protocol/lufa/LUFA-git/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 AVR XMEGA microcontrollers.
  33  *  \copydetails Group_USBManagement_XMEGA
  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_XMEGA USB Interface Management (XMEGA)
  41  *  \brief USB Controller definitions for the AVR XMEGA 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_XMEGA_H__
  49 #define __USBCONTROLLER_XMEGA_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         /* Private Interface - For use in library only: */
  59         #if !defined(__DOXYGEN__)
  60                 /* Macros: */
  61                         #if defined(MAX_ENDPOINT_INDEX)
  62                                 #define ENDPOINT_TABLE_COUNT  (MAX_ENDPOINT_INDEX + 1)
  63                         #else
  64                                 #define ENDPOINT_TABLE_COUNT  16
  65                         #endif
  66
  67                 /* Type Defines: */
  68                         typedef struct
  69                         {
  70                                 struct
  71                                 {
  72                                         USB_EP_t OUT;
  73                                         USB_EP_t IN;
  74                                 } Endpoints[ENDPOINT_TABLE_COUNT];
  75                                 uint16_t FrameNum;
  76                         } ATTR_PACKED USB_EndpointTable_t;
  77
  78                 /* External Variables: */
  79                         extern uint8_t USB_EndpointTable[];
  80         #endif
  81
  82         /* Includes: */
  83                 #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
  84                         #include "../Device.h"
  85                         #include "../Endpoint.h"
  86                         #include "../DeviceStandardReq.h"
  87                         #include "../EndpointStream.h"
  88                 #endif
  89
  90         /* Enable C linkage for C++ Compilers: */
  91                 #if defined(__cplusplus)
  92                         extern "C" {
  93                 #endif
  94
  95         /* Preprocessor Checks and Defines: */
  96                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  97                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  98                 #endif
  99
 100                 #if !defined(F_USB)
 101                         #error F_USB is not defined. You must define F_USB to the frequency of the unprescaled USB controller clock in your project makefile.
 102                 #endif
 103
 104                 #if ((F_USB % 6000000) || (F_USB < 6000000))
 105                         #error Invalid F_USB specified. F_USB must be a multiple of 6MHz for USB Low Speed operation, and a multiple of 48MHz for Full Speed operation.
 106                 #endif
 107
 108         /* Public Interface - May be used in end-application: */
 109                 /* Macros: */
 110                         /** \name USB Controller Option Masks */
 111                         //@{
 112                         /** Sets the USB bus interrupt priority level to be low priority. The USB bus interrupt is used for Start of Frame events, bus suspend
 113                          *  and resume events, bus reset events and other events related to the management of the USB bus.
 114                          */
 115                         #define USB_OPT_BUSEVENT_PRILOW           ((0 << 2) | (0 << 1))
 116
 117                         /** Sets the USB bus interrupt priority level to be medium priority. The USB bus interrupt is used for Start of Frame events, bus suspend
 118                          *  and resume events, bus reset events and other events related to the management of the USB bus.
 119                          */
 120                         #define USB_OPT_BUSEVENT_PRIMED           ((0 << 2) | (1 << 1))
 121
 122                         /** Sets the USB bus interrupt priority level to be high priority. The USB bus interrupt is used for Start of Frame events, bus suspend
 123                          *  and resume events, bus reset events and other events related to the management of the USB bus.
 124                          */
 125                         #define USB_OPT_BUSEVENT_PRIHIGH          ((1 << 2) | (0 << 1))
 126
 127                         /** Sets the USB controller to source its clock from the internal RC 32MHz clock, once it has been DFLL calibrated to 48MHz. */
 128                         #define USB_OPT_RC32MCLKSRC               (0 << 3)
 129
 130                         /** Sets the USB controller to source its clock from the internal PLL. */
 131                         #define USB_OPT_PLLCLKSRC                 (1 << 3)
 132                         //@}
 133
 134                         #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
 135                                 /** Constant for the maximum software timeout period of the USB data stream transfer functions
 136                                  *  (both control and standard) when in either device or host mode. If the next packet of a stream
 137                                  *  is not received or acknowledged within this time period, the stream function will fail.
 138                                  *
 139                                  *  This value may be overridden in the user project makefile as the value of the
 140                                  *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
 141                                  */
 142                                 #define USB_STREAM_TIMEOUT_MS       100
 143                         #endif
 144
 145                 /* Inline Functions: */
 146                         /** Detaches the device from the USB bus. This has the effect of removing the device from any
 147                          *  attached host, ceasing USB communications. If no host is present, this prevents any host from
 148                          *  enumerating the device once attached until \ref USB_Attach() is called.
 149                          */
 150                         static inline void USB_Detach(void) ATTR_ALWAYS_INLINE;
 151                         static inline void USB_Detach(void)
 152                         {
 153                                 USB.CTRLB &= ~USB_ATTACH_bm;
 154                         }
 155
 156                         /** Attaches the device to the USB bus. This announces the device's presence to any attached
 157                          *  USB host, starting the enumeration process. If no host is present, attaching the device
 158                          *  will allow for enumeration once a host is connected to the device.
 159                          *
 160                          *  This is inexplicably also required for proper operation while in host mode, to enable the
 161                          *  attachment of a device to the host. This is despite the bit being located in the device-mode
 162                          *  register and despite the datasheet making no mention of its requirement in host mode.
 163                          */
 164                         static inline void USB_Attach(void) ATTR_ALWAYS_INLINE;
 165                         static inline void USB_Attach(void)
 166                         {
 167                                 USB.CTRLB |= USB_ATTACH_bm;
 168                         }
 169
 170                 /* Function Prototypes: */
 171                         /** Main function to initialize and start the USB interface. Once active, the USB interface will
 172                          *  allow for device connection to a host when in device mode, or for device enumeration while in
 173                          *  host mode.
 174                          *
 175                          *  As the USB library relies on interrupts for the device and host mode enumeration processes,
 176                          *  the user must enable global interrupts before or shortly after this function is called. In
 177                          *  device mode, interrupts must be enabled within 500ms of this function being called to ensure
 178                          *  that the host does not time out whilst enumerating the device. In host mode, interrupts may be
 179                          *  enabled at the application's leisure however enumeration will not begin of an attached device
 180                          *  until after this has occurred.
 181                          *
 182                          *  Calling this function when the USB interface is already initialized will cause a complete USB
 183                          *  interface reset and re-enumeration.
 184                          *
 185                          *  \param[in] Mode     Mask indicating what mode the USB interface is to be initialized to, a value
 186                          *                      from the \ref USB_Modes_t enum.
 187                          *                      \note This parameter does not exist on devices with only one supported USB
 188                          *                            mode (device or host).
 189                          *
 190                          *  \param[in] Options  Mask indicating the options which should be used when initializing the USB
 191                          *                      interface to control the USB interface's behavior. This should be comprised of
 192                          *                      a \c USB_OPT_REG_* mask to control the regulator, a \c USB_OPT_*_PLL mask to control the
 193                          *                      PLL, and a \c USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
 194                          *                      mode speed.
 195                          *
 196                          *  \note To reduce the FLASH requirements of the library if only device or host mode is required,
 197                          *        the mode can be statically set in the project makefile by defining the token \c USB_DEVICE_ONLY
 198                          *        (for device mode) or \c USB_HOST_ONLY (for host mode), passing the token to the compiler
 199                          *        via the -D switch. If the mode is statically set, this parameter does not exist in the
 200                          *        function prototype.
 201                          *        \n\n
 202                          *
 203                          *  \note To reduce the FLASH requirements of the library if only fixed settings are required,
 204                          *        the options may be set statically in the same manner as the mode (see the Mode parameter of
 205                          *        this function). To statically set the USB options, pass in the \c USE_STATIC_OPTIONS token,
 206                          *        defined to the appropriate options masks. When the options are statically set, this
 207                          *        parameter does not exist in the function prototype.
 208                          *        \n\n
 209                          *
 210                          *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB
 211                          *        AVR models which only implement the USB device mode in hardware.
 212                          *
 213                          *  \see \ref Group_Device for the \c USB_DEVICE_OPT_* masks.
 214                          */
 215                         void USB_Init(
 216                                        #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 217                                        const uint8_t Mode
 218                                        #endif
 219
 220                                        #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__)
 221                                        ,
 222                                        #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS))
 223                                        void
 224                                        #endif
 225
 226                                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 227                                        const uint8_t Options
 228                                        #endif
 229                                        );
 230
 231                         /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
 232                          *  memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
 233                          *  is restarted with the \ref USB_Init() function.
 234                          */
 235                         void USB_Disable(void);
 236
 237                         /** Resets the interface, when already initialized. This will re-enumerate the device if already connected
 238                          *  to a host, or re-enumerate an already attached device when in host mode.
 239                          */
 240                         void USB_ResetInterface(void);
 241
 242                 /* Global Variables: */
 243                         #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 244                                 /** Indicates the mode that the USB interface is currently initialized to, a value from the
 245                                  *  \ref USB_Modes_t enum.
 246                                  *
 247                                  *  \attention This variable should be treated as read-only in the user application, and never manually
 248                                  *             changed in value.
 249                                  *
 250                                  *  \note When the controller is initialized into UID auto-detection mode, this variable will hold the
 251                                  *        currently selected USB mode (i.e. \ref USB_MODE_Device or \ref USB_MODE_Host). If the controller
 252                                  *        is fixed into a specific mode (either through the \c USB_DEVICE_ONLY or \c USB_HOST_ONLY compile time
 253                                  *        options, or a limitation of the USB controller in the chosen device model) this will evaluate to
 254                                  *        a constant of the appropriate value and will never evaluate to \ref USB_MODE_None even when the
 255                                  *        USB interface is not initialized.
 256                                  */
 257                                 extern volatile uint8_t USB_CurrentMode;
 258                         #elif defined(USB_CAN_BE_HOST)
 259                                 #define USB_CurrentMode USB_MODE_Host
 260                         #elif defined(USB_CAN_BE_DEVICE)
 261                                 #define USB_CurrentMode USB_MODE_Device
 262                         #endif
 263
 264                         #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 265                                 /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
 266                                  *  was called. This value will be one of the \c USB_MODE_* masks defined elsewhere in this module.
 267                                  *
 268                                  *  \attention This variable should be treated as read-only in the user application, and never manually
 269                                  *             changed in value.
 270                                  */
 271                                 extern volatile uint8_t USB_Options;
 272                         #elif defined(USE_STATIC_OPTIONS)
 273                                 #define USB_Options USE_STATIC_OPTIONS
 274                         #endif
 275
 276         /* Private Interface - For use in library only: */
 277         #if !defined(__DOXYGEN__)
 278                 /* Function Prototypes: */
 279                         #if defined(__INCLUDE_FROM_USB_CONTROLLER_C)
 280                                 static void USB_Init_Device(void);
 281                         #endif
 282
 283                 /* Inline Functions: */
 284                         static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE;
 285                         static inline void USB_Controller_Enable(void)
 286                         {
 287                                 USB.CTRLA |=  USB_ENABLE_bm;
 288                         }
 289
 290                         static inline void USB_Controller_Disable(void) ATTR_ALWAYS_INLINE;
 291                         static inline void USB_Controller_Disable(void)
 292                         {
 293                                 USB.CTRLA &= ~USB_ENABLE_bm;
 294                         }
 295
 296                         static inline void USB_Controller_Reset(void) ATTR_ALWAYS_INLINE;
 297                         static inline void USB_Controller_Reset(void)
 298                         {
 299                                 USB.CTRLA &= ~USB_ENABLE_bm;
 300                                 USB.CTRLA |=  USB_ENABLE_bm;
 301                         }
 302
 303         #endif
 304
 305         /* Disable C linkage for C++ Compilers: */
 306                 #if defined(__cplusplus)
 307                         }
 308                 #endif
 309
 310 #endif
 311
 312 /** @} */
 313