LUFA/Drivers/USB/LowLevel/LowLevel.h

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