@@ -58,7 +58,69 @@ include::xable-bus-options.txt[]
Arm a device for firmware activation. This is enabled by default
when a firmware image is specified. Specify --no-arm to disable
this default. Otherwise, without a firmware image, this option can be
- used to manually arm a device for firmware activate.
+ used to manually arm a device for firmware activate. When a
+ device transitions from unarmed to armed the platform recalculates the
+ firmware activation time and compares it against the maximum platform
+ supported time. If the activation time would exceed the platform maximum the
+ arm attempt is aborted:
+
+[verse]
+ndctl update-firmware --arm --bus=nfit_test.0 all
+ Error: update firmware: nmem4: arm aborted, tripped overflow
+[
+ {
+ "dev":"nmem1",
+ "id":"cdab-0a-07e0-ffffffff",
+ "handle":"0",
+ "phys_id":"0",
+ "security":"disabled",
+ "firmware":{
+ "current_version":"0",
+ "can_update":true
+ }
+ },
+ {
+ "dev":"nmem3",
+ "id":"cdab-0a-07e0-fffeffff",
+ "handle":"0x100",
+ "phys_id":"0x2",
+ "security":"disabled",
+ "firmware":{
+ "current_version":"0",
+ "can_update":true
+ }
+ },
+ {
+ "dev":"nmem2",
+ "id":"cdab-0a-07e0-feffffff",
+ "handle":"0x1",
+ "phys_id":"0x1",
+ "security":"disabled",
+ "firmware":{
+ "current_version":"0",
+ "can_update":true
+ }
+ }
+]
+updated 3 nmems.
+
+ It is possible, but not recommended, to ignore timeout overflows
+ with the --force option. At any point to view the 'armed' state of the
+ bus do:
+
+[verse]
+ndctl list -BF -b nfit_test.0
+[
+ {
+ "provider":"nfit_test.0",
+ "dev":"ndbus2",
+ "scrub_state":"idle",
+ "firmware":{
+ "activate_method":"suspend",
+ "activate_state":"overflow"
+ }
+ }
+]
-D::
--disarm::
Give examples and remediation for "overflow" events, i.e. where the estimated time to complete activation exceeds the platform advertised maximum. When that happens forced activation can lead to undefined results. Signed-off-by: Dan Williams <dan.j.williams@intel.com> --- Documentation/ndctl/ndctl-update-firmware.txt | 64 +++++++++++++++++++++++++ 1 file changed, 63 insertions(+), 1 deletion(-)