Data Fields
DeviceInfo Struct Reference

#include <usblib.h>

Data Fields

tCustomHandlers sCallbacks
 
const uint8_t * pDeviceDescriptor
 A pointer to the device descriptor for this device.
 
usbConfigHeader_t ** ppConfigDescriptors
 
uint8_t ** ppStringDescriptors
 
uint32_t ulNumStringDescriptors
 
const tFIFOConfigpsFIFOConfig
 
void * pvInstance
 

Detailed Description

This structure is passed to the USB library on a call to USBDCDInit and provides the library with information about the device that the application is implementing. It contains functions pointers for the various USB event handlers and pointers to each of the standard device descriptors.

Field Documentation

usbConfigHeader_t** DeviceInfo::ppConfigDescriptors

A pointer to an array of configuration descriptor pointers. Each entry in the array corresponds to one configuration that the device may be set to use by the USB host. The number of entries in the array must match the bNumConfigurations value in the device descriptor array, pDeviceDescriptor.

uint8_t** DeviceInfo::ppStringDescriptors

A pointer to the string descriptor array for this device. This array must be arranged as follows:

  • [0] - Standard descriptor containing supported language codes.
  • [1] - String 1 for the first language listed in descriptor 0.
  • [2] - String 2 for the first language listed in descriptor 0.
  • ...
  • [n] - String n for the first language listed in descriptor 0.
  • [n+1] - String 1 for the second language listed in descriptor 0.
  • ...
  • [2n] - String n for the second language listed in descriptor 0.
  • [2n+1]- String 1 for the third language listed in descriptor 0.
  • ...
  • [3n] - String n for the third language listed in descriptor 0.

and so on.

const tFIFOConfig* DeviceInfo::psFIFOConfig

A structure defining how the USB controller FIFO is to be partitioned between the various endpoints. This member can be set to point to g_sUSBDefaultFIFOConfig if the default FIFO configuration is acceptable This configuration sets each endpoint FIFO to be single buffered and sized to hold the maximum packet size for the endpoint.

void* DeviceInfo::pvInstance

This value will be passed back to all call back functions so that they have access to individual instance data based on the this pointer.

tCustomHandlers DeviceInfo::sCallbacks

A pointer to a structure containing pointers to event handler functions provided by the client to support the operation of this device.

uint32_t DeviceInfo::ulNumStringDescriptors

The total number of descriptors provided in the ppStringDescriptors array.


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

Copyright 2016, Texas Instruments Incorporated