Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

serial-settings: async platform #930

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

serial-settings: async platform #930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions serial-settings/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ embedded-io = "0.6"
yafnv = "3.0"
postcard = "1"
log = { version = "0.4", features = ["max_level_trace", "release_max_level_info"] }
embassy-futures = { version = "0.1", default-features = false }
94 changes: 55 additions & 39 deletions serial-settings/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@
//! Currently, there is a hardcoded limit of 64-bytes on the settings path. This is arbitrary and
//! can be changed if needed.
#![no_std]
#![allow(async_fn_in_trait)]

use embassy_futures::block_on;
use embedded_io::{ErrorType, Read, ReadReady, Write};
use heapless::String;
use miniconf::{JsonCoreSlash, Path, Postcard, Traversal, TreeKey};
Expand Down Expand Up @@ -82,25 +84,29 @@ pub trait Platform<const Y: usize> {
type Settings: Settings<Y>;

/// Fetch a value from persisten storage
fn fetch<'a>(
async fn fetch<'a>(
&mut self,
buf: &'a mut [u8],
key: &[u8],
) -> Result<Option<&'a [u8]>, Self::Error>;

/// Store a value to persistent storage
fn store(
async fn store(
&mut self,
buf: &mut [u8],
key: &[u8],
value: &[u8],
) -> Result<(), Self::Error>;

/// Remove a key from storage.
fn clear(&mut self, buf: &mut [u8], key: &[u8]) -> Result<(), Self::Error>;
async fn clear(
&mut self,
buf: &mut [u8],
key: &[u8],
) -> Result<(), Self::Error>;

/// Execute a platform specific command.
fn cmd(&mut self, cmd: &str);
async fn cmd(&mut self, cmd: &str);

/// Return a mutable reference to the `Interface`.
fn interface_mut(&mut self) -> &mut Self::Interface;
Expand All @@ -121,7 +127,7 @@ impl<'a, P: Platform<Y>, const Y: usize> Interface<'a, P, Y> {
_settings: &mut P::Settings,
) {
let key = menu::argument_finder(item, args, "cmd").unwrap().unwrap();
interface.platform.cmd(key)
block_on(interface.platform.cmd(key))
}

fn iter_root<F>(
Expand Down Expand Up @@ -237,14 +243,11 @@ impl<'a, P: Platform<Y>, const Y: usize> Interface<'a, P, Y> {
.unwrap();

// Get stored and compare
match interface.platform.fetch(interface.buffer, key.as_bytes())
{
Err(e) => write!(
interface,
" [fetch error: {e:?}]"
),
Ok(None) =>
write!(interface, " [not stored]"),
match block_on(
interface.platform.fetch(interface.buffer, key.as_bytes()),
) {
Err(e) => write!(interface, " [fetch error: {e:?}]"),
Ok(None) => write!(interface, " [not stored]"),
Ok(Some(stored)) => {
let slic = postcard::de_flavors::Slice::new(stored);
// Use defaults as scratch space for postcard->json conversion
Expand All @@ -253,29 +256,35 @@ impl<'a, P: Platform<Y>, const Y: usize> Interface<'a, P, Y> {
interface,
" [stored deserialize error: {e}]"
),
Ok(_rest) =>
match defaults.get_json_by_key(&key, interface.buffer) {
Err(e) => write!(
interface,
" [stored serialization error: {e}]"
),
Ok(len) => {
if yafnv::fnv1a::<u32>(&interface.buffer[..len]) != check {
Ok(_rest) => match defaults
.get_json_by_key(&key, interface.buffer)
{
Err(e) => write!(
interface,
" [stored serialization error: {e}]"
),
Ok(len) => {
if yafnv::fnv1a::<u32>(
&interface.buffer[..len],
) != check
{
write!(
interface.platform.interface_mut(),
" [stored: {}]",
core::str::from_utf8(&interface.buffer[..len]).unwrap())
} else {
write!(
interface,
" [stored]"
core::str::from_utf8(
&interface.buffer[..len]
)
}
},
.unwrap()
)
} else {
write!(interface, " [stored]")
}
}
}
},
}
}
}.unwrap();
}
.unwrap();
writeln!(interface).unwrap();
},
);
Expand Down Expand Up @@ -363,8 +372,9 @@ impl<'a, P: Platform<Y>, const Y: usize> Interface<'a, P, Y> {
}

// Check for stored
match interface.platform.fetch(interface.buffer, key.as_bytes())
{
match block_on(
interface.platform.fetch(interface.buffer, key.as_bytes()),
) {
Err(e) => {
writeln!(
interface,
Expand All @@ -375,10 +385,11 @@ impl<'a, P: Platform<Y>, const Y: usize> Interface<'a, P, Y> {
}
Ok(None) => {}
// Clear stored
Ok(Some(_stored)) => match interface
.platform
.clear(interface.buffer, key.as_bytes())
{
Ok(Some(_stored)) => match block_on(
interface
.platform
.clear(interface.buffer, key.as_bytes()),
) {
Ok(()) => {
writeln!(interface, "Clear stored `{}`", *key)
}
Expand Down Expand Up @@ -438,8 +449,9 @@ impl<'a, P: Platform<Y>, const Y: usize> Interface<'a, P, Y> {
};

// Get stored value checksum
match interface.platform.fetch(interface.buffer, key.as_bytes())
{
match block_on(
interface.platform.fetch(interface.buffer, key.as_bytes()),
) {
Ok(None) => {}
Ok(Some(stored)) => {
let stored = yafnv::fnv1a::<u32>(stored);
Expand Down Expand Up @@ -491,7 +503,11 @@ impl<'a, P: Platform<Y>, const Y: usize> Interface<'a, P, Y> {
let (value, rest) = interface.buffer.split_at_mut(len);

// Store
match interface.platform.store(rest, key.as_bytes(), value) {
match block_on(interface.platform.store(
rest,
key.as_bytes(),
value,
)) {
Ok(_) => writeln!(interface, "`{}` stored", *key),
Err(e) => {
writeln!(interface, "Failed to store `{}`: {e:?}", *key)
Expand Down
8 changes: 5 additions & 3 deletions src/hardware/setup.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,9 +644,11 @@ where
};

let mut settings = C::new(NetSettings::new(mac_addr));
crate::settings::SerialSettingsPlatform::load(
&mut settings,
&mut flash,
embassy_futures::block_on(
crate::settings::SerialSettingsPlatform::load(
&mut settings,
&mut flash,
),
);
(flash, settings)
};
Expand Down
36 changes: 21 additions & 15 deletions src/settings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
//! storage sharing.
use crate::hardware::{flash::Flash, metadata::ApplicationMetadata, platform};
use core::fmt::Write;
use embassy_futures::block_on;
use embedded_io::Write as EioWrite;
use heapless::{String, Vec};
use miniconf::{JsonCoreSlash, Path, Postcard, Tree};
Expand All @@ -34,7 +33,6 @@ use sequential_storage::{
};
use serial_settings::{BestEffortInterface, Platform, Settings};
use smoltcp_nal::smoltcp::wire::EthernetAddress;
use stm32h7xx_hal::flash::LockedFlashBank;

/// Settings that are used for configuring the network interface to Stabilizer.
#[derive(Clone, Debug, Tree)]
Expand Down Expand Up @@ -117,20 +115,22 @@ impl<C, const Y: usize> SerialSettingsPlatform<C, Y>
where
C: for<'d> JsonCoreSlash<'d, Y>,
{
pub fn load(structure: &mut C, storage: &mut Flash) {
pub async fn load(structure: &mut C, storage: &mut Flash) {
// Loop over flash and read settings
let mut buffer = [0u8; 512];
for path in C::nodes::<Path<String<64>, '/'>>() {
let (path, _node) = path.unwrap();

// Try to fetch the setting from flash.
let value: &[u8] = match block_on(fetch_item(
let value: &[u8] = match fetch_item(
storage,
storage.range(),
&mut NoCache::new(),
&mut buffer,
SettingsKey(Vec::try_from(path.as_bytes()).unwrap()),
)) {
)
.await
{
Err(e) => {
log::warn!(
"Failed to fetch `{}` from flash: {e:?}",
Expand Down Expand Up @@ -168,47 +168,53 @@ where
type Interface = BestEffortInterface<crate::hardware::SerialPort>;
type Settings = C;
type Error = sequential_storage::Error<
<LockedFlashBank as embedded_storage::nor_flash::ErrorType>::Error,
<stm32h7xx_hal::flash::LockedFlashBank as embedded_storage::nor_flash::ErrorType>::Error,
>;

fn fetch<'a>(
async fn fetch<'a>(
&mut self,
buf: &'a mut [u8],
key: &[u8],
) -> Result<Option<&'a [u8]>, Self::Error> {
let range = self.storage.range();
block_on(fetch_item(
fetch_item(
&mut self.storage,
range,
&mut NoCache::new(),
buf,
SettingsKey(Vec::try_from(key).unwrap()),
))
)
.await
.map(|v| v.filter(|v: &&[u8]| !v.is_empty()))
}

fn store(
async fn store(
&mut self,
buf: &mut [u8],
key: &[u8],
value: &[u8],
) -> Result<(), Self::Error> {
let range = self.storage.range();
block_on(store_item(
store_item(
&mut self.storage,
range,
&mut NoCache::new(),
buf,
SettingsKey(Vec::try_from(key).unwrap()),
&value,
))
)
.await
}

fn clear(&mut self, buf: &mut [u8], key: &[u8]) -> Result<(), Self::Error> {
self.store(buf, key, b"")
async fn clear(
&mut self,
buf: &mut [u8],
key: &[u8],
) -> Result<(), Self::Error> {
self.store(buf, key, b"").await
}

fn cmd(&mut self, cmd: &str) {
async fn cmd(&mut self, cmd: &str) {
match cmd {
"reboot" => cortex_m::peripheral::SCB::sys_reset(),
"dfu" => platform::start_dfu_reboot(),
Expand Down
Loading