LUFA/Drivers/USB/LowLevel/LowLevel.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 /** \ingroup Group_USB
  32  *  @defgroup Group_USBManagement USB Interface Management
  33  *
  34  *  Functions, macros, variables, enums and types related to the setup and management of the USB interface.
  35  *
  36  *  @{
  37  */
  38
  39 #ifndef __USBLOWLEVEL_H__
  40 #define __USBLOWLEVEL_H__
  41
  42         /* Includes: */
  43                 #include <avr/io.h>
  44                 #include <avr/interrupt.h>
  45                 #include <stdbool.h>
  46
  47                 #include "../HighLevel/USBMode.h"
  48
  49                 #include "../../../Common/Common.h"
  50                 #include "../HighLevel/USBMode.h"
  51                 #include "../HighLevel/Events.h"
  52                 #include "../HighLevel/USBTask.h"
  53                 #include "../HighLevel/USBInterrupt.h"
  54
  55                 #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
  56                         #include "Host.h"
  57                         #include "Pipe.h"
  58                         #include "OTG.h"
  59                 #endif
  60
  61                 #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
  62                         #include "Device.h"
  63                         #include "Endpoint.h"
  64                         #include "DevChapter9.h"
  65                 #endif
  66
  67         /* Enable C linkage for C++ Compilers: */
  68                 #if defined(__cplusplus)
  69                         extern "C" {
  70                 #endif
  71
  72         /* Preprocessor Checks and Defines: */
  73                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  74                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  75                 #endif
  76
  77                 #if !defined(F_CLOCK)
  78                         #error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled input clock in your project makefile.
  79                 #endif
  80
  81                 #if (F_CLOCK == 8000000)
  82                         #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
  83                              defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
  84                                  defined(__AVR_ATmega32U2__))
  85                                 #define USB_PLL_PSC                0
  86                         #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
  87                                 #define USB_PLL_PSC                0
  88                         #elif (defined(__AVR_AT90USB646__)  || defined(__AVR_AT90USB1286__) || defined(__AVR_ATmega32U6__))
  89                                 #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))
  90                         #elif (defined(__AVR_AT90USB647__)  || defined(__AVR_AT90USB1287__))
  91                                 #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))
  92                         #endif
  93                 #elif (F_CLOCK == 16000000)
  94                         #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
  95                              defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
  96                                  defined(__AVR_ATmega32U2__))
  97                                 #define USB_PLL_PSC                (1 << PLLP0)
  98                         #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
  99                                 #define USB_PLL_PSC                (1 << PINDIV)
 100                         #elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_ATmega32U6__))
 101                                 #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP1))
 102                         #elif (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__))
 103                                 #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP0))
 104                         #endif
 105                 #endif
 106
 107                 #if !defined(USB_PLL_PSC)
 108                         #error No PLL prescale value available for chosen F_CPU value and AVR model.
 109                 #endif
 110
 111         /* Public Interface - May be used in end-application: */
 112                 /* Macros: */
 113                         /** Mode mask for the \ref USB_CurrentMode global. This indicates that the USB interface is currently not
 114                          *  initialized into any mode.
 115                          */
 116                         #define USB_MODE_NONE                      0
 117
 118                         /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the
 119                          *  USB interface is or should be initialized in the USB device mode.
 120                          */
 121                         #define USB_MODE_DEVICE                    1
 122
 123                         /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the
 124                          *  USB interface is or should be initialized in the USB host mode.
 125                          */
 126                         #define USB_MODE_HOST                      2
 127
 128                         #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 129                                 /** Mode mask for the the \ref USB_Init() function. This indicates that the USB interface should be
 130                                  *  initialized into whatever mode the UID pin of the USB AVR indicates, and that the device
 131                                  *  should swap over its mode when the level of the UID pin changes during operation.
 132                                  *
 133                                  *  \note This token is not available on AVR models which do not support both host and device modes.
 134                                  */
 135                                 #define USB_MODE_UID                       3
 136                         #endif
 137
 138                         /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
 139                          *  regulator should be enabled to regulate the data pin voltages to within the USB standard.
 140                          *
 141                          *  \note See USB AVR data sheet for more information on the internal pad regulator.
 142                          */
 143                         #define USB_OPT_REG_DISABLED               (1 << 1)
 144
 145                         /** Regulator enable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
 146                          *  regulator should be disabled and the AVR's VCC level used for the data pads.
 147                          *
 148                          *  \note See USB AVR data sheet for more information on the internal pad regulator.
 149                          */
 150                         #define USB_OPT_REG_ENABLED                (0 << 1)
 151
 152                         /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application
 153                          *  will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
 154                          *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
 155                          */
 156                         #define USB_OPT_MANUAL_PLL                 (1 << 2)
 157
 158                         /** Automatic PLL control option mask for \ref USB_Init(). This indicates to the library that the library should
 159                          *  take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
 160                          *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
 161                          */
 162                         #define USB_OPT_AUTO_PLL                   (0 << 2)
 163
 164                         /** Mask for a CONTROL type endpoint or pipe.
 165                          *
 166                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 167                          */
 168                         #define EP_TYPE_CONTROL                    0x00
 169
 170                         /** Mask for an ISOCHRONOUS type endpoint or pipe.
 171                          *
 172                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 173                          */
 174                         #define EP_TYPE_ISOCHRONOUS                0x01
 175
 176                         /** Mask for a BULK type endpoint or pipe.
 177                          *
 178                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 179                          */
 180                         #define EP_TYPE_BULK                       0x02
 181
 182                         /** Mask for an INTERRUPT type endpoint or pipe.
 183                          *
 184                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 185                          */
 186                         #define EP_TYPE_INTERRUPT                  0x03
 187
 188                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
 189                                 /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power),
 190                                  *  otherwise returns false.
 191                                  *
 192                                  *  \note This token is not available on some AVR models which do not support hardware VBUS monitoring.
 193                                  */
 194                                 #define USB_VBUS_GetStatus()             ((USBSTA & (1 << VBUS)) ? true : false)
 195                         #endif
 196
 197                         /** Detaches the device from the USB bus. This has the effect of removing the device from any
 198                          *  attached host, ceasing USB communications. If no host is present, this prevents any host from
 199                          *  enumerating the device once attached until \ref USB_Attach() is called.
 200                          */
 201                         #define USB_Detach()                    MACROS{ UDCON  |=  (1 << DETACH);  }MACROE
 202
 203                         /** Attaches the device to the USB bus. This announces the device's presence to any attached
 204                          *  USB host, starting the enumeration process. If no host is present, attaching the device
 205                          *  will allow for enumeration once a host is connected to the device.
 206                          *
 207                          *  This is inexplicably also required for proper operation while in host mode, to enable the
 208                          *  attachment of a device to the host. This is despite the bit being located in the device-mode
 209                          *  register and despite the datasheet making no mention of its requirement in host mode.
 210                          */
 211                         #define USB_Attach()                    MACROS{ UDCON  &= ~(1 << DETACH);  }MACROE
 212
 213                         #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
 214                                 /** Constant for the maximum software timeout period of the USB data stream transfer functions
 215                                  *  (both control and standard) when in either device or host mode. If the next packet of a stream
 216                                  *  is not received or acknowledged within this time period, the stream function will fail.
 217                                  *
 218                                  *  This value may be overridden in the user project makefile as the value of the
 219                                  *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
 220                                  */
 221                                 #define USB_STREAM_TIMEOUT_MS       100
 222                         #endif
 223
 224                 /* Function Prototypes: */
 225                         /** Main function to initialize and start the USB interface. Once active, the USB interface will
 226                          *  allow for device connection to a host when in device mode, or for device enumeration while in
 227                          *  host mode.
 228                          *
 229                          *  As the USB library relies on USB interrupts for some of its functionality, this routine will
 230                          *  enable global interrupts.
 231                          *
 232                          *  Calling this function when the USB interface is already initialized will cause a complete USB
 233                          *  interface reset and re-enumeration.
 234                          *
 235                          *  \param[in] Mode     This is a mask indicating what mode the USB interface is to be initialized to.
 236                          *                      Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID.
 237                          *
 238                          *  \param[in] Options  Mask indicating the options which should be used when initializing the USB
 239                          *                      interface to control the USB interface's behaviour. This should be comprised of
 240                          *                      a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the
 241                          *                      PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
 242                          *                      mode speed.
 243                          *
 244                          *  \note To reduce the FLASH requirements of the library if only device or host mode is required,
 245                          *        this can be statically set via defining the token USB_DEVICE_ONLY for device mode or
 246                          *        USB_HOST_ONLY for host mode in the use project makefile, passing the token to the compiler
 247                          *        via the -D switch. If the mode is statically set, this parameter does not exist in the
 248                          *        function prototype.
 249                          *
 250                          *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,
 251                          *        the options may be set statically in the same manner as the mode (see the Mode parameter of
 252                          *        this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token,
 253                          *        defined to the appropriate options masks. When the options are statically set, this
 254                          *        parameter does not exist in the function prototype.
 255                          *
 256                          *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB
 257                          *        AVR models which only implement the USB device mode in hardware.
 258                          *
 259                          *  \see Device.h for the USB_DEVICE_OPT_* masks.
 260                          */
 261                         void USB_Init(
 262                                        #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 263                                        const uint8_t Mode
 264                                                    #endif
 265
 266                                        #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__)
 267                                        ,
 268                                                    #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS))
 269                                                    void
 270                                        #endif
 271
 272                                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 273                                        const uint8_t Options
 274                                        #endif
 275                                        );
 276
 277                         /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
 278                          *  memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
 279                          *  is restarted with the \ref USB_Init() function.
 280                          */
 281                         void USB_ShutDown(void);
 282
 283                         /** Resets the interface, when already initialized. This will re-enumerate the device if already connected
 284                          *  to a host, or re-enumerate an already attached device when in host mode.
 285                          */
 286                         void USB_ResetInterface(void);
 287
 288                 /* Enums: */
 289                         /** Enum for error codes relating to the powering on of the USB interface. These error codes are
 290                          *  used in the ErrorCode parameter value of the \ref EVENT_USB_InitFailure() event.
 291                          */
 292                         enum USB_InitErrorCodes_t
 293                         {
 294                                 USB_INITERROR_NoUSBModeSpecified       = 0, /**< Indicates that \ref USB_Init() was called with an
 295                                                                          *   invalid or missing Mode parameter.
 296                                                                          */
 297                         };
 298
 299                 /* Global Variables: */
 300                         #if (!defined(USB_HOST_ONLY) && !defined(USB_DEVICE_ONLY)) || defined(__DOXYGEN__)
 301                                 /** Indicates the mode that the USB interface is currently initialized to. This value will be
 302                                  *  one of the USB_MODE_* masks defined elsewhere in this module.
 303                                  *
 304                                  *  \note This variable should be treated as read-only in the user application, and never manually
 305                                  *        changed in value.
 306                                  */
 307                                 extern volatile uint8_t USB_CurrentMode;
 308                         #elif defined(USB_HOST_ONLY)
 309                                 #define USB_CurrentMode USB_MODE_HOST
 310                         #elif defined(USB_DEVICE_ONLY)
 311                                 #define USB_CurrentMode USB_MODE_DEVICE
 312                         #endif
 313
 314                         #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 315                                 /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
 316                                  *  was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.
 317                                  *
 318                                  *  \note This variable should be treated as read-only in the user application, and never manually
 319                                  *        changed in value.
 320                                  */
 321                                 extern volatile uint8_t USB_Options;
 322                         #elif defined(USE_STATIC_OPTIONS)
 323                                 #define USB_Options USE_STATIC_OPTIONS
 324                         #endif
 325
 326         /* Private Interface - For use in library only: */
 327         #if !defined(__DOXYGEN__)
 328                 /* Macros: */
 329                         #define USB_PLL_On()               MACROS{ PLLCSR   =  USB_PLL_PSC; PLLCSR |= (1 << PLLE); }MACROE
 330                         #define USB_PLL_Off()              MACROS{ PLLCSR   =  0;                           }MACROE
 331                         #define USB_PLL_IsReady()                ((PLLCSR  &   (1 << PLOCK)) ? true : false)
 332
 333                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
 334                                 #define USB_REG_On()           MACROS{ UHWCON  |=  (1 << UVREGE);               }MACROE
 335                                 #define USB_REG_Off()          MACROS{ UHWCON  &= ~(1 << UVREGE);               }MACROE
 336                         #else
 337                                 #define USB_REG_On()           MACROS{ REGCR   &= ~(1 << REGDIS);               }MACROE
 338                                 #define USB_REG_Off()          MACROS{ REGCR   |=  (1 << REGDIS);               }MACROE
 339                         #endif
 340
 341                         #define USB_OTGPAD_On()            MACROS{ USBCON  |=  (1 << OTGPADE);              }MACROE
 342                         #define USB_OTGPAD_Off()           MACROS{ USBCON  &= ~(1 << OTGPADE);              }MACROE
 343
 344                         #define USB_CLK_Freeze()           MACROS{ USBCON  |=  (1 << FRZCLK);               }MACROE
 345                         #define USB_CLK_Unfreeze()         MACROS{ USBCON  &= ~(1 << FRZCLK);               }MACROE
 346
 347                         #define USB_Controller_Enable()    MACROS{ USBCON  |=  (1 << USBE);                 }MACROE
 348                         #define USB_Controller_Disable()   MACROS{ USBCON  &= ~(1 << USBE);                 }MACROE
 349                         #define USB_Controller_Reset()     MACROS{ const uint8_t Temp = USBCON; USBCON = (Temp & ~(1 << USBE)); \
 350                                                                    USBCON = (Temp | (1 << USBE));           }MACROE
 351
 352                 /* Inline Functions: */
 353                         #if defined(USB_CAN_BE_BOTH)
 354                         static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 355                         static inline uint8_t USB_GetUSBModeFromUID(void)
 356                         {
 357                                 if (USBSTA & (1 << ID))
 358                                   return USB_MODE_DEVICE;
 359                                 else
 360                                   return USB_MODE_HOST;
 361                         }
 362                         #endif
 363
 364         #endif
 365
 366         /* Disable C linkage for C++ Compilers: */
 367                 #if defined(__cplusplus)
 368                         }
 369                 #endif
 370
 371 #endif
 372
 373 /** @} */