interrupt.h 3.82 KB
Newer Older
 Jake Read committed Nov 28, 2017 1 2 3 4 5 6 7 8 9 10 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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 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 140 141 142 /** * \file * * \brief Global interrupt management for 8- and 32-bit AVR * * Copyright (c) 2010-2016 Atmel Corporation. All rights reserved. * * \asf_license_start * * \page License * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * 3. The name of Atmel may not be used to endorse or promote products derived * from this software without specific prior written permission. * * 4. This software may only be redistributed and used in connection with an * Atmel microcontroller product. * * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * * \asf_license_stop * */ /* * Support and FAQ: visit Atmel Support */ #ifndef UTILS_INTERRUPT_H #define UTILS_INTERRUPT_H #include #if XMEGA || MEGA # include "interrupt/interrupt_avr8.h" #elif UC3 # include "interrupt/interrupt_avr32.h" #elif SAM || SAMB # include "interrupt/interrupt_sam_nvic.h" #else # error Unsupported device. #endif /** * \defgroup interrupt_group Global interrupt management * * This is a driver for global enabling and disabling of interrupts. * * @{ */ #if defined(__DOXYGEN__) /** * \def CONFIG_INTERRUPT_FORCE_INTC * \brief Force usage of the ASF INTC driver * * Predefine this symbol when preprocessing to force the use of the ASF INTC driver. * This is useful to ensure compatibility across compilers and shall be used only when required * by the application needs. */ # define CONFIG_INTERRUPT_FORCE_INTC #endif //! \name Global interrupt flags //@{ /** * \typedef irqflags_t * \brief Type used for holding state of interrupt flag */ /** * \def cpu_irq_enable * \brief Enable interrupts globally */ /** * \def cpu_irq_disable * \brief Disable interrupts globally */ /** * \fn irqflags_t cpu_irq_save(void) * \brief Get and clear the global interrupt flags * * Use in conjunction with \ref cpu_irq_restore. * * \return Current state of interrupt flags. * * \note This function leaves interrupts disabled. */ /** * \fn void cpu_irq_restore(irqflags_t flags) * \brief Restore global interrupt flags * * Use in conjunction with \ref cpu_irq_save. * * \param flags State to set interrupt flag to. */ /** * \fn bool cpu_irq_is_enabled_flags(irqflags_t flags) * \brief Check if interrupts are globally enabled in supplied flags * * \param flags Currents state of interrupt flags. * * \return True if interrupts are enabled. */ /** * \def cpu_irq_is_enabled * \brief Check if interrupts are globally enabled * * \return True if interrupts are enabled. */ //@} //! @} /** * \ingroup interrupt_group * \defgroup interrupt_deprecated_group Deprecated interrupt definitions */ #endif /* UTILS_INTERRUPT_H */