From: Nishanth Menon <nm@ti.com>
To: <u-boot@lists.denx.de>, Tom Rini <trini@konsulko.com>
Cc: Wadim Egorov <w.egorov@phytec.de>,
Francesco Dolcini <francesco@dolcini.it>,
Sjoerd Simons <sjoerd@collabora.com>,
Neha Malcom Francis <n-francis@ti.com>,
Bryan Brattlof <bb@ti.com>, Vignesh Raghavendra <vigneshr@ti.com>,
Marcel Ziswiler <marcel.ziswiler@toradex.com>,
Nikhil Jain <n-jain1@ti.com>, Nishanth Menon <nm@ti.com>
Subject: [PATCH 00/16] doc: board: ti: Cleanup documentation
Date: Thu, 27 Jul 2023 03:00:11 -0500 [thread overview]
Message-ID: <20230727080027.2817701-1-nm@ti.com> (raw)
Hi,
As requested in the thread[1] and irc[2], this series cleansup board/ti
documentation a bit.
Highlights:
* Reuse from k3.rst sources and build instructions at the same time
satisfy needs of users to have a single page documentation on all the
steps needed to build for a given platform.
* Replace ascii diagrams with actual svg diagrams (I have used a mix of
drawio and inkscape to develop these, though inkscape should be
sufficient to keep it updated). This also allows reuse based on common
patterns.
* Convert all pending tables into list-tables
* Add information for folks who are looking for board information
incontext of the documentation itself. (ever wondered what board is
this documentation talking about?)
Nishanth Menon (16):
doc: board: ti: Optimize sources references
doc: board: ti: am62x/j7200: Update with common boot flow diagram
doc: board: ti: am65x: Update with boot flow diagram
doc: board: ti: j721e: Update with boot flow diagram
doc: board: ti: k3: Reuse build instructions
doc: board: ti: j7200: Convert the image format to svg
doc: board: ti: j721e: Convert the image format to svg
doc: board: ti: am65x: Convert the image format to svg
doc: board: ti: am62x: Convert the image format to svg
doc: board: ti: am62x_sk: Convert switch settings to list tables
doc: board: ti: j7200_evm: Convert switch settings to list tables
doc: board: ti: am65x_evm: Convert the UART boot responsibility to
list table
doc: board: ti: am65/j721e: Convert OSPI memory map to svg
doc: board: ti: am65x_evm: Convert the emmc layout to svg
doc: board: ti: j7200_evm: Convert the emmc layout to svg
doc: board: ti: *: Add platform information
doc/board/ti/am62x_sk.rst | 240 +-
doc/board/ti/am65x_evm.rst | 300 +--
doc/board/ti/img/boot_diagram_am65.svg | 1835 +++++++++++++++
doc/board/ti/img/boot_diagram_j721e.svg | 2088 +++++++++++++++++
doc/board/ti/img/boot_diagram_k3_current.svg | 1987 ++++++++++++++++
doc/board/ti/img/dm_tispl.bin.svg | 317 +++
doc/board/ti/img/emmc_am65x_evm_boot0.svg | 748 ++++++
doc/board/ti/img/emmc_j7200_evm_boot01.svg | 662 ++++++
doc/board/ti/img/emmc_j7200_evm_udafs.svg | 505 ++++
doc/board/ti/img/j7200_tiboot3.bin.svg | 487 ++++
doc/board/ti/img/multi_cert_tiboot3.bin.svg | 287 +++
.../ti/img/no_multi_cert_tiboot3.bin.svg | 238 ++
doc/board/ti/img/nodm_tispl.bin.svg | 277 +++
doc/board/ti/img/ospi_sysfw.svg | 721 ++++++
doc/board/ti/img/sysfw.itb.svg | 317 +++
doc/board/ti/j7200_evm.rst | 298 +--
doc/board/ti/j721e_evm.rst | 267 +--
doc/board/ti/k3.rst | 98 +-
18 files changed, 10853 insertions(+), 819 deletions(-)
create mode 100644 doc/board/ti/img/boot_diagram_am65.svg
create mode 100644 doc/board/ti/img/boot_diagram_j721e.svg
create mode 100644 doc/board/ti/img/boot_diagram_k3_current.svg
create mode 100644 doc/board/ti/img/dm_tispl.bin.svg
create mode 100644 doc/board/ti/img/emmc_am65x_evm_boot0.svg
create mode 100644 doc/board/ti/img/emmc_j7200_evm_boot01.svg
create mode 100644 doc/board/ti/img/emmc_j7200_evm_udafs.svg
create mode 100644 doc/board/ti/img/j7200_tiboot3.bin.svg
create mode 100644 doc/board/ti/img/multi_cert_tiboot3.bin.svg
create mode 100644 doc/board/ti/img/no_multi_cert_tiboot3.bin.svg
create mode 100644 doc/board/ti/img/nodm_tispl.bin.svg
create mode 100644 doc/board/ti/img/ospi_sysfw.svg
create mode 100644 doc/board/ti/img/sysfw.itb.svg
--
2.40.0
next reply other threads:[~2023-07-27 8:02 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-27 8:00 Nishanth Menon [this message]
2023-07-27 8:00 ` [PATCH 01/16] doc: board: ti: Optimize sources references Nishanth Menon
2023-07-27 9:38 ` Neha Malcom Francis
2023-07-27 14:07 ` Tom Rini
2023-07-27 8:00 ` [PATCH 02/16] doc: board: ti: am62x/j7200: Update with common boot flow diagram Nishanth Menon
2023-07-27 9:40 ` Neha Malcom Francis
2023-07-27 10:02 ` Neha Malcom Francis
2023-07-27 10:04 ` Neha Malcom Francis
2023-07-27 13:12 ` Nishanth Menon
2023-07-28 7:31 ` Heinrich Schuchardt
2023-07-28 12:40 ` Nishanth Menon
2023-07-27 14:08 ` Tom Rini
2023-07-27 8:00 ` [PATCH 03/16] doc: board: ti: am65x: Update with " Nishanth Menon
2023-07-27 9:41 ` Neha Malcom Francis
2023-07-27 8:00 ` [PATCH 04/16] doc: board: ti: j721e: " Nishanth Menon
2023-07-27 9:41 ` Neha Malcom Francis
2023-07-27 8:00 ` [PATCH 05/16] doc: board: ti: k3: Reuse build instructions Nishanth Menon
2023-07-27 9:47 ` Neha Malcom Francis
2023-07-27 14:08 ` Tom Rini
2023-07-27 8:00 ` [PATCH 06/16] doc: board: ti: j7200: Convert the image format to svg Nishanth Menon
2023-07-27 9:52 ` Neha Malcom Francis
2023-07-27 13:12 ` Nishanth Menon
2023-07-27 11:25 ` Neha Malcom Francis
2023-07-27 8:00 ` [PATCH 07/16] doc: board: ti: j721e: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 08/16] doc: board: ti: am65x: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 09/16] doc: board: ti: am62x: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 10/16] doc: board: ti: am62x_sk: Convert switch settings to list tables Nishanth Menon
2023-07-27 8:00 ` [PATCH 11/16] doc: board: ti: j7200_evm: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 12/16] doc: board: ti: am65x_evm: Convert the UART boot responsibility to list table Nishanth Menon
2023-07-27 8:00 ` [PATCH 13/16] doc: board: ti: am65/j721e: Convert OSPI memory map to svg Nishanth Menon
2023-07-27 8:00 ` [PATCH 14/16] doc: board: ti: am65x_evm: Convert the emmc layout " Nishanth Menon
2023-07-27 8:00 ` [PATCH 15/16] doc: board: ti: j7200_evm: " Nishanth Menon
2023-07-27 8:00 ` [PATCH 16/16] doc: board: ti: *: Add platform information Nishanth Menon
2023-07-27 13:43 ` [PATCH 00/16] doc: board: ti: Cleanup documentation Nishanth Menon
2023-07-27 14:08 ` Tom Rini
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=20230727080027.2817701-1-nm@ti.com \
--to=nm@ti.com \
--cc=bb@ti.com \
--cc=francesco@dolcini.it \
--cc=marcel.ziswiler@toradex.com \
--cc=n-francis@ti.com \
--cc=n-jain1@ti.com \
--cc=sjoerd@collabora.com \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
--cc=vigneshr@ti.com \
--cc=w.egorov@phytec.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.