Skip to content

Commit a9777d8

Browse files
Merge branch 'main' into feat/i2s-move
2 parents 3f82bc0 + 86f2853 commit a9777d8

File tree

4 files changed

+10
-35
lines changed

4 files changed

+10
-35
lines changed

esp-alloc/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
- Added chip-selection features (#4023)
1313
- New default feature (`compat`) enables implementations for `malloc`, `free`, `calloc`, `realloc` and others (#3890, #4043)
14-
- `ESP_ALLOC_CONFIG_HEAP_ALGORITHM` to select the global heap algorithm (#4130)
14+
- `ESP_ALLOC_CONFIG_HEAP_ALGORITHM` to select the global heap algorithm (LLFF, TLSF) (#4130, #4316)
15+
- Added option to use TLSF as the heap allocator, implemented by the `rlsf` crate (#4130, #4316)
1516

1617
### Changed
1718

1819
- Make stats structs fields public (#3828)
19-
- The default heap allocator is now TLSF, implemented by the `rlsf` crate (#3950)
2020
- Fixed documentation to use `ram(reclaimed)` instead of a no longer valid linker_section syntax. (#4245)
2121

2222
### Fixed

esp-alloc/esp_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ options:
55
description: "The heap algorithm to use. TLSF offers higher performance
66
and bounded allocation time, but uses more memory."
77
default:
8-
- value: '"TLSF"'
8+
- value: '"LLFF"'
99
constraints:
1010
- type:
1111
validator: enumeration

esp-backtrace/Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ esp32s3 = ["esp-println?/esp32s3", "esp-metadata-generated/esp32s3", "semihostin
6666
println = ["dep:esp-println"]
6767

6868
## Use `defmt`
69+
##
70+
## Please note that `defmt` does _not_ provide MSRV guarantees with releases, and as such we are
71+
## not able to make any MSRV guarantees when this feature is enabled. For more information refer to
72+
## the MSRV section of `defmt`'s README: https://github.com/knurling-rs/defmt?tab=readme-ov-file#msrv
6973
defmt = ["dep:defmt"]
7074

7175
print-float-registers = [] # TODO support esp32p4

esp-backtrace/README.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,14 @@
66
![Crates.io](https://img.shields.io/crates/l/esp-backtrace?labelColor=1C2C2E&style=flat-square)
77
[![Matrix](https://img.shields.io/matrix/esp-rs:matrix.org?label=join%20matrix&labelColor=1C2C2E&color=BEC5C9&logo=matrix&style=flat-square)](https://matrix.to/#/#esp-rs:matrix.org)
88

9-
Supports the ESP32, ESP32-C2/C3/C6, ESP32-H2, ESP32-P4, and ESP32-S2/S3. Optional exception and panic handlers are included, both of which can be enabled via their respective features.
9+
Supports the ESP32, ESP32-C2/C3/C6, ESP32-H2, ESP32-P4, and ESP32-S2/S3. Optional panic handler is included, which can be enabled via its respective feature.
1010

1111
Please note that when targeting a RISC-V device, you **need** to force frame pointers (i.e. `"-C", "force-frame-pointers",` in your `.cargo/config.toml`); this is **not** required for Xtensa.
1212

1313
You can get an array of backtrace addresses (currently limited to 10) via `arch::backtrace()` if
14-
you want to create a backtrace yourself (i.e. not using the panic or exception handler).
14+
you want to create a backtrace yourself (i.e. not using the panic handler).
1515

16-
When using the panic and/or exception handler make sure to include `use esp_backtrace as _;`.
17-
18-
## Features
19-
20-
| Feature | Description |
21-
| -------------------- | ------------------------------------------------------------------------------------------------------------------ |
22-
| esp32 | Target ESP32 |
23-
| esp32c2 | Target ESP32-C2 |
24-
| esp32c3 | Target ESP32-C3 |
25-
| esp32c6 | Target ESP32-C6 |
26-
| esp32h2 | Target ESP32-H2 |
27-
| esp32p4 | Target ESP32-P4 |
28-
| esp32s2 | Target ESP32-S2 |
29-
| esp32s3 | Target ESP32-S3 |
30-
| panic-handler | Include a panic handler, will add `esp-println` as a dependency |
31-
| exception-handler | Include an exception handler, will add `esp-println` as a dependency |
32-
| println | Use `esp-println` to print messages |
33-
| defmt | Use `defmt` logging to print messages\* (check [example](https://github.com/playfulFence/backtrace-defmt-example)) |
34-
| colors | Print messages in red\* |
35-
| halt-cores | Halt both CPUs on ESP32 / ESP32-S3 instead of doing a `loop {}` in case of a panic or exception |
36-
| semihosting | Call `semihosting::process::abort()` on panic. |
37-
| custom-halt | Invoke the extern function `custom_halt()` instead of doing a `loop {}` in case of a panic or exception |
38-
| custom-pre-backtrace | Invoke the extern function `custom_pre_backtrace()` before handling a panic or exception |
39-
40-
\* _only used for panic and exception handlers_
41-
42-
### `defmt` Feature
43-
44-
Please note that `defmt` does _not_ provide MSRV guarantees with releases, and as such we are not able to make any MSRV guarantees when this feature is enabled. For more information refer to the MSRV section of `defmt`'s README:
45-
https://github.com/knurling-rs/defmt?tab=readme-ov-file#msrv
16+
When using the panic handler make sure to include `use esp_backtrace as _;`.
4617

4718
## Minimum Supported Rust Version (MSRV)
4819

0 commit comments

Comments
 (0)