All of lore.kernel.org
 help / color / mirror / Atom feed
From: Wadim Egorov <w.egorov@phytec.de>
To: <trini@konsulko.com>, <d.haller@phytec.de>, <peng.fan@nxp.com>,
	<jh80.chung@samsung.com>, <m.schwan@phytec.de>
Cc: <u-boot@lists.denx.de>, <upstream@lists.phytec.de>
Subject: [PATCH 6/7] doc: board: phytec: k3: Document boot flow and watchdog
Date: Wed, 13 May 2026 09:19:04 +0200	[thread overview]
Message-ID: <20260513071905.83522-7-w.egorov@phytec.de> (raw)
In-Reply-To: <20260513071905.83522-1-w.egorov@phytec.de>

Add two short sections to the common K3 phyCORE docs.
Describe the default boot flow and its deprecated version.
And write down the use of the watchdog.

Signed-off-by: Wadim Egorov <w.egorov@phytec.de>
---
 doc/board/phytec/k3-common.rst | 47 ++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/doc/board/phytec/k3-common.rst b/doc/board/phytec/k3-common.rst
index ffb50b51ad6..3adb176ea8a 100644
--- a/doc/board/phytec/k3-common.rst
+++ b/doc/board/phytec/k3-common.rst
@@ -1,6 +1,53 @@
 .. SPDX-License-Identifier: GPL-2.0+
 .. sectionauthor:: Wadim Egorov <w.egorov@phytec.de>
 
+Boot Flow
+---------
+
+The default `bootcmd` performs three steps:
+
+.. code-block::
+
+  run start_watchdog; bootflow scan -lb; run ${boot}boot
+
+Boot devices are scanned in the order given by `boot_targets`:
+
+.. code-block::
+
+  mmc1 mmc0 spi_flash dhcp
+
+For each device, U-Boot tries the boot methods listed in `bootmeths`:
+
+.. code-block::
+
+  [rauc] script efi extlinux pxe
+
+The `rauc` bootmeth is only present when `CONFIG_BOOTMETH_RAUC=y` is set in
+the A53 defconfig. RAUC slot selection is handled entirely by the bootmeth;
+no environment-side configuration is required.
+
+The legacy `${boot}boot` chain (`mmcboot`, `spiboot`, `netboot`) is kept for
+backwards compatibility and prints a deprecation warning when run. New
+deployments should rely on the standard boot mechanism (`bootflow`) only.
+
+
+Watchdog
+--------
+
+`bootcmd` runs `start_watchdog` before starting the boot flow. When
+`CONFIG_WATCHDOG_TIMEOUT_MSECS` is set to a non-zero value and the
+`watchdog` environment variable points to a watchdog device, U-Boot enables
+the watchdog with that timeout.
+
+After this point the OS is responsible for servicing the watchdog. If it
+does not feed the watchdog before the timeout expires, the SoC will reset.
+Make sure the watchdog driver is enabled and configured in the kernel and
+userspace before relying on this.
+
+To skip the watchdog start, either build with `CONFIG_WATCHDOG_TIMEOUT_MSECS=0`
+or set `watchdog_timeout_ms=0` in the environment.
+
+
 Environment
 -----------
 
-- 
2.48.1


  parent reply	other threads:[~2026-05-13  7:19 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-13  7:18 [PATCH 0/7] board: phytec: Update rm-cfgs, env and docs Wadim Egorov
2026-05-13  7:18 ` [PATCH 1/7] board: phytec: phycore_am62x: Add tifs-rm-cfg Wadim Egorov
2026-05-13  7:19 ` [PATCH 2/7] arm: dts: k3-am625-phycore-som-binman: Enable tifs-rm-cfg Wadim Egorov
2026-05-13  7:19 ` [PATCH 3/7] board: phytec: phycore_am68x: Update rm-cfg Wadim Egorov
2026-05-13  7:19 ` [PATCH 4/7] include: env: phytec: Drop legacy RAUC boot logic Wadim Egorov
2026-05-13 14:10   ` Martin Schwan
2026-05-13  7:19 ` [PATCH 5/7] doc: board: phytec: Fix typos and copy-paste errors in K3 docs Wadim Egorov
2026-05-13  7:19 ` Wadim Egorov [this message]
2026-05-13  7:19 ` [PATCH 7/7] doc: board: phytec: Document DDR size override Kconfigs Wadim Egorov

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=20260513071905.83522-7-w.egorov@phytec.de \
    --to=w.egorov@phytec.de \
    --cc=d.haller@phytec.de \
    --cc=jh80.chung@samsung.com \
    --cc=m.schwan@phytec.de \
    --cc=peng.fan@nxp.com \
    --cc=trini@konsulko.com \
    --cc=u-boot@lists.denx.de \
    --cc=upstream@lists.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.