'\" t
.\"     Title: ndctl-update-firmware
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2022-04-08
.\"    Manual: ndctl Manual
.\"    Source: ndctl
.\"  Language: English
.\"
.TH "NDCTL\-UPDATE\-FIRMWARE" "1" "2022-04-08" "ndctl" "ndctl Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ndctl\-update\-firmware \- update the firmware the given device
.SH "SYNOPSIS"
.sp
.sp
.nf
\fIndctl update\-firmware\fP <dimm> [<options>]
.fi
.br
.SH "DESCRIPTION"
.sp
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:
.sp
.sp
.nf
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
  }
}
.fi
.br
.SH "OPTIONS"
.sp
<dimm>
.RS 4
A \fInmemX\fP device name, or a dimm id number. Restrict the operation to
the specified dimm(s). The keyword \fIall\fP can be specified to indicate
the lack of any restriction, however this is the same as not supplying
a \-\-dimm option at all.
.RE
.sp
\-b, \-\-bus=
.RS 4
A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict the
operation to the specified bus(es). The keyword \fIall\fP can be specified
to indicate the lack of any restriction, however this is the same as
not supplying a \-\-bus option at all.
.RE
.sp
\-f, \-\-firmware
.RS 4
firmware file used to perform the update
.RE
.sp
\-i, \-\-force
.RS 4
Ignore in\-progress Address Range Scrub and try to submit the
firmware update, or ignore firmware activate arm overflows and
force\-arm devices.
.RE
.sp
\-A, \-\-arm
.RS 4
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.
.RE
.sp
\-D, \-\-disarm
.RS 4
Disarm devices after uploading the firmware file, or manually
disarm devices when a firmware image is not specified.
\-\-no\-disarm is not accepted.
.RE
.sp
\-v, \-\-verbose
.RS 4
Emit debug messages for the namespace check process.
.RE
.SH "COPYRIGHT"
.sp
Copyright \(co 2016 \- 2020, Intel Corporation. License GPLv2: GNU GPL
version 2 \c
.URL "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.