diff --git a/CHANGELOG.md b/CHANGELOG.md index e5bbec7..4823930 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,24 +5,50 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [Unreleased](https://github.com/rust-embedded-community/embedded-sdmmc-rs/compare/v0.5.0...develop) -[Unreleased]: https://github.com/rust-embedded-community/embedded-sdmmc-rs/compare/v0.4.0...develop +### Changed -- Renamed `Controller` to `VolumeManager`, to better describe what it does. -- Renamed `SdMmcSpi` to `SdCard` -- Renamed `BlockSpi` to `AcquiredSdCard` +- None -## [Version 0.4.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.4.0) +### Added + +- None + +### Removed + +- None + +## [Version 0.5.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.5.0) - 2023-05-20 + +### Changes + +- __Breaking Change__: Renamed `Controller` to `VolumeManager`, to better describe what it does. +- __Breaking Change__: Renamed `SdMmcSpi` to `SdCard` +- __Breaking Change__: `AcquireOpts` now has `use_crc` (which makes it ask for CRCs to be enabled) instead of `require_crc` (which simply allowed the enable-CRC command to fail) +- __Breaking Change__: `SdCard::new` now requires an object that implements the embedded-hal `DelayUs` trait +- __Breaking Change__: Renamed `card_size_bytes` to `num_bytes`, to match `num_blocks` +- More robust card intialisation procedure, with added retries +- Supports building with neither `defmt` nor `log` logging + +### Added + +- Added `mark_card_as_init` method, if you know the card is initialised and want to skip the initialisation step + +### Removed + +- __Breaking Change__: Removed `BlockSpi` type - card initialisation now handled as an internal state variable + +## [Version 0.4.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.4.0) - 2023-01-18 ### Changes - Optionally use [defmt](https://github.com/knurling-rs/defmt) for logging. Controlled by `defmt-log` feature flag. -- [breaking-change] Use SPI blocking traits instead to ease SPI peripheral sharing. +- __Breaking Change__: Use SPI blocking traits instead to ease SPI peripheral sharing. See: https://github.com/rust-embedded-community/embedded-sdmmc-rs/issues/28 - Added `Controller::has_open_handles` and `Controller::free` methods. -- [breaking-change] Changed interface to enforce correct SD state at compile time. -- [breaking-change] Added custom error type for `File` operations. +- __Breaking Change__: Changed interface to enforce correct SD state at compile time. +- __Breaking Change__: Added custom error type for `File` operations. - 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. @@ -30,7 +56,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - Add new constructor method `Controller::new_with_limits(block_device: D, timesource: T) -> Controller` 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) +## [Version 0.3.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.3.0) - 2019-12-16 ### Changes @@ -42,19 +68,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. * Added `write_test` and `create_test`. * De-duplicated FAT16 and FAT32 code (https://github.com/thejpster/embedded-sdmmc-rs/issues/10) -## [Version 0.2.1](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.2.1) +## [Version 0.2.1](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.2.1) - 2019-02-19 ### Changes * Added `readme=README.md` to `Cargo.toml` -## [Version 0.2.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.2.0) +## [Version 0.2.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.2.0) - 2019-01-24 ### Changes * Reduce delay waiting for response. Big speed improvements. -## [Version 0.1.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.1.1) +## [Version 0.1.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.1.1) - 2018-12-23 ### Changes diff --git a/Cargo.toml b/Cargo.toml index 96b5bb4..86f2bcf 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -authors = ["Jonathan 'theJPster' Pallant "] +authors = ["Jonathan 'theJPster' Pallant ", "Rust Embedded Community Developers"] categories = ["embedded", "no-std"] description = "A basic SD/MMC driver for Embedded Rust." edition = "2021" @@ -8,7 +8,7 @@ license = "MIT OR Apache-2.0" name = "embedded-sdmmc" readme = "README.md" repository = "https://github.com/rust-embedded-community/embedded-sdmmc-rs" -version = "0.4.0" +version = "0.5.0" [dependencies] byteorder = {version = "1", default-features = false}