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