doc: board: raspberrypi: Add documentation
PATCH 1/1 doc: board: raspberrypi: Add documentation
From: Matthias Brugger <[email protected]>
Add documentation about the different configuration files for the RaspberryPi board family.
--- 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
doc/board/raspberrypi/index.rst new file +10 -0
@@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger <[email protected]> + +Raspberry Pi +============ + +.. toctree:: + :maxdepth: 2 + + raspberrypi
doc/board/raspberrypi/raspberrypi.rst new file +53 -0
53 lines not on this page · raw message
Signature · 1 line
2.34.1
Hi Matthias,
Quoted 6 lines · On Mon, 14 Mar 2022 at 05:04, <[email protected]> wrote:
From: Matthias Brugger <[email protected]>
Add documentation about the different configuration files for the RaspberryPi board family.
Quoted 7 lines
Signed-off-by Matthias Brugger <[email protected]>--- 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
nit below
Quoted 23 lines
doc/board/raspberrypi/index.rst new file +10
-0@@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger <[email protected]> + +Raspberry Pi +============ + +.. toctree:: + :maxdepth: 2 + + raspberrypidoc/board/raspberrypi/raspberrypi.rst new file +0
-0
doc/board/raspberrypi/raspberrypi.rst line 4
Quoted 4 lines
doc/board/raspberrypi/raspberrypi.rst new file +4
-0@@ -0,0 +1,53 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger <[email protected]> + +RASPBERRY PI
Better to use lower case?
Quoted 38 lines
doc/board/raspberrypi/raspberrypi.rst new file +38
-0+============ + +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
doc/board/raspberrypi/raspberrypi.rst line 52
Quoted 10 lines
doc/board/raspberrypi/raspberrypi.rst new file +10
-0+ - 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' ?
Quoted 4 lines
doc/board/raspberrypi/raspberrypi.rst new file +1
-1+ --2.34.1
Regards,
Simon
Quoted 13 lines · Simon Glass
Hi Matthias,
Quoted 10 lines · On Mon, 14 Mar 2022 at 05:04, <[email protected]> wrote:
From: Matthias Brugger <[email protected]>
Add documentation about the different configuration files for the RaspberryPi board family.
Signed-off-by Matthias Brugger <[email protected]>--- 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.
Quoted 9 lines
Quoted 3 lines
2 files changed, 63 insertions(+)create mode 100644
doc/board/raspberrypi/index.rstcreate mode 100644doc/board/raspberrypi/raspberrypi.rstReviewed-by Simon Glass <[email protected]>nit below
Quoted 1 line
Quoted 11 lines
doc/board/raspberrypi/index.rst line 5
Quoted 11 lines
doc/board/raspberrypi/index.rst new file +5
-0@@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger <[email protected]> + +Raspberry Pi +============
All other boards have:
vendor/index.rstvendor/board1.rstvendor/board2.rst
I suggest to let this file refer to Broadcom Inc SoC based devices in general.
Best regards
Heinrich
Quoted 78 lines
Quoted 11 lines
doc/board/raspberrypi/index.rst new file +5
-0+ +.. toctree:: + :maxdepth: 2 + + raspberrypidoc/board/raspberrypi/raspberrypi.rst new file +0
-0doc/board/raspberrypi/raspberrypi.rst line 4
Quoted 4 lines
doc/board/raspberrypi/raspberrypi.rst new file +4
-0@@ -0,0 +1,53 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2022 Matthias Brugger <[email protected]> + +RASPBERRY PIBetter to use lower case?
Quoted 38 lines
doc/board/raspberrypi/raspberrypi.rst new file +38
-0+============ + +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_defconfigdoc/board/raspberrypi/raspberrypi.rst line 52
Quoted 10 lines
doc/board/raspberrypi/raspberrypi.rst new file +10
-0+ - 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' ?
Quoted 4 lines
doc/board/raspberrypi/raspberrypi.rst new file +1
-1+ --2.34.1
Regards,
Simon