![]() |
LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
|
USB Host definitions for the LPC microcontrollers. More...
Macros | |
#define | USB_HOST_DEVICEADDRESS 1 |
#define | USB_HOST_TIMEOUT_MS 1000 |
#define | HOST_DEVICE_SETTLE_DELAY_MS 1000 |
Enumerations | |
enum | USB_Host_ErrorCodes_t { HOST_ERROR_VBusVoltageDip = 0 } |
enum | USB_Host_EnumerationErrorCodes_t { HOST_ENUMERROR_NoError = 0, HOST_ENUMERROR_WaitStage = 1, HOST_ENUMERROR_NoDeviceDetected = 2, HOST_ENUMERROR_ControlError = 3, HOST_ENUMERROR_PipeConfigError = 4 } |
Functions | |
uint8_t | USB_Host_GetActiveHost (void) |
static void | USB_Host_EnableSOFEvents (void) ATTR_ALWAYS_INLINE |
Enables the host mode Start Of Frame events. When enabled, this causes the EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus, at the start of each USB frame when a device is enumerated while in host mode. | |
static void | USB_Host_DisableSOFEvents (void) ATTR_ALWAYS_INLINE |
Disables the host mode Start Of Frame events. When disabled, this stops the firing of the EVENT_USB_Host_StartOfFrame() event when enumerated in host mode. | |
static void | USB_Host_ResetBus (void) ATTR_ALWAYS_INLINE |
Resets the USB bus, including the endpoints in any attached device and pipes on the LPC host. USB bus resets leave the default control pipe configured (if already configured). | |
static bool | USB_Host_IsBusResetComplete (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
Determines if a previously issued bus reset (via the USB_Host_ResetBus() macro) has completed. | |
static void | USB_Host_ResumeBus (void) ATTR_ALWAYS_INLINE |
Resumes USB communications with an attached and enumerated device, by resuming the transmission of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the host and attached device may occur. | |
static void | USB_Host_SuspendBus (void) ATTR_ALWAYS_INLINE |
Suspends the USB bus, preventing any communications from occurring between the host and attached device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame messages to the device. | |
static bool | USB_Host_IsBusSuspended (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
Determines if the USB bus has been suspended via the use of the USB_Host_SuspendBus() macro, false otherwise. While suspended, no USB communications can occur until the bus is resumed, except for the Remote Wakeup event from the device if supported. | |
static bool | USB_Host_IsDeviceFullSpeed (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or false if the attached device is enumerated in Low Speed mode (1.5Mb/s). | |
static bool | USB_Host_IsRemoteWakeupSent (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
Determines if the attached device is currently issuing a Remote Wakeup request, requesting that the host resume the USB bus and wake up the device, false otherwise. | |
static void | USB_Host_ClearRemoteWakeupSent (void) ATTR_ALWAYS_INLINE |
static void | USB_Host_ResumeFromWakeupRequest (void) ATTR_ALWAYS_INLINE |
static bool | USB_Host_IsResumeFromWakeupRequestSent (void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE |
Determines if a resume from Remote Wakeup request is currently being sent to an attached device. | |
Variables | |
uint8_t | USB_Host_ControlPipeSize [MAX_USB_CORE] |
USB Host definitions for the LPC microcontrollers.
Architecture specific USB Host definitions for the LPC microcontrollers.
#define HOST_DEVICE_SETTLE_DELAY_MS 1000 |
Constant for the delay in milliseconds after a device is connected before the library will start the enumeration process. Some devices require a delay of up to 5 seconds after connection before the enumeration process can start or incorrect operation will occur.
The default delay value may be overridden in the user project makefile by defining the HOST_DEVICE_SETTLE_DELAY_MS
token to the required delay in milliseconds, and passed to the compiler using the -D switch.
Definition at line 90 of file Host_LPC.h.
#define USB_HOST_DEVICEADDRESS 1 |
Indicates the fixed USB device address which any attached device is enumerated to when in host mode. As only one USB device may be attached to the LPC in host mode at any one time and that the address used is not important (other than the fact that it is non-zero), a fixed value is specified by the library.
Definition at line 67 of file Host_LPC.h.
#define USB_HOST_TIMEOUT_MS 1000 |
Constant for the maximum software timeout period of sent USB control transactions to an attached device. If a device fails to respond to a sent control request within this period, the library will return a timeout error code.
This value may be overridden in the user project makefile as the value of the USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
Definition at line 77 of file Host_LPC.h.
Enum for the error codes for the EVENT_USB_Host_DeviceEnumerationFailed() event.
HOST_ENUMERROR_NoError |
No error occurred. Used internally, this is not a valid ErrorCode parameter value for the EVENT_USB_Host_DeviceEnumerationFailed() event. |
HOST_ENUMERROR_WaitStage |
One of the delays between enumeration steps failed to complete successfully, due to a timeout or other error. |
HOST_ENUMERROR_NoDeviceDetected |
No device was detected, despite the USB data lines indicating the attachment of a device. |
HOST_ENUMERROR_ControlError |
One of the enumeration control requests failed to complete successfully. |
HOST_ENUMERROR_PipeConfigError |
The default control pipe (address 0) failed to configure correctly. |
Definition at line 110 of file Host_LPC.h.
Enum for the error codes for the EVENT_USB_Host_HostError() event.
Definition at line 97 of file Host_LPC.h.
|
inlinestatic |
Clears the flag indicating that a Remote Wakeup request has been issued by an attached device.
Definition at line 254 of file Host_LPC.h.
|
inlinestatic |
Disables the host mode Start Of Frame events. When disabled, this stops the firing of the EVENT_USB_Host_StartOfFrame() event when enumerated in host mode.
Definition at line 159 of file Host_LPC.h.
|
inlinestatic |
Enables the host mode Start Of Frame events. When enabled, this causes the EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus, at the start of each USB frame when a device is enumerated while in host mode.
NO_SOF_EVENTS
compile time token is defined. Definition at line 147 of file Host_LPC.h.
uint8_t USB_Host_GetActiveHost | ( | void | ) |
Definition at line 225 of file Host_LPC.c.
|
inlinestatic |
Determines if a previously issued bus reset (via the USB_Host_ResetBus() macro) has completed.
true
if no bus reset is currently being sent, false
otherwise. Definition at line 184 of file Host_LPC.h.
|
inlinestatic |
Determines if the USB bus has been suspended via the use of the USB_Host_SuspendBus() macro, false otherwise. While suspended, no USB communications can occur until the bus is resumed, except for the Remote Wakeup event from the device if supported.
true
if the bus is currently suspended, false
otherwise. Definition at line 220 of file Host_LPC.h.
|
inlinestatic |
Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
true
if the attached device is enumerated in Full Speed mode, false
otherwise. Definition at line 233 of file Host_LPC.h.
|
inlinestatic |
Determines if the attached device is currently issuing a Remote Wakeup request, requesting that the host resume the USB bus and wake up the device, false otherwise.
true
if the attached device has sent a Remote Wakeup request, false
otherwise. Definition at line 246 of file Host_LPC.h.
|
inlinestatic |
Determines if a resume from Remote Wakeup request is currently being sent to an attached device.
true
if no resume request is currently being sent, false
otherwise. Definition at line 274 of file Host_LPC.h.
|
inlinestatic |
Resets the USB bus, including the endpoints in any attached device and pipes on the LPC host. USB bus resets leave the default control pipe configured (if already configured).
If the USB bus has been suspended prior to issuing a bus reset, the attached device will be woken up automatically and the bus resumed after the reset has been correctly issued.
Definition at line 174 of file Host_LPC.h.
|
inlinestatic |
Resumes USB communications with an attached and enumerated device, by resuming the transmission of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the host and attached device may occur.
Definition at line 197 of file Host_LPC.h.
|
inlinestatic |
Accepts a Remote Wakeup request from an attached device. This must be issued in response to a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to be resumed.
Definition at line 263 of file Host_LPC.h.
|
inlinestatic |
Suspends the USB bus, preventing any communications from occurring between the host and attached device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame messages to the device.
Definition at line 208 of file Host_LPC.h.
uint8_t USB_Host_ControlPipeSize[MAX_USB_CORE] |
Definition at line 41 of file Host_LPC.c.