ci/fpga-boss: add SDMux implementation for usbsdmux (#2143)

* ci/fpga-boss: add SDMux implementation for usbsdmux

Signed-off-by: leongross <leon.gross@9elements.com>

Author: leongross

ci-tools/fpga-boss/README.md

@@ -13,7 +13,7 @@ You need:
 
 To use the flashing feature, you will need
 
-* An [SDWire](https://wiki.tizen.org/SDWire) SD mux or compatible clone.
+* An [SDWire](https://wiki.tizen.org/SDWire) SD mux or compatible clone or an [usbsdmux](https://github.com/linux-automation/usbsdmux/). 
 
 ## How do I determine the `--zcu104` parameter for my hardware?
 
@@ -29,6 +29,20 @@ sudo dmesg | grep 'idVendor=0403, idProduct=6011'
 In this case, the USB path is `1-14.3`.
 
 
+## How do I determine the `--usbsdmux` parameter for my hardware?
+
+If you use the `usbsdmux` please refer to the official documentation and follow all the required steps to set up the udev rules and cli tools appropriately. 
+
+When set up, the connected `usbsdmux` device(s) will be exposed in `/dev/usb-sd-mux/`.
+
+```sh
+$ ls /dev/usb-sd-mux/
+total 0
+lrwxrwxrwx 1 root plugdev 1 Jan 01 00:00 id-00048.00643
+```
+
+Note this file name and trim the `id` to get the ID needed for the `--usbsdmux` cli parameter.
+
 ## How do I determine the `--sdwire` parameter for my hardware?
 
 This is the USB port path of the USB hub built into the SDWire0 (SDWire contains
@@ -68,7 +82,12 @@ $ sudo bash build.sh
 
 ```
 $ cd ci-tools/fpga-boss
+# SDwire
 $ cargo run -- --zcu104 1-14.3 --sdwire 1-14.6 flash ../fpga-image/out/image.img
+
+# usbsdmux
+# $ cargo run -- --zcu104 1-14.3 --usbsdmux 00048.00643 flash ../fpga-image/out/image.img
+
 Block device associated with 1-14.2.1 is /dev/sda
 Flashing ../fpga-image/out/image.img to /dev/sda
 Waiting for attached sd card to be noticed by OS
@@ -80,8 +99,9 @@ fpga-boss as root.
 
 ### To observe the UART output of the now booting FPGA:
 
+Example for `sdwire`
 ```
-$ cargo run -- --zcu104 1-14.3 --sdwire 1-14.2  console
+$ cargo run -- --zcu104 1-14.3 --sdwire 1-14.6  console
 To exit terminal type Ctrl-T then Q
 
 
@@ -99,6 +119,7 @@ We have four zcu104 boards connected to a Raspberry pi running four instances of
 
 ```
 # fpga-boss --zcu104 x-x.x --sdwire x-x.x serve image.img -- /path/to/rtool receive_jitconfig
+# fpga-boss --zcu104 x-x.x --usbsdmux xxxxx.xxxxx serve image.img -- /path/to/rtool receive_jitconfig
 ```
 
 The serve subcommand runs in a loop that does the following:

ci-tools/fpga-boss/src/ftdi.rs

@@ -24,6 +24,7 @@ pub enum BitMode {
     BitBang = 0x01,
     CBus = 0x20,
 }
+
 pub struct FtdiCtx {
     ctx: *mut libftdi1_sys::ftdi_context,
     port_path: UsbPortPath,

ci-tools/fpga-boss/src/main.rs

@@ -9,7 +9,6 @@ mod tty;
 mod usb_port_path;
 
 use anyhow::{anyhow, Context};
-use find_usb_block_device::find_usb_block_device;
 
 use clap::{arg, value_parser};
 use libftdi1_sys::ftdi_interface;
@@ -24,15 +23,18 @@ use std::{
 
 pub(crate) use fpga_jtag::{FpgaJtag, FpgaReset};
 pub(crate) use ftdi::FtdiCtx;
-pub(crate) use sd_mux::{SdMux, SdMuxTarget};
+use sd_mux::{SDWire, SdMux, SdMuxTarget, UsbsdMux};
 pub(crate) use usb_port_path::UsbPortPath;
 
 fn cli() -> clap::Command<'static> {
     clap::Command::new("fpga-boss")
         .about("FPGA boss tool")
         .arg(
             arg!(--"sdwire" [PORT_PATH] "USB port path to the hub chip on the SDWire (ex: 3-1.2)")
-                .value_parser(value_parser!(UsbPortPath))
+                .value_parser(value_parser!(OsString)))
+        .arg(
+            arg!(--"usbsdmux" [USBID] "USB unique ID for the usbsdmux device (ex: 00048.00643)")
+                .value_parser(value_parser!(OsString))
         )
         .arg(
             arg!(--"zcu104" [PORT_PATH] "USB port path to the FTDI chip on the ZCU104 dev board (ex: 3-1.2)")
@@ -93,21 +95,21 @@ fn open_block_dev(path: &Path) -> std::io::Result<File> {
     }
 }
 
-/// Returns true if the device alread contains the image.
+/// Returns true if the device already contains the image.
 fn verify_image(dev: &mut File, image: &mut File) -> std::io::Result<bool> {
     dev.seek(SeekFrom::Start(0))?;
     let file_len = image.metadata()?.len();
-    let mut buf1 = vec![0_u8; 1024 * 1024];
-    let mut buf2 = vec![0_u8; 1024 * 1024];
+    let mut want = vec![0_u8; 1024 * 1024];
+    let mut have = vec![0_u8; 1024 * 1024];
     let mut total_read: u64 = 0;
     let start_time = Instant::now();
     loop {
-        let bytes_read = image.read(&mut buf1)?;
+        let bytes_read = image.read(&mut want)?;
         if bytes_read == 0 {
             return Ok(true);
         }
-        dev.read_exact(&mut buf2[..bytes_read])?;
-        if buf1[..bytes_read] != buf2[..bytes_read] {
+        dev.read_exact(&mut have[..bytes_read])?;
+        if want[..bytes_read] != have[..bytes_read] {
             return Ok(false);
         }
         total_read += u64::try_from(bytes_read).unwrap();
@@ -162,7 +164,10 @@ fn active_runner_error_checks(input: &str) -> std::io::Result<()> {
 /// to recover the FPGA.
 fn check_for_github_runner_exception(input: &str) -> std::io::Result<()> {
     if input.contains("Unhandled exception") {
-        Err(Error::new(ErrorKind::BrokenPipe, "Github runner had an unhandled exception"))?;
+        Err(Error::new(
+            ErrorKind::BrokenPipe,
+            "Github runner had an unhandled exception",
+        ))?;
     }
     Ok(())
 }
@@ -232,7 +237,9 @@ fn log_uart_until_helper<R: BufRead>(
 
 fn main_impl() -> anyhow::Result<()> {
     let matches = cli().get_matches();
-    let sdwire_hub_path = matches.get_one::<UsbPortPath>("sdwire");
+    let sdwire = matches.get_one::<OsString>("sdwire");
+    let usbsdmux = matches.get_one::<OsString>("usbsdmux");
+
     let zcu104_path = matches.get_one::<UsbPortPath>("zcu104");
     let boss_ftdi_path = matches.get_one::<UsbPortPath>("boss_ftdi");
 
@@ -251,28 +258,21 @@ fn main_impl() -> anyhow::Result<()> {
             .ok_or(anyhow!("--zcu104 flag required"))
             .cloned()
     };
-    let get_sd_mux = || {
-        SdMux::open(
-            sdwire_hub_path
-                .ok_or(anyhow!("--sdwire flag required"))?
-                .child(2),
-        )
-    };
-    let get_fpga_ftdi = || FpgaJtag::open(get_zcu104_path()?);
-    let get_sd_dev_path = || {
-        let sdwire_hub_path = sdwire_hub_path.ok_or(anyhow!("--sdwire flag required"))?;
-        find_usb_block_device(&sdwire_hub_path.child(1)).with_context(|| {
-            format!(
-                "Could not find block device associated with {}",
-                sdwire_hub_path.child(1)
-            )
-        })
+
+    let mut sd_mux: Box<dyn SdMux> = match (sdwire, usbsdmux) {
+        (Some(sdwire), None) => {
+            Box::new(SDWire::open(String::from(sdwire.to_str().unwrap()))?) as Box<dyn SdMux>
+        }
+        (None, Some(usbsdmux)) => {
+            Box::new(UsbsdMux::open(String::from(usbsdmux.to_str().unwrap()))?) as Box<dyn SdMux>
+        }
+        _ => return Err(anyhow!("One of --sdwire or --usbsdmux required")),
     };
 
+    let get_fpga_ftdi = || FpgaJtag::open(get_zcu104_path()?);
     match matches.subcommand() {
         Some(("mode", sub_matches)) => {
             let mut fpga = get_fpga_ftdi();
-            let mut sd_mux = get_sd_mux()?;
             match sub_matches.get_one::<SdMuxTarget>("MODE").unwrap() {
                 SdMuxTarget::Dut => {
                     if let Ok(fpga) = &mut fpga {
@@ -335,8 +335,7 @@ fn main_impl() -> anyhow::Result<()> {
         }
         Some(("flash", sub_matches)) => {
             let mut fpga = get_fpga_ftdi();
-            let mut sd_mux = get_sd_mux()?;
-            let sd_dev_path = get_sd_dev_path()?;
+            let sd_dev_path = sd_mux.get_sd_dev_path()?;
             if let Ok(fpga) = &mut fpga {
                 fpga.set_reset(FpgaReset::Reset)?;
             }
@@ -362,14 +361,14 @@ fn main_impl() -> anyhow::Result<()> {
                 fpga.set_reset(FpgaReset::Run)?
             }
         }
+
         Some(("serve", sub_matches)) => {
             // Reuse the previous token if we never connect to GitHub.
             // This avoids creating a bunch of offline runners if the FPGA fails to establish a
             // connection.
             let mut cached_token: Option<Vec<u8>> = None;
             let mut fpga = get_fpga_ftdi()?;
-            let mut sd_mux = get_sd_mux()?;
-            let sd_dev_path = get_sd_dev_path()?;
+            let sd_dev_path = sd_mux.get_sd_dev_path()?;
             'outer: loop {
                 println!("Putting FPGA into reset");
                 fpga.set_reset(FpgaReset::Reset)?;