Skip to content

Commit a7accb5

Browse files
committed
added simple readmes to examples`
1 parent 0a5939f commit a7accb5

File tree

4 files changed

+16
-0
lines changed

4 files changed

+16
-0
lines changed

examples/all_allocator/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## all_allocator
2+
3+
This example detects the PSRAM available on the board, and adds it as well as the built in SRAM based heap to an allocator to provide an unified access to available memory. The allocator manages the *allocation* of the PSRAM and heap SRAM via a single API. The example also ```wraps``` the built in ```malloc``` and ```free``` suite of commands to integrate with existing examples and uses.
4+
5+
A "Two-Level Segregated Fit" (flsf) allocator is used from [here](https://github.com/espressif/tlsf).

examples/has_psram/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## has_psram
2+
3+
One of the more simple examples, this example shows how to detect if PSRAM is on the rp2350 board, and the size of the PSRAM available. It also walks through the available PSRAM, manually setting and verifying values.

examples/psram_allocator/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## psram_allocator
2+
3+
This example detects the PSRAM available on the board, and adds it to an allocator, which manages the *allocation* of the PSRAM. PSRAM is accessed (allocated) using a provided API, which mimics the standard malloc/free functionality.
4+
5+
A "Two-Level Segregated Fit" (flsf) allocator is used from [here](https://github.com/espressif/tlsf).

examples/set_qflash/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## test_qflash
2+
3+
This is a simple example that is used to verify the Quad SPI bit is set in the flash IC used on the attached board. It doesn't require the use of the ```sparkfun_pico``` library, but is helpful during board development and fits with the goals of this repository.

0 commit comments

Comments
 (0)