USBLib API Guide
1.00.00.01
|
#include <usbdhidkeyb.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 | pfnCallback |
void * | pvCBData |
const uint8_t *const * | ppui8StringDescriptors |
const uint32_t | ui32NumStringDescriptors |
tHIDKeyboardInstance | sPrivateData |
This structure is used by the application to define operating parameters for the HID keyboard device.
const uint16_t tUSBDHIDKeyboardDevice::ui16VID |
The vendor ID that this device is to present in the device descriptor.
Referenced by USBDHIDKeyboardCompositeInit().
const uint16_t tUSBDHIDKeyboardDevice::ui16PID |
The product ID that this device is to present in the device descriptor.
Referenced by USBDHIDKeyboardCompositeInit().
const uint16_t tUSBDHIDKeyboardDevice::ui16MaxPowermA |
The maximum power consumption of the device, expressed in milliamps.
Referenced by USBDHIDKeyboardCompositeInit().
const uint8_t tUSBDHIDKeyboardDevice::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 USBDHIDKeyboardCompositeInit().
const tUSBCallback tUSBDHIDKeyboardDevice::pfnCallback |
A pointer to the callback function which is called to notify the application of general events and those related to reception of Output and Feature reports via the (optional) interrupt OUT endpoint.
Referenced by USBDHIDKeyboardCompositeInit(), and USBDHIDKeyboardInit().
void* tUSBDHIDKeyboardDevice::pvCBData |
A client-supplied pointer which is sent as the first parameter in all calls made to the keyboard callback, pfnCallback.
Referenced by USBDHIDKeyboardSetCBData().
const uint8_t* const* tUSBDHIDKeyboardDevice::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),HID Interface description string (language 1), Configuration description string (language 1).
If supporting more than 1 language, the descriptor block (except for string descriptor 0) must be repeated for each language defined in the language descriptor.
Referenced by USBDHIDKeyboardCompositeInit(), and USBDHIDKeyboardInit().
const uint32_t tUSBDHIDKeyboardDevice::ui32NumStringDescriptors |
The number of descriptors provided in the ppStringDescriptors array. This must be (1 + (5 * (num languages))).
tHIDKeyboardInstance tUSBDHIDKeyboardDevice::sPrivateData |
The private instance data for this device. This memory must remain accessible for as long as the keyboard device is in use and must not be modified by any code outside the HID keyboard driver.
Referenced by USBDHIDKeyboardCompositeInit(), USBDHIDKeyboardInit(), USBDHIDKeyboardKeyStateChange(), USBDHIDKeyboardPowerStatusSet(), USBDHIDKeyboardRemoteWakeupRequest(), and USBDHIDKeyboardTerm().