|
|
|
USBLibAPIGuide
1.00.00.01
|
Data Structures | |
| struct | tEventInfo |
| #define USB_EVENT_BASE 0x0000 |
| #define USB_CLASS_EVENT_BASE 0x8000 |
| #define USBD_CDC_EVENT_BASE (USB_CLASS_EVENT_BASE + 0) |
| #define USBD_HID_EVENT_BASE (USB_CLASS_EVENT_BASE + 0x1000) |
| #define USBD_HID_KEYB_EVENT_BASE (USBD_HID_EVENT_BASE + 0x100) |
| #define USBD_BULK_EVENT_BASE (USB_CLASS_EVENT_BASE + 0x2000) |
| #define USBD_MSC_EVENT_BASE (USB_CLASS_EVENT_BASE + 0x3000) |
| #define USBD_AUDIO_EVENT_BASE (USB_CLASS_EVENT_BASE + 0x4000) |
| #define USBD_DFU_EVENT_BASE (USB_CLASS_EVENT_BASE + 0x5000) |
| #define USBH_CDC_EVENT_BASE (USBD_CDC_EVENT_BASE + 0x800) |
| #define USBH_HID_EVENT_BASE (USBD_HID_EVENT_BASE + 0x800) |
| #define USBH_BULK_EVENT_BASE (USBD_BULK_EVENT_BASE + 0x800) |
| #define USBH_MSC_EVENT_BASE (USBD_MSC_EVENT_BASE + 0x800) |
| #define USBH_AUDIO_EVENT_BASE (USBD_AUDIO_EVENT_BASE + 0x800) |
| #define USB_EVENT_CONNECTED (USB_EVENT_BASE + 0) |
The device is now attached to a USB host and ready to begin sending and receiving data (used by device classes only).
| #define USB_EVENT_DISCONNECTED (USB_EVENT_BASE + 1) |
The device has been disconnected from the USB host (used by device classes only).
| #define USB_EVENT_RX_AVAILABLE (USB_EVENT_BASE + 2) |
Data has been received and is in the buffer provided or is ready to be read from the FIFO. If the pvMsgData value is 0 then the ui32MsgParam value contains the amount of data in bytes ready to be read from the device. If the pvMsgData value is not 0 then pvMsgData is a pointer to the data that was read and ui32MsgParam is the number of valid bytes in the array pointed to by pvMsgData.
Referenced by USBBufferEventCallback().
| #define USB_EVENT_DATA_REMAINING (USB_EVENT_BASE + 3) |
This event is sent by a lower layer to inquire about the amount of unprocessed data buffered in the layers above. It is used in cases where a low level driver needs to ensure that all preceding data has been processed prior to performing some action or making some notification. Clients receiving this event should return the number of bytes of data that are unprocessed or 0 if no outstanding data remains.
| #define USB_EVENT_REQUEST_BUFFER (USB_EVENT_BASE + 4) |
This event is sent by a lower layer supporting DMA to request a buffer in which the next received packet may be stored. The ui32MsgValue parameter indicates the maximum size of packet that can be received in this channel and pvMsgData points to storage which should be written with the returned buffer pointer. The return value from the callback should be the size of the buffer allocated (which may be less than the maximum size passed in ui32MsgValue if the client knows that fewer bytes are expected to be received) or 0 if no buffer is being returned.
| #define USB_EVENT_TX_COMPLETE (USB_EVENT_BASE + 5) |
Data has been sent and acknowledged. If this event is received via the USB buffer callback, the ui32MsgValue parameter indicates the number of bytes from the transmit buffer that have been successfully transmitted and acknowledged.
| #define USB_EVENT_ERROR (USB_EVENT_BASE + 6) |
An error has been reported on the channel or pipe. The ui32MsgValue parameter indicates the source(s) of the error and is the logical OR combination of "USBERR_" flags defined below.
| #define USB_EVENT_SUSPEND (USB_EVENT_BASE + 7) |
The bus has entered suspend state.
| #define USB_EVENT_RESUME (USB_EVENT_BASE + 8) |
The bus has left suspend state.
| #define USB_EVENT_SCHEDULER (USB_EVENT_BASE + 9) |
A scheduler event has occurred.
| #define USB_EVENT_STALL (USB_EVENT_BASE + 10) |
A device or host has detected a stall condition.
| #define USB_EVENT_POWER_FAULT (USB_EVENT_BASE + 11) |
The host detected a power fault condition.
| #define USB_EVENT_POWER_ENABLE (USB_EVENT_BASE + 12) |
The controller has detected a A-Side cable and needs power applied This is only generated on OTG parts if automatic power control is disabled.
Referenced by USB0_IRQOTGModeHandler().
| #define USB_EVENT_POWER_DISABLE (USB_EVENT_BASE + 13) |
The controller needs power removed, This is only generated on OTG parts if automatic power control is disabled.
| #define USB_EVENT_COMP_IFACE_CHANGE (USB_EVENT_BASE + 14) |
This define is used with a device class's pfnDeviceHandler handler function to indicate that the USB library has changed the interface number. This event is typically due to the class being included in a composite device.
The pvInstance is a pointer to an instance of the device being accessed.
The ui32Request is USB_EVENT_COMP_IFACE_CHANGE.
The pvRequestData is a pointer to a two byte array where the first value is the old interface number and the second is the new interface number.
| #define USB_EVENT_COMP_EP_CHANGE (USB_EVENT_BASE + 15) |
This define is used with a device class's pfnDeviceHandler handler function to indicate that the USB library has changed the endpoint number. This event is typically due to the class being included in a composite device.
The pvInstance is a pointer to an instance of the device being accessed.
The ui32Request is USB_EVENT_COMP_EP_CHANGE.
The pvRequestData is a pointer to a two byte array where the first value is the old endpoint number and the second is the new endpoint number. The endpoint numbers should be exactly as USB specification defines them and bit 7 set indicates an IN endpoint and bit 7 clear indicates an OUT endpoint.
| #define USB_EVENT_COMP_STR_CHANGE (USB_EVENT_BASE + 16) |
This define is used with a device class's pfnDeviceHandler handler function to indicate that the USB library has changed the string index number for a string. This event is typically due to the class being included in a composite device.
The pvInstance is a pointer to an instance of the device being accessed.
The ui32Request is USB_EVENT_COMP_STR_CHANGE.
The pvRequestData is a pointer to a two byte array where the first value is the old string index and the second is the new string index.
| #define USB_EVENT_COMP_CONFIG (USB_EVENT_BASE + 17) |
This define is used with a device class's pfnDeviceHandler handler function to indicate that the USB library has changed the configuration descriptor. This allows the class to make final adjustments to the configuration descriptor. This event is typically due to the class being included in a composite device.
The pvInstance is a pointer to an instance of the device being accessed.
The ui32Request is USB_EVENT_COMP_CONFIG.
The pvRequestData is a pointer to the beginning of the configuration descriptor for the device instance.
| #define USB_EVENT_UNKNOWN_CONNECTED (USB_EVENT_BASE + 18) |
An unknown device is now attached to a USB host. This value is only valid for the generic event handler and not other device handlers. It is useful for applications that want to know when an unknown device is connected and what the class is of the unknown device.
The ui32Instance is the device instance for the unknown device.
| #define USB_EVENT_SOF (USB_EVENT_BASE + 19) |
A start of frame event has occurred. This event is disabled by default and must be enabled via a call from the application to USBHCDEventEnable().
| #define USB_EVENT_LPM_SLEEP (USB_EVENT_BASE + 20) |
This event occurs when a device enters LPM sleep mode.
Referenced by USBDeviceIntHandlerInternal().
| #define USB_EVENT_LPM_RESUME (USB_EVENT_BASE + 21) |
This event occurs when a device is resumed from LPM sleep mode.
Referenced by USBDeviceIntHandlerInternal().
| #define USB_EVENT_LPM_ERROR (USB_EVENT_BASE + 22) |
This event occurs when a device has responded with a NYET to an LPM request because LPM responses were disabled.
Referenced by USBDeviceIntHandlerInternal().
| #define USB_EVENT_CONFIG_CHANGE (USB_EVENT_BASE + 23) |
This event occurs when a device has been issued a configuration change.