'\" t
.\"     Title: cxl-update-firmware
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-01-12
.\"    Manual: cxl Manual
.\"    Source: cxl
.\"  Language: English
.\"
.TH "CXL\-UPDATE\-FIRMWARE" "1" "2024-01-12" "cxl" "cxl 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"
cxl-update-firmware \- update the firmware on a CXL memdev
.SH "SYNOPSIS"
.sp
.nf
\fIcxl update\-firmware <mem0> [<mem1>..<memN>] [<options>]\fP
.fi
.br
.SH "DESCRIPTION"
.sp
Update the firmware on one or more CXL mem devices. The mem devices
must support the set of firmware related mailbox commands.
.sp
This command doesn\(cqt directly issue the transfer / activate firmware
mailbox commands. Instead, the kernel\(cqs firmware loader facility is
used to provide the kernel with the data, and the kernel handles
performing the actual update while also managing time slicing the
transfer w.r.t. other background commands.
.SH "EXAMPLE"
.sp
.if n .RS 4
.nf
.fam C
# cxl update\-firmware mem0 \-F firmware.bin \-w
[
  {
    "memdev":"mem0",
    "pmem_size":1073741824,
    "ram_size":1073741824,
    "serial":0,
    "numa_node":0,
    "host":"cxl_mem.0",
    "firmware":{
      "num_slots":3,
      "active_slot":2,
      "online_activate_capable":false,
      "slot_1_version":"cxl_test_fw_001",
      "slot_2_version":"cxl_test_fw_002",
      "slot_3_version":"cxl_test_new_fw",
      "fw_update_in_progress":false
    }
  }
]
firmware update completed on 1 mem device
.fam
.fi
.if n .RE
.SH "OPTIONS"
.sp
\-b, \-\-bus=
.RS 4
Restrict the operation to the specified bus.
.RE
.sp
\-F, \-\-firmware\-file
.RS 4
Firmware image file to use for the update.
.RE
.sp
\-c, \-\-cancel
.RS 4
Attempt to abort an in\-progress firmware update. This may
fail depending on what stage the update process is in.
.RE
.sp
\-w, \-\-wait
.RS 4
By default, the update\-firmware command only initiates the
firmware update, and returns, while the update operation
happens asynchronously in the background. This option makes
the firmware update command synchronous by waiting for it to
complete before returning.
.sp
.if n .RS 4
.nf
.fam C
If \-\-wait is passed in without an accompanying firmware\-file,
it will initiate a wait on any current in\-progress firmware
updates, and then return.
.fam
.fi
.if n .RE
.RE
.sp
\-v, \-\-verbose
.RS 4
Emit more debug messages
.RE
.SH "COPYRIGHT"
.sp
Copyright \(co 2016 \- 2022, 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.
.SH "SEE ALSO"
.sp
cxl\-list(1),