From e79e00ef7f7afbee21762cf536cdff230b3e6cd6 Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sat, 6 Dec 2014 14:19:40 +0100 Subject: [PATCH] doc: add documentation for packet format in mc1322x --- cpu/mc1322x/maca/include/maca_packet.h | 28 ++++++++++++++++---------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/cpu/mc1322x/maca/include/maca_packet.h b/cpu/mc1322x/maca/include/maca_packet.h index 092a93c8ec..389340f3c6 100644 --- a/cpu/mc1322x/maca/include/maca_packet.h +++ b/cpu/mc1322x/maca/include/maca_packet.h @@ -23,24 +23,30 @@ extern "C" { #define PACKET_STATS 0 +/** + * @brief MC1322x internal MACA packet format */ struct packet { - uint8_t length; /*< does not include FCS checksum */ - volatile struct packet * left; - volatile struct packet * right; - /* offset into data for first byte of the packet payload */ - /* On TX this should be 0 */ - /* On RX this should be 1 since the maca puts the length as the first byte*/ - uint8_t offset; - uint8_t lqi; - uint8_t status; - uint32_t rx_time; + uint8_t length; /**< does not include FCS checksum */ + volatile struct packet *left; /**< pointer to left neighbor in queue */ + volatile struct packet *right; /**< pointer to right neighbor in queue */ + uint8_t offset; /**< offset into data for first byte of the + * packet payload + * On TX this should be 0 + * On RX this should be 1 since the maca + * puts the length as the first byte + */ + uint8_t lqi; /**< link quality indicator */ + uint8_t status; /**< packet status */ + uint32_t rx_time; /**< receiving timestamp */ #if PACKET_STATS uint8_t seen; uint8_t post_tx; uint8_t get_free; uint8_t rxd; #endif - uint8_t data[MACA_MAX_PAYLOAD_SIZE+2+1]; /* +2 for FCS; + 1 since maca returns the length as the first byte */ + uint8_t data[MACA_MAX_PAYLOAD_SIZE+2+1]; /**< +2 for FCS; + 1 since maca + * returns the length as the + * first byte */ }; typedef struct packet maca_packet_t;