summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/board/andestech/index.rst1
-rw-r--r--doc/board/andestech/voyager.rst81
-rw-r--r--doc/board/microsoft/index.rst1
-rw-r--r--doc/board/microsoft/surface-2.rst41
-rw-r--r--doc/board/rockchip/rockchip.rst4
-rw-r--r--doc/build/clang.rst8
-rw-r--r--doc/build/gen_compile_commands.rst2
-rw-r--r--doc/build/reproducible.rst2
-rw-r--r--doc/build/tools.rst9
-rw-r--r--doc/develop/release_cycle.rst4
-rw-r--r--doc/device-tree-bindings/power/ti,sci-pm-domain.txt2
-rw-r--r--doc/device-tree-bindings/remoteproc/k3-system-controller.txt4
-rw-r--r--doc/device-tree-bindings/reset/ti,sci-reset.txt2
-rw-r--r--doc/usage/cmd/sntp.rst8
-rw-r--r--doc/usage/cmd/wget.rst2
15 files changed, 149 insertions, 22 deletions
diff --git a/doc/board/andestech/index.rst b/doc/board/andestech/index.rst
index cacc5791a91..5ef93308b49 100644
--- a/doc/board/andestech/index.rst
+++ b/doc/board/andestech/index.rst
@@ -8,3 +8,4 @@ Andes Tech
adp-ag101p
ae350
+ voyager
diff --git a/doc/board/andestech/voyager.rst b/doc/board/andestech/voyager.rst
new file mode 100644
index 00000000000..63553216d60
--- /dev/null
+++ b/doc/board/andestech/voyager.rst
@@ -0,0 +1,81 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Voyager
+=======
+
+Qilai RISC-V SoC
+----------------
+The QiLai SoC chip is Andes' first RISC-V SoC. It includes high performance
+quad-core Andes AX45MP cluster and one NX27V vector processor.
+
+The Voyager development platform is based on Qilai and capable of running Linux.
+
+Mainline support
+----------------
+
+The support for following drivers are already enabled:
+
+1. UART driver
+2. MMC driver
+3. SPI driver
+
+Building
+~~~~~~~~
+
+How to build U-Boot SPL
+~~~~~~~~~~~~~~~~~~~~~~~
+Before building U-Boot SPL, OpenSBI must be build first.
+OpenSBI can be cloned and build for Voyager as below:
+
+1. Get the RISC-V toolchain.
+2. Setup cross compilation environment variable.
+
+.. code-block:: none
+
+ git clone https://github.com/riscv-software-src/opensbi.git
+ cd opensbi
+ make PLATFORM=generic
+
+Copy OpenSBI FW_DYNAMIC image (build/platform/generic/firmware/fw_dynamic.bin)
+into U-Boot root directory, then
+
+.. code-block:: console
+
+ export CROSS_COMPILE=riscv64-linux-gnu-
+ cd <U-Boot-dir>
+ cp fw_dynamic.bin .
+ make voyager_spl_defconfig
+ make
+
+Booting
+~~~~~~~
+
+Currently, we rely on vendor ROM code to initialize the DDR
+and load the u-boot image, then boot from it.
+
+Sample boot log from Voyager board
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: none
+
+ U-Boot SPL 2025.10-rc1-00130-ga28bcbba4778-dirty (Aug 06 2025 - 17:46:10 +0800)
+ Trying to boot from RAM
+
+ U-Boot 2025.10-rc1-00130-ga28bcbba4778-dirty (Aug 06 2025 - 17:46:10 +0800)
+
+ CPU: riscv
+ Model: andestech,ax45
+ DRAM: 16 GiB
+ Core: 25 devices, 14 uclasses, devicetree: board
+ MMC: mmc@30c00000: 0
+ Loading Environment from SPIFlash... SF: Detected mx25u1635e with page size 256 Bytes, erase size 4 KiB, total 2 MiB
+ *** Warning - bad CRC, using default environment
+
+ In: serial@30300000
+ Out: serial@30300000
+ Err: serial@30300000
+ Net: No ethernet found.
+ Hit any key to stop autoboot: 0
+ No ethernet found.
+ No ethernet found.
+ RISC-V #
diff --git a/doc/board/microsoft/index.rst b/doc/board/microsoft/index.rst
index 107f3527852..8318449a9a2 100644
--- a/doc/board/microsoft/index.rst
+++ b/doc/board/microsoft/index.rst
@@ -6,4 +6,5 @@ Microsoft
.. toctree::
:maxdepth: 2
+ surface-2
surface-rt
diff --git a/doc/board/microsoft/surface-2.rst b/doc/board/microsoft/surface-2.rst
new file mode 100644
index 00000000000..8185c6f5ae4
--- /dev/null
+++ b/doc/board/microsoft/surface-2.rst
@@ -0,0 +1,41 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+U-Boot for the Microsoft Surface 2 tablet
+=========================================
+
+Quick Start
+-----------
+
+- Build U-Boot
+- Boot
+
+Build U-Boot
+------------
+
+.. code-block:: bash
+
+ $ export CROSS_COMPILE=arm-none-eabi-
+ $ make surface-2_defconfig
+ $ make
+
+After the build succeeds, you will obtain the final ``u-boot-dtb-tegra.bin``
+image, ready for loading.
+
+Boot
+----
+
+Currently, U-Boot can be preloaded into RAM via the Fusée Gelée. To enter
+RCM protocol use ``power`` and ``volume up`` key combination from powered
+off device. The host PC should recognize an APX device.
+
+Built U-Boot ``u-boot-dtb-tegra.bin`` can be loaded from fusee-tools
+directory with
+
+.. code-block:: bash
+
+ $ ./run_bootloader.sh -s T30 -t ./bct/surface-2.bct
+
+To boot Linux, U-Boot will look for an ``extlinux.conf`` on MicroSD and then on
+eMMC. Additionally, if the Volume Down button is pressed while loading, the
+device will enter bootmenu. Bootmenu contains entries to mount MicroSD and eMMC
+as mass storage, fastboot, poweroff and enter U-Boot console.
diff --git a/doc/board/rockchip/rockchip.rst b/doc/board/rockchip/rockchip.rst
index b88299cbba2..de3aa79cb5c 100644
--- a/doc/board/rockchip/rockchip.rst
+++ b/doc/board/rockchip/rockchip.rst
@@ -134,7 +134,9 @@ List of mainline supported Rockchip boards:
- Radxa ROCK 3B (rock-3b-rk3568)
* rk3576
+ - ArmSoM Sige5 (sige5-rk3576)
- Firefly ROC-RK3576-PC (roc-pc-rk3576)
+ - Generic RK3576 (generic-rk3576)
* rk3588
- ArmSoM Sige7 (sige7-rk3588)
@@ -145,6 +147,7 @@ List of mainline supported Rockchip boards:
- FriendlyElec NanoPC-T6 (nanopc-t6-rk3588)
- FriendlyElec NanoPi R6C (nanopi-r6c-rk3588s)
- FriendlyElec NanoPi R6S (nanopi-r6s-rk3588s)
+ - GameForce Ace (gameforce-ace-rk3588s)
- Generic RK3588S/RK3588 (generic-rk3588)
- Hardkernel ODROID-M2 (odroid-m2-rk3588s)
- Indiedroid Nova (nova-rk3588s)
@@ -161,6 +164,7 @@ List of mainline supported Rockchip boards:
- Xunlong Orange Pi 5 (orangepi-5-rk3588s)
- Xunlong Orange Pi 5 Max (orangepi-5-max-rk3588)
- Xunlong Orange Pi 5 Plus (orangepi-5-plus-rk3588)
+ - Xunlong Orange Pi 5 Ultra (orangepi-5-ultra-rk3588)
- Yanyi Tech CoolPi 4 Model B (coolpi-4b-rk3588s)
- Yanyi Tech CoolPi CM5 EVB (coolpi-cm5-evb-rk3588)
- Yanyi Tech CoolPi CM5 GenBook (coolpi-cm5-genbook-rk3588)
diff --git a/doc/build/clang.rst b/doc/build/clang.rst
index 09bb988e923..a83ecb4fdc6 100644
--- a/doc/build/clang.rst
+++ b/doc/build/clang.rst
@@ -46,9 +46,9 @@ It can also be used to compile sandbox:
FreeBSD 11
----------
-Since llvm 3.4 is currently in the base system, the integrated assembler as
-is incapable of building U-Boot. Therefore gas from devel/arm-gnueabi-binutils
-is used instead. It needs a symlink to be picked up correctly though:
+Since LLVM 3.4 is currently in the base system, the integrated assembler is
+incapable of building U-Boot. Therefore gas from devel/arm-gnueabi-binutils is
+used instead. It needs a symbolic link to be picked up correctly though:
.. code-block:: bash
@@ -64,7 +64,7 @@ The following commands compile U-Boot using the Clang xdev toolchain.
gmake rpi_2_defconfig
gmake CC="clang -target arm-freebsd-eabi --sysroot /usr/arm-freebsd" -j8
-Given that U-Boot will default to gcc, above commands can be
+Given that U-Boot will default to gcc, the commands above can be
simplified with a simple wrapper script - saved as
/usr/local/bin/arm-gnueabi-freebsd-gcc - listed below:
diff --git a/doc/build/gen_compile_commands.rst b/doc/build/gen_compile_commands.rst
index d503764f9e3..5eb9e4ccb0a 100644
--- a/doc/build/gen_compile_commands.rst
+++ b/doc/build/gen_compile_commands.rst
@@ -39,7 +39,7 @@ course) to have an up-to-date database.
The database will be in the root of the repository. No further modifications are
needed for it to be usable by the LSP, unless you set a name for the database
-other than it's default one (compile_commands.json).
+other than the default one (compile_commands.json).
Compatible IDEs
---------------
diff --git a/doc/build/reproducible.rst b/doc/build/reproducible.rst
index 8b030f469d7..1512129e374 100644
--- a/doc/build/reproducible.rst
+++ b/doc/build/reproducible.rst
@@ -24,4 +24,4 @@ This date is shown when we launch U-Boot:
./u-boot -T
U-Boot 2023.01 (Jan 01 2023 - 00:00:00 +0000)
-The same effect can be obtained with buildman using the `-r` flag.
+The same effect can be obtained with Buildman using the `-r` flag.
diff --git a/doc/build/tools.rst b/doc/build/tools.rst
index 5bfa05b2325..1cc8eb93230 100644
--- a/doc/build/tools.rst
+++ b/doc/build/tools.rst
@@ -8,7 +8,7 @@ Building tools for Linux
------------------------
To allow distributions to distribute all possible tools in a generic way,
-avoiding the need of specific tools building for each machine, a tools only
+avoiding the need of specific building tools for each machine, a tools-only
defconfig file is provided.
Using this, we can build the tools by doing::
@@ -30,9 +30,8 @@ installed all required packages below in order to build these host tools::
* diffutils (3.7)
* openssl-devel (1.1.1.d)
-Note the version numbers in these parentheses above are the package versions
-at the time being when writing this document. The MSYS2 installer tested is
-http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20190524.exe.
+Note that the version numbers in parentheses above are the package versions at
+the time of writing this document.
There are 3 MSYS subsystems installed: MSYS2, MinGW32 and MinGW64. Each
subsystem provides an environment to build Windows applications. The MSYS2
@@ -50,7 +49,7 @@ Launch the MSYS2 shell of the MSYS2 environment, and do the following::
Building without Python
-----------------------
-The tools-only builds bytes pylibfdt by default. To disable this, use the
+The tools-only builds pylibfdt by default. To disable this, use the
NO_PYTHON variable::
NO_PYTHON=1 make tools-only_defconfig tools-only
diff --git a/doc/develop/release_cycle.rst b/doc/develop/release_cycle.rst
index 354ab1b5d74..daf73e207d4 100644
--- a/doc/develop/release_cycle.rst
+++ b/doc/develop/release_cycle.rst
@@ -75,9 +75,9 @@ For the next scheduled release, release candidates were made on::
* U-Boot |next_ver|-rc2 was released on Mon 11 August 2025.
-.. * U-Boot |next_ver|-rc3 was released on Mon 25 August 2025.
+* U-Boot |next_ver|-rc3 was released on Mon 25 August 2025.
-.. * U-Boot |next_ver|-rc4 was released on Mon 08 September 2025.
+* U-Boot |next_ver|-rc4 was released on Mon 08 September 2025.
.. * U-Boot |next_ver|-rc5 was released on Mon 22 September 2025.
diff --git a/doc/device-tree-bindings/power/ti,sci-pm-domain.txt b/doc/device-tree-bindings/power/ti,sci-pm-domain.txt
index 72d9fbc833c..81f6314230f 100644
--- a/doc/device-tree-bindings/power/ti,sci-pm-domain.txt
+++ b/doc/device-tree-bindings/power/ti,sci-pm-domain.txt
@@ -30,7 +30,7 @@ Required Properties:
Example (AM65x):
----------------
sysfw: sysfw {
- compatible = "ti,am654-system-controller";
+ compatible = "ti,am654-tisci-rproc-r5";
...
k3_pds: power-controller {
compatible = "ti,sci-pm-domain";
diff --git a/doc/device-tree-bindings/remoteproc/k3-system-controller.txt b/doc/device-tree-bindings/remoteproc/k3-system-controller.txt
index 33dc46812ed..7de57ad4f00 100644
--- a/doc/device-tree-bindings/remoteproc/k3-system-controller.txt
+++ b/doc/device-tree-bindings/remoteproc/k3-system-controller.txt
@@ -8,7 +8,7 @@ This driver communicates with ROM for loading this firmware.
Required properties:
--------------------
-- compatible: Shall be: "ti,am654-system-controller"
+- compatible: Shall be: "ti,am654-tisci-rproc-r5-r5"
- mbox-names: "tx" for Transfer channel
"rx" for Receive channel
- mboxes: Corresponding phandles to mailbox channels.
@@ -21,7 +21,7 @@ Example:
--------
system-controller: system-controller {
- compatible = "ti,am654-system-controller";
+ compatible = "ti,am654-tisci-rproc-r5-r5";
mboxes= <&secproxy 4>, <&secproxy 5>;
mbox-names = "tx", "rx";
};
diff --git a/doc/device-tree-bindings/reset/ti,sci-reset.txt b/doc/device-tree-bindings/reset/ti,sci-reset.txt
index e7e2d13f9fb..740b2dfea64 100644
--- a/doc/device-tree-bindings/reset/ti,sci-reset.txt
+++ b/doc/device-tree-bindings/reset/ti,sci-reset.txt
@@ -23,7 +23,7 @@ Required Properties:
Example (AM65x):
----------------
sysfw: sysfw {
- compatible = "ti,am654-system-controller";
+ compatible = "ti,am654-tisci-rproc-r5";
...
k3_reset: reset-controller {
compatible = "ti,sci-reset";
diff --git a/doc/usage/cmd/sntp.rst b/doc/usage/cmd/sntp.rst
index d97f83053f7..2046828130d 100644
--- a/doc/usage/cmd/sntp.rst
+++ b/doc/usage/cmd/sntp.rst
@@ -12,7 +12,7 @@ Synopsis
::
sntp [serverip]
- sntp [servername] # NET_LWIP=y && CMD_DNS=y only
+ sntp [servername] # NET_LWIP=y && DNS=y only
Description
@@ -27,8 +27,8 @@ The address of the NTP server does not need to be given if the DHCP server
provides one. The legacy network stack (`CONFIG_NET=y`) can only use the
first NTP server provided in the `ntp-servers` DHCP option.
-When the network stack is lwIP (`CONFIG_NET_LWIP=y`) and the dns command
-is enabled (`CONFIG_CMD_DNS=y`), then the sntp command accepts a server
+When the network stack is lwIP (`CONFIG_NET_LWIP=y`) and DNS resolution
+is enabled (`CONFIG_DNS=y`), then the sntp command accepts a server
name as an argument.
The network time is sent as UTC. So, if you want to set the RTC to any local
@@ -61,7 +61,7 @@ Examples
=> date
Date: 2025-06-16 (Monday) Time: 17:19:57
-With `CONFIG_NET_LWIP=y` and `CONFIG_CMD_DNS=y`:
+With `CONFIG_NET_LWIP=y` and `CONFIG_DNS=y`:
::
diff --git a/doc/usage/cmd/wget.rst b/doc/usage/cmd/wget.rst
index 06df2842549..8feda0248b2 100644
--- a/doc/usage/cmd/wget.rst
+++ b/doc/usage/cmd/wget.rst
@@ -38,7 +38,7 @@ address
memory address for the data downloaded
host
- IP address (or host name if `CONFIG_CMD_DNS` is enabled) of the HTTP
+ IP address (or host name if `CONFIG_DNS` is enabled) of the HTTP
server, defaults to the value of environment variable *serverip*.
path