snippets: add ram-console snippet support
The ram-console snippet disabled UART console and enabled the RAM console with the option link the RAM console buffer to a dedicate section in a new added memory-region. Signed-off-by: Hou Zhiqiang <Zhiqiang.Hou@nxp.com>
This commit is contained in:
parent
1cd37f21f3
commit
fd584b4727
7 changed files with 146 additions and 0 deletions
37
snippets/ram-console/README.rst
Normal file
37
snippets/ram-console/README.rst
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
.. _snippet-ram-console:
|
||||||
|
|
||||||
|
RAM Console Snippet (ram-console)
|
||||||
|
#################################
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
west build -S ram-console [...]
|
||||||
|
|
||||||
|
Overview
|
||||||
|
********
|
||||||
|
|
||||||
|
This snippet redirects console output to a RAM buffer. The RAM console
|
||||||
|
buffer is a global array located in RAM region by default, whose address
|
||||||
|
is unknown before building. The RAM console driver also supports using
|
||||||
|
a dedicated section for the RAM console buffer with prefined address.
|
||||||
|
|
||||||
|
How to enable RAM console buffer section
|
||||||
|
****************************************
|
||||||
|
|
||||||
|
Add board dts overlay to this snippet to add property ``zephyr,ram-console``
|
||||||
|
in the chosen node and memory-region node with compatible string
|
||||||
|
:dtcompatible:`zephyr,memory-region` as the following:
|
||||||
|
|
||||||
|
.. code-block:: DTS
|
||||||
|
|
||||||
|
/ {
|
||||||
|
chosen {
|
||||||
|
zephyr,ram-console = &snippet_ram_console;
|
||||||
|
};
|
||||||
|
|
||||||
|
snippet_ram_console: memory@93d00000 {
|
||||||
|
compatible = "zephyr,memory-region";
|
||||||
|
reg = <0x93d00000 DT_SIZE_K(4)>;
|
||||||
|
zephyr,memory-region = "RAM_CONSOLE";
|
||||||
|
};
|
||||||
|
};
|
||||||
17
snippets/ram-console/boards/imx8mm_evk_mimx8mm6_a53.overlay
Normal file
17
snippets/ram-console/boards/imx8mm_evk_mimx8mm6_a53.overlay
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2024 NXP
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/
|
||||||
|
|
||||||
|
/ {
|
||||||
|
chosen {
|
||||||
|
zephyr,ram-console = &snippet_ram_console;
|
||||||
|
};
|
||||||
|
|
||||||
|
snippet_ram_console: memory@93d00000 {
|
||||||
|
compatible = "zephyr,memory-region";
|
||||||
|
reg = <0x93d00000 DT_SIZE_K(4)>;
|
||||||
|
zephyr,memory-region = "RAM_CONSOLE";
|
||||||
|
};
|
||||||
|
};
|
||||||
17
snippets/ram-console/boards/imx8mn_evk_mimx8mn6_a53.overlay
Normal file
17
snippets/ram-console/boards/imx8mn_evk_mimx8mn6_a53.overlay
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2024 NXP
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/
|
||||||
|
|
||||||
|
/ {
|
||||||
|
chosen {
|
||||||
|
zephyr,ram-console = &snippet_ram_console;
|
||||||
|
};
|
||||||
|
|
||||||
|
snippet_ram_console: memory@93d00000 {
|
||||||
|
compatible = "zephyr,memory-region";
|
||||||
|
reg = <0x93d00000 DT_SIZE_K(4)>;
|
||||||
|
zephyr,memory-region = "RAM_CONSOLE";
|
||||||
|
};
|
||||||
|
};
|
||||||
17
snippets/ram-console/boards/imx8mp_evk_mimx8ml8_a53.overlay
Normal file
17
snippets/ram-console/boards/imx8mp_evk_mimx8ml8_a53.overlay
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2024 NXP
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/
|
||||||
|
|
||||||
|
/ {
|
||||||
|
chosen {
|
||||||
|
zephyr,ram-console = &snippet_ram_console;
|
||||||
|
};
|
||||||
|
|
||||||
|
snippet_ram_console: memory@c0100000 {
|
||||||
|
compatible = "zephyr,memory-region";
|
||||||
|
reg = <0xc0100000 DT_SIZE_K(4)>;
|
||||||
|
zephyr,memory-region = "RAM_CONSOLE";
|
||||||
|
};
|
||||||
|
};
|
||||||
17
snippets/ram-console/boards/imx93_evk_mimx9352_a55.overlay
Normal file
17
snippets/ram-console/boards/imx93_evk_mimx9352_a55.overlay
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2024 NXP
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/
|
||||||
|
|
||||||
|
/ {
|
||||||
|
chosen {
|
||||||
|
zephyr,ram-console = &snippet_ram_console;
|
||||||
|
};
|
||||||
|
|
||||||
|
snippet_ram_console: memory@d0100000 {
|
||||||
|
compatible = "zephyr,memory-region";
|
||||||
|
reg = <0xd0100000 DT_SIZE_K(4)>;
|
||||||
|
zephyr,memory-region = "RAM_CONSOLE";
|
||||||
|
};
|
||||||
|
};
|
||||||
9
snippets/ram-console/ram-console.conf
Normal file
9
snippets/ram-console/ram-console.conf
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
#
|
||||||
|
# Copyright 2024 NXP
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# Disable UART Console
|
||||||
|
CONFIG_UART_CONSOLE=n
|
||||||
|
# Enable RAM Console
|
||||||
|
CONFIG_RAM_CONSOLE=y
|
||||||
32
snippets/ram-console/snippet.yml
Normal file
32
snippets/ram-console/snippet.yml
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
#
|
||||||
|
# Copyright 2024 NXP
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
#
|
||||||
|
|
||||||
|
name: ram-console
|
||||||
|
append:
|
||||||
|
EXTRA_CONF_FILE: ram-console.conf
|
||||||
|
|
||||||
|
boards:
|
||||||
|
imx8mm_evk/mimx8mm6/a53:
|
||||||
|
append:
|
||||||
|
EXTRA_DTC_OVERLAY_FILE: boards/imx8mm_evk_mimx8mm6_a53.overlay
|
||||||
|
imx8mm_evk/mimx8mm6/a53/smp:
|
||||||
|
append:
|
||||||
|
EXTRA_DTC_OVERLAY_FILE: boards/imx8mm_evk_mimx8mm6_a53.overlay
|
||||||
|
imx8mn_evk/mimx8mn6/a53:
|
||||||
|
append:
|
||||||
|
EXTRA_DTC_OVERLAY_FILE: boards/imx8mn_evk_mimx8mn6_a53.overlay
|
||||||
|
imx8mn_evk/mimx8mn6/a53/smp:
|
||||||
|
append:
|
||||||
|
EXTRA_DTC_OVERLAY_FILE: boards/imx8mn_evk_mimx8mn6_a53.overlay
|
||||||
|
imx8mp_evk/mimx8ml8/a53:
|
||||||
|
append:
|
||||||
|
EXTRA_DTC_OVERLAY_FILE: boards/imx8mp_evk_mimx8ml8_a53.overlay
|
||||||
|
imx8mp_evk/mimx8ml8/a53/smp:
|
||||||
|
append:
|
||||||
|
EXTRA_DTC_OVERLAY_FILE: boards/imx8mp_evk_mimx8ml8_a53.overlay
|
||||||
|
imx93_evk/mimx9352/a55:
|
||||||
|
append:
|
||||||
|
EXTRA_DTC_OVERLAY_FILE: boards/imx93_evk_mimx9352_a55.overlay
|
||||||
Loading…
Reference in a new issue