[opentitanlib] add option to ignore SPI console frame numbers

When opentitanlib is invoked via an external C/C++ wrapper library, the
SpiConsoleDevice object is reinstantiated repeatedly to comply with
Rust's ownership rules (and satisfy the borrow checker). On each
reinstantiation of the SpiConsoleDevice struct, the next expected frame
number is reset to 0. This causes the SpiConsoleDevice to ignore a valid
frame when used through an external wrapper library, as is the case with
the OtlibWrapper used in the opentitan-provisioning repo. This was
causing CI issues in
lowRISC/opentitan-provisioning#165.

As such, this provides a mechanism for users of the SpiConsoleDevice to
ignore the frame number, which frankly  is not necessary when the
SpiConsoleDevice is used alongside the TX-indicator GPIO feature.
This feature does not make use of a circular transmit buffer, but rather
transmits only a single frame in the buffer at a time.

Signed-off-by: Tim Trippel <[email protected]>
(cherry picked from commit 9ca5d54)

Author: timothytrippel

sw/host/opentitanlib/src/console/spi.rs

@@ -20,6 +20,7 @@ pub struct SpiConsoleDevice<'a> {
     rx_buf: RefCell<VecDeque<u8>>,
     next_read_address: Cell<u32>,
     device_tx_ready_pin: Option<&'a Rc<dyn GpioPin>>,
+    ignore_frame_num: bool,
 }
 
 impl<'a> SpiConsoleDevice<'a> {
@@ -34,6 +35,7 @@ impl<'a> SpiConsoleDevice<'a> {
     pub fn new(
         spi: &'a dyn Target,
         device_tx_ready_pin: Option<&'a Rc<dyn GpioPin>>,
+        ignore_frame_num: bool,
     ) -> Result<Self> {
         let flash = SpiFlash {
             ..Default::default()
@@ -45,6 +47,7 @@ impl<'a> SpiConsoleDevice<'a> {
             console_next_frame_number: Cell::new(0),
             next_read_address: Cell::new(0),
             device_tx_ready_pin,
+            ignore_frame_num,
         })
     }
 
@@ -76,7 +79,7 @@ impl<'a> SpiConsoleDevice<'a> {
         let frame_number: u32 = u32::from_le_bytes(header[4..8].try_into().unwrap());
         let data_len_bytes: usize = u32::from_le_bytes(header[8..12].try_into().unwrap()) as usize;
         if magic_number != SpiConsoleDevice::SPI_FRAME_MAGIC_NUMBER
-            || frame_number != self.console_next_frame_number.get()
+            || (!self.ignore_frame_num && frame_number != self.console_next_frame_number.get())
             || data_len_bytes > SpiConsoleDevice::SPI_MAX_DATA_LENGTH
         {
             if self.device_tx_ready_pin.is_none() {

sw/host/provisioning/cp/src/main.rs

@@ -50,7 +50,11 @@ fn main() -> Result<()> {
     let device_console_tx_ready_pin = &transport.gpio_pin(&opts.console_tx_indicator_pin)?;
     device_console_tx_ready_pin.set_mode(PinMode::Input)?;
     device_console_tx_ready_pin.set_pull_mode(PullMode::None)?;
-    let spi_console_device = SpiConsoleDevice::new(&*spi, Some(device_console_tx_ready_pin))?;
+    let spi_console_device = SpiConsoleDevice::new(
+        &*spi,
+        Some(device_console_tx_ready_pin),
+        /*ignore_frame_num=*/ false,
+    )?;
 
     let provisioning_data = ManufCpProvisioningData {
         wafer_auth_secret: hex_string_to_u32_arrayvec::<8>(

sw/host/provisioning/ft/src/main.rs

@@ -129,7 +129,11 @@ fn main() -> Result<()> {
     let device_console_tx_ready_pin = &transport.gpio_pin(&opts.console_tx_indicator_pin)?;
     device_console_tx_ready_pin.set_mode(PinMode::Input)?;
     device_console_tx_ready_pin.set_pull_mode(PullMode::None)?;
-    let spi_console = SpiConsoleDevice::new(&*spi, Some(device_console_tx_ready_pin))?;
+    let spi_console = SpiConsoleDevice::new(
+        &*spi,
+        Some(device_console_tx_ready_pin),
+        /*ignore_frame_num=*/ false,
+    )?;
     InitializeTest::print_result(
         "load_bitstream",
         opts.init.load_bitstream.init(&transport).map(|_| None),

sw/host/tests/chip/ottf_console_with_gpio_tx_indicator/src/main.rs

@@ -42,7 +42,11 @@ fn spi_device_console_test(opts: &Opts, transport: &TransportWrapper) -> Result<
     let device_console_tx_ready_pin = &transport.gpio_pin("IOA5")?;
     device_console_tx_ready_pin.set_mode(PinMode::Input)?;
     device_console_tx_ready_pin.set_pull_mode(PullMode::None)?;
-    let spi_console_device = SpiConsoleDevice::new(&*spi, Some(device_console_tx_ready_pin))?;
+    let spi_console_device = SpiConsoleDevice::new(
+        &*spi,
+        Some(device_console_tx_ready_pin),
+        /*ignore_frame_num=*/ false,
+    )?;
 
     // Load the ELF binary and get the expect data.
     let elf_binary = fs::read(&opts.firmware_elf)?;

sw/host/tests/chip/spi_device_ottf_console/src/main.rs

@@ -45,7 +45,7 @@ fn spi_device_console_test(opts: &Opts, transport: &TransportWrapper) -> Result<
     );
     let spi = transport.spi(&opts.console_spi)?;
 
-    let spi_console_device = SpiConsoleDevice::new(&*spi, None)?;
+    let spi_console_device = SpiConsoleDevice::new(&*spi, None, /*ignore_frame_num=*/ false)?;
     let _ = UartConsole::wait_for(&spi_console_device, r"Running ", opts.timeout)?;
 
     /* Load the ELF binary and get the expect data.*/

sw/host/tests/chip/spi_device_ujson_console_test/src/main.rs

@@ -109,7 +109,7 @@ fn main() -> Result<()> {
 
     let transport = opts.init.init_target()?;
     let spi = transport.spi(&opts.console_spi)?;
-    let spi_console_device = SpiConsoleDevice::new(&*spi, None)?;
+    let spi_console_device = SpiConsoleDevice::new(&*spi, None, /*ignore_frame_num=*/ false)?;
     let _ = UartConsole::wait_for(&spi_console_device, r"Running ", opts.timeout)?;
 
     execute_test!(test_perso_blob_strcut, &opts, &spi_console_device);

sw/host/tests/crypto/acvp/src/main.rs

@@ -68,7 +68,7 @@ fn run<R: std::io::Read, W: std::io::Write>(
     output: Option<W>,
 ) -> Result<()> {
     let spi = transport.spi("BOOTSTRAP")?;
-    let spi_console_device = SpiConsoleDevice::new(&*spi, None)?;
+    let spi_console_device = SpiConsoleDevice::new(&*spi, None, /*ignore_frame_num=*/ false)?;
     let _ = UartConsole::wait_for(&spi_console_device, r"Running ", opts.timeout)?;
 
     let acvp_vectors: Vec<AcvpVectors> = serde_json::from_reader(input)?;

sw/host/tests/crypto/aes_gcm_nist_kat/src/main.rs

@@ -137,7 +137,7 @@ fn run_aes_gcm_testcase(
 
 fn test_aes_gcm(opts: &Opts, transport: &TransportWrapper) -> Result<()> {
     let spi = transport.spi("BOOTSTRAP")?;
-    let spi_console_device = SpiConsoleDevice::new(&*spi, None)?;
+    let spi_console_device = SpiConsoleDevice::new(&*spi, None, /*ignore_frame_num=*/ false)?;
     let _ = UartConsole::wait_for(&spi_console_device, r"Running ", opts.timeout)?;
 
     let mut test_counter = 0u32;

sw/host/tests/crypto/aes_nist_kat/src/main.rs

@@ -130,7 +130,7 @@ fn run_aes_testcase(
 
 fn test_aes(opts: &Opts, transport: &TransportWrapper) -> Result<()> {
     let spi = transport.spi("BOOTSTRAP")?;
-    let spi_console_device = SpiConsoleDevice::new(&*spi, None)?;
+    let spi_console_device = SpiConsoleDevice::new(&*spi, None, /*ignore_frame_num=*/ false)?;
     let _ = UartConsole::wait_for(&spi_console_device, r"Running ", opts.timeout)?;
 
     let mut test_counter = 0u32;

sw/host/tests/crypto/drbg_kat/src/main.rs

@@ -128,7 +128,7 @@ fn run_drbg_testcase(
 
 fn test_drbg(opts: &Opts, transport: &TransportWrapper) -> Result<()> {
     let spi = transport.spi("BOOTSTRAP")?;
-    let spi_console_device = SpiConsoleDevice::new(&*spi, None)?;
+    let spi_console_device = SpiConsoleDevice::new(&*spi, None, /*ignore_frame_num=*/ false)?;
     let _ = UartConsole::wait_for(&spi_console_device, r"Running ", opts.timeout)?;
 
     let mut test_counter = 0u32;