LUFA/Drivers/USB/LowLevel/LowLevel.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 low level USB controller definitions.
  33  *
  34  *  This file contains structures, function prototypes and macros related to the low level configutation of the
  35  *  USB controller, to start, stop and reset the USB library core.
  36  *
  37  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  38  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  39  */
  40
  41 /** \ingroup Group_USB
  42  *  @defgroup Group_USBManagement USB Interface Management
  43  *
  44  *  Functions, macros, variables, enums and types related to the setup and management of the USB interface.
  45  *
  46  *  @{
  47  */
  48
  49 #ifndef __USBLOWLEVEL_H__
  50 #define __USBLOWLEVEL_H__
  51
  52         /* Includes: */
  53                 #include <avr/io.h>
  54                 #include <avr/interrupt.h>
  55                 #include <stdbool.h>
  56
  57                 #include "../HighLevel/USBMode.h"
  58
  59                 #include "../../../Common/Common.h"
  60                 #include "../HighLevel/USBMode.h"
  61                 #include "../HighLevel/Events.h"
  62                 #include "../HighLevel/USBTask.h"
  63                 #include "USBInterrupt.h"
  64
  65                 #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
  66                         #include "Host.h"
  67                         #include "Pipe.h"
  68                         #include "OTG.h"
  69                 #endif
  70
  71                 #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
  72                         #include "Device.h"
  73                         #include "Endpoint.h"
  74                         #include "DevChapter9.h"
  75                 #endif
  76
  77         /* Enable C linkage for C++ Compilers: */
  78                 #if defined(__cplusplus)
  79                         extern "C" {
  80                 #endif
  81
  82         /* Preprocessor Checks and Defines: */
  83                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  84                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  85                 #endif
  86
  87                 #if !defined(F_CLOCK)
  88                         #error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled input clock in your project makefile.
  89                 #endif
  90
  91                 #if (F_CLOCK == 8000000)
  92                         #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
  93                              defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
  94                                  defined(__AVR_ATmega32U2__))
  95                                 #define USB_PLL_PSC                0
  96                         #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
  97                                 #define USB_PLL_PSC                0
  98                         #elif (defined(__AVR_AT90USB646__)  || defined(__AVR_AT90USB1286__) || defined(__AVR_ATmega32U6__))
  99                                 #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))
 100                         #elif (defined(__AVR_AT90USB647__)  || defined(__AVR_AT90USB1287__))
 101                                 #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))
 102                         #endif
 103                 #elif (F_CLOCK == 16000000)
 104                         #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
 105                              defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
 106                                  defined(__AVR_ATmega32U2__))
 107                                 #define USB_PLL_PSC                (1 << PLLP0)
 108                         #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
 109                                 #define USB_PLL_PSC                (1 << PINDIV)
 110                         #elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_ATmega32U6__))
 111                                 #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP1))
 112                         #elif (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__))
 113                                 #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP0))
 114                         #endif
 115                 #endif
 116
 117                 #if !defined(USB_PLL_PSC)
 118                         #error No PLL prescale value available for chosen F_CPU value and AVR model.
 119                 #endif
 120
 121         /* Public Interface - May be used in end-application: */
 122                 /* Macros: */
 123                         /** Mode mask for the \ref USB_CurrentMode global. This indicates that the USB interface is currently not
 124                          *  initialized into any mode.
 125                          */
 126                         #define USB_MODE_NONE                      0
 127
 128                         /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the
 129                          *  USB interface is or should be initialized in the USB device mode.
 130                          */
 131                         #define USB_MODE_DEVICE                    1
 132
 133                         /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the
 134                          *  USB interface is or should be initialized in the USB host mode.
 135                          */
 136                         #define USB_MODE_HOST                      2
 137
 138                         #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 139                                 /** Mode mask for the the \ref USB_Init() function. This indicates that the USB interface should be
 140                                  *  initialized into whatever mode the UID pin of the USB AVR indicates, and that the device
 141                                  *  should swap over its mode when the level of the UID pin changes during operation.
 142                                  *
 143                                  *  \note This token is not available on AVR models which do not support both host and device modes.
 144                                  */
 145                                 #define USB_MODE_UID                       3
 146                         #endif
 147
 148                         /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
 149                          *  regulator should be enabled to regulate the data pin voltages to within the USB standard.
 150                          *
 151                          *  \note See USB AVR data sheet for more information on the internal pad regulator.
 152                          */
 153                         #define USB_OPT_REG_DISABLED               (1 << 1)
 154
 155                         /** Regulator enable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
 156                          *  regulator should be disabled and the AVR's VCC level used for the data pads.
 157                          *
 158                          *  \note See USB AVR data sheet for more information on the internal pad regulator.
 159                          */
 160                         #define USB_OPT_REG_ENABLED                (0 << 1)
 161
 162                         /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application
 163                          *  will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
 164                          *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
 165                          */
 166                         #define USB_OPT_MANUAL_PLL                 (1 << 2)
 167
 168                         /** Automatic PLL control option mask for \ref USB_Init(). This indicates to the library that the library should
 169                          *  take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
 170                          *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
 171                          */
 172                         #define USB_OPT_AUTO_PLL                   (0 << 2)
 173
 174                         /** Mask for a CONTROL type endpoint or pipe.
 175                          *
 176                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 177                          */
 178                         #define EP_TYPE_CONTROL                    0x00
 179
 180                         /** Mask for an ISOCHRONOUS type endpoint or pipe.
 181                          *
 182                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 183                          */
 184                         #define EP_TYPE_ISOCHRONOUS                0x01
 185
 186                         /** Mask for a BULK type endpoint or pipe.
 187                          *
 188                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 189                          */
 190                         #define EP_TYPE_BULK                       0x02
 191
 192                         /** Mask for an INTERRUPT type endpoint or pipe.
 193                          *
 194                          *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
 195                          */
 196                         #define EP_TYPE_INTERRUPT                  0x03
 197
 198                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
 199                                 /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power),
 200                                  *  otherwise returns false.
 201                                  *
 202                                  *  \note This token is not available on some AVR models which do not support hardware VBUS monitoring.
 203                                  */
 204                                 #define USB_VBUS_GetStatus()             ((USBSTA & (1 << VBUS)) ? true : false)
 205                         #endif
 206
 207                         /** Detaches the device from the USB bus. This has the effect of removing the device from any
 208                          *  attached host, ceasing USB communications. If no host is present, this prevents any host from
 209                          *  enumerating the device once attached until \ref USB_Attach() is called.
 210                          */
 211                         #define USB_Detach()                    MACROS{ UDCON  |=  (1 << DETACH);  }MACROE
 212
 213                         /** Attaches the device to the USB bus. This announces the device's presence to any attached
 214                          *  USB host, starting the enumeration process. If no host is present, attaching the device
 215                          *  will allow for enumeration once a host is connected to the device.
 216                          *
 217                          *  This is inexplicably also required for proper operation while in host mode, to enable the
 218                          *  attachment of a device to the host. This is despite the bit being located in the device-mode
 219                          *  register and despite the datasheet making no mention of its requirement in host mode.
 220                          */
 221                         #define USB_Attach()                    MACROS{ UDCON  &= ~(1 << DETACH);  }MACROE
 222
 223                         #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
 224                                 /** Constant for the maximum software timeout period of the USB data stream transfer functions
 225                                  *  (both control and standard) when in either device or host mode. If the next packet of a stream
 226                                  *  is not received or acknowledged within this time period, the stream function will fail.
 227                                  *
 228                                  *  This value may be overridden in the user project makefile as the value of the
 229                                  *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
 230                                  */
 231                                 #define USB_STREAM_TIMEOUT_MS       100
 232                         #endif
 233
 234                 /* Function Prototypes: */
 235                         /** Main function to initialize and start the USB interface. Once active, the USB interface will
 236                          *  allow for device connection to a host when in device mode, or for device enumeration while in
 237                          *  host mode.
 238                          *
 239                          *  As the USB library relies on interrupts for the device and host mode enumeration processes,
 240                          *  the user must enable global interrupts before or shortly after this function is called. In
 241                          *  device mode, interrupts must be enabled within 500ms of this function being called to ensure
 242                          *  that the host does not time out whilst enumerating the device. In host mode, interrupts may be
 243                          *  enabled at the application's leisure however enumeration will not begin of an attached device
 244                          *  until after this has occurred.
 245                          *
 246                          *  Calling this function when the USB interface is already initialized will cause a complete USB
 247                          *  interface reset and re-enumeration.
 248                          *
 249                          *  \param[in] Mode     This is a mask indicating what mode the USB interface is to be initialized to.
 250                          *                      Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID.
 251                          *
 252                          *  \param[in] Options  Mask indicating the options which should be used when initializing the USB
 253                          *                      interface to control the USB interface's behaviour. This should be comprised of
 254                          *                      a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the
 255                          *                      PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
 256                          *                      mode speed.
 257                          *
 258                          *  \note To reduce the FLASH requirements of the library if only device or host mode is required,
 259                          *        the mode can be statically set in the project makefile by defining the token USB_DEVICE_ONLY
 260                          *        (for device mode) or USB_HOST_ONLY (for host mode), passing the token to the compiler
 261                          *        via the -D switch. If the mode is statically set, this parameter does not exist in the
 262                          *        function prototype.
 263                          *        \n\n
 264                          *
 265                          *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,
 266                          *        the options may be set statically in the same manner as the mode (see the Mode parameter of
 267                          *        this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token,
 268                          *        defined to the appropriate options masks. When the options are statically set, this
 269                          *        parameter does not exist in the function prototype.
 270                          *        \n\n
 271                          *
 272                          *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB
 273                          *        AVR models which only implement the USB device mode in hardware.
 274                          *
 275                          *  \see Device.h for the USB_DEVICE_OPT_* masks.
 276                          */
 277                         void USB_Init(
 278                                        #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 279                                        const uint8_t Mode
 280                                                    #endif
 281
 282                                        #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__)
 283                                        ,
 284                                                    #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS))
 285                                                    void
 286                                        #endif
 287
 288                                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 289                                        const uint8_t Options
 290                                        #endif
 291                                        );
 292
 293                         /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
 294                          *  memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
 295                          *  is restarted with the \ref USB_Init() function.
 296                          */
 297                         void USB_ShutDown(void);
 298
 299                         /** Resets the interface, when already initialized. This will re-enumerate the device if already connected
 300                          *  to a host, or re-enumerate an already attached device when in host mode.
 301                          */
 302                         void USB_ResetInterface(void);
 303
 304                 /* Enums: */
 305                         /** Enum for error codes relating to the powering on of the USB interface. These error codes are
 306                          *  used in the ErrorCode parameter value of the \ref EVENT_USB_InitFailure() event.
 307                          */
 308                         enum USB_InitErrorCodes_t
 309                         {
 310                                 USB_INITERROR_NoUSBModeSpecified       = 0, /**< Indicates that \ref USB_Init() was called with an
 311                                                                          *   invalid or missing Mode parameter.
 312                                                                          */
 313                         };
 314
 315                 /* Global Variables: */
 316                         #if (!defined(USB_HOST_ONLY) && !defined(USB_DEVICE_ONLY)) || defined(__DOXYGEN__)
 317                                 /** Indicates the mode that the USB interface is currently initialized to. This value will be
 318                                  *  one of the USB_MODE_* masks defined elsewhere in this module.
 319                                  *
 320                                  *  \note This variable should be treated as read-only in the user application, and never manually
 321                                  *        changed in value.
 322                                  */
 323                                 extern volatile uint8_t USB_CurrentMode;
 324                         #elif defined(USB_HOST_ONLY)
 325                                 #define USB_CurrentMode USB_MODE_HOST
 326                         #elif defined(USB_DEVICE_ONLY)
 327                                 #define USB_CurrentMode USB_MODE_DEVICE
 328                         #endif
 329
 330                         #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
 331                                 /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
 332                                  *  was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.
 333                                  *
 334                                  *  \note This variable should be treated as read-only in the user application, and never manually
 335                                  *        changed in value.
 336                                  */
 337                                 extern volatile uint8_t USB_Options;
 338                         #elif defined(USE_STATIC_OPTIONS)
 339                                 #define USB_Options USE_STATIC_OPTIONS
 340                         #endif
 341
 342         /* Private Interface - For use in library only: */
 343         #if !defined(__DOXYGEN__)
 344                 /* Macros: */
 345                         #define USB_PLL_On()               MACROS{ PLLCSR   =  USB_PLL_PSC; PLLCSR |= (1 << PLLE); }MACROE
 346                         #define USB_PLL_Off()              MACROS{ PLLCSR   =  0;                           }MACROE
 347                         #define USB_PLL_IsReady()                ((PLLCSR  &   (1 << PLOCK)) ? true : false)
 348
 349                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
 350                                 #define USB_REG_On()           MACROS{ UHWCON  |=  (1 << UVREGE);               }MACROE
 351                                 #define USB_REG_Off()          MACROS{ UHWCON  &= ~(1 << UVREGE);               }MACROE
 352                         #else
 353                                 #define USB_REG_On()           MACROS{ REGCR   &= ~(1 << REGDIS);               }MACROE
 354                                 #define USB_REG_Off()          MACROS{ REGCR   |=  (1 << REGDIS);               }MACROE
 355                         #endif
 356
 357                         #define USB_OTGPAD_On()            MACROS{ USBCON  |=  (1 << OTGPADE);              }MACROE
 358                         #define USB_OTGPAD_Off()           MACROS{ USBCON  &= ~(1 << OTGPADE);              }MACROE
 359
 360                         #define USB_CLK_Freeze()           MACROS{ USBCON  |=  (1 << FRZCLK);               }MACROE
 361                         #define USB_CLK_Unfreeze()         MACROS{ USBCON  &= ~(1 << FRZCLK);               }MACROE
 362
 363                         #define USB_Controller_Enable()    MACROS{ USBCON  |=  (1 << USBE);                 }MACROE
 364                         #define USB_Controller_Disable()   MACROS{ USBCON  &= ~(1 << USBE);                 }MACROE
 365                         #define USB_Controller_Reset()     MACROS{ const uint8_t Temp = USBCON; USBCON = (Temp & ~(1 << USBE)); \
 366                                                                    USBCON = (Temp | (1 << USBE));           }MACROE
 367
 368                 /* Inline Functions: */
 369                         #if defined(USB_CAN_BE_BOTH)
 370                         static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 371                         static inline uint8_t USB_GetUSBModeFromUID(void)
 372                         {
 373                                 if (USBSTA & (1 << ID))
 374                                   return USB_MODE_DEVICE;
 375                                 else
 376                                   return USB_MODE_HOST;
 377                         }
 378                         #endif
 379
 380         #endif
 381
 382         /* Disable C linkage for C++ Compilers: */
 383                 #if defined(__cplusplus)
 384                         }
 385                 #endif
 386
 387 #endif
 388
 389 /** @} */