#include <usbdmsc.h>

Collaboration diagram for tUSBDMSCDevice:

[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 uint8_t	pui8Vendor [8]
	8 byte vendor string. More...

const uint8_t	pui8Product [16]
	16 byte vendor string. More...

const uint8_t	pui8Version [4]
	4 byte vendor string. More...

const uint16_t	ui16MaxPowermA
	The maximum power consumption of the device, expressed in milliamps. More...

const uint8_t	ui8PwrAttributes

const uint8_t const	ppui8StringDescriptors

const uint32_t	ui32NumStringDescriptors

const tMSCDMedia	sMediaFunctions

const tUSBCallback	pfnEventCallback

tMSCInstance	sPrivateData

Detailed Description

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

Field Documentation

§ ui16VID

const uint16_t tUSBDMSCDevice::ui16VID

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

§ ui16PID

const uint16_t tUSBDMSCDevice::ui16PID

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

§ pui8Vendor

const uint8_t tUSBDMSCDevice::pui8Vendor[8]

8 byte vendor string.

§ pui8Product

const uint8_t tUSBDMSCDevice::pui8Product[16]

16 byte vendor string.

§ pui8Version

const uint8_t tUSBDMSCDevice::pui8Version[4]

4 byte vendor string.

§ ui16MaxPowermA

const uint16_t tUSBDMSCDevice::ui16MaxPowermA

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

§ ui8PwrAttributes

const uint8_t tUSBDMSCDevice::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.

§ ppui8StringDescriptors

const uint8_t* const* tUSBDMSCDevice::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), MSC 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 USBDMSCCompositeInit(), and USBDMSCInit().

§ ui32NumStringDescriptors

const uint32_t tUSBDMSCDevice::ui32NumStringDescriptors

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

§ sMediaFunctions

const tMSCDMedia tUSBDMSCDevice::sMediaFunctions

This structure holds the access functions for the media used by this instance of the mass storage class device. All of the functions in this structure are required to be filled out with valid functions.

Referenced by USBDMSCTerm().

§ pfnEventCallback

const tUSBCallback tUSBDMSCDevice::pfnEventCallback

This is the callback function for various events that occur during mass storage class operation.

§ sPrivateData

tMSCInstance tUSBDMSCDevice::sPrivateData

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

Referenced by USBDMSCCompositeInit(), USBDMSCMediaChange(), USBDMSCTerm(), and USBDSCSICommand().

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

usbdmsc.h

Data Fields