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