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