Skip to contentSkip to conversation

PCI/sysfs: Expose PCIe device serial number

PATCH Superseded Matthew Wood 2 participants 4 messages Jul 17, 2025 PCI

v4 of 8 Superseded Latest is v8 →

lore
Share & tools
lore
#0 lore raw

v4 cover PCI/sysfs: Expose PCIe device serial number

Add a single sysfs read-only, admin-only interface for reading PCIe device serial numbers from userspace, using the same hexadecimal 1-byte dashed formatting as lspci serial number capability output:

    more /sys/devices/pci0000:c0/0000:c0:01.1/0000:c1:00.0/0000:c2:1f.0/0000:ef:00.0/serial_number
    00-80-ee-00-00-00-41-80

If a device doesn't support the serial number capability, the serial_number sysfs attribute will not be visible.

Comparing serial number format to lspci output:

    sudo lspci -vvv -s ef:00.0
        ef:00.0 Serial Attached SCSI controller: Broadcom / LSI PCIe Switch management endpoint (rev b0)
            Subsystem: Broadcom / LSI Device 0144
            ...
            Capabilities: [100 v1] Device Serial Number 00-80-ee-00-00-00-41-80
            ...

This PCIe device sysfs attribute eliminates the need for parsing lspci output (e.g. regexp) for userspace applications that utilize serial numbers.

Matthew Wood (1):
PCI/sysfs: Expose PCIe device serial number

 Documentation/ABI/testing/sysfs-bus-pci |  9 +++++++++
 drivers/pci/pci-sysfs.c                 | 26 ++++++++++++++++++++++---
 2 files changed, 32 insertions(+), 3 deletions(-)
Signature · 1 line
2.50.0
#1 lore raw

PATCH v4 1/1 PCI/sysfs: Expose PCIe device serial number

Add a single sysfs read-only interface for reading PCIe device serial numbers from userspace in a programmatic way. This device attribute uses the same hexadecimal 1-byte dashed formatting as lspci serial number capability output. If a device doesn't support the serial number capability, the device_serial_number sysfs attribute will not be visible.

---
 Documentation/ABI/testing/sysfs-bus-pci |  9 +++++++++
 drivers/pci/pci-sysfs.c                 | 26 ++++++++++++++++++++++---
 2 files changed, 32 insertions(+), 3 deletions(-)
Documentation/ABI/testing/sysfs-bus-pci +9 -0
index 69f952fffec7..4da41471cc6b 100644
@@ -612,3 +612,12 @@ Description:
 
 		  # ls doe_features
 		  0001:01        0001:02        doe_discovery
+
+What:		/sys/bus/pci/devices/.../serial_number
+Date:		July 2025
+Contact:	Matthew Wood <[email protected]>
+Description:
+		This is visible only for PCIe devices that support the serial
+		number extended capability. The file is read only and due to
+		the possible sensitivity of accessible serial numbers, admin
+		only.
drivers/pci/pci-sysfs.c +23 -3
index 268c69daa4d5..bc0e0add15d1 100644
@@ -239,6 +239,22 @@ static ssize_t current_link_width_show(struct device *dev,
 }
 static DEVICE_ATTR_RO(current_link_width);
 
+static ssize_t serial_number_show(struct device *dev,
+				       struct device_attribute *attr, char *buf)
+{
+	struct pci_dev *pci_dev = to_pci_dev(dev);
+	u64 dsn;
+
+	dsn = pci_get_dsn(pci_dev);
+	if (!dsn)
+		return -EIO;
+
+	return sysfs_emit(buf, "%02llx-%02llx-%02llx-%02llx-%02llx-%02llx-%02llx-%02llx\n",
+		dsn >> 56, (dsn >> 48) & 0xff, (dsn >> 40) & 0xff, (dsn >> 32) & 0xff,
+		(dsn >> 24) & 0xff, (dsn >> 16) & 0xff, (dsn >> 8) & 0xff, dsn & 0xff);
+}
+static DEVICE_ATTR_ADMIN_RO(serial_number);
+
 static ssize_t secondary_bus_number_show(struct device *dev,
 					 struct device_attribute *attr,
 					 char *buf)
@@ -660,6 +676,7 @@ static struct attribute *pcie_dev_attrs[] = {
 	&dev_attr_current_link_width.attr,
 	&dev_attr_max_link_width.attr,
 	&dev_attr_max_link_speed.attr,
+	&dev_attr_serial_number.attr,
 	NULL,
 };
 
@@ -1749,10 +1766,13 @@ static umode_t pcie_dev_attrs_are_visible(struct kobject *kobj,
 	struct device *dev = kobj_to_dev(kobj);
 	struct pci_dev *pdev = to_pci_dev(dev);
 
-	if (pci_is_pcie(pdev))
-		return a->mode;
+	if (!pci_is_pcie(pdev))
+		return 0;
 
-	return 0;
+	if (a == &dev_attr_serial_number.attr && !pci_get_dsn(pdev))
+		return 0;
+
+	return a->mode;
 }
 
 static const struct attribute_group pci_dev_group = {
Signature · 1 line
2.50.0
Reviewed-by on v4 1/1
#2 lore raw
Quoted 5 lines · Matthew Wood

Add a single sysfs read-only interface for reading PCIe device serial numbers from userspace in a programmatic way. This device attribute uses the same hexadecimal 1-byte dashed formatting as lspci serial number capability output. If a device doesn't support the serial number capability, the device_serial_number sysfs attribute will not be visible.

You didn't update the commit message here for 'serial_number'.

Quoted 2 lines

With the commit and below comment fixed you can add this to your next spin.

Quoted 10 lines
---
  Documentation/ABI/testing/sysfs-bus-pci |  9 +++++++++
  drivers/pci/pci-sysfs.c                 | 26 ++++++++++++++++++++++---
  2 files changed, 32 insertions(+), 3 deletions(-)
Documentation/ABI/testing/sysfs-bus-pci +0 -0
index 69f952fffec7..4da41471cc6b 100644

Documentation/ABI/testing/sysfs-bus-pci Description: · line 617

Quoted 6 lines
Documentation/ABI/testing/sysfs-bus-pci +3 -0
@@ -612,3 +612,12 @@ Description:
 
  		  # ls doe_features
  		  0001:01        0001:02        doe_discovery
+
+What:		/sys/bus/pci/devices/.../serial_number
+Date:		July 2025

IIRC this should be the date that this is first introduced into the kernel. So if this is 6.17 material it should be October 2025 and if it's 6.18 material it should be December 2025.

It's getting close to the merge window so I'm not sure right now which Bjorn would prefer.

I would say make it October 2025 and if it slips it just gets updated for the next spin.

Quoted 58 lines
Documentation/ABI/testing/sysfs-bus-pci +6 -0
+Contact:	Matthew Wood <[email protected]>
+Description:
+		This is visible only for PCIe devices that support the serial
+		number extended capability. The file is read only and due to
+		the possible sensitivity of accessible serial numbers, admin
+		only.
drivers/pci/pci-sysfs.c +23 -3
index 268c69daa4d5..bc0e0add15d1 100644
@@ -239,6 +239,22 @@ static ssize_t current_link_width_show(struct device *dev,
  }
  static DEVICE_ATTR_RO(current_link_width);
 
+static ssize_t serial_number_show(struct device *dev,
+				       struct device_attribute *attr, char *buf)
+{
+	struct pci_dev *pci_dev = to_pci_dev(dev);
+	u64 dsn;
+
+	dsn = pci_get_dsn(pci_dev);
+	if (!dsn)
+		return -EIO;
+
+	return sysfs_emit(buf, "%02llx-%02llx-%02llx-%02llx-%02llx-%02llx-%02llx-%02llx\n",
+		dsn >> 56, (dsn >> 48) & 0xff, (dsn >> 40) & 0xff, (dsn >> 32) & 0xff,
+		(dsn >> 24) & 0xff, (dsn >> 16) & 0xff, (dsn >> 8) & 0xff, dsn & 0xff);
+}
+static DEVICE_ATTR_ADMIN_RO(serial_number);
+
  static ssize_t secondary_bus_number_show(struct device *dev,
  					 struct device_attribute *attr,
  					 char *buf)
@@ -660,6 +676,7 @@ static struct attribute *pcie_dev_attrs[] = {
  	&dev_attr_current_link_width.attr,
  	&dev_attr_max_link_width.attr,
  	&dev_attr_max_link_speed.attr,
+	&dev_attr_serial_number.attr,
  	NULL,
  };
 
@@ -1749,10 +1766,13 @@ static umode_t pcie_dev_attrs_are_visible(struct kobject *kobj,
  	struct device *dev = kobj_to_dev(kobj);
  	struct pci_dev *pdev = to_pci_dev(dev);
 
-	if (pci_is_pcie(pdev))
-		return a->mode;
+	if (!pci_is_pcie(pdev))
+		return 0;
 
-	return 0;
+	if (a == &dev_attr_serial_number.attr && !pci_get_dsn(pdev))
+		return 0;
+
+	return a->mode;
  }
 
  static const struct attribute_group pci_dev_group = {
#3 lore raw
Quoted 8 lines · Mario Limonciello
Quoted 5 lines · Matthew Wood

Add a single sysfs read-only interface for reading PCIe device serial numbers from userspace in a programmatic way. This device attribute uses the same hexadecimal 1-byte dashed formatting as lspci serial number capability output. If a device doesn't support the serial number capability, the device_serial_number sysfs attribute will not be visible.

Quoted 6 lines

You didn't update the commit message here for 'serial_number'.

Quoted 2 lines

With the commit and below comment fixed you can add this to your next spin.

Thank you Mario, I'll send out another v5 soon with these changes.

Quoted 88 lines
Quoted 10 lines
---
  Documentation/ABI/testing/sysfs-bus-pci |  9 +++++++++
  drivers/pci/pci-sysfs.c                 | 26 ++++++++++++++++++++++---
  2 files changed, 32 insertions(+), 3 deletions(-)
Documentation/ABI/testing/sysfs-bus-pci +0 -0
index 69f952fffec7..4da41471cc6b 100644

Documentation/ABI/testing/sysfs-bus-pci Description: · line 617

Quoted 6 lines
Documentation/ABI/testing/sysfs-bus-pci +3 -0
@@ -612,3 +612,12 @@ Description:
 
                # ls doe_features
                0001:01        0001:02        doe_discovery
+
+What:                /sys/bus/pci/devices/.../serial_number
+Date:                July 2025

IIRC this should be the date that this is first introduced into the kernel. So if this is 6.17 material it should be October 2025 and if it's 6.18 material it should be December 2025.

It's getting close to the merge window so I'm not sure right now which Bjorn would prefer.

I would say make it October 2025 and if it slips it just gets updated for the next spin.

Quoted 58 lines
Documentation/ABI/testing/sysfs-bus-pci +6 -0
+Contact:     Matthew Wood <[email protected]>
+Description:
+             This is visible only for PCIe devices that support the serial
+             number extended capability. The file is read only and due to
+             the possible sensitivity of accessible serial numbers, admin
+             only.
drivers/pci/pci-sysfs.c +23 -3
index 268c69daa4d5..bc0e0add15d1 100644
@@ -239,6 +239,22 @@ static ssize_t current_link_width_show(struct device *dev,
  }
  static DEVICE_ATTR_RO(current_link_width);
 
+static ssize_t serial_number_show(struct device *dev,
+                                    struct device_attribute *attr, char *buf)
+{
+     struct pci_dev *pci_dev = to_pci_dev(dev);
+     u64 dsn;
+
+     dsn = pci_get_dsn(pci_dev);
+     if (!dsn)
+             return -EIO;
+
+     return sysfs_emit(buf, "%02llx-%02llx-%02llx-%02llx-%02llx-%02llx-%02llx-%02llx\n",
+             dsn >> 56, (dsn >> 48) & 0xff, (dsn >> 40) & 0xff, (dsn >> 32) & 0xff,
+             (dsn >> 24) & 0xff, (dsn >> 16) & 0xff, (dsn >> 8) & 0xff, dsn & 0xff);
+}
+static DEVICE_ATTR_ADMIN_RO(serial_number);
+
  static ssize_t secondary_bus_number_show(struct device *dev,
                                       struct device_attribute *attr,
                                       char *buf)
@@ -660,6 +676,7 @@ static struct attribute *pcie_dev_attrs[] = {
      &dev_attr_current_link_width.attr,
      &dev_attr_max_link_width.attr,
      &dev_attr_max_link_speed.attr,
+     &dev_attr_serial_number.attr,
      NULL,
  };
 
@@ -1749,10 +1766,13 @@ static umode_t pcie_dev_attrs_are_visible(struct kobject *kobj,
      struct device *dev = kobj_to_dev(kobj);
      struct pci_dev *pdev = to_pci_dev(dev);
 
-     if (pci_is_pcie(pdev))
-             return a->mode;
+     if (!pci_is_pcie(pdev))
+             return 0;
 
-     return 0;
+     if (a == &dev_attr_serial_number.attr && !pci_get_dsn(pdev))
+             return 0;
+
+     return a->mode;
  }
 
  static const struct attribute_group pci_dev_group = {