drivers/pci/vpd.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * PCI VPD support
   4  *
   5  * Copyright (C) 2010 Broadcom Corporation.
   6  */
   7
   8 #include <linux/pci.h>
   9 #include <linux/delay.h>
  10 #include <linux/export.h>
  11 #include <linux/sched/signal.h>
  12 #include "pci.h"
  13
  14 /* VPD access through PCI 2.2+ VPD capability */
  15
  16 static struct pci_dev *pci_get_func0_dev(struct pci_dev *dev)
  17 {
  18         return pci_get_slot(dev->bus, PCI_DEVFN(PCI_SLOT(dev->devfn), 0));
  19 }
  20
  21 #define PCI_VPD_MAX_SIZE        (PCI_VPD_ADDR_MASK + 1)
  22 #define PCI_VPD_SZ_INVALID      UINT_MAX
  23
  24 /**
  25  * pci_vpd_size - determine actual size of Vital Product Data
  26  * @dev:        pci device struct
  27  */
  28 static size_t pci_vpd_size(struct pci_dev *dev)
  29 {
  30         size_t off = 0, size;
  31         unsigned char tag, header[1+2]; /* 1 byte tag, 2 bytes length */
  32
  33         /* Otherwise the following reads would fail. */
  34         dev->vpd.len = PCI_VPD_MAX_SIZE;
  35
  36         while (pci_read_vpd(dev, off, 1, header) == 1) {
  37                 size = 0;
  38
  39                 if (off == 0 && (header[0] == 0x00 || header[0] == 0xff))
  40                         goto error;
  41
  42                 if (header[0] & PCI_VPD_LRDT) {
  43                         /* Large Resource Data Type Tag */
  44                         if (pci_read_vpd(dev, off + 1, 2, &header[1]) != 2) {
  45                                 pci_warn(dev, "failed VPD read at offset %zu\n",
  46                                          off + 1);
  47                                 return off ?: PCI_VPD_SZ_INVALID;
  48                         }
  49                         size = pci_vpd_lrdt_size(header);
  50                         if (off + size > PCI_VPD_MAX_SIZE)
  51                                 goto error;
  52
  53                         off += PCI_VPD_LRDT_TAG_SIZE + size;
  54                 } else {
  55                         /* Short Resource Data Type Tag */
  56                         tag = pci_vpd_srdt_tag(header);
  57                         size = pci_vpd_srdt_size(header);
  58                         if (off + size > PCI_VPD_MAX_SIZE)
  59                                 goto error;
  60
  61                         off += PCI_VPD_SRDT_TAG_SIZE + size;
  62                         if (tag == PCI_VPD_STIN_END)    /* End tag descriptor */
  63                                 return off;
  64                 }
  65         }
  66         return off;
  67
  68 error:
  69         pci_info(dev, "invalid VPD tag %#04x (size %zu) at offset %zu%s\n",
  70                  header[0], size, off, off == 0 ?
  71                  "; assume missing optional EEPROM" : "");
  72         return off ?: PCI_VPD_SZ_INVALID;
  73 }
  74
  75 /*
  76  * Wait for last operation to complete.
  77  * This code has to spin since there is no other notification from the PCI
  78  * hardware. Since the VPD is often implemented by serial attachment to an
  79  * EEPROM, it may take many milliseconds to complete.
  80  * @set: if true wait for flag to be set, else wait for it to be cleared
  81  *
  82  * Returns 0 on success, negative values indicate error.
  83  */
  84 static int pci_vpd_wait(struct pci_dev *dev, bool set)
  85 {
  86         struct pci_vpd *vpd = &dev->vpd;
  87         unsigned long timeout = jiffies + msecs_to_jiffies(125);
  88         unsigned long max_sleep = 16;
  89         u16 status;
  90         int ret;
  91
  92         do {
  93                 ret = pci_user_read_config_word(dev, vpd->cap + PCI_VPD_ADDR,
  94                                                 &status);
  95                 if (ret < 0)
  96                         return ret;
  97
  98                 if (!!(status & PCI_VPD_ADDR_F) == set)
  99                         return 0;
 100
 101                 if (time_after(jiffies, timeout))
 102                         break;
 103
 104                 usleep_range(10, max_sleep);
 105                 if (max_sleep < 1024)
 106                         max_sleep *= 2;
 107         } while (true);
 108
 109         pci_warn(dev, "VPD access failed.  This is likely a firmware bug on this device.  Contact the card vendor for a firmware update\n");
 110         return -ETIMEDOUT;
 111 }
 112
 113 static ssize_t pci_vpd_read(struct pci_dev *dev, loff_t pos, size_t count,
 114                             void *arg)
 115 {
 116         struct pci_vpd *vpd = &dev->vpd;
 117         int ret = 0;
 118         loff_t end = pos + count;
 119         u8 *buf = arg;
 120
 121         if (!vpd->cap)
 122                 return -ENODEV;
 123
 124         if (pos < 0)
 125                 return -EINVAL;
 126
 127         if (pos > vpd->len)
 128                 return 0;
 129
 130         if (end > vpd->len) {
 131                 end = vpd->len;
 132                 count = end - pos;
 133         }
 134
 135         if (mutex_lock_killable(&vpd->lock))
 136                 return -EINTR;
 137
 138         while (pos < end) {
 139                 u32 val;
 140                 unsigned int i, skip;
 141
 142                 if (fatal_signal_pending(current)) {
 143                         ret = -EINTR;
 144                         break;
 145                 }
 146
 147                 ret = pci_user_write_config_word(dev, vpd->cap + PCI_VPD_ADDR,
 148                                                  pos & ~3);
 149                 if (ret < 0)
 150                         break;
 151                 ret = pci_vpd_wait(dev, true);
 152                 if (ret < 0)
 153                         break;
 154
 155                 ret = pci_user_read_config_dword(dev, vpd->cap + PCI_VPD_DATA, &val);
 156                 if (ret < 0)
 157                         break;
 158
 159                 skip = pos & 3;
 160                 for (i = 0;  i < sizeof(u32); i++) {
 161                         if (i >= skip) {
 162                                 *buf++ = val;
 163                                 if (++pos == end)
 164                                         break;
 165                         }
 166                         val >>= 8;
 167                 }
 168         }
 169
 170         mutex_unlock(&vpd->lock);
 171         return ret ? ret : count;
 172 }
 173
 174 static ssize_t pci_vpd_write(struct pci_dev *dev, loff_t pos, size_t count,
 175                              const void *arg)
 176 {
 177         struct pci_vpd *vpd = &dev->vpd;
 178         const u8 *buf = arg;
 179         loff_t end = pos + count;
 180         int ret = 0;
 181
 182         if (!vpd->cap)
 183                 return -ENODEV;
 184
 185         if (pos < 0 || (pos & 3) || (count & 3))
 186                 return -EINVAL;
 187
 188         if (end > vpd->len)
 189                 return -EINVAL;
 190
 191         if (mutex_lock_killable(&vpd->lock))
 192                 return -EINTR;
 193
 194         while (pos < end) {
 195                 u32 val;
 196
 197                 val = *buf++;
 198                 val |= *buf++ << 8;
 199                 val |= *buf++ << 16;
 200                 val |= *buf++ << 24;
 201
 202                 ret = pci_user_write_config_dword(dev, vpd->cap + PCI_VPD_DATA, val);
 203                 if (ret < 0)
 204                         break;
 205                 ret = pci_user_write_config_word(dev, vpd->cap + PCI_VPD_ADDR,
 206                                                  pos | PCI_VPD_ADDR_F);
 207                 if (ret < 0)
 208                         break;
 209
 210                 ret = pci_vpd_wait(dev, false);
 211                 if (ret < 0)
 212                         break;
 213
 214                 pos += sizeof(u32);
 215         }
 216
 217         mutex_unlock(&vpd->lock);
 218         return ret ? ret : count;
 219 }
 220
 221 void pci_vpd_init(struct pci_dev *dev)
 222 {
 223         dev->vpd.cap = pci_find_capability(dev, PCI_CAP_ID_VPD);
 224         mutex_init(&dev->vpd.lock);
 225
 226         if (!dev->vpd.len)
 227                 dev->vpd.len = pci_vpd_size(dev);
 228
 229         if (dev->vpd.len == PCI_VPD_SZ_INVALID)
 230                 dev->vpd.cap = 0;
 231 }
 232
 233 static ssize_t vpd_read(struct file *filp, struct kobject *kobj,
 234                         struct bin_attribute *bin_attr, char *buf, loff_t off,
 235                         size_t count)
 236 {
 237         struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
 238
 239         return pci_read_vpd(dev, off, count, buf);
 240 }
 241
 242 static ssize_t vpd_write(struct file *filp, struct kobject *kobj,
 243                          struct bin_attribute *bin_attr, char *buf, loff_t off,
 244                          size_t count)
 245 {
 246         struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
 247
 248         return pci_write_vpd(dev, off, count, buf);
 249 }
 250 static BIN_ATTR(vpd, 0600, vpd_read, vpd_write, 0);
 251
 252 static struct bin_attribute *vpd_attrs[] = {
 253         &bin_attr_vpd,
 254         NULL,
 255 };
 256
 257 static umode_t vpd_attr_is_visible(struct kobject *kobj,
 258                                    struct bin_attribute *a, int n)
 259 {
 260         struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
 261
 262         if (!pdev->vpd.cap)
 263                 return 0;
 264
 265         return a->attr.mode;
 266 }
 267
 268 const struct attribute_group pci_dev_vpd_attr_group = {
 269         .bin_attrs = vpd_attrs,
 270         .is_bin_visible = vpd_attr_is_visible,
 271 };
 272
 273 int pci_vpd_find_tag(const u8 *buf, unsigned int len, u8 rdt)
 274 {
 275         int i = 0;
 276
 277         /* look for LRDT tags only, end tag is the only SRDT tag */
 278         while (i + PCI_VPD_LRDT_TAG_SIZE <= len && buf[i] & PCI_VPD_LRDT) {
 279                 if (buf[i] == rdt)
 280                         return i;
 281
 282                 i += PCI_VPD_LRDT_TAG_SIZE + pci_vpd_lrdt_size(buf + i);
 283         }
 284
 285         return -ENOENT;
 286 }
 287 EXPORT_SYMBOL_GPL(pci_vpd_find_tag);
 288
 289 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
 290                               unsigned int len, const char *kw)
 291 {
 292         int i;
 293
 294         for (i = off; i + PCI_VPD_INFO_FLD_HDR_SIZE <= off + len;) {
 295                 if (buf[i + 0] == kw[0] &&
 296                     buf[i + 1] == kw[1])
 297                         return i;
 298
 299                 i += PCI_VPD_INFO_FLD_HDR_SIZE +
 300                      pci_vpd_info_field_size(&buf[i]);
 301         }
 302
 303         return -ENOENT;
 304 }
 305 EXPORT_SYMBOL_GPL(pci_vpd_find_info_keyword);
 306
 307 /**
 308  * pci_read_vpd - Read one entry from Vital Product Data
 309  * @dev:        PCI device struct
 310  * @pos:        offset in VPD space
 311  * @count:      number of bytes to read
 312  * @buf:        pointer to where to store result
 313  */
 314 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf)
 315 {
 316         ssize_t ret;
 317
 318         if (dev->dev_flags & PCI_DEV_FLAGS_VPD_REF_F0) {
 319                 dev = pci_get_func0_dev(dev);
 320                 if (!dev)
 321                         return -ENODEV;
 322
 323                 ret = pci_vpd_read(dev, pos, count, buf);
 324                 pci_dev_put(dev);
 325                 return ret;
 326         }
 327
 328         return pci_vpd_read(dev, pos, count, buf);
 329 }
 330 EXPORT_SYMBOL(pci_read_vpd);
 331
 332 /**
 333  * pci_write_vpd - Write entry to Vital Product Data
 334  * @dev:        PCI device struct
 335  * @pos:        offset in VPD space
 336  * @count:      number of bytes to write
 337  * @buf:        buffer containing write data
 338  */
 339 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf)
 340 {
 341         ssize_t ret;
 342
 343         if (dev->dev_flags & PCI_DEV_FLAGS_VPD_REF_F0) {
 344                 dev = pci_get_func0_dev(dev);
 345                 if (!dev)
 346                         return -ENODEV;
 347
 348                 ret = pci_vpd_write(dev, pos, count, buf);
 349                 pci_dev_put(dev);
 350                 return ret;
 351         }
 352
 353         return pci_vpd_write(dev, pos, count, buf);
 354 }
 355 EXPORT_SYMBOL(pci_write_vpd);
 356
 357 #ifdef CONFIG_PCI_QUIRKS
 358 /*
 359  * Quirk non-zero PCI functions to route VPD access through function 0 for
 360  * devices that share VPD resources between functions.  The functions are
 361  * expected to be identical devices.
 362  */
 363 static void quirk_f0_vpd_link(struct pci_dev *dev)
 364 {
 365         struct pci_dev *f0;
 366
 367         if (!PCI_FUNC(dev->devfn))
 368                 return;
 369
 370         f0 = pci_get_func0_dev(dev);
 371         if (!f0)
 372                 return;
 373
 374         if (f0->vpd.cap && dev->class == f0->class &&
 375             dev->vendor == f0->vendor && dev->device == f0->device)
 376                 dev->dev_flags |= PCI_DEV_FLAGS_VPD_REF_F0;
 377
 378         pci_dev_put(f0);
 379 }
 380 DECLARE_PCI_FIXUP_CLASS_EARLY(PCI_VENDOR_ID_INTEL, PCI_ANY_ID,
 381                               PCI_CLASS_NETWORK_ETHERNET, 8, quirk_f0_vpd_link);
 382
 383 /*
 384  * If a device follows the VPD format spec, the PCI core will not read or
 385  * write past the VPD End Tag.  But some vendors do not follow the VPD
 386  * format spec, so we can't tell how much data is safe to access.  Devices
 387  * may behave unpredictably if we access too much.  Blacklist these devices
 388  * so we don't touch VPD at all.
 389  */
 390 static void quirk_blacklist_vpd(struct pci_dev *dev)
 391 {
 392         dev->vpd.len = PCI_VPD_SZ_INVALID;
 393         pci_warn(dev, FW_BUG "disabling VPD access (can't determine size of non-standard VPD format)\n");
 394 }
 395 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x0060, quirk_blacklist_vpd);
 396 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x007c, quirk_blacklist_vpd);
 397 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x0413, quirk_blacklist_vpd);
 398 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x0078, quirk_blacklist_vpd);
 399 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x0079, quirk_blacklist_vpd);
 400 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x0073, quirk_blacklist_vpd);
 401 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x0071, quirk_blacklist_vpd);
 402 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x005b, quirk_blacklist_vpd);
 403 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x002f, quirk_blacklist_vpd);
 404 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x005d, quirk_blacklist_vpd);
 405 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_LSI_LOGIC, 0x005f, quirk_blacklist_vpd);
 406 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_ATTANSIC, PCI_ANY_ID, quirk_blacklist_vpd);
 407 /*
 408  * The Amazon Annapurna Labs 0x0031 device id is reused for other non Root Port
 409  * device types, so the quirk is registered for the PCI_CLASS_BRIDGE_PCI class.
 410  */
 411 DECLARE_PCI_FIXUP_CLASS_HEADER(PCI_VENDOR_ID_AMAZON_ANNAPURNA_LABS, 0x0031,
 412                                PCI_CLASS_BRIDGE_PCI, 8, quirk_blacklist_vpd);
 413
 414 static void quirk_chelsio_extend_vpd(struct pci_dev *dev)
 415 {
 416         int chip = (dev->device & 0xf000) >> 12;
 417         int func = (dev->device & 0x0f00) >>  8;
 418         int prod = (dev->device & 0x00ff) >>  0;
 419
 420         /*
 421          * If this is a T3-based adapter, there's a 1KB VPD area at offset
 422          * 0xc00 which contains the preferred VPD values.  If this is a T4 or
 423          * later based adapter, the special VPD is at offset 0x400 for the
 424          * Physical Functions (the SR-IOV Virtual Functions have no VPD
 425          * Capabilities).  The PCI VPD Access core routines will normally
 426          * compute the size of the VPD by parsing the VPD Data Structure at
 427          * offset 0x000.  This will result in silent failures when attempting
 428          * to accesses these other VPD areas which are beyond those computed
 429          * limits.
 430          */
 431         if (chip == 0x0 && prod >= 0x20)
 432                 dev->vpd.len = 8192;
 433         else if (chip >= 0x4 && func < 0x8)
 434                 dev->vpd.len = 2048;
 435 }
 436
 437 DECLARE_PCI_FIXUP_HEADER(PCI_VENDOR_ID_CHELSIO, PCI_ANY_ID,
 438                          quirk_chelsio_extend_vpd);
 439
 440 #endif