| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
USB Events
USB Core - software/LPCUSBLib/Drivers/USB/USB.h

## Detailed Description

USB Event management definitions.

This module contains macros and functions relating to the management of library events, which are small pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from multiple places in the user or library code, which may or may not be inside an ISR, thus each handler should be written to be as small and fast as possible to prevent possible problems.

Events can be hooked by the user application by declaring a handler function with the same name and parameters listed here. If an event with no user-associated handler is fired within the library, it by default maps to an internal empty stub function.

Each event must only have one associated event handler, but can be raised by multiple sources by calling the event handler function (with any required event parameters).

## Functions
void | EVENT_USB_UIDChange (void)
void | EVENT_USB_Host_HostError (const uint8_t corenum, const uint8_t ErrorCode)
void | EVENT_USB_Host_DeviceAttached (const uint8_t corenum)
void | EVENT_USB_Host_DeviceUnattached (const uint8_t corenum)
void | EVENT_USB_Host_DeviceEnumerationFailed (const uint8_t corenum, const uint8_t ErrorCode, const uint8_t SubErrorCode)
void | EVENT_USB_Host_DeviceEnumerationComplete (const uint8_t corenum)
void | EVENT_USB_Host_StartOfFrame (const uint8_t corenum)
void | EVENT_USB_Device_Connect (void)
void | EVENT_USB_Device_Disconnect (void)
void | EVENT_USB_Device_ControlRequest (void)
void | EVENT_USB_Device_ConfigurationChanged (void)
void | EVENT_USB_Device_Suspend (void)
void | EVENT_USB_Device_WakeUp (void)
void | EVENT_USB_Device_Reset (void)
void | EVENT_USB_Device_StartOfFrame (void)
| Event handler for the USB device Start Of Frame event.

## Function Documentation

void EVENT_USB_Device_ConfigurationChanged | ( | void |  | ) |

Event for USB configuration number changed. This event fires when a the USB host changes the selected configuration number while in device mode. This event should be hooked in device applications to create the endpoints and configure the device for the selected configuration.

This event is time-critical; exceeding OS-specific delays within this event handler (typically of around one second) will prevent the device from enumerating correctly.

This event fires after the value of USB_Device_ConfigurationNumber has been changed.

Note
  This event does not exist if the `USB_HOST_ONLY` token is supplied to the compiler (see USB Interface Management documentation).

Event handler for the library USB Configuration Changed event.

Returns
  Nothing

Definition at line 317 of file usbmsdev.c.

void EVENT_USB_Device_Connect | ( | void |  | ) |

Event for USB device connection. This event fires when the microcontroller is in USB Device mode and the device is connected to a USB host, beginning the enumeration process measured by a rising level on the microcontroller's VBUS sense pin.

This event is time-critical; exceeding OS-specific delays within this event handler (typically of around two seconds) will prevent the device from enumerating correctly.

Note
  For the microcontrollers with limited USB controller functionality, VBUS sensing is not available. this means that the current connection state is derived from the bus suspension and wake up events by default, which is not always accurate (host may suspend the bus while still connected). If the actual connection state needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by passing the `NO_LIMITED_CONTROLLER_CONNECT` token to the compiler via the -D switch at compile time. The connection and disconnection events may be manually fired, and the USB_DeviceState global changed manually.
  This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers if `NO_LIMITED_CONTROLLER_CONNECT` is not defined.

See Also
  USB Interface Management for more information on the USB management task and reducing CPU usage.

Event handler for the library USB Connection event.

Returns
  Nothing

Definition at line 309 of file usbmsdev.c.

void EVENT_USB_Device_ControlRequest | ( | void |  | ) |

Event for control requests. This event fires when a the USB host issues a control request to the mandatory device control endpoint (of address 0). This may either be a standard request that the library may have a handler code for internally, or a class specific request issued to the device which must be handled appropriately. If a request is not processed in the user application via this event, it will be passed to the library for processing internally if a suitable handler exists.

This event is time-critical; each packet within the request transaction must be acknowledged or sent within 50ms or the host will abort the transfer.

The library internally handles all standard control requests with the exceptions of SYNC FRAME, SET DESCRIPTOR and SET INTERFACE. These and all other non-standard control requests will be left for the user to process via this event if desired. If not handled in the user application or by the library internally, unknown requests are automatically STALLed.

Note
  This event does not exist if the `USB_HOST_ONLY` token is supplied to the compiler (see USB Interface Management documentation).
  Requests should be handled in the same manner as described in the USB 2.0 Specification, or appropriate class specification. In all instances, the library has already read the request SETUP parameters into the USB_ControlRequest structure which should then be used by the application to determine how to handle the issued request.

Event handler for the library USB Control Request reception event.

Returns
  Nothing

Definition at line 325 of file usbmsdev.c.

void EVENT_USB_Device_Disconnect | ( | void |  | ) |

Event for USB device disconnection. This event fires when the microcontroller is in USB Device mode and the device is disconnected from a host, measured by a falling level on the microcontroller's VBUS sense pin.

Note
  For the microcontrollers with limited USB controllers, VBUS sense is not available to the USB controller. this means that the current connection state is derived from the bus suspension and wake up events by default, which is not always accurate (host may suspend the bus while still connected). If the actual connection state needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by passing the `NO_LIMITED_CONTROLLER_CONNECT` token to the compiler via the -D switch at compile time. The connection and disconnection events may be manually fired, and the USB_DeviceState global changed manually.
  This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers if `NO_LIMITED_CONTROLLER_CONNECT` is not defined.

See Also
  USB Interface Management for more information on the USB management task and reducing CPU usage.

Event handler for the library USB Disconnection event.

Returns
  Nothing

Definition at line 313 of file usbmsdev.c.

void EVENT_USB_Device_Reset | ( | void |  | ) |

Event for USB interface reset. This event fires when the USB interface is in device mode, and a the USB host requests that the device reset its interface. This event fires after the control endpoint has been automatically configured by the library.

This event is time-critical; exceeding OS-specific delays within this event handler (typically of around two seconds) will prevent the device from enumerating correctly.

Note
  This event does not exist if the `USB_HOST_ONLY` token is supplied to the compiler (see USB Interface Management documentation).

void EVENT_USB_Device_StartOfFrame | ( | void |  | ) |

Event handler for the USB device Start Of Frame event.

Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB frame, once per millisecond, and is synchronized to the USB bus. This can be used as an accurate millisecond timer source when the USB bus is enumerated in device mode to a USB host.

This event is time-critical; it is run once per millisecond and thus long handlers will significantly degrade device performance. This event should only be enabled when needed to reduce device wake-ups.

Precondition
  This event is not normally active - it must be manually enabled and disabled via the USB_Device_EnableSOFEvents() and USB_Device_DisableSOFEvents() commands after enumeration.

Note
  This event does not exist if the `USB_HOST_ONLY` token is supplied to the compiler (see USB Interface Management documentation).

Returns
  Nothing

Definition at line 142 of file GenericHID.c.

void EVENT_USB_Device_Suspend | ( | void |  | ) |

Event for USB suspend. This event fires when a the USB host suspends the device by halting its transmission of Start Of Frame pulses to the device. This is generally hooked in order to move the device over to a low power state until the host wakes up the device. If the USB interface is enumerated with the USB_OPT_AUTO_PLL option set, the library will automatically suspend the USB PLL before the event is fired to save power.

Note
  This event does not exist if the `USB_HOST_ONLY` token is supplied to the compiler (see USB Interface Management documentation).
  This event does not exist on the microcontrollers with limited USB VBUS sensing abilities when the `NO_LIMITED_CONTROLLER_CONNECT` compile time token is not set - see EVENT_USB_Device_Disconnect.

See Also
  EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.

void EVENT_USB_Device_WakeUp | ( | void |  | ) |

Event for USB wake up. This event fires when a the USB interface is suspended while in device mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally hooked to pull the user application out of a low power state and back into normal operating mode. If the USB interface is enumerated with the USB_OPT_AUTO_PLL option set, the library will automatically restart the USB PLL before the event is fired.

Note
  This event does not exist if the `USB_HOST_ONLY` token is supplied to the compiler (see USB Interface Management documentation).
  This event does not exist on the microcontrollers with limited USB VBUS sensing abilities when the `NO_LIMITED_CONTROLLER_CONNECT` compile time token is not set - see EVENT_USB_Device_Disconnect.

See Also
  EVENT_USB_Device_Suspend() event for accompanying Suspend event.

void EVENT_USB_Host_DeviceAttached | ( | const uint8_t | corenum | ) |

Event for USB device attachment. This event fires when a the USB interface is in host mode, and a USB device has been connected to the USB interface. This is interrupt driven, thus fires before the standard EVENT_USB_Device_Connect() event and so can be used to programmatically start the USB management task to reduce CPU consumption.

Note
  This event only exists on microcontrollers that supports USB host mode.
  This event does not exist if the `USB_DEVICE_ONLY` token is supplied to the compiler (see USB Interface Management documentation).

See Also
  USB_USBTask() for more information on the USB management task and reducing CPU usage.

Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and starts the library USB task to begin the enumeration and USB management process.

Definition at line 163 of file AudioOutputHost.c.

void EVENT_USB_Host_DeviceEnumerationComplete | ( | const uint8_t | corenum | ) |

Event for USB device enumeration completion. This event fires when a the USB interface is in host mode and an attached USB device has been completely enumerated and is ready to be controlled by the user application.

This event is time-critical; exceeding OS-specific delays within this event handler (typically of around 1 second) when a transaction is waiting to be processed by the device will prevent break communications and cause the host to reset the USB bus.

Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully enumerated by the host and is now ready to be used by the application.

Definition at line 180 of file AudioOutputHost.c.

void EVENT_USB_Host_DeviceEnumerationFailed | ( | const uint8_t | corenum,
|  | const uint8_t | ErrorCode,
|  | const uint8_t | SubErrorCode
| ) |  |

Event for USB device enumeration failure. This event fires when a the USB interface is in host mode, and an attached USB device has failed to enumerate completely.

Parameters

  corenum | : USB port number
  ErrorCode | Error code indicating the failure reason, a value in USB_Host_EnumerationErrorCodes_t.
  SubErrorCode | Sub error code indicating the reason for failure - for example, if the ErrorCode parameter indicates a control error, this will give the error code returned by the USB_Host_SendControlRequest() function.

Note
  This event only exists on microcontrollers that supports USB host mode.
  This event does not exist if the `USB_DEVICE_ONLY` token is supplied to the compiler (see USB Interface Management documentation).

Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while enumerating an attached USB device.

Definition at line 242 of file AudioOutputHost.c.

void EVENT_USB_Host_DeviceUnattached | ( | const uint8_t | corenum | ) |

Event for USB device removal. This event fires when a the USB interface is in host mode, and a USB device has been removed the USB interface whether or not it has been enumerated. This can be used to programmatically stop the USB management task to reduce CPU consumption.

Note
  This event only exists on microcontrollers that supports USB host mode.
  This event does not exist if the `USB_DEVICE_ONLY` token is supplied to the compiler (see USB Interface Management documentation).

See Also
  USB_USBTask() for more information on the USB management task and reducing CPU usage.

Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and stops the library USB task management process.

Definition at line 171 of file AudioOutputHost.c.

void EVENT_USB_Host_HostError | ( | const uint8_t | corenum,
|  | const uint8_t | ErrorCode
| ) |  |

Event for USB host error. This event fires when a hardware fault has occurred whilst the USB interface is in host mode.

Parameters

  corenum | : USB port number
  ErrorCode | : Error code indicating the failure reason, a value in USB_Host_ErrorCodes_t.

Note
  This event only exists on microcontrollers that supports USB host mode.
  This event does not exist if the `USB_DEVICE_ONLY` token is supplied to the compiler (see USB Interface Management documentation).

Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode.

Definition at line 228 of file AudioOutputHost.c.

void EVENT_USB_Host_StartOfFrame | ( | const uint8_t | corenum | ) |

Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB frame, once per millisecond, and is synchronized to the USB bus. This can be used as an accurate millisecond timer source when the USB bus is not suspended while in host mode.

This event is time-critical; it is run once per millisecond and thus long handlers will significantly degrade device performance. This event should only be enabled when needed to reduce device wake-ups.

Note
  This event is not normally active - it must be manually enabled and disabled via the USB_Host_EnableSOFEvents() and USB_Host_DisableSOFEvents() commands after enumeration of a USB device.
  This event does not exist if the `USB_DEVICE_ONLY` token is supplied to the compiler (see USB Interface Management documentation).

void EVENT_USB_UIDChange | ( | void |  | ) |

Event for USB mode pin level change. This event fires when the USB interface is set to dual role mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires before the mode is switched to the newly indicated mode but after the EVENT_USB_Device_Disconnect event has fired (if disconnected before the role change).

Note
  This event only exists on microcontrollers that support dual role USB modes.
  This event does not exist if the `USB_DEVICE_ONLY` or `USB_HOST_ONLY` tokens have been supplied to the compiler (see USB Interface Management documentation).