LUFA/Drivers/USB/LowLevel/USBController.h

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