tUSBDBulkDevice Struct Reference

#include <usbdbulk.h>

Collaboration diagram for tUSBDBulkDevice:

Data Fields
const uint16_t	ui16VID
	The vendor ID that this device is to present in the device descriptor. More...
const uint16_t	ui16PID
	The product ID that this device is to present in the device descriptor. More...
const uint16_t	ui16MaxPowermA
	The maximum power consumption of the device, expressed in milliamps. More...
const uint8_t	ui8PwrAttributes
const tUSBCallback	pfnRxCallback
void *	pvRxCBData
const tUSBCallback	pfnTxCallback
void *	pvTxCBData
const uint8_t *const *	ppui8StringDescriptors
const uint32_t	ui32NumStringDescriptors
tBulkInstance	sPrivateData

Detailed Description

The structure used by the application to define operating parameters for the bulk device.

Field Documentation

ui16VID

const uint16_t tUSBDBulkDevice::ui16VID

The vendor ID that this device is to present in the device descriptor.

Referenced by USBDBulkInit().

ui16PID

const uint16_t tUSBDBulkDevice::ui16PID

The product ID that this device is to present in the device descriptor.

Referenced by USBDBulkInit().

ui16MaxPowermA

const uint16_t tUSBDBulkDevice::ui16MaxPowermA

The maximum power consumption of the device, expressed in milliamps.

Referenced by USBDBulkInit().

ui8PwrAttributes

const uint8_t tUSBDBulkDevice::ui8PwrAttributes

Indicates whether the device is self- or bus-powered and whether or not it supports remote wakeup. Valid values are USB_CONF_ATTR_SELF_PWR or USB_CONF_ATTR_BUS_PWR, optionally ORed with USB_CONF_ATTR_RWAKE.

Referenced by USBDBulkInit().

pfnRxCallback

const tUSBCallback tUSBDBulkDevice::pfnRxCallback

A pointer to the callback function which will be called to notify the application of events related to the device's data receive channel.

Referenced by USBDBulkCompositeInit().

pvRxCBData

void* tUSBDBulkDevice::pvRxCBData

A client-supplied pointer which will be sent as the first parameter in all calls made to the receive channel callback, pfnRxCallback.

pfnTxCallback

const tUSBCallback tUSBDBulkDevice::pfnTxCallback

A pointer to the callback function which will be called to notify the application of events related to the device's data transmit channel.

Referenced by USBDBulkCompositeInit().

pvTxCBData

void* tUSBDBulkDevice::pvTxCBData

A client-supplied pointer which will be sent as the first parameter in all calls made to the transmit channel callback, pfnTxCallback.

ppui8StringDescriptors

const uint8_t* const* tUSBDBulkDevice::ppui8StringDescriptors

A pointer to the string descriptor array for this device. This array must contain pointers to the following string descriptors in this order. Language descriptor, Manufacturer name string (language 1), Product name string (language 1), Serial number string (language 1), Interface description string (language 1) and Configuration description string (language 1).

If supporting more than 1 language, the strings for indices 1 through 5 must be repeated for each of the other languages defined in the language descriptor.

Referenced by USBDBulkCompositeInit().

ui32NumStringDescriptors

const uint32_t tUSBDBulkDevice::ui32NumStringDescriptors

The number of descriptors provided in the ppStringDescriptors array. This must be 1 + (5 * number of supported languages).

sPrivateData

tBulkInstance tUSBDBulkDevice::sPrivateData

The private instance data for this device. This memory must not be modified by any code outside the bulk class driver.

Referenced by USBDBulkCompositeInit(), and USBDBulkInit().

---

The documentation for this struct was generated from the following file:

• usbdbulk.h