LUFA/Drivers/USB/Core/UC3/Host_UC3.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 AVR32 UC3B microcontrollers.
  33  *  \copydetails Group_Host_UC3B
  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_UC3B Host Management (UC3B)
  41  *  \brief USB Host definitions for the AVR32 UC3B microcontrollers.
  42  *
  43  *  Architecture specific USB Host definitions for the Atmel 32-bit AVR UC3B microcontrollers.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __USBHOST_UC3B_H__
  49 #define __USBHOST_UC3B_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                 /* Enums: */
 101                         /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event.
 102                          *
 103                          *  \see \ref Group_Events for more information on this event.
 104                          */
 105                         enum USB_Host_ErrorCodes_t
 106                         {
 107                                 HOST_ERROR_VBusVoltageDip       = 0, /**< VBUS voltage dipped to an unacceptable level. This
 108                                                                       *   error may be the result of an attached device drawing
 109                                                                       *   too much current from the VBUS line, or due to the
 110                                                                       *   AVR's power source being unable to supply sufficient
 111                                                                       *   current.
 112                                                                       */
 113                         };
 114
 115                         /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event.
 116                          *
 117                          *  \see \ref Group_Events for more information on this event.
 118                          */
 119                         enum USB_Host_EnumerationErrorCodes_t
 120                         {
 121                                 HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid
 122                                                                       *   ErrorCode parameter value for the \ref EVENT_USB_Host_DeviceEnumerationFailed()
 123                                                                       *   event.
 124                                                                       */
 125                                 HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed
 126                                                                       *   to complete successfully, due to a timeout or other
 127                                                                       *   error.
 128                                                                       */
 129                                 HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines
 130                                                                       *   indicating the attachment of a device.
 131                                                                       */
 132                                 HOST_ENUMERROR_ControlError     = 3, /**< One of the enumeration control requests failed to
 133                                                                       *   complete successfully.
 134                                                                       */
 135                                 HOST_ENUMERROR_PipeConfigError  = 4, /**< The default control pipe (address 0) failed to
 136                                                                       *   configure correctly.
 137                                                                       */
 138                         };
 139
 140                 /* Inline Functions: */
 141                         /** Returns the current USB frame number, when in host mode. Every millisecond the USB bus is active (i.e. not suspended)
 142                          *  the frame number is incremented by one.
 143                          */
 144                         static inline uint16_t USB_Host_GetFrameNumber(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 145                         static inline uint16_t USB_Host_GetFrameNumber(void)
 146                         {
 147                                 return AVR32_USBB_UHFNUM;
 148                         }
 149
 150                         #if !defined(NO_SOF_EVENTS)
 151                                 /** Enables the host mode Start Of Frame events. When enabled, this causes the
 152                                  *  \ref EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 153                                  *  at the start of each USB frame when a device is enumerated while in host mode.
 154                                  *
 155                                  *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
 156                                  */
 157                                 static inline void USB_Host_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
 158                                 static inline void USB_Host_EnableSOFEvents(void)
 159                                 {
 160                                         USB_INT_Enable(USB_INT_HSOFI);
 161                                 }
 162
 163                                 /** Disables the host mode Start Of Frame events. When disabled, this stops the firing of the
 164                                  *  \ref EVENT_USB_Host_StartOfFrame() event when enumerated in host mode.
 165                                  *
 166                                  *  \note Not available when the NO_SOF_EVENTS compile time token is defined.
 167                                  */
 168                                 static inline void USB_Host_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
 169                                 static inline void USB_Host_DisableSOFEvents(void)
 170                                 {
 171                                         USB_INT_Disable(USB_INT_HSOFI);
 172                                 }
 173                         #endif
 174
 175                         /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.
 176                          *  USB bus resets leave the default control pipe configured (if already configured).
 177                          *
 178                          *  If the USB bus has been suspended prior to issuing a bus reset, the attached device will be
 179                          *  woken up automatically and the bus resumed after the reset has been correctly issued.
 180                          */
 181                         static inline void USB_Host_ResetBus(void) ATTR_ALWAYS_INLINE;
 182                         static inline void USB_Host_ResetBus(void)
 183                         {
 184                                 AVR32_USBB.UHCON.reset = true;
 185                         }
 186
 187                         /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has
 188                          *  completed.
 189                          *
 190                          *  \return Boolean \c true if no bus reset is currently being sent, \c false otherwise.
 191                          */
 192                         static inline bool USB_Host_IsBusResetComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 193                         static inline bool USB_Host_IsBusResetComplete(void)
 194                         {
 195                                 return AVR32_USBB.UHCON.reset;
 196                         }
 197
 198                         /** Resumes USB communications with an attached and enumerated device, by resuming the transmission
 199                          *  of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the
 200                          *  host and attached device may occur.
 201                          */
 202                         static inline void USB_Host_ResumeBus(void) ATTR_ALWAYS_INLINE;
 203                         static inline void USB_Host_ResumeBus(void)
 204                         {
 205                                 AVR32_USBB.UHCON.sofe = true;
 206                         }
 207
 208                         /** Suspends the USB bus, preventing any communications from occurring between the host and attached
 209                          *  device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame
 210                          *  messages to the device.
 211                          */
 212                         static inline void USB_Host_SuspendBus(void) ATTR_ALWAYS_INLINE;
 213                         static inline void USB_Host_SuspendBus(void)
 214                         {
 215                                 AVR32_USBB.UHCON.sofe = false;
 216                         }
 217
 218                         /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,
 219                          *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,
 220                          *  except for the Remote Wakeup event from the device if supported.
 221                          *
 222                          *  \return Boolean \c true if the bus is currently suspended, \c false otherwise.
 223                          */
 224                         static inline bool USB_Host_IsBusSuspended(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 225                         static inline bool USB_Host_IsBusSuspended(void)
 226                         {
 227                                 return AVR32_USBB.UHCON.sofe;
 228                         }
 229
 230                         /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or
 231                          *  false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
 232                          *
 233                          *  \return Boolean \c true if the attached device is enumerated in Full Speed mode, \c false otherwise.
 234                          */
 235                         static inline bool USB_Host_IsDeviceFullSpeed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 236                         static inline bool USB_Host_IsDeviceFullSpeed(void)
 237                         {
 238                                 return (AVR32_USBB.USBSTA.speed == AVR32_USBB_SPEED_FULL);
 239                         }
 240
 241                         /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
 242                          *  that the host resume the USB bus and wake up the device, false otherwise.
 243                          *
 244                          *  \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.
 245                          */
 246                         static inline bool USB_Host_IsRemoteWakeupSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 247                         static inline bool USB_Host_IsRemoteWakeupSent(void)
 248                         {
 249                                 return AVR32_USBB.UHINT.rxrsmi;
 250                         }
 251
 252                         /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */
 253                         static inline void USB_Host_ClearRemoteWakeupSent(void) ATTR_ALWAYS_INLINE;
 254                         static inline void USB_Host_ClearRemoteWakeupSent(void)
 255                         {
 256                                 AVR32_USBB.UHINTCLR.rxrsmic = true;
 257                         }
 258
 259                         /** Accepts a Remote Wakeup request from an attached device. This must be issued in response to
 260                          *  a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to
 261                          *  be resumed.
 262                          */
 263                         static inline void USB_Host_ResumeFromWakeupRequest(void) ATTR_ALWAYS_INLINE;
 264                         static inline void USB_Host_ResumeFromWakeupRequest(void)
 265                         {
 266                                 AVR32_USBB.UHCON.resume = true;
 267                         }
 268
 269                         /** Determines if a resume from Remote Wakeup request is currently being sent to an attached
 270                          *  device.
 271                          *
 272                          *  \return Boolean \c true if no resume request is currently being sent, \c false otherwise.
 273                          */
 274                         static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 275                         static inline bool USB_Host_IsResumeFromWakeupRequestSent(void)
 276                         {
 277                                 return AVR32_USBB.UHCON.resume;
 278                         }
 279
 280                 /* Function Prototypes: */
 281                         /** Convenience function. This routine sends a SET CONFIGURATION standard request to the attached
 282                          *  device, with the given configuration index. This can be used to easily set the device
 283                          *  configuration without creating and sending the request manually.
 284                          *
 285                          *  \note After this routine returns, the control pipe will be selected.
 286                          *
 287                          *  \param[in] ConfigNumber  Configuration index to send to the device.
 288                          *
 289                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 290                          */
 291                         uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);
 292
 293                         /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached
 294                          *  device, requesting the device descriptor. This can be used to easily retrieve information
 295                          *  about the device such as its VID, PID and power requirements.
 296                          *
 297                          *  \note After this routine returns, the control pipe will be selected.
 298                          *
 299                          *  \param[out] DeviceDescriptorPtr  Pointer to the destination device descriptor structure where
 300                          *                                   the read data is to be stored.
 301                          *
 302                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 303                          */
 304                         uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);
 305
 306                         /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached
 307                          *  device, requesting the string descriptor of the specified index. This can be used to easily
 308                          *  retrieve string descriptors from the device by index, after the index is obtained from the
 309                          *  Device or Configuration descriptors.
 310                          *
 311                          *  \note After this routine returns, the control pipe will be selected.
 312                          *
 313                          *  \param[in]  Index        Index of the string index to retrieve.
 314                          *  \param[out] Buffer       Pointer to the destination buffer where the retrieved string descriptor is
 315                          *                           to be stored.
 316                          *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer.
 317                          *
 318                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 319                          */
 320                         uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
 321                                                                    void* const Buffer,
 322                                                                    const uint8_t BufferLength);
 323
 324                         /** Clears a stall condition on the given pipe, via a CLEAR FEATURE standard request to the attached device.
 325                          *
 326                          *  \note After this routine returns, the control pipe will be selected.
 327                          *
 328                          *  \param[in] EndpointIndex  Index of the endpoint to clear, including the endpoint's direction.
 329                          *
 330                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 331                          */
 332                         uint8_t USB_Host_ClearPipeStall(const uint8_t EndpointIndex);
 333
 334                         /** Selects a given alternative setting for the specfied interface, via a SET INTERFACE standard request to
 335                          *  the attached device.
 336                          *
 337                          *  \note After this routine returns, the control pipe will be selected.
 338                          *
 339                          *  \param[in] InterfaceIndex  Index of the interface whose alternative setting is to be altered.
 340                          *  \param[in] AltSetting      Index of the interface's alternative setting which is to be selected.
 341                          *
 342                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 343                          */
 344                         uint8_t USB_Host_SetInterfaceAltSetting(const uint8_t InterfaceIndex,
 345                                                                                                         const uint8_t AltSetting);
 346
 347         /* Private Interface - For use in library only: */
 348         #if !defined(__DOXYGEN__)
 349                 /* Macros: */
 350                         static inline void USB_Host_HostMode_On(void) ATTR_ALWAYS_INLINE;
 351                         static inline void USB_Host_HostMode_On(void)
 352                         {
 353                                 // Not required for UC3B
 354                         }
 355
 356                         static inline void USB_Host_HostMode_Off(void) ATTR_ALWAYS_INLINE;
 357                         static inline void USB_Host_HostMode_Off(void)
 358                         {
 359                                 // Not required for UC3B
 360                         }
 361
 362                         static inline void USB_Host_VBUS_Auto_Enable(void) ATTR_ALWAYS_INLINE;
 363                         static inline void USB_Host_VBUS_Auto_Enable(void)
 364                         {
 365                                 AVR32_USBB.USBCON.vbushwc = false;
 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                                 AVR32_USBB.USBCON.vbushwc = true;
 372                         }
 373
 374                         static inline void USB_Host_VBUS_Auto_On(void) ATTR_ALWAYS_INLINE;
 375                         static inline void USB_Host_VBUS_Auto_On(void)
 376                         {
 377                                 AVR32_USBB.USBSTASET.vbusrqs = true;
 378                         }
 379
 380                         static inline void USB_Host_VBUS_Manual_On(void) ATTR_ALWAYS_INLINE;
 381                         static inline void USB_Host_VBUS_Manual_On(void)
 382                         {
 383                                 AVR32_USBB.USBSTASET.vbusrqs = true;
 384                         }
 385
 386                         static inline void USB_Host_VBUS_Auto_Off(void) ATTR_ALWAYS_INLINE;
 387                         static inline void USB_Host_VBUS_Auto_Off(void)
 388                         {
 389                                 AVR32_USBB.USBSTACLR.vbusrqc = true;
 390                         }
 391
 392                         static inline void USB_Host_VBUS_Manual_Off(void) ATTR_ALWAYS_INLINE;
 393                         static inline void USB_Host_VBUS_Manual_Off(void)
 394                         {
 395                                 AVR32_USBB.USBSTACLR.vbusrqc = true;
 396                         }
 397
 398                         static inline void USB_Host_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
 399                         static inline void USB_Host_SetDeviceAddress(const uint8_t Address)
 400                         {
 401                                 AVR32_USBB.UHADDR1.uhaddr_p0 = Address;
 402                                 AVR32_USBB.UHADDR1.uhaddr_p1 = Address;
 403                                 AVR32_USBB.UHADDR1.uhaddr_p2 = Address;
 404                                 AVR32_USBB.UHADDR1.uhaddr_p3 = Address;
 405                                 AVR32_USBB.UHADDR2.uhaddr_p4 = Address;
 406                                 AVR32_USBB.UHADDR2.uhaddr_p5 = Address;
 407                                 AVR32_USBB.UHADDR2.uhaddr_p6 = Address;
 408                         }
 409
 410                 /* Enums: */
 411                         enum USB_Host_WaitMSErrorCodes_t
 412                         {
 413                                 HOST_WAITERROR_Successful       = 0,
 414                                 HOST_WAITERROR_DeviceDisconnect = 1,
 415                                 HOST_WAITERROR_PipeError        = 2,
 416                                 HOST_WAITERROR_SetupStalled     = 3,
 417                         };
 418
 419                 /* Function Prototypes: */
 420                         void    USB_Host_ProcessNextHostState(void);
 421                         uint8_t USB_Host_WaitMS(uint8_t MS);
 422
 423                         #if defined(__INCLUDE_FROM_HOST_C)
 424                                 static void USB_Host_ResetDevice(void);
 425                         #endif
 426         #endif
 427
 428         /* Disable C linkage for C++ Compilers: */
 429                 #if defined(__cplusplus)
 430                         }
 431                 #endif
 432
 433 #endif
 434
 435 /** @} */
 436