Skip to content

Commit 740ca3c

Browse files
committed
add features to readme
1 parent bb7b694 commit 740ca3c

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
99

10+
### Changed
11+
12+
- Update readme
13+
1014
## [v0.14.0] - 2022-12-12
1115

1216
### Changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,49 @@ peripheral access API for the STMicro STM32F4 series microcontrollers. The
1313
selection of the MCU is done by feature gates, typically specified by board
1414
support crates. Currently supported configurations are:
1515

16+
<table>
17+
<tr>
18+
<td>
19+
1620
* stm32f401
1721
* stm32f405
1822
* stm32f407
1923
* stm32f410
2024
* stm32f411
2125
* stm32f412
26+
<td>
27+
2228
* stm32f413
2329
* stm32f415
2430
* stm32f417
2531
* stm32f423
2632
* stm32f427
2733
* stm32f429
34+
<td>
35+
2836
* stm32f437
2937
* stm32f439
3038
* stm32f446
3139
* stm32f469
3240
* stm32f479
41+
</tr>
42+
</table>
3343

3444
The idea behind this crate is to gloss over the slight differences in the
3545
various peripherals available on those MCUs so a HAL can be written for all
3646
chips in that same family without having to cut and paste crates for every
3747
single model.
3848

49+
### Other optional features
50+
51+
* `rtic` — support monotonic timers that can be used by [RTIC framework](https://crates.io/crates/cortex-m-rtic).
52+
* `defmt` — implementation of `defmt::Format` for public enums and structures. See [defmt](https://crates.io/crates/defmt).
53+
* `can` — bxCAN peripheral support. See [bxcan](https://crates.io/crates/bxcan).
54+
* `i2s` — I2S peripheral support. See [stm32_i2s_v12x](https://crates.io/crates/stm32_i2s_v12x).
55+
* `usb_fs` or `usb_hs` — USB OTG FS/HS peripheral support. See [synopsys-usb-otg](https://crates.io/crates/synopsys-usb-otg).
56+
* `fsmc_lcd` — LCD support via FMC/FSMC peripheral. See [display-interface](https://crates.io/crates/display-interface).
57+
* `sdio-host` — SDIO peripheral support. See [sdio-host](https://crates.io/crates/sdio-host).
58+
3959
Collaboration on this crate is highly welcome as are pull requests!
4060

4161
This crate relies on Adam Greigs fantastic [stm32f4][] crate to provide
@@ -76,6 +96,7 @@ panic-halt = "0.2"
7696
[dependencies.stm32f4xx-hal]
7797
version = "0.14.0"
7898
features = ["stm32f407"] # replace the model of your microcontroller here
99+
# and add other required features
79100
```
80101

81102
We also need to tell Rust how to link our executable and how to lay out the

0 commit comments

Comments
 (0)