LUFA/Drivers/USB/LowLevel/USBController.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 /** \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                         /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
 127                          *  regulator should be enabled to regulate the data pin voltages to within the USB standard.
 128                          *
 129                          *  \note See USB AVR data sheet for more information on the internal pad regulator.
 130                          */
 131                         #define USB_OPT_REG_DISABLED               (1 << 1)
 132
 133                         /** Regulator enable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
 134                          *  regulator should be disabled and the AVR's VCC level used for the data pads.
 135                          *
 136                          *  \note See USB AVR data sheet for more information on the internal pad regulator.
 137                          */
 138                         #define USB_OPT_REG_ENABLED                (0 << 1)
 139
 140                         /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application
 141                          *  will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
 142                          *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
 143                          */
 144                         #define USB_OPT_MANUAL_PLL                 (1 << 2)
 145
 146                         /** Automatic PLL control option mask for \ref USB_Init(). This indicates to the library that the library should
 147                          *  take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
 148                          *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
 149                          */
 150                         #define USB_OPT_AUTO_PLL                   (0 << 2)
 151
 152                         /** Mask for a CONTROL type endpoint or pipe.
 153                          *
 154                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 155                          */
 156                         #define EP_TYPE_CONTROL                    0x00
 157
 158                         /** Mask for an ISOCHRONOUS type endpoint or pipe.
 159                          *
 160                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 161                          */
 162                         #define EP_TYPE_ISOCHRONOUS                0x01
 163
 164                         /** Mask for a BULK type endpoint or pipe.
 165                          *
 166                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 167                          */
 168                         #define EP_TYPE_BULK                       0x02
 169
 170                         /** Mask for an INTERRUPT type endpoint or pipe.
 171                          *
 172                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 173                          */
 174                         #define EP_TYPE_INTERRUPT                  0x03
 175
 176                         #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
 177                                 /** Constant for the maximum software timeout period of the USB data stream transfer functions
 178                                  *  (both control and standard) when in either device or host mode. If the next packet of a stream
 179                                  *  is not received or acknowledged within this time period, the stream function will fail.
 180                                  *
 181                                  *  This value may be overridden in the user project makefile as the value of the
 182                                  *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
 183                                  */
 184                                 #define USB_STREAM_TIMEOUT_MS       100
 185                         #endif
 186
 187                 /* Inline Functions: */
 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 function is not available on some AVR models which do not support hardware VBUS monitoring.
 193                                  */
 194                                 static inline bool USB_VBUS_GetStatus(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 195                                 static inline bool USB_VBUS_GetStatus(void)
 196                                 {
 197                                         return ((USBSTA & (1 << VBUS)) ? true : false);
 198                                 }
 199                         #endif
 200
 201                         /** Detaches the device from the USB bus. This has the effect of removing the device from any
 202                          *  attached host, ceasing USB communications. If no host is present, this prevents any host from
 203                          *  enumerating the device once attached until \ref USB_Attach() is called.
 204                          */
 205                         static inline void USB_Detach(void) ATTR_ALWAYS_INLINE;
 206                         static inline void USB_Detach(void)
 207                         {
 208                                 UDCON  |=  (1 << DETACH);
 209                         }
 210
 211                         /** Attaches the device to the USB bus. This announces the device's presence to any attached
 212                          *  USB host, starting the enumeration process. If no host is present, attaching the device
 213                          *  will allow for enumeration once a host is connected to the device.
 214                          *
 215                          *  This is inexplicably also required for proper operation while in host mode, to enable the
 216                          *  attachment of a device to the host. This is despite the bit being located in the device-mode
 217                          *  register and despite the datasheet making no mention of its requirement in host mode.
 218                          */
 219                         static inline void USB_Attach(void) ATTR_ALWAYS_INLINE;
 220                         static inline void USB_Attach(void)
 221                         {
 222                                 UDCON  &= ~(1 << DETACH);
 223                         }
 224
 225                 /* Function Prototypes: */
 226                         /** Main function to initialize and start the USB interface. Once active, the USB interface will
 227                          *  allow for device connection to a host when in device mode, or for device enumeration while in
 228                          *  host mode.
 229                          *
 230                          *  As the USB library relies on interrupts for the device and host mode enumeration processes,
 231                          *  the user must enable global interrupts before or shortly after this function is called. In
 232                          *  device mode, interrupts must be enabled within 500ms of this function being called to ensure
 233                          *  that the host does not time out whilst enumerating the device. In host mode, interrupts may be
 234                          *  enabled at the application's leisure however enumeration will not begin of an attached device
 235                          *  until after this has occurred.
 236                          *
 237                          *  Calling this function when the USB interface is already initialized will cause a complete USB
 238                          *  interface reset and re-enumeration.
 239                          *
 240                          *  \param[in] Mode     This is a mask indicating what mode the USB interface is to be initialized to, a value
 241                          *                      from the \ref USB_Modes_t enum.
 242                          *
 243                          *  \param[in] Options  Mask indicating the options which should be used when initializing the USB
 244                          *                      interface to control the USB interface's behaviour. This should be comprised of
 245                          *                      a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the
 246                          *                      PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
 247                          *                      mode speed.
 248                          *
 249                          *  \note To reduce the FLASH requirements of the library if only device or host mode is required,
 250                          *        the mode can be statically set in the project makefile by defining the token USB_DEVICE_ONLY
 251                          *        (for device mode) or USB_HOST_ONLY (for host mode), passing the token to the compiler
 252                          *        via the -D switch. If the mode is statically set, this parameter does not exist in the
 253                          *        function prototype.
 254                          *        \n\n
 255                          *
 256                          *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,
 257                          *        the options may be set statically in the same manner as the mode (see the Mode parameter of
 258                          *        this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token,
 259                          *        defined to the appropriate options masks. When the options are statically set, this
 260                          *        parameter does not exist in the function prototype.
 261                          *        \n\n
 262                          *
 263                          *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB
 264                          *        AVR models which only implement the USB device mode in hardware.
 265                          *
 266                          *  \see Device.h for the USB_DEVICE_OPT_* masks.
 267                          */
 268                         void USB_Init(
 269                                        #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 270                                        const uint8_t Mode
 271                                        #endif
 272
 273                                        #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__)
 274                                        ,
 275                                        #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS))
 276                                        void
 277                                        #endif
 278
 279                                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 280                                        const uint8_t Options
 281                                        #endif
 282                                        );
 283
 284                         /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
 285                          *  memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
 286                          *  is restarted with the \ref USB_Init() function.
 287                          */
 288                         void USB_ShutDown(void);
 289
 290                         /** Resets the interface, when already initialized. This will re-enumerate the device if already connected
 291                          *  to a host, or re-enumerate an already attached device when in host mode.
 292                          */
 293                         void USB_ResetInterface(void);
 294
 295                 /* Global Variables: */
 296                         #if (!defined(USB_HOST_ONLY) && !defined(USB_DEVICE_ONLY)) || defined(__DOXYGEN__)
 297                                 /** Indicates the mode that the USB interface is currently initialized to, a value from the
 298                                  *  \ref USB_Modes_t enum.
 299                                  *
 300                                  *  \note This variable should be treated as read-only in the user application, and never manually
 301                                  *        changed in value.
 302                                  *        \n\n
 303                                  *
 304                                  *  \note When the controller is initialized into UID autodetection mode, this variable will hold the
 305                                  *        currently selected USB mode (i.e. \ref USB_MODE_Device or \ref USB_MODE_Host). If the controller
 306                                  *        is fixed into a specific mode (either through the USB_DEVICE_ONLY or USB_HOST_ONLY compile time
 307                                  *        options, or a limitation of the USB controller in the chosen device model) this will evaluate to
 308                                  *        a constant of the appropriate value and will never evaluate to \ref USB_MODE_None even when the
 309                                  *        USB interface is not initialized.
 310                                  */
 311                                 extern volatile uint8_t USB_CurrentMode;
 312                         #elif defined(USB_HOST_ONLY)
 313                                 #define USB_CurrentMode USB_MODE_Host
 314                         #elif defined(USB_DEVICE_ONLY)
 315                                 #define USB_CurrentMode USB_MODE_Device
 316                         #endif
 317
 318                         #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 319                                 /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
 320                                  *  was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.
 321                                  *
 322                                  *  \note This variable should be treated as read-only in the user application, and never manually
 323                                  *        changed in value.
 324                                  */
 325                                 extern volatile uint8_t USB_Options;
 326                         #elif defined(USE_STATIC_OPTIONS)
 327                                 #define USB_Options USE_STATIC_OPTIONS
 328                         #endif
 329
 330                 /* Enums: */
 331                         /** Enum for the possible USB controller modes, for initialization via \ref USB_Init() and indication back to the
 332                          *  user application via \ref USB_CurrentMode.
 333                          */
 334                         enum USB_Modes_t
 335                         {
 336                                 USB_MODE_None   = 0, /**< Indicates that the controller is currently not initialized in any specific USB mode. */
 337                                 USB_MODE_Device = 1, /**< Indicates that the controller is currently initialized in USB Device mode. */
 338                                 USB_MODE_Host   = 2, /**< Indicates that the controller is currently initialized in USB Host mode. */
 339                                 USB_MODE_UID    = 3, /**< Indicates that the controller should determine the USB mode from the UID pin of the
 340                                                       *   USB connector.
 341                                                       */
 342                         };
 343
 344         /* Private Interface - For use in library only: */
 345         #if !defined(__DOXYGEN__)
 346                 /* Function Prototypes: */
 347                         #if defined(__INCLUDE_FROM_USB_CONTROLLER_C)
 348                                 #if defined(USB_CAN_BE_DEVICE)
 349                                 static void USB_Init_Device(void);
 350                                 #endif
 351
 352                                 #if defined(USB_CAN_BE_HOST)
 353                                 static void USB_Init_Host(void);
 354                                 #endif
 355                         #endif
 356
 357                 /* Inline Functions: */
 358                         static inline void USB_PLL_On(void) ATTR_ALWAYS_INLINE;
 359                         static inline void USB_PLL_On(void)
 360                         {
 361                                 PLLCSR  = USB_PLL_PSC;
 362                                 PLLCSR |= (1 << PLLE);
 363                         }
 364
 365                         static inline void USB_PLL_Off(void) ATTR_ALWAYS_INLINE;
 366                         static inline void USB_PLL_Off(void)
 367                         {
 368                                 PLLCSR  = 0;
 369                         }
 370
 371                         static inline bool USB_PLL_IsReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 372                         static inline bool USB_PLL_IsReady(void)
 373                         {
 374                                 return ((PLLCSR  &   (1 << PLOCK)) ? true : false);
 375                         }
 376
 377                         static inline void USB_REG_On(void) ATTR_ALWAYS_INLINE;
 378                         static inline void USB_REG_On(void)
 379                         {
 380                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
 381                                 UHWCON  |=  (1 << UVREGE);
 382                         #else
 383                                 REGCR   &= ~(1 << REGDIS);
 384                         #endif
 385                         }
 386
 387                         static inline void USB_REG_Off(void) ATTR_ALWAYS_INLINE;
 388                         static inline void USB_REG_Off(void)
 389                         {
 390                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
 391                                 UHWCON  &= ~(1 << UVREGE);
 392                         #else
 393                                 REGCR   |=  (1 << REGDIS);
 394                         #endif
 395                         }
 396
 397                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
 398                         static inline void USB_OTGPAD_On(void) ATTR_ALWAYS_INLINE;
 399                         static inline void USB_OTGPAD_On(void)
 400                         {
 401                                 USBCON  |=  (1 << OTGPADE);
 402                         }
 403
 404                         static inline void USB_OTGPAD_Off(void) ATTR_ALWAYS_INLINE;
 405                         static inline void USB_OTGPAD_Off(void)
 406                         {
 407                                 USBCON  &= ~(1 << OTGPADE);
 408                         }
 409                         #endif
 410
 411                         static inline void USB_CLK_Freeze(void) ATTR_ALWAYS_INLINE;
 412                         static inline void USB_CLK_Freeze(void)
 413                         {
 414                                 USBCON  |=  (1 << FRZCLK);
 415                         }
 416
 417                         static inline void USB_CLK_Unfreeze(void) ATTR_ALWAYS_INLINE;
 418                         static inline void USB_CLK_Unfreeze(void)
 419                         {
 420                                 USBCON  &= ~(1 << FRZCLK);
 421                         }
 422
 423                         static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE;
 424                         static inline void USB_Controller_Enable(void)
 425                         {
 426                                 USBCON  |=  (1 << USBE);
 427                         }
 428
 429                         static inline void USB_Controller_Disable(void) ATTR_ALWAYS_INLINE;
 430                         static inline void USB_Controller_Disable(void)
 431                         {
 432                                 USBCON  &= ~(1 << USBE);
 433                         }
 434
 435                         static inline void USB_Controller_Reset(void) ATTR_ALWAYS_INLINE;
 436                         static inline void USB_Controller_Reset(void)
 437                         {
 438                                 const uint8_t Temp = USBCON;
 439
 440                                 USBCON = (Temp & ~(1 << USBE));
 441                                 USBCON = (Temp |  (1 << USBE));
 442                         }
 443
 444                         #if defined(USB_CAN_BE_BOTH)
 445                         static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 446                         static inline uint8_t USB_GetUSBModeFromUID(void)
 447                         {
 448                                 if (USBSTA & (1 << ID))
 449                                   return USB_MODE_Device;
 450                                 else
 451                                   return USB_MODE_Host;
 452                         }
 453                         #endif
 454
 455         #endif
 456
 457         /* Disable C linkage for C++ Compilers: */
 458                 #if defined(__cplusplus)
 459                         }
 460                 #endif
 461
 462 #endif
 463
 464 /** @} */
 465