Merge pull request tock#4069 from alistair23/alistair/tickv

tickv: Remove the offset from read_region()
YoeDistro · Jul 17, 2024 · 8b9d425 · 8b9d425
2 parents 403be95 + 3054b46
commit 8b9d425
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 37 deletions.
diff --git a/capsules/extra/src/tickv.rs b/capsules/extra/src/tickv.rs
@@ -241,7 +241,6 @@ impl<'a, F: Flash, const PAGE_SIZE: usize> tickv::flash_controller::FlashControl
     fn read_region(
         &self,
         region_number: usize,
-        _offset: usize,
         _buf: &mut [u8; PAGE_SIZE],
     ) -> Result<(), tickv::error_codes::ErrorCode> {
         if self

diff --git a/libraries/tickv/Cargo.toml b/libraries/tickv/Cargo.toml
@@ -7,7 +7,7 @@ name = "tickv"
 description = "TicKV (Tiny Circular Key Value) is a small file system allowing key value pairs to be stored in Flash Memory."
 repository = "https://github.com/tock/tock"
 documentation = "https://github.com/tock/tock/blob/master/libraries/tickv/README.md"
-version = "1.0.0"
+version = "2.0.0"
 license = "MIT OR Apache-2.0"
 authors = ["Alistair Francis <[email protected]>"]
 edition = "2021"

diff --git a/libraries/tickv/src/async_ops.rs b/libraries/tickv/src/async_ops.rs
@@ -45,7 +45,6 @@
 //!     fn read_region(
 //!         &self,
 //!         region_number: usize,
-//!         offset: usize,
 //!         buf: &mut [u8; 1024],
 //!     ) -> Result<(), ErrorCode> {
 //!          // We aren't ready yet, launch the async operation
@@ -533,10 +532,9 @@ mod tests {
             fn read_region(
                 &self,
                 region_number: usize,
-                offset: usize,
                 _buf: &mut [u8; S],
             ) -> Result<(), ErrorCode> {
-                println!("Read from region: {}, offset: {offset}", region_number);
+                println!("Read from region: {}", region_number);
 
                 // Pretend that we aren't ready
                 self.async_read_region.set(region_number);

diff --git a/libraries/tickv/src/crc32.rs b/libraries/tickv/src/crc32.rs
@@ -322,6 +322,7 @@ const fn crc32(poly: u32, mut byte: u8) -> u32 {
 ///
 /// We keep this seperate to clearly show the CRC implementation
 /// details (such as initial state and xorout).
+#[derive(Default)]
 struct Crc {}
 
 impl Crc {

diff --git a/libraries/tickv/src/flash_controller.rs b/libraries/tickv/src/flash_controller.rs
@@ -40,7 +40,7 @@ use crate::error_codes::ErrorCode;
 /// }
 ///
 /// impl FlashController<1024> for FlashCtrl {
-///     fn read_region(&self, region_number: usize, offset: usize, buf: &mut [u8; 1024]) -> Result<(), ErrorCode> {
+///     fn read_region(&self, region_number: usize, buf: &mut [u8; 1024]) -> Result<(), ErrorCode> {
 ///         unimplemented!()
 ///     }
 ///
@@ -56,8 +56,7 @@ use crate::error_codes::ErrorCode;
 pub trait FlashController<const S: usize> {
     /// This function must read the data from the flash region specified by
     /// `region_number` into `buf`. The length of the data read should be the
-    /// same length as buf. `offset` indicates an offset into the region that
-    /// should be read.
+    /// same length as buf.
     ///
     /// On success it should return nothing, on failure it
     /// should return ErrorCode::ReadFail.
@@ -71,12 +70,7 @@ pub trait FlashController<const S: usize> {
     /// `read_region()` has returned `ErrorCode::ReadNotReady(region_number)`
     /// the `read_region()` function will be called again and this time should
     /// return the data.
-    fn read_region(
-        &self,
-        region_number: usize,
-        offset: usize,
-        buf: &mut [u8; S],
-    ) -> Result<(), ErrorCode>;
+    fn read_region(&self, region_number: usize, buf: &mut [u8; S]) -> Result<(), ErrorCode>;
 
     /// This function must write the length of `buf` to the specified address
     /// in flash.

diff --git a/libraries/tickv/src/lib.rs b/libraries/tickv/src/lib.rs
@@ -122,10 +122,10 @@
 //! }
 //!
 //! impl FlashController<1024> for FlashCtrl {
-//!     fn read_region(&self, region_number: usize, offset: usize, buf: &mut [u8; 1024]) -> Result<(), ErrorCode> {
+//!     fn read_region(&self, region_number: usize, buf: &mut [u8; 1024]) -> Result<(), ErrorCode> {
 //!         // TODO: Read the specified flash region
 //!         for (i, b) in buf.iter_mut().enumerate() {
-//!             *b = self.buf.borrow()[region_number][offset + i]
+//!             *b = self.buf.borrow()[region_number][i]
 //!         }
 //!         Ok(())
 //!     }

diff --git a/libraries/tickv/src/tests.rs b/libraries/tickv/src/tests.rs
@@ -151,7 +151,6 @@ mod simple_flash_ctrl {
         fn read_region(
             &self,
             _region_number: usize,
-            _offset: usize,
             buf: &mut [u8; 2048],
         ) -> Result<(), ErrorCode> {
             for b in buf.iter_mut() {
@@ -202,7 +201,6 @@ mod single_erase_flash_ctrl {
         fn read_region(
             &self,
             _region_number: usize,
-            _offset: usize,
             buf: &mut [u8; 2048],
         ) -> Result<(), ErrorCode> {
             for b in buf.iter_mut() {
@@ -262,16 +260,11 @@ mod store_flast_ctrl {
     }
 
     impl FlashController<1024> for FlashCtrl {
-        fn read_region(
-            &self,
-            region_number: usize,
-            offset: usize,
-            buf: &mut [u8; 1024],
-        ) -> Result<(), ErrorCode> {
+        fn read_region(&self, region_number: usize, buf: &mut [u8; 1024]) -> Result<(), ErrorCode> {
             println!("Read from region: {}", region_number);
 
             for (i, b) in buf.iter_mut().enumerate() {
-                *b = self.buf.borrow()[region_number][offset + i]
+                *b = self.buf.borrow()[region_number][i]
             }
 
             Ok(())
@@ -552,16 +545,11 @@ mod no_check_store_flast_ctrl {
     }
 
     impl FlashController<256> for FlashCtrl {
-        fn read_region(
-            &self,
-            region_number: usize,
-            offset: usize,
-            buf: &mut [u8; 256],
-        ) -> Result<(), ErrorCode> {
+        fn read_region(&self, region_number: usize, buf: &mut [u8; 256]) -> Result<(), ErrorCode> {
             println!("Read from region: {}", region_number);
 
             for (i, b) in buf.iter_mut().enumerate() {
-                *b = self.buf.borrow()[region_number][offset + i]
+                *b = self.buf.borrow()[region_number][i]
             }
 
             Ok(())

diff --git a/libraries/tickv/src/tickv.rs b/libraries/tickv/src/tickv.rs
@@ -429,7 +429,7 @@ impl<'a, C: FlashController<S>, const S: usize> TicKV<'a, C, S> {
             if self.state.get() != State::AppendKey(KeyState::ReadRegion(new_region))
                 && self.state.get() != State::Init(InitState::AppendKeyReadRegion(new_region))
             {
-                match self.controller.read_region(new_region, 0, region_data) {
+                match self.controller.read_region(new_region, region_data) {
                     Ok(()) => {}
                     Err(e) => {
                         self.read_buffer.replace(Some(region_data));
@@ -693,7 +693,7 @@ impl<'a, C: FlashController<S>, const S: usize> TicKV<'a, C, S> {
             if self.state.get() != State::GetKey(KeyState::ReadRegion(new_region))
                 && self.state.get() != State::Init(InitState::GetKeyReadRegion(new_region))
             {
-                match self.controller.read_region(new_region, 0, region_data) {
+                match self.controller.read_region(new_region, region_data) {
                     Ok(()) => {}
                     Err(e) => {
                         self.read_buffer.replace(Some(region_data));
@@ -818,7 +818,7 @@ impl<'a, C: FlashController<S>, const S: usize> TicKV<'a, C, S> {
             // Get the data from that region
             let region_data = self.read_buffer.take().unwrap();
             if self.state.get() != State::InvalidateKey(KeyState::ReadRegion(new_region)) {
-                match self.controller.read_region(new_region, 0, region_data) {
+                match self.controller.read_region(new_region, region_data) {
                     Ok(()) => {}
                     Err(e) => {
                         self.read_buffer.replace(Some(region_data));
@@ -917,7 +917,7 @@ impl<'a, C: FlashController<S>, const S: usize> TicKV<'a, C, S> {
             // Get the data from that region
             let region_data = self.read_buffer.take().unwrap();
             if self.state.get() != State::ZeroiseKey(KeyState::ReadRegion(new_region)) {
-                match self.controller.read_region(new_region, 0, region_data) {
+                match self.controller.read_region(new_region, region_data) {
                     Ok(()) => {}
                     Err(e) => {
                         self.read_buffer.replace(Some(region_data));
@@ -992,7 +992,7 @@ impl<'a, C: FlashController<S>, const S: usize> TicKV<'a, C, S> {
         let region_data = self.read_buffer.take().unwrap();
         if self.state.get() != State::GarbageCollect(RubbishState::ReadRegion(region, flash_freed))
         {
-            match self.controller.read_region(region, 0, region_data) {
+            match self.controller.read_region(region, region_data) {
                 Ok(()) => {}
                 Err(e) => {
                     self.read_buffer.replace(Some(region_data));