Document the Bluetooth ACL layer. Remove unneeded parameters from the signalling...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / USBInterrupt.h

diff --git a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h
index 65e0b5f..c3f778f 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h
+++ b/LUFA/Drivers/USB/HighLevel/USBInterrupt.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
-\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\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


@@ -29,19 +29,15 @@
 */\r
 \r
 /** \file\r
 */\r
 \r
 /** \file\r

+ *  \brief USB controller interrupt service routine management.\r

  *\r
  *\r

- *  Main USB interrupt vector handler. This file manages the main USB interrupt vector, for handling such\r
- *  events as VBUS interrupts (on supported USB AVR models), device connections and disconnections, etc.\r
- */\r
-\r
-/** \ingroup Group_USB\r
- *  @defgroup Group_USBInterrupt Endpoint and Pipe Interrupts\r
- *\r
- *  Functions, macros, variables, enums and types related to endpoint and pipe interrupts.\r
+ *  This file contains definitions required for the correct handling of low level USB service routine interrupts\r
+ *  from the USB controller.\r

  *\r
  *\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

-\r
+ \r

 #ifndef __USBINTERRUPT_H__\r
 #define __USBINTERRUPT_H__\r
 \r
 #ifndef __USBINTERRUPT_H__\r
 #define __USBINTERRUPT_H__\r
 \r


@@ -59,147 +55,20 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

-       /* Public Interface - May be used in end-application: */\r
+       /* Preprocessor Checks: */\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
+       /* Private Interface - For use in library only: */\r
+       #if !defined(__DOXYGEN__)\r

                /* Macros: */\r
                /* Macros: */\r

-                       /** Vector name for the common endpoint and pipe vector. This can be used to write an ISR handler\r
-                        *  for the endpoint and pipe events, to make certain USB functions interrupt rather than poll\r
-                        *  driven.\r
-                        */\r
-                       #define ENDPOINT_PIPE_vect                       USB_COM_vect\r
-       \r
-                       /** Enables the given USB interrupt vector (such as the ENDPOINT_INT_* and PIPE_INT_* vectors in\r
-                        *  Endpoint.h and Pipe.h).\r
-                        */\r

                        #define USB_INT_Enable(int)              MACROS{ USB_INT_GET_EN_REG(int)   |=   USB_INT_GET_EN_MASK(int);   }MACROE\r
                        #define USB_INT_Enable(int)              MACROS{ USB_INT_GET_EN_REG(int)   |=   USB_INT_GET_EN_MASK(int);   }MACROE\r

-\r
-                       /** Disables the given USB interrupt vector.\r
-                        *\r
-                        *  \see USB_INT_Enable()\r
-                        */\r

                        #define USB_INT_Disable(int)             MACROS{ USB_INT_GET_EN_REG(int)   &= ~(USB_INT_GET_EN_MASK(int));  }MACROE\r
                        #define USB_INT_Disable(int)             MACROS{ USB_INT_GET_EN_REG(int)   &= ~(USB_INT_GET_EN_MASK(int));  }MACROE\r

-\r
-                       /** Resets the given USB interrupt flag, so that the interrupt is re-primed for the next firing. */\r

                        #define USB_INT_Clear(int)               MACROS{ USB_INT_GET_INT_REG(int)  &= ~(USB_INT_GET_INT_MASK(int)); }MACROE\r
                        #define USB_INT_Clear(int)               MACROS{ USB_INT_GET_INT_REG(int)  &= ~(USB_INT_GET_INT_MASK(int)); }MACROE\r

-                       \r
-                       /** Returns boolean false if the given USB interrupt is disabled, or true if the interrupt is currently\r
-                        *  enabled.\r
-                        */\r

                        #define USB_INT_IsEnabled(int)                 ((USB_INT_GET_EN_REG(int)   &    USB_INT_GET_EN_MASK(int)) ? true : false)\r
                        #define USB_INT_IsEnabled(int)                 ((USB_INT_GET_EN_REG(int)   &    USB_INT_GET_EN_MASK(int)) ? true : false)\r

-\r
-                       /** Returns boolean true if the given interrupt flag is set (i.e. the condition for the interrupt has occurred,\r
-                        *  but the interrupt vector is not necessarily enabled), otherwise returns false.\r
-                        */\r

                        #define USB_INT_HasOccurred(int)               ((USB_INT_GET_INT_REG(int)  &    USB_INT_GET_INT_MASK(int)) ? true : false)\r
                        #define USB_INT_HasOccurred(int)               ((USB_INT_GET_INT_REG(int)  &    USB_INT_GET_INT_MASK(int)) ? true : false)\r

-               \r
-               /* Throwable Events: */\r
-                       /** This module raises the USB Connected interrupt when the AVR is attached to a host while in device\r
-                        *  USB mode.\r
-                        *\r
-                        *  \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
-                        *        this means that the current connection state is derived from the bus suspension and wake up events by default,\r
-                        *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
-                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
-                        *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
-                        *        and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
-                        */\r
-                       RAISES_EVENT(USB_Connect);\r
-\r
-                       /** This module raises the USB Disconnected interrupt when the AVR is removed from a host while in\r
-                        *  device USB mode.\r
-                        *\r
-                        *  \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
-                        *        this means that the current connection state is derived from the bus suspension and wake up events by default,\r
-                        *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
-                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
-                        *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
-                        *        and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
-                        */\r
-                       RAISES_EVENT(USB_Disconnect);\r
-\r
-                       #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)\r
-                               /** This module raises the VBUS Change event when the current VBUS status (present or not present) has\r
-                                *  changed.\r
-                                *\r
-                                *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_VBUSChange);\r
-\r
-                               /** This module raises the VBUS Connect event when the VBUS line is powered.\r
-                                *\r
-                                *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_VBUSConnect);\r
-\r
-                               /** This module raises the VBUS Disconnect event when power is removed from the VBUS line.\r
-                                *\r
-                                *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_VBUSDisconnect);\r
-                       #endif\r
-\r
-                       #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)\r
-                               /** This module raises the Suspended event when the host suspends the USB interface of the AVR\r
-                                *  whilst running in device mode.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_Suspend);\r
-\r
-                               /** This module raises the Wake Up event when the host resumes the USB interface of the AVR\r
-                                *  whilst running in device mode.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_WakeUp);\r

 \r
 \r

-                               /** This module raises the USB Reset event when the host resets the USB interface of the AVR\r
-                                *  whilst running in device mode.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_Reset);\r
-                       #endif\r
-                       \r
-                       #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
-                               /** This module raises the Host Error event when the VBUS line voltage dips below the minimum threshold\r
-                                *  while running in host mode.\r
-                                *\r
-                                *  \note Not all USB AVR models support host mode; this event only exists on supported AVRs.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_HostError);\r
-\r
-                               /** This module raises the Device Unattached event when an attached device is removed from the AVR whilst\r
-                                *  running in host mode.\r
-                                *\r
-                                *  \note Not all USB AVR models support host mode; this event only exists on supported AVRs.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_DeviceUnattached);\r
-                       #endif\r
-\r
-                       #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)\r
-                               /** This module raises the UID Change event when the UID line changes in value on dual-role devices.\r
-                                *\r
-                                *  \note Not all USB AVR models support host mode and thus the UID pin; this event only exists on\r
-                                *        supported AVRs.\r
-                                *\r
-                                *  \see Events.h for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_UIDChange);\r
-                       #endif\r
-                       \r
-       /* Private Interface - For use in library only: */\r
-       #if !defined(__DOXYGEN__)\r
-               /* Macros: */\r

                        #define USB_INT_GET_EN_REG(a, b, c, d)           a\r
                        #define USB_INT_GET_EN_MASK(a, b, c, d)          b\r
                        #define USB_INT_GET_INT_REG(a, b, c, d)          c\r
                        #define USB_INT_GET_EN_REG(a, b, c, d)           a\r
                        #define USB_INT_GET_EN_MASK(a, b, c, d)          b\r
                        #define USB_INT_GET_INT_REG(a, b, c, d)          c\r


@@ -218,6 +87,7 @@
                        #define USB_INT_HSOFI                            UHIEN,  (1 << HSOFE)  , UHINT , (1 << HSOFI)\r
                        #define USB_INT_RSTI                             UHIEN , (1 << RSTE)   , UHINT , (1 << RSTI)\r
                        #define USB_INT_SRPI                             OTGIEN, (1 << SRPE)   , OTGINT, (1 << SRPI)\r
                        #define USB_INT_HSOFI                            UHIEN,  (1 << HSOFE)  , UHINT , (1 << HSOFI)\r
                        #define USB_INT_RSTI                             UHIEN , (1 << RSTE)   , UHINT , (1 << RSTI)\r
                        #define USB_INT_SRPI                             OTGIEN, (1 << SRPE)   , OTGINT, (1 << SRPI)\r

+                       #define USB_INT_RXSTPI                           UEIENX, (1 << RXSTPE) , UEINTX, (1 << RXSTPI)\r

        \r
                /* Function Prototypes: */\r
                        void USB_INT_ClearAllInterrupts(void);\r
        \r
                /* Function Prototypes: */\r
                        void USB_INT_ClearAllInterrupts(void);\r


@@ -230,5 +100,3 @@
                #endif\r
 \r
 #endif\r
                #endif\r
 \r
 #endif\r

-\r
-/** @} */\r