summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHsuan Ting Chen <roccochen@google.com>2024-03-07 18:46:10 +0800
committerAnastasia Klimchuk <aklm@chromium.org>2024-03-30 12:46:15 +0000
commit041644a6afb12232495c45d3450ae0b3e2eb2a2d (patch)
treedafce8badec8141a355a4718fbe0e1f303a91063
parent1bcedfa598a3a266d4eee3c836921dec5f6a9f0c (diff)
downloadflashrom-041644a6afb12232495c45d3450ae0b3e2eb2a2d.tar.gz
flashrom-041644a6afb12232495c45d3450ae0b3e2eb2a2d.tar.bz2
flashrom-041644a6afb12232495c45d3450ae0b3e2eb2a2d.zip
classic_cli_manpage.rst: Update doc for custom_rst of raiden_debug_spi
Update technical details for custom_rst of raiden_debug_spi to help users better understand their configuration options. BUG=b:161745002 BRANCH=none TEST=`meson compile -C testdir` and view ./testdir/doc/html/classic_cli_manpage.html Change-Id: Ie2b084a3ed9bf40f91bfa81dbc95ec69d99d5ad0 Signed-off-by: Hsuan Ting Chen <roccochen@chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/81114 Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
-rw-r--r--doc/classic_cli_manpage.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/classic_cli_manpage.rst b/doc/classic_cli_manpage.rst
index c46edf6f1..f40d19ee5 100644
--- a/doc/classic_cli_manpage.rst
+++ b/doc/classic_cli_manpage.rst
@@ -899,11 +899,19 @@ USB device serial number to use specifically with::
The servo device serial number can be found via ``lsusb``.
Raiden will poll the ``ap`` target waiting for the system power to settle on the AP and EC flash devices.
-The optional ``custom_rst=true`` parameter changes the timeout value from 3ms to 10ms::
+The optional ``custom_rst=true`` parameter alters the behavior of the reset process::
flashrom -p raiden_debug_spi:custom_rst=<true|false>
-syntax, where ``custom_rst=false`` is the implicit default timeout of 3ms. More information about the ChromiumOS servo
+syntax, where:
+
+``custom_rst=false`` is the implicit default timeout of 3ms
+
+and ``custom_rst=true`` set ``RAIDEN_DEBUG_SPI_REQ_ENABLE_AP_CUSTOM`` instead of ``RAIDEN_DEBUG_SPI_REQ_ENABLE_AP``.
+This custom reset will modify the timeout from 3ms to 10ms and will not set ``EC_RST_L``, meaning neither the EC nor the AP will be reset. With this setting, it's the user's responsibility to manage the reset signal manually or by configuring the GPIO.
+Failure to handle the reset signal appropriately will likely result in flashing errors.
+
+More information about the ChromiumOS servo
hardware is available at `servos website <https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/HEAD/docs/servo_v4.md>`_.