Functions | |
void | EVENT_USB_InitFailure (const uint8_t ErrorCode) |
void | EVENT_USB_UIDChange (void) |
void | EVENT_USB_Host_HostError (const uint8_t ErrorCode) |
void | EVENT_USB_Host_DeviceAttached (void) |
void | EVENT_USB_Host_DeviceUnattached (void) |
void | EVENT_USB_Host_DeviceEnumerationFailed (const uint8_t ErrorCode, const uint8_t SubErrorCode) |
void | EVENT_USB_Host_DeviceEnumerationComplete (void) |
void | EVENT_USB_Device_Connect (void) |
void | EVENT_USB_Device_Disconnect (void) |
void | EVENT_USB_Device_UnhandledControlRequest (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) |
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).
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_ConfigurationNumber has been changed.
void EVENT_USB_Device_Connect | ( | void | ) |
Event for USB device connection. This event fires when the AVR in device mode and the device is connected to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS 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.
void EVENT_USB_Device_Disconnect | ( | void | ) |
Event for USB device disconnection. This event fires when the AVR in device mode and the device is disconnected from a host, measured by a falling level on the AVR's VBUS pin.
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.
void EVENT_USB_Device_StartOfFrame | ( | void | ) |
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.
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.
void EVENT_USB_Device_UnhandledControlRequest | ( | void | ) |
Event for unhandled control requests. This event fires when a the USB host issues a control request to the control endpoint (address 0) that the library does not handle. This may either be a standard request that the library has no handler code for, or a class specific request issued to the device which must be handled appropriately.
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, requests are automatically STALLed.
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.
void EVENT_USB_Host_DeviceAttached | ( | void | ) |
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.
void EVENT_USB_Host_DeviceEnumerationComplete | ( | void | ) |
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.
void EVENT_USB_Host_DeviceEnumerationFailed | ( | 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.
[in] | ErrorCode | Error code indicating the failure reason, a value in USB_Host_EnumerationErrorCodes_t. |
[in] | 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. |
void EVENT_USB_Host_DeviceUnattached | ( | void | ) |
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.
void EVENT_USB_Host_HostError | ( | 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.
[in] | ErrorCode | Error code indicating the failure reason, a value in USB_Host_ErrorCodes_t. |
void EVENT_USB_InitFailure | ( | const uint8_t | ErrorCode | ) |
Event for USB stack initialization failure. This event fires when the USB interface fails to initialize correctly due to a hardware or software fault.
[in] | ErrorCode | Error code indicating the failure reason, a value in USB_InitErrorCodes_t. |
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 connected before the role change).