drivers/pnp/quirks.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  This file contains quirk handling code for PnP devices
   4  *  Some devices do not report all their resources, and need to have extra
   5  *  resources added. This is most easily accomplished at initialisation time
   6  *  when building up the resource structure for the first time.
   7  *
   8  *  Copyright (c) 2000 Peter Denison <peterd@pnd-pc.demon.co.uk>
   9  *  Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
  10  *      Bjorn Helgaas <bjorn.helgaas@hp.com>
  11  *
  12  *  Heavily based on PCI quirks handling which is
  13  *
  14  *  Copyright (c) 1999 Martin Mares <mj@ucw.cz>
  15  */
  16
  17 #include <linux/types.h>
  18 #include <linux/kernel.h>
  19 #include <linux/pci.h>
  20 #include <linux/string.h>
  21 #include <linux/slab.h>
  22 #include <linux/pnp.h>
  23 #include <linux/io.h>
  24 #include "base.h"
  25
  26 static void quirk_awe32_add_ports(struct pnp_dev *dev,
  27                                   struct pnp_option *option,
  28                                   unsigned int offset)
  29 {
  30         struct pnp_option *new_option;
  31
  32         new_option = kmalloc(sizeof(struct pnp_option), GFP_KERNEL);
  33         if (!new_option) {
  34                 dev_err(&dev->dev, "couldn't add ioport region to option set "
  35                         "%d\n", pnp_option_set(option));
  36                 return;
  37         }
  38
  39         *new_option = *option;
  40         new_option->u.port.min += offset;
  41         new_option->u.port.max += offset;
  42         list_add(&new_option->list, &option->list);
  43
  44         dev_info(&dev->dev, "added ioport region %#llx-%#llx to set %d\n",
  45                 (unsigned long long) new_option->u.port.min,
  46                 (unsigned long long) new_option->u.port.max,
  47                 pnp_option_set(option));
  48 }
  49
  50 static void quirk_awe32_resources(struct pnp_dev *dev)
  51 {
  52         struct pnp_option *option;
  53         unsigned int set = ~0;
  54
  55         /*
  56          * Add two extra ioport regions (at offset 0x400 and 0x800 from the
  57          * one given) to every dependent option set.
  58          */
  59         list_for_each_entry(option, &dev->options, list) {
  60                 if (pnp_option_is_dependent(option) &&
  61                     pnp_option_set(option) != set) {
  62                         set = pnp_option_set(option);
  63                         quirk_awe32_add_ports(dev, option, 0x800);
  64                         quirk_awe32_add_ports(dev, option, 0x400);
  65                 }
  66         }
  67 }
  68
  69 static void quirk_cmi8330_resources(struct pnp_dev *dev)
  70 {
  71         struct pnp_option *option;
  72         struct pnp_irq *irq;
  73         struct pnp_dma *dma;
  74
  75         list_for_each_entry(option, &dev->options, list) {
  76                 if (!pnp_option_is_dependent(option))
  77                         continue;
  78
  79                 if (option->type == IORESOURCE_IRQ) {
  80                         irq = &option->u.irq;
  81                         bitmap_zero(irq->map.bits, PNP_IRQ_NR);
  82                         __set_bit(5, irq->map.bits);
  83                         __set_bit(7, irq->map.bits);
  84                         __set_bit(10, irq->map.bits);
  85                         dev_info(&dev->dev, "set possible IRQs in "
  86                                  "option set %d to 5, 7, 10\n",
  87                                  pnp_option_set(option));
  88                 } else if (option->type == IORESOURCE_DMA) {
  89                         dma = &option->u.dma;
  90                         if ((dma->flags & IORESOURCE_DMA_TYPE_MASK) ==
  91                                                 IORESOURCE_DMA_8BIT &&
  92                             dma->map != 0x0A) {
  93                                 dev_info(&dev->dev, "changing possible "
  94                                          "DMA channel mask in option set %d "
  95                                          "from %#02x to 0x0A (1, 3)\n",
  96                                          pnp_option_set(option), dma->map);
  97                                 dma->map = 0x0A;
  98                         }
  99                 }
 100         }
 101 }
 102
 103 static void quirk_sb16audio_resources(struct pnp_dev *dev)
 104 {
 105         struct pnp_option *option;
 106         unsigned int prev_option_flags = ~0, n = 0;
 107         struct pnp_port *port;
 108
 109         /*
 110          * The default range on the OPL port for these devices is 0x388-0x388.
 111          * Here we increase that range so that two such cards can be
 112          * auto-configured.
 113          */
 114         list_for_each_entry(option, &dev->options, list) {
 115                 if (prev_option_flags != option->flags) {
 116                         prev_option_flags = option->flags;
 117                         n = 0;
 118                 }
 119
 120                 if (pnp_option_is_dependent(option) &&
 121                     option->type == IORESOURCE_IO) {
 122                         n++;
 123                         port = &option->u.port;
 124                         if (n == 3 && port->min == port->max) {
 125                                 port->max += 0x70;
 126                                 dev_info(&dev->dev, "increased option port "
 127                                          "range from %#llx-%#llx to "
 128                                          "%#llx-%#llx\n",
 129                                          (unsigned long long) port->min,
 130                                          (unsigned long long) port->min,
 131                                          (unsigned long long) port->min,
 132                                          (unsigned long long) port->max);
 133                         }
 134                 }
 135         }
 136 }
 137
 138 static struct pnp_option *pnp_clone_dependent_set(struct pnp_dev *dev,
 139                                                   unsigned int set)
 140 {
 141         struct pnp_option *tail = NULL, *first_new_option = NULL;
 142         struct pnp_option *option, *new_option;
 143         unsigned int flags;
 144
 145         list_for_each_entry(option, &dev->options, list) {
 146                 if (pnp_option_is_dependent(option))
 147                         tail = option;
 148         }
 149         if (!tail) {
 150                 dev_err(&dev->dev, "no dependent option sets\n");
 151                 return NULL;
 152         }
 153
 154         flags = pnp_new_dependent_set(dev, PNP_RES_PRIORITY_FUNCTIONAL);
 155         list_for_each_entry(option, &dev->options, list) {
 156                 if (pnp_option_is_dependent(option) &&
 157                     pnp_option_set(option) == set) {
 158                         new_option = kmalloc(sizeof(struct pnp_option),
 159                                              GFP_KERNEL);
 160                         if (!new_option) {
 161                                 dev_err(&dev->dev, "couldn't clone dependent "
 162                                         "set %d\n", set);
 163                                 return NULL;
 164                         }
 165
 166                         *new_option = *option;
 167                         new_option->flags = flags;
 168                         if (!first_new_option)
 169                                 first_new_option = new_option;
 170
 171                         list_add(&new_option->list, &tail->list);
 172                         tail = new_option;
 173                 }
 174         }
 175
 176         return first_new_option;
 177 }
 178
 179
 180 static void quirk_add_irq_optional_dependent_sets(struct pnp_dev *dev)
 181 {
 182         struct pnp_option *new_option;
 183         unsigned int num_sets, i, set;
 184         struct pnp_irq *irq;
 185
 186         num_sets = dev->num_dependent_sets;
 187         for (i = 0; i < num_sets; i++) {
 188                 new_option = pnp_clone_dependent_set(dev, i);
 189                 if (!new_option)
 190                         return;
 191
 192                 set = pnp_option_set(new_option);
 193                 while (new_option && pnp_option_set(new_option) == set) {
 194                         if (new_option->type == IORESOURCE_IRQ) {
 195                                 irq = &new_option->u.irq;
 196                                 irq->flags |= IORESOURCE_IRQ_OPTIONAL;
 197                         }
 198                         dbg_pnp_show_option(dev, new_option);
 199                         new_option = list_entry(new_option->list.next,
 200                                                 struct pnp_option, list);
 201                 }
 202
 203                 dev_info(&dev->dev, "added dependent option set %d (same as "
 204                          "set %d except IRQ optional)\n", set, i);
 205         }
 206 }
 207
 208 static void quirk_ad1815_mpu_resources(struct pnp_dev *dev)
 209 {
 210         struct pnp_option *option;
 211         struct pnp_irq *irq = NULL;
 212         unsigned int independent_irqs = 0;
 213
 214         list_for_each_entry(option, &dev->options, list) {
 215                 if (option->type == IORESOURCE_IRQ &&
 216                     !pnp_option_is_dependent(option)) {
 217                         independent_irqs++;
 218                         irq = &option->u.irq;
 219                 }
 220         }
 221
 222         if (independent_irqs != 1)
 223                 return;
 224
 225         irq->flags |= IORESOURCE_IRQ_OPTIONAL;
 226         dev_info(&dev->dev, "made independent IRQ optional\n");
 227 }
 228
 229 static void quirk_system_pci_resources(struct pnp_dev *dev)
 230 {
 231         struct pci_dev *pdev = NULL;
 232         struct resource *res;
 233         resource_size_t pnp_start, pnp_end, pci_start, pci_end;
 234         int i, j;
 235
 236         /*
 237          * Some BIOSes have PNP motherboard devices with resources that
 238          * partially overlap PCI BARs.  The PNP system driver claims these
 239          * motherboard resources, which prevents the normal PCI driver from
 240          * requesting them later.
 241          *
 242          * This patch disables the PNP resources that conflict with PCI BARs
 243          * so they won't be claimed by the PNP system driver.
 244          */
 245         for_each_pci_dev(pdev) {
 246                 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
 247                         unsigned long flags, type;
 248
 249                         flags = pci_resource_flags(pdev, i);
 250                         type = flags & (IORESOURCE_IO | IORESOURCE_MEM);
 251                         if (!type || pci_resource_len(pdev, i) == 0)
 252                                 continue;
 253
 254                         if (flags & IORESOURCE_UNSET)
 255                                 continue;
 256
 257                         pci_start = pci_resource_start(pdev, i);
 258                         pci_end = pci_resource_end(pdev, i);
 259                         for (j = 0;
 260                              (res = pnp_get_resource(dev, type, j)); j++) {
 261                                 if (res->start == 0 && res->end == 0)
 262                                         continue;
 263
 264                                 pnp_start = res->start;
 265                                 pnp_end = res->end;
 266
 267                                 /*
 268                                  * If the PNP region doesn't overlap the PCI
 269                                  * region at all, there's no problem.
 270                                  */
 271                                 if (pnp_end < pci_start || pnp_start > pci_end)
 272                                         continue;
 273
 274                                 /*
 275                                  * If the PNP region completely encloses (or is
 276                                  * at least as large as) the PCI region, that's
 277                                  * also OK.  For example, this happens when the
 278                                  * PNP device describes a bridge with PCI
 279                                  * behind it.
 280                                  */
 281                                 if (pnp_start <= pci_start &&
 282                                     pnp_end >= pci_end)
 283                                         continue;
 284
 285                                 /*
 286                                  * Otherwise, the PNP region overlaps *part* of
 287                                  * the PCI region, and that might prevent a PCI
 288                                  * driver from requesting its resources.
 289                                  */
 290                                 dev_warn(&dev->dev,
 291                                          "disabling %pR because it overlaps "
 292                                          "%s BAR %d %pR\n", res,
 293                                          pci_name(pdev), i, &pdev->resource[i]);
 294                                 res->flags |= IORESOURCE_DISABLED;
 295                         }
 296                 }
 297         }
 298 }
 299
 300 #ifdef CONFIG_AMD_NB
 301
 302 #include <asm/amd_nb.h>
 303
 304 static void quirk_amd_mmconfig_area(struct pnp_dev *dev)
 305 {
 306         resource_size_t start, end;
 307         struct pnp_resource *pnp_res;
 308         struct resource *res;
 309         struct resource mmconfig_res, *mmconfig;
 310
 311         mmconfig = amd_get_mmconfig_range(&mmconfig_res);
 312         if (!mmconfig)
 313                 return;
 314
 315         list_for_each_entry(pnp_res, &dev->resources, list) {
 316                 res = &pnp_res->res;
 317                 if (res->end < mmconfig->start || res->start > mmconfig->end ||
 318                     (res->start == mmconfig->start && res->end == mmconfig->end))
 319                         continue;
 320
 321                 dev_info(&dev->dev, FW_BUG
 322                          "%pR covers only part of AMD MMCONFIG area %pR; adding more reservations\n",
 323                          res, mmconfig);
 324                 if (mmconfig->start < res->start) {
 325                         start = mmconfig->start;
 326                         end = res->start - 1;
 327                         pnp_add_mem_resource(dev, start, end, 0);
 328                 }
 329                 if (mmconfig->end > res->end) {
 330                         start = res->end + 1;
 331                         end = mmconfig->end;
 332                         pnp_add_mem_resource(dev, start, end, 0);
 333                 }
 334                 break;
 335         }
 336 }
 337 #endif
 338
 339 #ifdef CONFIG_PCI
 340 /* Device IDs of parts that have 32KB MCH space */
 341 static const unsigned int mch_quirk_devices[] = {
 342         0x0154, /* Ivy Bridge */
 343         0x0a04, /* Haswell-ULT */
 344         0x0c00, /* Haswell */
 345         0x1604, /* Broadwell */
 346 };
 347
 348 static struct pci_dev *get_intel_host(void)
 349 {
 350         int i;
 351         struct pci_dev *host;
 352
 353         for (i = 0; i < ARRAY_SIZE(mch_quirk_devices); i++) {
 354                 host = pci_get_device(PCI_VENDOR_ID_INTEL, mch_quirk_devices[i],
 355                                       NULL);
 356                 if (host)
 357                         return host;
 358         }
 359         return NULL;
 360 }
 361
 362 static void quirk_intel_mch(struct pnp_dev *dev)
 363 {
 364         struct pci_dev *host;
 365         u32 addr_lo, addr_hi;
 366         struct pci_bus_region region;
 367         struct resource mch;
 368         struct pnp_resource *pnp_res;
 369         struct resource *res;
 370
 371         host = get_intel_host();
 372         if (!host)
 373                 return;
 374
 375         /*
 376          * MCHBAR is not an architected PCI BAR, so MCH space is usually
 377          * reported as a PNP0C02 resource.  The MCH space was originally
 378          * 16KB, but is 32KB in newer parts.  Some BIOSes still report a
 379          * PNP0C02 resource that is only 16KB, which means the rest of the
 380          * MCH space is consumed but unreported.
 381          */
 382
 383         /*
 384          * Read MCHBAR for Host Member Mapped Register Range Base
 385          * https://www-ssl.intel.com/content/www/us/en/processors/core/4th-gen-core-family-desktop-vol-2-datasheet
 386          * Sec 3.1.12.
 387          */
 388         pci_read_config_dword(host, 0x48, &addr_lo);
 389         region.start = addr_lo & ~0x7fff;
 390         pci_read_config_dword(host, 0x4c, &addr_hi);
 391         region.start |= (u64) addr_hi << 32;
 392         region.end = region.start + 32*1024 - 1;
 393
 394         memset(&mch, 0, sizeof(mch));
 395         mch.flags = IORESOURCE_MEM;
 396         pcibios_bus_to_resource(host->bus, &mch, &region);
 397
 398         list_for_each_entry(pnp_res, &dev->resources, list) {
 399                 res = &pnp_res->res;
 400                 if (res->end < mch.start || res->start > mch.end)
 401                         continue;       /* no overlap */
 402                 if (res->start == mch.start && res->end == mch.end)
 403                         continue;       /* exact match */
 404
 405                 dev_info(&dev->dev, FW_BUG "PNP resource %pR covers only part of %s Intel MCH; extending to %pR\n",
 406                          res, pci_name(host), &mch);
 407                 res->start = mch.start;
 408                 res->end = mch.end;
 409                 break;
 410         }
 411
 412         pci_dev_put(host);
 413 }
 414 #endif
 415
 416 /*
 417  *  PnP Quirks
 418  *  Cards or devices that need some tweaking due to incomplete resource info
 419  */
 420
 421 static struct pnp_fixup pnp_fixups[] = {
 422         /* Soundblaster awe io port quirk */
 423         {"CTL0021", quirk_awe32_resources},
 424         {"CTL0022", quirk_awe32_resources},
 425         {"CTL0023", quirk_awe32_resources},
 426         /* CMI 8330 interrupt and dma fix */
 427         {"@X@0001", quirk_cmi8330_resources},
 428         /* Soundblaster audio device io port range quirk */
 429         {"CTL0001", quirk_sb16audio_resources},
 430         {"CTL0031", quirk_sb16audio_resources},
 431         {"CTL0041", quirk_sb16audio_resources},
 432         {"CTL0042", quirk_sb16audio_resources},
 433         {"CTL0043", quirk_sb16audio_resources},
 434         {"CTL0044", quirk_sb16audio_resources},
 435         {"CTL0045", quirk_sb16audio_resources},
 436         /* Add IRQ-optional MPU options */
 437         {"ADS7151", quirk_ad1815_mpu_resources},
 438         {"ADS7181", quirk_add_irq_optional_dependent_sets},
 439         {"AZT0002", quirk_add_irq_optional_dependent_sets},
 440         /* PnP resources that might overlap PCI BARs */
 441         {"PNP0c01", quirk_system_pci_resources},
 442         {"PNP0c02", quirk_system_pci_resources},
 443 #ifdef CONFIG_AMD_NB
 444         {"PNP0c01", quirk_amd_mmconfig_area},
 445 #endif
 446 #ifdef CONFIG_PCI
 447         {"PNP0c02", quirk_intel_mch},
 448 #endif
 449         {""}
 450 };
 451
 452 void pnp_fixup_device(struct pnp_dev *dev)
 453 {
 454         struct pnp_fixup *f;
 455
 456         for (f = pnp_fixups; *f->id; f++) {
 457                 if (!compare_pnp_id(dev->id, f->id))
 458                         continue;
 459                 pnp_dbg(&dev->dev, "%s: calling %pS\n", f->id,
 460                         f->quirk_function);
 461                 f->quirk_function(dev);
 462         }
 463 }