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