contrib/libpcap/pcap/usb.h

   1 /*
   2  * Copyright (c) 2006 Paolo Abeni (Italy)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote
  15  * products derived from this software without specific prior written
  16  * permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * Basic USB data struct
  31  * By Paolo Abeni <paolo.abeni@email.it>
  32  */
  33
  34 #ifndef lib_pcap_usb_h
  35 #define lib_pcap_usb_h
  36
  37 /*
  38  * possible transfer mode
  39  */
  40 #define URB_TRANSFER_IN   0x80
  41 #define URB_ISOCHRONOUS   0x0
  42 #define URB_INTERRUPT     0x1
  43 #define URB_CONTROL       0x2
  44 #define URB_BULK          0x3
  45
  46 /*
  47  * possible event type
  48  */
  49 #define URB_SUBMIT        'S'
  50 #define URB_COMPLETE      'C'
  51 #define URB_ERROR         'E'
  52
  53 /*
  54  * USB setup header as defined in USB specification.
  55  * Appears at the front of each Control S-type packet in DLT_USB captures.
  56  */
  57 typedef struct _usb_setup {
  58         u_int8_t bmRequestType;
  59         u_int8_t bRequest;
  60         u_int16_t wValue;
  61         u_int16_t wIndex;
  62         u_int16_t wLength;
  63 } pcap_usb_setup;
  64
  65 /*
  66  * Information from the URB for Isochronous transfers.
  67  */
  68 typedef struct _iso_rec {
  69         int32_t error_count;
  70         int32_t numdesc;
  71 } iso_rec;
  72
  73 /*
  74  * Header prepended by linux kernel to each event.
  75  * Appears at the front of each packet in DLT_USB_LINUX captures.
  76  */
  77 typedef struct _usb_header {
  78         u_int64_t id;
  79         u_int8_t event_type;
  80         u_int8_t transfer_type;
  81         u_int8_t endpoint_number;
  82         u_int8_t device_address;
  83         u_int16_t bus_id;
  84         char setup_flag;/*if !=0 the urb setup header is not present*/
  85         char data_flag; /*if !=0 no urb data is present*/
  86         int64_t ts_sec;
  87         int32_t ts_usec;
  88         int32_t status;
  89         u_int32_t urb_len;
  90         u_int32_t data_len; /* amount of urb data really present in this event*/
  91         pcap_usb_setup setup;
  92 } pcap_usb_header;
  93
  94 /*
  95  * Header prepended by linux kernel to each event for the 2.6.31
  96  * and later kernels; for the 2.6.21 through 2.6.30 kernels, the
  97  * "iso_rec" information, and the fields starting with "interval"
  98  * are zeroed-out padding fields.
  99  *
 100  * Appears at the front of each packet in DLT_USB_LINUX_MMAPPED captures.
 101  */
 102 typedef struct _usb_header_mmapped {
 103         u_int64_t id;
 104         u_int8_t event_type;
 105         u_int8_t transfer_type;
 106         u_int8_t endpoint_number;
 107         u_int8_t device_address;
 108         u_int16_t bus_id;
 109         char setup_flag;/*if !=0 the urb setup header is not present*/
 110         char data_flag; /*if !=0 no urb data is present*/
 111         int64_t ts_sec;
 112         int32_t ts_usec;
 113         int32_t status;
 114         u_int32_t urb_len;
 115         u_int32_t data_len; /* amount of urb data really present in this event*/
 116         union {
 117                 pcap_usb_setup setup;
 118                 iso_rec iso;
 119         } s;
 120         int32_t interval;       /* for Interrupt and Isochronous events */
 121         int32_t start_frame;    /* for Isochronous events */
 122         u_int32_t xfer_flags;   /* copy of URB's transfer flags */
 123         u_int32_t ndesc;        /* number of isochronous descriptors */
 124 } pcap_usb_header_mmapped;
 125
 126 /*
 127  * Isochronous descriptors; for isochronous transfers there might be
 128  * one or more of these at the beginning of the packet data.  The
 129  * number of descriptors is given by the "ndesc" field in the header;
 130  * as indicated, in older kernels that don't put the descriptors at
 131  * the beginning of the packet, that field is zeroed out, so that field
 132  * can be trusted even in captures from older kernels.
 133  */
 134 typedef struct _usb_isodesc {
 135         int32_t         status;
 136         u_int32_t       offset;
 137         u_int32_t       len;
 138         u_int8_t        pad[4];
 139 } usb_isodesc;
 140
 141 #endif