tool: 新增算能芯片 ROM 辅助芯片

Signed-off-by: zhujunxing <zjx1319@hust.edu.cn>

Author: jakezhu9

.gitignore

@@ -1 +1,5 @@
+# Rust compiler cache
 /target
+
+# Generated by Sophgo ROM Tool package
+fip.bin

Cargo.lock

@@ -3,5 +3,6 @@ resolver = "2"
 members = [
     "sophgo-rom-rt",
     "sophgo-rom-rt/macros",
+    "sophgo-rom-tool",
     "examples/hello-world",
 ]

Cargo.toml

@@ -12,5 +12,6 @@ fn main() -> ! {
     let uart = unsafe { &*(0x04140000 as *const uart16550::Uart16550<u32>) };
     loop {
         uart.write(b"Hello World from Rust!\n");
+        // TODO fix Uart16550 crate bug; it doesn't block when UART FIFO is not empty
     }
 }

examples/hello-world/src/main.rs

@@ -0,0 +1,10 @@
+[package]
+name = "sophgo-rom-tool"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+clap = { version = "4.4.16", features = ["derive"] }
+crc = "3.0.1"

sophgo-rom-tool/Cargo.toml

@@ -0,0 +1,11 @@
+# 算能芯片 ROM 辅助工具
+
+本工具可由二进制文件生成算能芯片 ROM 镜像文件（fip.bin）。
+
+Example:
+
+```bash
+cargo build -p hello-world --target riscv64imac-unknown-none-elf --release
+rust-objcopy --binary-architecture=riscv64 --strip-all -O binary .\target\riscv64imac-unknown-none-elf\release\hello-world .\target\hello-world.bin
+cargo run --bin sophgo-rom-tool -- .\target\hello-world.bin -o .\target\fip.bin
+```

sophgo-rom-tool/README.md

@@ -0,0 +1,55 @@
+use clap::Parser;
+use crc::{Crc, CRC_16_XMODEM};
+use std::fs;
+
+/// Generate a ROM image for Sophgo chips.
+#[derive(Parser, Debug)]
+#[command(author, version, about, long_about = None)]
+struct Args {
+    /// Input filename.
+    input: String,
+    /// Output ROM image filename.
+    #[arg(short, long, default_value_t = String::from("fip.bin"))]
+    output: String,
+}
+
+const SIGNATURE: [u8; 32] = [
+    0x6F, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+];
+
+const MAGIC: [u8; 12] = [
+    0x43, 0x56, 0x42, 0x4C, 0x30, 0x31, 0x0A, 0x00, 0x00, 0x00, 0x00, 0x00,
+]; // CVBL01
+
+fn main() {
+    let args = Args::parse();
+    let data = fs::read(&args.input).expect("Unable to read file");
+    let data_len = data.len();
+    if data_len < SIGNATURE.len() || data[..SIGNATURE.len()] != SIGNATURE {
+        panic!("Invalid input file");
+    }
+
+    let mut image = vec![0; 0x1000];
+    image.extend(data);
+    let padding_len = 512 - (data_len % 512);
+    image.extend(core::iter::repeat(0).take(padding_len));
+
+    let crc = Crc::<u16>::new(&CRC_16_XMODEM);
+    let bl2_checksum = crc.checksum(&image[0x1000..]);
+
+    image[..MAGIC.len()].copy_from_slice(&MAGIC);
+    image[0xBC..0xC0].copy_from_slice(&0x2F8u32.to_le_bytes()); // chip_conf_size
+    image[0xC0..0xC4].copy_from_slice(&0xCAFE0000u32.to_le_bytes()); // blcp_img_cksum
+    image[0xD4..0xD8].copy_from_slice(&(0xCAFE0000u32 + bl2_checksum as u32).to_le_bytes()); // bl2_img_cksum
+    image[0xD8..0xDC].copy_from_slice(&((data_len + padding_len) as u32).to_le_bytes()); // bl2_img_size
+
+    let param_checksum = crc.checksum(&image[0x10..0x800]);
+    image[0xC..0x10].copy_from_slice(
+        (0xCAFE0000u32 + param_checksum as u32)
+            .to_le_bytes()
+            .as_ref(),
+    ); // param_cksum
+
+    fs::write(&args.output, image).expect("Unable to write file");
+}