79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> |
||
---|---|---|
.. | ||
boards | ||
src | ||
CMakeLists.txt | ||
README.rst | ||
prj.conf | ||
sample.yaml |
README.rst
.. _spiram_test: Espressif ESP32 SPIRAM test ########################### Overview ******** This sample allocates memory from internal DRAM and SPIRAM by calling :c:func:`k_malloc`, frees allocated memory by calling :c:func:`k_free` and checks if memory can be allocated again. Capability of allocated memory is decided by ESP_HEAP_MIN_EXTRAM_THRESHOLD. If size is less than ESP_HEAP_MIN_EXTRAM_THRESHOLD, memory is allocated from internal DRAM. If size is greater than ESP_HEAP_MIN_EXTRAM_THRESHOLD, memory is allocated from SPIRAM. Supported SoCs ************** The following SoCs are supported by this sample code so far: * ESP32 * ESP32-S2 Building and Running ******************** Make sure you have your board connected over USB port. .. code-block:: console west build -b esp32 samples/boards/esp32/spiram_test west flash If using another supported Espressif board, replace the argument in the above command with a proper board name (e.g., `esp32s2_saola`). Sample Output ============= To check output of this sample, run ``west espressif monitor`` or any other serial console program (e.g., minicom, putty, screen, etc). This example uses ``west espressif monitor``, which automatically detects the serial port at ``/dev/ttyUSB0``: .. code-block:: console $ west espressif monitor .. code-block:: console mem test ok! 209 SPIRAM mem test pass mem test ok! 194 Internal mem test pass