USBLib API Guide
1.00.00.01
|
#include <usbdcdc.h>
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 | pfnControlCallback |
void * | pvControlCBData |
const tUSBCallback | pfnRxCallback |
void * | pvRxCBData |
const tUSBCallback | pfnTxCallback |
void * | pvTxCBData |
const uint8_t *const * | ppui8StringDescriptors |
const uint32_t | ui32NumStringDescriptors |
tCDCSerInstance | sPrivateData |
The structure used by the application to define operating parameters for the CDC device.
const uint16_t tUSBDCDCDevice::ui16VID |
The vendor ID that this device is to present in the device descriptor.
Referenced by USBDCDCInit().
const uint16_t tUSBDCDCDevice::ui16PID |
The product ID that this device is to present in the device descriptor.
Referenced by USBDCDCInit().
const uint16_t tUSBDCDCDevice::ui16MaxPowermA |
The maximum power consumption of the device, expressed in milliamps.
Referenced by USBDCDCInit().
const uint8_t tUSBDCDCDevice::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 USBDCDCInit().
const tUSBCallback tUSBDCDCDevice::pfnControlCallback |
A pointer to the callback function which will be called to notify the application of all asynchronous control events related to the operation of the device.
Referenced by USBDCDCCompositeInit().
void* tUSBDCDCDevice::pvControlCBData |
A client-supplied pointer which will be sent as the first parameter in all calls made to the control channel callback, pfnControlCallback.
Referenced by USBDCDCSetControlCBData().
const tUSBCallback tUSBDCDCDevice::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 USBDCDCCompositeInit().
void* tUSBDCDCDevice::pvRxCBData |
A client-supplied pointer which will be sent as the first parameter in all calls made to the receive channel callback, pfnRxCallback.
Referenced by USBDCDCSetRxCBData().
const tUSBCallback tUSBDCDCDevice::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 USBDCDCCompositeInit().
void* tUSBDCDCDevice::pvTxCBData |
A client-supplied pointer which will be sent as the first parameter in all calls made to the transmit channel callback, pfnTxCallback.
Referenced by USBDCDCSetTxCBData().
const uint8_t* const* tUSBDCDCDevice::ppui8StringDescriptors |
A pointer to the string descriptor array for this device. This array must contain the following string descriptor pointers in this order. Language descriptor, Manufacturer name string (language 1), Product name string (language 1), Serial number string (language 1), Control interface description string (language 1), 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.
const uint32_t tUSBDCDCDevice::ui32NumStringDescriptors |
The number of descriptors provided in the ppStringDescriptors array. This must be 1 + (5 * number of supported languages).
tCDCSerInstance tUSBDCDCDevice::sPrivateData |
The private instance data for this device. This memory must remain accessible for as long as the CDC device is in use and must not be modified by any code outside the CDC class driver.
Referenced by ProcessDataFromHost(), ProcessDataToHost(), ProcessNotificationToHost(), USBDCDCCompositeInit(), and USBDCDCInit().