From: Nishanth Menon <nm@ti.com>
To: Tom Rini <trini@konsulko.com>
Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>,
Sinthu Raja <sinthu.raja@ti.com>,
Manorit Chawdhry <m-chawdhry@ti.com>, Reid Tonking <reidt@ti.com>,
Neha Malcom Francis <n-francis@ti.com>, Andrew Davis <afd@ti.com>,
Simon Glass <sjg@chromium.org>,
Robert Nelson <robertcnelson@gmail.com>,
Jason Kridner <jkridner@beagleboard.org>,
Nishanth Menon <nm@ti.com>, <u-boot@lists.denx.de>, <bb@ti.com>,
<praneeth@ti.com>
Subject: [PATCH 4/5] doc: board: Move am62x_beagleplay to it's own vendor
Date: Sat, 4 Nov 2023 03:01:36 -0500 [thread overview]
Message-ID: <20231104080137.9628-5-nm@ti.com> (raw)
In-Reply-To: <20231104080137.9628-1-nm@ti.com>
Move BeaglePlay documentation to beagle as a board vendor and update
references accordingly.
Signed-off-by: Nishanth Menon <nm@ti.com>
---
doc/board/{ti => beagle}/am62x_beagleplay.rst | 22 +++++++++----------
.../{ti => beagle}/img/beagleplay_emmc.svg | 0
doc/board/beagle/index.rst | 13 +++++++++++
doc/board/index.rst | 1 +
doc/board/ti/k3.rst | 2 +-
5 files changed, 26 insertions(+), 12 deletions(-)
rename doc/board/{ti => beagle}/am62x_beagleplay.rst (96%)
rename doc/board/{ti => beagle}/img/beagleplay_emmc.svg (100%)
create mode 100644 doc/board/beagle/index.rst
diff --git a/doc/board/ti/am62x_beagleplay.rst b/doc/board/beagle/am62x_beagleplay.rst
similarity index 96%
rename from doc/board/ti/am62x_beagleplay.rst
rename to doc/board/beagle/am62x_beagleplay.rst
index 11bafaf5e137..3209a881849c 100644
--- a/doc/board/ti/am62x_beagleplay.rst
+++ b/doc/board/beagle/am62x_beagleplay.rst
@@ -23,7 +23,7 @@ Boot Flow:
----------
Below is the pictorial representation of boot flow:
-.. image:: img/boot_diagram_k3_current.svg
+.. image:: ../ti/img/boot_diagram_k3_current.svg
:alt: Boot flow diagram
- On this platform, 'TI Foundational Security' (TIFS) functions as the
@@ -34,7 +34,7 @@ Below is the pictorial representation of boot flow:
Sources:
--------
-.. include:: k3.rst
+.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_boot_sources
:end-before: .. k3_rst_include_end_boot_sources
@@ -42,17 +42,17 @@ Build procedure:
----------------
0. Setup the environment variables:
-.. include:: k3.rst
+.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_common_env_vars_desc
:end-before: .. k3_rst_include_end_common_env_vars_desc
-.. include:: k3.rst
+.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_board_env_vars_desc
:end-before: .. k3_rst_include_end_board_env_vars_desc
Set the variables corresponding to this platform:
-.. include:: k3.rst
+.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_common_env_vars_defn
:end-before: .. k3_rst_include_end_common_env_vars_defn
.. prompt:: bash $
@@ -65,7 +65,7 @@ Set the variables corresponding to this platform:
export OPTEE_PLATFORM=k3-am62x
export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
-.. include:: am62x_sk.rst
+.. include:: ../ti/am62x_sk.rst
:start-after: .. am62x_evm_rst_include_start_build_steps
:end-before: .. am62x_evm_rst_include_end_build_steps
@@ -82,12 +82,12 @@ Image formats
- tiboot3.bin
-.. image:: img/multi_cert_tiboot3.bin.svg
+.. image:: ../ti/img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/dm_tispl.bin.svg
+.. image:: ../ti/img/dm_tispl.bin.svg
:alt: tispl.bin image format
Additional hardware for U-Boot development
@@ -240,7 +240,7 @@ LED patterns during boot
A53 SPL DDR Memory Layout
-------------------------
-.. include:: am62x_sk.rst
+.. include:: ../ti/am62x_sk.rst
:start-after: .. am62x_evm_rst_include_start_ddr_mem_layout
:end-before: .. am62x_evm_rst_include_end_ddr_mem_layout
@@ -284,11 +284,11 @@ detailed setup and debugging information.
environment's distribution needs to be updated, it might be necessary to
build OpenOCD from the source.
-.. include:: k3.rst
+.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_openocd_connect_tag_connect
:end-before: .. k3_rst_include_end_openocd_connect_tag_connect
-.. include:: k3.rst
+.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_openocd_cfg_external_intro
:end-before: .. k3_rst_include_end_openocd_cfg_external_intro
diff --git a/doc/board/ti/img/beagleplay_emmc.svg b/doc/board/beagle/img/beagleplay_emmc.svg
similarity index 100%
rename from doc/board/ti/img/beagleplay_emmc.svg
rename to doc/board/beagle/img/beagleplay_emmc.svg
diff --git a/doc/board/beagle/index.rst b/doc/board/beagle/index.rst
new file mode 100644
index 000000000000..e6f9b7480d31
--- /dev/null
+++ b/doc/board/beagle/index.rst
@@ -0,0 +1,13 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+BeagleBoard.org
+###############
+
+
+ARM based boards
+----------------
+
+.. toctree::
+ :maxdepth: 2
+
+ am62x_beagleplay
diff --git a/doc/board/index.rst b/doc/board/index.rst
index 35dd3bcf5fad..9e4cecc889e0 100644
--- a/doc/board/index.rst
+++ b/doc/board/index.rst
@@ -17,6 +17,7 @@ Board-specific doc
asus/index
atmel/index
beacon/index
+ beagle/index
broadcom/index
bsh/index
cloos/index
diff --git a/doc/board/ti/k3.rst b/doc/board/ti/k3.rst
index 129edd4ff93d..45f62fb094e8 100644
--- a/doc/board/ti/k3.rst
+++ b/doc/board/ti/k3.rst
@@ -30,8 +30,8 @@ K3 Based SoCs
.. toctree::
:maxdepth: 1
- am62x_beagleplay
am62x_sk
+ ../beagle/am62x_beagleplay
../toradex/verdin-am62
am64x_evm
am65x_evm
--
2.37.2
next prev parent reply other threads:[~2023-11-04 8:02 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-04 8:01 [PATCH 0/5] board: beagle: Move beagleplay and omap3beagle under beagle vendor folder Nishanth Menon
2023-11-04 8:01 ` [PATCH 1/5] arm: dts: k3-am625-beagleplay-u-boot/r5: Just depend on k3-binman.dtsi Nishanth Menon
2023-11-06 14:34 ` Bryan Brattlof
2023-11-06 14:45 ` Nishanth Menon
2023-11-22 20:49 ` Tom Rini
2023-11-04 8:01 ` [PATCH 2/5] configs: Add am62x_beagleplay_*_defconfig Nishanth Menon
2023-11-04 8:01 ` [PATCH 3/5] board: Move beagleplay under beagle vendor folder Nishanth Menon
2023-11-06 14:29 ` Bryan Brattlof
2023-11-04 8:01 ` Nishanth Menon [this message]
2023-11-06 14:25 ` [PATCH 4/5] doc: board: Move am62x_beagleplay to it's own vendor Bryan Brattlof
2023-11-04 8:01 ` [PATCH 5/5] board: Move omap3 beagle under beagle vendor folder Nishanth Menon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231104080137.9628-5-nm@ti.com \
--to=nm@ti.com \
--cc=afd@ti.com \
--cc=bb@ti.com \
--cc=jkridner@beagleboard.org \
--cc=m-chawdhry@ti.com \
--cc=n-francis@ti.com \
--cc=praneeth@ti.com \
--cc=reidt@ti.com \
--cc=robertcnelson@gmail.com \
--cc=sinthu.raja@ti.com \
--cc=sjg@chromium.org \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
--cc=xypron.glpk@gmx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox