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