Skip to content

Commit e08947f

Browse files
thejpstereldruin
authored andcommitted
Update to 0.5.0 and fill in CHANGELOG
1 parent d3beac2 commit e08947f

File tree

2 files changed

+41
-15
lines changed

2 files changed

+41
-15
lines changed

CHANGELOG.md

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,58 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
66
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [Unreleased](https://github.com/rust-embedded-community/embedded-sdmmc-rs/compare/v0.5.0...develop)
99

10-
[Unreleased]: https://github.com/rust-embedded-community/embedded-sdmmc-rs/compare/v0.4.0...develop
10+
### Changed
1111

12-
- Renamed `Controller` to `VolumeManager`, to better describe what it does.
13-
- Renamed `SdMmcSpi` to `SdCard`
14-
- Renamed `BlockSpi` to `AcquiredSdCard`
12+
- None
1513

16-
## [Version 0.4.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.4.0)
14+
### Added
15+
16+
- None
17+
18+
### Removed
19+
20+
- None
21+
22+
## [Version 0.5.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.5.0) - 2023-05-20
23+
24+
### Changes
25+
26+
- __Breaking Change__: Renamed `Controller` to `VolumeManager`, to better describe what it does.
27+
- __Breaking Change__: Renamed `SdMmcSpi` to `SdCard`
28+
- __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)
29+
- __Breaking Change__: `SdCard::new` now requires an object that implements the embedded-hal `DelayUs` trait
30+
- __Breaking Change__: Renamed `card_size_bytes` to `num_bytes`, to match `num_blocks`
31+
- More robust card intialisation procedure, with added retries
32+
- Supports building with neither `defmt` nor `log` logging
33+
34+
### Added
35+
36+
- Added `mark_card_as_init` method, if you know the card is initialised and want to skip the initialisation step
37+
38+
### Removed
39+
40+
- __Breaking Change__: Removed `BlockSpi` type - card initialisation now handled as an internal state variable
41+
42+
## [Version 0.4.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.4.0) - 2023-01-18
1743

1844
### Changes
1945
- Optionally use [defmt](https://github.com/knurling-rs/defmt) for logging.
2046
Controlled by `defmt-log` feature flag.
21-
- [breaking-change] Use SPI blocking traits instead to ease SPI peripheral sharing.
47+
- __Breaking Change__: Use SPI blocking traits instead to ease SPI peripheral sharing.
2248
See: https://github.com/rust-embedded-community/embedded-sdmmc-rs/issues/28
2349
- Added `Controller::has_open_handles` and `Controller::free` methods.
24-
- [breaking-change] Changed interface to enforce correct SD state at compile time.
25-
- [breaking-change] Added custom error type for `File` operations.
50+
- __Breaking Change__: Changed interface to enforce correct SD state at compile time.
51+
- __Breaking Change__: Added custom error type for `File` operations.
2652
- Fix `env_logger` pulling in the `std` feature in `log` in library builds.
2753
- Raise the minimum supported Rust version to 1.56.0.
2854
- Code tidy-ups and more documentation.
2955
- Add `MAX_DIRS` and `MAX_FILES` generics to `Controller` to allow an arbitrary numbers of concurrent open directories and files.
3056
- Add new constructor method `Controller::new_with_limits(block_device: D, timesource: T) -> Controller<D, T, MAX_DIRS, MAX_FILES>`
3157
to create a `Controller` with custom limits.
3258

33-
## [Version 0.3.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.3.0)
59+
## [Version 0.3.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.3.0) - 2019-12-16
3460

3561
### Changes
3662

@@ -42,19 +68,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
4268
* Added `write_test` and `create_test`.
4369
* De-duplicated FAT16 and FAT32 code (https://github.com/thejpster/embedded-sdmmc-rs/issues/10)
4470

45-
## [Version 0.2.1](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.2.1)
71+
## [Version 0.2.1](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.2.1) - 2019-02-19
4672

4773
### Changes
4874

4975
* Added `readme=README.md` to `Cargo.toml`
5076

51-
## [Version 0.2.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.2.0)
77+
## [Version 0.2.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.2.0) - 2019-01-24
5278

5379
### Changes
5480

5581
* Reduce delay waiting for response. Big speed improvements.
5682

57-
## [Version 0.1.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.1.1)
83+
## [Version 0.1.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.1.1) - 2018-12-23
5884

5985
### Changes
6086

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
authors = ["Jonathan 'theJPster' Pallant <github@thejpster.org.uk>"]
2+
authors = ["Jonathan 'theJPster' Pallant <github@thejpster.org.uk>", "Rust Embedded Community Developers"]
33
categories = ["embedded", "no-std"]
44
description = "A basic SD/MMC driver for Embedded Rust."
55
edition = "2021"
@@ -8,7 +8,7 @@ license = "MIT OR Apache-2.0"
88
name = "embedded-sdmmc"
99
readme = "README.md"
1010
repository = "https://github.com/rust-embedded-community/embedded-sdmmc-rs"
11-
version = "0.4.0"
11+
version = "0.5.0"
1212

1313
[dependencies]
1414
byteorder = {version = "1", default-features = false}

0 commit comments

Comments
 (0)