From 2d05695d993325638ec6acfaa3067476b3b663d3 Mon Sep 17 00:00:00 2001 From: Daniel Barlow Date: Sun, 9 Jul 2023 15:07:12 +0100 Subject: [PATCH] add cautionary note about flashing from openwrt h/t matthewcroughan, thank you for your service --- doc/user.rst | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/doc/user.rst b/doc/user.rst index 63b655d1..c2a16874 100644 --- a/doc/user.rst +++ b/doc/user.rst @@ -138,19 +138,6 @@ Flashing ======== -Flashing from OpenWrt (untested) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If your device is running OpenWrt then it probably has the -:command:`mtd` command installed and you can use it as follows: - -.. code-block:: console - - mtd -r write /tmp/firmware_image.bin firmware - -For more information, please see the `OpenWrt manual `_ which may also contain (hardware-dependent) instructions on how to flash an image using the vendor firmware - perhaps even from a web interface. - - Flashing from the boot monitor ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -170,6 +157,24 @@ works we can flash the image - and if it doesn't work we can reboot the device again and it will boot from the old image. +Flashing from OpenWrt (not currently advised!) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. CAUTION:: At your own risk! This may in some circumstances lead to + bricking the device: we think this flash method is currently + incompatible with use of a writeable (jffs2) filesystem. + +If your device is running OpenWrt then it probably has the +:command:`mtd` command installed. After transferring the image onto the +device using e.g. :command:`ssh`, you can run it as follows: + +.. code-block:: console + + mtd -r write /tmp/firmware.bin firmware + +For more information, please see the `OpenWrt manual `_ which may also contain (hardware-dependent) instructions on how to flash an image using the vendor firmware - perhaps even from a web interface. + + Building the RAM-based image ............................