no_std Hardware Abstraction Layers for ESP32 microcontrollers

Go to file

Jesse Braham a9cf53a001 Clean up imports/exports, normalize/update examples		2022-01-10 10:21:40 -08:00
.github/workflows	Add a CI workflow to check the examples for each package	2022-01-07 16:35:59 -08:00
.vscode	Shared GPIO Implementation (#3 )	2022-01-06 07:57:55 -08:00
esp32-hal	Clean up imports/exports, normalize/update examples	2022-01-10 10:21:40 -08:00
esp32c3-hal	Clean up imports/exports, normalize/update examples	2022-01-10 10:21:40 -08:00
esp32s2-hal	Add empty linker scripts for ESP32-S2 and ESP32-S3 to make rust analyzer happy	2022-01-10 10:12:31 -08:00
esp32s3-hal	Add empty linker scripts for ESP32-S2 and ESP32-S3 to make rust analyzer happy	2022-01-10 10:12:31 -08:00
esp-hal-common	Format GPIO-related macros and their invocations to improve readability	2022-01-06 09:34:32 -08:00
.gitignore	Initial commit	2021-10-19 15:00:41 -07:00
Cargo.toml	Shared GPIO Implementation (#3 )	2022-01-06 07:57:55 -08:00
LICENSE-APACHE	Initial commit	2021-10-19 15:00:41 -07:00
LICENSE-MIT	Initial commit	2021-10-19 15:00:41 -07:00
README.md	Update README to reflect recent additions	2022-01-10 09:57:47 -08:00
rustfmt.toml	Assorted updates to make most things build properly... still some errors	2021-11-23 20:12:34 -08:00

README.md

esp-hal

An extremely experimental attempt at writing a HAL which targets the ESP32, ESP32-C3, ESP32-S2, and ESP32-S3.

This should not be used for anything other than experimentation at this point in time, this is merely a proof-of-concept.

The various packages in this repository may or may not build at any given time. Until the first releases are published there should be no expectation of API stability.

What is working?

For the ESP32 and ESP32-C3, the GPIO, TIMG and UART peripherals have (probably incomplete) implementations which are nonetheless functional. These packages include examples to demonstrate these peripherals.

What is NOT working?

Everything else.

Notes on the ESP32-S2 and ESP32-S3

At this time, there are two major issues blocking progress on the ESP32-S2 and ESP32-S3:

The lack of runtime support via riscv-rt
The omission of linker scripts, required for actually building the binaries

Once these issues have been resolved, progress can resume on the esp32s2-hal and esp32s3-hal crates.

License

Licensed under either of:

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (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.