LUFA/Drivers/USB/Core/UC3/USBController_UC3.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2020.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2020  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 AVR32 UC3 microcontrollers.
  33  *  \copydetails Group_USBManagement_UC3
  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_UC3 USB Interface Management (UC3)
  41  *  \brief USB Controller definitions for the AVR32 UC3 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_UC3_H__
  49 #define __USBCONTROLLER_UC3_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 clock input to the USB module.
  85                 #endif
  86
  87                 #if (defined(USB_SERIES_UC3A3_AVR) || defined(USB_SERIES_UC3A4_AVR))
  88                         #if ((F_USB < 12000000) || (F_USB % 12000000))
  89                                 #error Invalid F_USB specified. F_USB must be a multiple of 12MHz for UC3A3 and UC3A4 devices.
  90                         #endif
  91                 #else
  92                         #if ((F_USB < 48000000) || (F_USB % 48000000))
  93                                 #error Invalid F_USB specified. F_USB must be a multiple of 48MHz for UC3A and UC3B devices.
  94                         #endif
  95                 #endif
  96
  97         /* Public Interface - May be used in end-application: */
  98                 /* Macros: */
  99                         /** \name USB Controller Option Masks */
 100                         /**@{*/
 101                         /** Selects one of the system's main clock oscillators as the input clock to the USB Generic Clock source
 102                          *  generation module. This indicates that an external oscillator should be used directly instead of an
 103                          *  internal PLL clock source.
 104                          */
 105                         #define USB_OPT_GCLK_SRC_OSC               (1 << 2)
 106
 107                         /** Selects one of the system's PLL oscillators as the input clock to the USB Generic Clock source
 108                          *  generation module. This indicates that one of the device's PLL outputs should be used instead of an
 109                          *  external oscillator source.
 110                          */
 111                         #define USB_OPT_GCLK_SRC_PLL               (0 << 2)
 112
 113                         /** Selects PLL or External Oscillator 0 as the USB Generic Clock source module input clock. */
 114                         #define USB_OPT_GCLK_CHANNEL_0             (1 << 3)
 115
 116                         /** Selects PLL or External Oscillator 1 as the USB Generic Clock source module input clock. */
 117                         #define USB_OPT_GCLK_CHANNEL_1             (0 << 3)
 118                         /**@}*/
 119
 120                         #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
 121                                 /** Constant for the maximum software timeout period of the USB data stream transfer functions
 122                                  *  (both control and standard) when in either device or host mode. If the next packet of a stream
 123                                  *  is not received or acknowledged within this time period, the stream function will fail.
 124                                  *
 125                                  *  This value may be overridden in the user project makefile as the value of the
 126                                  *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
 127                                  */
 128                                 #define USB_STREAM_TIMEOUT_MS       100
 129                         #endif
 130
 131                 /* Inline Functions: */
 132                         /** Determines if the VBUS line is currently high (i.e. the USB host is supplying power).
 133                          *
 134                          *  \return Boolean \c true if the VBUS line is currently detecting power from a host, \c false otherwise.
 135                          */
 136                         static inline bool USB_VBUS_GetStatus(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 137                         static inline bool USB_VBUS_GetStatus(void)
 138                         {
 139                                 return AVR32_USBB.USBSTA.vbus;
 140                         }
 141
 142                         /** Detaches the device from the USB bus. This has the effect of removing the device from any
 143                          *  attached host, ceasing USB communications. If no host is present, this prevents any host from
 144                          *  enumerating the device once attached until \ref USB_Attach() is called.
 145                          */
 146                         static inline void USB_Detach(void) ATTR_ALWAYS_INLINE;
 147                         static inline void USB_Detach(void)
 148                         {
 149                                 AVR32_USBB.UDCON.detach = true;
 150                         }
 151
 152                         /** Attaches the device to the USB bus. This announces the device's presence to any attached
 153                          *  USB host, starting the enumeration process. If no host is present, attaching the device
 154                          *  will allow for enumeration once a host is connected to the device.
 155                          *
 156                          *  This is inexplicably also required for proper operation while in host mode, to enable the
 157                          *  attachment of a device to the host. This is despite the bit being located in the device-mode
 158                          *  register and despite the datasheet making no mention of its requirement in host mode.
 159                          */
 160                         static inline void USB_Attach(void) ATTR_ALWAYS_INLINE;
 161                         static inline void USB_Attach(void)
 162                         {
 163                                 AVR32_USBB.UDCON.detach = false;
 164                         }
 165
 166                 /* Function Prototypes: */
 167                         /** Main function to initialize and start the USB interface. Once active, the USB interface will
 168                          *  allow for device connection to a host when in device mode, or for device enumeration while in
 169                          *  host mode.
 170                          *
 171                          *  As the USB library relies on interrupts for the device and host mode enumeration processes,
 172                          *  the user must enable global interrupts before or shortly after this function is called. In
 173                          *  device mode, interrupts must be enabled within 500ms of this function being called to ensure
 174                          *  that the host does not time out whilst enumerating the device. In host mode, interrupts may be
 175                          *  enabled at the application's leisure however enumeration will not begin of an attached device
 176                          *  until after this has occurred.
 177                          *
 178                          *  Calling this function when the USB interface is already initialized will cause a complete USB
 179                          *  interface reset and re-enumeration.
 180                          *
 181                          *  \param[in] Mode     Mask indicating what mode the USB interface is to be initialized to, a value
 182                          *                      from the \ref USB_Modes_t enum.
 183                          *                      \note This parameter does not exist on devices with only one supported USB
 184                          *                            mode (device or host).
 185                          *
 186                          *  \param[in] Options  Mask indicating the options which should be used when initializing the USB
 187                          *                      interface to control the USB interface's behavior. This should be comprised of
 188                          *                      a \c USB_OPT_REG_* mask to control the regulator, a \c USB_OPT_*_PLL mask to control the
 189                          *                      PLL, and a \c USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
 190                          *                      mode speed.
 191                          *
 192                          *  \note To reduce the FLASH requirements of the library if only device or host mode is required,
 193                          *        the mode can be statically set in the project makefile by defining the token \c USB_DEVICE_ONLY
 194                          *        (for device mode) or \c USB_HOST_ONLY (for host mode), passing the token to the compiler
 195                          *        via the -D switch. If the mode is statically set, this parameter does not exist in the
 196                          *        function prototype.
 197                          *        \n\n
 198                          *
 199                          *  \note To reduce the FLASH requirements of the library if only fixed settings are required,
 200                          *        the options may be set statically in the same manner as the mode (see the Mode parameter of
 201                          *        this function). To statically set the USB options, pass in the \c USE_STATIC_OPTIONS token,
 202                          *        defined to the appropriate options masks. When the options are statically set, this
 203                          *        parameter does not exist in the function prototype.
 204                          *
 205                          *  \see \ref Group_Device for the \c USB_DEVICE_OPT_* masks.
 206                          */
 207                         void USB_Init(
 208                                        #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 209                                        const uint8_t Mode
 210                                        #endif
 211
 212                                        #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__)
 213                                        ,
 214                                        #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS))
 215                                        void
 216                                        #endif
 217
 218                                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 219                                        const uint8_t Options
 220                                        #endif
 221                                        );
 222
 223                         /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
 224                          *  memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
 225                          *  is restarted with the \ref USB_Init() function.
 226                          */
 227                         void USB_Disable(void);
 228
 229                         /** Resets the interface, when already initialized. This will re-enumerate the device if already connected
 230                          *  to a host, or re-enumerate an already attached device when in host mode.
 231                          */
 232                         void USB_ResetInterface(void);
 233
 234                 /* Global Variables: */
 235                         #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 236                                 /** Indicates the mode that the USB interface is currently initialized to, a value from the
 237                                  *  \ref USB_Modes_t enum.
 238                                  *
 239                                  *  \attention This variable should be treated as read-only in the user application, and never manually
 240                                  *             changed in value.
 241                                  *
 242                                  *  \note When the controller is initialized into UID auto-detection mode, this variable will hold the
 243                                  *        currently selected USB mode (i.e. \ref USB_MODE_Device or \ref USB_MODE_Host). If the controller
 244                                  *        is fixed into a specific mode (either through the \c USB_DEVICE_ONLY or \c USB_HOST_ONLY compile time
 245                                  *        options, or a limitation of the USB controller in the chosen device model) this will evaluate to
 246                                  *        a constant of the appropriate value and will never evaluate to \ref USB_MODE_None even when the
 247                                  *        USB interface is not initialized.
 248                                  */
 249                                 extern volatile uint8_t USB_CurrentMode;
 250                         #elif defined(USB_CAN_BE_HOST)
 251                                 #define USB_CurrentMode USB_MODE_Host
 252                         #elif defined(USB_CAN_BE_DEVICE)
 253                                 #define USB_CurrentMode USB_MODE_Device
 254                         #endif
 255
 256                         #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 257                                 /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
 258                                  *  was called. This value will be one of the \c USB_MODE_* masks defined elsewhere in this module.
 259                                  *
 260                                  *  \attention This variable should be treated as read-only in the user application, and never manually
 261                                  *             changed in value.
 262                                  */
 263                                 extern volatile uint8_t USB_Options;
 264                         #elif defined(USE_STATIC_OPTIONS)
 265                                 #define USB_Options USE_STATIC_OPTIONS
 266                         #endif
 267
 268         /* Private Interface - For use in library only: */
 269         #if !defined(__DOXYGEN__)
 270                 /* Macros: */
 271                         #if defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32)
 272                                 #define USB_CLOCK_REQUIRED_FREQ  12000000UL
 273                         #else
 274                                 #define USB_CLOCK_REQUIRED_FREQ  48000000UL
 275                         #endif
 276
 277                 /* Function Prototypes: */
 278                         #if defined(__INCLUDE_FROM_USB_CONTROLLER_C)
 279                                 #if defined(USB_CAN_BE_DEVICE)
 280                                 static void USB_Init_Device(void);
 281                                 #endif
 282
 283                                 #if defined(USB_CAN_BE_HOST)
 284                                 static void USB_Init_Host(void);
 285                                 #endif
 286                         #endif
 287
 288                 /* Inline Functions: */
 289                         static inline void USB_OTGPAD_On(void) ATTR_ALWAYS_INLINE;
 290                         static inline void USB_OTGPAD_On(void)
 291                         {
 292                                 AVR32_USBB.USBCON.otgpade = true;
 293                         }
 294
 295                         static inline void USB_OTGPAD_Off(void) ATTR_ALWAYS_INLINE;
 296                         static inline void USB_OTGPAD_Off(void)
 297                         {
 298                                 AVR32_USBB.USBCON.otgpade = false;
 299                         }
 300
 301                         static inline void USB_CLK_Freeze(void) ATTR_ALWAYS_INLINE;
 302                         static inline void USB_CLK_Freeze(void)
 303                         {
 304                                 AVR32_USBB.USBCON.frzclk = true;
 305                         }
 306
 307                         static inline void USB_CLK_Unfreeze(void) ATTR_ALWAYS_INLINE;
 308                         static inline void USB_CLK_Unfreeze(void)
 309                         {
 310                                 AVR32_USBB.USBCON.frzclk = false;
 311                         }
 312
 313                         static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE;
 314                         static inline void USB_Controller_Enable(void)
 315                         {
 316                                 AVR32_USBB.USBCON.usbe = true;
 317                         }
 318
 319                         static inline void USB_Controller_Disable(void) ATTR_ALWAYS_INLINE;
 320                         static inline void USB_Controller_Disable(void)
 321                         {
 322                                 AVR32_USBB.USBCON.usbe = false;
 323                         }
 324
 325                         static inline void USB_Controller_Reset(void) ATTR_ALWAYS_INLINE;
 326                         static inline void USB_Controller_Reset(void)
 327                         {
 328                                 AVR32_USBB.USBCON.usbe = false;
 329                                 AVR32_USBB.USBCON.usbe = true;
 330                         }
 331
 332                         #if defined(USB_CAN_BE_BOTH)
 333                         static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 334                         static inline uint8_t USB_GetUSBModeFromUID(void)
 335                         {
 336                                 if (AVR32_USBB.USBSTA.id)
 337                                   return USB_MODE_Device;
 338                                 else
 339                                   return USB_MODE_Host;
 340                         }
 341                         #endif
 342
 343         #endif
 344
 345         /* Disable C linkage for C++ Compilers: */
 346                 #if defined(__cplusplus)
 347                         }
 348                 #endif
 349
 350 #endif
 351
 352 /** @} */
 353