83 lines
4.9 KiB
Markdown
83 lines
4.9 KiB
Markdown
# esp-hal
|
|
|
|
|
|
|
|
[](https://matrix.to/#/#esp-rs:matrix.org)
|
|
|
|
**H**ardware **A**bstraction **L**ayer crates for the **ESP32**, **ESP32-C3**, **ESP32-S2**, and **ESP32-S3** from Espressif.
|
|
|
|
These HALs are `no_std`; if you are looking for `std` support please use [esp-idf-hal] instead.
|
|
|
|
This project is still in the early stages of development, and as such there should be no expectation of API stability. A significant number of peripherals currently have drivers implemented (you can see a full list [here]) but have varying levels of functionality. For most basic tasks, this should be usable already.
|
|
|
|
If you have any questions, comments, or concerns please [open an issue], [start a new discussion], or join us on [Matrix]. For additional information regarding any of the crates in this repository please refer to the crate's README.
|
|
|
|
| Crate | Target | Technical Reference Manual |
|
|
| :-----------: | :-----------------------------------------------------------------: | :------------------------: |
|
|
| [esp32-hal] | `xtensa-esp32-none-elf` | [ESP32] |
|
|
| [esp32c3-hal] | `riscv32imc-unknown-none-elf`<br />`riscv32imac-unknown-none-elf`\* | [ESP32-C3] |
|
|
| [esp32s2-hal] | `xtensa-esp32s2-none-elf` | [ESP32-S2] |
|
|
| [esp32s3-hal] | `xtensa-esp32s3-none-elf` | [ESP32-S3] |
|
|
|
|
_\* via [atomic emulation]_
|
|
|
|
[here]: https://github.com/esp-rs/esp-hal/issues/19
|
|
[esp-idf-hal]: https://github.com/esp-rs/esp-idf-hal
|
|
[open an issue]: https://github.com/esp-rs/esp-hal/issues/new
|
|
[start a new discussion]: https://github.com/esp-rs/esp-hal/discussions/new
|
|
[matrix]: https://matrix.to/#/#esp-rs:matrix.org
|
|
[esp32-hal]: https://github.com/esp-rs/esp-hal/tree/main/esp32-hal
|
|
[esp32c3-hal]: https://github.com/esp-rs/esp-hal/tree/main/esp32c3-hal
|
|
[esp32s2-hal]: https://github.com/esp-rs/esp-hal/tree/main/esp32s2-hal
|
|
[esp32s3-hal]: https://github.com/esp-rs/esp-hal/tree/main/esp32s3-hal
|
|
[esp32]: https://www.espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf
|
|
[esp32-c3]: https://www.espressif.com/sites/default/files/documentation/esp32-c3_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
|
|
[atomic emulation]: https://github.com/esp-rs/riscv-atomic-emulation-trap
|
|
|
|
## Ancillary Crates
|
|
|
|
There are a number of other crates within the [esp-rs organization] which can be used in conjunction with `esp-hal`:
|
|
|
|
| Crate | Description |
|
|
| :-------------: | :----------------------------------------------------------------------------: |
|
|
| [esp-alloc] | A simple `no_std` heap allocator |
|
|
| [esp-backtrace] | Backtrace support for bare-metal applications |
|
|
| [esp-storage] | Implementation of [embedded-storage] traits to access unencrypted flash memory |
|
|
|
|
[esp-rs organization]: https://github.com/esp-rs
|
|
[esp-alloc]: https://github.com/esp-rs/esp-alloc
|
|
[esp-backtrace]: https://github.com/esp-rs/esp-backtrace
|
|
[esp-storage]: https://github.com/esp-rs/esp-storage
|
|
[embedded-storage]: https://github.com/rust-embedded-community/embedded-storage
|
|
|
|
## MSRV
|
|
|
|
The **M**inimum **S**upported **R**ust **V**ersions are:
|
|
|
|
- `1.60.0` for RISC-V devices (**ESP32-C3**)
|
|
- `1.60.0` for Xtensa devices (**ESP32**, **ESP32-S2**, **ESP32-S3**)
|
|
|
|
Note that targeting the Xtensa ISA currently requires the use of the [esp-rs/rust] compiler fork. The [esp-rs/rust-build] repository has pre-compiled release artifacts for most common platforms, and provides installation scripts to aid you in the process.
|
|
|
|
RISC-V is officially supported by the official Rust compiler.
|
|
|
|
[esp-rs/rust]: https://github.com/esp-rs/rust
|
|
[esp-rs/rust-build]: https://github.com/esp-rs/rust-build
|
|
|
|
## 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.
|