Scroll to navigation

NDCTL-UPDATE-FIRMWARE(1) ndctl Manual NDCTL-UPDATE-FIRMWARE(1)

NAME

ndctl-update-firmware - update the firmware the given device

SYNOPSIS

ndctl update-firmware <dimm> [<options>]

DESCRIPTION

Provide a generic interface for updating NVDIMM firmware. The use of this depends on support for the NVDIMM "family" in libndctl, the kernel needs to enable that command set, and the device itself needs to implement the command. Use "ndctl list -DF" to interrogate if firmware update is enabled. For example:

ndctl list -DFu -d nmem1
{


  "dev":"nmem1",


  "id":"cdab-0a-07e0-ffffffff",


  "handle":"0",


  "phys_id":"0",


  "security":"disabled",


  "firmware":{


    "current_version":"0",


    "can_update":true


  }
}

OPTIONS

<dimm>

A nmemX device name, or a dimm id number. Restrict the operation to the specified dimm(s). The keyword all can be specified to indicate the lack of any restriction, however this is the same as not supplying a --dimm option at all.

-b, --bus=

A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict the operation to the specified bus(es). The keyword all can be specified to indicate the lack of any restriction, however this is the same as not supplying a --bus option at all.

-f, --firmware

firmware file used to perform the update

-i, --force

Ignore in-progress Address Range Scrub and try to submit the firmware update, or ignore firmware activate arm overflows and force-arm devices.

-A, --arm

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. 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:

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:

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

Disarm devices after uploading the firmware file, or manually disarm devices when a firmware image is not specified. --no-disarm is not accepted.

-v, --verbose

Emit debug messages for the namespace check process.

COPYRIGHT

Copyright © 2016 - 2022, Intel Corporation. License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

2023-02-24 ndctl