NDCTL User Guide
HomePMDKNDCTLBlog
v72.1
v72.1
  • NDCTL User Guide
  • Installing NDCTL, DAXCTL, and CXL-CLI Utilities
    • Installing NDCTL and DAXCTL Packages on Linux
    • Installing the CXL-CLI Package on Linux
    • Installing NDCTL, DAXCTL, and CXL-CLI from Source on Linux
  • Quick Start
  • Concepts
    • NVDIMM Devices
    • PMEM and BLK Modes
    • Regions
      • Regions, Atomic Sectors, and DAX
    • Label Storage Area (LSA)
    • Namespaces
  • Managing NVDIMMs
  • Managing Regions
  • Managing Label Storage Areas (LSA)
  • Managing Namespaces
  • Managing NVDIMM Security
  • NDCTL Man Pages
    • ndctl(1)
    • ndctl-activate-firmware(1)
    • ndctl−check−labels(1)
    • ndctl−check−namespace(1)
    • ndctl−clear−errors(1)
    • ndctl−create−namespace(1)
    • ndctl−destroy−namespace(1)
    • ndctl−disable−dimm(1)
    • ndctl−disable−namespace(1)
    • ndctl−disable−region(1)
    • ndctl−enable−dimm(1)
    • ndctl-enable−namespace(1)
    • ndctl−enable−region(1)
    • ndctl−freeze−security(1)
    • ndctl−init−labels(1)
    • ndctl−inject−error(1)
    • ndctl−inject−smart(1)
    • ndct-list(1)
    • ndctl−load−keys(1)
    • ndctl−monitor(1)
    • ndctl-read-infoblock(1)
    • ndctl−read−labels(1)
    • ndctl−remove−passphrase(1)
    • ndctl−sanitize−dimm(1)
    • ndctl−setup−passphrase(1)
    • ndctl−start−scrub(1)
    • ndctl-update-firmware(1)
    • ndctl-update-passphrase(1)
    • ndctl−wait−overwrite(1)
    • ndctl−wait−scrub(1)
    • ndctl-write-infoblock(1)
    • ndctl−write−labels(1)
    • ndctl−zero−labels(1)
  • DAXCTL Man Pages
    • daxctl(1)
    • daxctl-create-device (1)
    • daxctl-destroy-device (1)
    • daxctl-disable-device (1)
    • daxctl-enable-device (1)
    • daxctl-list(1)
    • daxctl−migrate−device−model(1)
    • daxctl−offline−memory(1)
    • daxctl−online−memory(1)
    • daxctl−reconfigure−device(1)
  • CXL Man Pages
    • cxl(1)
    • cxl-list(1)
    • cxl-read-labels(1)
    • cxl-write-labels(1)
    • cxl-zero-labels(1)
  • Troubleshooting
  • Glossary
  • Reference Material
Powered by GitBook
On this page
  • Documentation for ndctl and daxctl
  • NAME
  • SYNOPSIS
  • DESCRIPTION
  • OPTIONS
  • COPYRIGHT

Was this helpful?

  1. NDCTL Man Pages

ndctl-update-firmware(1)

Documentation for ndctl and daxctl

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

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.

-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

Previousndctl−start−scrub(1)Nextndctl-update-passphrase(1)

Last updated 3 years ago

Was this helpful?

Copyright (c) 2016 - 2020, Intel Corporation. License GPLv2: GNU GPL version 2 . This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

http://gnu.org/licenses/gpl.html