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