diff options
Diffstat (limited to 'Documentation/user')
| -rw-r--r-- | Documentation/user/barebox.rst | 1 | ||||
| -rw-r--r-- | Documentation/user/introduction.rst | 15 | ||||
| -rw-r--r-- | Documentation/user/reboot-mode.rst | 5 | ||||
| -rw-r--r-- | Documentation/user/watchdog.rst | 11 |
4 files changed, 28 insertions, 4 deletions
diff --git a/Documentation/user/barebox.rst b/Documentation/user/barebox.rst index a890aa4dbe..7b37ddba77 100644 --- a/Documentation/user/barebox.rst +++ b/Documentation/user/barebox.rst @@ -222,6 +222,7 @@ command doesn't support the barebox binaries directly, they first have to be converted to uImage format using the mkimage tool provided with U-Boot: .. code-block:: console + sh: mkimage -n barebox -A arm -T kernel -C none -a 0x80000000 -d \ build/images/barebox-freescale-imx53-loco.img image diff --git a/Documentation/user/introduction.rst b/Documentation/user/introduction.rst index 8a980a70ab..e7388b8bc9 100644 --- a/Documentation/user/introduction.rst +++ b/Documentation/user/introduction.rst @@ -15,6 +15,8 @@ development binary as well as for lean production systems. Just like busybox is the Swiss Army Knife for embedded Linux, barebox is the Swiss Army Knife for bare metal, hence the name. +.. _feedback: + Feedback -------- @@ -24,6 +26,15 @@ discussion of barebox takes place here: http://lists.infradead.org/mailman/listinfo/barebox/ -There's also an IRC channel: +Mails sent to the barebox mailing list are archived on +`lore.barebox.org <https://lore.barebox.org/barebox/>`_. + +Patch series sent there can be fetched with `b4 <https://pypi.org/project/b4/>`_ :: + + git config b4.midmask https://lore.barebox.org/%s + git config b4.linkmask https://lore.barebox.org/%s + b4 am https://lore.barebox.org/$messageid # replace with link -IRC: #barebox (Freenode) +There's also an IRC channel, which is +`bridged to Matrix <https://app.element.io/#/room/#barebox:matrix.org>`_: +#barebox on Libera Chat diff --git a/Documentation/user/reboot-mode.rst b/Documentation/user/reboot-mode.rst index 681438d944..83d4136b85 100644 --- a/Documentation/user/reboot-mode.rst +++ b/Documentation/user/reboot-mode.rst @@ -29,9 +29,10 @@ User API Devices registered with the reboot mode API gain two parameters: - ``$dev_of_reboot_mode.prev`` (read-only): The reboot mode that was - set previous to barebox startup + set previously to barebox startup. - ``$dev_of_reboot_mode.next``: The next reboot mode, for when the - system is reset + system is reset. Its initial value after startup is 0 which corresponds + to ``normal`` by default. The reboot mode driver core use the alias name if available to name the device. By convention, this should end with ``.reboot_mode``, e.g.:: diff --git a/Documentation/user/watchdog.rst b/Documentation/user/watchdog.rst index ff400317a0..0220965598 100644 --- a/Documentation/user/watchdog.rst +++ b/Documentation/user/watchdog.rst @@ -10,6 +10,15 @@ the bootloader. For these scenarios barebox provides the watchdog framework with the following functionality and at least ``CONFIG_WATCHDOG`` should be enabled. +Disabling for development +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The shorthand command ``wd -x`` will disable all watchdogs. +If hardware (or driver) doesn't support turning off the watchdog, +an autpoller will be registered to periodically feed watchdogs. +This should only be needed for development. +See :ref:`boot-watchdog-timeout` for how to use the watchdog in the field. + Polling ~~~~~~~ @@ -98,6 +107,8 @@ device tree or via the ``priority`` device parameter. Normally, watchdogs that have a wider effect should be given the higher priority (e.g. PMIC watchdog resetting the board vs. SoC's watchdog resetting only itself). +.. _boot-watchdog-timeout: + Boot Watchdog Timeout ~~~~~~~~~~~~~~~~~~~~~ |