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