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