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