proxmox-mirrors/fwupd
1
0
Fork 0
mirror of https://git.proxmox.com/git/fwupd synced 2025-06-03 20:14:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
e47de909c0
fwupd/plugins/nvme
History
Richard Hughes 40cd18fa97 Allow using a per-device global percentage completion 
It's actually quite hard to build a front-end for fwupd at the moment
as you're never sure when the progress bar is going to zip back to 0%
and start all over again. Some plugins go 0..100% for write, others
go 0..100% for erase, then again for write, then *again* for verify.

By creating a helper object we can easily split up the progress of the
specific task, e.g. write_firmware().

We can encode at the plugin level "the erase takes 50% of the time, the
write takes 40% and the read takes 10%". This means we can have a
progressbar which goes up just once at a consistent speed.
2021-09-13 14:28:15 +01:00
..
fu-nvme-common.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-nvme-common.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-nvme-device.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-nvme-device.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-plugin-nvme.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-self-test.c trivial: fix nvme and ata self tests failing in buildd 2021-09-03 15:10:38 -05:00
meson.build Move the plugin build logic to the plugins themselves 2021-02-18 14:46:20 +00:00
nvme.quirk Add needs-shutdown flag for Kingston vendor ID, remove wrong Kingston OUI 2021-05-22 07:48:53 +01:00
README.md trivial: update markdown for pre-commit style 2021-07-18 14:42:47 -05:00

README.md

NVMe

Introduction

This plugin adds support for NVMe storage hardware. Devices are enumerated from the Identify Controller data structure and can be updated with appropriate firmware file. Firmware is sent in 4kB chunks and activated on next reboot.

The device GUID is read from the vendor specific area and if not found then generated from the trimmed model string.

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in an unspecified binary file format.

This plugin supports the following protocol ID:

  • org.nvmexpress

GUID Generation

These device use the NVMe DeviceInstanceId values, e.g.

  • NVME\VEN_1179&DEV_010F&REV_01
  • NVME\VEN_1179&DEV_010F
  • NVME\VEN_1179

The FRU globally unique identifier (FGUID) is also added from the CNS if set. Please refer to this document for more details on how to add support for FGUID.

Additionally, for NVMe drives with Dell vendor firmware two extra GUIDs are added:

  • STORAGE-DELL-${component-id}

and any optional GUID saved in the vendor extension block.

Update Behavior

The firmware is deployed when the device is in normal runtime mode, but it is only activated when the system is either restarted or in some cases shutdown.

Quirk Use

This plugin uses the following plugin-specific quirks:

NvmeBlockSize

The block size used for NVMe writes

Since: 1.1.3

Flags

  • force-align if image should be padded, since 1.2.4

Vendor ID Security

The vendor ID is set from the udev vendor, for example set to NVME:0x1179

External Interface Access

This plugin requires ioctl NVME_IOCTL_ADMIN_CMD access.