irq: relocate multi-level irq out of irq.h

Relocate multi-level interrupts APIs out of `irq.h` into
a new file named `irq_multilevel.h` to provide cleaner
separation between typical irq & multilevel ones.

Added preprocessor versions of `irq_to_level_x` as `IRQ_TO_Lx`.

Signed-off-by: Yong Cong Sin <ycsin@meta.com>
This commit is contained in:
Yong Cong Sin 2023-10-16 13:30:53 +08:00 committed by Chris Friedt
parent 42676e322b
commit d7302f417e
8 changed files with 182 additions and 131 deletions

View File

@ -7,6 +7,7 @@
#include <zephyr/sw_isr_table.h>
#include <zephyr/arch/cpu.h>
#include <zephyr/irq.h>
#include <zephyr/irq_multilevel.h>
#include <zephyr/sys/__assert.h>
/*
* Common code for arches that use software ISR tables (CONFIG_GEN_ISR_TABLES)

View File

@ -8,6 +8,7 @@
#include <kernel_internal.h>
#include <zephyr/logging/log.h>
#include <zephyr/arch/riscv/csr.h>
#include <zephyr/irq_multilevel.h>
LOG_MODULE_DECLARE(os, CONFIG_KERNEL_LOG_LEVEL);

View File

@ -17,6 +17,7 @@
#include <zephyr/drivers/gpio.h>
#include <zephyr/sys/util.h>
#include <zephyr/irq.h>
#include <zephyr/irq_multilevel.h>
#include <zephyr/drivers/gpio/gpio_utils.h>

View File

@ -12,6 +12,7 @@
#include <zephyr/arch/cpu.h>
#include <zephyr/sys/util.h>
#include <zephyr/device.h>
#include <zephyr/irq_multilevel.h>
#include <soc.h>
#include <zephyr/sw_isr_table.h>

View File

@ -280,137 +280,6 @@ void z_smp_global_unlock(unsigned int key);
#define irq_unlock(key) arch_irq_unlock(key)
#endif
/**
* @brief Return IRQ level
* This routine returns the interrupt level number of the provided interrupt.
*
* @param irq IRQ number in its zephyr format
*
* @return 1 if IRQ level 1, 2 if IRQ level 2, 3 if IRQ level 3
*/
static inline unsigned int irq_get_level(unsigned int irq)
{
const uint32_t mask2 = BIT_MASK(CONFIG_2ND_LEVEL_INTERRUPT_BITS) <<
CONFIG_1ST_LEVEL_INTERRUPT_BITS;
const uint32_t mask3 = BIT_MASK(CONFIG_3RD_LEVEL_INTERRUPT_BITS) <<
(CONFIG_1ST_LEVEL_INTERRUPT_BITS + CONFIG_2ND_LEVEL_INTERRUPT_BITS);
if (IS_ENABLED(CONFIG_3RD_LEVEL_INTERRUPTS) && (irq & mask3) != 0) {
return 3;
}
if (IS_ENABLED(CONFIG_2ND_LEVEL_INTERRUPTS) && (irq & mask2) != 0) {
return 2;
}
return 1;
}
#if defined(CONFIG_2ND_LEVEL_INTERRUPTS)
/**
* @brief Return the 2nd level interrupt number
*
* This routine returns the second level irq number of the zephyr irq
* number passed in
*
* @param irq IRQ number in its zephyr format
*
* @return 2nd level IRQ number
*/
static inline unsigned int irq_from_level_2(unsigned int irq)
{
#if defined(CONFIG_3RD_LEVEL_INTERRUPTS)
return ((irq >> CONFIG_1ST_LEVEL_INTERRUPT_BITS) &
BIT_MASK(CONFIG_2ND_LEVEL_INTERRUPT_BITS)) - 1;
#else
return (irq >> CONFIG_1ST_LEVEL_INTERRUPT_BITS) - 1;
#endif
}
/**
* @brief Converts irq from level 1 to level 2 format
*
*
* This routine converts the input into the level 2 irq number format
*
* @note Values >= 0xFF are invalid
*
* @param irq IRQ number in its zephyr format
*
* @return 2nd level IRQ number
*/
static inline unsigned int irq_to_level_2(unsigned int irq)
{
return (irq + 1) << CONFIG_1ST_LEVEL_INTERRUPT_BITS;
}
/**
* @brief Returns the parent IRQ of the level 2 raw IRQ number
*
*
* The parent of a 2nd level interrupt is in the 1st byte
*
* @param irq IRQ number in its zephyr format
*
* @return 2nd level IRQ parent
*/
static inline unsigned int irq_parent_level_2(unsigned int irq)
{
return irq & BIT_MASK(CONFIG_1ST_LEVEL_INTERRUPT_BITS);
}
#endif
#ifdef CONFIG_3RD_LEVEL_INTERRUPTS
/**
* @brief Return the 3rd level interrupt number
*
*
* This routine returns the third level irq number of the zephyr irq
* number passed in
*
* @param irq IRQ number in its zephyr format
*
* @return 3rd level IRQ number
*/
static inline unsigned int irq_from_level_3(unsigned int irq)
{
return (irq >> (CONFIG_1ST_LEVEL_INTERRUPT_BITS + CONFIG_2ND_LEVEL_INTERRUPT_BITS)) - 1;
}
/**
* @brief Converts irq from level 1 to level 3 format
*
*
* This routine converts the input into the level 3 irq number format
*
* @note Values >= 0xFF are invalid
*
* @param irq IRQ number in its zephyr format
*
* @return 3rd level IRQ number
*/
static inline unsigned int irq_to_level_3(unsigned int irq)
{
return (irq + 1) << (CONFIG_1ST_LEVEL_INTERRUPT_BITS + CONFIG_2ND_LEVEL_INTERRUPT_BITS);
}
/**
* @brief Returns the parent IRQ of the level 3 raw IRQ number
*
*
* The parent of a 3rd level interrupt is in the 2nd byte
*
* @param irq IRQ number in its zephyr format
*
* @return 3rd level IRQ parent
*/
static inline unsigned int irq_parent_level_3(unsigned int irq)
{
return (irq >> CONFIG_1ST_LEVEL_INTERRUPT_BITS) &
BIT_MASK(CONFIG_2ND_LEVEL_INTERRUPT_BITS);
}
#endif
/**
* @brief Enable an IRQ.
*

View File

@ -0,0 +1,176 @@
/*
* Copyright (c) 2023 Meta
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Public interface for multi-level interrupts
*/
#ifndef ZEPHYR_INCLUDE_IRQ_MULTILEVEL_H_
#define ZEPHYR_INCLUDE_IRQ_MULTILEVEL_H_
#ifndef _ASMLANGUAGE
#include <zephyr/sys/util_macro.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Return IRQ level
* This routine returns the interrupt level number of the provided interrupt.
*
* @param irq IRQ number in its zephyr format
*
* @return 1 if IRQ level 1, 2 if IRQ level 2, 3 if IRQ level 3
*/
static inline unsigned int irq_get_level(unsigned int irq)
{
const uint32_t mask2 = BIT_MASK(CONFIG_2ND_LEVEL_INTERRUPT_BITS) <<
CONFIG_1ST_LEVEL_INTERRUPT_BITS;
const uint32_t mask3 = BIT_MASK(CONFIG_3RD_LEVEL_INTERRUPT_BITS) <<
(CONFIG_1ST_LEVEL_INTERRUPT_BITS + CONFIG_2ND_LEVEL_INTERRUPT_BITS);
if (IS_ENABLED(CONFIG_3RD_LEVEL_INTERRUPTS) && (irq & mask3) != 0) {
return 3;
}
if (IS_ENABLED(CONFIG_2ND_LEVEL_INTERRUPTS) && (irq & mask2) != 0) {
return 2;
}
return 1;
}
#if defined(CONFIG_2ND_LEVEL_INTERRUPTS)
/**
* @brief Return the 2nd level interrupt number
*
* This routine returns the second level irq number of the zephyr irq
* number passed in
*
* @param irq IRQ number in its zephyr format
*
* @return 2nd level IRQ number
*/
static inline unsigned int irq_from_level_2(unsigned int irq)
{
#if defined(CONFIG_3RD_LEVEL_INTERRUPTS)
return ((irq >> CONFIG_1ST_LEVEL_INTERRUPT_BITS) &
BIT_MASK(CONFIG_2ND_LEVEL_INTERRUPT_BITS)) - 1;
#else
return (irq >> CONFIG_1ST_LEVEL_INTERRUPT_BITS) - 1;
#endif
}
/**
* @brief Preprocessor macro to convert `irq` from level 1 to level 2 format
*
* @param irq IRQ number in its zephyr format
*
* @return 2nd level IRQ number
*/
#define IRQ_TO_L2(irq) ((irq + 1) << CONFIG_1ST_LEVEL_INTERRUPT_BITS)
/**
* @brief Converts irq from level 1 to level 2 format
*
*
* This routine converts the input into the level 2 irq number format
*
* @note Values >= 0xFF are invalid
*
* @param irq IRQ number in its zephyr format
*
* @return 2nd level IRQ number
*/
static inline unsigned int irq_to_level_2(unsigned int irq)
{
return IRQ_TO_L2(irq);
}
/**
* @brief Returns the parent IRQ of the level 2 raw IRQ number
*
*
* The parent of a 2nd level interrupt is in the 1st byte
*
* @param irq IRQ number in its zephyr format
*
* @return 2nd level IRQ parent
*/
static inline unsigned int irq_parent_level_2(unsigned int irq)
{
return irq & BIT_MASK(CONFIG_1ST_LEVEL_INTERRUPT_BITS);
}
#endif
#ifdef CONFIG_3RD_LEVEL_INTERRUPTS
/**
* @brief Return the 3rd level interrupt number
*
*
* This routine returns the third level irq number of the zephyr irq
* number passed in
*
* @param irq IRQ number in its zephyr format
*
* @return 3rd level IRQ number
*/
static inline unsigned int irq_from_level_3(unsigned int irq)
{
return (irq >> (CONFIG_1ST_LEVEL_INTERRUPT_BITS + CONFIG_2ND_LEVEL_INTERRUPT_BITS)) - 1;
}
/**
* @brief Preprocessor macro to convert `irq` from level 1 to level 3 format
*
* @param irq IRQ number in its zephyr format
*
* @return 3rd level IRQ number
*/
#define IRQ_TO_L3(irq) \
((irq + 1) << (CONFIG_1ST_LEVEL_INTERRUPT_BITS + CONFIG_2ND_LEVEL_INTERRUPT_BITS))
/**
* @brief Converts irq from level 1 to level 3 format
*
*
* This routine converts the input into the level 3 irq number format
*
* @note Values >= 0xFF are invalid
*
* @param irq IRQ number in its zephyr format
*
* @return 3rd level IRQ number
*/
static inline unsigned int irq_to_level_3(unsigned int irq)
{
return IRQ_TO_L3(irq);
}
/**
* @brief Returns the parent IRQ of the level 3 raw IRQ number
*
*
* The parent of a 3rd level interrupt is in the 2nd byte
*
* @param irq IRQ number in its zephyr format
*
* @return 3rd level IRQ parent
*/
static inline unsigned int irq_parent_level_3(unsigned int irq)
{
return (irq >> CONFIG_1ST_LEVEL_INTERRUPT_BITS) &
BIT_MASK(CONFIG_2ND_LEVEL_INTERRUPT_BITS);
}
#endif
#ifdef __cplusplus
}
#endif
#endif /* _ASMLANGUAGE */
#endif /* ZEPHYR_INCLUDE_IRQ_MULTILEVEL_H_ */

View File

@ -10,6 +10,7 @@
privileged architecture specification
*/
#include <zephyr/irq.h>
#include <zephyr/irq_multilevel.h>
#include <zephyr/drivers/interrupt_controller/riscv_clic.h>
#include <zephyr/drivers/interrupt_controller/riscv_plic.h>

View File

@ -7,6 +7,7 @@
#include <zephyr/kernel.h>
#include <zephyr/ztest.h>
#include <zephyr/irq.h>
#include <zephyr/irq_multilevel.h>
#include <zephyr/tc_util.h>
#include <zephyr/sw_isr_table.h>
#include <zephyr/interrupt_util.h>