projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add bluetooth channel connection callback to the incomplete BluetoothHost demo.
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / LowLevel.h
diff --git a/LUFA/Drivers/USB/LowLevel/LowLevel.h b/LUFA/Drivers/USB/LowLevel/LowLevel.h
index a5adf99..79261cd 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/LowLevel.h
+++ b/LUFA/Drivers/USB/LowLevel/LowLevel.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
 \r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
@@ -28,6 +28,16 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief USB low level USB controller definitions.\r
+ *\r
+ *  This file contains structures, function prototypes and macros related to the low level configutation of the\r
+ *  USB controller, to start, stop and reset the USB library core.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+ \r
 /** \ingroup Group_USB\r
  *  @defgroup Group_USBManagement USB Interface Management\r
  *\r
 /** \ingroup Group_USB\r
  *  @defgroup Group_USBManagement USB Interface Management\r
  *\r
@@ -70,29 +80,37 @@
                #endif\r
 \r
        /* Preprocessor Checks and Defines: */\r
                #endif\r
 \r
        /* Preprocessor Checks and Defines: */\r
+               #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+               #endif\r
+\r
                #if !defined(F_CLOCK)\r
                #if !defined(F_CLOCK)\r
-                       #error F_CLOCK is not defined. You must device F_CLOCK to the frequency of the unprescaled input clock in your project makefile.\r
+                       #error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled input clock in your project makefile.\r
                #endif\r
        \r
                #if (F_CLOCK == 8000000)\r
                #endif\r
        \r
                #if (F_CLOCK == 8000000)\r
-                       #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__))\r
+                       #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \\r
+                            defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \\r
+                                defined(__AVR_ATmega32U2__))\r
                                #define USB_PLL_PSC                0\r
                                #define USB_PLL_PSC                0\r
-                       #elif (defined(__AVR_AT90USB646__)  || defined(__AVR_AT90USB647__)  || \\r
-                              defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || \\r
-                                  defined(__AVR_ATmega32U6__))\r
-                               #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))\r
                        #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))\r
                                #define USB_PLL_PSC                0\r
                        #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))\r
                                #define USB_PLL_PSC                0\r
+                       #elif (defined(__AVR_AT90USB646__)  || defined(__AVR_AT90USB1286__) || defined(__AVR_ATmega32U6__))\r
+                               #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))\r
+                       #elif (defined(__AVR_AT90USB647__)  || defined(__AVR_AT90USB1287__))\r
+                               #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))\r
                        #endif\r
                #elif (F_CLOCK == 16000000)\r
                        #endif\r
                #elif (F_CLOCK == 16000000)\r
-                       #if (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_ATmega32U6__))\r
-                               #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP1))\r
-                       #elif (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__))\r
-                               #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP0))\r
-                       #elif (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__))\r
+                       #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \\r
+                            defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \\r
+                                defined(__AVR_ATmega32U2__))\r
                                #define USB_PLL_PSC                (1 << PLLP0)\r
                        #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))\r
                                #define USB_PLL_PSC                (1 << PINDIV)\r
                                #define USB_PLL_PSC                (1 << PLLP0)\r
                        #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))\r
                                #define USB_PLL_PSC                (1 << PINDIV)\r
+                       #elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_ATmega32U6__))\r
+                               #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP1))\r
+                       #elif (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__))\r
+                               #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP0))\r
                        #endif\r
                #endif\r
                \r
                        #endif\r
                #endif\r
                \r
@@ -111,15 +129,11 @@
                         *  USB interface is or should be initialized in the USB device mode.\r
                         */\r
                        #define USB_MODE_DEVICE                    1\r
                         *  USB interface is or should be initialized in the USB device mode.\r
                         */\r
                        #define USB_MODE_DEVICE                    1\r
-\r
-                       #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
-                               /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the\r
-                                *  USB interface is or should be initialized in the USB host mode.\r
-                                *\r
-                                *  \note This token is not available on AVR models which do not support host mode.\r
-                                */\r
-                               #define USB_MODE_HOST                  2\r
-                       #endif\r
+                       \r
+                       /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the\r
+                        *  USB interface is or should be initialized in the USB host mode.\r
+                        */\r
+                       #define USB_MODE_HOST                      2\r
                        \r
                        #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)\r
                                /** Mode mask for the the \ref USB_Init() function. This indicates that the USB interface should be\r
                        \r
                        #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)\r
                                /** Mode mask for the the \ref USB_Init() function. This indicates that the USB interface should be\r
@@ -181,7 +195,7 @@
                         */\r
                        #define EP_TYPE_INTERRUPT                  0x03\r
 \r
                         */\r
                        #define EP_TYPE_INTERRUPT                  0x03\r
 \r
-                       #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)\r
+                       #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)\r
                                /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power),\r
                                 *  otherwise returns false.\r
                                 *\r
                                /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power),\r
                                 *  otherwise returns false.\r
                                 *\r
@@ -191,7 +205,7 @@
                        #endif\r
 \r
                        /** Detaches the device from the USB bus. This has the effect of removing the device from any\r
                        #endif\r
 \r
                        /** Detaches the device from the USB bus. This has the effect of removing the device from any\r
-                        *  host if, ceasing USB communications. If no host is present, this prevents any host from\r
+                        *  attached host, ceasing USB communications. If no host is present, this prevents any host from\r
                         *  enumerating the device once attached until \ref USB_Attach() is called.\r
                         */\r
                        #define USB_Detach()                    MACROS{ UDCON  |=  (1 << DETACH);  }MACROE\r
                         *  enumerating the device once attached until \ref USB_Attach() is called.\r
                         */\r
                        #define USB_Detach()                    MACROS{ UDCON  |=  (1 << DETACH);  }MACROE\r
@@ -228,26 +242,28 @@
                         *  Calling this function when the USB interface is already initialized will cause a complete USB\r
                         *  interface reset and re-enumeration.\r
                         *\r
                         *  Calling this function when the USB interface is already initialized will cause a complete USB\r
                         *  interface reset and re-enumeration.\r
                         *\r
-                        *  \param Mode     This is a mask indicating what mode the USB interface is to be initialized to.\r
-                        *                  Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID.\r
+                        *  \param[in] Mode     This is a mask indicating what mode the USB interface is to be initialized to.\r
+                        *                      Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID.\r
                         *\r
                         *\r
-                        *  \param Options  Mask indicating the options which should be used when initializing the USB\r
-                        *                  interface to control the USB interface's behaviour. This should be comprised of\r
-                        *                  a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the\r
-                        *                  PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device\r
-                        *                  mode speed.\r
+                        *  \param[in] Options  Mask indicating the options which should be used when initializing the USB\r
+                        *                      interface to control the USB interface's behaviour. This should be comprised of\r
+                        *                      a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the\r
+                        *                      PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device\r
+                        *                      mode speed.\r
                         *\r
                         *  \note To reduce the FLASH requirements of the library if only device or host mode is required, \r
                         *\r
                         *  \note To reduce the FLASH requirements of the library if only device or host mode is required, \r
-                        *        this can be statically set via defining the token USB_DEVICE_ONLY for device mode or \r
-                        *        USB_HOST_ONLY for host mode in the use project makefile, passing the token to the compiler \r
+                        *        the mode can be statically set in the project makefile by defining the token USB_DEVICE_ONLY\r
+                        *        (for device mode) or USB_HOST_ONLY (for host mode), passing the token to the compiler \r
                         *        via the -D switch. If the mode is statically set, this parameter does not exist in the\r
                         *        function prototype.\r
                         *        via the -D switch. If the mode is statically set, this parameter does not exist in the\r
                         *        function prototype.\r
+                        *        \n\n\r
                         *\r
                         *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,\r
                         *        the options may be set statically in the same manner as the mode (see the Mode parameter of \r
                         *        this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token,\r
                         *        defined to the appropriate options masks. When the options are statically set, this\r
                         *        parameter does not exist in the function prototype.\r
                         *\r
                         *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,\r
                         *        the options may be set statically in the same manner as the mode (see the Mode parameter of \r
                         *        this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token,\r
                         *        defined to the appropriate options masks. When the options are statically set, this\r
                         *        parameter does not exist in the function prototype.\r
+                        *        \n\n\r
                         *        \r
                         *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB \r
                         *        AVR models which only implement the USB device mode in hardware.\r
                         *        \r
                         *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB \r
                         *        AVR models which only implement the USB device mode in hardware.\r
@@ -283,7 +299,7 @@
 \r
                /* Enums: */\r
                        /** Enum for error codes relating to the powering on of the USB interface. These error codes are\r
 \r
                /* Enums: */\r
                        /** Enum for error codes relating to the powering on of the USB interface. These error codes are\r
-                        *  used in the ErrorCode parameter value of the \ref USB_InitFailure event.\r
+                        *  used in the ErrorCode parameter value of the \ref EVENT_USB_InitFailure() event.\r
                         */\r
                        enum USB_InitErrorCodes_t\r
                        {\r
                         */\r
                        enum USB_InitErrorCodes_t\r
                        {\r
@@ -301,6 +317,10 @@
                                 *        changed in value.\r
                                 */\r
                                extern volatile uint8_t USB_CurrentMode;\r
                                 *        changed in value.\r
                                 */\r
                                extern volatile uint8_t USB_CurrentMode;\r
+                       #elif defined(USB_HOST_ONLY)\r
+                               #define USB_CurrentMode USB_MODE_HOST\r
+                       #elif defined(USB_DEVICE_ONLY)\r
+                               #define USB_CurrentMode USB_MODE_DEVICE\r
                        #endif\r
                        \r
                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)\r
                        #endif\r
                        \r
                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)\r
@@ -311,26 +331,10 @@
                                 *        changed in value.\r
                                 */\r
                                extern volatile uint8_t USB_Options;\r
                                 *        changed in value.\r
                                 */\r
                                extern volatile uint8_t USB_Options;\r
+                       #elif defined(USE_STATIC_OPTIONS)\r
+                               #define USB_Options USE_STATIC_OPTIONS\r
                        #endif\r
 \r
                        #endif\r
 \r
-               /* Throwable Events: */\r
-                       /** This module raises the \ref USB_Disconnect event if the USB interface is reset (such as during a mode\r
-                        *  change while in UID mode) while the USB interface is connected to a device when in host mode, or\r
-                        *  a host while in device mode.\r
-                        *\r
-                        *  \see Events.h for more information on this event.\r
-                        */\r
-                       RAISES_EVENT(USB_Disconnect);\r
-                       \r
-                       #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)\r
-                               /** This module raises the Power On Failure event when an error occurs while initializing the USB\r
-                                *  interface.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_InitFailure);\r
-                       #endif\r
-                       \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
@@ -338,7 +342,7 @@
                        #define USB_PLL_Off()              MACROS{ PLLCSR   =  0;                           }MACROE\r
                        #define USB_PLL_IsReady()                ((PLLCSR  &   (1 << PLOCK)) ? true : false)\r
 \r
                        #define USB_PLL_Off()              MACROS{ PLLCSR   =  0;                           }MACROE\r
                        #define USB_PLL_IsReady()                ((PLLCSR  &   (1 << PLOCK)) ? true : false)\r
 \r
-                       #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER)               \r
+                       #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r
                                #define USB_REG_On()           MACROS{ UHWCON  |=  (1 << UVREGE);               }MACROE\r
                                #define USB_REG_Off()          MACROS{ UHWCON  &= ~(1 << UVREGE);               }MACROE\r
                        #else\r
                                #define USB_REG_On()           MACROS{ UHWCON  |=  (1 << UVREGE);               }MACROE\r
                                #define USB_REG_Off()          MACROS{ UHWCON  &= ~(1 << UVREGE);               }MACROE\r
                        #else\r
@@ -352,14 +356,14 @@
                        #define USB_CLK_Freeze()           MACROS{ USBCON  |=  (1 << FRZCLK);               }MACROE\r
                        #define USB_CLK_Unfreeze()         MACROS{ USBCON  &= ~(1 << FRZCLK);               }MACROE\r
 \r
                        #define USB_CLK_Freeze()           MACROS{ USBCON  |=  (1 << FRZCLK);               }MACROE\r
                        #define USB_CLK_Unfreeze()         MACROS{ USBCON  &= ~(1 << FRZCLK);               }MACROE\r
 \r
-                       #define USB_Interface_Enable()     MACROS{ USBCON  |=  (1 << USBE);                 }MACROE\r
-                       #define USB_Interface_Disable()    MACROS{ USBCON  &= ~(1 << USBE);                 }MACROE\r
-                       #define USB_Interface_Reset()      MACROS{ uint8_t Temp = USBCON; USBCON = (Temp & ~(1 << USBE)); \\r
+                       #define USB_Controller_Enable()    MACROS{ USBCON  |=  (1 << USBE);                 }MACROE\r
+                       #define USB_Controller_Disable()   MACROS{ USBCON  &= ~(1 << USBE);                 }MACROE\r
+                       #define USB_Controller_Reset()     MACROS{ const uint8_t Temp = USBCON; USBCON = (Temp & ~(1 << USBE)); \\r
                                                                   USBCON = (Temp | (1 << USBE));           }MACROE\r
        \r
                /* Inline Functions: */\r
                        #if defined(USB_CAN_BE_BOTH)\r
                                                                   USBCON = (Temp | (1 << USBE));           }MACROE\r
        \r
                /* Inline Functions: */\r
                        #if defined(USB_CAN_BE_BOTH)\r
-                       static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT;\r
+                       static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
                        static inline uint8_t USB_GetUSBModeFromUID(void)\r
                        {\r
                                if (USBSTA & (1 << ID))\r
                        static inline uint8_t USB_GetUSBModeFromUID(void)\r
                        {\r
                                if (USBSTA & (1 << ID))\r
USB isp AVR programmer