mirror of
https://github.com/esp-rs/esp-hal.git
synced 2025-10-02 14:44:42 +00:00
ecb3c31d21
* Hide internal-only RMT macros from documentation * Document the features of each chip-specific HAL package * Document the supported image formats for relevant packages
97 lines
3.8 KiB
Rust
97 lines
3.8 KiB
Rust
//! `no_std` HAL for the ESP32 from Espressif.
|
|
//!
|
|
//! Implements a number of the traits defined by the various packages in the
|
|
//! [embedded-hal] repository.
|
|
//!
|
|
//! [embedded-hal]: https://github.com/rust-embedded/embedded-hal
|
|
//!
|
|
//! ### Cargo Features
|
|
//!
|
|
//! The available cargo features for this package are listed below, along with a
|
|
//! brief description of each feature.
|
|
//!
|
|
//! - `async` - Enable support for asynchronous operation, with interfaces
|
|
//! provided by [embedded-hal-async] and [embedded-io-async]
|
|
//! - `bluetooth` - Enable support for using the Bluetooth radio
|
|
//! - `debug` - Enable debug features in the HAL (used for development)
|
|
//! - `eh1` - Implement the traits defined in the `1.0.0-xxx` pre-releases of
|
|
//! [embedded-hal], [embedded-hal-nb], and [embedded-io]
|
|
//! - `embassy` - Enable support for [embassy], a modern asynchronous embedded
|
|
//! framework
|
|
//! - `embassy-time-timg0` - Enable the [embassy] time driver using the `TIMG0`
|
|
//! peripheral
|
|
//! - `psram_2m` - Use externally connected PSRAM (2MB)
|
|
//! - `psram_4m` - Use externally connected PSRAM (4MB)
|
|
//! - `psram_8m` - Use externally connected PSRAM (8MB)
|
|
//! - `rt` - Runtime support
|
|
//! - `ufmt` - Implement the [`ufmt_write::uWrite`] trait for the UART driver
|
|
//! - `vectored` - Enable interrupt vectoring
|
|
//! - `xtal26mhz` - The target device uses a 26MHz crystal
|
|
//! - `xtal40mhz` - The target device uses a 40MHz crystal
|
|
//!
|
|
//! #### Default Features
|
|
//!
|
|
//! The `rt`, `vectored`, and `xtal40mhz` features are enabled by default.
|
|
//!
|
|
//! [embedded-hal-async]: https://github.com/rust-embedded/embedded-hal/tree/master/embedded-hal-async
|
|
//! [embedded-io-async]: https://github.com/rust-embedded/embedded-hal/tree/master/embedded-io-async
|
|
//! [embedded-hal]: https://github.com/rust-embedded/embedded-hal/tree/master/embedded-hal
|
|
//! [embedded-hal-nb]: https://github.com/rust-embedded/embedded-hal/tree/master/embedded-hal-nb
|
|
//! [embedded-io]: https://github.com/rust-embedded/embedded-hal/tree/master/embedded-io
|
|
//! [embassy]: https://github.com/embassy-rs/embassy
|
|
//! [`ufmt_write::uWrite`]: https://docs.rs/ufmt-write/latest/ufmt_write/trait.uWrite.html
|
|
|
|
#![no_std]
|
|
#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/46717278")]
|
|
|
|
pub use esp_hal_common::*;
|
|
|
|
/// Common module for analog functions
|
|
pub mod analog {
|
|
pub use esp_hal_common::analog::{AvailableAnalog, SensExt};
|
|
}
|
|
|
|
/// Function initializes ESP32 specific memories (RTC slow and fast) and
|
|
/// then calls original Reset function
|
|
///
|
|
/// ENTRY point is defined in memory.x
|
|
/// *Note: the pre_init function is called in the original reset handler
|
|
/// after the initializations done in this function*
|
|
#[cfg(feature = "rt")]
|
|
#[doc(hidden)]
|
|
#[no_mangle]
|
|
pub unsafe extern "C" fn ESP32Reset() -> ! {
|
|
// These symbols come from `memory.x`
|
|
extern "C" {
|
|
static mut _rtc_fast_bss_start: u32;
|
|
static mut _rtc_fast_bss_end: u32;
|
|
|
|
static mut _rtc_slow_bss_start: u32;
|
|
static mut _rtc_slow_bss_end: u32;
|
|
|
|
static mut _stack_end_cpu0: u32;
|
|
}
|
|
|
|
// set stack pointer to end of memory: no need to retain stack up to this point
|
|
esp_hal_common::xtensa_lx::set_stack_pointer(&mut _stack_end_cpu0);
|
|
|
|
// copying data from flash to various data segments is done by the bootloader
|
|
// initialization to zero needs to be done by the application
|
|
|
|
// Initialize RTC RAM
|
|
esp_hal_common::xtensa_lx_rt::zero_bss(&mut _rtc_fast_bss_start, &mut _rtc_fast_bss_end);
|
|
esp_hal_common::xtensa_lx_rt::zero_bss(&mut _rtc_slow_bss_start, &mut _rtc_slow_bss_end);
|
|
|
|
// continue with default reset handler
|
|
esp_hal_common::xtensa_lx_rt::Reset();
|
|
}
|
|
|
|
/// The ESP32 has a first stage bootloader that handles loading program data
|
|
/// into the right place therefore we skip loading it again.
|
|
#[doc(hidden)]
|
|
#[no_mangle]
|
|
#[rustfmt::skip]
|
|
pub extern "Rust" fn __init_data() -> bool {
|
|
false
|
|
}
|