projects / pub / lufa.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Enhance and document the AVR32 UC3 platform drivers.
[pub/lufa.git] / LUFA / Platform / UC3 / InterruptManagement.h
diff --git a/LUFA/Platform/UC3/InterruptManagement.h b/LUFA/Platform/UC3/InterruptManagement.h
index fec099d..bcceab7 100644 (file)
--- a/LUFA/Platform/UC3/InterruptManagement.h
+++ b/LUFA/Platform/UC3/InterruptManagement.h
@@ -28,8 +28,47 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r
-#ifndef _INTERRUPT_MANAGEMENT_H_\r
-#define _INTERRUPT_MANAGEMENT_H_\r
+/** \file\r
+ *  \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers.\r
+ *\r
+ *  Interrupt controller driver for the AVR32 UC3 microcontrollers, for the configuration of interrupt\r
+ *  handlers within the device.\r
+ */\r
+\r
+/** \ingroup Group_PlatformDrivers\r
+ *  \defgroup Group_PlatformDrivers_UC3Interrupts UC3 Interrupt Controller Driver - LUFA/Platform/UC3/InterruptManagement.h\r
+ *  \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers.\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Platform/UC3/InterruptManagement.c\r
+ *    - LUFA/Platform/UC3/Exception.S\r
+ *\r
+ *  \section Sec_ModDescription Module Description\r
+ *  Interrupt controller driver for the AVR32 UC3 microcontrollers, for the configuration of interrupt\r
+ *  handlers within the device.\r
+ *\r
+ *  Usage Example:\r
+ *  \code\r
+ *             #include <LUFA/Platform/UC3/InterruptManagement.h>\r
+ *\r
+ *             ISR(USB_Group_IRQ_Handler)\r
+ *             {\r
+ *                     // USB group handler code here\r
+ *             }\r
+ *\r
+ *             void main(void)\r
+ *             {\r
+ *                     INTC_Init();\r
+ *                     INTC_RegisterGroupHandler(INTC_IRQ_GROUP(AVR32_USBB_IRQ), AVR32_INTC_INT0, USB_Group_IRQ_Handler);\r
+ *             }\r
+ *  \endcode\r
+ *\r
+ *  @{\r
+ */\r
+\r
+#ifndef _UC3_INTERRUPT_MANAGEMENT_H_\r
+#define _UC3_INTERRUPT_MANAGEMENT_H_\r
 \r
        /* Includes: */\r
                #include <avr32/io.h>\r
 \r
        /* Includes: */\r
                #include <avr32/io.h>\r
@@ -38,46 +77,91 @@
 \r
                #include <LUFA/Common/Common.h>\r
 \r
 \r
                #include <LUFA/Common/Common.h>\r
 \r
-       /* Macros: */\r
-               #if !defined(ISR)\r
-                       #define ISR(Name)                 void Name (void) __attribute__((__interrupt__)); void Name (void)\r
+       /* Enable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       extern "C" {\r
+               #endif\r
+\r
+       /* Private Interface - For use in library only: */\r
+       #if !defined(__DOXYGEN__)\r
+               /* External Variables: */\r
+                       extern const void            EVBA_Table;\r
+                       extern const uint32_t        Autovector_Table[];\r
+                       extern InterruptHandlerPtr_t InterruptHandlers[AVR32_INTC_NUM_INT_GRPS];\r
+       #endif\r
+\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Macros: */\r
+                       /** Converts a given interrupt index into its assocated interrupt group.\r
+                        *\r
+                        *  \param[in] IRQIndex  Index of the interrupt request to convert.\r
+                        *\r
+                        *  \return Interrupt group number associated with the interrupt index.\r
+                        */\r
+                       #define INTC_IRQ_GROUP(IRQIndex)  (IRQIndex / 32)\r
+\r
+                       /** Converts a given interrupt index into its assocated interrupt line.\r
+                        *\r
+                        *  \param[in] IRQIndex  Index of the interrupt request to convert.\r
+                        *\r
+                        *  \return Interrupt line number associated with the interrupt index.\r
+                        */\r
+                       #define INTC_IRQ_LINE(IRQIndex)   (IRQIndex % 32)\r
+\r
+               /* Type Defines: */\r
+                       /** Type define for an interrupt handler ISR function. */\r
+                       typedef void (*InterruptHandlerPtr_t)(void);\r
+\r
+               /* Function Prototypes: */\r
+                       /** Initializes the interrupt controller, nulling out all interrupt handlers ready for new registration. This\r
+                        *  function should be called once on startup to ensure the interrupt controller is ready for use.\r
+                        */\r
+                       void INTC_Init(void);\r
+\r
+               /* Inline Functions: */\r
+                       /** Registers a handler for a given interrupt group. On the AVR32 UC3 devices, interrupts are grouped by\r
+                        *  peripheral. To save on SRAM used, a single ISR handles all interrupt lines within a single group - to\r
+                        *  determine the exact line that has interrupted within the group ISR handler, use \ref INTC_GetGroupInterrupts().\r
+                        *\r
+                        *  If multiple interrupts with the same group are registered, the last registered handler will become the\r
+                        *  handler called for interrupts raised within that group.\r
+                        *\r
+                        *  To obtain the group number of a specific interrupt index, use the \ref INTC_IRQ_GROUP() macro.\r
+                        *\r
+                        *  \param[in] GroupNumber       Group number of the interrupt group to register a handler for.\r
+                        *  \param[in] InterruptLevel    Priority level for the specified interrupt, a \c AVR32_INTC_INT* mask.\r
+                        *  \param[in] Handler           Address of the ISR handler for the interrupt group.\r
+                        */\r
+                       static inline void INTC_RegisterGroupHandler(const uint16_t GroupNumber,\r
+                                                                    const uint8_t InterruptLevel,\r
+                                                                    const InterruptHandlerPtr_t Handler) ATTR_ALWAYS_INLINE;\r
+                       static inline void INTC_RegisterGroupHandler(const uint16_t GroupNumber,\r
+                                                                    const uint8_t InterruptLevel,\r
+                                                                    const InterruptHandlerPtr_t Handler)\r
+                       {\r
+                               InterruptHandlers[GroupNumber] = Handler;\r
+                               AVR32_INTC.ipr[GroupNumber]    = Autovector_Table[InterruptLevel];\r
+                       }\r
+                       \r
+                       /** Retrieves the pending interrupts for a given interrupt group. The result of this function should be masked\r
+                        *  against interrupt request indexes converted to a request line number via the \ref INTC_IRQ_LINE() macro. To\r
+                        *  obtain the group number of a given interrupt request, use the \ref INTC_IRQ_GROUP() macro.\r
+                        *\r
+                        *  \param[in] GroupNumber Group number of the interrupt group to check.\r
+                        *\r
+                        *  \return Mask of pending interrupt lines for the given interrupt group.\r
+                        */\r
+                       static inline uint_reg_t INTC_GetGroupInterrupts(const uint16_t GroupNumber) ATTR_ALWAYS_INLINE;\r
+                       static inline uint_reg_t INTC_GetGroupInterrupts(const uint16_t GroupNumber)\r
+                       {\r
+                               return AVR32_INTC.irr[GroupNumber];\r
+                       }\r
+       \r
+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
                #endif\r
                #endif\r
-               \r
-               #define INTC_EnableInterrupts()   do { GCC_MEMORY_BARRIER(); __builtin_csrf(AVR32_SR_GM_OFFSET); } while (0)\r
-               #define INTC_DisableInterrupts()  do { __builtin_ssrf(AVR32_SR_GM_OFFSET); GCC_MEMORY_BARRIER(); } while (0)\r
-\r
-       /* Type Defines: */\r
-               typedef void (*InterruptHandlerPtr_t)(void);\r
-\r
-       /* External Variables: */\r
-               extern const void            EVBA_Table;\r
-               extern const uint32_t        Autovector_Table[];\r
-               extern InterruptHandlerPtr_t InterruptHandlers[AVR32_INTC_NUM_INT_GRPS];\r
-\r
-       /* Function Prototypes: */\r
-               void INTC_Init(void);\r
-\r
-       /* Inline Functions: */\r
-               /** Registers a handler for a given interrupt group. On the AVR32 UC3 devices, interrupts are grouped by\r
-                *  peripheral. To save on SRAM used, a single ISR handles all interrupt lines within a single group - to\r
-                *  determine the exact line that has interrupted within the group ISR handler, examine the module's interrupt\r
-                *  flag register bits.\r
-                *\r
-                *  If multiple interrupts with the same group are registered, the last registered handler will become the\r
-                *  handler called for interrupts raised within that group.\r
-                *\r
-                *  \param[in] InterruptRequest  Interrupt request index for the given interrupt, a AVR32_*_IRQ mask.\r
-                *  \param[in] InterruptLevel    Priority level for the specified interrupt, a AVR32_INTC_INT* mask.\r
-                *  \param[in] Handler           Address of the ISR handler for the interrupt group.\r
-                */\r
-               static inline void INTC_RegisterGroupHandler(const uint16_t InterruptRequest,\r
-                                                                                                    const uint8_t  InterruptLevel,\r
-                                                                                                    const InterruptHandlerPtr_t Handler)\r
-               {\r
-                       uint8_t InterruptGroup = (InterruptRequest >> 5);\r
-\r
-                       InterruptHandlers[InterruptGroup] = Handler;\r
-                       AVR32_INTC.ipr[InterruptGroup]    = Autovector_Table[InterruptLevel];\r
-               }\r
 \r
 #endif\r
 \r
 #endif\r
+\r
+/** @} */\r
Lightweight USB Framework for AVRs