1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 2010 Broadcom Corporation.
9 #include <linux/delay.h>
10 #include <linux/export.h>
11 #include <linux/sched/signal.h>
14 /* VPD access through PCI 2.2+ VPD capability */
17 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
18 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
19 int (*set_size)(struct pci_dev *dev, size_t len);
23 const struct pci_vpd_ops *ops;
24 struct bin_attribute *attr; /* Descriptor for sysfs VPD entry */
34 * pci_read_vpd - Read one entry from Vital Product Data
35 * @dev: pci device struct
36 * @pos: offset in vpd space
37 * @count: number of bytes to read
38 * @buf: pointer to where to store result
40 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf)
42 if (!dev->vpd || !dev->vpd->ops)
44 return dev->vpd->ops->read(dev, pos, count, buf);
46 EXPORT_SYMBOL(pci_read_vpd);
49 * pci_write_vpd - Write entry to Vital Product Data
50 * @dev: pci device struct
51 * @pos: offset in vpd space
52 * @count: number of bytes to write
53 * @buf: buffer containing write data
55 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf)
57 if (!dev->vpd || !dev->vpd->ops)
59 return dev->vpd->ops->write(dev, pos, count, buf);
61 EXPORT_SYMBOL(pci_write_vpd);
64 * pci_set_vpd_size - Set size of Vital Product Data space
65 * @dev: pci device struct
66 * @len: size of vpd space
68 int pci_set_vpd_size(struct pci_dev *dev, size_t len)
70 if (!dev->vpd || !dev->vpd->ops)
72 return dev->vpd->ops->set_size(dev, len);
74 EXPORT_SYMBOL(pci_set_vpd_size);
76 #define PCI_VPD_MAX_SIZE (PCI_VPD_ADDR_MASK + 1)
79 * pci_vpd_size - determine actual size of Vital Product Data
80 * @dev: pci device struct
81 * @old_size: current assumed size, also maximum allowed size
83 static size_t pci_vpd_size(struct pci_dev *dev, size_t old_size)
86 unsigned char header[1+2]; /* 1 byte tag, 2 bytes length */
88 while (off < old_size &&
89 pci_read_vpd(dev, off, 1, header) == 1) {
92 if (header[0] & PCI_VPD_LRDT) {
93 /* Large Resource Data Type Tag */
94 tag = pci_vpd_lrdt_tag(header);
95 /* Only read length from known tag items */
96 if ((tag == PCI_VPD_LTIN_ID_STRING) ||
97 (tag == PCI_VPD_LTIN_RO_DATA) ||
98 (tag == PCI_VPD_LTIN_RW_DATA)) {
99 if (pci_read_vpd(dev, off+1, 2,
101 pci_warn(dev, "invalid large VPD tag %02x size at offset %zu",
105 off += PCI_VPD_LRDT_TAG_SIZE +
106 pci_vpd_lrdt_size(header);
109 /* Short Resource Data Type Tag */
110 off += PCI_VPD_SRDT_TAG_SIZE +
111 pci_vpd_srdt_size(header);
112 tag = pci_vpd_srdt_tag(header);
115 if (tag == PCI_VPD_STIN_END) /* End tag descriptor */
118 if ((tag != PCI_VPD_LTIN_ID_STRING) &&
119 (tag != PCI_VPD_LTIN_RO_DATA) &&
120 (tag != PCI_VPD_LTIN_RW_DATA)) {
121 pci_warn(dev, "invalid %s VPD tag %02x at offset %zu",
122 (header[0] & PCI_VPD_LRDT) ? "large" : "short",
131 * Wait for last operation to complete.
132 * This code has to spin since there is no other notification from the PCI
133 * hardware. Since the VPD is often implemented by serial attachment to an
134 * EEPROM, it may take many milliseconds to complete.
136 * Returns 0 on success, negative values indicate error.
138 static int pci_vpd_wait(struct pci_dev *dev)
140 struct pci_vpd *vpd = dev->vpd;
141 unsigned long timeout = jiffies + msecs_to_jiffies(125);
142 unsigned long max_sleep = 16;
149 while (time_before(jiffies, timeout)) {
150 ret = pci_user_read_config_word(dev, vpd->cap + PCI_VPD_ADDR,
155 if ((status & PCI_VPD_ADDR_F) == vpd->flag) {
160 if (fatal_signal_pending(current))
163 usleep_range(10, max_sleep);
164 if (max_sleep < 1024)
168 pci_warn(dev, "VPD access failed. This is likely a firmware bug on this device. Contact the card vendor for a firmware update\n");
172 static ssize_t pci_vpd_read(struct pci_dev *dev, loff_t pos, size_t count,
175 struct pci_vpd *vpd = dev->vpd;
177 loff_t end = pos + count;
185 vpd->len = pci_vpd_size(dev, vpd->len);
194 if (end > vpd->len) {
199 if (mutex_lock_killable(&vpd->lock))
202 ret = pci_vpd_wait(dev);
208 unsigned int i, skip;
210 ret = pci_user_write_config_word(dev, vpd->cap + PCI_VPD_ADDR,
215 vpd->flag = PCI_VPD_ADDR_F;
216 ret = pci_vpd_wait(dev);
220 ret = pci_user_read_config_dword(dev, vpd->cap + PCI_VPD_DATA, &val);
225 for (i = 0; i < sizeof(u32); i++) {
235 mutex_unlock(&vpd->lock);
236 return ret ? ret : count;
239 static ssize_t pci_vpd_write(struct pci_dev *dev, loff_t pos, size_t count,
242 struct pci_vpd *vpd = dev->vpd;
244 loff_t end = pos + count;
247 if (pos < 0 || (pos & 3) || (count & 3))
252 vpd->len = pci_vpd_size(dev, vpd->len);
261 if (mutex_lock_killable(&vpd->lock))
264 ret = pci_vpd_wait(dev);
276 ret = pci_user_write_config_dword(dev, vpd->cap + PCI_VPD_DATA, val);
279 ret = pci_user_write_config_word(dev, vpd->cap + PCI_VPD_ADDR,
280 pos | PCI_VPD_ADDR_F);
286 ret = pci_vpd_wait(dev);
293 mutex_unlock(&vpd->lock);
294 return ret ? ret : count;
297 static int pci_vpd_set_size(struct pci_dev *dev, size_t len)
299 struct pci_vpd *vpd = dev->vpd;
301 if (len == 0 || len > PCI_VPD_MAX_SIZE)
310 static const struct pci_vpd_ops pci_vpd_ops = {
311 .read = pci_vpd_read,
312 .write = pci_vpd_write,
313 .set_size = pci_vpd_set_size,
316 static ssize_t pci_vpd_f0_read(struct pci_dev *dev, loff_t pos, size_t count,
319 struct pci_dev *tdev = pci_get_slot(dev->bus,
320 PCI_DEVFN(PCI_SLOT(dev->devfn), 0));
326 ret = pci_read_vpd(tdev, pos, count, arg);
331 static ssize_t pci_vpd_f0_write(struct pci_dev *dev, loff_t pos, size_t count,
334 struct pci_dev *tdev = pci_get_slot(dev->bus,
335 PCI_DEVFN(PCI_SLOT(dev->devfn), 0));
341 ret = pci_write_vpd(tdev, pos, count, arg);
346 static int pci_vpd_f0_set_size(struct pci_dev *dev, size_t len)
348 struct pci_dev *tdev = pci_get_slot(dev->bus,
349 PCI_DEVFN(PCI_SLOT(dev->devfn), 0));
355 ret = pci_set_vpd_size(tdev, len);
360 static const struct pci_vpd_ops pci_vpd_f0_ops = {
361 .read = pci_vpd_f0_read,
362 .write = pci_vpd_f0_write,
363 .set_size = pci_vpd_f0_set_size,
366 int pci_vpd_init(struct pci_dev *dev)
371 cap = pci_find_capability(dev, PCI_CAP_ID_VPD);
375 vpd = kzalloc(sizeof(*vpd), GFP_ATOMIC);
379 vpd->len = PCI_VPD_MAX_SIZE;
380 if (dev->dev_flags & PCI_DEV_FLAGS_VPD_REF_F0)
381 vpd->ops = &pci_vpd_f0_ops;
383 vpd->ops = &pci_vpd_ops;
384 mutex_init(&vpd->lock);
392 void pci_vpd_release(struct pci_dev *dev)
397 static ssize_t read_vpd_attr(struct file *filp, struct kobject *kobj,
398 struct bin_attribute *bin_attr, char *buf,
399 loff_t off, size_t count)
401 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
403 if (bin_attr->size > 0) {
404 if (off > bin_attr->size)
406 else if (count > bin_attr->size - off)
407 count = bin_attr->size - off;
410 return pci_read_vpd(dev, off, count, buf);
413 static ssize_t write_vpd_attr(struct file *filp, struct kobject *kobj,
414 struct bin_attribute *bin_attr, char *buf,
415 loff_t off, size_t count)
417 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
419 if (bin_attr->size > 0) {
420 if (off > bin_attr->size)
422 else if (count > bin_attr->size - off)
423 count = bin_attr->size - off;
426 return pci_write_vpd(dev, off, count, buf);
429 void pcie_vpd_create_sysfs_dev_files(struct pci_dev *dev)
432 struct bin_attribute *attr;
437 attr = kzalloc(sizeof(*attr), GFP_ATOMIC);
441 sysfs_bin_attr_init(attr);
443 attr->attr.name = "vpd";
444 attr->attr.mode = S_IRUSR | S_IWUSR;
445 attr->read = read_vpd_attr;
446 attr->write = write_vpd_attr;
447 retval = sysfs_create_bin_file(&dev->dev.kobj, attr);
453 dev->vpd->attr = attr;
456 void pcie_vpd_remove_sysfs_dev_files(struct pci_dev *dev)
458 if (dev->vpd && dev->vpd->attr) {
459 sysfs_remove_bin_file(&dev->dev.kobj, dev->vpd->attr);
460 kfree(dev->vpd->attr);
464 int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt)
468 for (i = off; i < len; ) {
471 if (val & PCI_VPD_LRDT) {
472 /* Don't return success of the tag isn't complete */
473 if (i + PCI_VPD_LRDT_TAG_SIZE > len)
479 i += PCI_VPD_LRDT_TAG_SIZE +
480 pci_vpd_lrdt_size(&buf[i]);
482 u8 tag = val & ~PCI_VPD_SRDT_LEN_MASK;
487 if (tag == PCI_VPD_SRDT_END)
490 i += PCI_VPD_SRDT_TAG_SIZE +
491 pci_vpd_srdt_size(&buf[i]);
497 EXPORT_SYMBOL_GPL(pci_vpd_find_tag);
499 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
500 unsigned int len, const char *kw)
504 for (i = off; i + PCI_VPD_INFO_FLD_HDR_SIZE <= off + len;) {
505 if (buf[i + 0] == kw[0] &&
509 i += PCI_VPD_INFO_FLD_HDR_SIZE +
510 pci_vpd_info_field_size(&buf[i]);
515 EXPORT_SYMBOL_GPL(pci_vpd_find_info_keyword);
517 #ifdef CONFIG_PCI_QUIRKS
519 * Quirk non-zero PCI functions to route VPD access through function 0 for
520 * devices that share VPD resources between functions. The functions are
521 * expected to be identical devices.
523 static void quirk_f0_vpd_link(struct pci_dev *dev)
527 if (!PCI_FUNC(dev->devfn))
530 f0 = pci_get_slot(dev->bus, PCI_DEVFN(PCI_SLOT(dev->devfn), 0));
534 if (f0->vpd && dev->class == f0->class &&
535 dev->vendor == f0->vendor && dev->device == f0->device)
536 dev->dev_flags |= PCI_DEV_FLAGS_VPD_REF_F0;
540 DECLARE_PCI_FIXUP_CLASS_EARLY(PCI_VENDOR_ID_INTEL, PCI_ANY_ID,
541 PCI_CLASS_NETWORK_ETHERNET, 8, quirk_f0_vpd_link);
544 * If a device follows the VPD format spec, the PCI core will not read or
545 * write past the VPD End Tag. But some vendors do not follow the VPD
546 * format spec, so we can't tell how much data is safe to access. Devices
547 * may behave unpredictably if we access too much. Blacklist these devices
548 * so we don't touch VPD at all.
550 static void quirk_blacklist_vpd(struct pci_dev *dev)
554 pci_warn(dev, FW_BUG "disabling VPD access (can't determine size of non-standard VPD format)\n");
557 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x0060, quirk_blacklist_vpd);
558 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x007c, quirk_blacklist_vpd);
559 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x0413, quirk_blacklist_vpd);
560 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x0078, quirk_blacklist_vpd);
561 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x0079, quirk_blacklist_vpd);
562 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x0073, quirk_blacklist_vpd);
563 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x0071, quirk_blacklist_vpd);
564 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x005b, quirk_blacklist_vpd);
565 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x002f, quirk_blacklist_vpd);
566 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x005d, quirk_blacklist_vpd);
567 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_LSI_LOGIC, 0x005f, quirk_blacklist_vpd);
568 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_ATTANSIC, PCI_ANY_ID,
569 quirk_blacklist_vpd);
570 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_QLOGIC, 0x2261, quirk_blacklist_vpd);
573 * For Broadcom 5706, 5708, 5709 rev. A nics, any read beyond the
574 * VPD end tag will hang the device. This problem was initially
575 * observed when a vpd entry was created in sysfs
576 * ('/sys/bus/pci/devices/<id>/vpd'). A read to this sysfs entry
577 * will dump 32k of data. Reading a full 32k will cause an access
578 * beyond the VPD end tag causing the device to hang. Once the device
579 * is hung, the bnx2 driver will not be able to reset the device.
580 * We believe that it is legal to read beyond the end tag and
581 * therefore the solution is to limit the read/write length.
583 static void quirk_brcm_570x_limit_vpd(struct pci_dev *dev)
586 * Only disable the VPD capability for 5706, 5706S, 5708,
587 * 5708S and 5709 rev. A
589 if ((dev->device == PCI_DEVICE_ID_NX2_5706) ||
590 (dev->device == PCI_DEVICE_ID_NX2_5706S) ||
591 (dev->device == PCI_DEVICE_ID_NX2_5708) ||
592 (dev->device == PCI_DEVICE_ID_NX2_5708S) ||
593 ((dev->device == PCI_DEVICE_ID_NX2_5709) &&
594 (dev->revision & 0xf0) == 0x0)) {
596 dev->vpd->len = 0x80;
599 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_BROADCOM,
600 PCI_DEVICE_ID_NX2_5706,
601 quirk_brcm_570x_limit_vpd);
602 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_BROADCOM,
603 PCI_DEVICE_ID_NX2_5706S,
604 quirk_brcm_570x_limit_vpd);
605 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_BROADCOM,
606 PCI_DEVICE_ID_NX2_5708,
607 quirk_brcm_570x_limit_vpd);
608 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_BROADCOM,
609 PCI_DEVICE_ID_NX2_5708S,
610 quirk_brcm_570x_limit_vpd);
611 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_BROADCOM,
612 PCI_DEVICE_ID_NX2_5709,
613 quirk_brcm_570x_limit_vpd);
614 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_BROADCOM,
615 PCI_DEVICE_ID_NX2_5709S,
616 quirk_brcm_570x_limit_vpd);
618 static void quirk_chelsio_extend_vpd(struct pci_dev *dev)
620 pci_set_vpd_size(dev, 8192);
622 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x20, quirk_chelsio_extend_vpd);
623 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x21, quirk_chelsio_extend_vpd);
624 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x22, quirk_chelsio_extend_vpd);
625 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x23, quirk_chelsio_extend_vpd);
626 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x24, quirk_chelsio_extend_vpd);
627 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x25, quirk_chelsio_extend_vpd);
628 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x26, quirk_chelsio_extend_vpd);
629 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x30, quirk_chelsio_extend_vpd);
630 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x31, quirk_chelsio_extend_vpd);
631 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x32, quirk_chelsio_extend_vpd);
632 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x35, quirk_chelsio_extend_vpd);
633 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x36, quirk_chelsio_extend_vpd);
634 DECLARE_PCI_FIXUP_FINAL(PCI_VENDOR_ID_CHELSIO, 0x37, quirk_chelsio_extend_vpd);