Skip to contentSkip to conversation

nvme: update firmware version after commit

PATCH Applied Daniel Wagner 4 participants 11 messages Oct 30, 2023 – Nov 7, 2023 NVMe

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 nvme: update firmware version after commit

The firmware version sysfs entry needs to be updated after a successfully firmware activation.

nvme-cli stopped issuing an Identify Controller command to list the current firmware information and relies on sysfs showing the current firmware version.

---

Only compile tested. Asked for testing.

changes:

v3:
- use afi variable directly, no _to_cpu helper
- fix bit mask size

v2:
- use fw slot info instead issuing another identify controller command
- https://lore.kernel.org/linux-nvme/[email protected]

v1:
- initial version
- https://lore.kernel.org/linux-nvme/[email protected]/

 drivers/nvme/host/core.c | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)
drivers/nvme/host/core.c +14 -1
index 37b6fa746662..e8511bff78d2 100644
@@ -4053,8 +4053,21 @@ static void nvme_get_fw_slot_info(struct nvme_ctrl *ctrl)
 		return;
 
 	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, NVME_CSI_NVM,
-			log, sizeof(*log), 0))
+			 log, sizeof(*log), 0)) {
 		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
+		goto out_free_log;
+	}
+
+	if (log->afi & 0x70) {
+		dev_info(ctrl->device,
+			 "Firmware is activated after next Controller Level Reset\n");
+		goto out_free_log;
+	}
+
+	memcpy(ctrl->subsys->firmware_rev, &log->frs[log->afi & 0x7],
+		sizeof(ctrl->subsys->firmware_rev));
+
+out_free_log:
 	kfree(log);
 }
 
Signature · 1 line
2.42.0
Reviewed-by on v3 1/1
#2 lore raw
In reply to Daniel Wagner
Quoted 61 lines · Daniel Wagner

The firmware version sysfs entry needs to be updated after a successfully firmware activation.

nvme-cli stopped issuing an Identify Controller command to list the current firmware information and relies on sysfs showing the current firmware version.

---

Only compile tested. Asked for testing.

changes:

v3:
- use afi variable directly, no _to_cpu helper
- fix bit mask size

v2:
- use fw slot info instead issuing another identify controller command
- https://lore.kernel.org/linux-nvme/[email protected]

v1:
- initial version
- https://lore.kernel.org/linux-nvme/[email protected]/

 drivers/nvme/host/core.c | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)
drivers/nvme/host/core.c +14 -1
index 37b6fa746662..e8511bff78d2 100644
@@ -4053,8 +4053,21 @@ static void nvme_get_fw_slot_info(struct nvme_ctrl *ctrl)
 		return;
 
 	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, NVME_CSI_NVM,
-			log, sizeof(*log), 0))
+			 log, sizeof(*log), 0)) {
 		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
+		goto out_free_log;
+	}
+
+	if (log->afi & 0x70) {
+		dev_info(ctrl->device,
+			 "Firmware is activated after next Controller Level Reset\n");
+		goto out_free_log;
+	}
+
+	memcpy(ctrl->subsys->firmware_rev, &log->frs[log->afi & 0x7],
+		sizeof(ctrl->subsys->firmware_rev));
+
+out_free_log:
 	kfree(log);
 }
 
Signature · 1 line
2.42.0
author Tested-by Kenji Tomonaga on v3 1/1
#3 lore raw
In reply to Daniel Wagner
Quoted 9 lines · Daniel Wagner

The firmware version sysfs entry needs to be updated after a successfully firmware activation.

nvme-cli stopped issuing an Identify Controller command to list the current firmware information and relies on sysfs showing the current firmware version.

Unfortunately, Kenji is not able to post on the mailing list, so here his tag:

#5 lore raw
Quoted 4 lines · Keith Busch
Quoted 3 lines · Daniel Wagner

The firmware version sysfs entry needs to be updated after a successfully firmware activation.

Quoted 8 lines
Quoted 6 lines

nvme-cli stopped issuing an Identify Controller command to list the current firmware information and relies on sysfs showing the current firmware version.

Thanks, applied for nvme-6.7.

I've got negative feedback from one of our customer. I've annotate the code with

	dev_info(ctrl->device, "afi: %#x\n", log->afi);
	for (i = 0; i < 7; i++) {
		dev_info(ctrl->device, "frs%d: %.*s\n", i + 1,
			 nvme_strlen((char *)&log->frs[i], sizeof(ctrl->subsys->firmware_rev)),
			 (char *)&log->frs[i]);
	}
[  124.824812] nvme nvme8: afi: 0x3
[  124.824824] nvme nvme8: frs1: 0.4.0
[  124.824828] nvme nvme8: frs2: 0.3.0
[  124.824832] nvme nvme8: frs3: 0.4.0
[  124.824835] nvme nvme8: frs4:
[  124.824837] nvme nvme8: frs5:
[  124.824840] nvme nvme8: frs6:
[  124.824842] nvme nvme8: frs7:

This particular firmware seem to interpret afi one based, while the this patch assumes it is zero based

	memcpy(ctrl->subsys->firmware_rev, &log->frs[log->afi & 0x7],
		sizeof(ctrl->subsys->firmware_rev));

The spec says

Active Firmware Info (AFI): Specifies information about the active
firmware revision.

Bit 7 is reserved.
Bits 6:4 indicates the firmware slot that is going to be activated
at the next Controller Level Reset. If this field is 0h, then the controller does not indicate the firmware slot that is going to be activated at the next Controller Level Reset.
Bit 3 is reserved.
Bits 2:0 indicates the firmware slot from which the actively running
firmware revision was loaded.

It's not clear to me if afi bits 2:0 is zero or one based. Bits 6:4 indicate to be 1 based.

Any ideas how to handle this?

Thanks,
Daniel

#6 lore raw
Quoted 16 lines · Daniel Wagner

This particular firmware seem to interpret afi one based, while the this patch assumes it is zero based

Active Firmware Info (AFI): Specifies information about the active
firmware revision.

Bit 7 is reserved.
Bits 6:4 indicates the firmware slot that is going to be activated
at the next Controller Level Reset. If this field is 0h, then the controller does not indicate the firmware slot that is going to be activated at the next Controller Level Reset.
Bit 3 is reserved.
Bits 2:0 indicates the firmware slot from which the actively running
firmware revision was loaded.

Quoted 2 lines

It's not clear to me if afi bits 2:0 is zero or one based. Bits 6:4 indicate to be 1 based.

All 0's based (what a stupid term..) fields in NVMe are explicitly marked as such. And even if that wasn't the case I'd very much expect the same encoding for the two sub-fields.

maintainer
#7 lore raw
Quoted 17 lines · Christoph Hellwig
Quoted 16 lines · Daniel Wagner

This particular firmware seem to interpret afi one based, while the this patch assumes it is zero based

Active Firmware Info (AFI): Specifies information about the active
firmware revision.

Bit 7 is reserved.
Bits 6:4 indicates the firmware slot that is going to be activated
at the next Controller Level Reset. If this field is 0h, then the controller does not indicate the firmware slot that is going to be activated at the next Controller Level Reset.
Bit 3 is reserved.
Bits 2:0 indicates the firmware slot from which the actively running
firmware revision was loaded.

Quoted 6 lines
Quoted 2 lines

It's not clear to me if afi bits 2:0 is zero or one based. Bits 6:4 indicate to be 1 based.

All 0's based (what a stupid term..) fields in NVMe are explicitly marked as such. And even if that wasn't the case I'd very much expect the same encoding for the two sub-fields.

Yeah, it's just the firmware slot number, taken literally. AFI = 1 means slot 1, AFI = 2 means slot 2, etc... Slot 0 either has special meaning (firmware commit SF field, or fw log AFI bits 6:4), or is reserved value, like in Identify Controller FRMW.NOFS, and has no place in the FW Slot Info log page.

Our first slot in the log page is defined as slot one, so we have to subtract one from the AFI field to index into the slot array. I messed up for not catching that earlier, but thanks for pointing it out now.

#8 lore raw
Quoted 10 lines · Keith Busch
Quoted 3 lines

All 0's based (what a stupid term..) fields in NVMe are explicitly marked as such. And even if that wasn't the case I'd very much expect the same encoding for the two sub-fields.

Yeah, it's just the firmware slot number, taken literally. AFI = 1 means slot 1, AFI = 2 means slot 2, etc... Slot 0 either has special meaning (firmware commit SF field, or fw log AFI bits 6:4), or is reserved value, like in Identify Controller FRMW.NOFS, and has no place in the FW Slot Info log page.

Quoted 3 lines

Our first slot in the log page is defined as slot one, so we have to subtract one from the AFI field to index into the slot array. I messed up for not catching that earlier, but thanks for pointing it out now.

Thanks for the clarification.

Do you want me to send a follow up patch, a new version of this one or do you fix up yourself?

maintainer
#9 lore raw
Quoted 11 lines · Daniel Wagner
Quoted 10 lines · Keith Busch
Quoted 3 lines

All 0's based (what a stupid term..) fields in NVMe are explicitly marked as such. And even if that wasn't the case I'd very much expect the same encoding for the two sub-fields.

Yeah, it's just the firmware slot number, taken literally. AFI = 1 means slot 1, AFI = 2 means slot 2, etc... Slot 0 either has special meaning (firmware commit SF field, or fw log AFI bits 6:4), or is reserved value, like in Identify Controller FRMW.NOFS, and has no place in the FW Slot Info log page.

Quoted 8 lines
Quoted 3 lines

Our first slot in the log page is defined as slot one, so we have to subtract one from the AFI field to index into the slot array. I messed up for not catching that earlier, but thanks for pointing it out now.

Thanks for the clarification.

Do you want me to send a follow up patch, a new version of this one or do you fix up yourself?

Fixed up inline when applying the original patch. Let me know if you have any concerns with the result, currently here:

https://git.infradead.org/nvme.git/commitdiff/983a338b96c8a25b81e773b643f80634358e81bc