mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_RZ_A1H/irq_ctrl.h@166:5aab5a7997ee, 2018-04-20 (annotated)

Committer:
Anna Bridge
Date:
Fri Apr 20 11:08:29 2018 +0100
Revision:
166:5aab5a7997ee
Parent:
160:5571c4ff569f
Child:
169:a7c7b631e539
Updating mbed 2 version number

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 160:5571c4ff569f 1 /**************************************************************************//**
Anna Bridge 160:5571c4ff569f 2 * @file irq_ctrl.h
Anna Bridge 160:5571c4ff569f 3 * @brief Interrupt Controller API header file
Anna Bridge 160:5571c4ff569f 4 * @version V1.0.0
Anna Bridge 160:5571c4ff569f 5 * @date 23. June 2017
Anna Bridge 160:5571c4ff569f 6 ******************************************************************************/
Anna Bridge 160:5571c4ff569f 7 /*
Anna Bridge 160:5571c4ff569f 8 * Copyright (c) 2017 ARM Limited. All rights reserved.
Anna Bridge 160:5571c4ff569f 9 *
Anna Bridge 160:5571c4ff569f 10 * SPDX-License-Identifier: Apache-2.0
Anna Bridge 160:5571c4ff569f 11 *
Anna Bridge 160:5571c4ff569f 12 * Licensed under the Apache License, Version 2.0 (the License); you may
Anna Bridge 160:5571c4ff569f 13 * not use this file except in compliance with the License.
Anna Bridge 160:5571c4ff569f 14 * You may obtain a copy of the License at
Anna Bridge 160:5571c4ff569f 15 *
Anna Bridge 160:5571c4ff569f 16 * www.apache.org/licenses/LICENSE-2.0
Anna Bridge 160:5571c4ff569f 17 *
Anna Bridge 160:5571c4ff569f 18 * Unless required by applicable law or agreed to in writing, software
Anna Bridge 160:5571c4ff569f 19 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
Anna Bridge 160:5571c4ff569f 20 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Anna Bridge 160:5571c4ff569f 21 * See the License for the specific language governing permissions and
Anna Bridge 160:5571c4ff569f 22 * limitations under the License.
Anna Bridge 160:5571c4ff569f 23 */
Anna Bridge 160:5571c4ff569f 24
Anna Bridge 160:5571c4ff569f 25 #ifndef IRQ_CTRL_H_
Anna Bridge 160:5571c4ff569f 26 #define IRQ_CTRL_H_
Anna Bridge 160:5571c4ff569f 27
Anna Bridge 160:5571c4ff569f 28 #include <stdint.h>
Anna Bridge 160:5571c4ff569f 29
Anna Bridge 160:5571c4ff569f 30 #ifndef IRQHANDLER_T
Anna Bridge 160:5571c4ff569f 31 #define IRQHANDLER_T
Anna Bridge 160:5571c4ff569f 32 /// Interrupt handler data type
Anna Bridge 160:5571c4ff569f 33 typedef void (*IRQHandler_t) (void);
Anna Bridge 160:5571c4ff569f 34 #endif
Anna Bridge 160:5571c4ff569f 35
Anna Bridge 160:5571c4ff569f 36 #ifndef IRQN_ID_T
Anna Bridge 160:5571c4ff569f 37 #define IRQN_ID_T
Anna Bridge 160:5571c4ff569f 38 /// Interrupt ID number data type
Anna Bridge 160:5571c4ff569f 39 typedef int32_t IRQn_ID_t;
Anna Bridge 160:5571c4ff569f 40 #endif
Anna Bridge 160:5571c4ff569f 41
Anna Bridge 160:5571c4ff569f 42 /* Interrupt mode bit-masks */
Anna Bridge 160:5571c4ff569f 43 #define IRQ_MODE_TRIG_Pos (0U)
Anna Bridge 160:5571c4ff569f 44 #define IRQ_MODE_TRIG_Msk (0x07UL /*<< IRQ_MODE_TRIG_Pos*/)
Anna Bridge 160:5571c4ff569f 45 #define IRQ_MODE_TRIG_LEVEL (0x00UL /*<< IRQ_MODE_TRIG_Pos*/) ///< Trigger: level triggered interrupt
Anna Bridge 160:5571c4ff569f 46 #define IRQ_MODE_TRIG_LEVEL_LOW (0x01UL /*<< IRQ_MODE_TRIG_Pos*/) ///< Trigger: low level triggered interrupt
Anna Bridge 160:5571c4ff569f 47 #define IRQ_MODE_TRIG_LEVEL_HIGH (0x02UL /*<< IRQ_MODE_TRIG_Pos*/) ///< Trigger: high level triggered interrupt
Anna Bridge 160:5571c4ff569f 48 #define IRQ_MODE_TRIG_EDGE (0x04UL /*<< IRQ_MODE_TRIG_Pos*/) ///< Trigger: edge triggered interrupt
Anna Bridge 160:5571c4ff569f 49 #define IRQ_MODE_TRIG_EDGE_RISING (0x05UL /*<< IRQ_MODE_TRIG_Pos*/) ///< Trigger: rising edge triggered interrupt
Anna Bridge 160:5571c4ff569f 50 #define IRQ_MODE_TRIG_EDGE_FALLING (0x06UL /*<< IRQ_MODE_TRIG_Pos*/) ///< Trigger: falling edge triggered interrupt
Anna Bridge 160:5571c4ff569f 51 #define IRQ_MODE_TRIG_EDGE_BOTH (0x07UL /*<< IRQ_MODE_TRIG_Pos*/) ///< Trigger: rising and falling edge triggered interrupt
Anna Bridge 160:5571c4ff569f 52
Anna Bridge 160:5571c4ff569f 53 #define IRQ_MODE_TYPE_Pos (3U)
Anna Bridge 160:5571c4ff569f 54 #define IRQ_MODE_TYPE_Msk (0x01UL << IRQ_MODE_TYPE_Pos)
Anna Bridge 160:5571c4ff569f 55 #define IRQ_MODE_TYPE_IRQ (0x00UL << IRQ_MODE_TYPE_Pos) ///< Type: interrupt source triggers CPU IRQ line
Anna Bridge 160:5571c4ff569f 56 #define IRQ_MODE_TYPE_FIQ (0x01UL << IRQ_MODE_TYPE_Pos) ///< Type: interrupt source triggers CPU FIQ line
Anna Bridge 160:5571c4ff569f 57
Anna Bridge 160:5571c4ff569f 58 #define IRQ_MODE_DOMAIN_Pos (4U)
Anna Bridge 160:5571c4ff569f 59 #define IRQ_MODE_DOMAIN_Msk (0x01UL << IRQ_MODE_DOMAIN_Pos)
Anna Bridge 160:5571c4ff569f 60 #define IRQ_MODE_DOMAIN_NONSECURE (0x00UL << IRQ_MODE_DOMAIN_Pos) ///< Domain: interrupt is targeting non-secure domain
Anna Bridge 160:5571c4ff569f 61 #define IRQ_MODE_DOMAIN_SECURE (0x01UL << IRQ_MODE_DOMAIN_Pos) ///< Domain: interrupt is targeting secure domain
Anna Bridge 160:5571c4ff569f 62
Anna Bridge 160:5571c4ff569f 63 #define IRQ_MODE_CPU_Pos (5U)
Anna Bridge 160:5571c4ff569f 64 #define IRQ_MODE_CPU_Msk (0xFFUL << IRQ_MODE_CPU_Pos)
Anna Bridge 160:5571c4ff569f 65 #define IRQ_MODE_CPU_ALL (0x00UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets all CPUs
Anna Bridge 160:5571c4ff569f 66 #define IRQ_MODE_CPU_0 (0x01UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets CPU 0
Anna Bridge 160:5571c4ff569f 67 #define IRQ_MODE_CPU_1 (0x02UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets CPU 1
Anna Bridge 160:5571c4ff569f 68 #define IRQ_MODE_CPU_2 (0x04UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets CPU 2
Anna Bridge 160:5571c4ff569f 69 #define IRQ_MODE_CPU_3 (0x08UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets CPU 3
Anna Bridge 160:5571c4ff569f 70 #define IRQ_MODE_CPU_4 (0x10UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets CPU 4
Anna Bridge 160:5571c4ff569f 71 #define IRQ_MODE_CPU_5 (0x20UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets CPU 5
Anna Bridge 160:5571c4ff569f 72 #define IRQ_MODE_CPU_6 (0x40UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets CPU 6
Anna Bridge 160:5571c4ff569f 73 #define IRQ_MODE_CPU_7 (0x80UL << IRQ_MODE_CPU_Pos) ///< CPU: interrupt targets CPU 7
Anna Bridge 160:5571c4ff569f 74
Anna Bridge 160:5571c4ff569f 75 #define IRQ_MODE_ERROR (0x80000000UL) ///< Bit indicating mode value error
Anna Bridge 160:5571c4ff569f 76
Anna Bridge 160:5571c4ff569f 77 /* Interrupt priority bit-masks */
Anna Bridge 160:5571c4ff569f 78 #define IRQ_PRIORITY_Msk (0x0000FFFFUL) ///< Interrupt priority value bit-mask
Anna Bridge 160:5571c4ff569f 79 #define IRQ_PRIORITY_ERROR (0x80000000UL) ///< Bit indicating priority value error
Anna Bridge 160:5571c4ff569f 80
Anna Bridge 160:5571c4ff569f 81 /// Initialize interrupt controller.
Anna Bridge 160:5571c4ff569f 82 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 83 int32_t IRQ_Initialize (void);
Anna Bridge 160:5571c4ff569f 84
Anna Bridge 160:5571c4ff569f 85 /// Register interrupt handler.
Anna Bridge 160:5571c4ff569f 86 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 87 /// \param[in] handler interrupt handler function address
Anna Bridge 160:5571c4ff569f 88 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 89 int32_t IRQ_SetHandler (IRQn_ID_t irqn, IRQHandler_t handler);
Anna Bridge 160:5571c4ff569f 90
Anna Bridge 160:5571c4ff569f 91 /// Get the registered interrupt handler.
Anna Bridge 160:5571c4ff569f 92 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 93 /// \return registered interrupt handler function address.
Anna Bridge 160:5571c4ff569f 94 IRQHandler_t IRQ_GetHandler (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 95
Anna Bridge 160:5571c4ff569f 96 /// Enable interrupt.
Anna Bridge 160:5571c4ff569f 97 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 98 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 99 int32_t IRQ_Enable (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 100
Anna Bridge 160:5571c4ff569f 101 /// Disable interrupt.
Anna Bridge 160:5571c4ff569f 102 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 103 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 104 int32_t IRQ_Disable (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 105
Anna Bridge 160:5571c4ff569f 106 /// Get interrupt enable state.
Anna Bridge 160:5571c4ff569f 107 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 108 /// \return 0 - interrupt is disabled, 1 - interrupt is enabled.
Anna Bridge 160:5571c4ff569f 109 uint32_t IRQ_GetEnableState (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 110
Anna Bridge 160:5571c4ff569f 111 /// Configure interrupt request mode.
Anna Bridge 160:5571c4ff569f 112 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 113 /// \param[in] mode mode configuration
Anna Bridge 160:5571c4ff569f 114 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 115 int32_t IRQ_SetMode (IRQn_ID_t irqn, uint32_t mode);
Anna Bridge 160:5571c4ff569f 116
Anna Bridge 160:5571c4ff569f 117 /// Get interrupt mode configuration.
Anna Bridge 160:5571c4ff569f 118 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 119 /// \return current interrupt mode configuration with optional IRQ_MODE_ERROR bit set.
Anna Bridge 160:5571c4ff569f 120 uint32_t IRQ_GetMode (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 121
Anna Bridge 160:5571c4ff569f 122 /// Get ID number of current interrupt request (IRQ).
Anna Bridge 160:5571c4ff569f 123 /// \return interrupt ID number.
Anna Bridge 160:5571c4ff569f 124 IRQn_ID_t IRQ_GetActiveIRQ (void);
Anna Bridge 160:5571c4ff569f 125
Anna Bridge 160:5571c4ff569f 126 /// Get ID number of current fast interrupt request (FIQ).
Anna Bridge 160:5571c4ff569f 127 /// \return interrupt ID number.
Anna Bridge 160:5571c4ff569f 128 IRQn_ID_t IRQ_GetActiveFIQ (void);
Anna Bridge 160:5571c4ff569f 129
Anna Bridge 160:5571c4ff569f 130 /// Signal end of interrupt processing.
Anna Bridge 160:5571c4ff569f 131 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 132 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 133 int32_t IRQ_EndOfInterrupt (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 134
Anna Bridge 160:5571c4ff569f 135 /// Set interrupt pending flag.
Anna Bridge 160:5571c4ff569f 136 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 137 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 138 int32_t IRQ_SetPending (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 139
Anna Bridge 160:5571c4ff569f 140 /// Get interrupt pending flag.
Anna Bridge 160:5571c4ff569f 141 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 142 /// \return 0 - interrupt is not pending, 1 - interrupt is pending.
Anna Bridge 160:5571c4ff569f 143 uint32_t IRQ_GetPending (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 144
Anna Bridge 160:5571c4ff569f 145 /// Clear interrupt pending flag.
Anna Bridge 160:5571c4ff569f 146 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 147 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 148 int32_t IRQ_ClearPending (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 149
Anna Bridge 160:5571c4ff569f 150 /// Set interrupt priority value.
Anna Bridge 160:5571c4ff569f 151 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 152 /// \param[in] priority interrupt priority value
Anna Bridge 160:5571c4ff569f 153 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 154 int32_t IRQ_SetPriority (IRQn_ID_t irqn, uint32_t priority);
Anna Bridge 160:5571c4ff569f 155
Anna Bridge 160:5571c4ff569f 156 /// Get interrupt priority.
Anna Bridge 160:5571c4ff569f 157 /// \param[in] irqn interrupt ID number
Anna Bridge 160:5571c4ff569f 158 /// \return current interrupt priority value with optional IRQ_PRIORITY_ERROR bit set.
Anna Bridge 160:5571c4ff569f 159 uint32_t IRQ_GetPriority (IRQn_ID_t irqn);
Anna Bridge 160:5571c4ff569f 160
Anna Bridge 160:5571c4ff569f 161 /// Set priority masking threshold.
Anna Bridge 160:5571c4ff569f 162 /// \param[in] priority priority masking threshold value
Anna Bridge 160:5571c4ff569f 163 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 164 int32_t IRQ_SetPriorityMask (uint32_t priority);
Anna Bridge 160:5571c4ff569f 165
Anna Bridge 160:5571c4ff569f 166 /// Get priority masking threshold
Anna Bridge 160:5571c4ff569f 167 /// \return current priority masking threshold value with optional IRQ_PRIORITY_ERROR bit set.
Anna Bridge 160:5571c4ff569f 168 uint32_t IRQ_GetPriorityMask (void);
Anna Bridge 160:5571c4ff569f 169
Anna Bridge 160:5571c4ff569f 170 /// Set priority grouping field split point
Anna Bridge 160:5571c4ff569f 171 /// \param[in] bits number of MSB bits included in the group priority field comparison
Anna Bridge 160:5571c4ff569f 172 /// \return 0 on success, -1 on error.
Anna Bridge 160:5571c4ff569f 173 int32_t IRQ_SetPriorityGroupBits (uint32_t bits);
Anna Bridge 160:5571c4ff569f 174
Anna Bridge 160:5571c4ff569f 175 /// Get priority grouping field split point
Anna Bridge 160:5571c4ff569f 176 /// \return current number of MSB bits included in the group priority field comparison with
Anna Bridge 160:5571c4ff569f 177 /// optional IRQ_PRIORITY_ERROR bit set.
Anna Bridge 160:5571c4ff569f 178 uint32_t IRQ_GetPriorityGroupBits (void);
Anna Bridge 160:5571c4ff569f 179
Anna Bridge 160:5571c4ff569f 180 #endif // IRQ_CTRL_H_