README.rst
1.. _snippet-ram-console:
2
3RAM Console Snippet (ram-console)
4#################################
5
6.. code-block:: console
7
8 west build -S ram-console [...]
9
10Overview
11********
12
13This snippet redirects console output to a RAM buffer. The RAM console
14buffer is a global array located in RAM region by default, whose address
15is unknown before building. The RAM console driver also supports using
16a dedicated section for the RAM console buffer with prefined address.
17
18How to enable RAM console buffer section
19****************************************
20
21Add board dts overlay to this snippet to add property ``zephyr,ram-console``
22in the chosen node and memory-region node with compatible string
23:dtcompatible:`zephyr,memory-region` as the following:
24
25.. code-block:: DTS
26
27 / {
28 chosen {
29 zephyr,ram-console = &snippet_ram_console;
30 };
31
32 snippet_ram_console: memory@93d00000 {
33 compatible = "zephyr,memory-region";
34 reg = <0x93d00000 DT_SIZE_K(4)>;
35 zephyr,memory-region = "RAM_CONSOLE";
36 };
37 };
38
