qualcomm/qbox
Loading...
Searching...
No Matches
aplic-sifive.h
1/*
2 * Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause-Clear
5 */
6
7#ifndef _LIBQBOX_COMPONENTS_IRQ_CTRL_APLIC_SIFIVE_H
8#define _LIBQBOX_COMPONENTS_IRQ_CTRL_APLIC_SIFIVE_H
9
10#include <string>
11#include <cassert>
12
13#include <cci_configuration>
14
15#include <libqemu-cxx/target/riscv.h>
16#include <module_factory_registery.h>
17#include <device.h>
18
19#include <ports/target.h>
20#include <ports/qemu-target-signal-socket.h>
21#include <ports/qemu-initiator-signal-socket.h>
22
23/*
24 * aplic_sifive — QBox wrapper for the libqemu "riscv.aplic" device (RISC-V AIA
25 * Advanced Platform-Level Interrupt Controller).
26 *
27 * Direct-delivery mode (msimode=false): IRQ sources enter on irq_in[0..num_irqs-1]
28 * (gpio_in); one irq_out per hart drives MEIP (mmode=true) or SEIP (mmode=false).
29 *
30 * Not yet modelled: MSI mode (needs an IMSIC peer; irq_out stays empty) and the
31 * M/S APLIC domain hierarchy (riscv_aplic_add_child).
32 */
33class aplic_sifive : public QemuDevice
34{
35public:
36 /* CCI parameters — map 1:1 to libqemu "riscv.aplic" device properties. */
37
38 /* APLIC register window size in bytes; APLIC_SIZE(n) = 0x4000 + align32(32 * n). */
39 cci::cci_param<uint64_t> p_aperture_size;
40 /* Hart ID of the first hart served by this domain. */
41 cci::cci_param<unsigned int> p_hartid_base;
42 /* Number of harts served by this domain. */
43 cci::cci_param<unsigned int> p_num_harts;
44 /* Interrupt-priority mask = (1 << iprio_bits) - 1 (e.g. 0xFF for 8-bit). */
45 cci::cci_param<unsigned int> p_iprio_mask;
46 /* Number of interrupt sources (libqemu stores num_sources+1; +1 added below). */
47 cci::cci_param<unsigned int> p_num_irqs;
48 /* false = direct-delivery (MEIP/SEIP); true = MSI mode (needs IMSIC). */
49 cci::cci_param<bool> p_msimode;
50 /* true = M-mode domain (MEIP); false = S-mode domain (SEIP). */
51 cci::cci_param<bool> p_mmode;
52
53 /* Ports */
54
55 /* APLIC register window (sysbus MMIO index 0). */
56 QemuTargetSocket<> socket;
57 /* IRQ sources (gpio_in, 0..num_irqs-1); root domain only. */
58 sc_core::sc_vector<QemuTargetSignalSocket> irq_in;
59 /* Per-hart outputs (gpio_out) to MEIP/SEIP; empty in MSI mode. */
60 sc_core::sc_vector<QemuInitiatorSignalSocket> irq_out;
61
62 aplic_sifive(const sc_core::sc_module_name& name, sc_core::sc_object* o)
63 : aplic_sifive(name, *(dynamic_cast<QemuInstance*>(o)))
64 {
65 }
66
67 aplic_sifive(sc_core::sc_module_name nm, QemuInstance& inst)
68 : QemuDevice(nm, inst, "riscv.aplic")
69 , p_aperture_size("aperture_size", 0, "APLIC register window size in bytes")
70 , p_hartid_base("hartid_base", 0, "Hart ID of the first hart in this domain")
71 , p_num_harts("num_harts", 0, "Number of harts served by this domain")
72 , p_iprio_mask("iprio_mask", 0xFF, "Interrupt-priority mask = (1 << iprio_bits) - 1")
73 , p_num_irqs("num_irqs", 0, "Number of interrupt sources")
74 , p_msimode("msimode", false, "false = direct (MEIP/SEIP); true = MSI mode")
75 , p_mmode("mmode", true, "true = M-mode (MEIP); false = S-mode (SEIP)")
76 , socket("mem", inst)
77 , irq_in("irq_in", p_num_irqs, [](const char* n, int) { return new QemuTargetSignalSocket(n); })
78 , irq_out("irq_out", p_num_harts, [](const char* n, int) { return new QemuInitiatorSignalSocket(n); })
79 {
80 }
81
82 void before_end_of_elaboration() override
83 {
84 QemuDevice::before_end_of_elaboration();
85
86 m_dev.set_prop_int("aperture-size", p_aperture_size);
87 m_dev.set_prop_int("hartid-base", p_hartid_base);
88 m_dev.set_prop_int("num-harts", p_num_harts);
89 m_dev.set_prop_int("iprio-mask", p_iprio_mask);
90 m_dev.set_prop_int("num-irqs", p_num_irqs + 1); /* libqemu stores num_sources+1 */
91 m_dev.set_prop_bool("msimode", p_msimode);
92 m_dev.set_prop_bool("mmode", p_mmode);
93 }
94
95 void end_of_elaboration() override
96 {
97 QemuDevice::set_sysbus_as_parent_bus();
98 QemuDevice::end_of_elaboration();
99
100 qemu::SysBusDevice sbd(get_qemu_dev());
101
102 socket.init(sbd, 0);
103
104 /* IRQ sources (gpio_in); root domain only. */
105 for (unsigned int i = 0; i < p_num_irqs; i++) {
106 irq_in[i].init(m_dev, i);
107 }
108
109 /*
110 * Per-hart outputs. riscv.aplic exposes these as gpio-out
111 * (qdev_init_gpio_out), not sysbus IRQs — so use init(m_dev, i), not
112 * init_sbd(). Skipped in MSI mode, where no gpio_out lines are created.
113 */
114 if (!p_msimode) {
115 for (unsigned int i = 0; i < p_num_harts; i++) {
116 irq_out[i].init(m_dev, i);
117 }
118 }
119 }
120};
121
122extern "C" void module_register();
123
124#endif /* _LIBQBOX_COMPONENTS_IRQ_CTRL_APLIC_SIFIVE_H */
QemuDevice(const sc_core::sc_module_name &name, QemuInstance &inst, const char *qom_type)
Construct a QEMU device.
Definition device.h:86
A QEMU output GPIO exposed as a InitiatorSignalSocket<bool>.
Definition qemu-initiator-signal-socket.h:40
This class encapsulates a libqemu-cxx qemu::LibQemu instance. It handles QEMU parameters and instance...
Definition qemu-instance.h:89
A QEMU input GPIO exposed as a TargetSignalSocket<bool>.
Definition qemu-target-signal-socket.h:29
Definition target.h:194
Definition libqemu-cxx.h:699