Merge branch 'develop' into skip-wait-init-sequence

Author: elpiel

CHANGELOG.md

@@ -9,9 +9,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 [Unreleased]: https://github.com/rust-embedded-community/embedded-sdmmc-rs/compare/v0.4.0...develop
 
-### Changes
-- Add `MAX_DIRS` and `MAX_FILES` generics to `Controller` to allow an arbitrary numbers of concurrent open directories and files.
-
 ## [Version 0.4.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.4.0)
 
 ### Changes
@@ -25,6 +22,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Fix `env_logger` pulling in the `std` feature in `log` in library builds.
 - Raise the minimum supported Rust version to 1.56.0.
 - Code tidy-ups and more documentation.
+- Add `MAX_DIRS` and `MAX_FILES` generics to `Controller` to allow an arbitrary numbers of concurrent open directories and files.
+- Add new constructor method `Controller::new_with_limits(block_device: D, timesource: T) -> Controller<D, T, MAX_DIRS, MAX_FILES>`
+  to create a `Controller` with custom limits.
 
 ## [Version 0.3.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.3.0)
 

README.md

@@ -11,7 +11,7 @@ designed for readability and simplicity over performance.
 You will need something that implements the `BlockDevice` trait, which can read and write the 512-byte blocks (or sectors) from your card. If you were to implement this over USB Mass Storage, there's no reason this crate couldn't work with a USB Thumb Drive, but we only supply a `BlockDevice` suitable for reading SD and SDHC cards over SPI.
 
 ```rust
-let mut spi_dev = embedded_sdmmc::SdMmcSpi::new(embedded_sdmmc::SdMmcSpi::new(sdmmc_spi, sdmmc_cs), time_source);
+let mut spi_dev = embedded_sdmmc::SdMmcSpi::new(sdmmc_spi, sdmmc_cs);
 write!(uart, "Init SD card...").unwrap();
 match spi_dev.acquire() {
     Ok(block) => {
@@ -42,7 +42,7 @@ let mut cont: Controller<
     DummyTimeSource,
     6,
     12,
-> = Controller::new(block, time_source);
+> = Controller::new_with_limits(block, time_source);
 ```
 
 ## Supported features

examples/create_test.rs

@@ -118,7 +118,7 @@ fn main() {
         .map_err(Error::DeviceError)
         .unwrap();
     println!("lbd: {:?}", lbd);
-    let mut controller: Controller<LinuxBlockDevice, Clock, 4, 4> = Controller::new(lbd, Clock);
+    let mut controller = Controller::new(lbd, Clock);
     for volume_idx in 0..=3 {
         let volume = controller.get_volume(VolumeIdx(volume_idx));
         println!("volume {}: {:#?}", volume_idx, volume);

examples/delete_test.rs

@@ -118,7 +118,7 @@ fn main() {
         .map_err(Error::DeviceError)
         .unwrap();
     println!("lbd: {:?}", lbd);
-    let mut controller: Controller<LinuxBlockDevice, Clock, 4, 4> = Controller::new(lbd, Clock);
+    let mut controller = Controller::new(lbd, Clock);
     for volume_idx in 0..=3 {
         let volume = controller.get_volume(VolumeIdx(volume_idx));
         println!("volume {}: {:#?}", volume_idx, volume);

examples/test_mount.rs

@@ -121,7 +121,7 @@ fn main() {
         .map_err(Error::DeviceError)
         .unwrap();
     println!("lbd: {:?}", lbd);
-    let mut controller: Controller<LinuxBlockDevice, Clock, 4, 4> = Controller::new(lbd, Clock);
+    let mut controller = Controller::new(lbd, Clock);
     for i in 0..=3 {
         let volume = controller.get_volume(VolumeIdx(i));
         println!("volume {}: {:#?}", i, volume);

examples/write_test.rs

@@ -118,7 +118,7 @@ fn main() {
         .map_err(Error::DeviceError)
         .unwrap();
     println!("lbd: {:?}", lbd);
-    let mut controller: Controller<LinuxBlockDevice, Clock, 4, 4> = Controller::new(lbd, Clock);
+    let mut controller = Controller::new(lbd, Clock);
     for volume_idx in 0..=3 {
         let volume = controller.get_volume(VolumeIdx(volume_idx));
         println!("volume {}: {:#?}", volume_idx, volume);

src/controller.rs

@@ -29,6 +29,24 @@ where
     open_files: [(VolumeIdx, Cluster); MAX_FILES],
 }
 
+impl<D, T> Controller<D, T, 4, 4>
+where
+    D: BlockDevice,
+    T: TimeSource,
+    <D as BlockDevice>::Error: core::fmt::Debug,
+{
+    /// Create a new Disk Controller using a generic `BlockDevice`. From this
+    /// controller we can open volumes (partitions) and with those we can open
+    /// files.
+    ///
+    /// This creates a Controller with default values
+    /// MAX_DIRS = 4, MAX_FILES = 4. Call `Controller::new_with_limits(block_device, timesource)`
+    /// if you need different limits.
+    pub fn new(block_device: D, timesource: T) -> Controller<D, T, 4, 4> {
+        Self::new_with_limits(block_device, timesource)
+    }
+}
+
 impl<D, T, const MAX_DIRS: usize, const MAX_FILES: usize> Controller<D, T, MAX_DIRS, MAX_FILES>
 where
     D: BlockDevice,
@@ -38,7 +56,10 @@ where
     /// Create a new Disk Controller using a generic `BlockDevice`. From this
     /// controller we can open volumes (partitions) and with those we can open
     /// files.
-    pub fn new(block_device: D, timesource: T) -> Controller<D, T, MAX_DIRS, MAX_FILES> {
+    pub fn new_with_limits(
+        block_device: D,
+        timesource: T,
+    ) -> Controller<D, T, MAX_DIRS, MAX_FILES> {
         debug!("Creating new embedded-sdmmc::Controller");
         Controller {
             block_device,

src/lib.rs

@@ -460,8 +460,9 @@ mod tests {
 
     #[test]
     fn partition0() {
-        let mut c: Controller<DummyBlockDevice, Clock, 4, 4> =
-            Controller::new(DummyBlockDevice, Clock);
+        let mut c: Controller<DummyBlockDevice, Clock, 2, 2> =
+            Controller::new_with_limits(DummyBlockDevice, Clock);
+
         let v = c.get_volume(VolumeIdx(0)).unwrap();
         assert_eq!(
             v,