incremental i2c changes

This commit is contained in:
bunnie 2021-03-16 15:52:13 +08:00
parent ab1b839900
commit eff3e7d7bf
5 changed files with 43 additions and 83 deletions

74
Cargo.lock generated
View file

@ -70,7 +70,7 @@ dependencies = [
"graphics-server", "graphics-server",
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"utralib", "utralib",
"xous", "xous",
@ -83,7 +83,7 @@ version = "0.1.0"
dependencies = [ dependencies = [
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"utralib", "utralib",
"xous", "xous",
"xous-names", "xous-names",
@ -124,7 +124,7 @@ version = "0.5.0"
source = "git+https://github.com/betrusted-io/blitstr.git?rev=d4516b0a6fa3ae6d29e5e323513158c4cd6b8b16#d4516b0a6fa3ae6d29e5e323513158c4cd6b8b16" source = "git+https://github.com/betrusted-io/blitstr.git?rev=d4516b0a6fa3ae6d29e5e323513158c4cd6b8b16#d4516b0a6fa3ae6d29e5e323513158c4cd6b8b16"
dependencies = [ dependencies = [
"log", "log",
"rkyv 0.3.1", "rkyv",
] ]
[[package]] [[package]]
@ -241,7 +241,7 @@ dependencies = [
"heapless", "heapless",
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"typenum", "typenum",
"utralib", "utralib",
@ -276,7 +276,7 @@ version = "0.1.0"
dependencies = [ dependencies = [
"graphics-server", "graphics-server",
"log", "log",
"rkyv 0.3.1", "rkyv",
"xous", "xous",
"xous-names", "xous-names",
] ]
@ -415,7 +415,7 @@ dependencies = [
"keyboard", "keyboard",
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"trng", "trng",
"utralib", "utralib",
@ -479,7 +479,7 @@ dependencies = [
"log", "log",
"log-server", "log-server",
"minifb", "minifb",
"rkyv 0.3.1", "rkyv",
"utralib", "utralib",
"xous", "xous",
"xous-names", "xous-names",
@ -559,7 +559,7 @@ dependencies = [
"keyboard", "keyboard",
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"utralib", "utralib",
"xous", "xous",
@ -572,7 +572,7 @@ version = "0.1.0"
dependencies = [ dependencies = [
"graphics-server", "graphics-server",
"log", "log",
"rkyv 0.3.1", "rkyv",
"xous", "xous",
"xous-names", "xous-names",
] ]
@ -585,7 +585,7 @@ dependencies = [
"ime-plugin-api", "ime-plugin-api",
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"utralib", "utralib",
"xous", "xous",
@ -613,7 +613,7 @@ dependencies = [
"heapless", "heapless",
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"utralib", "utralib",
"xous", "xous",
@ -655,7 +655,7 @@ dependencies = [
"heapless", "heapless",
"log", "log",
"log-server", "log-server",
"rkyv 0.4.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"utralib", "utralib",
"xous", "xous",
@ -836,26 +836,6 @@ dependencies = [
"unicode-xid 0.2.1", "unicode-xid 0.2.1",
] ]
[[package]]
name = "ptr_meta"
version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "aad980f4bb4053abd4733b1680024a8c71ffde345f6e584c6af9eb6f0067a198"
dependencies = [
"ptr_meta_derive",
]
[[package]]
name = "ptr_meta_derive"
version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7bcd6232fa7d7fcd15703da5c07c9f10d203ee4fdf6ecf6d7ac5056db78089a3"
dependencies = [
"proc-macro2 1.0.24",
"quote 1.0.8",
"syn 1.0.60",
]
[[package]] [[package]]
name = "quick-error" name = "quick-error"
version = "1.2.3" version = "1.2.3"
@ -1036,18 +1016,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4ba0dea2b9efaa468bc76d09a06741839d84c70a746edb1793d9653828532666" checksum = "4ba0dea2b9efaa468bc76d09a06741839d84c70a746edb1793d9653828532666"
dependencies = [ dependencies = [
"memoffset", "memoffset",
"rkyv_derive 0.3.1", "rkyv_derive",
]
[[package]]
name = "rkyv"
version = "0.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "45a6fdbe501948402e00ede914b4dc21d340105b2eff740ed47e3d45ac846f5c"
dependencies = [
"memoffset",
"ptr_meta",
"rkyv_derive 0.4.0",
] ]
[[package]] [[package]]
@ -1061,17 +1030,6 @@ dependencies = [
"syn 1.0.60", "syn 1.0.60",
] ]
[[package]]
name = "rkyv_derive"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "95a169f6bc5a81033e86ed39d0f4150e2608160b73d2b93c6e8e6a3efa873f14"
dependencies = [
"proc-macro2 1.0.24",
"quote 1.0.8",
"syn 1.0.60",
]
[[package]] [[package]]
name = "rustc-hash" name = "rustc-hash"
version = "1.1.0" version = "1.1.0"
@ -1156,7 +1114,7 @@ dependencies = [
"llio", "llio",
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"utralib", "utralib",
"xous", "xous",
@ -1593,7 +1551,7 @@ dependencies = [
"hex", "hex",
"lazy_static", "lazy_static",
"log", "log",
"rkyv 0.3.1", "rkyv",
"rustc-std-workspace-core", "rustc-std-workspace-core",
"xous-macros", "xous-macros",
] ]
@ -1617,7 +1575,7 @@ dependencies = [
"heapless", "heapless",
"log", "log",
"log-server", "log-server",
"rkyv 0.3.1", "rkyv",
"ticktimer-server", "ticktimer-server",
"utralib", "utralib",
"xous", "xous",

View file

@ -12,11 +12,7 @@ log-server = { path = "../log-server" }
ticktimer-server = { path = "../ticktimer-server" } ticktimer-server = { path = "../ticktimer-server" }
xous-names = { path = "../xous-names" } xous-names = { path = "../xous-names" }
log = "0.4" log = "0.4"
rkyv = { version = "0.3.1", default_features = false }
[dependencies.rkyv]
version = "0.4.1"
default-features = false
features = ["const_generics"]
[target.'cfg(not(any(windows,unix)))'.dependencies] [target.'cfg(not(any(windows,unix)))'.dependencies]
utralib = { path = "../../utralib"} utralib = { path = "../../utralib"}

View file

@ -2,7 +2,7 @@ use xous::{Message, ScalarMessage};
use xous::String; use xous::String;
/////////////////////// UART TYPE /////////////////////// UART TYPE
#[derive(Debug, rkyv::Archive)] #[derive(Debug, rkyv::Archive, rkyv::Unarchive)]
pub enum UartType { pub enum UartType {
Kernel, Kernel,
Log, Log,
@ -44,7 +44,7 @@ impl Into<u32> for UartType {
/////////////////////// I2C /////////////////////// I2C
// a small book-keeping struct used to report back to I2C requestors as to the status of a transaction // a small book-keeping struct used to report back to I2C requestors as to the status of a transaction
#[derive(Debug, Copy, Clone, rkyv::Archive)] #[derive(Debug, Copy, Clone, rkyv::Archive, rkyv::Unarchive)]
pub enum I2cStatus { pub enum I2cStatus {
/// used only as the default, should always be set to one of the below before sending /// used only as the default, should always be set to one of the below before sending
Uninitialized, Uninitialized,
@ -65,13 +65,13 @@ pub enum I2cStatus {
/// everything is OK, write finished. data fields have no meaning /// everything is OK, write finished. data fields have no meaning
ResponseWriteOk, ResponseWriteOk,
} }
#[derive(Debug, Copy, Clone, rkyv::Archive)] #[derive(Debug, Copy, Clone, rkyv::Archive, rkyv::Unarchive)]
pub struct I2cTransaction { pub struct I2cTransaction {
bus_addr: u8, bus_addr: u8,
// write address and read address are encoded in the packet field below // write address and read address are encoded in the packet field below
txbuf: Option<[u8; 258]>, // up to 258 bytes total packet length; note cost is "same" b/c these are sent via 4kiB page remaps txbuf: Option<[u8; 31]>, // limited by trait types available in Rkyv
txlen: u32, txlen: u32,
rxbuf: Option<[u8; 258]>, rxbuf: Option<[u8; 31]>,
rxlen: u32, rxlen: u32,
timeout_ms: u32, timeout_ms: u32,
// response field to the calling server // response field to the calling server
@ -81,10 +81,11 @@ impl I2cTransaction {
pub fn new() -> Self { pub fn new() -> Self {
I2cTransaction{ bus_addr: 0, txbuf: None, txlen: 0, rxbuf: None, rxlen: 0, timeout_ms: 100, status: I2cStatus::Uninitialized } I2cTransaction{ bus_addr: 0, txbuf: None, txlen: 0, rxbuf: None, rxlen: 0, timeout_ms: 100, status: I2cStatus::Uninitialized }
} }
pub fn status(&self) -> I2cStatus { self.status }
} }
////////////////////////////////// VIBE ////////////////////////////////// VIBE
#[derive(Debug, rkyv::Archive)] #[derive(Debug, rkyv::Archive, rkyv::Unarchive)]
pub enum VibePattern { pub enum VibePattern {
Short, Short,
Long, Long,
@ -110,7 +111,7 @@ impl Into<usize> for VibePattern {
} }
//////////////////////////////// CLOCK GATING (placeholder) //////////////////////////////// CLOCK GATING (placeholder)
#[derive(Debug, rkyv::Archive)] #[derive(Debug, rkyv::Archive, rkyv::Unarchive)]
pub enum ClockMode { pub enum ClockMode {
Low, Low,
AllOn, AllOn,
@ -133,7 +134,7 @@ impl Into<usize> for ClockMode {
} }
//////////////////////////////////// OPCODES //////////////////////////////////// OPCODES
#[derive(Debug, rkyv::Archive)] #[derive(Debug, rkyv::Archive, rkyv::Unarchive)]
pub enum Opcode { pub enum Opcode {
/// not tested - reboot /// not tested - reboot
RebootRequest, RebootRequest,

View file

@ -10,11 +10,11 @@ use xous::{send_message, CID};
// used by the LLIO to send a response to other servers // used by the LLIO to send a response to other servers
pub fn send_i2c_response(cid: CID, transaction: I2cTransaction) -> Result<(), xous::Error> { pub fn send_i2c_response(cid: CID, transaction: I2cTransaction) -> Result<(), xous::Error> {
let op = api::Opcode::I2cResponse(transaction); let op = api::Opcode::I2cResponse(transaction);
let mut writer = rkyv::ser::serializers::BufferSerializer::new(xous::XousBuffer::new(4096)); use rkyv::Write;
let pos = { let mut writer = rkyv::ArchiveBuffer::new(xous::XousBuffer::new(4096));
use rkyv::ser::Serializer; let pos = writer
writer.serialize_value(&op).expect("LLIO_API: couldn't archive I2cResponse"); .archive(&op)
}; .expect("couldn't archive request");
let buf = writer.into_inner(); let buf = writer.into_inner();
buf.lend(cid, pos as u32).expect("LLIO_API: I2cResponse operation failure"); buf.lend(cid, pos as u32).expect("LLIO_API: I2cResponse operation failure");
@ -23,20 +23,22 @@ pub fn send_i2c_response(cid: CID, transaction: I2cTransaction) -> Result<(), xo
// used by other servers to request an I2C transaction // used by other servers to request an I2C transaction
pub fn send_i2c_request(cid: CID, transaction: I2cTransaction) -> Result<I2cStatus, xous::Error> { pub fn send_i2c_request(cid: CID, transaction: I2cTransaction) -> Result<I2cStatus, xous::Error> {
let op = api::Opcode::I2cTxRx(transaction); let op = api::Opcode::I2cTxRx(transaction);
let mut writer = rkyv::ser::serializers::BufferSerializer::new(xous::XousBuffer::new(4096)); use rkyv::Write;
let pos = { let mut writer = rkyv::ArchiveBuffer::new(xous::XousBuffer::new(4096));
use rkyv::ser::Serializer; let pos = writer
writer.serialize_value(&op).expect("LLIO_API: couldn't archive I2cTxRx"); .archive(&op)
}; .expect("couldn't archive request");
let buf = writer.into_inner(); let mut buf = writer.into_inner();
buf.lend_mut(cid, pos as u32).expect("LLIO_API: I2cTxRx operation failure"); buf.lend_mut(cid, pos as u32).expect("LLIO_API: I2cTxRx operation failure");
let returned = unsafe { rkyv::archived_value::<api::Opcode>(buf.as_ref(), pos)}; let returned = unsafe { rkyv::archived_value::<api::Opcode>(buf.as_ref(), pos)};
if let rkyv::Archived::<api::Opcode>::I2cTxRx(result) = returned { if let rkyv::Archived::<api::Opcode>::I2cTxRx(result) = returned {
use rkyv::Unarchive;
let i2c_txrx: I2cTransaction = result.unarchive(); let i2c_txrx: I2cTransaction = result.unarchive();
Ok(i2c_txrx.status) Ok(i2c_txrx.status())
} else { } else {
use rkyv::Unarchive;
let i2c_txrx = returned.unarchive(); let i2c_txrx = returned.unarchive();
log::info!("send_i2c_request saw an unhandled return type of {:?}", i2c_txrx); log::info!("send_i2c_request saw an unhandled return type of {:?}", i2c_txrx);
Err(xous::Error::InternalError) Err(xous::Error::InternalError)

View file

@ -84,6 +84,9 @@ impl Authenticate {
} }
} }
// note to self: keep around the implementation for the key-able version of the String
// structure, but we can lose the rkyv-able version for the external API
// --------------------- Taken from rkyv docs https://docs.rs/rkyv/0.3.0/rkyv/trait.Archive.html // // --------------------- Taken from rkyv docs https://docs.rs/rkyv/0.3.0/rkyv/trait.Archive.html //
#[derive(Debug, Copy, Clone)] #[derive(Debug, Copy, Clone)]
pub struct XousServerName { pub struct XousServerName {