Merge pull request #656 from betrusted-io/sam.hello-world

adding bao-console functions (`i2cdetect` and `cute`)

Author: bunnie

Cargo.lock

@@ -91,6 +91,10 @@ use usb::*;
 mod pddb;
 #[cfg(feature = "with-pddb")]
 use pddb::*;
+mod i2cdetect;
+use i2cdetect::*;
+mod cute;
+use cute::*;
 
 pub struct CmdEnv {
     common_env: CommonEnv,
@@ -138,11 +142,16 @@ impl CmdEnv {
         let mut echo_cmd = Echo {}; // this command has no persistent storage, so we can "create" it every time we call dispatch (but it's a zero-cost absraction so this doesn't actually create any instructions)
         let mut ver_cmd = Ver {};
         let mut console_cmd = Test {};
+        let mut i2cdetect_cmd = I2cDetect {};
+        let mut cute_cmd = Cute {};
+
         let commands: &mut [&mut dyn ShellCmdApi] = &mut [
             ///// 4. add your command to this array, so that it can be looked up and dispatched
             &mut echo_cmd,
             &mut ver_cmd,
             &mut self.trng_cmd,
+            &mut i2cdetect_cmd,
+            &mut cute_cmd,
             &mut console_cmd,
             #[cfg(feature = "usb")]
             &mut self.usb,

services/bao-console/src/cmds.rs

@@ -0,0 +1,90 @@
+use String;
+
+use crate::{CommonEnv, ShellCmdApi};
+
+#[derive(Debug)]
+pub struct Cute {}
+
+impl<'a> ShellCmdApi<'a> for Cute {
+    cmd_api!(cute);
+
+    fn process(&mut self, args: String, _env: &mut CommonEnv) -> Result<Option<String>, xous::Error> {
+        use core::fmt::Write;
+        let mut ret = String::new();
+        let helpstring = "Usage:
+  cute cat       - prints cat ascii art
+  cute bread     - prints bread ascii art
+  cute breadcat  - prints breadcat ascii art";
+
+        let mut tokens = args.split_whitespace();
+
+        if let Some(sub_cmd) = tokens.next() {
+            match sub_cmd {
+                "cat" => {
+                    let cat_art = r#"
+⠀⠀⠀⠀⢀⠠⠤⠀⢀⣿⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠐⠀⠐⠀⠀⢀⣾⣿⡇⠀⠀⠀⠀⠀⢀⣼⡇⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⣸⣿⣿⣿⠀⠀⠀⠀⣴⣿⣿⠇⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⢠⣿⣿⣿⣇⠀⠀⢀⣾⣿⣿⣿⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⣴⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡟⠀⠀⠐⠀⡀
+⠀⠀⠀⠀⢰⡿⠉⠀⡜⣿⣿⣿⡿⠿⢿⣿⣿⡃⠀⠀⠂⠄⠀
+⠀⠀⠒⠒⠸⣿⣄⡘⣃⣿⣿⡟⢰⠃⠀⢹⣿⡇⠀⠀⠀⠀⠀
+⠀⠀⠚⠉⠀⠊⠻⣿⣿⣿⣿⣿⣮⣤⣤⣿⡟⠁⠘⠠⠁⠀⠀
+⠀⠀⠀⠀⠀⠠⠀⠀⠈⠙⠛⠛⠛⠛⠛⠁⠀⠒⠤⠀⠀⠀⠀
+⠨⠠⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠑⠀⠀⠀⠀⠀⠀
+⠁⠃⠉⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+"#;
+                    write!(ret, "{}", cat_art).unwrap();
+                }
+                "bread" => {
+                    let bread_art = r#"
+⠀⠀⠀⠀⣀⣠⣤⣤⣤⣤⣤⣄⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⣴⣿⣿⠿⠛⣉⣁⣠⣤⣤⣤⣬⣀⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⢸⣿⣿⣿⣿⣿⣿⡿⠛⣉⣁⣠⣤⣤⣤⣬⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⢸⣿⣿⣿⣿⣿⣵⣾⣿⡿⠟⠛⠉⣉⣉⣉⣉⠉⠓⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⢸⣿⣿⣿⣿⣿⣿⡟⢁⣤⣶⣿⣿⣿⣿⣿⣿⣿⣿⣶⣄⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⢸⣿⣿⣿⣿⣿⣿⠀⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠇⠀⠀⠀⠀⠀⠀⠀
+⠀⢿⣿⣿⣿⣿⣿⣿⡄⢹⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠈⠻⣿⣿⣿⣿⣿⣷⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣇⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠈⠻⣿⣿⣿⣿⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠙⢿⣿⠇⢰⣿⣿⣿⣿⡿⠛⢉⣩⣉⡉⠛⠻⠇⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠙⠀⠸⠿⠿⠟⢉⣠⣾⣿⣿⣿⣿⣷⣶⣦⣤⣄⣀⣀⡀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣴⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡷⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢈⣉⣉⠉⠛⠛⠻⠿⣿⣿⣿⣿⣿⣿⣿⠿⠋⣀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠛⠛⠛⠛⠻⠶⣶⣤⣈⣉⣉⣉⣁⣤⣴⠾⠛⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⠙⠛⠉⠉⠉⠀⠀⠀⠀
+"#;
+                    write!(ret, "{}", bread_art).unwrap();
+                }
+                "breadcat" => {
+                    let breadcat_art = r#"
+⠀⠀⠀⠰⣦⣤⣤⣀⠀⠀⡀⠀⠀⠀⠀⣀⣀⠀⠠⢤⣶⣶⣿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⢿⣿⢋⣵⣾⣿⣿⡿⣥⣮⢻⣿⣿⣿⣿⣶⣌⢿⣿⢰⣶⣶⣶⣶⣶⣶⣶⣶⣶⣶⣦⣤⡀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠘⢡⣿⣿⣿⣿⣿⣷⡹⠟⣵⣿⣿⣿⣿⣿⣿⣦⢃⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⢺⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⢨⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⣿⣿⣿⡟⣸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠙⣿⣷⣬⣿⣿⣿⣿⣿⣿⣿⡼⣿⣿⡟⣱⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⣿⣧⣠⣿⣿⣿⣿⣿⣿⣿⣀⣾⣿⡇⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣅⣽⣿⣿⣿⣿⣿⣿⡇⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣦⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⡀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠛⠙⠋⠋⠋⠋⠋⠋⠋⠋⠛⠙⠙⠁⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⢿⣿⣿⣿⣿⣿⣧⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢈⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡠⣴⣶⣉⢿⣿⣿⣿⡟⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣤⣆⡻⣿⣷⠜⣿⣏⣾⣿⣿⡿⠁⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⣿⣿⣿⣇⣿⣿⣽⣿⣿⣿⠿⠋⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⢿⣿⣿⣿⣿⣿⠿⠟⠋⠁⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠉⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+"#;
+                    write!(ret, "{}", breadcat_art).unwrap();
+                }
+                _ => {
+                    write!(ret, "{}\n", helpstring).unwrap();
+                }
+            }
+        } else {
+            write!(ret, "{}\n", helpstring).unwrap();
+        }
+
+        Ok(Some(ret))
+    }
+}

services/bao-console/src/cmds/cute.rs

@@ -0,0 +1,103 @@
+use String;
+use cram_hal_service::I2c;
+use cramium_api::I2cApi;
+use cramium_api::I2cResult;
+
+use crate::{CommonEnv, ShellCmdApi};
+
+#[derive(Debug)]
+
+enum ProbeStatus {
+    Ack,
+    Nack,
+}
+
+fn probe_address(i2c: &mut I2c, addr: u8) -> ProbeStatus {
+    let mut buf = [0u8; 1];
+    match i2c.i2c_read(addr, 0x00, &mut buf, false) {
+        Ok(I2cResult::Ack(_)) => ProbeStatus::Ack,
+        Ok(I2cResult::Nack) => ProbeStatus::Nack,
+        Ok(I2cResult::Pending) => panic!("Unexpected I2cResult::Pending: this operation should be blocking."),
+        Ok(I2cResult::InternalError) => panic!("Unexpected Ok(I2cResult::InternalError)."),
+        Err(e) => panic!("I2C bus error while probing address 0x{:02X}: {:?}", addr, e),
+    }
+}
+
+pub struct I2cDetect {}
+
+impl<'a> ShellCmdApi<'a> for I2cDetect {
+    cmd_api!(i2cdetect);
+
+    fn process(&mut self, args: String, _env: &mut CommonEnv) -> Result<Option<String>, xous::Error> {
+        use core::fmt::Write;
+        let mut ret = String::new();
+        let helpstring = "Usage:
+    i2cdetect probe <hex>        - probes a single I2C address (e.g. 34)
+    i2cdetect scan               - reads all addresses on the bus (use with caution!)";
+
+        let mut tokens = args.split_whitespace();
+
+        if let Some(sub_cmd) = tokens.next() {
+            match sub_cmd {
+                "probe" => {
+                    if let Some(addr_str) = tokens.next() {
+                        match u8::from_str_radix(addr_str, 16) {
+                            Ok(addr) => {
+                                let mut i2c = I2c::new();
+                                let status = probe_address(&mut i2c, addr);
+                                match status {
+                                    ProbeStatus::Ack => {
+                                        write!(ret, "Device found at address {:02X}\n", addr).unwrap()
+                                    }
+                                    ProbeStatus::Nack => {
+                                        write!(ret, "Device at address {:02X} responded with NACK\n", addr)
+                                            .unwrap()
+                                    }
+                                };
+                            }
+                            Err(_) => {
+                                write!(
+                                    ret,
+                                    "Invalid hex address '{}'. Example: i2cdetect probe 3C\n",
+                                    addr_str
+                                )
+                                .unwrap();
+                            }
+                        }
+                    } else {
+                        write!(ret, "Usage: i2cdetect probe <hexaddr>\n").unwrap();
+                    }
+                }
+
+                "scan" => {
+                    let mut i2c = I2c::new();
+                    writeln!(&mut ret, "     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f").unwrap();
+                    for row in 0..8 {
+                        write!(&mut ret, "{:02x}: ", row * 16).unwrap();
+                        for col in 0..16 {
+                            let addr = (row * 16 + col) as u8;
+                            if addr < 0x03 || addr > 0x77 {
+                                write!(&mut ret, "   ").unwrap();
+                            } else {
+                                let status = probe_address(&mut i2c, addr);
+                                match status {
+                                    ProbeStatus::Ack => write!(&mut ret, "{:02x} ", addr).unwrap(),
+                                    ProbeStatus::Nack => write!(&mut ret, "-- ").unwrap(),
+                                };
+                            }
+                        }
+                        writeln!(&mut ret).unwrap();
+                    }
+                }
+
+                _ => {
+                    write!(ret, "{}\n", helpstring).unwrap();
+                }
+            }
+        } else {
+            write!(ret, "{}\n", helpstring).unwrap();
+        }
+
+        Ok(Some(ret))
+    }
+}

services/bao-console/src/cmds/i2cdetect.rs

@@ -612,7 +612,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
             //   - [planned] vault application
             let bao_rram_pkgs =
                 ["xous-ticktimer", "xous-log", "xous-names", "keystore" /* "usb-cramium" */].to_vec(); /* "usb-cramium" */
-            let bao_swap_pkgs = ["cram-hal-service", "bao-console", "modals", "pddb", "bao-video"].to_vec(); /* "bao-video" */
+            let bao_swap_pkgs =
+                ["cram-hal-service", "bao-console", /* "modals", "pddb", */ "bao-video"].to_vec(); /* "bao-video" */
             if !builder.is_swap_set() {
                 builder.set_swap(0, 8 * 1024 * 1024);
             }