LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 /** \file
  32  *  \brief USB Host definitions for the AVR8 microcontrollers.
  33  *  \copydetails Group_Host_AVR8
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  36  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  37  */
  38
  39 /** \ingroup Group_Host
  40  *  \defgroup Group_Host_AVR8 Host Management (AVR8)
  41  *  \brief USB Host definitions for the AVR8 microcontrollers.
  42  *
  43  *  Architecture specific USB Host definitions for the Atmel 8-bit AVR microcontrollers.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __USBHOST_AVR8_H__
  49 #define __USBHOST_AVR8_H__
  50
  51         /* Includes: */
  52                 #include "../../../../Common/Common.h"
  53                 #include "../StdDescriptors.h"
  54                 #include "../Pipe.h"
  55                 #include "../USBInterrupt.h"
  56
  57         /* Enable C linkage for C++ Compilers: */
  58                 #if defined(__cplusplus)
  59                         extern "C" {
  60                 #endif
  61
  62         /* Preprocessor Checks: */
  63                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  64                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  65                 #endif
  66
  67         /* Public Interface - May be used in end-application: */
  68                 /* Macros: */
  69                         /** Indicates the fixed USB device address which any attached device is enumerated to when in
  70                          *  host mode. As only one USB device may be attached to the AVR in host mode at any one time
  71                          *  and that the address used is not important (other than the fact that it is non-zero), a
  72                          *  fixed value is specified by the library.
  73                          */
  74                         #define USB_HOST_DEVICEADDRESS                 1
  75
  76                         #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)
  77                                 /** Constant for the maximum software timeout period of sent USB control transactions to an attached
  78                                  *  device. If a device fails to respond to a sent control request within this period, the
  79                                  *  library will return a timeout error code.
  80                                  *
  81                                  *  This value may be overridden in the user project makefile as the value of the
  82                                  *  \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
  83                                  */
  84                                 #define USB_HOST_TIMEOUT_MS                1000
  85                         #endif
  86
  87                         #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__)
  88                                 /** Constant for the delay in milliseconds after a device is connected before the library
  89                                  *  will start the enumeration process. Some devices require a delay of up to 5 seconds
  90                                  *  after connection before the enumeration process can start or incorrect operation will
  91                                  *  occur.
  92                                  *
  93                                  *  The default delay value may be overridden in the user project makefile by defining the
  94                                  *  \c HOST_DEVICE_SETTLE_DELAY_MS token to the required delay in milliseconds, and passed to the
  95                                  *  compiler using the -D switch.
  96                                  */
  97                                 #define HOST_DEVICE_SETTLE_DELAY_MS        1000
  98                         #endif
  99
 100                         /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event.
 101                          *
 102                          *  \see \ref Group_Events for more information on this event.
 103                          */
 104                         enum USB_Host_ErrorCodes_t
 105                         {
 106                                 HOST_ERROR_VBusVoltageDip       = 0, /**< VBUS voltage dipped to an unacceptable level. This
 107                                                                       *   error may be the result of an attached device drawing
 108                                                                       *   too much current from the VBUS line, or due to the
 109                                                                       *   AVR's power source being unable to supply sufficient
 110                                                                       *   current.
 111                                                                       */
 112                         };
 113
 114                         /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event.
 115                          *
 116                          *  \see \ref Group_Events for more information on this event.
 117                          */
 118                         enum USB_Host_EnumerationErrorCodes_t
 119                         {
 120                                 HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid
 121                                                                       *   ErrorCode parameter value for the \ref EVENT_USB_Host_DeviceEnumerationFailed()
 122                                                                       *   event.
 123                                                                       */
 124                                 HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed
 125                                                                       *   to complete successfully, due to a timeout or other
 126                                                                       *   error.
 127                                                                       */
 128                                 HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines
 129                                                                       *   indicating the attachment of a device.
 130                                                                       */
 131                                 HOST_ENUMERROR_ControlError     = 3, /**< One of the enumeration control requests failed to
 132                                                                       *   complete successfully.
 133                                                                       */
 134                                 HOST_ENUMERROR_PipeConfigError  = 4, /**< The default control pipe (address 0) failed to
 135                                                                       *   configure correctly.
 136                                                                       */
 137                         };
 138
 139                 /* Inline Functions: */
 140                         /** Returns the current USB frame number, when in host mode. Every millisecond the USB bus is active (i.e. not suspended)
 141                          *  the frame number is incremented by one.
 142                          */
 143                         static inline uint16_t USB_Host_GetFrameNumber(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 144                         static inline uint16_t USB_Host_GetFrameNumber(void)
 145                         {
 146                                 return UHFNUM;
 147                         }
 148
 149                         #if !defined(NO_SOF_EVENTS)
 150                                 /** Enables the host mode Start Of Frame events. When enabled, this causes the
 151                                  *  \ref EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 152                                  *  at the start of each USB frame when a device is enumerated while in host mode.
 153                                  *
 154                                  *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
 155                                  */
 156                                 static inline void USB_Host_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
 157                                 static inline void USB_Host_EnableSOFEvents(void)
 158                                 {
 159                                         USB_INT_Enable(USB_INT_HSOFI);
 160                                 }
 161
 162                                 /** Disables the host mode Start Of Frame events. When disabled, this stops the firing of the
 163                                  *  \ref EVENT_USB_Host_StartOfFrame() event when enumerated in host mode.
 164                                  *
 165                                  *  \note Not available when the NO_SOF_EVENTS compile time token is defined.
 166                                  */
 167                                 static inline void USB_Host_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
 168                                 static inline void USB_Host_DisableSOFEvents(void)
 169                                 {
 170                                         USB_INT_Disable(USB_INT_HSOFI);
 171                                 }
 172                         #endif
 173
 174                         /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.
 175                          *  USB bus resets leave the default control pipe configured (if already configured).
 176                          *
 177                          *  If the USB bus has been suspended prior to issuing a bus reset, the attached device will be
 178                          *  woken up automatically and the bus resumed after the reset has been correctly issued.
 179                          */
 180                         static inline void USB_Host_ResetBus(void) ATTR_ALWAYS_INLINE;
 181                         static inline void USB_Host_ResetBus(void)
 182                         {
 183                                 UHCON |=  (1 << RESET);
 184                         }
 185
 186                         /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has
 187                          *  completed.
 188                          *
 189                          *  \return Boolean \c true if no bus reset is currently being sent, \c false otherwise.
 190                          */
 191                         static inline bool USB_Host_IsBusResetComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 192                         static inline bool USB_Host_IsBusResetComplete(void)
 193                         {
 194                                 return ((UHCON & (1 << RESET)) ? false : true);
 195                         }
 196
 197                         /** Resumes USB communications with an attached and enumerated device, by resuming the transmission
 198                          *  of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the
 199                          *  host and attached device may occur.
 200                          */
 201                         static inline void USB_Host_ResumeBus(void) ATTR_ALWAYS_INLINE;
 202                         static inline void USB_Host_ResumeBus(void)
 203                         {
 204                                 UHCON |=  (1 << SOFEN);
 205                         }
 206
 207                         /** Suspends the USB bus, preventing any communications from occurring between the host and attached
 208                          *  device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame
 209                          *  messages to the device.
 210                          */
 211                         static inline void USB_Host_SuspendBus(void) ATTR_ALWAYS_INLINE;
 212                         static inline void USB_Host_SuspendBus(void)
 213                         {
 214                                 UHCON &= ~(1 << SOFEN);
 215                         }
 216
 217                         /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,
 218                          *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,
 219                          *  except for the Remote Wakeup event from the device if supported.
 220                          *
 221                          *  \return Boolean \c true if the bus is currently suspended, \c false otherwise.
 222                          */
 223                         static inline bool USB_Host_IsBusSuspended(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 224                         static inline bool USB_Host_IsBusSuspended(void)
 225                         {
 226                                 return ((UHCON & (1 << SOFEN)) ? false : true);
 227                         }
 228
 229                         /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or
 230                          *  false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
 231                          *
 232                          *  \return Boolean \c true if the attached device is enumerated in Full Speed mode, \c false otherwise.
 233                          */
 234                         static inline bool USB_Host_IsDeviceFullSpeed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 235                         static inline bool USB_Host_IsDeviceFullSpeed(void)
 236                         {
 237                                 return ((USBSTA & (1 << SPEED)) ? true : false);
 238                         }
 239
 240                         /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
 241                          *  that the host resume the USB bus and wake up the device, false otherwise.
 242                          *
 243                          *  \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.
 244                          */
 245                         static inline bool USB_Host_IsRemoteWakeupSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 246                         static inline bool USB_Host_IsRemoteWakeupSent(void)
 247                         {
 248                                 return ((UHINT & (1 << RXRSMI)) ? true : false);
 249                         }
 250
 251                         /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */
 252                         static inline void USB_Host_ClearRemoteWakeupSent(void) ATTR_ALWAYS_INLINE;
 253                         static inline void USB_Host_ClearRemoteWakeupSent(void)
 254                         {
 255                                 UHINT &= ~(1 << RXRSMI);
 256                         }
 257
 258                         /** Accepts a Remote Wakeup request from an attached device. This must be issued in response to
 259                          *  a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to
 260                          *  be resumed.
 261                          */
 262                         static inline void USB_Host_ResumeFromWakeupRequest(void) ATTR_ALWAYS_INLINE;
 263                         static inline void USB_Host_ResumeFromWakeupRequest(void)
 264                         {
 265                                 UHCON |=  (1 << RESUME);
 266                         }
 267
 268                         /** Determines if a resume from Remote Wakeup request is currently being sent to an attached
 269                          *  device.
 270                          *
 271                          *  \return Boolean \c true if no resume request is currently being sent, \c false otherwise.
 272                          */
 273                         static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 274                         static inline bool USB_Host_IsResumeFromWakeupRequestSent(void)
 275                         {
 276                                 return ((UHCON & (1 << RESUME)) ? false : true);
 277                         }
 278
 279                 /* Function Prototypes: */
 280                         /** Convenience function. This routine sends a SET CONFIGURATION standard request to the attached
 281                          *  device, with the given configuration index. This can be used to easily set the device
 282                          *  configuration without creating and sending the request manually.
 283                          *
 284                          *  \note After this routine returns, the control pipe will be selected.
 285                          *
 286                          *  \param[in] ConfigNumber  Configuration index to send to the device.
 287                          *
 288                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 289                          */
 290                         uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);
 291
 292                         /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached
 293                          *  device, requesting the device descriptor. This can be used to easily retrieve information
 294                          *  about the device such as its VID, PID and power requirements.
 295                          *
 296                          *  \note After this routine returns, the control pipe will be selected.
 297                          *
 298                          *  \param[out] DeviceDescriptorPtr  Pointer to the destination device descriptor structure where
 299                          *                                   the read data is to be stored.
 300                          *
 301                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 302                          */
 303                         uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);
 304
 305                         /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached
 306                          *  device, requesting the string descriptor of the specified index. This can be used to easily
 307                          *  retrieve string descriptors from the device by index, after the index is obtained from the
 308                          *  Device or Configuration descriptors.
 309                          *
 310                          *  \note After this routine returns, the control pipe will be selected.
 311                          *
 312                          *  \param[in]  Index        Index of the string index to retrieve.
 313                          *  \param[out] Buffer       Pointer to the destination buffer where the retrieved string descriptor is
 314                          *                           to be stored.
 315                          *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer.
 316                          *
 317                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 318                          */
 319                         uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
 320                                                                    void* const Buffer,
 321                                                                    const uint8_t BufferLength);
 322
 323                         /** Clears a stall condition on the given pipe, via a CLEAR FEATURE standard request to the attached device.
 324                          *
 325                          *  \note After this routine returns, the control pipe will be selected.
 326                          *
 327                          *  \param[in] EndpointIndex  Index of the endpoint to clear, including the endpoint's direction.
 328                          *
 329                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 330                          */
 331                         uint8_t USB_Host_ClearPipeStall(const uint8_t EndpointIndex);
 332
 333                         /** Selects a given alternative setting for the specfied interface, via a SET INTERFACE standard request to
 334                          *  the attached device.
 335                          *
 336                          *  \note After this routine returns, the control pipe will be selected.
 337                          *
 338                          *  \param[in] InterfaceIndex  Index of the interface whose alternative setting is to be altered.
 339                          *  \param[in] AltSetting      Index of the interface's alternative setting which is to be selected.
 340                          *
 341                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 342                          */
 343                         uint8_t USB_Host_SetInterfaceAltSetting(const uint8_t InterfaceIndex,
 344                                                                                                         const uint8_t AltSetting);
 345
 346         /* Private Interface - For use in library only: */
 347         #if !defined(__DOXYGEN__)
 348                 /* Macros: */
 349                         static inline void USB_Host_HostMode_On(void) ATTR_ALWAYS_INLINE;
 350                         static inline void USB_Host_HostMode_On(void)
 351                         {
 352                                 USBCON |=  (1 << HOST);
 353                         }
 354
 355                         static inline void USB_Host_HostMode_Off(void) ATTR_ALWAYS_INLINE;
 356                         static inline void USB_Host_HostMode_Off(void)
 357                         {
 358                                 USBCON &= ~(1 << HOST);
 359                         }
 360
 361                         static inline void USB_Host_VBUS_Auto_Enable(void) ATTR_ALWAYS_INLINE;
 362                         static inline void USB_Host_VBUS_Auto_Enable(void)
 363                         {
 364                                 OTGCON &= ~(1 << VBUSHWC);
 365                                 UHWCON |=  (1 << UVCONE);
 366                         }
 367
 368                         static inline void USB_Host_VBUS_Manual_Enable(void) ATTR_ALWAYS_INLINE;
 369                         static inline void USB_Host_VBUS_Manual_Enable(void)
 370                         {
 371                                 OTGCON |=  (1 << VBUSHWC);
 372                                 UHWCON &= ~(1 << UVCONE);
 373
 374                                 DDRE   |=  (1 << 7);
 375                         }
 376
 377                         static inline void USB_Host_VBUS_Auto_On(void) ATTR_ALWAYS_INLINE;
 378                         static inline void USB_Host_VBUS_Auto_On(void)
 379                         {
 380                                 OTGCON |=  (1 << VBUSREQ);
 381                         }
 382
 383                         static inline void USB_Host_VBUS_Manual_On(void) ATTR_ALWAYS_INLINE;
 384                         static inline void USB_Host_VBUS_Manual_On(void)
 385                         {
 386                                 PORTE  |=  (1 << 7);
 387                         }
 388
 389                         static inline void USB_Host_VBUS_Auto_Off(void) ATTR_ALWAYS_INLINE;
 390                         static inline void USB_Host_VBUS_Auto_Off(void)
 391                         {
 392                                 OTGCON |=  (1 << VBUSRQC);
 393                         }
 394
 395                         static inline void USB_Host_VBUS_Manual_Off(void) ATTR_ALWAYS_INLINE;
 396                         static inline void USB_Host_VBUS_Manual_Off(void)
 397                         {
 398                                 PORTE  &= ~(1 << 7);
 399                         }
 400
 401                         static inline void USB_Host_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
 402                         static inline void USB_Host_SetDeviceAddress(const uint8_t Address)
 403                         {
 404                                 UHADDR  =  (Address & 0x7F);
 405                         }
 406
 407                 /* Enums: */
 408                         enum USB_Host_WaitMSErrorCodes_t
 409                         {
 410                                 HOST_WAITERROR_Successful       = 0,
 411                                 HOST_WAITERROR_DeviceDisconnect = 1,
 412                                 HOST_WAITERROR_PipeError        = 2,
 413                                 HOST_WAITERROR_SetupStalled     = 3,
 414                         };
 415
 416                 /* Function Prototypes: */
 417                         void    USB_Host_ProcessNextHostState(void);
 418                         uint8_t USB_Host_WaitMS(uint8_t MS);
 419
 420                         #if defined(__INCLUDE_FROM_HOST_C)
 421                                 static void USB_Host_ResetDevice(void);
 422                         #endif
 423         #endif
 424
 425         /* Disable C linkage for C++ Compilers: */
 426                 #if defined(__cplusplus)
 427                         }
 428                 #endif
 429
 430 #endif
 431
 432 /** @} */
 433