|
| 1 | +use crate::{svd::Peripheral, util, Config}; |
| 2 | +use anyhow::{anyhow, Context, Result}; |
| 3 | +use log::debug; |
| 4 | +use proc_macro2::{Span, TokenStream}; |
| 5 | +use quote::quote; |
| 6 | +use svd_parser::svd::{Access, Register}; |
| 7 | + |
| 8 | +/// Whole AVR-specific generation. |
| 9 | +/// |
| 10 | +/// SVD files for AVR devices carry no information about the configuration |
| 11 | +/// change protection (CCP) mechanism of modern (xmega based) AVR cores, so the |
| 12 | +/// list of protected registers and their unlock magic comes from the settings |
| 13 | +/// file ([`crate::config::avr::AvrConfig`]). Here we translate that list into |
| 14 | +/// `UnlockRegister` and `Protected` trait implementations for the generated |
| 15 | +/// register types, so that protected registers can be written with |
| 16 | +/// `write_protected`/`modify_protected` from `generic_avr_ccp.rs`. |
| 17 | +pub fn render(peripherals: &[Peripheral], config: &Config) -> Result<TokenStream> { |
| 18 | + let mut mod_items = TokenStream::new(); |
| 19 | + |
| 20 | + let Some(ccp) = config |
| 21 | + .settings |
| 22 | + .avr_config |
| 23 | + .as_ref() |
| 24 | + .and_then(|avr| avr.ccp.as_ref()) |
| 25 | + else { |
| 26 | + return Ok(mod_items); |
| 27 | + }; |
| 28 | + |
| 29 | + debug!("Rendering AVR configuration change protection impls"); |
| 30 | + |
| 31 | + // The unlock register itself is not listed as protected in the SVD either; |
| 32 | + // its data-space address is all the unlock sequence needs, and we can |
| 33 | + // derive that from the SVD instead of asking for it in the settings file. |
| 34 | + let (unlock_periph, unlock_reg, unlock_addr) = |
| 35 | + resolve_register(peripherals, &ccp.unlock_register) |
| 36 | + .context("can't resolve CCP unlock register")?; |
| 37 | + let unlock_spec = register_spec_path(unlock_periph, unlock_reg, config); |
| 38 | + let unlock_addr = util::hex(unlock_addr); |
| 39 | + |
| 40 | + mod_items.extend(quote! { |
| 41 | + impl crate::UnlockRegister for #unlock_spec { |
| 42 | + const PTR: *mut u8 = #unlock_addr as *mut u8; |
| 43 | + } |
| 44 | + }); |
| 45 | + |
| 46 | + for protected in &ccp.protected_registers { |
| 47 | + let (periph, reg, _) = resolve_register(peripherals, &protected.register) |
| 48 | + .with_context(|| format!("can't resolve protected register {}", protected.register))?; |
| 49 | + |
| 50 | + // The unlock sequence in `generic_avr_ccp.rs` only supports 8-bit |
| 51 | + // writable registers (`RegisterSpec<Ux = u8> + Writable`); catch |
| 52 | + // mismatches here instead of failing later in the PAC build. Size and |
| 53 | + // access are usually inherited defaults on AVR SVDs, so only reject |
| 54 | + // explicit contradictions. |
| 55 | + if let Some(size) = reg.properties.size { |
| 56 | + if size != 8 { |
| 57 | + return Err(anyhow!( |
| 58 | + "protected register {} is {} bits wide; only 8-bit registers are supported", |
| 59 | + protected.register, |
| 60 | + size |
| 61 | + )); |
| 62 | + } |
| 63 | + } |
| 64 | + if reg.properties.access == Some(Access::ReadOnly) { |
| 65 | + return Err(anyhow!( |
| 66 | + "protected register {} is read-only", |
| 67 | + protected.register |
| 68 | + )); |
| 69 | + } |
| 70 | + |
| 71 | + let reg_spec = register_spec_path(periph, reg, config); |
| 72 | + // Emit the magic as a hex literal so the generated code matches the |
| 73 | + // datasheet notation (0x9D/0xD8) instead of decimal. |
| 74 | + let magic = util::hex(protected.magic as u64); |
| 75 | + |
| 76 | + mod_items.extend(quote! { |
| 77 | + impl crate::Protected for #reg_spec { |
| 78 | + const MAGIC: u8 = #magic; |
| 79 | + type CcpReg = #unlock_spec; |
| 80 | + } |
| 81 | + }); |
| 82 | + } |
| 83 | + |
| 84 | + Ok(mod_items) |
| 85 | +} |
| 86 | + |
| 87 | +/// Look up a `PERIPHERAL.REGISTER` path from the settings file in the SVD and |
| 88 | +/// return the peripheral, the register and the register's data-space address. |
| 89 | +/// |
| 90 | +/// Registers of derived peripherals are found on the base peripheral, but the |
| 91 | +/// address is computed from the derived peripheral's own base address. |
| 92 | +fn resolve_register<'a>( |
| 93 | + peripherals: &'a [Peripheral], |
| 94 | + path: &str, |
| 95 | +) -> Result<(&'a Peripheral, &'a Register, u64)> { |
| 96 | + let (periph_name, reg_name) = path.split_once('.').ok_or_else(|| { |
| 97 | + anyhow!("register path `{path}` must have the form `PERIPHERAL.REGISTER`") |
| 98 | + })?; |
| 99 | + |
| 100 | + let periph = peripherals |
| 101 | + .iter() |
| 102 | + .find(|p| p.name == periph_name) |
| 103 | + .ok_or_else(|| anyhow!("no peripheral named `{periph_name}` in the SVD"))?; |
| 104 | + |
| 105 | + // Follow `derivedFrom` (once, as mandated by the SVD spec) in case the |
| 106 | + // peripheral inherits its registers from another one. |
| 107 | + let base = match periph.derived_from.as_deref() { |
| 108 | + Some(base_name) => peripherals |
| 109 | + .iter() |
| 110 | + .find(|p| p.name == base_name) |
| 111 | + .ok_or_else(|| { |
| 112 | + anyhow!("peripheral `{periph_name}` is derived from unknown `{base_name}`") |
| 113 | + })?, |
| 114 | + None => periph, |
| 115 | + }; |
| 116 | + |
| 117 | + let reg = base |
| 118 | + .registers() |
| 119 | + .find(|r| r.name == reg_name) |
| 120 | + .ok_or_else(|| anyhow!("no register named `{reg_name}` in peripheral `{periph_name}`"))?; |
| 121 | + |
| 122 | + let address = periph.base_address + reg.address_offset as u64; |
| 123 | + Ok((periph, reg, address)) |
| 124 | +} |
| 125 | + |
| 126 | +/// Build the module-relative path to a register's spec type, e.g. |
| 127 | +/// `cpu::ccp::CCP_SPEC`. The impls are emitted at the top level of the device |
| 128 | +/// module where all peripheral modules are siblings, so no crate-level prefix |
| 129 | +/// is needed. |
| 130 | +fn register_spec_path(periph: &Peripheral, reg: &Register, config: &Config) -> TokenStream { |
| 131 | + let span = Span::call_site(); |
| 132 | + let periph_mod = util::ident(&periph.name, config, "peripheral_mod", span); |
| 133 | + let reg_mod = util::ident(®.name, config, "register_mod", span); |
| 134 | + let reg_spec = util::ident(®.name, config, "register_spec", span); |
| 135 | + quote! { #periph_mod::#reg_mod::#reg_spec } |
| 136 | +} |
0 commit comments