LUFA/Drivers/USB/LowLevel/Host.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \ingroup Group_USB
  32  *  @defgroup Group_Host Host Management
  33  *
  34  *  USB Host mode related macros and enums. This module contains macros and enums which are used when
  35  *  the USB controller is initialized in host mode.
  36  *
  37  *  @{
  38  */
  39
  40 #ifndef __USBHOST_H__
  41 #define __USBHOST_H__
  42
  43         /* Includes: */
  44                 #include <avr/io.h>
  45                 #include <stdbool.h>
  46                 #include <util/delay.h>
  47
  48                 #include "../../../Common/Common.h"
  49                 #include "../HighLevel/USBInterrupt.h"
  50
  51         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Public Interface - May be used in end-application: */
  57                 /* Macros: */
  58                         /** Indicates the fixed USB device address which any attached device is enumerated to when in
  59                          *  host mode. As only one USB device may be attached to the AVR in host mode at any one time
  60                          *  and that the address used is not important (other than the fact that it is non-zero), a
  61                          *  fixed value is specified by the library.
  62                          */
  63                         #define USB_HOST_DEVICEADDRESS                 1
  64
  65                         #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)
  66                                 /** Constant for the maximum software timeout period of sent USB control transactions to an attached
  67                                  *  device. If a device fails to respond to a sent control request within this period, the
  68                                  *  library will return a timeout error code.
  69                                  *
  70                                  *  This value may be overridden in the user project makefile as the value of the
  71                                  *  \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
  72                                  */
  73                                 #define USB_HOST_TIMEOUT_MS                1000
  74                         #endif
  75
  76                         #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__)
  77                                 /** Constant for the delay in milliseconds after a device is connected before the library
  78                                  *  will start the enumeration process. Some devices require a delay of up to 5 seconds
  79                                  *  after connection before the enumeration process can start or incorrect operation will
  80                                  *  occur.
  81                                  *
  82                                  *  This value may be overridden in the user project makefile as the value of the
  83                                  *  HOST_DEVICE_SETTLE_DELAY_MS token, and passed to the compiler using the -D switch.
  84                                  */
  85                                 #define HOST_DEVICE_SETTLE_DELAY_MS        1500
  86                         #endif
  87
  88                 /* Pseudo-Function Macros: */
  89                         #if defined(__DOXYGEN__)
  90                                 /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.
  91                                  *  USB bus resets leave the default control pipe configured (if already configured).
  92                                  *
  93                                  *  If the USB bus has been suspended prior to issuing a bus reset, the attached device will be
  94                                  *  woken up automatically and the bus resumed after the reset has been correctly issued.
  95                                  */
  96                                 static inline void USB_Host_ResetBus(void);
  97
  98                                 /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has
  99                                  *  completed.
 100                                  *
 101                                  *  \return Boolean true if no bus reset is currently being sent, false otherwise.
 102                                  */
 103                                 static inline void USB_Host_IsBusResetComplete(void);
 104
 105                                 /** Resumes USB communications with an attached and enumerated device, by resuming the transmission
 106                                  *  of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the
 107                                  *  host and attached device may occur.
 108                                  */
 109                                 static inline void USB_Host_ResumeBus(void);
 110
 111                                 /** Suspends the USB bus, preventing any communications from occurring between the host and attached
 112                                  *  device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame
 113                                  *  messages to the device.
 114                                  */
 115                                 static inline void USB_Host_SuspendBus(void);
 116
 117                                 /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,
 118                                  *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,
 119                                  *  except for the Remote Wakeup event from the device if supported.
 120                                  *
 121                                  *  \return Boolean true if the bus is currently suspended, false otherwise
 122                                  */
 123                                  static inline bool USB_Host_IsBusSuspended(void);
 124
 125                                 /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or
 126                                  *  false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
 127                                  *
 128                                  *  \return Boolean true if the attached device is enumerated in Full Speed mode, false otherwise
 129                                  */
 130                                 static inline bool USB_Host_IsDeviceFullSpeed(void);
 131
 132                                 /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
 133                                  *  that the host resume the USB bus and wake up the device, false otherwise.
 134                                  *
 135                                  *  \return Boolean true if the attached device has sent a Remote Wakeup request, false otherwise
 136                                  */
 137                                 static inline bool USB_Host_IsRemoteWakeupSent(void);
 138
 139                                 /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */
 140                                 static inline void USB_Host_ClearRemoteWakeupSent(void);
 141
 142                                 /** Accepts a Remote Wakeup request from an attached device. This must be issued in response to
 143                                  *  a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to
 144                                  *  be resumed.
 145                                  */
 146                                 static inline void USB_Host_ResumeFromWakeupRequest(void);
 147
 148                                 /** Determines if a resume from Remote Wakeup request is currently being sent to an attached
 149                                  *  device.
 150                                  *
 151                                  *  \return Boolean true if no resume request is currently being sent, false otherwise
 152                                  */
 153                                 static inline bool USB_Host_IsResumeFromWakeupRequestSent(void);
 154                         #else
 155                                 #define USB_Host_ResetBus()                MACROS{ UHCON |=  (1 << RESET);          }MACROE
 156
 157                                 #define USB_Host_IsBusResetComplete()      ((UHCON &   (1 << RESET)) ? false : true)
 158
 159                                 #define USB_Host_ResumeBus()               MACROS{ UHCON |=  (1 << SOFEN);          }MACROE
 160
 161                                 #define USB_Host_SuspendBus()              MACROS{ UHCON &= ~(1 << SOFEN);          }MACROE
 162
 163                                 #define USB_Host_IsBusSuspended()                ((UHCON &   (1 << SOFEN)) ? false : true)
 164
 165                                 #define USB_Host_IsDeviceFullSpeed()             ((USBSTA &  (1 << SPEED)) ? true : false)
 166
 167                                 #define USB_Host_IsRemoteWakeupSent()            ((UHINT &   (1 << RXRSMI)) ? true : false)
 168
 169                                 #define USB_Host_ClearRemoteWakeupSent()   MACROS{ UHINT &= ~(1 << RXRSMI);         }MACROE
 170
 171                                 #define USB_Host_ResumeFromWakeupRequest() MACROS{ UHCON |=  (1 << RESUME);         }MACROE
 172
 173                                 #define USB_Host_IsResumeFromWakeupRequestSent() ((UHCON &   (1 << RESUME)) ? false : true)
 174                         #endif
 175
 176                 /* Function Prototypes: */
 177                         /** Convenience function. This routine sends a SetConfiguration standard request to the attached
 178                          *  device, with the given configuration index. This can be used to easily set the device
 179                          *  configuration without creating and sending the request manually.
 180                          *
 181                          *  \note After this routine returns, the control pipe will be selected.
 182                          *
 183                          *  \param ConfigNumber  Configuration index to send to the device
 184                          *
 185                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 186                          */
 187                         uint8_t USB_Host_SetDeviceConfiguration(uint8_t ConfigNumber);
 188
 189                 /* Enums: */
 190                         /** Enum for the various states of the USB Host state machine. Only some states are
 191                          *  implemented in the LUFA library - other states are left to the user to implement.
 192                          *
 193                          *  For information on each state, refer to the USB 2.0 specification. Some states have
 194                          *
 195                          *  \see \ref USB_HostState, which stores the current host state machine state.
 196                          */
 197                         enum USB_Host_States_t
 198                         {
 199                                 HOST_STATE_WaitForDevice                = 0,  /**< Internally implemented by the library. */
 200                                 HOST_STATE_Unattached                   = 1,  /**< Internally implemented by the library. */
 201                                 HOST_STATE_Attached                     = 2,  /**< Internally implemented by the library. */
 202                                 HOST_STATE_Attached_WaitForDeviceSettle = 3,  /**< Internally implemented by the library. */
 203                                 HOST_STATE_Attached_WaitForConnect      = 4,  /**< Internally implemented by the library. */
 204                                 HOST_STATE_Attached_DoReset             = 5,  /**< Internally implemented by the library. */
 205                                 HOST_STATE_Powered                      = 6,  /**< Internally implemented by the library. */
 206                                 HOST_STATE_Default                      = 7,  /**< Internally implemented by the library. */
 207                                 HOST_STATE_Default_PostReset            = 8,  /**< Internally implemented by the library. */
 208                                 HOST_STATE_Default_PostAddressSet       = 9,  /**< Internally implemented by the library. */
 209                                 HOST_STATE_Addressed                    = 10, /**< May be implemented by the user project. */
 210                                 HOST_STATE_Configured                   = 11, /**< May be implemented by the user project. */
 211                                 HOST_STATE_Ready                        = 12, /**< May be implemented by the user project. */
 212                                 HOST_STATE_Suspended                    = 13, /**< May be implemented by the user project. */
 213                         };
 214
 215                         /** Enum for the error codes for the \ref EVENT_USB_HostError() event.
 216                          *
 217                          *  \see \ref Group_Events for more information on this event.
 218                          */
 219                         enum USB_Host_ErrorCodes_t
 220                         {
 221                                 HOST_ERROR_VBusVoltageDip       = 0, /**< VBUS voltage dipped to an unacceptable level. This
 222                                                                       *   error may be the result of an attached device drawing
 223                                                                       *   too much current from the VBUS line, or due to the
 224                                                                       *   AVR's power source being unable to supply sufficient
 225                                                                       *   current.
 226                                                                       */
 227                         };
 228
 229                         /** Enum for the error codes for the \ref EVENT_USB_DeviceEnumerationFailed() event.
 230                          *
 231                          *  \see \ref Group_Events for more information on this event.
 232                          */
 233                         enum USB_Host_EnumerationErrorCodes_t
 234                         {
 235                                 HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid
 236                                                                       *   ErrorCode parameter value for the \ref EVENT_USB_DeviceEnumerationFailed()
 237                                                                       *   event.
 238                                                                       */
 239                                 HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed
 240                                                                       *   to complete successfully, due to a timeout or other
 241                                                                       *   error.
 242                                                                       */
 243                                 HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines
 244                                                                       *   indicating the attachment of a device.
 245                                                                       */
 246                                 HOST_ENUMERROR_ControlError     = 3, /**< One of the enumeration control requests failed to
 247                                                                       *   complete successfully.
 248                                                                                                           */
 249                                 HOST_ENUMERROR_PipeConfigError  = 4, /**< The default control pipe (address 0) failed to
 250                                                                       *   configure correctly.
 251                                                                       */
 252                         };
 253
 254         /* Private Interface - For use in library only: */
 255         #if !defined(__DOXYGEN__)
 256                 /* Macros: */
 257                         #define USB_Host_HostMode_On()          MACROS{ USBCON |=  (1 << HOST);           }MACROE
 258                         #define USB_Host_HostMode_Off()         MACROS{ USBCON &= ~(1 << HOST);           }MACROE
 259
 260                         #define USB_Host_VBUS_Auto_Enable()     MACROS{ OTGCON &= ~(1 << VBUSHWC); UHWCON |=  (1 << UVCONE);                   }MACROE
 261                         #define USB_Host_VBUS_Manual_Enable()   MACROS{ OTGCON |=  (1 << VBUSHWC); UHWCON &= ~(1 << UVCONE); DDRE |= (1 << 7); }MACROE
 262
 263                         #define USB_Host_VBUS_Auto_On()         MACROS{ OTGCON |= (1 << VBUSREQ);         }MACROE
 264                         #define USB_Host_VBUS_Manual_On()       MACROS{ PORTE  |= (1 << 7);               }MACROE
 265
 266                         #define USB_Host_VBUS_Auto_Off()        MACROS{ OTGCON |=  (1 << VBUSRQC);        }MACROE
 267                         #define USB_Host_VBUS_Manual_Off()      MACROS{ PORTE  &= ~(1 << 7);              }MACROE
 268
 269                         #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR  =  (addr & 0x7F);         }MACROE
 270
 271                 /* Enums: */
 272                         enum USB_Host_WaitMSErrorCodes_t
 273                         {
 274                                 HOST_WAITERROR_Successful       = 0,
 275                                 HOST_WAITERROR_DeviceDisconnect = 1,
 276                                 HOST_WAITERROR_PipeError        = 2,
 277                                 HOST_WAITERROR_SetupStalled     = 3,
 278                         };
 279
 280                 /* Function Prototypes: */
 281                         void    USB_Host_ProcessNextHostState(void);
 282                         uint8_t USB_Host_WaitMS(uint8_t MS);
 283
 284                         #if defined(INCLUDE_FROM_HOST_C)
 285                                 static void USB_Host_ResetDevice(void);
 286                         #endif
 287         #endif
 288
 289         /* Disable C linkage for C++ Compilers: */
 290                 #if defined(__cplusplus)
 291                         }
 292                 #endif
 293
 294 #endif
 295
 296 /** @} */