More descriptive error type and ringbuf logging

Author: mkeeter

task/host-sp-comms/src/main.rs

@@ -134,6 +134,11 @@ enum Trace {
         #[count(children)]
         message: SpToHost,
     },
+    APOBWriteError {
+        offset: u64,
+        #[count(children)]
+        err: APOBError,
+    },
 }
 
 counted_ringbuf!(Trace, 20, Trace::None);
@@ -160,6 +165,31 @@ enum Timers {
     TxPeriodicZeroByte,
 }
 
+#[derive(Copy, Clone, Debug, Eq, PartialEq, counters::Count)]
+enum APOBError {
+    OffsetOverflow {
+        offset: u64,
+    },
+    NotErased {
+        offset: u32,
+    },
+    EraseFailed {
+        offset: u32,
+        #[count(children)]
+        err: drv_hf_api::HfError,
+    },
+    WriteFailed {
+        offset: u32,
+        #[count(children)]
+        err: drv_hf_api::HfError,
+    },
+    ReadFailed {
+        offset: u32,
+        #[count(children)]
+        err: drv_hf_api::HfError,
+    },
+}
+
 #[export_name = "main"]
 fn main() -> ! {
     let mut server = ServerImpl::claim_static_resources();
@@ -970,7 +1000,10 @@ impl ServerImpl {
             HostToSp::APOB { offset } => {
                 Some(match Self::apob_write(&self.hf, offset, data) {
                     Ok(()) => SpToHost::APOBResult(0),
-                    Err(_) => SpToHost::APOBResult(1),
+                    Err(err) => {
+                        ringbuf_entry!(Trace::APOBWriteError { offset, err });
+                        SpToHost::APOBResult(1)
+                    }
                 })
             }
         };
@@ -1008,13 +1041,13 @@ impl ServerImpl {
         hf: &HostFlash,
         mut offset: u64,
         data: &[u8],
-    ) -> Result<(), drv_hf_api::HfError> {
+    ) -> Result<(), APOBError> {
         for chunk in data.chunks(drv_hf_api::PAGE_SIZE_BYTES) {
             Self::apob_write_page(
                 hf,
                 offset
                     .try_into()
-                    .map_err(|_| drv_hf_api::HfError::BadAddress)?,
+                    .map_err(|_| APOBError::OffsetOverflow { offset })?,
                 chunk,
             )?;
             offset += chunk.len() as u64;
@@ -1029,19 +1062,21 @@ impl ServerImpl {
         hf: &HostFlash,
         offset: u32,
         data: &[u8],
-    ) -> Result<(), drv_hf_api::HfError> {
+    ) -> Result<(), APOBError> {
         if offset as usize % drv_hf_api::SECTOR_SIZE_BYTES == 0 {
-            hf.bonus_sector_erase(offset)?;
+            hf.bonus_sector_erase(offset)
+                .map_err(|err| APOBError::EraseFailed { offset, err })?;
         } else {
             // Read back the page and confirm that it's all empty
             let mut scratch = [0u8; drv_hf_api::PAGE_SIZE_BYTES];
-            hf.bonus_read(offset, &mut scratch[..data.len()])?;
+            hf.bonus_read(offset, &mut scratch[..data.len()])
+                .map_err(|err| APOBError::ReadFailed { offset, err })?;
             if !scratch[..data.len()].iter().all(|b| *b == 0xFF) {
-                // TODO use a different error here?
-                return Err(drv_hf_api::HfError::BadAddress);
+                return Err(APOBError::NotErased { offset });
             }
         }
         hf.bonus_page_program(offset, data)
+            .map_err(|err| APOBError::WriteFailed { offset, err })
     }
 
     fn handle_sprot(