fwupd/plugins/nvme/README.md
Richard Hughes 078beafb2d Add a new internal flag to opt-in to GUID matching
It is far too easy to forget to set FWUPD_DEVICE_FLAG_NO_GUID_MATCHING for new
plugins, and without it it all works really well *until* a user has two devices
of the same type installed at the same time and then one 'disappears' for hard
to explain reasons. Typically we only need it for replug anyway!

Explicitly opt-in to this rarely-required behaviour, with the default to just
use the physical and logical IDs. Also document the update behavior for each
plugin to explain why the flag is being used.

This allows you to have two identical Unifying plugged in without one of them
being hidden from the user, at the same time allowing a HIDRAW<->USB transition
when going to and from bootloader and runtime modes.

This removes the workaround added in 99eb3f06b6.

Fixes https://github.com/fwupd/fwupd/issues/2915
2021-02-25 15:47:25 +00:00

2.0 KiB

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.