proxmox-mirrors/fwupd
1
0
Fork 0
mirror of https://git.proxmox.com/git/fwupd synced 2026-03-27 21:30:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
7b7d33554a
fwupd/plugins/nvme
History
Richard Hughes aaa77c6f51 Allow adding and removing custom flags on devices 
The CustomFlags feature is a bit of a hack where we just join the flags
and store in the device metadata section as a string. This makes it
inefficient to check if just one flag exists as we have to split the
string to a temporary array each time.

Rather than adding to the hack by splitting, appending (if not exists)
then joining again, store the flags in the plugin privdata directly.

This allows us to support negating custom properties (e.g. ~hint) and
also allows quirks to append custom values without duplicating them on
each GUID match, e.g.

[USB\VID_17EF&PID_307F]
Plugin = customflag1
[USB\VID_17EF&PID_307F&HUB_0002]
Flags = customflag2

...would result in customflag1,customflag2 which is the same as you'd
get from an enumerated device flag doing the same thing.
2021-06-23 07:59:15 +01:00
..
fu-nvme-common.c nvme: Check the return code of the admin passthru ioctl 2019-01-15 16:26:30 +00:00
fu-nvme-common.h trivial: Remove G_BEGIN_DECLS from all private headers 2019-10-09 20:02:16 +01:00
fu-nvme-device.c Allow adding and removing custom flags on devices 2021-06-23 07:59:15 +01:00
fu-nvme-device.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-plugin-nvme.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-self-test.c Install the installed tests 2020-08-28 10:10:43 -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 Add a new internal flag to opt-in to GUID matching 2021-02-25 15:47:25 +00: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: https://nvmexpress.org/wp-content/uploads/NVM_Express_Revision_1.3.pdf

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:

Quirk Description Minimum fwupd version
NvmeBlockSize The block size used for NVMe writes 1.1.3
Flags force-align if image should be padded 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.