fwupd/plugins/nvme
Richard Hughes b3f9841924 Support more than one protocol for a given device
Devices may want to support more than one protocol, and for some devices
(e.g. Unifying peripherals stuck in bootloader mode) you might not even be able
to query for the correct protocol anyway.
2021-03-01 16:14:36 +00: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 Support more than one protocol for a given device 2021-03-01 16:14:36 +00:00
fu-nvme-device.h trivial: Remove G_BEGIN_DECLS from all private headers 2019-10-09 20:02:16 +01:00
fu-plugin-nvme.c Use FWUPD_COMPILATION define to indicate an in tree build 2021-01-22 14:01:25 -06: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 Set all FuUdevDevice plugins to use FU_QUIRKS_PLUGIN 2019-10-09 20:02:16 +01:00
README.md Add a new internal flag to opt-in to GUID matching 2021-02-25 15:47:25 +00:00

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.