/*

 * Copyright (c) 2006 Paolo Abeni (Italy)

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 *

 * 1. Redistributions of source code must retain the above copyright

 * notice, this list of conditions and the following disclaimer.

 * 2. Redistributions in binary form must reproduce the above copyright

 * notice, this list of conditions and the following disclaimer in the

 * documentation and/or other materials provided with the distribution.

 * 3. The name of the author may not be used to endorse or promote

 * products derived from this software without specific prior written

 * permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 *

 * Basic USB data struct

 * By Paolo Abeni <paolo.abeni@email.it>

 */

#ifndef lib_pcap_usb_h

#define lib_pcap_usb_h

#include <pcap/pcap-inttypes.h>

/*

 * possible transfer mode

 */

#define URB_TRANSFER_IN   0x80

#define URB_ISOCHRONOUS   0x0

#define URB_INTERRUPT     0x1

#define URB_CONTROL       0x2

#define URB_BULK          0x3

/*

 * possible event type

 */

#define URB_SUBMIT        'S'

#define URB_COMPLETE      'C'

#define URB_ERROR         'E'

/*

 * USB setup header as defined in USB specification.

 * Appears at the front of each Control S-type packet in DLT_USB captures.

 */

typedef struct _usb_setup {

	uint8_t bmRequestType;

	uint8_t bRequest;

	uint16_t wValue;

	uint16_t wIndex;

	uint16_t wLength;

} pcap_usb_setup;

/*

 * Information from the URB for Isochronous transfers.

 */

typedef struct _iso_rec {

	int32_t	error_count;

	int32_t	numdesc;

} iso_rec;

/*

 * Header prepended by linux kernel to each event.

 * Appears at the front of each packet in DLT_USB_LINUX captures.

 */

typedef struct _usb_header {

	uint64_t id;

	uint8_t event_type;

	uint8_t transfer_type;

	uint8_t endpoint_number;

	uint8_t device_address;

	uint16_t bus_id;

	char setup_flag;/*if !=0 the urb setup header is not present*/

	char data_flag; /*if !=0 no urb data is present*/

	int64_t ts_sec;

	int32_t ts_usec;

	int32_t status;

	uint32_t urb_len;

	uint32_t data_len; /* amount of urb data really present in this event*/

	pcap_usb_setup setup;

} pcap_usb_header;

/*

 * Header prepended by linux kernel to each event for the 2.6.31

 * and later kernels; for the 2.6.21 through 2.6.30 kernels, the

 * "iso_rec" information, and the fields starting with "interval"

 * are zeroed-out padding fields.

 *

 * Appears at the front of each packet in DLT_USB_LINUX_MMAPPED captures.

 */

typedef struct _usb_header_mmapped {

	uint64_t id;

	uint8_t event_type;

	uint8_t transfer_type;

	uint8_t endpoint_number;

	uint8_t device_address;

	uint16_t bus_id;

	char setup_flag;/*if !=0 the urb setup header is not present*/

	char data_flag; /*if !=0 no urb data is present*/

	int64_t ts_sec;

	int32_t ts_usec;

	int32_t status;

	uint32_t urb_len;

	uint32_t data_len; /* amount of urb data really present in this event*/

	union {

		pcap_usb_setup setup;

		iso_rec iso;

	} s;

	int32_t	interval;	/* for Interrupt and Isochronous events */

	int32_t start_frame;	/* for Isochronous events */

	uint32_t xfer_flags;	/* copy of URB's transfer flags */

	uint32_t ndesc;	/* number of isochronous descriptors */

} pcap_usb_header_mmapped;

/*

 * Isochronous descriptors; for isochronous transfers there might be

 * one or more of these at the beginning of the packet data.  The

 * number of descriptors is given by the "ndesc" field in the header;

 * as indicated, in older kernels that don't put the descriptors at

 * the beginning of the packet, that field is zeroed out, so that field

 * can be trusted even in captures from older kernels.

 */

typedef struct _usb_isodesc {

	int32_t		status;

	uint32_t	offset;

	uint32_t	len;

	uint8_t	pad[4];

} usb_isodesc;

#endif