git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M4F_ATSAM4E_Atmel_Studio/src/ASF/common/utils/interrupt/interrupt_sam_nvic.h

   1 /**\r
   2  * \file\r
   3  *\r
   4  * \brief Global interrupt management for SAM D20, SAM3 and SAM4 (NVIC based)\r
   5  *\r
   6  * Copyright (c) 2012-2013 Atmel Corporation. All rights reserved.\r
   7  *\r
   8  * \asf_license_start\r
   9  *\r
  10  * \page License\r
  11  *\r
  12  * Redistribution and use in source and binary forms, with or without\r
  13  * modification, are permitted provided that the following conditions are met:\r
  14  *\r
  15  * 1. Redistributions of source code must retain the above copyright notice,\r
  16  *    this list of conditions and the following disclaimer.\r
  17  *\r
  18  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  19  *    this list of conditions and the following disclaimer in the documentation\r
  20  *    and/or other materials provided with the distribution.\r
  21  *\r
  22  * 3. The name of Atmel may not be used to endorse or promote products derived\r
  23  *    from this software without specific prior written permission.\r
  24  *\r
  25  * 4. This software may only be redistributed and used in connection with an\r
  26  *    Atmel microcontroller product.\r
  27  *\r
  28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED\r
  29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR\r
  32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r
  36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\r
  37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  38  * POSSIBILITY OF SUCH DAMAGE.\r
  39  *\r
  40  * \asf_license_stop\r
  41  *\r
  42  */\r
  43 \r
  44 #ifndef UTILS_INTERRUPT_INTERRUPT_H\r
  45 #define UTILS_INTERRUPT_INTERRUPT_H\r
  46 \r
  47 #include <compiler.h>\r
  48 #include <parts.h>\r
  49 \r
  50 /**\r
  51  * \weakgroup interrupt_group\r
  52  *\r
  53  * @{\r
  54  */\r
  55 \r
  56 /**\r
  57  * \name Interrupt Service Routine definition\r
  58  *\r
  59  * @{\r
  60  */\r
  61 \r
  62 /**\r
  63  * \brief Define service routine\r
  64  *\r
  65  * \note For NVIC devices the interrupt service routines are predefined to\r
  66  *       add to vector table in binary generation, so there is no service\r
  67  *       register at run time. The routine collections are in exceptions.h.\r
  68  *\r
  69  * Usage:\r
  70  * \code\r
  71  * ISR(foo_irq_handler)\r
  72  * {\r
  73  *      // Function definition\r
  74  *      ...\r
  75  * }\r
  76  * \endcode\r
  77  *\r
  78  * \param func Name for the function.\r
  79  */\r
  80 #  define ISR(func)   \\r
  81         void func (void)\r
  82 \r
  83 /**\r
  84  * \brief Initialize interrupt vectors\r
  85  *\r
  86  * For NVIC the interrupt vectors are put in vector table. So nothing\r
  87  * to do to initialize them, except defined the vector function with\r
  88  * right name.\r
  89  *\r
  90  * This must be called prior to \ref irq_register_handler.\r
  91  */\r
  92 #  define irq_initialize_vectors()   \\r
  93         do {                             \\r
  94         } while(0)\r
  95 \r
  96 /**\r
  97  * \brief Register handler for interrupt\r
  98  *\r
  99  * For NVIC the interrupt vectors are put in vector table. So nothing\r
 100  * to do to register them, except defined the vector function with\r
 101  * right name.\r
 102  *\r
 103  * Usage:\r
 104  * \code\r
 105  * irq_initialize_vectors();\r
 106  * irq_register_handler(foo_irq_handler);\r
 107  * \endcode\r
 108  *\r
 109  * \note The function \a func must be defined with the \ref ISR macro.\r
 110  * \note The functions prototypes can be found in the device exception header\r
 111  *       files (exceptions.h).\r
 112  */\r
 113 #  define irq_register_handler(int_num, int_prio)                      \\r
 114         NVIC_ClearPendingIRQ(    (IRQn_Type)int_num);                      \\r
 115         NVIC_SetPriority(    (IRQn_Type)int_num, int_prio);                \\r
 116         NVIC_EnableIRQ(      (IRQn_Type)int_num);                          \\r
 117 \r
 118 //@}\r
 119 \r
 120 #  define cpu_irq_enable()                     \\r
 121         do {                                       \\r
 122                 g_interrupt_enabled = true;            \\r
 123                 __DMB();                               \\r
 124                 __enable_irq();                        \\r
 125         } while (0)\r
 126 #  define cpu_irq_disable()                    \\r
 127         do {                                       \\r
 128                 __disable_irq();                       \\r
 129                 __DMB();                               \\r
 130                 g_interrupt_enabled = false;           \\r
 131         } while (0)\r
 132 \r
 133 typedef uint32_t irqflags_t;\r
 134 \r
 135 #if !defined(__DOXYGEN__)\r
 136 extern volatile bool g_interrupt_enabled;\r
 137 #endif\r
 138 \r
 139 #define cpu_irq_is_enabled()    (__get_PRIMASK() == 0)\r
 140 \r
 141 static volatile uint32_t cpu_irq_critical_section_counter;\r
 142 static volatile bool     cpu_irq_prev_interrupt_state;\r
 143 \r
 144 static inline irqflags_t cpu_irq_save(void)\r
 145 {\r
 146         irqflags_t flags = cpu_irq_is_enabled();\r
 147         cpu_irq_disable();\r
 148         return flags;\r
 149 }\r
 150 \r
 151 static inline bool cpu_irq_is_enabled_flags(irqflags_t flags)\r
 152 {\r
 153         return (flags);\r
 154 }\r
 155 \r
 156 static inline void cpu_irq_restore(irqflags_t flags)\r
 157 {\r
 158         if (cpu_irq_is_enabled_flags(flags))\r
 159                 cpu_irq_enable();\r
 160 }\r
 161 \r
 162 void cpu_irq_enter_critical(void);\r
 163 void cpu_irq_leave_critical(void);\r
 164 \r
 165 /**\r
 166  * \weakgroup interrupt_deprecated_group\r
 167  * @{\r
 168  */\r
 169 \r
 170 #define Enable_global_interrupt()            cpu_irq_enable()\r
 171 #define Disable_global_interrupt()           cpu_irq_disable()\r
 172 #define Is_global_interrupt_enabled()        cpu_irq_is_enabled()\r
 173 \r
 174 //@}\r
 175 \r
 176 //@}\r
 177 \r
 178 #endif /* UTILS_INTERRUPT_INTERRUPT_H */\r