Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@decaday
decaday committed Dec 12, 2024
1 parent 7b8fd67 commit 9d446f3
Showing 1 changed file with 26 additions and 20 deletions.
46 changes: 26 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,25 +37,27 @@ Supported chip flags: `py32f030f16`, `py32f030k28`, `py32f072c1b`, More is comin

Note: Currently the program behavior has nothing to do with chip packaging.

Others should work if you are careful as most peripherals are similar enough.In fact, the IPs of peripherals in different PY32 series may be consistent. Moreover, some series use the same die, so it might not require much work.
Others should work if you are careful as most peripherals are similar enough. In fact, the IPs of peripherals in different PY32 series may be consistent. Moreover, some series use the same die, so it might not require much work.

For a full list of chip capabilities and peripherals, check the [py32-data](https://github.com/py32-rs/py32-data) repository.

| Family | F002B/L020/F001 | F030/F003/F002A | F040/F07x/MD410 | F403 |
| ---------- | --------------- | --------------- | --------------- | ---- |
| Embassy | | ✅ | ✅ | |
| RCC | | ✅ | ✅ | |
| GPIO | | ✅ | ✅ | |
| INTERRUPT | | ✅ | ✅ | |
| DMA | N/A | | | |
| EXTI | | ✅+ | ❓ | |
| USART | | ✅ | ❓ | |
| I2C | | ✅ | ❓ | |
| SPI | | | | |
| ADC | | ✅+ | ✅ | |
| RTC | | | | |
| Timer(PWM) | | ✅ | ❓ | |
| USB | N/A | N/A | ✅+ | |
| Family | F002B/L020 | F030/F003/F002A | F040/F07x/MD410 | F403 |
| ---------- | ---------- | --------------- | --------------- | ---- |
| Embassy | | ✅ | ✅ | |
| RCC | | ✅ | ✅ | |
| GPIO | | ✅ | ✅ | |
| INTERRUPT | | ✅ | ✅ | |
| DMA | N/A | | | |
| EXTI | | ✅+ | ✅+ | |
| USART | | ✅+ | ✅+ | |
| I2C | | ✅ | ❓ | |
| SPI | | | | |
| ADC | | ✅+ | ✅ | |
| RTC | | | | |
| Timer(PWM) | | ✅ | ❓ | |
| USB | N/A | N/A | ✅+ | |
| DAC | N/A | N/A | | |
| I2S | N/A | N/A | | |

- ✅ : Implemented
- Blank : Not implemented
Expand Down Expand Up @@ -91,11 +93,9 @@ Embassy requires that any TIM used as a time-driver has at least two channels, s

For PY32F07x, F040, you can use TIM15, TIM3 or TIM1.

## Minimum supported Rust version(MSRV)
## Awesome List

This project is developed with a recent **nightly** version of Rust compiler. And is expected to work with beta versions of Rust.

Feel free to change this if you did some testing with some version of Rust.
[py32csdk-hal-sys](https://github.com/decaday/py32csdk-hal-sys): PY32F0 MCU c SDK bindings rust crate

## Contributing

Expand All @@ -110,6 +110,12 @@ All kinds of contributions are welcome.
- Adding new peripheral drivers
- ...

## Minimum supported Rust version(MSRV)

This project is developed with a recent **nightly** version of Rust compiler. And is expected to work with beta versions of Rust.

Feel free to change this if you did some testing with some version of Rust.

## License

This project is licensed under the MIT or Apache-2.0 license, at your option.
Expand Down

0 comments on commit 9d446f3

Please sign in to comment.