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

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