fwupd/plugins/nvme
Richard Hughes 56ac823af9 Set the protocol per-device not per-plugin
Some plugins have devices with more than one protocol. Logically the protocol
belongs to the device, not the plugin, and in the future we could use this to
further check firmware that's about to be deployed.

This is also not exported into libfwupd (yet?) as it's remains a debug-feature
only -- protocols are not actually required for devices to be added.
2019-11-25 18:01:54 +00:00
..
tests nvme: Add a new plugin to update NVMe hardware 2018-08-26 19:42:28 +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 Set the protocol per-device not per-plugin 2019-11-25 18:01:54 +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 Set the protocol per-device not per-plugin 2019-11-25 18:01:54 +00:00
fu-self-test.c Defer the InstanceID->GUID hashing until after setup 2019-02-06 08:02:16 +00:00
meson.build Do not use efivar just to print a mixed endian GUID 2019-02-04 15:19:57 +00:00
nvme.quirk Set all FuUdevDevice plugins to use FU_QUIRKS_PLUGIN 2019-10-09 20:02:16 +01:00
README.md trivial: Add the missing protocol IDs to the plugin READMEs 2019-01-29 22:28:09 +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.

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