#include <usbdcomp.h>

Collaboration diagram for tUSBDCompositeDevice:

[legend]

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 mA. More...

const uint8_t	ui8PwrAttributes

const tUSBCallback	pfnCallback

const uint8_t const	ppui8StringDescriptors

const uint32_t	ui32NumStringDescriptors

const uint32_t	ui32NumDevices
	The number of devices in the psDevices array. More...

tCompositeEntry *const	psDevices

tCompositeInstance	sPrivateData

Detailed Description

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

Field Documentation

§ ui16VID

const uint16_t tUSBDCompositeDevice::ui16VID

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

§ ui16PID

const uint16_t tUSBDCompositeDevice::ui16PID

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

§ ui16MaxPowermA

const uint16_t tUSBDCompositeDevice::ui16MaxPowermA

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

§ ui8PwrAttributes

const uint8_t tUSBDCompositeDevice::ui8PwrAttributes

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

§ pfnCallback

const tUSBCallback tUSBDCompositeDevice::pfnCallback

A pointer to the callback function which will be called to notify the application of events relating to the operation of the composite device.

§ ppui8StringDescriptors

const uint8_t* const* tUSBDCompositeDevice::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), Composite device 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 USBDCompositeInit().

§ ui32NumStringDescriptors

const uint32_t tUSBDCompositeDevice::ui32NumStringDescriptors

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

§ ui32NumDevices

const uint32_t tUSBDCompositeDevice::ui32NumDevices

The number of devices in the psDevices array.

§ psDevices

tCompositeEntry* const tUSBDCompositeDevice::psDevices

This application supplied array holds the the top level device class information as well as the Instance data for that class.

Referenced by BuildCompositeDescriptor().

§ sPrivateData

tCompositeInstance tUSBDCompositeDevice::sPrivateData

The private data for this device instance. This memory must remain accessible for as long as the composite device is in use and must not be modified by any code outside the composite class driver.

Referenced by BuildCompositeDescriptor(), and USBDCompositeInit().

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

usbdcomp.h

Data Fields