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                 #include "../HighLevel/StdDescriptors.h"
  51                 #include "Pipe.h"
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Public Interface - May be used in end-application: */
  59                 /* Macros: */
  60                         /** Indicates the fixed USB device address which any attached device is enumerated to when in
  61                          *  host mode. As only one USB device may be attached to the AVR in host mode at any one time
  62                          *  and that the address used is not important (other than the fact that it is non-zero), a
  63                          *  fixed value is specified by the library.
  64                          */
  65                         #define USB_HOST_DEVICEADDRESS                 1
  66
  67                         #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)
  68                                 /** Constant for the maximum software timeout period of sent USB control transactions to an attached
  69                                  *  device. If a device fails to respond to a sent control request within this period, the
  70                                  *  library will return a timeout error code.
  71                                  *
  72                                  *  This value may be overridden in the user project makefile as the value of the
  73                                  *  \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
  74                                  */
  75                                 #define USB_HOST_TIMEOUT_MS                1000
  76                         #endif
  77
  78                         #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__)
  79                                 /** Constant for the delay in milliseconds after a device is connected before the library
  80                                  *  will start the enumeration process. Some devices require a delay of up to 5 seconds
  81                                  *  after connection before the enumeration process can start or incorrect operation will
  82                                  *  occur.
  83                                  *
  84                                  *  This value may be overridden in the user project makefile as the value of the
  85                                  *  HOST_DEVICE_SETTLE_DELAY_MS token, and passed to the compiler using the -D switch.
  86                                  */
  87                                 #define HOST_DEVICE_SETTLE_DELAY_MS        1500
  88                         #endif
  89
  90                 /* Pseudo-Function Macros: */
  91                         #if defined(__DOXYGEN__)
  92                                 /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.
  93                                  *  USB bus resets leave the default control pipe configured (if already configured).
  94                                  *
  95                                  *  If the USB bus has been suspended prior to issuing a bus reset, the attached device will be
  96                                  *  woken up automatically and the bus resumed after the reset has been correctly issued.
  97                                  */
  98                                 static inline void USB_Host_ResetBus(void);
  99
 100                                 /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has
 101                                  *  completed.
 102                                  *
 103                                  *  \return Boolean true if no bus reset is currently being sent, false otherwise.
 104                                  */
 105                                 static inline void USB_Host_IsBusResetComplete(void);
 106
 107                                 /** Resumes USB communications with an attached and enumerated device, by resuming the transmission
 108                                  *  of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the
 109                                  *  host and attached device may occur.
 110                                  */
 111                                 static inline void USB_Host_ResumeBus(void);
 112
 113                                 /** Suspends the USB bus, preventing any communications from occurring between the host and attached
 114                                  *  device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame
 115                                  *  messages to the device.
 116                                  */
 117                                 static inline void USB_Host_SuspendBus(void);
 118
 119                                 /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,
 120                                  *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,
 121                                  *  except for the Remote Wakeup event from the device if supported.
 122                                  *
 123                                  *  \return Boolean true if the bus is currently suspended, false otherwise
 124                                  */
 125                                  static inline bool USB_Host_IsBusSuspended(void);
 126
 127                                 /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or
 128                                  *  false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
 129                                  *
 130                                  *  \return Boolean true if the attached device is enumerated in Full Speed mode, false otherwise
 131                                  */
 132                                 static inline bool USB_Host_IsDeviceFullSpeed(void);
 133
 134                                 /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
 135                                  *  that the host resume the USB bus and wake up the device, false otherwise.
 136                                  *
 137                                  *  \return Boolean true if the attached device has sent a Remote Wakeup request, false otherwise
 138                                  */
 139                                 static inline bool USB_Host_IsRemoteWakeupSent(void);
 140
 141                                 /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */
 142                                 static inline void USB_Host_ClearRemoteWakeupSent(void);
 143
 144                                 /** Accepts a Remote Wakeup request from an attached device. This must be issued in response to
 145                                  *  a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to
 146                                  *  be resumed.
 147                                  */
 148                                 static inline void USB_Host_ResumeFromWakeupRequest(void);
 149
 150                                 /** Determines if a resume from Remote Wakeup request is currently being sent to an attached
 151                                  *  device.
 152                                  *
 153                                  *  \return Boolean true if no resume request is currently being sent, false otherwise
 154                                  */
 155                                 static inline bool USB_Host_IsResumeFromWakeupRequestSent(void);
 156                         #else
 157                                 #define USB_Host_ResetBus()                MACROS{ UHCON |=  (1 << RESET);          }MACROE
 158
 159                                 #define USB_Host_IsBusResetComplete()      ((UHCON &   (1 << RESET)) ? false : true)
 160
 161                                 #define USB_Host_ResumeBus()               MACROS{ UHCON |=  (1 << SOFEN);          }MACROE
 162
 163                                 #define USB_Host_SuspendBus()              MACROS{ UHCON &= ~(1 << SOFEN);          }MACROE
 164
 165                                 #define USB_Host_IsBusSuspended()                ((UHCON &   (1 << SOFEN)) ? false : true)
 166
 167                                 #define USB_Host_IsDeviceFullSpeed()             ((USBSTA &  (1 << SPEED)) ? true : false)
 168
 169                                 #define USB_Host_IsRemoteWakeupSent()            ((UHINT &   (1 << RXRSMI)) ? true : false)
 170
 171                                 #define USB_Host_ClearRemoteWakeupSent()   MACROS{ UHINT &= ~(1 << RXRSMI);         }MACROE
 172
 173                                 #define USB_Host_ResumeFromWakeupRequest() MACROS{ UHCON |=  (1 << RESUME);         }MACROE
 174
 175                                 #define USB_Host_IsResumeFromWakeupRequestSent() ((UHCON &   (1 << RESUME)) ? false : true)
 176                         #endif
 177
 178                 /* Function Prototypes: */
 179                         /** Convenience function. This routine sends a SetConfiguration standard request to the attached
 180                          *  device, with the given configuration index. This can be used to easily set the device
 181                          *  configuration without creating and sending the request manually.
 182                          *
 183                          *  \note After this routine returns, the control pipe will be selected.
 184                          *
 185                          *  \param ConfigNumber  Configuration index to send to the device
 186                          *
 187                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 188                          */
 189                         uint8_t USB_Host_SetDeviceConfiguration(uint8_t ConfigNumber);
 190
 191                         /** Convenience function. This routine sends a GetDescriptor standard request to the attached
 192                          *  device, requesting the device descriptor. This can be used to easily retrieve information
 193                          *  about the device such as its VID, PID and power requirements.
 194                          *
 195                          *  \note After this routine returns, the control pipe will be selected.
 196                          *
 197                          *  \param DeviceDescriptorPtr  Pointer to the destination device descriptor structure where
 198                          *                              the read data is to be stored
 199                          *
 200                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 201                          */
 202                         uint8_t USB_Host_GetDeviceDescriptor(void* DeviceDescriptorPtr);
 203
 204                         /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.
 205                          *
 206                          *  \note After this routine returns, the control pipe will be selected.
 207                          *
 208                          *  \param EndpointIndex  Index of the endpoint to clear
 209                          *
 210                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 211                          */
 212                         uint8_t USB_Host_ClearPipeStall(uint8_t EndpointIndex);
 213
 214                 /* Enums: */
 215                         /** Enum for the various states of the USB Host state machine. Only some states are
 216                          *  implemented in the LUFA library - other states are left to the user to implement.
 217                          *
 218                          *  For information on each state, refer to the USB 2.0 specification. Some states have
 219                          *
 220                          *  \see \ref USB_HostState, which stores the current host state machine state.
 221                          */
 222                         enum USB_Host_States_t
 223                         {
 224                                 HOST_STATE_WaitForDevice                = 0,  /**< Internally implemented by the library. */
 225                                 HOST_STATE_Unattached                   = 1,  /**< Internally implemented by the library. */
 226                                 HOST_STATE_Attached                     = 2,  /**< Internally implemented by the library. */
 227                                 HOST_STATE_Attached_WaitForDeviceSettle = 3,  /**< Internally implemented by the library. */
 228                                 HOST_STATE_Attached_WaitForConnect      = 4,  /**< Internally implemented by the library. */
 229                                 HOST_STATE_Attached_DoReset             = 5,  /**< Internally implemented by the library. */
 230                                 HOST_STATE_Powered                      = 6,  /**< Internally implemented by the library. */
 231                                 HOST_STATE_Default                      = 7,  /**< Internally implemented by the library. */
 232                                 HOST_STATE_Default_PostReset            = 8,  /**< Internally implemented by the library. */
 233                                 HOST_STATE_Default_PostAddressSet       = 9,  /**< Internally implemented by the library. */
 234                                 HOST_STATE_Addressed                    = 10, /**< May be implemented by the user project. */
 235                                 HOST_STATE_Configured                   = 11, /**< May be implemented by the user project. */
 236                                 HOST_STATE_Ready                        = 12, /**< May be implemented by the user project. */
 237                                 HOST_STATE_Suspended                    = 13, /**< May be implemented by the user project. */
 238                         };
 239
 240                         /** Enum for the error codes for the \ref EVENT_USB_HostError() event.
 241                          *
 242                          *  \see \ref Group_Events for more information on this event.
 243                          */
 244                         enum USB_Host_ErrorCodes_t
 245                         {
 246                                 HOST_ERROR_VBusVoltageDip       = 0, /**< VBUS voltage dipped to an unacceptable level. This
 247                                                                       *   error may be the result of an attached device drawing
 248                                                                       *   too much current from the VBUS line, or due to the
 249                                                                       *   AVR's power source being unable to supply sufficient
 250                                                                       *   current.
 251                                                                       */
 252                         };
 253
 254                         /** Enum for the error codes for the \ref EVENT_USB_DeviceEnumerationFailed() event.
 255                          *
 256                          *  \see \ref Group_Events for more information on this event.
 257                          */
 258                         enum USB_Host_EnumerationErrorCodes_t
 259                         {
 260                                 HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid
 261                                                                       *   ErrorCode parameter value for the \ref EVENT_USB_DeviceEnumerationFailed()
 262                                                                       *   event.
 263                                                                       */
 264                                 HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed
 265                                                                       *   to complete successfully, due to a timeout or other
 266                                                                       *   error.
 267                                                                       */
 268                                 HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines
 269                                                                       *   indicating the attachment of a device.
 270                                                                       */
 271                                 HOST_ENUMERROR_ControlError     = 3, /**< One of the enumeration control requests failed to
 272                                                                       *   complete successfully.
 273                                                                                                           */
 274                                 HOST_ENUMERROR_PipeConfigError  = 4, /**< The default control pipe (address 0) failed to
 275                                                                       *   configure correctly.
 276                                                                       */
 277                         };
 278
 279         /* Private Interface - For use in library only: */
 280         #if !defined(__DOXYGEN__)
 281                 /* Macros: */
 282                         #define USB_Host_HostMode_On()          MACROS{ USBCON |=  (1 << HOST);           }MACROE
 283                         #define USB_Host_HostMode_Off()         MACROS{ USBCON &= ~(1 << HOST);           }MACROE
 284
 285                         #define USB_Host_VBUS_Auto_Enable()     MACROS{ OTGCON &= ~(1 << VBUSHWC); UHWCON |=  (1 << UVCONE);                   }MACROE
 286                         #define USB_Host_VBUS_Manual_Enable()   MACROS{ OTGCON |=  (1 << VBUSHWC); UHWCON &= ~(1 << UVCONE); DDRE |= (1 << 7); }MACROE
 287
 288                         #define USB_Host_VBUS_Auto_On()         MACROS{ OTGCON |= (1 << VBUSREQ);         }MACROE
 289                         #define USB_Host_VBUS_Manual_On()       MACROS{ PORTE  |= (1 << 7);               }MACROE
 290
 291                         #define USB_Host_VBUS_Auto_Off()        MACROS{ OTGCON |=  (1 << VBUSRQC);        }MACROE
 292                         #define USB_Host_VBUS_Manual_Off()      MACROS{ PORTE  &= ~(1 << 7);              }MACROE
 293
 294                         #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR  =  (addr & 0x7F);         }MACROE
 295
 296                 /* Enums: */
 297                         enum USB_Host_WaitMSErrorCodes_t
 298                         {
 299                                 HOST_WAITERROR_Successful       = 0,
 300                                 HOST_WAITERROR_DeviceDisconnect = 1,
 301                                 HOST_WAITERROR_PipeError        = 2,
 302                                 HOST_WAITERROR_SetupStalled     = 3,
 303                         };
 304
 305                 /* Function Prototypes: */
 306                         void    USB_Host_ProcessNextHostState(void);
 307                         uint8_t USB_Host_WaitMS(uint8_t MS);
 308
 309                         #if defined(INCLUDE_FROM_HOST_C)
 310                                 static void USB_Host_ResetDevice(void);
 311                         #endif
 312         #endif
 313
 314         /* Disable C linkage for C++ Compilers: */
 315                 #if defined(__cplusplus)
 316                         }
 317                 #endif
 318
 319 #endif
 320
 321 /** @} */