LUFA/Drivers/USB/LowLevel/LowLevel.h

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