use paperpaw_sdk::native::{INTERFACE, Native};
pub(crate) const FAMILIES: usize = 8;
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub(crate) struct Needs {
pub interface: Option<u16>,
pub api: Option<u32>,
pub families: Option<[u16; FAMILIES]>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum Fit {
Yes,
Newer,
Older,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct Provides {
pub api: u32,
pub families: [u16; FAMILIES],
pub oldest: [u16; FAMILIES],
pub checks_families: bool,
}
impl Provides {
pub(crate) fn of(native: &Native) -> Self {
Self {
api: native.api_size,
families: native.family_revs,
oldest: native.family_min,
checks_families: native.toolchain.contains("riscv32"),
}
}
pub(crate) fn fit(&self, needs: &Needs) -> Fit {
let interface = needs.interface.unwrap_or(INTERFACE);
if interface < INTERFACE {
return Fit::Older;
}
let mut older = false;
let mut newer = interface > INTERFACE || needs.api.is_some_and(|api| api > self.api);
let used = needs.families.filter(|_| self.checks_families);
if let Some(used) = used {
for (i, &rev) in used.iter().enumerate().filter(|(_, rev)| **rev != 0) {
newer |= rev > self.families[i];
older |= rev < self.oldest[i];
}
}
if newer {
Fit::Newer
} else if older {
Fit::Older
} else {
Fit::Yes
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use paperpaw_sdk::PluginProblem;
use paperpaw_sdk::native::{Chip, Header};
fn provides() -> Provides {
Provides {
api: 400,
families: [3, 2, 0, 0, 0, 0, 0, 0],
oldest: [2, 1, 0, 0, 0, 0, 0, 0],
checks_families: true,
}
}
fn needing(api: u32, families: [u16; 8]) -> Needs {
Needs {
interface: Some(INTERFACE),
api: Some(api),
families: Some(families),
}
}
#[test]
fn a_build_that_says_nothing_fits_as_before() {
assert_eq!(provides().fit(&Needs::default()), Fit::Yes);
let odd = Needs {
families: None,
api: Some(401),
..Needs::default()
};
assert_eq!(provides().fit(&odd), Fit::Newer);
}
#[test]
fn what_the_firmware_lacks_is_a_newer_paperpaw() {
let p = provides();
assert_eq!(p.fit(&needing(400, [3, 2, 0, 0, 0, 0, 0, 0])), Fit::Yes);
assert_eq!(p.fit(&needing(0, [2, 0, 0, 0, 0, 0, 0, 0])), Fit::Yes);
assert_eq!(p.fit(&needing(404, [0; 8])), Fit::Newer);
assert_eq!(p.fit(&needing(400, [4, 0, 0, 0, 0, 0, 0, 0])), Fit::Newer);
assert_eq!(p.fit(&needing(400, [0, 0, 1, 0, 0, 0, 0, 0])), Fit::Newer);
let later = Needs {
interface: Some(INTERFACE + 1),
..Needs::default()
};
assert_eq!(p.fit(&later), Fit::Newer);
}
#[test]
fn what_was_built_before_the_oldest_still_run_is_not_offered() {
let p = provides();
assert_eq!(p.fit(&needing(0, [1, 0, 0, 0, 0, 0, 0, 0])), Fit::Older);
let before = Needs {
interface: Some(INTERFACE - 1),
..Needs::default()
};
assert_eq!(p.fit(&before), Fit::Older);
assert_eq!(p.fit(&needing(500, [1, 0, 0, 0, 0, 0, 0, 0])), Fit::Newer);
}
#[test]
fn it_says_what_the_firmware_says_of_the_file() {
for (chip, toolchain) in [
(Chip::Esp32C3, "rustc 1.99.0, riscv32imc-unknown-none-elf"),
(Chip::Esp32S3, "esp 1.97.0.0, xtensa-esp32s3-none-elf"),
] {
let mut native = Native::new("code.ppn");
native.toolchain = toolchain.into();
native.api_size = 400;
native.family_revs = [3, 2, 0, 0, 0, 0, 0, 0];
native.family_min = [2, 1, 0, 0, 0, 0, 0, 0];
let provides = Provides::of(&native);
assert_eq!(provides.checks_families, chip == Chip::Esp32C3);
let base = Header {
chip,
fingerprint: native.fingerprint.0,
base: 0,
image_len: 0,
code_at: 0,
entry: 0,
api: 0,
relocs: 0,
align: 4,
compiler: 0,
hot_at: 0,
hot_len: 0,
patches: 0,
needs_api: 0,
families: [0; 8],
interface: INTERFACE,
sha256: [0; 32],
};
for (api, families) in [
(400, [3, 2, 0, 0, 0, 0, 0, 0]),
(404, [0; 8]),
(400, [4, 0, 0, 0, 0, 0, 0, 0]),
(400, [0, 0, 1, 0, 0, 0, 0, 0]),
(0, [1, 0, 0, 0, 0, 0, 0, 0]),
(0, [2, 1, 0, 0, 0, 0, 0, 0]),
] {
let file = Header {
needs_api: api,
families,
..base
};
let problem = native.problem(&file);
let fit = provides.fit(&needing(api, families));
let said = match fit {
Fit::Yes => None,
Fit::Newer => Some(PluginProblem::NeedsNewerPaperPaw),
Fit::Older => Some(PluginProblem::OlderInterface {
built_for: INTERFACE,
}),
};
assert_eq!(problem, said, "{chip:?} {api} {families:?}");
}
}
}
}