qualcomm/qbox
Loading...
Searching...
No Matches
neoverse-n1.h
1/*
2 * This file is part of libqbox
3 * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All Rights Reserved.
4 * Author: GreenSocs 2020
5 *
6 * SPDX-License-Identifier: BSD-3-Clause
7 */
8
9#pragma once
10
11#include <string>
12
13#include <cci_configuration>
14
15#include <libqemu-cxx/target/aarch64.h>
16
17#include <tlm-extensions/exclusive-access.h>
18#include <module_factory_registery.h>
19
20#include <arm.h>
21#include <ports/qemu-initiator-signal-socket.h>
22#include <ports/qemu-target-signal-socket.h>
23#include <qemu-instance.h>
24
25class cpu_arm_neoverseN1 : public QemuCpuArm
26{
27protected:
28 int get_psci_conduit_val() const
29 {
30 if (p_psci_conduit.get_value() == "disabled") {
31 return 0;
32 } else if (p_psci_conduit.get_value() == "smc") {
33 return 1;
34 } else if (p_psci_conduit.get_value() == "hvc") {
35 return 2;
36 } else {
37 /* TODO: report warning */
38 return 0;
39 }
40 }
41
42 void add_exclusive_ext(TlmPayload& pl)
43 {
45 ext->add_hop(m_cpu.get_index());
46 pl.set_extension(ext);
47 }
48
49 static uint64_t extract_data_from_payload(const TlmPayload& pl)
50 {
51 uint8_t* ptr = pl.get_data_ptr() + pl.get_data_length() - 1;
52 uint64_t ret = 0;
53
54 /* QEMU never accesses more than 64 bits at the same time */
55 assert(pl.get_data_length() <= 8);
56
57 while (ptr >= pl.get_data_ptr()) {
58 ret = (ret << 8) | *(ptr--);
59 }
60
61 return ret;
62 }
63
64public:
65 cci::cci_param<unsigned int> p_mp_affinity;
66 cci::cci_param<bool> p_has_el2;
67 cci::cci_param<bool> p_has_el3;
68 cci::cci_param<bool> p_start_powered_off;
69 cci::cci_param<std::string> p_psci_conduit;
70 cci::cci_param<uint64_t> p_rvbar;
71 cci::cci_param<uint64_t> p_cntfrq_hz;
72
77
78 QemuInitiatorSignalSocket irq_timer_phys_out;
79 QemuInitiatorSignalSocket irq_timer_virt_out;
80 QemuInitiatorSignalSocket irq_timer_hyp_out;
81 QemuInitiatorSignalSocket irq_timer_sec_out;
82
83 cpu_arm_neoverseN1(const sc_core::sc_module_name& name, sc_core::sc_object* o)
84 : cpu_arm_neoverseN1(name, *(dynamic_cast<QemuInstance*>(o)))
85 {
86 }
87 cpu_arm_neoverseN1(sc_core::sc_module_name name, QemuInstance& inst)
88 : QemuCpuArm(name, inst, "neoverse-n1-arm")
89 , p_mp_affinity("mp_affinity", 0, "Multi-processor affinity value")
90 , p_has_el2("has_el2", true, "ARM virtualization extensions")
91 , p_has_el3("has_el3", true, "ARM secure-mode extensions")
92 , p_start_powered_off("start_powered_off", false,
93 "Start and reset the CPU "
94 "in powered-off state")
95 , p_psci_conduit("psci_conduit", "disabled",
96 "Set the QEMU PSCI conduit: "
97 "disabled->no conduit, "
98 "hvc->through hvc call, "
99 "smc->through smc call")
100 , p_rvbar("rvbar", 0ull, "Reset vector base address register value")
101 , p_cntfrq_hz("cntfrq_hz", 0ull, "CPU Generic Timer CNTFRQ in Hz")
102
103 , irq_in("irq_in")
104 , fiq_in("fiq_in")
105 , virq_in("virq_in")
106 , vfiq_in("vfiq_in")
107 , irq_timer_phys_out("irq_timer_phys_out")
108 , irq_timer_virt_out("irq_timer_virt_out")
109 , irq_timer_hyp_out("irq_timer_hyp_out")
110 , irq_timer_sec_out("irq_timer_sec_out")
111 {
112 m_external_ev |= irq_in->default_event();
113 m_external_ev |= fiq_in->default_event();
114 m_external_ev |= virq_in->default_event();
115 m_external_ev |= vfiq_in->default_event();
116 }
117
118 void before_end_of_elaboration() override
119 {
120 QemuCpuArm::before_end_of_elaboration();
121
122 qemu::CpuAarch64 cpu(m_cpu);
123 cpu.set_aarch64_mode(true);
124
125 if (!p_mp_affinity.is_default_value()) {
126 cpu.set_prop_int("mp-affinity", p_mp_affinity);
127 }
128 cpu.set_prop_bool("has_el2", p_has_el2);
129 cpu.set_prop_bool("has_el3", p_has_el3);
130 init_secure_memory(p_has_el3.get_value());
131
132 cpu.set_prop_bool("start-powered-off", p_start_powered_off);
133 cpu.set_prop_int("psci-conduit", get_psci_conduit_val());
134
135 cpu.set_prop_int("rvbar", p_rvbar);
136 if (!p_cntfrq_hz.is_default_value()) {
137 cpu.set_prop_int("cntfrq", p_cntfrq_hz);
138 }
139 }
140
141 void end_of_elaboration() override
142 {
143 QemuCpuArm::end_of_elaboration();
144
145 irq_in.init(m_dev, 0);
146 fiq_in.init(m_dev, 1);
147 virq_in.init(m_dev, 2);
148 vfiq_in.init(m_dev, 3);
149
150 irq_timer_phys_out.init(m_dev, 0);
151 irq_timer_virt_out.init(m_dev, 1);
152 irq_timer_hyp_out.init(m_dev, 2);
153 irq_timer_sec_out.init(m_dev, 3);
154 }
155
156 void initiator_customize_tlm_payload(TlmPayload& payload) override
157 {
158 uint64_t addr;
159 qemu::CpuAarch64 arm_cpu(m_cpu);
160
161 QemuCpu::initiator_customize_tlm_payload(payload);
162
163 addr = payload.get_address();
164
165 if (!arm_cpu.is_in_exclusive_context()) {
166 return;
167 }
168
169 if (addr != arm_cpu.get_exclusive_addr()) {
170 return;
171 }
172
173 /*
174 * We are in the load/store pair of the cmpxchg of the exclusive store
175 * implementation. Add the exclusive access extension to lock the
176 * memory and check for exclusive store success in
177 * initiator_tidy_tlm_payload.
178 */
179 add_exclusive_ext(payload);
180 }
181
182 void initiator_tidy_tlm_payload(TlmPayload& payload) override
183 {
184 using namespace tlm;
185
187 qemu::CpuAarch64 arm_cpu(m_cpu);
188
189 QemuCpu::initiator_tidy_tlm_payload(payload);
190
191 payload.get_extension(ext);
192 bool exit_tb = false;
193
194 if (ext == nullptr) {
195 return;
196 }
197
198 if (payload.get_command() == TLM_WRITE_COMMAND) {
199 auto sta = ext->get_exclusive_store_status();
200
201 /* We just executed an exclusive store. Check its status */
202 if (sta == ExclusiveAccessTlmExtension::EXCLUSIVE_STORE_FAILURE) {
203 /*
204 * To actually make the exclusive store fails, we need to trick
205 * QEMU into thinking that the value at the store address has
206 * changed compared to when it did the corresponding ldrex (due
207 * to the way exclusive loads/stores are implemented in QEMU).
208 * For this, we simply smash the exclusive_val field of the ARM
209 * CPU state in case it currently matches with the value in
210 * memory.
211 */
212 uint64_t exclusive_val = arm_cpu.get_exclusive_val();
213 uint64_t mem_val = extract_data_from_payload(payload);
214 uint64_t mask = (payload.get_data_length() == 8) ? -1 : (1 << (8 * payload.get_data_length())) - 1;
215
216 if ((exclusive_val & mask) == mem_val) {
217 arm_cpu.set_exclusive_val(~exclusive_val);
218
219 /*
220 * Exit the execution loop to force QEMU to re-do the
221 * store. This is necessary because we modify exclusive_val
222 * in the CPU env. This field is also mapped on a TCG
223 * global. Even though the qemu_st_ixx TCG opcs are marked
224 * TCG_OPF_CALL_CLOBBER, TCG does not reload the global
225 * after the store as I thought it would do. To force this,
226 * we exit the TB here so that the new exclusive_val value
227 * will be taken into account on the next execution.
228 */
229 exit_tb = true;
230 }
231
232 payload.set_response_status(TLM_OK_RESPONSE);
233 }
234 }
235
236 payload.clear_extension(ext);
237 delete ext;
238
239 if (exit_tb) {
240 /*
241 * FIXME: exiting the CPU loop from here is a bit violent. The
242 * caller won't have a chance to destruct its stack objects. The
243 * object model should be reworked to allow exiting the loop
244 * cleanly.
245 */
246 m_cpu.exit_loop_from_io();
247 }
248 }
249};
250
251extern "C" void module_register();
Exclusive load/store TLM extension.
Definition exclusive-access.h:36
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 aarch64.h:40