|
| 1 | +#![cfg_attr(not(feature = "std"), no_std)] |
| 2 | + |
| 3 | +pub const SERIAL_PROTOCOL_VERSION: u16 = 1; |
| 4 | +pub const SERIAL_READY_PREFIX: &str = "AXLOADER READY "; |
| 5 | +pub const SERIAL_BOOT_PREFIX: &str = "AXLOADER BOOT "; |
| 6 | + |
| 7 | +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] |
| 8 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 9 | +#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))] |
| 10 | +pub enum BootArch { |
| 11 | + X86_64, |
| 12 | + Aarch64, |
| 13 | + Loongarch64, |
| 14 | + Riscv64, |
| 15 | + Other, |
| 16 | +} |
| 17 | + |
| 18 | +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] |
| 19 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 20 | +#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))] |
| 21 | +pub enum ImageFormat { |
| 22 | + Elf64, |
| 23 | +} |
| 24 | + |
| 25 | +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] |
| 26 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 27 | +pub struct SerialReadyMessage<'a> { |
| 28 | + pub protocol_version: u16, |
| 29 | + pub board: &'a str, |
| 30 | + pub arch: BootArch, |
| 31 | + pub loader_version: Option<&'a str>, |
| 32 | +} |
| 33 | + |
| 34 | +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] |
| 35 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 36 | +pub struct SerialBootOfferMessage<'a> { |
| 37 | + pub protocol_version: u16, |
| 38 | + pub boot_id: &'a str, |
| 39 | + pub kernel_url: &'a str, |
| 40 | + pub kernel_size: u64, |
| 41 | + pub image_format: ImageFormat, |
| 42 | + pub arch: BootArch, |
| 43 | + pub entry_symbol: Option<&'a str>, |
| 44 | +} |
| 45 | + |
| 46 | +#[cfg(feature = "std")] |
| 47 | +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] |
| 48 | +#[derive(Debug, Clone, PartialEq, Eq)] |
| 49 | +pub struct KernelPublishResponse { |
| 50 | + pub boot_id: String, |
| 51 | + pub kernel_url: String, |
| 52 | + pub kernel_size: u64, |
| 53 | + pub kernel_sha256: Option<String>, |
| 54 | +} |
| 55 | + |
| 56 | +#[cfg(all(feature = "std", feature = "serde"))] |
| 57 | +#[derive(Debug)] |
| 58 | +pub enum SerialMessageError { |
| 59 | + InvalidPrefix(&'static str), |
| 60 | + Json(serde_json::Error), |
| 61 | +} |
| 62 | + |
| 63 | +#[cfg(all(feature = "std", feature = "serde"))] |
| 64 | +impl core::fmt::Display for SerialMessageError { |
| 65 | + fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { |
| 66 | + match self { |
| 67 | + Self::InvalidPrefix(prefix) => { |
| 68 | + write!( |
| 69 | + f, |
| 70 | + "serial line does not start with expected prefix `{prefix}`" |
| 71 | + ) |
| 72 | + } |
| 73 | + Self::Json(err) => write!(f, "failed to parse serial message JSON: {err}"), |
| 74 | + } |
| 75 | + } |
| 76 | +} |
| 77 | + |
| 78 | +#[cfg(all(feature = "std", feature = "serde"))] |
| 79 | +impl std::error::Error for SerialMessageError {} |
| 80 | + |
| 81 | +#[cfg(all(feature = "std", feature = "serde"))] |
| 82 | +impl From<serde_json::Error> for SerialMessageError { |
| 83 | + fn from(err: serde_json::Error) -> Self { |
| 84 | + Self::Json(err) |
| 85 | + } |
| 86 | +} |
| 87 | + |
| 88 | +#[cfg(all(feature = "std", feature = "serde"))] |
| 89 | +pub fn render_serial_ready(message: &SerialReadyMessage<'_>) -> Result<String, serde_json::Error> { |
| 90 | + Ok(format!( |
| 91 | + "{SERIAL_READY_PREFIX}{}", |
| 92 | + serde_json::to_string(message)? |
| 93 | + )) |
| 94 | +} |
| 95 | + |
| 96 | +#[cfg(all(feature = "std", feature = "serde"))] |
| 97 | +pub fn parse_serial_ready(line: &str) -> Result<SerialReadyMessage<'_>, SerialMessageError> { |
| 98 | + let body = line |
| 99 | + .trim() |
| 100 | + .strip_prefix(SERIAL_READY_PREFIX) |
| 101 | + .ok_or(SerialMessageError::InvalidPrefix(SERIAL_READY_PREFIX))?; |
| 102 | + Ok(serde_json::from_str(body)?) |
| 103 | +} |
| 104 | + |
| 105 | +#[cfg(all(feature = "std", feature = "serde"))] |
| 106 | +pub fn render_serial_boot_offer( |
| 107 | + message: &SerialBootOfferMessage<'_>, |
| 108 | +) -> Result<String, serde_json::Error> { |
| 109 | + Ok(format!( |
| 110 | + "{SERIAL_BOOT_PREFIX}{}", |
| 111 | + serde_json::to_string(message)? |
| 112 | + )) |
| 113 | +} |
| 114 | + |
| 115 | +#[cfg(all(feature = "std", feature = "serde"))] |
| 116 | +pub fn parse_serial_boot_offer( |
| 117 | + line: &str, |
| 118 | +) -> Result<SerialBootOfferMessage<'_>, SerialMessageError> { |
| 119 | + let body = line |
| 120 | + .trim() |
| 121 | + .strip_prefix(SERIAL_BOOT_PREFIX) |
| 122 | + .ok_or(SerialMessageError::InvalidPrefix(SERIAL_BOOT_PREFIX))?; |
| 123 | + Ok(serde_json::from_str(body)?) |
| 124 | +} |
| 125 | + |
| 126 | +#[cfg(test)] |
| 127 | +mod tests { |
| 128 | + use super::{ |
| 129 | + BootArch, ImageFormat, SERIAL_BOOT_PREFIX, SERIAL_PROTOCOL_VERSION, SERIAL_READY_PREFIX, |
| 130 | + SerialBootOfferMessage, SerialReadyMessage, parse_serial_boot_offer, parse_serial_ready, |
| 131 | + render_serial_boot_offer, render_serial_ready, |
| 132 | + }; |
| 133 | + |
| 134 | + #[test] |
| 135 | + fn serializes_loader_control_messages() { |
| 136 | + let offer = SerialBootOfferMessage { |
| 137 | + protocol_version: SERIAL_PROTOCOL_VERSION, |
| 138 | + boot_id: "boot-1", |
| 139 | + kernel_url: "http://127.0.0.1/kernel.elf", |
| 140 | + kernel_size: 4096, |
| 141 | + image_format: ImageFormat::Elf64, |
| 142 | + arch: BootArch::X86_64, |
| 143 | + entry_symbol: Some("httpboot_entry"), |
| 144 | + }; |
| 145 | + let value = serde_json::to_value(&offer).unwrap(); |
| 146 | + assert_eq!(value["image_format"], "elf64"); |
| 147 | + } |
| 148 | + |
| 149 | + #[test] |
| 150 | + fn renders_and_parses_serial_ready_message() { |
| 151 | + let ready = SerialReadyMessage { |
| 152 | + protocol_version: SERIAL_PROTOCOL_VERSION, |
| 153 | + board: "asus-nuc15crh", |
| 154 | + arch: BootArch::X86_64, |
| 155 | + loader_version: Some("axloader"), |
| 156 | + }; |
| 157 | + |
| 158 | + let line = render_serial_ready(&ready).unwrap(); |
| 159 | + |
| 160 | + assert!(line.starts_with(SERIAL_READY_PREFIX)); |
| 161 | + assert_eq!(parse_serial_ready(&line).unwrap(), ready); |
| 162 | + } |
| 163 | + |
| 164 | + #[test] |
| 165 | + fn renders_and_parses_serial_boot_offer_message() { |
| 166 | + let offer = SerialBootOfferMessage { |
| 167 | + protocol_version: SERIAL_PROTOCOL_VERSION, |
| 168 | + boot_id: "boot-1", |
| 169 | + kernel_url: "http://10.3.10.192:2999/boot/kernel.elf", |
| 170 | + kernel_size: 4096, |
| 171 | + image_format: ImageFormat::Elf64, |
| 172 | + arch: BootArch::X86_64, |
| 173 | + entry_symbol: Some("httpboot_entry"), |
| 174 | + }; |
| 175 | + |
| 176 | + let line = render_serial_boot_offer(&offer).unwrap(); |
| 177 | + |
| 178 | + assert!(line.starts_with(SERIAL_BOOT_PREFIX)); |
| 179 | + assert_eq!(parse_serial_boot_offer(&line).unwrap(), offer); |
| 180 | + } |
| 181 | +} |
0 commit comments