summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <trini@konsulko.com>2024-02-12 15:22:05 -0500
committerTom Rini <trini@konsulko.com>2024-02-12 15:22:05 -0500
commit73b5b47dd5b546d0b9106bcca54c72815380e6d3 (patch)
tree347bf71809965d00f7d709b175930e78f82ce710 /doc
parenta5f877a0bd64af97dbc812c9a0a8d7d6a353d943 (diff)
parent2eb39c9adafb4210c6bcf0aed75a34493c098c8e (diff)
Merge tag 'doc-2024-04-rc2' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request doc-2024-04-rc2 Documentation: * Fix and extend utf8_to_utf32_stream() documentation * Fix rendering of OpenSBI logo in VisionFive 2 description * Document imxrt1170-evk board * codingstyle.rst: Clarify include section UEFI: * simplify error message in efi_disk_create_raw()
Diffstat (limited to 'doc')
-rw-r--r--doc/board/nxp/imxrt1170-evk.rst50
-rw-r--r--doc/board/nxp/index.rst1
-rw-r--r--doc/board/starfive/visionfive2.rst10
-rw-r--r--doc/develop/codingstyle.rst23
4 files changed, 67 insertions, 17 deletions
diff --git a/doc/board/nxp/imxrt1170-evk.rst b/doc/board/nxp/imxrt1170-evk.rst
new file mode 100644
index 00000000000..86bd39ccb64
--- /dev/null
+++ b/doc/board/nxp/imxrt1170-evk.rst
@@ -0,0 +1,50 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+imxrt1170-evk
+=============
+
+How to use U-Boot on NXP i.MXRT1170 EVK
+---------------------------------------
+
+- Build U-Boot for i.MXRT1170 EVK:
+
+ .. code-block:: bash
+
+ $ make mrproper
+ $ make imxrt1170-evk_defconfig
+ $ make
+
+ This will generate the SPL image called SPL and the u-boot.img.
+
+- Flash the SPL image into the micro SD card:
+
+ .. code-block:: bash
+
+ $sudo dd if=SPL of=/dev/sdX bs=1k seek=1 conv=notrunc; sync
+
+ This location is not compatible with GPT partioning. Please, use MBR
+ partitioning instead.
+
+- Flash the u-boot.img image into the micro SD card:
+
+ .. code-block:: bash
+
+ $sudo dd if=u-boot.img of=/dev/sdX bs=1k seek=128 conv=notrunc; sync
+
+- Jumper settings
+
+ .. list-table::
+ :stub-columns: 1
+
+ * - SW1
+ - 1 0 1 0
+ * - SW2
+ - 0 0 0 0 | 0 0 0 0 | 1 0 0 0
+
+ where 0 means bottom position and 1 means top position (from the
+ switch label numbers reference).
+
+- Connect the USB cable between the EVK and the PC for the console.
+ The USB console connector is the one close the ethernet connector
+
+- Insert the micro SD card in the board, power it up and U-Boot messages should come up.
diff --git a/doc/board/nxp/index.rst b/doc/board/nxp/index.rst
index 3bd9ed3c873..94687730544 100644
--- a/doc/board/nxp/index.rst
+++ b/doc/board/nxp/index.rst
@@ -14,6 +14,7 @@ NXP Semiconductors
imx93_11x11_evk
imxrt1020-evk
imxrt1050-evk
+ imxrt1170-evk
ls1046ardb
mx6sabreauto
mx6sabresd
diff --git a/doc/board/starfive/visionfive2.rst b/doc/board/starfive/visionfive2.rst
index 6cb033ead04..abda8ac21bc 100644
--- a/doc/board/starfive/visionfive2.rst
+++ b/doc/board/starfive/visionfive2.rst
@@ -133,14 +133,14 @@ Sample boot log from StarFive VisionFive2 board
Trying to boot from MMC2
OpenSBI v1.2-80-g4b28afc
- ____ _____ ____ _____
- / __ \ / ____| _ \_ _|
+ ____ _____ ____ _____
+ / __ \ / ____| _ \_ _|
| | | |_ __ ___ _ __ | (___ | |_) || |
| | | | '_ \ / _ \ '_ \ \___ \| _ < | |
| |__| | |_) | __/ | | |____) | |_) || |_
- \____/| .__/ \___|_| |_|_____/|___/_____|
- | |
- |_|
+ \____/| .__/ \___|_| |_|_____/|____/_____|
+ | |
+ |_|
Platform Name : StarFive VisionFive 2 v1.3B
Platform Features : medeleg
diff --git a/doc/develop/codingstyle.rst b/doc/develop/codingstyle.rst
index b25bfbd271f..f6248cdcb1e 100644
--- a/doc/develop/codingstyle.rst
+++ b/doc/develop/codingstyle.rst
@@ -108,30 +108,29 @@ expected size, or that particular members appear at the right offset.
Include files
-------------
-You should follow this ordering in U-Boot. The common.h header (which is going
-away at some point) should always be first, followed by other headers in order,
-then headers with directories, then local files:
+You should follow this ordering in U-Boot. In all cases, they should be listed
+in alphabetical order. First comes headers which are located directly in our
+top-level include diretory. This excludes the common.h header file which is to
+be removed. Second are headers within subdirectories, Finally directory-local
+includes should be listed. See this example:
.. code-block:: C
- #include <common.h>
#include <bootstage.h>
#include <dm.h>
#include <others.h>
#include <asm/...>
- #include <arm/arch/...>
+ #include <asm/arch/...>
#include <dm/device_compat.h>
#include <linux/...>
#include "local.h"
-Within that order, sort your includes.
-
-It is important to include common.h first since it provides basic features used
-by most files, e.g. CONFIG options.
-
For files that need to be compiled for the host (e.g. tools), you need to use
-``#ifndef USE_HOSTCC`` to avoid including common.h since it includes a lot of
-internal U-Boot things. See common/image.c for an example.
+``#ifndef USE_HOSTCC`` to avoid including U-Boot specific include files. See
+common/image.c for an example.
+
+If you encounter code which still uses <common.h> a patch to remove that and
+replace it with any required include files directly is much appreciated.
If your file uses driver model, include <dm.h> in the C file. Do not include
dm.h in a header file. Try to use forward declarations (e.g. ``struct