More UC3B architecture port updates.
authorDean Camera <dean@fourwalledcubicle.com>
Sat, 26 Feb 2011 15:54:11 +0000 (15:54 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Sat, 26 Feb 2011 15:54:11 +0000 (15:54 +0000)
LUFA/Drivers/Board/EVK1101/LEDs.h
LUFA/Drivers/USB/Core/AVR8/Device_AVR8.c
LUFA/Drivers/USB/Core/UC3B/Device_UC3B.c
LUFA/Drivers/USB/Core/UC3B/Device_UC3B.h
LUFA/Drivers/USB/Core/UC3B/Endpoint_UC3B.c
LUFA/Drivers/USB/Core/UC3B/USBController_UC3B.c
LUFA/Drivers/USB/Core/UC3B/USBController_UC3B.h
LUFA/Drivers/USB/Core/UC3B/USBInterrupt_UC3B.c
LUFA/ManPages/CompileTimeTokens.txt
LUFA/ManPages/LUFAPoweredProjects.txt

index 4dae3fb..6ed80be 100644 (file)
                                AVR32_GPIO.port[LEDS_PORT].ovrc  = ActiveMask;\r
                        }\r
                        \r
-                       static inline uintN_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
-                       static inline uintN_t LEDs_GetLEDs(void)\r
+                       static inline uint32_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
+                       static inline uint32_t LEDs_GetLEDs(void)\r
                        {\r
                                return (AVR32_GPIO.port[LEDS_PORT].ovr & LEDS_ALL_LEDS);\r
                        }\r
index 2473327..4bf3393 100644 (file)
@@ -46,7 +46,7 @@ void USB_Device_SendRemoteWakeup(void)
        USB_CLK_Unfreeze();
 
        UDCON |= (1 << RMWKUP);
-       while (!(UDCON & (1 << RMWKUP)));
+       while (UDCON & (1 << RMWKUP));
 }
 
 #endif
index fc6abc8..8ea9bd7 100644 (file)
@@ -45,8 +45,8 @@ void USB_Device_SendRemoteWakeup(void)
 \r
        USB_CLK_Unfreeze();\r
 \r
-       AVR32_USBB.UDCON |= (1 << RMWKUP);\r
-       while (!(AVR32_USBB.UDCON & (1 << RMWKUP)));\r
+       AVR32_USBB.UDCON.rmwakeup = true;\r
+       while (AVR32_USBB.UDCON.rmwakeup);\r
 }\r
 \r
 #endif\r
index d68b6e8..7d48027 100644 (file)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
                #endif\r
 \r
-               #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))\r
-                       #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.\r
-               #endif\r
-\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** \name USB Device Mode Option Masks */\r
                        static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_Device_SetDeviceAddress(const uint8_t Address)\r
                        {\r
-                               AVR32_USBB.UDCON       = (AVR32_USBB_UDCON & ~AVR32_USBB_UDADDR) | Address;\r
+                               AVR32_USBB.udcon       = (AVR32_USBB.udcon & ~AVR32_USBB_UADD_MASK) | Address;\r
                                AVR32_USBB.UDCON.adden = true;\r
                        }\r
 \r
index a212543..05a81f2 100644 (file)
@@ -41,10 +41,10 @@ uint8_t USB_ControlEndpointSize = ENDPOINT_CONTROLEP_DEFAULT_SIZE;
 \r
 uint8_t USB_SelectedEndpoint = ENDPOINT_CONTROLEP;\r
 \r
+\r
 bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,\r
                                     const uint32_t UECFGXData)\r
 {\r
-#if defined(CONTROL_ONLY_DEVICE) || defined(ORDERED_EP_CONFIG)\r
        Endpoint_SelectEndpoint(Number);\r
        Endpoint_EnableEndpoint();\r
 \r
@@ -52,42 +52,6 @@ bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
        *((uint32_t*)AVR32_USBB_UECFG0)[USB_SelectedEndpoint] = UECFGXData;\r
 \r
        return Endpoint_IsConfigured();\r
-#else  \r
-       for (uint8_t EPNum = Number; EPNum < ENDPOINT_TOTAL_ENDPOINTS; EPNum++)\r
-       {\r
-               uint32_t UECFGXTemp;\r
-               uint32_t UEIENXTemp;\r
-\r
-               Endpoint_SelectEndpoint(EPNum);\r
-               \r
-               if (EPNum == Number)\r
-               {\r
-                       UECFGXTemp = UECFGXData;\r
-                       UEIENXTemp = 0;\r
-               }\r
-               else\r
-               {\r
-                       UECFGXTemp = *((uint32_t*)AVR32_USBB_UECFG0)[EPNum];\r
-                       UEIENXTemp = *((uint32_t*)AVR32_USBB_UEINT0)[EPNum];\r
-               }\r
-\r
-               if (!(UECFGXTemp & AVR32_USBB_ALLOC))\r
-                 continue;\r
-\r
-               Endpoint_DisableEndpoint();\r
-               *((uint32_t*)AVR32_USBB_UECFG0)[USB_SelectedEndpoint] &= ~AVR32_USBB_ALLOC;\r
-\r
-               Endpoint_EnableEndpoint();\r
-               *((uint32_t*)AVR32_USBB_UECFG0)[EPNum] = UECFGXTemp;\r
-               *((uint32_t*)AVR32_USBB_UEINT0)[EPNum] = UEINTXTemp;\r
-                       \r
-               if (!(Endpoint_IsConfigured()))\r
-                 return false;                 \r
-       }\r
-       \r
-       Endpoint_SelectEndpoint(Number);\r
-       return true;\r
-#endif\r
 }\r
 \r
 void Endpoint_ClearEndpoints(void)\r
@@ -97,9 +61,7 @@ void Endpoint_ClearEndpoints(void)
        for (uint8_t EPNum = 0; EPNum < ENDPOINT_TOTAL_ENDPOINTS; EPNum++)\r
        {\r
                Endpoint_SelectEndpoint(EPNum);\r
-               UEIENX  = 0;\r
-               UEINTX  = 0;\r
-               UECFG1X = 0;\r
+               *((uint32_t*)AVR32_USBB_UECFG0)[USB_SelectedEndpoint] = 0;\r
                Endpoint_DisableEndpoint();\r
        }\r
 }\r
index 1a80c5b..8e18add 100644 (file)
@@ -60,15 +60,10 @@ void USB_Init(
        USB_Options = Options;\r
        #endif\r
 \r
-       if (!(USB_Options & USB_OPT_REG_DISABLED))\r
-         USB_REG_On();\r
-       else\r
-         USB_REG_Off();\r
-\r
        #if defined(USB_CAN_BE_BOTH)\r
        if (Mode == USB_MODE_UID)\r
        {\r
-               UHWCON |= (1 << UIDE);\r
+               AVR32_USBB.USBCON.uide = true;\r
                USB_INT_Enable(USB_INT_IDTI);\r
                USB_CurrentMode = USB_GetUSBModeFromUID();\r
        }\r
@@ -91,14 +86,7 @@ void USB_Disable(void)
        USB_Detach();\r
        USB_Controller_Disable();\r
 \r
-       if (!(USB_Options & USB_OPT_MANUAL_PLL))\r
-         USB_PLL_Off();\r
-\r
-       USB_REG_Off();\r
-\r
-       #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r
        USB_OTGPAD_Off();\r
-       #endif\r
 \r
        #if defined(USB_CAN_BE_BOTH)\r
        USB_CurrentMode = USB_MODE_None;\r
@@ -118,20 +106,10 @@ void USB_ResetInterface(void)
 \r
        USB_Controller_Reset();\r
 \r
-       if (!(USB_Options & USB_OPT_MANUAL_PLL))\r
-       {\r
-               #if defined(USB_SERIES_4_AVR)\r
-               PLLFRQ = ((1 << PLLUSB) | (1 << PDIV3) | (1 << PDIV1));\r
-               #endif\r
-\r
-               USB_PLL_On();\r
-               while (!(USB_PLL_IsReady()));\r
-       }\r
-\r
        #if defined(USB_CAN_BE_BOTH)\r
        if (UIDModeSelectEnabled)\r
        {\r
-               UHWCON |= (1 << UIDE);\r
+               AVR32_USBB.USBCON.uide = true;\r
                USB_INT_Enable(USB_INT_IDTI);\r
        }\r
        #endif\r
@@ -141,25 +119,19 @@ void USB_ResetInterface(void)
        if (USB_CurrentMode == USB_MODE_Device)\r
        {\r
                #if defined(USB_CAN_BE_DEVICE)\r
-               #if (defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))\r
-               UHWCON |=  (1 << UIMOD);\r
-               #endif\r
-\r
+               AVR32_USBB.USBCON.uimod = true;\r
                USB_Init_Device();\r
                #endif\r
        }\r
        else if (USB_CurrentMode == USB_MODE_Host)\r
        {\r
                #if defined(USB_CAN_BE_HOST)\r
-               UHWCON &= ~(1 << UIMOD);\r
-\r
+               AVR32_USBB.USBCON.uimod = false;\r
                USB_Init_Host();\r
                #endif\r
        }\r
 \r
-       #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))\r
        USB_OTGPAD_On();\r
-       #endif\r
 }\r
 \r
 #if defined(USB_CAN_BE_DEVICE)\r
index 4c90362..f528c6b 100644 (file)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
                #endif\r
 \r
-               #if !defined(F_CLOCK)\r
-                       #error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled USB controller clock in your project makefile.\r
-               #endif\r
-\r
-               #if (F_CLOCK == 8000000)\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
-                       #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
-                       #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
-                       #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
-               #if !defined(USB_PLL_PSC)\r
-                       #error No PLL prescale value available for chosen F_CLOCK value and AVR model.\r
-               #endif\r
-\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
-                       /** \name USB Controller Option Masks */\r
-                       //@{\r
-                       /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad\r
-                        *  regulator should be enabled to regulate the data pin voltages to within the USB standard.\r
-                        *\r
-                        *  \note See USB AVR data sheet for more information on the internal pad regulator.\r
-                        */\r
-                       #define USB_OPT_REG_DISABLED               (1 << 1)\r
-\r
-                       /** Regulator enable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad\r
-                        *  regulator should be disabled and the AVR's VCC level used for the data pads.\r
-                        *\r
-                        *  \note See USB AVR data sheet for more information on the internal pad regulator.\r
-                        */\r
-                       #define USB_OPT_REG_ENABLED                (0 << 1)\r
-\r
-                       /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application\r
-                        *  will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock\r
-                        *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.\r
-                        */\r
-                       #define USB_OPT_MANUAL_PLL                 (1 << 2)\r
-\r
-                       /** Automatic PLL control option mask for \ref USB_Init(). This indicates to the library that the library should\r
-                        *  take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock\r
-                        *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.\r
-                        */\r
-                       #define USB_OPT_AUTO_PLL                   (0 << 2)\r
-                       //@}\r
-                       \r
                        /** \name Endpoint/Pipe Type Masks */\r
                        //@{\r
                        /** Mask for a CONTROL type endpoint or pipe.\r
                        static inline void USB_Detach(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_Detach(void)\r
                        {\r
-                               UDCON  |=  (1 << DETACH);\r
+                               AVR32_USBB.UDCON.detach = true;\r
                        }\r
 \r
                        /** Attaches the device to the USB bus. This announces the device's presence to any attached\r
                        static inline void USB_Attach(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_Attach(void)\r
                        {\r
-                               UDCON  &= ~(1 << DETACH);\r
+                               AVR32_USBB.UDCON.detach = false;\r
                        }\r
 \r
                /* Function Prototypes: */\r
                        #endif\r
 \r
                /* Inline Functions: */\r
-                       static inline void USB_PLL_On(void) ATTR_ALWAYS_INLINE;\r
-                       static inline void USB_PLL_On(void)\r
-                       {\r
-                               PLLCSR  = USB_PLL_PSC;\r
-                               PLLCSR |= (1 << PLLE);\r
-                       }\r
-\r
-                       static inline void USB_PLL_Off(void) ATTR_ALWAYS_INLINE;\r
-                       static inline void USB_PLL_Off(void)\r
-                       {\r
-                               PLLCSR  = 0;\r
-                       }\r
-\r
-                       static inline bool USB_PLL_IsReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
-                       static inline bool USB_PLL_IsReady(void)\r
-                       {\r
-                               return ((PLLCSR  &   (1 << PLOCK)) ? true : false);\r
-                       }\r
-\r
-                       static inline void USB_REG_On(void) ATTR_ALWAYS_INLINE;\r
-                       static inline void USB_REG_On(void)\r
-                       {\r
-                       #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r
-                               UHWCON  |=  (1 << UVREGE);\r
-                       #else\r
-                               REGCR   &= ~(1 << REGDIS);\r
-                       #endif\r
-                       }\r
-\r
-                       static inline void USB_REG_Off(void) ATTR_ALWAYS_INLINE;\r
-                       static inline void USB_REG_Off(void)\r
-                       {\r
-                       #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r
-                               UHWCON  &= ~(1 << UVREGE);\r
-                       #else\r
-                               REGCR   |=  (1 << REGDIS);\r
-                       #endif\r
-                       }\r
-\r
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r
                        static inline void USB_OTGPAD_On(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_OTGPAD_On(void)\r
                        {\r
-                               USBCON  |=  (1 << OTGPADE);\r
+                               AVR32_USBB.USBCON.otgpade = true;\r
                        }\r
 \r
                        static inline void USB_OTGPAD_Off(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_OTGPAD_Off(void)\r
                        {\r
-                               USBCON  &= ~(1 << OTGPADE);\r
+                               AVR32_USBB.USBCON.otgpade = false;\r
                        }\r
                        #endif\r
 \r
                        static inline void USB_CLK_Freeze(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_CLK_Freeze(void)\r
                        {\r
-                               USBCON  |=  (1 << FRZCLK);\r
+                               AVR32_USBB.USBCON.frzclk = true;\r
                        }\r
 \r
                        static inline void USB_CLK_Unfreeze(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_CLK_Unfreeze(void)\r
                        {\r
-                               USBCON  &= ~(1 << FRZCLK);\r
+                               AVR32_USBB.USBCON.frzclk = false;\r
                        }\r
 \r
                        static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_Controller_Enable(void)\r
                        {\r
-                               USBCON  |=  (1 << USBE);\r
+                               AVR32_USBB.USBCON.usbe = true;\r
                        }\r
 \r
                        static inline void USB_Controller_Disable(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_Controller_Disable(void)\r
                        {\r
-                               USBCON  &= ~(1 << USBE);\r
+                               AVR32_USBB.USBCON.usbe = false;\r
                        }\r
 \r
                        static inline void USB_Controller_Reset(void) ATTR_ALWAYS_INLINE;\r
                        static inline void USB_Controller_Reset(void)\r
                        {\r
-                               const uint8_t Temp = USBCON;\r
-\r
-                               USBCON = (Temp & ~(1 << USBE));\r
-                               USBCON = (Temp |  (1 << USBE));\r
+                               AVR32_USBB.USBCON.usbe = false;\r
+                               AVR32_USBB.USBCON.usbe = true;\r
                        }\r
 \r
                        #if defined(USB_CAN_BE_BOTH)\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
+                               if (AVR32_USBB.USBSTA.id)\r
                                  return USB_MODE_Device;\r
                                else\r
                                  return USB_MODE_Host;\r
index a079e4c..9324acf 100644 (file)
@@ -164,10 +164,6 @@ ISR(USB_GEN_vect, ISR_BLOCK)
                                           ENDPOINT_DIR_OUT, USB_ControlEndpointSize,\r
                                           ENDPOINT_BANK_SINGLE);\r
 \r
-               #if defined(INTERRUPT_CONTROL_ENDPOINT)\r
-               USB_INT_Enable(USB_INT_RXSTPI);\r
-               #endif\r
-\r
                EVENT_USB_Device_Reset();\r
        }\r
        #endif\r
@@ -247,23 +243,3 @@ ISR(USB_GEN_vect, ISR_BLOCK)
        }\r
        #endif\r
 }\r
-\r
-#if defined(INTERRUPT_CONTROL_ENDPOINT) && defined(USB_CAN_BE_DEVICE)\r
-ISR(USB_COM_vect, ISR_BLOCK)\r
-{\r
-       uint8_t PrevSelectedEndpoint = Endpoint_GetCurrentEndpoint();\r
-\r
-       Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);\r
-       USB_INT_Disable(USB_INT_RXSTPI);\r
-\r
-       NONATOMIC_BLOCK(NONATOMIC_FORCEOFF)\r
-       {\r
-               USB_Device_ProcessControlRequest();\r
-       }\r
-\r
-       Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);\r
-       USB_INT_Enable(USB_INT_RXSTPI);\r
-       Endpoint_SelectEndpoint(PrevSelectedEndpoint);\r
-}\r
-#endif\r
-\r
index f215ffe..9dfa805 100644 (file)
@@ -14,7 +14,7 @@
  *  \section Sec_SummaryNonUSBTokens Non USB Related Tokens
  *  This section describes compile tokens which affect non-USB sections of the LUFA library.
  *
- *  <b>DISABLE_TERMINAL_CODES</b> - ( \ref Group_Terminal ) \n
+ *  <b>DISABLE_TERMINAL_CODES</b> - (\ref Group_Terminal) - <i>All Architectures</i> \n
  *  If an application contains ANSI terminal control codes listed in TerminalCodes.h, it might be desired to remove them
  *  at compile time for use with a terminal which is non-ANSI control code aware, without modifying the source code. If
  *  this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from
  *  \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens
  *  This section describes compile tokens which affect USB class-specific drivers in the LUFA library.
  *
- *  <b>HID_HOST_BOOT_PROTOCOL_ONLY</b> - ( \ref Group_USBClassHIDHost ) \n
+ *  <b>HID_HOST_BOOT_PROTOCOL_ONLY</b> - (\ref Group_USBClassHIDHost) - <i>All Architectures</i> \n
  *  By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID
  *  communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic
  *  Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol
  *  mode can be removed to save space in the compiled application by defining this token. When defined, it is still necessary
  *  to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol().
  *
- *  <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - ( \ref Group_HIDParser ) \n
+ *  <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n
+ *  <i>Supported Architectures:</i> All \n
  *  HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This
  *  allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous
  *  state table in a compact manner. This token may be defined to a non-zero 8-bit value to give the maximum depth of the state
  *  table stack. If not defined, this defaults to the value indicated in the HID.h file documentation.
  *
- *  <b>HID_USAGE_STACK_DEPTH</b>=<i>x</i> - ( \ref Group_HIDParser ) \n
+ *  <b>HID_USAGE_STACK_DEPTH</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n
  *  HID reports generally contain many USAGE elements, which are assigned to INPUT, OUTPUT and FEATURE items in succession
  *  when multiple items are defined at once (via REPORT COUNT elements). This allows for several items to be defined with
  *  different usages in a compact manner. This token may be defined to a non-zero 8-bit value to set the maximum depth of the
  *  usage stack, indicating the maximum number of USAGE items which can be stored temporarily until the next INPUT, OUTPUT
  *  and FEATURE item. If not defined, this defaults to the value indicated in the HID.h file documentation.
  *
- *  <b>HID_MAX_COLLECTIONS</b>=<i>x</i> - ( \ref Group_HIDParser ) \n
+ *  <b>HID_MAX_COLLECTIONS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n
  *  HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information
  *  is stored separately in the processed usage structure (and referred to by the data elements in the structure) to save space.
  *  This token may be defined to a non-zero 8-bit value to set the maximum number of COLLECTION items which can be processed by the
  *  parser into the resultant processed report structure. If not defined, this defaults to the value indicated in the HID.h file
  *  documentation.
  *
- *  <b>HID_MAX_REPORTITEMS</b>=<i>x</i> - ( \ref Group_HIDParser ) \n
+ *  <b>HID_MAX_REPORTITEMS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n
  *  All HID reports contain one or more INPUT, OUTPUT and/or FEATURE items describing the data which can be sent to and from the HID
  *  device. Each item has associated usages, bit offsets in the item reports and other associated data indicating the manner in which
  *  the report data should be interpreted by the host. This token may be defined to a non-zero 8-bit value to set the maximum number of
@@ -59,7 +60,7 @@
  *  If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed separately in the
  *  processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.
  *
- *  <b>HID_MAX_REPORT_IDS</b>=<i>x</i> - ( \ref Group_HIDParser ) \n
+ *  <b>HID_MAX_REPORT_IDS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n
  *  HID reports may contain several report IDs, to logically distinguish grouped device data from one another - for example, a combination
  *  keyboard and mouse might use report IDs to separate the keyboard reports from the mouse reports. In order to determine the size of each
  *  report, and thus know how many bytes must be read or written, the size of each report (IN, OUT and FEATURE) must be calculated and
@@ -67,7 +68,7 @@
  *  and their sizes calculated/stored into the resultant processed report structure. If not defined, this defaults to the value indicated in
  *  the HID.h file documentation.
  *
- *  <b>NO_CLASS_DRIVER_AUTOFLUSH</b>
+ *  <b>NO_CLASS_DRIVER_AUTOFLUSH</b> - (\ref Group_USBClassDrivers) - <i>All Architectures</i> \n
  *  Many of the device and host mode class drivers automatically flush any data waiting to be written to an interface, when the corresponding
  *  USB management task is executed. This is usually desirable to ensure that any queued data is sent as soon as possible once and new data is
  *  constructed in the main program loop. However, if flushing is to be controlled manually by the user application via the *_Flush() commands,
  *  \section Sec_SummaryUSBTokens General USB Driver Related Tokens
  *  This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.
  *
- *  <b>ORDERED_EP_CONFIG</b> - ( \ref Group_EndpointManagement , \ref Group_PipeManagement )\n
+ *  <b>ORDERED_EP_CONFIG</b> - (\ref Group_EndpointManagement , \ref Group_PipeManagement)  - <i>AVR8 Only</i> \n
  *  The USB AVRs do not allow for Endpoints and Pipes to be configured out of order; they <i>must</i> be configured in an ascending order to
  *  prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialisation. This compile
  *  time token may be used to restrict the intialisation order to ascending indexes only in exchange for a smaller compiled binary size.
  *
- *  <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
+ *  <b>USE_STATIC_OPTIONS</b>=<i>x</i> - (\ref Group_USBManagement) - <i>All Architectures</i> \n
  *  By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad
  *  voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options
  *  mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing
  *  the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an
  *  Options parameter.
  *
- *  <b>USB_DEVICE_ONLY</b> - ( \ref Group_USBManagement ) \n
+ *  <b>USB_DEVICE_ONLY</b> - (\ref Group_USBManagement) - <i>All Architectures</i> \n
  *  For the USB AVR models supporting both device and host USB modes, the USB_Init() function contains a Mode parameter which specifies the
  *  mode the library should be initialized to. If only device mode is required, the code for USB host mode can be removed from the binary to
  *  save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevant on smaller USB AVRs which
  *  do not support host mode.
  *
- *  <b>USB_HOST_ONLY</b> - ( \ref Group_USBManagement ) \n
+ *  <b>USB_HOST_ONLY</b> - (\ref Group_USBManagement) - <i>All Architectures</i> \n
  *  Same as USB_DEVICE_ONLY, except the library is fixed to USB host mode rather than USB device mode. Not available on some USB AVR models.
  *
- *  <b>USB_STREAM_TIMEOUT_MS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
+ *  <b>USB_STREAM_TIMEOUT_MS</b>=<i>x</i> - (\ref Group_USBManagement) - <i>All Architectures</i> \n
  *  When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host
  *  must satisfy, or the stream function aborts the remaining data transfer. This token may be defined to a non-zero 16-bit value to set the timeout
  *  period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead.
  *
- *  <b>NO_LIMITED_CONTROLLER_CONNECT</b> - ( \ref Group_Events ) \n
+ *  <b>NO_LIMITED_CONTROLLER_CONNECT</b> - (\ref Group_Events) - <i>AVR8 Only</i> \n
  *  On the smaller USB AVRs, the USB controller lacks VBUS events to determine the physical connection state of the USB bus to a host. In lieu of
  *  VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be
  *  slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is
  *  can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the RAISE_EVENT macro.
  *  When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
  *
- *  <b>NO_SOF_EVENTS</b> - ( \ref Group_Events ) \n
+ *  <b>NO_SOF_EVENTS</b> - (\ref Group_Events) - <i>All Architectures</i> \n
  *  By default, there exists a LUFA application event for the start of each USB frame while the USB bus is not suspended in either host or device mode.
  *  This event can be selectively enabled or disabled by calling the appropriate device or host mode function. When this compile time token is defined,
  *  the ability to receive USB Start of Frame events via the \ref EVENT_USB_Device_StartOfFrame() or \ref EVENT_USB_Host_StartOfFrame() events is removed,
  *  \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens
  *  This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode.
  *
- *  <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
+ *  <b>USE_RAM_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n
  *  Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one
  *  of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime.
  *
- *  <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
+ *  <b>USE_FLASH_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n
  *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM.
  *
- *  <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
+ *  <b>USE_EEPROM_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n
  *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.
  *
- *  <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_StdDescriptors ) \n
- *  Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This
- *  allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing
- *  allocated resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the
- *  code that performs this task can be disabled by defining this option and passing it to the compiler via the -D switch.
+ *  <b>NO_INTERNAL_SERIAL</b> - (\ref Group_StdDescriptors) - <i>All Architectures</i> \n
+ *  Some AVR models contain a unique serial number which can be used as the device serial number, while in device mode. This allows
+ *  the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing allocated
+ *  resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the code that
+ *  performs this task can be disabled by defining this option and passing it to the compiler via the -D switch.
  *
- *  <b>FIXED_CONTROL_ENDPOINT_SIZE</b>=<i>x</i> - ( \ref Group_EndpointManagement ) \n
+ *  <b>FIXED_CONTROL_ENDPOINT_SIZE</b>=<i>x</i> - (\ref Group_EndpointManagement) - <i>All Architectures</i> \n
  *  By default, the library determines the size of the control endpoint (when in device mode) by reading the device descriptor.
  *  Normally this reduces the amount of configuration required for the library, allows the value to change dynamically (if
  *  descriptors are stored in EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this token can be
  *  defined to a non-zero value instead to give the size in bytes of the control endpoint, to reduce the size of the compiled
  *  binary.
  *
- *  <b>DEVICE_STATE_AS_GPIOR</b> - ( \ref Group_Device ) \n
+ *  <b>DEVICE_STATE_AS_GPIOR</b> - (\ref Group_Device) - <i>AVR8 Only</i> \n
  *  One of the most frequently used global variables in the stack is the USB_DeviceState global, which indicates the current state of
  *  the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
  *  may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
  *  implicitly via the library APIs.
  *
- *  <b>FIXED_NUM_CONFIGURATIONS</b>=<i>x</i> - ( \ref Group_Device ) \n
+ *  <b>FIXED_NUM_CONFIGURATIONS</b>=<i>x</i> - (\ref Group_Device) - <i>All Architectures</i> \n
  *  By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces
  *  the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in
  *  EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this value may be fixed via this token in the project
  *  makefile to reduce the compiled size of the binary at the expense of flexibility.
  *
- *  <b>CONTROL_ONLY_DEVICE</b> \n
+ *  <b>CONTROL_ONLY_DEVICE</b> - (\ref Group_Device) - <i>All Architectures</i> \n
  *  In some limited USB device applications, there are no device endpoints other than the control endpoint; i.e. all device communication
  *  is through control endpoint requests. Defining this token will remove several features related to the selection and control of device
  *  endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided.
  *
- *  <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \ref Group_USBManagement ) \n
+ *  <b>INTERRUPT_CONTROL_ENDPOINT</b> - (\ref Group_USBManagement) - <i>AVR8 Only</i> \n
  *  Some applications prefer to not call the USB_USBTask() management task regularly while in device mode, as it can complicate code significantly.
  *  Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control
  *  endpoint entirely via USB controller interrupts asynchronously to the user application. When defined, USB_USBTask() does not need to be called
  *  when in USB device mode.
  *
- *  <b>NO_DEVICE_REMOTE_WAKEUP</b> - (\ref Group_Device ) \n
+ *  <b>NO_DEVICE_REMOTE_WAKEUP</b> - (\ref Group_Device) - <i>All Architectures</i> \n
  *  Many devices do not require the use of the Remote Wakeup features of USB, used to wake up the USB host when suspended. On these devices,
  *  the code required to manage device Remote Wakeup can be disabled by defining this token and passing it to the library via the -D switch.
  *
- *  <b>NO_DEVICE_SELF_POWER</b> - (\ref Group_Device ) \n
+ *  <b>NO_DEVICE_SELF_POWER</b> - (\ref Group_Device) - <i>All Architectures</i> \n
  *  USB devices may be bus powered, self powered, or a combination of both. When a device can be both bus powered and self powered, the host may
  *  query the device to determine the current power source, via \ref USB_CurrentlySelfPowered. For solely bus powered devices, this global and the
  *  code required to manage it may be disabled by passing this token to the library via the -D switch.
  *
  *  This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode.
  *
- *  <b>HOST_STATE_AS_GPIOR</b> - ( \ref Group_Host ) \n
+ *  <b>HOST_STATE_AS_GPIOR</b> - (\ref Group_Host) - <i>AVR8 Only</i> \n
  *  One of the most frequently used global variables in the stack is the USB_HostState global, which indicates the current state of
  *  the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
  *  may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
  *  implicitly via the library APIs.
  *
- *  <b>USB_HOST_TIMEOUT_MS</b>=<i>x</i> - ( \ref Group_Host ) \n
+ *  <b>USB_HOST_TIMEOUT_MS</b>=<i>x</i> - (\ref Group_Host) - <i>All Architectures</i> \n
  *  When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached
  *  device fails to respond within the timeout period. This token may be defined to a non-zero 16-bit value to set the timeout period for
  *  control transfers, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.
  *
- *  <b>HOST_DEVICE_SETTLE_DELAY_MS</b>=<i>x</i> - ( \ref Group_Host ) \n
+ *  <b>HOST_DEVICE_SETTLE_DELAY_MS</b>=<i>x</i> - (\ref Group_Host) - <i>All Architectures</i> \n
  *  Some devices require a delay of up to 5 seconds after they are connected to VBUS before the enumeration process can be started, or
  *  they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled
  *  back to a known idle state before communications occur with the device. This token may be defined to a 16-bit value to set the device
index 4dc51d0..b894df2 100644 (file)
@@ -70,6 +70,7 @@
  *  - Reprap with LUFA, a LUFA powered 3D printer: http://code.google.com/p/at90usb1287-code-for-arduino-and-eclipse/
  *  - SD Card reader: http://elasticsheep.com/2010/04/teensy2-usb-mass-storage-with-an-sd-card/
  *  - SEGA Megadrive/Genesis Development Cartridge: http://www.makestuff.eu/wordpress/?page_id=398
+ *  - Serial Line bus analyser: http://www.pjrc.com/teensy/projects/SerialAnalyzer.html
  *  - Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/
  *  - Teensy SD Card .WAV file player: http://elasticsheep.com/2010/04/teensy2-usb-wav-player-part-1/
  *  - Touchscreen Input Device: http://capnstech.blogspot.com/2010/07/touchscreen-update.html