]> git.ipfire.org Git - thirdparty/u-boot.git/commitdiff
doc: tqma7: add documentation
authorAlexander Feilke <alexander.feilke@ew.tq-group.com>
Tue, 7 Apr 2026 13:06:51 +0000 (15:06 +0200)
committerFabio Estevam <festevam@gmail.com>
Tue, 21 Apr 2026 23:49:39 +0000 (20:49 -0300)
Add readme for the tqma7 board.

Reviewed-by: Peng Fan <peng.fan@nxp.com>
Signed-off-by: Alexander Feilke <alexander.feilke@ew.tq-group.com>
doc/board/index.rst
doc/board/tq/index.rst [new file with mode: 0644]
doc/board/tq/tqma7.rst [new file with mode: 0644]

index 7870f1bc2461b16e970ce8e58e3d05ba0f2c9b20..fcb4224bae34d9d20a2970c8ff73c826643a5aeb 100644 (file)
@@ -71,6 +71,7 @@ Board-specific doc
    theobroma-systems/index
    ti/index
    toradex/index
+   tq/index
    variscite/index
    wexler/index
    xen/index
diff --git a/doc/board/tq/index.rst b/doc/board/tq/index.rst
new file mode 100644 (file)
index 0000000..d6dc610
--- /dev/null
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later or CC-BY-4.0
+
+.. Copyright (c) 2024-2026 TQ-Systems GmbH <u-boot@ew.tq-group.com>,
+.. D-82229 Seefeld, Germany.
+
+TQ-Systems
+==========
+
+.. toctree::
+   :maxdepth: 2
+
+   tqma7
diff --git a/doc/board/tq/tqma7.rst b/doc/board/tq/tqma7.rst
new file mode 100644 (file)
index 0000000..60fd883
--- /dev/null
@@ -0,0 +1,77 @@
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. Copyright (c) 2020-2026 TQ-Systems GmbH <u-boot@ew.tq-group.com>,
+.. D-82229 Seefeld, Germany.
+
+########################################
+U-Boot for the TQ-Systems TQMa7x modules
+########################################
+
+This file contains information for the port of
+U-Boot to the TQ-Systems TQMa7x modules.
+
+***********
+Boot source
+***********
+
+The following boot sources are supported:
+
+- SD/eMMC
+- USB (SDP)
+
+QSPI boot is functional but requires an additional prepended NXP header
+image. This currently unsupported in u-boot.
+
+********
+Building
+********
+
+To build U-Boot for the TQ-Systems TQMa7x modules:
+
+.. code-block:: bash
+
+       make tqma7_mba7_<boot>_defconfig
+       make
+
+**boot** is a placeholder for the boot device:
+
++------+-----------+
+| mmc  | SD/eMMC   |
++------+-----------+
+| uuu  | USB (SDP) |
++------+-----------+
+
+The default build artifact is named ``u-boot-with-spl.imx``.
+
+*****************************************
+Serial Download Protocol (SDP) / USB boot
+*****************************************
+
+The complete system image can be programmed with ``uuu``
+(https://github.com/nxp-imx/mfgtools) to eMMC.
+
+Serial Download Protocol is supported on the Micro-B USB port (X5) of MBa7x.
+The command ``fastboot usb 0`` is used to enable the fastboot gadget.
+
+Build SDP enabled U-Boot image
+==============================
+
+.. code-block:: bash
+
+       make <som>_mba7_uuu_defconfig
+       make
+
+Booting
+=======
+
+With UUU
+
+.. code-block:: bash
+
+       uuu -b spl <UUU U-Boot image>
+
+************
+Support Wiki
+************
+
+See `TQ Embedded Wiki for TQMa7x <https://support.tq-group.com/en/arm/tqma7x>`_.