diff --git a/Cargo.lock b/Cargo.lock index 27704851e..ee2f6d981 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -535,7 +535,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -556,7 +556,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-semver", @@ -1171,7 +1171,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -1288,7 +1288,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", ] @@ -1506,7 +1506,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -1570,7 +1570,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -1931,7 +1931,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -1967,7 +1967,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -2041,7 +2041,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-semver", @@ -2246,7 +2246,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-semver", @@ -2518,7 +2518,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "zeroize", @@ -3118,7 +3118,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-semver", @@ -3387,7 +3387,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -3469,7 +3469,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -3568,7 +3568,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -3632,7 +3632,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-semver", @@ -3938,7 +3938,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -4107,7 +4107,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-semver", @@ -4132,7 +4132,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", ] @@ -4234,7 +4234,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -4724,20 +4724,6 @@ dependencies = [ "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] -[[package]] -name = "xous-api-susres" -version = "0.9.0" -dependencies = [ - "log", - "num-derive", - "num-traits", - "rkyv", - "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", - "xous-api-log", - "xous-api-names", - "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", -] - [[package]] name = "xous-api-susres" version = "0.9.0" @@ -4755,6 +4741,20 @@ dependencies = [ "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] +[[package]] +name = "xous-api-susres" +version = "0.9.1" +dependencies = [ + "log", + "num-derive", + "num-traits", + "rkyv", + "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-log", + "xous-api-names", + "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", +] + [[package]] name = "xous-api-ticktimer" version = "0.9.0" @@ -4768,7 +4768,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-semver", ] @@ -4865,7 +4865,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0", + "xous-api-susres 0.9.1", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -4881,7 +4881,7 @@ dependencies = [ "xous 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-api-log", "xous-api-names", - "xous-api-susres 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)", + "xous-api-susres 0.9.0", "xous-api-ticktimer", "xous-ipc 0.9.9 (registry+https://github.com/rust-lang/crates.io-index)", "xous-semver", diff --git a/api/susres/Cargo.toml b/api/susres/Cargo.toml index 7f12bb641..8b4185fd9 100644 --- a/api/susres/Cargo.toml +++ b/api/susres/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "xous-api-susres" -version = "0.9.0" +version = "0.9.1" authors = ["bunnie "] edition = "2018" description = "Manager of suspend/resume operations" diff --git a/api/susres/src/lib.rs b/api/susres/src/lib.rs index 5a2f821ff..59e7ca51d 100644 --- a/api/susres/src/lib.rs +++ b/api/susres/src/lib.rs @@ -54,6 +54,13 @@ impl Susres { #[cfg(any(feature="hosted", not(any(feature="precursor", feature="renode", feature="hosted")) ))] + /// When created, the `susres` object can be configured with a `SuspendOrder` to enforce + /// sequencing rules in shutdown. It also requires arguments to define a callback which is + /// pinged when a suspend event arrives. The callback takes the form of a `CID, discriminant` + /// pair, where the CID is the local connection ID to the caller (in other words, a self-connection + /// to the caller), and the discriminant is the number placed into the Xous message's `body.id()` + /// field. This is typically just the descriminant of the main loop's opcode enum for the + /// suspend-resume opcode. pub fn new(_ordering: Option, xns: &xous_names::XousNames, cb_discriminant: u32, cid: CID) -> Result { REFCOUNT.fetch_add(1, Ordering::Relaxed); Ok(Susres {