riscv_aplic.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright The Zephyr Project Contributors
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_INTERRUPT_CONTROLLER_RISCV_APLIC_H_
#define ZEPHYR_INCLUDE_DRIVERS_INTERRUPT_CONTROLLER_RISCV_APLIC_H_
 
#include <zephyr/device.h>
#include <zephyr/types.h>

#define APLIC_DOMAINCFG      0x0000
#define APLIC_SOURCECFG_BASE 0x0004
#define APLIC_SETIP_BASE     0x1C00
#define APLIC_SETIPNUM       0x1CDC
#define APLIC_CLRIP_BASE     0x1D00
#define APLIC_CLRIPNUM       0x1DDC
#define APLIC_SETIE_BASE     0x1E00
#define APLIC_SETIENUM       0x1EDC
#define APLIC_CLRIE_BASE     0x1F00
#define APLIC_CLRIENUM       0x1FDC
#define APLIC_MSIADDRCFG     0x1BC0
#define APLIC_MSIADDRCFGH    0x1BC4
#define APLIC_SMSIADDRCFG    0x1BC8
#define APLIC_SMSIADDRCFGH   0x1BCC
#define APLIC_GENMSI         0x3000
#define APLIC_TARGET_BASE    0x3004
#define APLIC_IDC_BASE       0x4000

#define APLIC_DOMAINCFG_IE BIT(8)
#define APLIC_DOMAINCFG_DM BIT(2)
#define APLIC_DOMAINCFG_BE BIT(0)

#define APLIC_MSIADDRCFGH_L_BIT      31
#define APLIC_MSIADDRCFGH_HHXS_SHIFT 24
#define APLIC_MSIADDRCFGH_HHXS_MASK  0x1F
#define APLIC_MSIADDRCFGH_LHXS_SHIFT 20
#define APLIC_MSIADDRCFGH_LHXS_MASK  0x7
#define APLIC_MSIADDRCFGH_HHXW_SHIFT 16
#define APLIC_MSIADDRCFGH_HHXW_MASK  0x7
#define APLIC_MSIADDRCFGH_LHXW_SHIFT 12
#define APLIC_MSIADDRCFGH_LHXW_MASK  0xF
#define APLIC_MSIADDRCFGH_BAPPN_MASK 0xFFF

#define APLIC_SOURCECFG_D_BIT   10
#define APLIC_SOURCECFG_SM_MASK 0x7
#define APLIC_SM_INACTIVE       0x0
#define APLIC_SM_DETACHED       0x1
#define APLIC_SM_EDGE_RISE      0x4
#define APLIC_SM_EDGE_FALL      0x5
#define APLIC_SM_LEVEL_HIGH     0x6
#define APLIC_SM_LEVEL_LOW      0x7

#define APLIC_TARGET_HART_SHIFT 18
#define APLIC_TARGET_HART_MASK  0x3FFF
#define APLIC_TARGET_MSI_DEL    BIT(11)
#define APLIC_TARGET_EIID_MASK  0x7FF

#define APLIC_GENMSI_HART_SHIFT    18
#define APLIC_GENMSI_HART_MASK     0x3FFF
#define APLIC_GENMSI_CONTEXT_SHIFT 13
#define APLIC_GENMSI_CONTEXT_MASK  0x1F
#define APLIC_GENMSI_BUSY          BIT(12)
#define APLIC_GENMSI_MMSI_MODE     BIT(11)
#define APLIC_GENMSI_EIID_MASK     0x7FF

#define APLIC_IDC_IDELIVERY_OFFSET  0x0
#define APLIC_IDC_IFORCE_OFFSET     0x4
#define APLIC_IDC_ITHRESHOLD_OFFSET 0x8
#define APLIC_IDC_TOPI_OFFSET       0x18
#define APLIC_IDC_CLAIMI_OFFSET     0x1C
#define APLIC_IDC_STRUCT_SIZE       0x20

#define APLIC_IDC_IDELIVERY_ENABLE BIT(0)

#define APLIC_IDC_IFORCE_SET 1

#define APLIC_IDC_ITHRESHOLD 0

#define APLIC_IPRIO_MASK               0xFF
#define APLIC_INTERRUPT_IDENTITY_SHIFT 16
#define APLIC_INTERRUPT_IDENTITY_MASK  (BIT_MASK(10) << APLIC_INTERRUPT_IDENTITY_SHIFT)

static inline uint32_t aplic_sourcecfg_off(unsigned int src)
{
        return APLIC_SOURCECFG_BASE + (src - 1U) * 4U;
}

static inline uint32_t aplic_target_off(unsigned int src)
{
        return APLIC_TARGET_BASE + (src - 1U) * 4U;
}

static inline const struct device *riscv_aplic_get_dev(void)
{
        return DEVICE_DT_GET_ANY(riscv_aplic);
}

int riscv_aplic_domain_enable(const struct device *dev, bool enable);

int riscv_aplic_config_src(const struct device *dev, unsigned int src, unsigned int sm);

int riscv_aplic_enable_src(const struct device *dev, unsigned int src, bool enable);
 
#if defined(CONFIG_RISCV_APLIC_MSI) || defined(__DOXYGEN__)
int riscv_aplic_msi_route(const struct device *dev, unsigned int src, uint32_t hart, uint32_t eiid);

int riscv_aplic_msi_inject_software_interrupt(const struct device *dev, uint32_t eiid,
                                              uint32_t hart_id, uint32_t context);
#endif /* CONFIG_RISCV_APLIC_MSI */

uint32_t riscv_aplic_get_num_sources(const struct device *dev);

static inline void riscv_aplic_enable_source(unsigned int src)
{
        riscv_aplic_enable_src(riscv_aplic_get_dev(), src, true);
}

static inline void riscv_aplic_disable_source(unsigned int src)
{
        riscv_aplic_enable_src(riscv_aplic_get_dev(), src, false);
}
 
#if defined(CONFIG_RISCV_APLIC_MSI) || defined(__DOXYGEN__)
static inline void riscv_aplic_msi_inject_genmsi(uint32_t hart, uint32_t eiid)
{
        riscv_aplic_msi_inject_software_interrupt(riscv_aplic_get_dev(), eiid, hart, 0);
}
#endif /* CONFIG_RISCV_APLIC_MSI */
 
#if defined(CONFIG_RISCV_APLIC_DIRECT) || defined(__DOXYGEN__)
static inline uint32_t aplic_idelivery_off(unsigned int cpu)
{
        return APLIC_IDC_BASE + (cpu * APLIC_IDC_STRUCT_SIZE) + APLIC_IDC_IDELIVERY_OFFSET;
}

static inline uint32_t aplic_ithreshold_off(unsigned int cpu)
{
        return APLIC_IDC_BASE + (cpu * APLIC_IDC_STRUCT_SIZE) + APLIC_IDC_ITHRESHOLD_OFFSET;
}

static inline uint32_t aplic_iforce_off(unsigned int cpu)
{
        return APLIC_IDC_BASE + (cpu * APLIC_IDC_STRUCT_SIZE) + APLIC_IDC_IFORCE_OFFSET;
}

static inline uint32_t aplic_topi_off(unsigned int cpu)
{
        return APLIC_IDC_BASE + (cpu * APLIC_IDC_STRUCT_SIZE) + APLIC_IDC_TOPI_OFFSET;
}

static inline uint32_t aplic_claimi_off(unsigned int cpu)
{
        return APLIC_IDC_BASE + (cpu * APLIC_IDC_STRUCT_SIZE) + APLIC_IDC_CLAIMI_OFFSET;
}
#endif /* CONFIG_RISCV_APLIC_DIRECT */
 
#endif