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