itsscb/esp-hal
1
0
Fork 0
mirror of https://github.com/esp-rs/esp-hal.git synced 2025-09-29 21:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix, simplify and ignore PSRAM doc example (#3789)

Browse Source 
* Run doctests with all needed features

* Fix, simplify and ignore PSRAM doc example
This commit is contained in:
Dániel Buga 2025-07-11 14:47:20 +02:00 committed by GitHub
parent 1e611aaf80
commit 9e20bc3807
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 19 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
esp-hal/src/soc/esp32/psram.rs
View File

@ -18,28 +18,13 @@
//! You need an ESP32 with at least 2 MB of PSRAM memory.
//! Notice that PSRAM example **must** be built in release mode!
//!
//! ```rust, no_run
//! ```rust, ignore
//! # {before_snippet}
//! # extern crate alloc;
//! # use alloc::{string::String, vec::Vec};
//! # use esp_alloc as _;
//! # use esp_hal::psram;
//!
//! // Initialize PSRAM and add it as a heap memory region
//! fn init_psram_heap(start: *mut u8, size: usize) {
//! unsafe {
//! esp_alloc::HEAP.add_region(esp_alloc::HeapRegion::new(
//! start,
//! size,
//! esp_alloc::MemoryCapability::External.into(),
//! ));
//! }
//! }
//!
//! // Initialize PSRAM and add it to the heap
//! let (start, size) = psram::init_psram(peripherals.PSRAM, psram::PsramConfig::default());
//!
//! init_psram_heap(start, size);
//! #
//! // Add PSRAM to the heap.
//! esp_alloc::psram_allocator!(&peripherals.PSRAM, esp_hal::psram);
//!
//! let mut large_vec: Vec<u32> = Vec::with_capacity(500 * 1024 / 4);
//!
@ -48,7 +33,7 @@
//! }
//!
//! let string = String::from("A string allocated in PSRAM");
//! # }
//! # {after_snippet}
//! ```
pub use crate::soc::psram_common::*;

23
esp-hal/src/soc/esp32s2/psram.rs
View File

@ -18,26 +18,13 @@
//! You need an ESP32S2 with at least 2 MB of PSRAM memory.
//! Notice that PSRAM example **must** be built in release mode!
//!
//! ```rust, no_run
//! ```rust, ignore
//! # {before_snippet}
//! # extern crate alloc;
//! # use alloc::{string::String, vec::Vec};
//! # use esp_alloc as _;
//! # use esp_hal::psram;
//!
//! // Initialize PSRAM and add it as a heap memory region
//! fn init_psram_heap(start: *mut u8, size: usize) {
//! unsafe {
//! esp_alloc::HEAP.add_region(esp_alloc::HeapRegion::new(
//! start,
//! size,
//! esp_alloc::MemoryCapability::External.into(),
//! ));
//! }
//! }
//!
//! // Initialize PSRAM and add it to the heap
//! let (start, size) = psram::init_psram(peripherals.PSRAM, psram::PsramConfig::default());
//! #
//! // Add PSRAM to the heap.
//! esp_alloc::psram_allocator!(&peripherals.PSRAM, esp_hal::psram);
//!
//! init_psram_heap(start, size);
//!
@ -48,7 +35,7 @@
//! }
//!
//! let string = String::from("A string allocated in PSRAM");
//! # }
//! # {after_snippet}
//! ```
use crate::peripherals::{EXTMEM, SPI0, SPI1};

25
esp-hal/src/soc/esp32s3/psram.rs
View File

@ -24,28 +24,13 @@
//!
//! Notice that PSRAM example **must** be built in release mode!
//!
//! ```rust, no_run
//! ```rust, ignore
//! # {before_snippet}
//! # extern crate alloc;
//! # use alloc::{string::String, vec::Vec};
//! # use esp_alloc as _;
//! # use esp_hal::psram;
//!
//! // Initialize PSRAM and add it as a heap memory region
//! fn init_psram_heap(start: *mut u8, size: usize) {
//! unsafe {
//! esp_alloc::HEAP.add_region(esp_alloc::HeapRegion::new(
//! start,
//! size,
//! esp_alloc::MemoryCapability::External.into(),
//! ));
//! }
//! }
//!
//! // Initialize PSRAM and add it to the heap
//! let (start, size) = psram::init_psram(peripherals.PSRAM, psram::PsramConfig::default());
//!
//! init_psram_heap(start, size);
//! #
//! // Add PSRAM to the heap.
//! esp_alloc::psram_allocator!(&peripherals.PSRAM, esp_hal::psram);
//!
//! let mut large_vec: Vec<u32> = Vec::with_capacity(500 * 1024 / 4);
//!
@ -54,7 +39,7 @@
//! }
//!
//! let string = String::from("A string allocated in PSRAM");
//! # }
//! # {after_snippet}
//! ```
use crate::peripherals::{EXTMEM, IO_MUX, SPI0, SPI1};

5
xtask/src/commands/run.rs
View File

@ -53,7 +53,10 @@ pub fn run_doc_tests(workspace: &Path, args: ExamplesArgs) -> Result<()> {
// Determine the appropriate build target, and cargo features for the given
// package and chip:
let target = args.package.target_triple(&chip)?;
let features = vec![chip.to_string(), "unstable".to_string()];
let mut features = args
.package
.feature_rules(&esp_metadata::Config::for_chip(&chip));
features.push(chip.to_string());
// We need `nightly` for building the doc tests, unfortunately:
let toolchain = if chip.is_xtensa() { "esp" } else { "nightly" };