LUFA/Drivers/USB/Core/AVR8/USBController_AVR8.h

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