Host.h

Go to the documentation of this file.

/*
 * @brief Common USB Host definitions for all architectures
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * Copyright(C) Dean Camera, 2011, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __USBHOST_H__
#define __USBHOST_H__

 /* Includes: */
  #include "../../../Common/Common.h"
  #include "USBMode.h"  

 /* Enable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
   extern "C" {
  #endif

 /* Preprocessor Checks: */
  #if !defined(__INCLUDE_FROM_USB_DRIVER)
   #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
  #endif

 /* Public Interface - May be used in end-application: */
  /* Enums: */
   enum USB_Host_States_t
   {
    HOST_STATE_WaitForDevice                = 0,  
    HOST_STATE_Unattached                   = 1,  
    HOST_STATE_Powered                      = 2,  
    HOST_STATE_Powered_WaitForDeviceSettle  = 3,  
    HOST_STATE_Powered_WaitForConnect       = 4,  
    HOST_STATE_Powered_DoReset              = 5,  
    HOST_STATE_Powered_ConfigPipe           = 6,  
    HOST_STATE_Default                      = 7,  
    HOST_STATE_Default_PostReset            = 8,  
    HOST_STATE_Default_PostAddressSet       = 9,  
    HOST_STATE_Addressed                    = 10, 
    HOST_STATE_Configured                   = 11, 
   };

  #include "StdDescriptors.h"
  #include "Pipe.h"
  #include "USBInterrupt.h"
  
  /* Macros: */
     #define USB_HOST_DEVICEADDRESS                 1

     #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)

      #define USB_HOST_TIMEOUT_MS                1000
     #endif

     #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__)

      #define HOST_DEVICE_SETTLE_DELAY_MS        1000
     #endif

  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,   
  };

  uint8_t USB_Host_GetActiveHost(void);

  extern uint8_t USB_Host_ControlPipeSize[MAX_USB_CORE];

  /* Inline Functions: */
     #if !defined(NO_SOF_EVENTS)

  static inline void USB_Host_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_EnableSOFEvents(void)
  {}

  static inline void USB_Host_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_DisableSOFEvents(void)
  {}

     #endif

  static inline void USB_Host_ResetBus(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_ResetBus(void)
  {}

  static inline bool USB_Host_IsBusResetComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

  static inline bool USB_Host_IsBusResetComplete(void)
  {
   return true;
  }

  static inline void USB_Host_ResumeBus(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_ResumeBus(void)
  {}

  static inline void USB_Host_SuspendBus(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_SuspendBus(void)
  {}

  static inline bool USB_Host_IsBusSuspended(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

  static inline bool USB_Host_IsBusSuspended(void)
  {
   return false;
  }

  static inline bool USB_Host_IsDeviceFullSpeed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

  static inline bool USB_Host_IsDeviceFullSpeed(void)
  {
   return true;   // implement later when needed
  }

  static inline bool USB_Host_IsRemoteWakeupSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

  static inline bool USB_Host_IsRemoteWakeupSent(void)
  {
   return false;
  }

  static inline void USB_Host_ClearRemoteWakeupSent(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_ClearRemoteWakeupSent(void)
  {}

  static inline void USB_Host_ResumeFromWakeupRequest(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_ResumeFromWakeupRequest(void)
  {}

  static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

  static inline bool USB_Host_IsResumeFromWakeupRequestSent(void)
  {
   return false;
  }

  /* Private Interface - For use in library only: */
   #if !defined(__DOXYGEN__)
  /* Macros: */
  static inline void USB_Host_HostMode_On(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_HostMode_On(void)
  {}

  static inline void USB_Host_HostMode_Off(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_HostMode_Off(void)
  {}

  static inline void USB_Host_VBUS_Auto_Enable(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_VBUS_Auto_Enable(void)
  {}

  static inline void USB_Host_VBUS_Manual_Enable(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_VBUS_Manual_Enable(void)
  {}

  static inline void USB_Host_VBUS_Auto_On(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_VBUS_Auto_On(void)
  {}

  static inline void USB_Host_VBUS_Manual_On(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_VBUS_Manual_On(void)
  {}

  static inline void USB_Host_VBUS_Auto_Off(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_VBUS_Auto_Off(void)
  {}

  static inline void USB_Host_VBUS_Manual_Off(void) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_VBUS_Manual_Off(void)
  {}

  static inline void USB_Host_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;

  static inline void USB_Host_SetDeviceAddress(const uint8_t Address)
  {}

  /* Enums: */
  enum USB_Host_WaitMSErrorCodes_t {
   HOST_WAITERROR_Successful       = 0,
   HOST_WAITERROR_DeviceDisconnect = 1,
   HOST_WAITERROR_PipeError        = 2,
   HOST_WAITERROR_SetupStalled     = 3,
  };

  /* Function Prototypes: */
  void    USB_Host_ProcessNextHostState(uint8_t corenum);

  uint8_t USB_Host_WaitMS(uint8_t MS);

  uint16_t USB_Host_GetFrameNumber(void);

     #if defined(__INCLUDE_FROM_HOST_C)
  // static void USB_Host_ResetDevice(void);
     #endif
   #endif


 /* Disable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
   }
  #endif

#endif