tock · bradjc · Oct 10, 2023 · Sep 29, 2023 · Sep 29, 2023 · Sep 29, 2023
diff --git a/boards/opentitan/src/tests/flash.rs b/boards/opentitan/src/tests/flash.rs
diff --git a/capsules/core/src/virtualizers/virtual_flash.rs b/capsules/core/src/virtualizers/virtual_flash.rs
@@ -47,23 +47,31 @@ pub struct MuxFlash<'a, F: hil::flash::Flash + 'static> {
 }
 
 impl<F: hil::flash::Flash> hil::flash::Client<F> for MuxFlash<'_, F> {
-    fn read_complete(&self, pagebuffer: &'static mut F::Page, error: hil::flash::Error) {
+    fn read_complete(
+        &self,
+        pagebuffer: &'static mut F::Page,
+        result: Result<(), hil::flash::Error>,
+    ) {
         self.inflight.take().map(move |user| {
-            user.read_complete(pagebuffer, error);
+            user.read_complete(pagebuffer, result);
         });
         self.do_next_op();
     }
 
-    fn write_complete(&self, pagebuffer: &'static mut F::Page, error: hil::flash::Error) {
+    fn write_complete(
+        &self,
+        pagebuffer: &'static mut F::Page,
+        result: Result<(), hil::flash::Error>,
+    ) {
         self.inflight.take().map(move |user| {
-            user.write_complete(pagebuffer, error);
+            user.write_complete(pagebuffer, result);
         });
         self.do_next_op();
     }
 
-    fn erase_complete(&self, error: hil::flash::Error) {
+    fn erase_complete(&self, result: Result<(), hil::flash::Error>) {
         self.inflight.take().map(move |user| {
-            user.erase_complete(error);
+            user.erase_complete(result);
         });
         self.do_next_op();
     }
@@ -165,21 +173,29 @@ impl<'a, F: hil::flash::Flash, C: hil::flash::Client<Self>> hil::flash::HasClien
 }
 
 impl<'a, F: hil::flash::Flash> hil::flash::Client<F> for FlashUser<'a, F> {
-    fn read_complete(&self, pagebuffer: &'static mut F::Page, error: hil::flash::Error) {
+    fn read_complete(
+        &self,
+        pagebuffer: &'static mut F::Page,
+        result: Result<(), hil::flash::Error>,
+    ) {
         self.client.map(move |client| {
-            client.read_complete(pagebuffer, error);
+            client.read_complete(pagebuffer, result);
         });
     }
 
-    fn write_complete(&self, pagebuffer: &'static mut F::Page, error: hil::flash::Error) {
+    fn write_complete(
+        &self,
+        pagebuffer: &'static mut F::Page,
+        result: Result<(), hil::flash::Error>,
+    ) {
         self.client.map(move |client| {
-            client.write_complete(pagebuffer, error);
+            client.write_complete(pagebuffer, result);
         });
     }
 
-    fn erase_complete(&self, error: hil::flash::Error) {
+    fn erase_complete(&self, result: Result<(), hil::flash::Error>) {
         self.client.map(move |client| {
-            client.erase_complete(error);
+            client.erase_complete(result);
         });
     }
 }

diff --git a/capsules/extra/src/at24c_eeprom.rs b/capsules/extra/src/at24c_eeprom.rs
@@ -186,9 +186,9 @@ impl I2CClient for AT24C<'static> {
                     self.buffer.replace(buffer);
                     self.flash_client.map(|client| {
                         if status.is_err() {
-                            client.read_complete(client_page, hil::flash::Error::FlashError);
+                            client.read_complete(client_page, Err(hil::flash::Error::FlashError));
                         } else {
-                            client.read_complete(client_page, hil::flash::Error::CommandComplete);
+                            client.read_complete(client_page, Ok(()));
                         }
                     });
                 }
@@ -200,9 +200,9 @@ impl I2CClient for AT24C<'static> {
                 self.flash_client.map(|client| {
                     if let Some(client_page) = self.client_page.take() {
                         if status.is_err() {
-                            client.write_complete(client_page, hil::flash::Error::FlashError);
+                            client.write_complete(client_page, Err(hil::flash::Error::FlashError));
                         } else {
-                            client.write_complete(client_page, hil::flash::Error::CommandComplete);
+                            client.write_complete(client_page, Ok(()));
                         }
                     }
                 });
@@ -213,9 +213,9 @@ impl I2CClient for AT24C<'static> {
                 self.i2c.disable();
                 self.flash_client.map(move |client| {
                     if status.is_err() {
-                        client.erase_complete(hil::flash::Error::FlashError);
+                        client.erase_complete(Err(hil::flash::Error::FlashError));
                     } else {
-                        client.erase_complete(hil::flash::Error::CommandComplete);
+                        client.erase_complete(Ok(()));
                     }
                 });
             }

diff --git a/capsules/extra/src/humidity.rs b/capsules/extra/src/humidity.rs
@@ -25,7 +25,7 @@
 //! The `command` system call support one argument `cmd` which is used to specify the specific
 //! operation, currently the following cmd's are supported:
 //!
-//! * `0`: driver existence check
+//! * `0`: check whether the driver exists
 //! * `1`: read humidity
 //!
 //!

diff --git a/capsules/extra/src/log.rs b/capsules/extra/src/log.rs
@@ -783,16 +783,16 @@ impl<'a, F: Flash + 'static> LogWrite<'a> for Log<'a, F> {
 }
 
 impl<'a, F: Flash + 'static> flash::Client<F> for Log<'a, F> {
-    fn read_complete(&self, _read_buffer: &'static mut F::Page, _error: flash::Error) {
+    fn read_complete(&self, _read_buffer: &'static mut F::Page, _result: Result<(), flash::Error>) {
         // Reads are made directly from the storage volume, not through the flash interface.
         unreachable!();
     }
 
     /// If in the middle of a write operation, reset pagebuffer and finish write. If syncing, make
     /// successful client callback.
-    fn write_complete(&self, pagebuffer: &'static mut F::Page, error: flash::Error) {
-        match error {
-            flash::Error::CommandComplete => {
+    fn write_complete(&self, pagebuffer: &'static mut F::Page, result: Result<(), flash::Error>) {
+        match result.is_ok() {
+            true => {
                 match self.state.get() {
                     State::Append => {
                         // Reset pagebuffer and finish writing on the new page.
@@ -824,31 +824,35 @@ impl<'a, F: Flash + 'static> flash::Client<F> for Log<'a, F> {
                     _ => unreachable!(),
                 }
             }
-            flash::Error::FlashError | flash::Error::FlashMemoryProtectionError => {
-                // Make client callback with FAIL return code.
-                self.pagebuffer.replace(pagebuffer);
-                match self.state.get() {
-                    State::Append => {
-                        self.length.set(0);
-                        self.records_lost.set(false);
-                        self.error.set(Err(ErrorCode::FAIL));
-                        self.client_callback();
-                    }
-                    State::Sync => {
-                        self.error.set(Err(ErrorCode::FAIL));
-                        self.client_callback();
+            false => {
+                match result.unwrap_err() {
+                    flash::Error::FlashError | flash::Error::FlashMemoryProtectionError => {
+                        // Make client callback with FAIL return code.
+                        self.pagebuffer.replace(pagebuffer);
+                        match self.state.get() {
+                            State::Append => {
+                                self.length.set(0);
+                                self.records_lost.set(false);
+                                self.error.set(Err(ErrorCode::FAIL));
+                                self.client_callback();
+                            }
+                            State::Sync => {
+                                self.error.set(Err(ErrorCode::FAIL));
+                                self.client_callback();
+                            }
+                            _ => unreachable!(),
+                        }
                     }
-                    _ => unreachable!(),
                 }
             }
         }
     }
 
     /// Erase next page if log erase complete, else make client callback. Fails with BUSY if flash
     /// is busy and erase cannot be completed.
-    fn erase_complete(&self, error: flash::Error) {
-        match error {
-            flash::Error::CommandComplete => {
+    fn erase_complete(&self, result: Result<(), flash::Error>) {
+        match result.is_ok() {
+            true => {
                 let oldest_entry_id = self.oldest_entry_id.get();
                 if oldest_entry_id >= self.append_entry_id.get() - self.page_size {
                     // Erased all pages. Reset state and callback client.
@@ -872,10 +876,12 @@ impl<'a, F: Flash + 'static> flash::Client<F> for Log<'a, F> {
                     }
                 }
             }
-            flash::Error::FlashError | flash::Error::FlashMemoryProtectionError => {
-                self.error.set(Err(ErrorCode::FAIL));
-                self.client_callback();
-            }
+            false => match result.unwrap_err() {
+                flash::Error::FlashError | flash::Error::FlashMemoryProtectionError => {
+                    self.error.set(Err(ErrorCode::FAIL));
+                    self.client_callback();
+                }
+            },
         }
     }
 }

diff --git a/capsules/extra/src/mx25r6435f.rs b/capsules/extra/src/mx25r6435f.rs
@@ -404,7 +404,7 @@ impl<
                             self.rxbuffer.replace(read_buffer);
 
                             self.client.map(move |client| {
-                                client.read_complete(sector, hil::flash::Error::CommandComplete);
+                                client.read_complete(sector, Ok(()));
                             });
                         } else {
                             let address =
@@ -480,7 +480,7 @@ impl<
                 self.state.set(State::Idle);
                 self.txbuffer.replace(write_buffer);
                 self.client.map(|client| {
-                    client.erase_complete(hil::flash::Error::CommandComplete);
+                    client.erase_complete(Ok(()));
                 });
             }
             State::WriteSectorWriteEnable {
@@ -495,7 +495,7 @@ impl<
                     self.txbuffer.replace(write_buffer);
                     self.client.map(|client| {
                         self.client_sector.take().map(|sector| {
-                            client.write_complete(sector, hil::flash::Error::CommandComplete);
+                            client.write_complete(sector, Ok(()));
                         });
                     });
                 } else {

diff --git a/capsules/extra/src/nonvolatile_to_pages.rs b/capsules/extra/src/nonvolatile_to_pages.rs
@@ -192,7 +192,11 @@ impl<'a, F: hil::flash::Flash> hil::nonvolatile_storage::NonvolatileStorage<'a>
 }
 
 impl<F: hil::flash::Flash> hil::flash::Client<F> for NonvolatileToPages<'_, F> {
-    fn read_complete(&self, pagebuffer: &'static mut F::Page, _error: hil::flash::Error) {
+    fn read_complete(
+        &self,
+        pagebuffer: &'static mut F::Page,
+        _result: Result<(), hil::flash::Error>,
+    ) {
         match self.state.get() {
             State::Read => {
                 // OK we got a page from flash. Copy what we actually want from it
@@ -267,7 +271,11 @@ impl<F: hil::flash::Flash> hil::flash::Client<F> for NonvolatileToPages<'_, F> {
         }
     }
 
-    fn write_complete(&self, pagebuffer: &'static mut F::Page, _error: hil::flash::Error) {
+    fn write_complete(
+        &self,
+        pagebuffer: &'static mut F::Page,
+        _result: Result<(), hil::flash::Error>,
+    ) {
         // After a write we could be done, need to do another write, or need to
         // do a read.
         self.buffer.take().map(move |buffer| {
@@ -308,5 +316,5 @@ impl<F: hil::flash::Flash> hil::flash::Client<F> for NonvolatileToPages<'_, F> {
         });
     }
 
-    fn erase_complete(&self, _error: hil::flash::Error) {}
+    fn erase_complete(&self, _result: Result<(), hil::flash::Error>) {}
 }
diff --git a/capsules/extra/src/tickv.rs b/capsules/extra/src/tickv.rs
@@ -414,7 +414,7 @@ impl<'a, F: Flash, H: Hasher<'a, 8>, const PAGE_SIZE: usize> hasher::Client<8>
 impl<'a, F: Flash, H: Hasher<'a, 8>, const PAGE_SIZE: usize> flash::Client<F>
     for TicKVSystem<'a, F, H, PAGE_SIZE>
 {
-    fn read_complete(&self, pagebuffer: &'static mut F::Page, _error: flash::Error) {
+    fn read_complete(&self, pagebuffer: &'static mut F::Page, _result: Result<(), flash::Error>) {
         self.tickv.set_read_buffer(pagebuffer.as_mut());
         self.tickv
             .tickv
@@ -559,7 +559,7 @@ impl<'a, F: Flash, H: Hasher<'a, 8>, const PAGE_SIZE: usize> flash::Client<F>
         }
     }
 
-    fn write_complete(&self, pagebuffer: &'static mut F::Page, _error: flash::Error) {
+    fn write_complete(&self, pagebuffer: &'static mut F::Page, _result: Result<(), flash::Error>) {
         self.tickv
             .tickv
             .controller
@@ -590,7 +590,7 @@ impl<'a, F: Flash, H: Hasher<'a, 8>, const PAGE_SIZE: usize> flash::Client<F>
         }
     }
 
-    fn erase_complete(&self, _error: flash::Error) {
+    fn erase_complete(&self, _result: Result<(), flash::Error>) {
         let (ret, tickv_buf, tickv_buf_len) = self.tickv.continue_operation();
 
         // If we got the buffer back from TicKV then store it.

diff --git a/chips/lowrisc/src/flash_ctrl.rs b/chips/lowrisc/src/flash_ctrl.rs
@@ -524,22 +524,22 @@ impl<'a> FlashCtrl<'a> {
             if let Some(buf) = read_buf {
                 // We were doing a read
                 self.flash_client.map(move |client| {
-                    client.read_complete(buf, error);
+                    client.read_complete(buf, Err(error));
                 });
             }
 
             let write_buf = self.write_buf.take();
             if let Some(buf) = write_buf {
                 // We were doing a write
                 self.flash_client.map(move |client| {
-                    client.write_complete(buf, error);
+                    client.write_complete(buf, Err(error));
                 });
             }
 
             if self.registers.control.matches_all(CONTROL::OP::ERASE) {
                 // We were doing an erase
                 self.flash_client.map(move |client| {
-                    client.erase_complete(error);
+                    client.erase_complete(Err(error));
                 });
             }
         }
@@ -622,7 +622,7 @@ impl<'a> FlashCtrl<'a> {
                         self.registers.op_status.set(0);
                         // We have all of the data, call the client
                         self.flash_client.map(move |client| {
-                            client.read_complete(buf, hil::flash::Error::CommandComplete);
+                            client.read_complete(buf, Ok(()));
                         });
                     } else {
                         // Still waiting on data, keep waiting
@@ -638,7 +638,7 @@ impl<'a> FlashCtrl<'a> {
                         self.registers.op_status.set(0);
                         // We sent all of the data, call the client
                         self.flash_client.map(move |client| {
-                            client.write_complete(buf, hil::flash::Error::CommandComplete);
+                            client.write_complete(buf, Ok(()));
                         });
                     } else {
                         // Still writing data, keep trying
@@ -648,7 +648,7 @@ impl<'a> FlashCtrl<'a> {
                 }
             } else if self.registers.control.matches_all(CONTROL::OP::ERASE) {
                 self.flash_client.map(move |client| {
-                    client.erase_complete(hil::flash::Error::CommandComplete);
+                    client.erase_complete(Ok(()));
                 });
             }
         }

diff --git a/chips/nrf52/src/nvmc.rs b/chips/nrf52/src/nvmc.rs
@@ -250,20 +250,20 @@ impl Nvmc {
             FlashState::Read => {
                 self.client.map(|client| {
                     self.buffer.take().map(|buffer| {
-                        client.read_complete(buffer, hil::flash::Error::CommandComplete);
+                        client.read_complete(buffer, Ok(()));
                     });
                 });
             }
             FlashState::Write => {
                 self.client.map(|client| {
                     self.buffer.take().map(|buffer| {
-                        client.write_complete(buffer, hil::flash::Error::CommandComplete);
+                        client.write_complete(buffer, Ok(()));
                     });
                 });
             }
             FlashState::Erase => {
                 self.client.map(|client| {
-                    client.erase_complete(hil::flash::Error::CommandComplete);
+                    client.erase_complete(Ok(()));
                 });
             }
             _ => {}