linux-pci.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH pci-next v2 0/1] PCI/sysfs: Expose PCIe device serial number
@ 2025-07-16  4:53 Matthew Wood
  2025-07-16  4:53 ` [PATCH pci-next v2 1/1] " Matthew Wood
  0 siblings, 1 reply; 3+ messages in thread
From: Matthew Wood @ 2025-07-16  4:53 UTC (permalink / raw)
  To: Bjorn Helgaas, Jonathan Cameron; +Cc: linux-pci, linux-kernel

Add a single sysfs read-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:cc:00.0/device_serial_number
    00-80-ee-00-00-00-41-80

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

Comparing serial number format to lspci output:

    sudo lspci -vvv -s cc:00.0
        cc: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

 drivers/pci/pci-sysfs.c | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

-- 
2.50.0


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH pci-next v2 1/1] PCI/sysfs: Expose PCIe device serial number
  2025-07-16  4:53 [PATCH pci-next v2 0/1] PCI/sysfs: Expose PCIe device serial number Matthew Wood
@ 2025-07-16  4:53 ` Matthew Wood
  2025-07-16  5:22   ` Thomas Weißschuh
  0 siblings, 1 reply; 3+ messages in thread
From: Matthew Wood @ 2025-07-16  4:53 UTC (permalink / raw)
  To: Jonathan Cameron, Bjorn Helgaas; +Cc: linux-pci, linux-kernel

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.

Signed-off-by: Matthew Wood <thepacketgeek@gmail.com>
---
 drivers/pci/pci-sysfs.c | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/drivers/pci/pci-sysfs.c b/drivers/pci/pci-sysfs.c
index 268c69daa4d5..d59756bc91c9 100644
--- a/drivers/pci/pci-sysfs.c
+++ b/drivers/pci/pci-sysfs.c
@@ -239,6 +239,22 @@ static ssize_t current_link_width_show(struct device *dev,
 }
 static DEVICE_ATTR_RO(current_link_width);
 
+static ssize_t device_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 -EINVAL;
+
+	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_RO(device_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_device_serial_number.attr,
 	NULL,
 };
 
@@ -1749,8 +1766,12 @@ 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))
+	if (pci_is_pcie(pdev)) {
+		if (strncmp(a->name, "device_serial_number", 20) == 0 &&
+			!pci_get_dsn(pdev))
+			return 0;
 		return a->mode;
+	}
 
 	return 0;
 }
-- 
2.50.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH pci-next v2 1/1] PCI/sysfs: Expose PCIe device serial number
  2025-07-16  4:53 ` [PATCH pci-next v2 1/1] " Matthew Wood
@ 2025-07-16  5:22   ` Thomas Weißschuh
  0 siblings, 0 replies; 3+ messages in thread
From: Thomas Weißschuh @ 2025-07-16  5:22 UTC (permalink / raw)
  To: Matthew Wood; +Cc: Jonathan Cameron, Bjorn Helgaas, linux-pci, linux-kernel

On Tue, Jul 15, 2025 at 09:53:22PM -0700, Matthew Wood wrote:
> 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.
> 
> Signed-off-by: Matthew Wood <thepacketgeek@gmail.com>
> ---
>  drivers/pci/pci-sysfs.c | 23 ++++++++++++++++++++++-
>  1 file changed, 22 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/pci/pci-sysfs.c b/drivers/pci/pci-sysfs.c
> index 268c69daa4d5..d59756bc91c9 100644
> --- a/drivers/pci/pci-sysfs.c
> +++ b/drivers/pci/pci-sysfs.c
> @@ -239,6 +239,22 @@ static ssize_t current_link_width_show(struct device *dev,
>  }
>  static DEVICE_ATTR_RO(current_link_width);
>  
> +static ssize_t device_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 -EINVAL;

-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_RO(device_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_device_serial_number.attr,
>  	NULL,
>  };
>  
> @@ -1749,8 +1766,12 @@ 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))
> +	if (pci_is_pcie(pdev)) {
> +		if (strncmp(a->name, "device_serial_number", 20) == 0 &&

Compare to the real 'struct attribute *' instead of the name.
You could restructure this a bit to be easier to read.

if (!pci_is_pcie(pdev))
	return 0;

if (a == &dev_addr_device_serial_number.attr && !pci_get_dns(pdev))
	return 0;

return a->mode;

> +			!pci_get_dsn(pdev))
> +			return 0;
>  		return a->mode;
> +	}

Also should have some docs in Documentation/ABI/testing/sysfs-bus-pci.

>  
>  	return 0;
>  }
> -- 
> 2.50.0
> 

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-07-16  5:22 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-07-16  4:53 [PATCH pci-next v2 0/1] PCI/sysfs: Expose PCIe device serial number Matthew Wood
2025-07-16  4:53 ` [PATCH pci-next v2 1/1] " Matthew Wood
2025-07-16  5:22   ` Thomas Weißschuh

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).