Changeset 0d768c8


Ignore:
Timestamp:
02/24/06 14:38:51 (15 years ago)
Author:
Perry Lorier <perry@…>
Branches:
4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, getfragoff, help, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes
Children:
9de8150
Parents:
2e223eca
Message:

More documentation of fields

Location:
lib
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • lib/libtrace.h

    r2e223eca r0d768c8  
    104104 */
    105105typedef struct libtrace_packet_t {
    106         struct libtrace_t *trace;
    107         void *header;
    108         void *payload;
    109         buf_control_t buf_control;
    110         void *buffer;
     106        struct libtrace_t *trace; /**< pointer to the trace */
     107        void *header;           /**< pointer to the framing header */
     108        void *payload;          /**< pointer to the link layer */
     109        buf_control_t buf_control; /**< who owns the memory */
     110        void *buffer;           /**< allocated buffer */
    111111        size_t size;            /**< trace_get_framing_length()
    112112                                 * +trace_get_capture_length() */
     
    289289{
    290290 u_int16_t header;
    291  u_int16_t ether_type;
     291 u_int16_t ether_type;          /**< ether type */
    292292} __attribute__ ((packed)) libtrace_pos;
    293293/*@}*/
  • lib/libtrace_int.h

    r2e223eca r0d768c8  
    113113        struct libtrace_format_t *format;       /**< format driver */
    114114        struct libtrace_format_data_out_t *format_data; /**< format data */
    115         bool started;
     115        bool started;                   /**< trace started */
    116116        libtrace_err_t err;             /**< Associated error */
    117117        char *uridata;                  /**< URI associated with this trace */
  • lib/wag.h

    rf03fc17 r0d768c8  
    4343#define FRAME_SUBTYPE_DATA_TX   (0x0001)
    4444
    45 /* This is the common part of the frame header.
    46  * We synchronise by scanning a stream to look for the magic number (WAG_MAGIC).
    47  * We can then tell the size and type of this frame, and pass over it if necessary.
     45/** This is the common part of the frame header.
     46 * We synchronise by scanning a stream to look for the magic number
     47 * (WAG_MAGIC).  We can then tell the size and type of this frame, and pass
     48 * over it if necessary.
    4849 */
    4950struct frame_t {
    50   uint16_t magic;                                   /* magic number (0xdaa1) */
    51   uint16_t size;                                    /* total frame size in bytes */
    52   uint16_t type;                                    /* frame type */
    53   uint16_t subtype;                                 /* frame subtype */
     51  uint16_t magic;                           /**< magic number (0xdaa1) */
     52  uint16_t size;                            /**< total frame size in bytes */
     53  uint16_t type;                            /**< frame type */
     54  uint16_t subtype;                         /**< frame subtype */
    5455};
    5556
     
    6263*/
    6364
    64 /* timestamp */
     65/** timestamp */
    6566struct timestamp_t {
    66   uint32_t           secs;                          /* seconds since start of 01-01-1970 */
    67   uint32_t           subsecs;                       /* (1/(2^32))ths of a second */
     67  uint32_t           secs;           /**< seconds since start of 01-01-1970 */
     68  uint32_t           subsecs;        /**< (1/(2^32))ths of a second */
    6869};
    6970
    70 /* frame stream information */
     71/** frame stream information */
    7172struct strinfo_t {
    7273  uint16_t unused_1;
    7374  uint16_t unused_2;
    7475  uint16_t unused_3;
    75   uint16_t packets_lost;
     76  uint16_t packets_lost;        /**< Number of packets lost */
    7677};
    7778
    78 /* Type: DATA, Subtype: RX */
     79/** Type: DATA, Subtype: RX */
    7980struct frame_data_rx_t {
    80   struct frame_t                 hdr;               /* common frame header */
    81   struct strinfo_t               strinfo;           /* stream status */
    82   struct timestamp_t             ts;                /* timestamp of reception of this frame */
     81  struct frame_t     hdr;     /**< common frame header */
     82  struct strinfo_t   strinfo; /**< stream status */
     83  struct timestamp_t ts;      /**< timestamp of reception of this frame */
    8384  struct {
    84     uint8_t              rssi;                      /* receive signal strength of this frame */
    85     uint8_t              rxstatus;                  /* rx status bits from the modem */
    86     uint16_t             length;                    /* length in bytes of the frame payload */
     85    uint8_t          rssi;    /**< receive signal strength of this frame */
     86    uint8_t          rxstatus; /**< rx status bits from the modem */
     87    uint16_t         length;  /**< length in bytes of the frame payload */
    8788    struct {
    88       uint8_t  signal;                              /* 802.11PLCP signal field */
    89       uint8_t  service;                             /* 802.11PLCP service field */
    90       uint16_t length; } plcp; } rxinfo;            /* 802.11PLCP length field (uS) */
     89      uint8_t  signal;        /**< 802.11PLCP signal field */
     90      uint8_t  service;       /**< 802.11PLCP service field */
     91      uint16_t length;        /**< 802.11PLCP length field (uS) */
     92    } plcp;
     93  } rxinfo;
    9194};
    9295
    93 /* Type: DATA, Subtype: TX */
     96/** Type: DATA, Subtype: TX */
    9497struct frame_data_tx_t {
    95   struct frame_t                 hdr;               /* common frame header */
    96   uint64_t                       unused_1;         
    97   uint64_t                       unused_2;         
     98  struct frame_t      hdr;       /**< common frame header */
     99  uint64_t            unused_1;         
     100  uint64_t            unused_2;         
    98101  struct {
    99     uint8_t  gain;                                  /* tx gain with which to send this packet */
    100     uint8_t  mode;                                  /* tx mode with which to send this packet */
    101     uint16_t length;                                /* length in bytes of the frame payload */
    102     uint32_t unused_1; }         txinfo;           
     102    uint8_t  gain;        /**< tx gain with which to send this packet */
     103    uint8_t  mode;        /**< tx mode with which to send this packet */
     104    uint16_t length;      /**< length in bytes of the frame payload */
     105    uint32_t unused_1;
     106  } txinfo;           
    103107};
    104108
     
    123127};
    124128
     129/** 802.11 payload */
    125130struct ieee_802_11_payload {
    126         uint16_t     type;
     131        uint16_t     type; /**< ether type of this packet */
    127132};
    128133
Note: See TracChangeset for help on using the changeset viewer.