ascii graphics that shows how we get to the head of the footer

[tinyos-2.x.git] / tos / lib / net / le / LinkEstimatorP.nc

diff --git a/tos/lib/net/le/LinkEstimatorP.nc b/tos/lib/net/le/LinkEstimatorP.nc
index c18e9f19b416c5c3d893cd812424a38e587d77f8..57bd8e87e32f8a0ddc625c3b1ec01f2493c7be45 100644 (file)
--- a/tos/lib/net/le/LinkEstimatorP.nc
+++ b/tos/lib/net/le/LinkEstimatorP.nc
@@ -649,6 +649,20 @@ implementation {
        }
       }
 
+
+      /* Graphical explanation of how we get to the head of the
+       * footer in the following code 
+       * <---------------------- payloadLen ------------------->
+       * -------------------------------------------------------
+       * linkest_header_t  | payload  | linkest_footer_t* ...|
+       * -------------------------------------------------------
+       * ^                              ^                      ^
+       * |                              |                      |
+       * subpayload                     |                      payloadEnd
+       *                                |
+       *                                payloadEnd - footersize*num footers
+      */
+
       if ((nidx != INVALID_RVAL) && (num_entries > 0)) {
        uint8_t payloadLen = call SubPacket.payloadLength(msg);
        void* subPayload = call SubPacket.getPayload(msg, payloadLen);