esp_alloc/
macros.rs

Help
1//! Macros provided for convenience
2
3/// Initialize a global heap allocator providing a heap of the given size in
4/// bytes. This supports attributes.
5///
6/// # Usage
7/// ```rust, no_run
8/// // Use 64kB in the same region stack uses (dram_seg), for the heap.
9/// heap_allocator!(size: 64000);
10/// // Use 64kB in dram2_seg for the heap, which is otherwise unused.
11/// heap_allocator!(#[link_section = ".dram2_uninit"] size: 64000);
12/// ```
13#[macro_export]
14macro_rules! heap_allocator {
15    ($(#[$m:meta])* size: $size:expr) => {{
16        $(#[$m])*
17        static mut HEAP: core::mem::MaybeUninit<[u8; $size]> = core::mem::MaybeUninit::uninit();
18
19        unsafe {
20            $crate::HEAP.add_region($crate::HeapRegion::new(
21                HEAP.as_mut_ptr() as *mut u8,
22                $size,
23                $crate::MemoryCapability::Internal.into(),
24            ));
25        }
26    }};
27}
28
29/// Initialize a global heap allocator backed by PSRAM
30///
31/// You need a SoC which supports PSRAM
32/// and activate the feature to enable it. You need to pass the PSRAM peripheral
33/// and the psram module path.
34///
35/// # Usage
36/// ```rust, no_run
37/// esp_alloc::psram_allocator!(peripherals.PSRAM, hal::psram);
38/// ```
39#[macro_export]
40macro_rules! psram_allocator {
41    ($peripheral:expr, $psram_module:path) => {{
42        use $psram_module as _psram;
43        let (start, size) = _psram::psram_raw_parts(&$peripheral);
44        unsafe {
45            $crate::HEAP.add_region($crate::HeapRegion::new(
46                start,
47                size,
48                $crate::MemoryCapability::External.into(),
49            ));
50        }
51    }};
52}
esp_alloc/macros.rs

esp_alloc/
macros.rs
