[PATCH] doc: board: raspberrypi: Add documentation
From: Matthias Brugger mbrugger@suse.com
Add documentation about the different configuration files for the RaspberryPi board family.
Signed-off-by: Matthias Brugger mbrugger@suse.com --- doc/board/raspberrypi/index.rst | 10 +++++ doc/board/raspberrypi/raspberrypi.rst | 53 +++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 doc/board/raspberrypi/index.rst create mode 100644 doc/board/raspberrypi/raspberrypi.rst
diff --git a/doc/board/raspberrypi/index.rst b/doc/board/raspberrypi/index.rst new file mode 100644 index 0000000000..7a283d81af --- /dev/null +++ b/doc/board/raspberrypi/index.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger mbrugger@suse.com + +Raspberry Pi +============ + +.. toctree:: + :maxdepth: 2 + + raspberrypi diff --git a/doc/board/raspberrypi/raspberrypi.rst b/doc/board/raspberrypi/raspberrypi.rst new file mode 100644 index 0000000000..219a780e15 --- /dev/null +++ b/doc/board/raspberrypi/raspberrypi.rst @@ -0,0 +1,53 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger mbrugger@suse.com + +RASPBERRY PI +============ + +About this +---------- + +This document describes the information about Raspberry PI boards +and it's usage steps. + +Raspberry Pi boards +------------------- + +List of mainline supported Rasbperry Pi boards through the following configs: + +32-bits: +^^^^^^^^ + +* rpi_defconfig + - Raspberry Pi +* rpi_0_w_defconfig + - Raspberry Pi 1 + - Raspberry Pi zero +* rpi_2_defconfig + - Raspberry Pi 2 +* rpi_3_32b_defconfig + - Raspberry Pi 3b +* rpi_4_32b_defconfig + - Raspberry Pi 4b + +64-bits: +^^^^^^^^ + +* rpi_3_defconfig + - Raspberry Pi 3b +* rpi_3_b_plus_defconfig + - Raspberry Pi 3b+ +* rpi_4_defconfig + - Raspberry Pi 4b +* rpi_arm64_defconfig + - Raspberry Pi 3b + - Raspberry Pi 3b+ + - Raspberry Pi 4b + - Raspberry Pi 400 + - Raspberry Pi CM 3 + - Raspberry Pi CM 3+ + - Raspberry Pi CM 4 + - Raspberry Pi zero 2 w + +Config rpi_arm64_defconfig uses the DTB proviede by the firmware instead of using the embedded one. It allows to actually boot the same U-Boot binary of different boards. +
Hi Matthias,
On Mon, 14 Mar 2022 at 05:04, matthias.bgg@kernel.org wrote:
From: Matthias Brugger mbrugger@suse.com
Add documentation about the different configuration files for the RaspberryPi board family.
Signed-off-by: Matthias Brugger mbrugger@suse.com
doc/board/raspberrypi/index.rst | 10 +++++ doc/board/raspberrypi/raspberrypi.rst | 53 +++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 doc/board/raspberrypi/index.rst create mode 100644 doc/board/raspberrypi/raspberrypi.rst
Reviewed-by: Simon Glass sjg@chromium.org
nit below
diff --git a/doc/board/raspberrypi/index.rst b/doc/board/raspberrypi/index.rst new file mode 100644 index 0000000000..7a283d81af --- /dev/null +++ b/doc/board/raspberrypi/index.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger mbrugger@suse.com
+Raspberry Pi +============
+.. toctree::
- :maxdepth: 2
- raspberrypi
diff --git a/doc/board/raspberrypi/raspberrypi.rst b/doc/board/raspberrypi/raspberrypi.rst new file mode 100644 index 0000000000..219a780e15 --- /dev/null +++ b/doc/board/raspberrypi/raspberrypi.rst @@ -0,0 +1,53 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger mbrugger@suse.com
+RASPBERRY PI
Better to use lower case?
+============
+About this +----------
+This document describes the information about Raspberry PI boards +and it's usage steps.
+Raspberry Pi boards +-------------------
+List of mainline supported Rasbperry Pi boards through the following configs:
+32-bits: +^^^^^^^^
+* rpi_defconfig
- Raspberry Pi
+* rpi_0_w_defconfig
- Raspberry Pi 1
- Raspberry Pi zero
+* rpi_2_defconfig
- Raspberry Pi 2
+* rpi_3_32b_defconfig
- Raspberry Pi 3b
+* rpi_4_32b_defconfig
- Raspberry Pi 4b
+64-bits: +^^^^^^^^
+* rpi_3_defconfig
- Raspberry Pi 3b
+* rpi_3_b_plus_defconfig
- Raspberry Pi 3b+
+* rpi_4_defconfig
- Raspberry Pi 4b
+* rpi_arm64_defconfig
- Raspberry Pi 3b
- Raspberry Pi 3b+
- Raspberry Pi 4b
- Raspberry Pi 400
- Raspberry Pi CM 3
- Raspberry Pi CM 3+
- Raspberry Pi CM 4
- Raspberry Pi zero 2 w
+Config rpi_arm64_defconfig uses the DTB proviede by the firmware instead of using the embedded one. It allows to actually boot the same U-Boot binary of different boards.
provided
how about 'It allows booting the same' ?
-- 2.34.1
Regards, Simon
On 3/14/22 19:24, Simon Glass wrote:
Hi Matthias,
On Mon, 14 Mar 2022 at 05:04, matthias.bgg@kernel.org wrote:
From: Matthias Brugger mbrugger@suse.com
Add documentation about the different configuration files for the RaspberryPi board family.
Signed-off-by: Matthias Brugger mbrugger@suse.com
doc/board/raspberrypi/index.rst | 10 +++++ doc/board/raspberrypi/raspberrypi.rst | 53 +++++++++++++++++++++++++++
Thanks for writing this up.
An entry in doc/board/index.rst is missing.
2 files changed, 63 insertions(+) create mode 100644 doc/board/raspberrypi/index.rst create mode 100644 doc/board/raspberrypi/raspberrypi.rst
Reviewed-by: Simon Glass sjg@chromium.org
nit below
diff --git a/doc/board/raspberrypi/index.rst b/doc/board/raspberrypi/index.rst new file mode 100644 index 0000000000..7a283d81af --- /dev/null +++ b/doc/board/raspberrypi/index.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger mbrugger@suse.com
+Raspberry Pi +============
All other boards have:
vendor/index.rst vendor/board1.rst vendor/board2.rst
I suggest to let this file refer to Broadcom Inc SoC based devices in general.
Best regards
Heinrich
+.. toctree::
- :maxdepth: 2
- raspberrypi
diff --git a/doc/board/raspberrypi/raspberrypi.rst b/doc/board/raspberrypi/raspberrypi.rst new file mode 100644 index 0000000000..219a780e15 --- /dev/null +++ b/doc/board/raspberrypi/raspberrypi.rst @@ -0,0 +1,53 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger mbrugger@suse.com
+RASPBERRY PI
Better to use lower case?
+============
+About this +----------
+This document describes the information about Raspberry PI boards +and it's usage steps.
+Raspberry Pi boards +-------------------
+List of mainline supported Rasbperry Pi boards through the following configs:
+32-bits: +^^^^^^^^
+* rpi_defconfig
- Raspberry Pi
+* rpi_0_w_defconfig
- Raspberry Pi 1
- Raspberry Pi zero
+* rpi_2_defconfig
- Raspberry Pi 2
+* rpi_3_32b_defconfig
- Raspberry Pi 3b
+* rpi_4_32b_defconfig
- Raspberry Pi 4b
+64-bits: +^^^^^^^^
+* rpi_3_defconfig
- Raspberry Pi 3b
+* rpi_3_b_plus_defconfig
- Raspberry Pi 3b+
+* rpi_4_defconfig
- Raspberry Pi 4b
+* rpi_arm64_defconfig
- Raspberry Pi 3b
- Raspberry Pi 3b+
- Raspberry Pi 4b
- Raspberry Pi 400
- Raspberry Pi CM 3
- Raspberry Pi CM 3+
- Raspberry Pi CM 4
- Raspberry Pi zero 2 w
+Config rpi_arm64_defconfig uses the DTB proviede by the firmware instead of using the embedded one. It allows to actually boot the same U-Boot binary of different boards.
provided
how about 'It allows booting the same' ?
-- 2.34.1
Regards, Simon
participants (3)
-
Heinrich Schuchardt -
matthias.bgg＠kernel.org -
Simon Glass