9bf70ff792
* Combine `esp-ulp-riscv-hal` and `esp32c6-lp-hal` into a single package * Update LP core examples * Update CI workflow * Fix `LP_UART` example
74 lines
3.9 KiB
Markdown
74 lines
3.9 KiB
Markdown
# esp-lp-hal
|
|
|
|
[](https://crates.io/crates/esp-lp-hal)
|
|
[](https://docs.rs/esp-lp-hal)
|
|
|
|
[](https://matrix.to/#/#esp-rs:matrix.org)
|
|
|
|
`no_std` HAL for the low-power RISC-V coprocessors found on the ESP32-C6, ESP32-S2, and ESP32-S3 from Espressif.
|
|
|
|
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
|
|
|
These devices uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imc-unknown-none-elf` and `riscv32imac-unknown-none-elf` targets.
|
|
|
|
Please refer to the documentation for more information.
|
|
|
|
[c6-datasheet]: https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf
|
|
[s2-datasheet]: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
|
|
[s3-datasheet]: https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf
|
|
[c6-trm]: https://www.espressif.com/sites/default/files/documentation/esp32-c6_technical_reference_manual_en.pdf
|
|
[s2-trm]: https://www.espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf
|
|
[s3-trm]: https://www.espressif.com/sites/default/files/documentation/esp32-s3_technical_reference_manual_en.pdf
|
|
|
|
## [Documentation]
|
|
|
|
[documentation]: https://docs.rs/esp-lp-hal/
|
|
|
|
## Supported Devices
|
|
|
|
| Chip | Datasheet | Technical Reference Manual | Target |
|
|
| :------: | :----------------------: | :------------------------: | :----------------------------: |
|
|
| ESP32-C6 | [ESP32-C6][c6-datasheet] | [ESP32-C6][c6-trm] | `riscv32imac-unknown-none-elf` |
|
|
| ESP32-S2 | [ESP32-S2][s2-datasheet] | [ESP32-S2][s2-trm] | `riscv32imc-unknown-none-elf` |
|
|
| ESP32-S3 | [ESP32-S3][s3-datasheet] | [ESP32-S3][s3-trm] | `riscv32imc-unknown-none-elf` |
|
|
|
|
## Resources
|
|
|
|
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
|
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
|
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
|
- Datasheets:
|
|
- [ESP32-C6](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf)
|
|
- [ESP32-S2](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf)
|
|
- [ESP32-S3](https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf)
|
|
- Technical Reference Manuals:
|
|
- [ESP32-C6](https://www.espressif.com/sites/default/files/documentation/esp32-c6_technical_reference_manual_en.pdf)
|
|
- [ESP32-S2](https://www.espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf)
|
|
- [ESP32-S3](https://www.espressif.com/sites/default/files/documentation/esp32-s3_technical_reference_manual_en.pdf)
|
|
|
|
## Getting Started
|
|
|
|
### Installing the Rust Compiler Targets
|
|
|
|
The compilation targets for these devices are officially supported by the mainline Rust compiler and can be installed using [rustup](https://rustup.rs/):
|
|
|
|
```shell
|
|
rustup target add riscv32imc-unknown-none-elf
|
|
rustup target add riscv32imac-unknown-none-elf
|
|
```
|
|
|
|
## License
|
|
|
|
Licensed under either of:
|
|
|
|
- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
- MIT license ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
at your option.
|
|
|
|
### Contribution
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
|
|
the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without
|
|
any additional terms or conditions.
|