1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
use crate::{svd::Peripheral, util, Config, Settings};
use anyhow::Result;
use log::debug;
use proc_macro2::{Span, TokenStream};
use quote::quote;
use std::{collections::HashMap, fmt::Write, str::FromStr};
pub fn is_riscv_peripheral(p: &Peripheral, s: &Settings) -> bool {
// TODO cleaner implementation of this
match &s.riscv_config {
Some(c) => {
c.clint.as_ref().is_some_and(|clint| clint.name == p.name)
|| c.plic.as_ref().is_some_and(|plic| plic.name == p.name)
}
_ => false,
}
}
/// Whole RISC-V generation
pub fn render(
peripherals: &[Peripheral],
device_x: &mut String,
config: &Config,
) -> Result<TokenStream> {
let mut mod_items = TokenStream::new();
let defmt = config
.impl_defmt
.as_ref()
.map(|feature| quote!(#[cfg_attr(feature = #feature, derive(defmt::Format))]));
if let Some(c) = config.settings.riscv_config.as_ref() {
if !c.core_interrupts.is_empty() {
debug!("Rendering target-specific core interrupts");
writeln!(device_x, "/* Core interrupt sources and trap handlers */")?;
let mut interrupts = vec![];
for interrupt in c.core_interrupts.iter() {
let name = TokenStream::from_str(&interrupt.name).unwrap();
let value = TokenStream::from_str(&format!("{}", interrupt.value)).unwrap();
let description = interrupt.description();
writeln!(device_x, "PROVIDE({name} = DefaultHandler);")?;
writeln!(
device_x,
"PROVIDE(_start_{name}_trap = _start_DefaultHandler_trap);"
)?;
interrupts.push(quote! {
#[doc = #description]
#name = #value,
});
}
mod_items.extend(quote! {
/// Core interrupts. These interrupts are handled by the core itself.
#[riscv::pac_enum(unsafe CoreInterruptNumber)]
#defmt
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CoreInterrupt {
#(#interrupts)*
}
});
} else {
// when no interrupts are defined, we re-export the standard riscv interrupts
mod_items.extend(quote! {pub use riscv::interrupt::Interrupt as CoreInterrupt;});
}
if !c.exceptions.is_empty() {
debug!("Rendering target-specific exceptions");
writeln!(device_x, "/* Exception sources */")?;
let mut exceptions = vec![];
for exception in c.exceptions.iter() {
let name = TokenStream::from_str(&exception.name).unwrap();
let value = TokenStream::from_str(&format!("{}", exception.value)).unwrap();
let description = exception.description();
writeln!(device_x, "PROVIDE({name} = ExceptionHandler);")?;
exceptions.push(quote! {
#[doc = #description]
#name = #value,
});
}
mod_items.extend(quote! {
/// Exception sources in the device.
#[riscv::pac_enum(unsafe ExceptionNumber)]
#defmt
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Exception {
#(#exceptions)*
}
});
} else {
// when no exceptions are defined, we re-export the standard riscv exceptions
mod_items.extend(quote! { pub use riscv::interrupt::Exception; });
}
if !c.priorities.is_empty() {
debug!("Rendering target-specific priority levels");
let priorities = c.priorities.iter().map(|priority| {
let name = TokenStream::from_str(&priority.name).unwrap();
let value = TokenStream::from_str(&format!("{}", priority.value)).unwrap();
let description = priority.description();
quote! {
#[doc = #description]
#name = #value,
}
});
mod_items.extend(quote! {
/// Priority levels in the device
#[riscv::pac_enum(unsafe PriorityNumber)]
#defmt
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Priority {
#(#priorities)*
}
});
}
if !c.harts.is_empty() {
debug!("Rendering target-specific HART IDs");
let harts = c.harts.iter().map(|hart| {
let name = TokenStream::from_str(&hart.name).unwrap();
let value = TokenStream::from_str(&format!("{}", hart.value)).unwrap();
let description = hart.description();
quote! {
#[doc = #description]
#name = #value,
}
});
mod_items.extend(quote! {
/// HARTs in the device
#[riscv::pac_enum(unsafe HartIdNumber)]
#defmt
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Hart {
#(#harts)*
}
});
}
} else {
// when no riscv block is defined, we re-export the standard riscv interrupt and exception enums
mod_items.extend(quote! {
pub use riscv::interrupt::{Interrupt as CoreInterrupt, Exception};
});
}
mod_items.extend(quote! {
pub use riscv::{
InterruptNumber, ExceptionNumber, PriorityNumber, HartIdNumber,
interrupt::{enable, disable, free, nested}
};
pub type Trap = riscv::interrupt::Trap<CoreInterrupt, Exception>;
/// Retrieves the cause of a trap in the current hart.
///
/// If the raw cause is not a valid interrupt or exception for the target, it returns an error.
#[inline]
pub fn try_cause() -> riscv::result::Result<Trap> {
riscv::interrupt::try_cause()
}
/// Retrieves the cause of a trap in the current hart (machine mode).
///
/// If the raw cause is not a valid interrupt or exception for the target, it panics.
#[inline]
pub fn cause() -> Trap {
try_cause().unwrap()
}
});
let external_interrupts = peripherals
.iter()
.flat_map(|p| p.interrupt.iter())
.map(|i| (i.value, i))
.collect::<HashMap<_, _>>();
let mut external_interrupts = external_interrupts.into_values().collect::<Vec<_>>();
external_interrupts.sort_by_key(|i| i.value);
if !external_interrupts.is_empty() {
debug!("Rendering target-specific external interrupts");
writeln!(device_x, "/* External interrupt sources */")?;
let mut interrupts = vec![];
for i in external_interrupts.iter() {
let name = TokenStream::from_str(&i.name).unwrap();
let value = TokenStream::from_str(&format!("{}", i.value)).unwrap();
let description = format!(
"{} - {}",
i.value,
i.description
.as_ref()
.map(|s| util::respace(s))
.as_ref()
.map(|s| util::escape_special_chars(s))
.unwrap_or_else(|| i.name.as_str().into())
);
writeln!(device_x, "PROVIDE({name} = DefaultHandler);")?;
interrupts.push(quote! {
#[doc = #description]
#name = #value,
})
}
mod_items.extend(quote! {
/// External interrupts. These interrupts are handled by the external peripherals.
#[riscv::pac_enum(unsafe ExternalInterruptNumber)]
#defmt
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ExternalInterrupt {
#(#interrupts)*
}
});
}
let mut riscv_peripherals = TokenStream::new();
if let Some(c) = config.settings.riscv_config.as_ref() {
let harts = c
.harts
.iter()
.map(|h| (TokenStream::from_str(&h.name).unwrap(), h.value))
.collect::<Vec<_>>();
let harts = match harts.len() {
0 => quote! {},
_ => {
let harts = harts
.iter()
.map(|(name, value)| {
let value = TokenStream::from_str(&format!("{value}")).unwrap();
quote! {crate::interrupt::Hart::#name => #value}
})
.collect::<Vec<_>>();
quote! {
harts [#(#harts),*]
}
}
};
if let Some(clint) = &c.clint {
let p = peripherals.iter().find(|&p| p.name == clint.name).unwrap();
let span = Span::call_site();
let vis = match clint.pub_new {
true => quote! {pub},
false => quote! {},
};
let name = util::ident(&p.name, config, "peripheral", span);
let base = TokenStream::from_str(&format!("base 0x{:X},", p.base_address)).unwrap();
let freq = TokenStream::from_str(&format!("mtime_freq {},", clint.mtime_freq)).unwrap();
riscv_peripherals.extend(quote! {
riscv_peripheral::clint_codegen!(#vis #name, #base #freq #harts);
impl #name {
/// Steal an instance of this peripheral
///
/// # Safety
///
/// Ensure that the new instance of the peripheral cannot be used in a way
/// that may race with any existing instances, for example by only
/// accessing read-only or write-only registers, or by consuming the
/// original peripheral and using critical sections to coordinate
/// access between multiple new instances.
///
/// Additionally, other software such as HALs may rely on only one
/// peripheral instance existing to ensure memory safety; ensure
/// no stolen instances are passed to such software.
#[inline]
pub unsafe fn steal() -> Self {
Self::new()
}
}
});
}
if let Some(plic) = &c.plic {
let p = peripherals.iter().find(|&p| p.name == plic.name).unwrap();
let span = Span::call_site();
let vis = match plic.pub_new {
true => quote! {pub},
false => quote! {},
};
let name = util::ident(&p.name, config, "peripheral", span);
let base = TokenStream::from_str(&format!("base 0x{:X},", p.base_address)).unwrap();
riscv_peripherals.extend(quote! {
riscv_peripheral::plic_codegen!(#vis #name, #base #harts);
impl #name {
/// Steal an instance of this peripheral
///
/// # Safety
///
/// Ensure that the new instance of the peripheral cannot be used in a way
/// that may race with any existing instances, for example by only
/// accessing read-only or write-only registers, or by consuming the
/// original peripheral and using critical sections to coordinate
/// access between multiple new instances.
///
/// Additionally, other software such as HALs may rely on only one
/// peripheral instance existing to ensure memory safety; ensure
/// no stolen instances are passed to such software.
#[inline]
pub unsafe fn steal() -> Self {
Self::new()
}
}
});
if let Some(core_interrupt) = &plic.core_interrupt {
let core_interrupt = TokenStream::from_str(core_interrupt).unwrap();
let ctx = match &plic.hart_id {
Some(hart_id) => {
TokenStream::from_str(&format!("ctx(Hart::{hart_id})")).unwrap()
}
None => quote! { ctx_mhartid() },
};
mod_items.extend(quote! {
#[cfg(feature = "rt")]
#[riscv_rt::core_interrupt(CoreInterrupt::#core_interrupt)]
unsafe fn plic_handler() {
let plic = unsafe { crate::#name::steal() };
let claim = plic.#ctx.claim();
if let Some(s) = claim.claim::<ExternalInterrupt>() {
unsafe { _dispatch_external_interrupt(s.number()) }
claim.complete(s);
}
}
});
}
}
}
Ok(quote! {
/// Interrupt numbers, priority levels, and HART IDs.
pub mod interrupt {
#mod_items
}
#riscv_peripherals
})
}