irq.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Carlo Caione <ccaione@baylibre.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_ARCH_RISCV_IRQ_H_
#define ZEPHYR_INCLUDE_ARCH_RISCV_IRQ_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <zephyr/sys/util_macro.h>
 
#ifndef _ASMLANGUAGE
#include <zephyr/irq.h>
#include <zephyr/sw_isr_table.h>
#include <stdbool.h>
#endif /* !_ASMLANGUAGE */
 
/* Exceptions 0-15 (MCAUSE interrupt=0) */

#define RISCV_EXC_BREAKPOINT 3
/* Environment Call from U-mode */
#define RISCV_EXC_ECALLU 8
#define RISCV_EXC_ECALLS  9
#define RISCV_EXC_ECALLM 11
 
/* IRQs 0-15 (MCAUSE interrupt=1) */

#define RISCV_IRQ_MSOFT 3
#define RISCV_IRQ_MEXT  11
 
#ifdef CONFIG_64BIT
#define RISCV_MCAUSE_IRQ_POS          63U
#define RISCV_MCAUSE_IRQ_BIT          BIT64(RISCV_MCAUSE_IRQ_POS)
#else
#define RISCV_MCAUSE_IRQ_POS          31U
#define RISCV_MCAUSE_IRQ_BIT          BIT(RISCV_MCAUSE_IRQ_POS)
#endif
 
#ifndef _ASMLANGUAGE
 
extern void arch_irq_enable(unsigned int irq);
extern void arch_irq_disable(unsigned int irq);
extern int arch_irq_is_enabled(unsigned int irq);
 
#if defined(CONFIG_RISCV_HAS_PLIC) || defined(CONFIG_RISCV_HAS_CLIC) ||                            \
        defined(CONFIG_RISCV_HAS_AIA)
extern void z_riscv_irq_priority_set(unsigned int irq,
                                     unsigned int prio,
                                     uint32_t flags);
#else
#define z_riscv_irq_priority_set(i, p, f) /* Nothing */
#endif /* CONFIG_RISCV_HAS_PLIC || CONFIG_RISCV_HAS_CLIC */
 
#ifdef CONFIG_RISCV_HAS_CLIC
extern void z_riscv_irq_vector_set(unsigned int irq);
#else
#define z_riscv_irq_vector_set(i) /* Nothing */
#endif /* CONFIG_RISCV_HAS_CLIC */
 
#define ARCH_IRQ_CONNECT(irq_p, priority_p, isr_p, isr_param_p, flags_p) \
{ \
        Z_ISR_DECLARE(irq_p + CONFIG_RISCV_RESERVED_IRQ_ISR_TABLES_OFFSET, \
                      0, isr_p, isr_param_p); \
        z_riscv_irq_priority_set(irq_p, priority_p, flags_p); \
}
 
#define ARCH_IRQ_DIRECT_CONNECT(irq_p, priority_p, isr_p, flags_p) \
{ \
        Z_ISR_DECLARE_DIRECT(irq_p + CONFIG_RISCV_RESERVED_IRQ_ISR_TABLES_OFFSET, \
                      ISR_FLAG_DIRECT, isr_p); \
        z_riscv_irq_priority_set(irq_p, priority_p, flags_p); \
        z_riscv_irq_vector_set(irq_p); \
}
 
#ifdef CONFIG_PM
extern void arch_isr_direct_pm(void);
#define ARCH_ISR_DIRECT_PM() arch_isr_direct_pm()
#else
#define ARCH_ISR_DIRECT_PM()                                                                       \
        do {                                                                                       \
        } while (false)
#endif
 
#define ARCH_ISR_DIRECT_HEADER() arch_isr_direct_header()
#define ARCH_ISR_DIRECT_FOOTER(swap) arch_isr_direct_footer(swap)
 
#ifdef CONFIG_TRACING_ISR
extern void sys_trace_isr_enter(void);
extern void sys_trace_isr_exit(void);
#endif
 
static inline void arch_isr_direct_header(void)
{
#ifdef CONFIG_TRACING_ISR
        sys_trace_isr_enter();
#endif
        /* We need to increment this so that arch_is_in_isr() keeps working */
        ++(arch_curr_cpu()->nested);
}
 
extern unsigned long __soc_handle_irq(unsigned long mcause);
 
static inline void arch_isr_direct_footer(int swap)
{
        ARG_UNUSED(swap);
        unsigned long cause;
 
#ifdef CONFIG_RISCV_S_MODE
        __asm__ volatile("csrr %0, scause" : "=r" (cause));
#else
        __asm__ volatile("csrr %0, mcause" : "=r" (cause));
#endif
        cause &= CONFIG_RISCV_MCAUSE_EXCEPTION_MASK;
 
        /* Clear the pending IRQ */
        __soc_handle_irq(cause);
 
        /* We are not in the ISR anymore */
        --(arch_curr_cpu()->nested);
 
#ifdef CONFIG_TRACING_ISR
        sys_trace_isr_exit();
#endif
}
 
/*
 * TODO: Add support for rescheduling
 */
#ifdef CONFIG_RISCV_S_MODE
#define ARCH_ISR_DIRECT_DECLARE(name) \
        static inline int name##_body(void); \
        __attribute__ ((interrupt("supervisor"))) void name(void) \
        { \
                ISR_DIRECT_HEADER(); \
                name##_body(); \
                ISR_DIRECT_FOOTER(0); \
        } \
        static inline int name##_body(void)
#else
#define ARCH_ISR_DIRECT_DECLARE(name) \
        static inline int name##_body(void); \
        __attribute__ ((interrupt)) void name(void) \
        { \
                ISR_DIRECT_HEADER(); \
                name##_body(); \
                ISR_DIRECT_FOOTER(0); \
        } \
        static inline int name##_body(void)
#endif
 
#endif /* _ASMLANGUAGE */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_ARCH_RISCV_IRQ_H_ */