LUFA/Drivers/USB/Core/UC3/Host_UC3.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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(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                                  *  The default delay value may be overridden in the user project makefile by defining the
  83                                  *  \c HOST_DEVICE_SETTLE_DELAY_MS token to the required delay in milliseconds, and passed to the
  84                                  *  compiler using the -D switch.
  85                                  */
  86                                 #define HOST_DEVICE_SETTLE_DELAY_MS        1000
  87                         #endif
  88
  89                 /* Enums: */
  90                         /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event.
  91                          *
  92                          *  \see \ref Group_Events for more information on this event.
  93                          */
  94                         enum USB_Host_ErrorCodes_t
  95                         {
  96                                 HOST_ERROR_VBusVoltageDip       = 0, /**< VBUS voltage dipped to an unacceptable level. This
  97                                                                       *   error may be the result of an attached device drawing
  98                                                                       *   too much current from the VBUS line, or due to the
  99                                                                       *   AVR's power source being unable to supply sufficient
 100                                                                       *   current.
 101                                                                       */
 102                         };
 103
 104                         /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event.
 105                          *
 106                          *  \see \ref Group_Events for more information on this event.
 107                          */
 108                         enum USB_Host_EnumerationErrorCodes_t
 109                         {
 110                                 HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid
 111                                                                       *   ErrorCode parameter value for the \ref EVENT_USB_Host_DeviceEnumerationFailed()
 112                                                                       *   event.
 113                                                                       */
 114                                 HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed
 115                                                                       *   to complete successfully, due to a timeout or other
 116                                                                       *   error.
 117                                                                       */
 118                                 HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines
 119                                                                       *   indicating the attachment of a device.
 120                                                                       */
 121                                 HOST_ENUMERROR_ControlError     = 3, /**< One of the enumeration control requests failed to
 122                                                                       *   complete successfully.
 123                                                                       */
 124                                 HOST_ENUMERROR_PipeConfigError  = 4, /**< The default control pipe (address 0) failed to
 125                                                                       *   configure correctly.
 126                                                                       */
 127                         };
 128
 129                 /* Inline Functions: */
 130                         /** Returns the current USB frame number, when in host mode. Every millisecond the USB bus is active (i.e. not suspended)
 131                          *  the frame number is incremented by one.
 132                          *
 133                          *  \return Current USB frame number from the USB controller.
 134                          */
 135                         static inline uint16_t USB_Host_GetFrameNumber(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 136                         static inline uint16_t USB_Host_GetFrameNumber(void)
 137                         {
 138                                 return AVR32_USBB_UHFNUM;
 139                         }
 140
 141                         #if !defined(NO_SOF_EVENTS)
 142                                 /** Enables the host mode Start Of Frame events. When enabled, this causes the
 143                                  *  \ref EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 144                                  *  at the start of each USB frame when a device is enumerated while in host mode.
 145                                  *
 146                                  *  \note This function is not available when the \c NO_SOF_EVENTS compile time token is defined.
 147                                  */
 148                                 static inline void USB_Host_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
 149                                 static inline void USB_Host_EnableSOFEvents(void)
 150                                 {
 151                                         USB_INT_Enable(USB_INT_HSOFI);
 152                                 }
 153
 154                                 /** Disables the host mode Start Of Frame events. When disabled, this stops the firing of the
 155                                  *  \ref EVENT_USB_Host_StartOfFrame() event when enumerated in host mode.
 156                                  *
 157                                  *  \note This function is not available when the \c NO_SOF_EVENTS compile time token is defined.
 158                                  */
 159                                 static inline void USB_Host_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
 160                                 static inline void USB_Host_DisableSOFEvents(void)
 161                                 {
 162                                         USB_INT_Disable(USB_INT_HSOFI);
 163                                 }
 164                         #endif
 165
 166                         /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.
 167                          *  USB bus resets leave the default control pipe configured (if already configured).
 168                          *
 169                          *  If the USB bus has been suspended prior to issuing a bus reset, the attached device will be
 170                          *  woken up automatically and the bus resumed after the reset has been correctly issued.
 171                          */
 172                         static inline void USB_Host_ResetBus(void) ATTR_ALWAYS_INLINE;
 173                         static inline void USB_Host_ResetBus(void)
 174                         {
 175                                 AVR32_USBB.UHCON.reset = true;
 176                         }
 177
 178                         /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has
 179                          *  completed.
 180                          *
 181                          *  \return Boolean \c true if no bus reset is currently being sent, \c false otherwise.
 182                          */
 183                         static inline bool USB_Host_IsBusResetComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 184                         static inline bool USB_Host_IsBusResetComplete(void)
 185                         {
 186                                 return AVR32_USBB.UHCON.reset;
 187                         }
 188
 189                         /** Resumes USB communications with an attached and enumerated device, by resuming the transmission
 190                          *  of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the
 191                          *  host and attached device may occur.
 192                          */
 193                         static inline void USB_Host_ResumeBus(void) ATTR_ALWAYS_INLINE;
 194                         static inline void USB_Host_ResumeBus(void)
 195                         {
 196                                 AVR32_USBB.UHCON.sofe = true;
 197                         }
 198
 199                         /** Suspends the USB bus, preventing any communications from occurring between the host and attached
 200                          *  device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame
 201                          *  messages to the device.
 202                          *
 203                          *  \note While the USB bus is suspended, all USB interrupt sources are also disabled; this means that
 204                          *        some events (such as device disconnections) will not fire until the bus is resumed.
 205                          */
 206                         static inline void USB_Host_SuspendBus(void) ATTR_ALWAYS_INLINE;
 207                         static inline void USB_Host_SuspendBus(void)
 208                         {
 209                                 AVR32_USBB.UHCON.sofe = false;
 210                         }
 211
 212                         /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,
 213                          *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,
 214                          *  except for the Remote Wakeup event from the device if supported.
 215                          *
 216                          *  \return Boolean \c true if the bus is currently suspended, \c false otherwise.
 217                          */
 218                         static inline bool USB_Host_IsBusSuspended(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 219                         static inline bool USB_Host_IsBusSuspended(void)
 220                         {
 221                                 return AVR32_USBB.UHCON.sofe;
 222                         }
 223
 224                         /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or
 225                          *  false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
 226                          *
 227                          *  \return Boolean \c true if the attached device is enumerated in Full Speed mode, \c false otherwise.
 228                          */
 229                         static inline bool USB_Host_IsDeviceFullSpeed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 230                         static inline bool USB_Host_IsDeviceFullSpeed(void)
 231                         {
 232                                 return (AVR32_USBB.USBSTA.speed == AVR32_USBB_SPEED_FULL);
 233                         }
 234
 235                         /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
 236                          *  that the host resume the USB bus and wake up the device, false otherwise.
 237                          *
 238                          *  \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.
 239                          */
 240                         static inline bool USB_Host_IsRemoteWakeupSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 241                         static inline bool USB_Host_IsRemoteWakeupSent(void)
 242                         {
 243                                 return AVR32_USBB.UHINT.rxrsmi;
 244                         }
 245
 246                         /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */
 247                         static inline void USB_Host_ClearRemoteWakeupSent(void) ATTR_ALWAYS_INLINE;
 248                         static inline void USB_Host_ClearRemoteWakeupSent(void)
 249                         {
 250                                 AVR32_USBB.UHINTCLR.rxrsmic = true;
 251                         }
 252
 253                         /** Accepts a Remote Wakeup request from an attached device. This must be issued in response to
 254                          *  a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to
 255                          *  be resumed.
 256                          */
 257                         static inline void USB_Host_ResumeFromWakeupRequest(void) ATTR_ALWAYS_INLINE;
 258                         static inline void USB_Host_ResumeFromWakeupRequest(void)
 259                         {
 260                                 AVR32_USBB.UHCON.resume = true;
 261                         }
 262
 263                         /** Determines if a resume from Remote Wakeup request is currently being sent to an attached
 264                          *  device.
 265                          *
 266                          *  \return Boolean \c true if no resume request is currently being sent, \c false otherwise.
 267                          */
 268                         static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 269                         static inline bool USB_Host_IsResumeFromWakeupRequestSent(void)
 270                         {
 271                                 return AVR32_USBB.UHCON.resume;
 272                         }
 273
 274         /* Private Interface - For use in library only: */
 275         #if !defined(__DOXYGEN__)
 276                 /* Macros: */
 277                         static inline void USB_Host_HostMode_On(void) ATTR_ALWAYS_INLINE;
 278                         static inline void USB_Host_HostMode_On(void)
 279                         {
 280                                 // Not required for UC3B
 281                         }
 282
 283                         static inline void USB_Host_HostMode_Off(void) ATTR_ALWAYS_INLINE;
 284                         static inline void USB_Host_HostMode_Off(void)
 285                         {
 286                                 // Not required for UC3B
 287                         }
 288
 289                         static inline void USB_Host_VBUS_Auto_Enable(void) ATTR_ALWAYS_INLINE;
 290                         static inline void USB_Host_VBUS_Auto_Enable(void)
 291                         {
 292                                 AVR32_USBB.USBCON.vbushwc = false;
 293                         }
 294
 295                         static inline void USB_Host_VBUS_Manual_Enable(void) ATTR_ALWAYS_INLINE;
 296                         static inline void USB_Host_VBUS_Manual_Enable(void)
 297                         {
 298                                 AVR32_USBB.USBCON.vbushwc = true;
 299                         }
 300
 301                         static inline void USB_Host_VBUS_Auto_On(void) ATTR_ALWAYS_INLINE;
 302                         static inline void USB_Host_VBUS_Auto_On(void)
 303                         {
 304                                 AVR32_USBB.USBSTASET.vbusrqs = true;
 305                         }
 306
 307                         static inline void USB_Host_VBUS_Manual_On(void) ATTR_ALWAYS_INLINE;
 308                         static inline void USB_Host_VBUS_Manual_On(void)
 309                         {
 310                                 AVR32_USBB.USBSTASET.vbusrqs = true;
 311                         }
 312
 313                         static inline void USB_Host_VBUS_Auto_Off(void) ATTR_ALWAYS_INLINE;
 314                         static inline void USB_Host_VBUS_Auto_Off(void)
 315                         {
 316                                 AVR32_USBB.USBSTACLR.vbusrqc = true;
 317                         }
 318
 319                         static inline void USB_Host_VBUS_Manual_Off(void) ATTR_ALWAYS_INLINE;
 320                         static inline void USB_Host_VBUS_Manual_Off(void)
 321                         {
 322                                 AVR32_USBB.USBSTACLR.vbusrqc = true;
 323                         }
 324
 325                         static inline void USB_Host_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
 326                         static inline void USB_Host_SetDeviceAddress(const uint8_t Address)
 327                         {
 328                                 AVR32_USBB.UHADDR1.uhaddr_p0 = Address;
 329                                 AVR32_USBB.UHADDR1.uhaddr_p1 = Address;
 330                                 AVR32_USBB.UHADDR1.uhaddr_p2 = Address;
 331                                 AVR32_USBB.UHADDR1.uhaddr_p3 = Address;
 332                                 AVR32_USBB.UHADDR2.uhaddr_p4 = Address;
 333                                 AVR32_USBB.UHADDR2.uhaddr_p5 = Address;
 334                                 AVR32_USBB.UHADDR2.uhaddr_p6 = Address;
 335                         }
 336
 337                 /* Enums: */
 338                         enum USB_Host_WaitMSErrorCodes_t
 339                         {
 340                                 HOST_WAITERROR_Successful       = 0,
 341                                 HOST_WAITERROR_DeviceDisconnect = 1,
 342                                 HOST_WAITERROR_PipeError        = 2,
 343                                 HOST_WAITERROR_SetupStalled     = 3,
 344                         };
 345
 346                 /* Function Prototypes: */
 347                         void    USB_Host_ProcessNextHostState(void);
 348                         uint8_t USB_Host_WaitMS(uint8_t MS);
 349
 350                         #if defined(__INCLUDE_FROM_HOST_C)
 351                                 static void USB_Host_ResetDevice(void);
 352                         #endif
 353         #endif
 354
 355         /* Disable C linkage for C++ Compilers: */
 356                 #if defined(__cplusplus)
 357                         }
 358                 #endif
 359
 360 #endif
 361
 362 /** @} */
 363