mirror of
https://github.com/esp-rs/esp-hal.git
synced 2025-09-28 04:40:52 +00:00
cc2083fd1a
* Move ROM function definitions to esp-hal-rom crate * Patch ESP32 ROM-functions, use it in esp-storage * Allow placing additional code in IRAM * esp-storage depends on esp-hal-rom * Move ROM function wrappers from esp-hal to esp-hal-rom * Make bootloader-support crate use CRC ROM function * Minor polishing * changelogs * Make CI green * Define (some) spiflash ROM functions in esp-hal-rom * Lint * Avoid duplicate definition of `__assert_func` * Rename to `esp-rom-sys` * Mention versioning this crate in the README * Fixes * Check self-version * Docs * Clippy * Check if version bump is allowed * Unconditionally place spiflash ROM function patches (if present) in rwtext * Cleanup * Change how unacceptable version bump requests are detected * Initial version 0.1.0 * Docs * Use correct version * Force esp-rom-sys bumps to patch * Fix
39 lines
2.1 KiB
Markdown
39 lines
2.1 KiB
Markdown
# esp-rom-sys
|
|
|
|
[](https://crates.io/crates/esp-rom-sys)
|
|
[](https://docs.espressif.com/projects/rust/esp-rom-sys/latest/)
|
|
|
|
|
|
[](https://matrix.to/#/#esp-rs:matrix.org)
|
|
|
|
ROM code support.
|
|
|
|
This includes the definition of ROM code function addresses.
|
|
|
|
For some targets (ESP32 currently) we will use `libesp_rom.a` from ESP-IDF. The code here corresponds to [ESP-IDF v5.3.1](https://github.com/espressif/esp-idf/blob/v5.3.1/components/esp_rom/patches/esp_rom_spiflash.c)
|
|
|
|
Since there can be only one version of this crate used in a dependency tree this is expected to never see a major version bump. (i.e. all releases are patch releases)
|
|
|
|
That said, we cannot remove anything here. Degrading a symbol from hard linkage to weak linkage is allowed.
|
|
|
|
## [Documentation](https://docs.espressif.com/projects/rust/esp-rom-sys/latest/)
|
|
|
|
## Minimum Supported Rust Version (MSRV)
|
|
|
|
This crate is guaranteed to compile when using the latest stable Rust version at the time of the crate's release. It _might_ compile with older versions, but that may change in any new release, including patches.
|
|
|
|
## 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.
|