LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Host_LPC.h File Reference
#include "../../../../Common/Common.h"
#include "../StdDescriptors.h"
#include "../Pipe.h"
#include "../USBInterrupt.h"

Go to the source code of this file.

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]