Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
interrupt_util.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef INTERRUPT_UTIL_H_
8#define INTERRUPT_UTIL_H_
9
10#define k_str_out_count(s) k_str_out((s), sizeof(s) - 1);
11
12#if defined(CONFIG_CPU_CORTEX_M)
13#include <cmsis_core.h>
14
15static inline uint32_t get_available_nvic_line(uint32_t initial_offset)
16{
17 int i;
18
19 for (i = initial_offset - 1; i >= 0; i--) {
20
21 if (NVIC_GetEnableIRQ(i) == 0) {
22 /*
23 * Interrupts configured statically with IRQ_CONNECT(.)
24 * are automatically enabled. NVIC_GetEnableIRQ()
25 * returning false, here, implies that the IRQ line is
26 * either not implemented or it is not enabled, thus,
27 * currently not in use by Zephyr.
28 */
29
30 /* Set the NVIC line to pending. */
31 NVIC_SetPendingIRQ(i);
32
33 if (NVIC_GetPendingIRQ(i)) {
34 /*
35 * If the NVIC line is pending, it is
36 * guaranteed that it is implemented; clear the
37 * line.
38 */
39 NVIC_ClearPendingIRQ(i);
40
41 if (!NVIC_GetPendingIRQ(i)) {
42 /*
43 * If the NVIC line can be successfully
44 * un-pended, it is guaranteed that it
45 * can be used for software interrupt
46 * triggering. Return the NVIC line
47 * number.
48 */
49 break;
50 }
51 }
52 }
53 }
54
55 zassert_true(i >= 0, "No available IRQ line\n");
56
57 return i;
58}
59
60static inline void trigger_irq(int irq)
61{
62 k_str_out_count("Triggering irq\n");
63#if defined(CONFIG_SOC_TI_LM3S6965_QEMU) || defined(CONFIG_CPU_CORTEX_M0) || \
64 defined(CONFIG_CPU_CORTEX_M0PLUS) || defined(CONFIG_CPU_CORTEX_M1) || \
65 defined(CONFIG_ARMV6_M_ARMV8_M_BASELINE)
66 /* QEMU does not simulate the STIR register: this is a workaround */
67 NVIC_SetPendingIRQ(irq);
68#else
69 NVIC->STIR = irq;
70#endif
71}
72
73#elif defined(CONFIG_GIC)
76
77static inline void trigger_irq(int irq)
78{
79 k_str_out_count("Triggering irq\n");
80
81 /* Ensure that the specified IRQ number is a valid SGI interrupt ID */
82 zassert_true(irq <= 15, "%u is not a valid SGI interrupt ID", irq);
83
84 /*
85 * Generate a software generated interrupt and forward it to the
86 * requesting CPU.
87 */
88#if CONFIG_GIC_VER <= 2
90#else
91 uint64_t mpidr = GET_MPIDR();
92 uint8_t aff0 = MPIDR_AFFLVL(mpidr, 0);
93
94 gic_raise_sgi(irq, mpidr, BIT(aff0));
95#endif
96}
97
98#elif defined(CONFIG_ARC)
99static inline void trigger_irq(int irq)
100{
101 k_str_out_count("Triggering irq\n");
102 z_arc_v2_aux_reg_write(_ARC_V2_AUX_IRQ_HINT, irq);
103}
104
105#elif defined(CONFIG_X86)
106
107#ifdef CONFIG_X2APIC
109#define VECTOR_MASK 0xFF
110#else
112#define LOAPIC_ICR_IPI_TEST 0x00004000U
113#endif
114
115/*
116 * We can emulate the interrupt by sending the IPI to
117 * core itself by the LOAPIC for x86 platform.
118 *
119 * In APIC mode, Write LOAPIC's ICR to trigger IPI,
120 * the LOAPIC_ICR_IPI_TEST 0x00004000U means:
121 * Delivery Mode: Fixed
122 * Destination Mode: Physical
123 * Level: Assert
124 * Trigger Mode: Edge
125 * Destination Shorthand: No Shorthand
126 * Destination: depends on cpu_id
127 *
128 * In X2APIC mode, this no longer works. We emulate the
129 * interrupt by writing the IA32_X2APIC_SELF_IPI MSR
130 * to send IPI to the core itself via LOAPIC also.
131 * According to SDM vol.3 chapter 10.12.11, the bit[7:0]
132 * for setting the vector is only needed.
133 */
134static inline void trigger_irq(int vector)
135{
136 uint8_t i;
137
138#ifdef CONFIG_X2APIC
139 x86_write_x2apic(LOAPIC_SELF_IPI, ((VECTOR_MASK & vector)));
140#else
141
142#ifdef CONFIG_SMP
143 int cpu_id = arch_curr_cpu()->id;
144#else
145 int cpu_id = 0;
146#endif
147 z_loapic_ipi(cpu_id, LOAPIC_ICR_IPI_TEST, vector);
148#endif /* CONFIG_X2APIC */
149
150 /*
151 * add some nop operations here to cost some cycles to make sure
152 * the IPI interrupt is handled before do our check.
153 */
154 for (i = 0; i < 10; i++) {
155 arch_nop();
156 }
157}
158
159#elif defined(CONFIG_ARCH_POSIX)
161
162static inline void trigger_irq(int irq)
163{
165}
166
167#elif defined(CONFIG_RISCV)
168#if defined(CONFIG_CLIC) || defined(CONFIG_NRFX_CLIC)
169void riscv_clic_irq_set_pending(uint32_t irq);
170static inline void trigger_irq(int irq)
171{
172 riscv_clic_irq_set_pending(irq);
173}
174#else
175static inline void trigger_irq(int irq)
176{
177 uint32_t mip;
178
179 __asm__ volatile("csrrs %0, mip, %1\n" : "=r"(mip) : "r"(1 << irq));
180}
181#endif
182#elif defined(CONFIG_XTENSA)
183static inline void trigger_irq(int irq)
184{
185#if XCHAL_NUM_INTERRUPTS > 32
186 switch (irq >> 5) {
187 case 0:
188 z_xt_set_intset(1 << irq);
189 break;
190 case 1:
191 z_xt_set_intset1(1 << irq);
192 break;
193#if XCHAL_NUM_INTERRUPTS > 64
194 case 2:
195 z_xt_set_intset2(1 << irq);
196 break;
197#endif
198#if XCHAL_NUM_INTERRUPTS > 96
199 case 3:
200 z_xt_set_intset3(1 << irq);
201 break;
202#endif
203 default:
204 break;
205 }
206#else
207 z_xt_set_intset(1 << irq);
208#endif
209}
210
211#elif defined(CONFIG_SPARC)
212extern void z_sparc_enter_irq(int);
213
214static inline void trigger_irq(int irq)
215{
216 z_sparc_enter_irq(irq);
217}
218
219#elif defined(CONFIG_MIPS)
220extern void z_mips_enter_irq(int);
221
222static inline void trigger_irq(int irq)
223{
224 z_mips_enter_irq(irq);
225}
226
227#elif defined(CONFIG_CPU_CORTEX_R5) && defined(CONFIG_VIM)
228
229extern void z_vim_arm_enter_irq(int);
230
231static inline void trigger_irq(int irq)
232{
233 z_vim_arm_enter_irq(irq);
234}
235
236#elif defined(CONFIG_RX)
237#define IR_BASE_ADDRESS DT_REG_ADDR_BY_NAME(DT_NODELABEL(icu), IR)
238static inline void trigger_irq(int irq)
239{
240 __ASSERT(irq < CONFIG_NUM_IRQS, "attempting to trigger invalid IRQ (%u)", irq);
241 __ASSERT(irq >= CONFIG_GEN_IRQ_START_VECTOR, "attempting to trigger reserved IRQ (%u)",
242 irq);
243 _sw_isr_table[irq - CONFIG_GEN_IRQ_START_VECTOR].isr(
244 _sw_isr_table[irq - CONFIG_GEN_IRQ_START_VECTOR].arg);
245}
246
247#else
248#define NO_TRIGGER_FROM_SW
249#endif
250
251#endif /* INTERRUPT_UTIL_H_ */
static ALWAYS_INLINE _cpu_t * arch_curr_cpu(void)
Definition arch_inlines.h:17
#define MPIDR_AFFLVL(mpidr, aff_level)
Definition cpu.h:101
#define GET_MPIDR()
Definition cpu.h:104
#define CONFIG_GEN_IRQ_START_VECTOR
Definition irq.h:14
#define CONFIG_NUM_IRQS
Definition irq.h:183
Driver for ARM Generic Interrupt Controller.
void gic_raise_sgi(unsigned int sgi_id, uint64_t target_aff, uint16_t target_list)
raise SGI to target cores
#define GICD_SGIR
Definition gic.h:181
#define GICD_SGIR_SGIINTID(x)
Definition gic.h:259
#define GICD_SGIR_TGTFILT_REQONLY
Definition gic.h:251
static void arch_nop(void)
Do nothing and return.
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define zassert_true(cond,...)
Assert that cond is true.
Definition ztest_assert.h:275
#define k_str_out_count(s)
Definition interrupt_util.h:10
static void x86_write_x2apic(unsigned int reg, uint64_t val)
Write 64-bit value to the local APIC in x2APIC mode.
Definition loapic.h:118
#define LOAPIC_SELF_IPI
Definition loapic.h:42
void posix_sw_set_pending_IRQ(unsigned int IRQn)
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
static ALWAYS_INLINE void sys_write32(uint32_t data, mem_addr_t addr)
Definition sys-io-common.h:70