limeth/acid
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Use custom partition table to prevent firmware getting overwritten

Browse source
This commit is contained in:
Jakub Hlusička 2026-02-05 02:54:40 +01:00
parent 40b9b5d278
commit d4c8d69cf3
7 changed files with 142 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
firmware/.gitignore vendored
View file

@ -1 +1,2 @@
/.cargo
!/acid-firmware/partition-table.csv

38
firmware/.vscode/launch.json vendored
View file

@ -10,6 +10,14 @@
"coreConfigs": [
{
"programBinary": "target/xtensa-esp32s3-none-elf/debug/acid-firmware",
"rttEnabled": true,
"rttChannelFormats": [
{
"channelNumber": 0,
"dataFormat": "String",
"mode": "BlockIfFull"
}
]
},
],
},
@ -22,6 +30,14 @@
"coreConfigs": [
{
"programBinary": "target/xtensa-esp32s3-none-elf/release/acid-firmware",
"rttEnabled": true,
"rttChannelFormats": [
{
"channelNumber": 0,
"dataFormat": "String",
"mode": "BlockIfFull"
}
]
},
],
},
@ -32,12 +48,23 @@
"request": "launch",
"flashingConfig": {
"flashingEnabled": true,
"formatOptions": {
"idf_partition_table": "partition-table.csv"
}
},
"probe": "303a:1001",
"chip": "esp32s3",
"coreConfigs": [
{
"programBinary": "target/xtensa-esp32s3-none-elf/debug/acid-firmware",
"rttEnabled": true,
"rttChannelFormats": [
{
"channelNumber": 0,
"dataFormat": "String",
"mode": "BlockIfFull"
}
]
},
],
},
@ -48,12 +75,23 @@
"request": "launch",
"flashingConfig": {
"flashingEnabled": true,
"formatOptions": {
"idf_partition_table": "partition-table.csv"
}
},
"probe": "303a:1001",
"chip": "esp32s3",
"coreConfigs": [
{
"programBinary": "target/xtensa-esp32s3-none-elf/release/acid-firmware",
"rttEnabled": true,
"rttChannelFormats": [
{
"channelNumber": 0,
"dataFormat": "String",
"mode": "BlockIfFull"
}
]
},
],
},

10
firmware/.vscode/tasks.json vendored
View file

@ -5,7 +5,10 @@
"label": "rust: cargo build",
"type": "cargo",
"options": {
"cwd": "${workspaceFolder}/acid-firmware"
"cwd": "${workspaceFolder}/acid-firmware",
"env": {
"ESP_LOG": "info"
}
},
"command": "build",
"args": [
@ -23,7 +26,10 @@
"label": "rust: cargo build --release",
"type": "cargo",
"options": {
"cwd": "${workspaceFolder}/acid-firmware"
"cwd": "${workspaceFolder}/acid-firmware",
"env": {
"ESP_LOG": "info"
}
},
"command": "build",
"args": [

2
firmware/acid-firmware/.cargo/config.toml
View file

@ -1,5 +1,5 @@
[target.'cfg(all(any(target_arch = "riscv32", target_arch = "xtensa"), target_os = "none"))']
runner = "espflash flash --monitor"
runner = "espflash flash --partition-table partition-table.csv --monitor"
# runner = "probe-rs run --chip esp32s3 --preverify"
[build]

1
firmware/acid-firmware/Cargo.toml
View file

@ -87,6 +87,7 @@ chrono = { version = "0.4.43", default-features = false, features = ["alloc", "s
tinyvec = { version = "1.10.0", default-features = false, features = ["alloc"] }
esp-metadata-generated = { version = "0.3.0", features = ["esp32s3"] }
hex = { version = "0.4.3", default-features = false, features = ["alloc"] }
indoc = "2.0.7"
# A fork of slint with patches for `allocator_api` support.
# Don't forget to change `slint-build` in build dependencies, if this is changed.

6
firmware/acid-firmware/partition-table.csv Normal file
View file

@ -0,0 +1,6 @@
# Name, Type, SubType, Offset, Size, Flags
nvs, data, nvs, 0x9000, 0x6000,
phy_init, data, phy, 0xf000, 0x1000,
factory, app, factory, 0x10000, 4M,
rmk, data, undefined, , 64K,
acid, data, undefined, , 0x7E0000,
1 # Name Type SubType Offset Size Flags
2 nvs data nvs 0x9000 0x6000
3 phy_init data phy 0xf000 0x1000
4 factory app factory 0x10000 4M
5 rmk data undefined 64K
6 acid data undefined 0x7E0000

102
firmware/acid-firmware/src/main.rs
View file

@ -18,12 +18,15 @@ extern crate alloc;
use core::alloc::Layout;
use core::cell::RefCell;
use core::fmt::Write;
use core::sync::atomic::{AtomicBool, Ordering};
use alloc::boxed::Box;
use alloc::collections::vec_deque::VecDeque;
use alloc::string::String;
use alloc::sync::Arc;
use alloc::vec;
use alloc::vec::Vec;
use embassy_embedded_hal::adapter::BlockingAsync;
use embassy_embedded_hal::flash::partition::Partition;
use embassy_executor::Spawner;
@ -33,6 +36,7 @@ use embassy_sync::mutex::Mutex;
use embassy_sync::signal::Signal;
use embassy_time::{Duration, Timer};
use esp_alloc::{HeapRegion, MemoryCapability};
use esp_bootloader_esp_idf::partitions::PartitionTable;
use esp_hal::Blocking;
use esp_hal::clock::CpuClock;
use esp_hal::dma::{BurstConfig, DmaDescriptor, DmaTxBuf, ExternalBurstConfig};
@ -50,6 +54,7 @@ use esp_hal::system::Stack;
use esp_hal::timer::timg::TimerGroup;
use esp_rtos::embassy::Executor;
use esp_storage::FlashStorage;
use indoc::writedoc;
use log::{error, info, warn};
use rmk::channel::{CONTROLLER_CHANNEL, ControllerSub};
use rmk::config::{BehaviorConfig, PositionalConfig, RmkConfig, StorageConfig, VialConfig};
@ -242,10 +247,20 @@ async fn main(_spawner: Spawner) {
};
// Initialize the flash
static FLASH: StaticCell<Mutex<CriticalSectionRawMutex, BlockingAsync<FlashStorage>>> =
static PARTITION_TABLE_BUFFER: StaticCell<Vec<u8, &'static esp_alloc::EspHeap>> =
StaticCell::new();
let flash = FLASH.init_with(|| {
let flash = FlashStorage::new(peripherals.FLASH)
let partition_table_buffer = PARTITION_TABLE_BUFFER.init_with(|| {
let mut buffer = Vec::<u8, _>::new_in(&PSRAM_ALLOCATOR);
buffer.resize(1024, 0_u8);
buffer
});
static FLASH: StaticCell<(
Mutex<CriticalSectionRawMutex, BlockingAsync<FlashStorage>>,
PartitionTable<'static>,
)> = StaticCell::new();
let (flash, partition_table) = FLASH.init_with(|| {
let mut flash = FlashStorage::new(peripherals.FLASH)
// Flash memory may not be written to while another core is executing from it.
// By default, `FlashStorage` is configured to abort the operation and log an error message.
// However, it can also be configured to auto-park the other core, such that writing to
@ -254,19 +269,68 @@ async fn main(_spawner: Spawner) {
// to avoid having to park the other core, which could result in better performance.
// Invalid configuration would then present itself as freezing/UB.
.multicore_auto_park();
let partition_table = {
esp_bootloader_esp_idf::partitions::read_partition_table(
&mut flash,
partition_table_buffer,
)
.expect("Failed to read the partition table.")
};
Mutex::<CriticalSectionRawMutex, _>::new(async_flash_wrapper(flash))
(
Mutex::<CriticalSectionRawMutex, _>::new(async_flash_wrapper(flash)),
partition_table,
)
});
const FLASH_SIZE_TOTAL: u32 = 16 * 1024 * 1024;
const FLASH_PART_FIRMWARE_OFFSET: u32 = 0;
const FLASH_PART_FIRMWARE_SIZE: u32 = 0x3f0000;
const FLASH_PART_RMK_OFFSET: u32 = FLASH_PART_FIRMWARE_OFFSET + FLASH_PART_FIRMWARE_SIZE;
const FLASH_PART_RMK_SIZE_IN_SECTORS: u32 = 16;
const FLASH_PART_RMK_SIZE: u32 = FLASH_PART_RMK_SIZE_IN_SECTORS * FlashStorage::SECTOR_SIZE;
const FLASH_PART_ACID_OFFSET: u32 = FLASH_PART_RMK_OFFSET + FLASH_PART_RMK_SIZE;
const FLASH_PART_ACID_SIZE: u32 = FLASH_SIZE_TOTAL - FLASH_PART_ACID_OFFSET;
let flash_part_rmk = Partition::new(flash, FLASH_PART_RMK_OFFSET, FLASH_PART_RMK_SIZE);
let flash_part_acid = Partition::new(flash, FLASH_PART_ACID_OFFSET, FLASH_PART_ACID_SIZE);
{
let mut buffer = String::new();
writeln!(buffer, "Partition table:").unwrap();
for (index, partition) in partition_table.iter().enumerate() {
writedoc!(
buffer,
"
Partition #{index} {label:?}:
offset: 0x{offset:x}
length: 0x{len:x}
type: 0x{type:?}
read only: {read_only}
encrypted: {encrypted}
magic: {magic}
",
label = partition.label_as_str(),
offset = partition.offset(),
len = partition.len(),
type = partition.partition_type(),
read_only = partition.is_read_only(),
encrypted = partition.is_encrypted(),
magic = partition.magic(),
)
.unwrap();
}
info!("{}", buffer);
}
let flash_part_info_rmk = partition_table
.iter()
.find(|partition| partition.label_as_str() == "rmk")
.expect("No \"rmk\" partition found. Make sure to use the custom partition-table.csv when flashing.");
let flash_part_info_acid = partition_table
.iter()
.find(|partition| partition.label_as_str() == "acid")
.expect("No \"acid\" partition found. Make sure to use the custom partition-table.csv when flashing.");
let flash_part_rmk = Partition::new(
flash,
flash_part_info_rmk.offset(),
flash_part_info_rmk.len(),
);
let flash_part_acid = Partition::new(
flash,
flash_part_info_acid.offset(),
flash_part_info_acid.len(),
);
info!("Flash memory configured!");
@ -313,7 +377,15 @@ async fn main(_spawner: Spawner) {
let vial_config = VialConfig::new(VIAL_KEYBOARD_ID, VIAL_KEYBOARD_DEF, &[(0, 0), (1, 1)]);
let storage_config = StorageConfig {
start_addr: 0,
num_sectors: FLASH_PART_RMK_SIZE_IN_SECTORS as u8,
num_sectors: {
assert!(
flash_part_info_rmk.len() as u32 % FlashStorage::SECTOR_SIZE == 0,
"The size of the RMK partition must be a multiple of {} bytes. Current size: {}",
FlashStorage::SECTOR_SIZE,
flash_part_info_rmk.len()
);
(flash_part_info_rmk.len() as u32 / FlashStorage::SECTOR_SIZE) as u8
},
..Default::default()
};
let rmk_config = RmkConfig {