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