From: Simon Glass <sjg@chromium.org>
To: U-Boot Mailing List <u-boot@lists.denx.de>
Cc: Tom Rini <trini@konsulko.com>, Simon Glass <sjg@chromium.org>
Subject: [PATCH v4 01/12] doc: Convert SPL documentation to ReST
Date: Sun, 1 Aug 2021 13:21:04 -0600 [thread overview]
Message-ID: <20210801132108.v4.1.I25ec0964fa88300c1888cc5b5fa2cdcd4697c22e@changeid> (raw)
In-Reply-To: <20210801192115.2183311-1-sjg@chromium.org>
Move this documentation over to .rst format.
Signed-off-by: Simon Glass <sjg@chromium.org>
---
(no changes since v1)
doc/develop/index.rst | 1 +
doc/{README.SPL => develop/spl.rst} | 36 +++++++++++++++--------------
2 files changed, 20 insertions(+), 17 deletions(-)
rename doc/{README.SPL => develop/spl.rst} (86%)
diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index 3ead7bda8fd..671cbca2755 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -15,6 +15,7 @@ Implementation
logging
makefiles
menus
+ spl
uefi/index
version
diff --git a/doc/README.SPL b/doc/develop/spl.rst
similarity index 86%
rename from doc/README.SPL
rename to doc/develop/spl.rst
index 0448835f5f1..c7d08d22bf2 100644
--- a/doc/README.SPL
+++ b/doc/develop/spl.rst
@@ -20,19 +20,19 @@ u-boot-spl.map.
A config option named CONFIG_SPL_BUILD is enabled by Kconfig for SPL.
Source files can therefore be compiled for SPL with different settings.
-For example:
+For example::
-ifeq ($(CONFIG_SPL_BUILD),y)
-obj-y += board_spl.o
-else
-obj-y += board.o
-endif
+ ifeq ($(CONFIG_SPL_BUILD),y)
+ obj-y += board_spl.o
+ else
+ obj-y += board.o
+ endif
-obj-$(CONFIG_SPL_BUILD) += foo.o
+ obj-$(CONFIG_SPL_BUILD) += foo.o
-#ifdef CONFIG_SPL_BUILD
- foo();
-#endif
+ #ifdef CONFIG_SPL_BUILD
+ foo();
+ #endif
The building of SPL images can be enabled by CONFIG_SPL option in Kconfig.
@@ -71,11 +71,13 @@ Device tree
The U-Boot device tree is filtered by the fdtgrep tools during the build
process to generate a much smaller device tree used in SPL (spl/u-boot-spl.dtb)
with:
+
- the mandatory nodes (/alias, /chosen, /config)
- the nodes with one pre-relocation property:
'u-boot,dm-pre-reloc' or 'u-boot,dm-spl'
fdtgrep is also used to remove:
+
- the properties defined in CONFIG_OF_SPL_REMOVE_PROPS
- all the pre-relocation properties
('u-boot,dm-pre-reloc', 'u-boot,dm-spl' and 'u-boot,dm-tpl')
@@ -98,14 +100,14 @@ stack usage at various points in run sequence of SPL. The -fstack-usage option
to gcc will produce '.su' files (such as arch/arm/cpu/armv7/syslib.su) that
will give stack usage information and cflow can construct program flow.
-Must have gcc 4.6 or later, which supports -fstack-usage
+Must have gcc 4.6 or later, which supports -fstack-usage:
-1) Build normally
-2) Perform the following shell command to generate a list of C files used in
-SPL:
-$ find spl -name '*.su' | sed -e 's:^spl/::' -e 's:[.]su$:.c:' > used-spl.list
-3) Execute cflow:
-$ cflow --main=board_init_r `cat used-spl.list` 2>&1 | $PAGER
+#. Build normally
+#. Perform the following shell command to generate a list of C files used in
+ SPL:
+#. `find spl -name '*.su' | sed -e 's:^spl/::' -e 's:[.]su$:.c:' > used-spl.list`
+#. Execute cflow:
+ `$ cflow --main=board_init_r $(cat used-spl.list) 2>&1 | $PAGER`
cflow will spit out a number of warnings as it does not parse
the config files and picks functions based on #ifdef. Parsing the '.i'
--
2.32.0.554.ge1b32706d8-goog
next prev parent reply other threads:[~2021-08-01 19:21 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-01 19:21 [PATCH v4 00/12] vpl: Introduce a verifying program loader Simon Glass
2021-08-01 19:21 ` Simon Glass [this message]
2021-08-01 19:21 ` [PATCH v4 02/12] doc: Expand SPL docs to explain the phase and config Simon Glass
2021-08-01 19:21 ` [PATCH v4 03/12] test: Tidy up test building with SPL Simon Glass
2021-08-01 19:21 ` [PATCH v4 04/12] spl: Move TPL_HASH_SUPPORT down next to other TPL options Simon Glass
2021-08-01 19:21 ` [PATCH v4 05/12] bloblist: Correct Kconfig dependencies Simon Glass
2021-08-01 19:21 ` [PATCH v4 06/12] avb: Don't build in SPL Simon Glass
2021-08-01 19:21 ` [PATCH v4 07/12] Makefile: Simplify devicetree rules for SPL/TPL Simon Glass
2021-08-01 19:21 ` [PATCH v4 08/12] Makefile: Tidy up the TPL build rules Simon Glass
2021-08-01 19:21 ` [PATCH v4 09/12] binman: Add VPL support Simon Glass
2021-08-01 19:21 ` [PATCH v4 10/12] Introduce Verifying Program Loader (VPL) Simon Glass
2021-08-01 19:21 ` [PATCH v4 11/12] vpl: Add Kconfig options for VPL Simon Glass
2021-08-01 19:21 ` [PATCH v4 12/12] sandbox: Add a build " Simon Glass
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=20210801132108.v4.1.I25ec0964fa88300c1888cc5b5fa2cdcd4697c22e@changeid \
--to=sjg@chromium.org \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.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.