InterruptManagement.h 6.25 KB
Newer Older
 Dean Camera committed Jul 15, 2011 1 2 /* LUFA Library  Dean Camera committed Feb 04, 2012 3  Copyright (C) Dean Camera, 2012.  Dean Camera committed Jul 15, 2011 4 5 6 7 8 9  dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /*  Dean Camera committed Feb 04, 2012 10  Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)  Dean Camera committed Jul 15, 2011 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37  Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */ /** \file * \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers. * * Interrupt controller driver for the AVR32 UC3 microcontrollers, for the configuration of interrupt * handlers within the device. */  Dean Camera committed Feb 12, 2012 38 39 /** \ingroup Group_PlatformDrivers_UC3 * \defgroup Group_PlatformDrivers_UC3Interrupts Interrupt Controller Driver - LUFA/Platform/UC3/InterruptManagement.h  Dean Camera committed Jul 15, 2011 40 41 42 43  * \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module:  Dean Camera committed Jun 02, 2012 44 45  * - LUFA/Platform/UC3/InterruptManagement.c (Makefile source module name: LUFA_SRC_PLATFORM) * - LUFA/Platform/UC3/Exception.S (Makefile source module name: LUFA_SRC_PLATFORM)  Dean Camera committed Jul 15, 2011 46 47 48 49 50 51 52 53  * * \section Sec_ModDescription Module Description * Interrupt controller driver for the AVR32 UC3 microcontrollers, for the configuration of interrupt * handlers within the device. * * Usage Example: * \code * #include  Dean Camera committed May 20, 2012 54  *  Dean Camera committed Jul 15, 2011 55 56 57 58  * ISR(USB_Group_IRQ_Handler) * { * // USB group handler code here * }  Dean Camera committed May 20, 2012 59  *  Dean Camera committed Jul 15, 2011 60 61 62 63 64 65 66 67 68 69 70 71 72 73  * void main(void) * { * INTC_Init(); * INTC_RegisterGroupHandler(INTC_IRQ_GROUP(AVR32_USBB_IRQ), AVR32_INTC_INT0, USB_Group_IRQ_Handler); * } * \endcode * * @{ */ #ifndef _UC3_INTERRUPT_MANAGEMENT_H_ #define _UC3_INTERRUPT_MANAGEMENT_H_ /* Includes: */  Dean Camera committed Jul 01, 2012 74  #include "../../Common/Common.h"  Dean Camera committed Jul 15, 2011 75 76 77 78 79 80 81 82 83 84 85 86  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Type Defines: */ typedef void (*InterruptHandlerPtr_t)(void); /* External Variables: */  Dean Camera committed Feb 19, 2012 87 88 89  #if defined(__INCLUDE_FROM_INTMANAGEMENT_C) extern const void EVBA_Table; #endif  Dean Camera committed Jul 15, 2011 90  extern InterruptHandlerPtr_t InterruptHandlers[AVR32_INTC_NUM_INT_GRPS];  Dean Camera committed Feb 19, 2012 91  extern const uint32_t Autovector_Table[];  Dean Camera committed Jul 15, 2011 92 93 94 95  #endif /* Public Interface - May be used in end-application: */ /* Macros: */  Dean Camera committed Jun 09, 2012 96  /** Converts a given interrupt index into its associated interrupt group.  Dean Camera committed Jul 15, 2011 97 98 99 100 101 102 103  * * \param[in] IRQIndex Index of the interrupt request to convert. * * \return Interrupt group number associated with the interrupt index. */ #define INTC_IRQ_GROUP(IRQIndex) (IRQIndex / 32)  Dean Camera committed Jun 09, 2012 104  /** Converts a given interrupt index into its associated interrupt line.  Dean Camera committed Jul 15, 2011 105 106 107 108 109 110 111 112  * * \param[in] IRQIndex Index of the interrupt request to convert. * * \return Interrupt line number associated with the interrupt index. */ #define INTC_IRQ_LINE(IRQIndex) (IRQIndex % 32) /* Function Prototypes: */  Dean Camera committed Jul 22, 2012 113 114  void INTC_Init(void); InterruptHandlerPtr_t INTC_GetInterruptHandler(const uint_reg_t InterruptLevel);  Dean Camera committed Jul 15, 2011 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139  /* Inline Functions: */ /** Registers a handler for a given interrupt group. On the AVR32 UC3 devices, interrupts are grouped by * peripheral. To save on SRAM used, a single ISR handles all interrupt lines within a single group - to * determine the exact line that has interrupted within the group ISR handler, use \ref INTC_GetGroupInterrupts(). * * If multiple interrupts with the same group are registered, the last registered handler will become the * handler called for interrupts raised within that group. * * To obtain the group number of a specific interrupt index, use the \ref INTC_IRQ_GROUP() macro. * * \param[in] GroupNumber Group number of the interrupt group to register a handler for. * \param[in] InterruptLevel Priority level for the specified interrupt, a \c AVR32_INTC_INT* mask. * \param[in] Handler Address of the ISR handler for the interrupt group. */ static inline void INTC_RegisterGroupHandler(const uint16_t GroupNumber, const uint8_t InterruptLevel, const InterruptHandlerPtr_t Handler) ATTR_ALWAYS_INLINE; static inline void INTC_RegisterGroupHandler(const uint16_t GroupNumber, const uint8_t InterruptLevel, const InterruptHandlerPtr_t Handler) { InterruptHandlers[GroupNumber] = Handler; AVR32_INTC.ipr[GroupNumber] = Autovector_Table[InterruptLevel]; }  Dean Camera committed Dec 23, 2011 140   Dean Camera committed Jul 15, 2011 141 142 143 144 145 146 147 148 149 150 151 152 153  /** Retrieves the pending interrupts for a given interrupt group. The result of this function should be masked * against interrupt request indexes converted to a request line number via the \ref INTC_IRQ_LINE() macro. To * obtain the group number of a given interrupt request, use the \ref INTC_IRQ_GROUP() macro. * * \param[in] GroupNumber Group number of the interrupt group to check. * * \return Mask of pending interrupt lines for the given interrupt group. */ static inline uint_reg_t INTC_GetGroupInterrupts(const uint16_t GroupNumber) ATTR_ALWAYS_INLINE; static inline uint_reg_t INTC_GetGroupInterrupts(const uint16_t GroupNumber) { return AVR32_INTC.irr[GroupNumber]; }  Dean Camera committed Dec 23, 2011 154   Dean Camera committed Jul 15, 2011 155 156 157 158 159 160 161 162  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */  Dean Camera committed Dec 23, 2011 163