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