1 /*- 2 * Copyright (c) 2010 Isilon Systems, Inc. 3 * Copyright (c) 2010 iX Systems, Inc. 4 * Copyright (c) 2010 Panasas, Inc. 5 * Copyright (c) 2013-2016 Mellanox Technologies, Ltd. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice unmodified, this list of conditions, and the following 13 * disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 * 29 * $FreeBSD$ 30 */ 31 #ifndef _LINUX_PCI_H_ 32 #define _LINUX_PCI_H_ 33 34 #define CONFIG_PCI_MSI 35 36 #include <linux/types.h> 37 38 #include <sys/param.h> 39 #include <sys/bus.h> 40 #include <sys/nv.h> 41 #include <sys/pciio.h> 42 #include <sys/rman.h> 43 #include <sys/bus.h> 44 #include <dev/pci/pcivar.h> 45 #include <dev/pci/pcireg.h> 46 #include <dev/pci/pci_private.h> 47 48 #include <machine/resource.h> 49 50 #include <linux/list.h> 51 #include <linux/dmapool.h> 52 #include <linux/dma-mapping.h> 53 #include <linux/compiler.h> 54 #include <linux/errno.h> 55 #include <asm/atomic.h> 56 #include <linux/device.h> 57 58 struct pci_device_id { 59 uint32_t vendor; 60 uint32_t device; 61 uint32_t subvendor; 62 uint32_t subdevice; 63 uint32_t class; 64 uint32_t class_mask; 65 uintptr_t driver_data; 66 }; 67 68 #define MODULE_DEVICE_TABLE(bus, table) 69 70 #define PCI_BASE_CLASS_DISPLAY 0x03 71 #define PCI_CLASS_DISPLAY_VGA 0x0300 72 #define PCI_CLASS_DISPLAY_OTHER 0x0380 73 #define PCI_BASE_CLASS_BRIDGE 0x06 74 #define PCI_CLASS_BRIDGE_ISA 0x0601 75 76 #define PCI_ANY_ID -1U 77 #define PCI_VENDOR_ID_APPLE 0x106b 78 #define PCI_VENDOR_ID_ASUSTEK 0x1043 79 #define PCI_VENDOR_ID_ATI 0x1002 80 #define PCI_VENDOR_ID_DELL 0x1028 81 #define PCI_VENDOR_ID_HP 0x103c 82 #define PCI_VENDOR_ID_IBM 0x1014 83 #define PCI_VENDOR_ID_INTEL 0x8086 84 #define PCI_VENDOR_ID_MELLANOX 0x15b3 85 #define PCI_VENDOR_ID_REDHAT_QUMRANET 0x1af4 86 #define PCI_VENDOR_ID_SERVERWORKS 0x1166 87 #define PCI_VENDOR_ID_SONY 0x104d 88 #define PCI_VENDOR_ID_TOPSPIN 0x1867 89 #define PCI_VENDOR_ID_VIA 0x1106 90 #define PCI_SUBVENDOR_ID_REDHAT_QUMRANET 0x1af4 91 #define PCI_DEVICE_ID_ATI_RADEON_QY 0x5159 92 #define PCI_DEVICE_ID_MELLANOX_TAVOR 0x5a44 93 #define PCI_DEVICE_ID_MELLANOX_TAVOR_BRIDGE 0x5a46 94 #define PCI_DEVICE_ID_MELLANOX_ARBEL_COMPAT 0x6278 95 #define PCI_DEVICE_ID_MELLANOX_ARBEL 0x6282 96 #define PCI_DEVICE_ID_MELLANOX_SINAI_OLD 0x5e8c 97 #define PCI_DEVICE_ID_MELLANOX_SINAI 0x6274 98 #define PCI_SUBDEVICE_ID_QEMU 0x1100 99 100 #define PCI_DEVFN(slot, func) ((((slot) & 0x1f) << 3) | ((func) & 0x07)) 101 #define PCI_SLOT(devfn) (((devfn) >> 3) & 0x1f) 102 #define PCI_FUNC(devfn) ((devfn) & 0x07) 103 #define PCI_BUS_NUM(devfn) (((devfn) >> 8) & 0xff) 104 105 #define PCI_VDEVICE(_vendor, _device) \ 106 .vendor = PCI_VENDOR_ID_##_vendor, .device = (_device), \ 107 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID 108 #define PCI_DEVICE(_vendor, _device) \ 109 .vendor = (_vendor), .device = (_device), \ 110 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID 111 112 #define to_pci_dev(n) container_of(n, struct pci_dev, dev) 113 114 #define PCI_VENDOR_ID PCIR_DEVVENDOR 115 #define PCI_COMMAND PCIR_COMMAND 116 #define PCI_EXP_DEVCTL PCIER_DEVICE_CTL /* Device Control */ 117 #define PCI_EXP_LNKCTL PCIER_LINK_CTL /* Link Control */ 118 #define PCI_EXP_FLAGS_TYPE PCIEM_FLAGS_TYPE /* Device/Port type */ 119 #define PCI_EXP_DEVCAP PCIER_DEVICE_CAP /* Device capabilities */ 120 #define PCI_EXP_DEVSTA PCIER_DEVICE_STA /* Device Status */ 121 #define PCI_EXP_LNKCAP PCIER_LINK_CAP /* Link Capabilities */ 122 #define PCI_EXP_LNKSTA PCIER_LINK_STA /* Link Status */ 123 #define PCI_EXP_SLTCAP PCIER_SLOT_CAP /* Slot Capabilities */ 124 #define PCI_EXP_SLTCTL PCIER_SLOT_CTL /* Slot Control */ 125 #define PCI_EXP_SLTSTA PCIER_SLOT_STA /* Slot Status */ 126 #define PCI_EXP_RTCTL PCIER_ROOT_CTL /* Root Control */ 127 #define PCI_EXP_RTCAP PCIER_ROOT_CAP /* Root Capabilities */ 128 #define PCI_EXP_RTSTA PCIER_ROOT_STA /* Root Status */ 129 #define PCI_EXP_DEVCAP2 PCIER_DEVICE_CAP2 /* Device Capabilities 2 */ 130 #define PCI_EXP_DEVCTL2 PCIER_DEVICE_CTL2 /* Device Control 2 */ 131 #define PCI_EXP_LNKCAP2 PCIER_LINK_CAP2 /* Link Capabilities 2 */ 132 #define PCI_EXP_LNKCTL2 PCIER_LINK_CTL2 /* Link Control 2 */ 133 #define PCI_EXP_LNKSTA2 PCIER_LINK_STA2 /* Link Status 2 */ 134 #define PCI_EXP_FLAGS PCIER_FLAGS /* Capabilities register */ 135 #define PCI_EXP_FLAGS_VERS PCIEM_FLAGS_VERSION /* Capability version */ 136 #define PCI_EXP_TYPE_ROOT_PORT PCIEM_TYPE_ROOT_PORT /* Root Port */ 137 #define PCI_EXP_TYPE_ENDPOINT PCIEM_TYPE_ENDPOINT /* Express Endpoint */ 138 #define PCI_EXP_TYPE_LEG_END PCIEM_TYPE_LEGACY_ENDPOINT /* Legacy Endpoint */ 139 #define PCI_EXP_TYPE_DOWNSTREAM PCIEM_TYPE_DOWNSTREAM_PORT /* Downstream Port */ 140 #define PCI_EXP_FLAGS_SLOT PCIEM_FLAGS_SLOT /* Slot implemented */ 141 #define PCI_EXP_TYPE_RC_EC PCIEM_TYPE_ROOT_EC /* Root Complex Event Collector */ 142 #define PCI_EXP_LNKCAP_SLS_2_5GB 0x01 /* Supported Link Speed 2.5GT/s */ 143 #define PCI_EXP_LNKCAP_SLS_5_0GB 0x02 /* Supported Link Speed 5.0GT/s */ 144 #define PCI_EXP_LNKCAP_SLS_8_0GB 0x04 /* Supported Link Speed 8.0GT/s */ 145 #define PCI_EXP_LNKCAP_SLS_16_0GB 0x08 /* Supported Link Speed 16.0GT/s */ 146 #define PCI_EXP_LNKCAP_MLW 0x03f0 /* Maximum Link Width */ 147 #define PCI_EXP_LNKCAP2_SLS_2_5GB 0x02 /* Supported Link Speed 2.5GT/s */ 148 #define PCI_EXP_LNKCAP2_SLS_5_0GB 0x04 /* Supported Link Speed 5.0GT/s */ 149 #define PCI_EXP_LNKCAP2_SLS_8_0GB 0x08 /* Supported Link Speed 8.0GT/s */ 150 #define PCI_EXP_LNKCAP2_SLS_16_0GB 0x10 /* Supported Link Speed 16.0GT/s */ 151 152 #define PCI_EXP_LNKCTL_HAWD PCIEM_LINK_CTL_HAWD 153 #define PCI_EXP_LNKCAP_CLKPM 0x00040000 154 #define PCI_EXP_DEVSTA_TRPND 0x0020 155 156 #define IORESOURCE_MEM (1 << SYS_RES_MEMORY) 157 #define IORESOURCE_IO (1 << SYS_RES_IOPORT) 158 #define IORESOURCE_IRQ (1 << SYS_RES_IRQ) 159 160 enum pci_bus_speed { 161 PCI_SPEED_UNKNOWN = -1, 162 PCIE_SPEED_2_5GT, 163 PCIE_SPEED_5_0GT, 164 PCIE_SPEED_8_0GT, 165 PCIE_SPEED_16_0GT, 166 }; 167 168 enum pcie_link_width { 169 PCIE_LNK_WIDTH_RESRV = 0x00, 170 PCIE_LNK_X1 = 0x01, 171 PCIE_LNK_X2 = 0x02, 172 PCIE_LNK_X4 = 0x04, 173 PCIE_LNK_X8 = 0x08, 174 PCIE_LNK_X12 = 0x0c, 175 PCIE_LNK_X16 = 0x10, 176 PCIE_LNK_X32 = 0x20, 177 PCIE_LNK_WIDTH_UNKNOWN = 0xff, 178 }; 179 180 typedef int pci_power_t; 181 182 #define PCI_D0 PCI_POWERSTATE_D0 183 #define PCI_D1 PCI_POWERSTATE_D1 184 #define PCI_D2 PCI_POWERSTATE_D2 185 #define PCI_D3hot PCI_POWERSTATE_D3 186 #define PCI_D3cold 4 187 188 #define PCI_POWER_ERROR PCI_POWERSTATE_UNKNOWN 189 190 struct pci_dev; 191 192 struct pci_driver { 193 struct list_head links; 194 char *name; 195 const struct pci_device_id *id_table; 196 int (*probe)(struct pci_dev *dev, const struct pci_device_id *id); 197 void (*remove)(struct pci_dev *dev); 198 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */ 199 int (*resume) (struct pci_dev *dev); /* Device woken up */ 200 void (*shutdown) (struct pci_dev *dev); /* Device shutdown */ 201 driver_t bsddriver; 202 devclass_t bsdclass; 203 struct device_driver driver; 204 const struct pci_error_handlers *err_handler; 205 bool isdrm; 206 int (*bsd_iov_init)(device_t dev, uint16_t num_vfs, 207 const nvlist_t *pf_config); 208 void (*bsd_iov_uninit)(device_t dev); 209 int (*bsd_iov_add_vf)(device_t dev, uint16_t vfnum, 210 const nvlist_t *vf_config); 211 }; 212 213 struct pci_bus { 214 struct pci_dev *self; 215 int domain; 216 int number; 217 }; 218 219 extern struct list_head pci_drivers; 220 extern struct list_head pci_devices; 221 extern spinlock_t pci_lock; 222 223 #define __devexit_p(x) x 224 225 struct pci_mmio_region { 226 TAILQ_ENTRY(pci_mmio_region) next; 227 struct resource *res; 228 int rid; 229 int type; 230 }; 231 232 struct pci_dev { 233 struct device dev; 234 struct list_head links; 235 struct pci_driver *pdrv; 236 struct pci_bus *bus; 237 uint16_t device; 238 uint16_t vendor; 239 uint16_t subsystem_vendor; 240 uint16_t subsystem_device; 241 unsigned int irq; 242 unsigned int devfn; 243 uint32_t class; 244 uint8_t revision; 245 bool msi_enabled; 246 247 TAILQ_HEAD(, pci_mmio_region) mmio; 248 }; 249 250 static inline struct resource_list_entry * 251 linux_pci_get_rle(struct pci_dev *pdev, int type, int rid) 252 { 253 struct pci_devinfo *dinfo; 254 struct resource_list *rl; 255 256 dinfo = device_get_ivars(pdev->dev.bsddev); 257 rl = &dinfo->resources; 258 return resource_list_find(rl, type, rid); 259 } 260 261 static inline struct resource_list_entry * 262 linux_pci_get_bar(struct pci_dev *pdev, int bar) 263 { 264 struct resource_list_entry *rle; 265 266 bar = PCIR_BAR(bar); 267 if ((rle = linux_pci_get_rle(pdev, SYS_RES_MEMORY, bar)) == NULL) 268 rle = linux_pci_get_rle(pdev, SYS_RES_IOPORT, bar); 269 return (rle); 270 } 271 272 static inline struct device * 273 linux_pci_find_irq_dev(unsigned int irq) 274 { 275 struct pci_dev *pdev; 276 struct device *found; 277 278 found = NULL; 279 spin_lock(&pci_lock); 280 list_for_each_entry(pdev, &pci_devices, links) { 281 if (irq == pdev->dev.irq || 282 (irq >= pdev->dev.irq_start && irq < pdev->dev.irq_end)) { 283 found = &pdev->dev; 284 break; 285 } 286 } 287 spin_unlock(&pci_lock); 288 return (found); 289 } 290 291 static inline int 292 pci_resource_type(struct pci_dev *pdev, int bar) 293 { 294 struct pci_map *pm; 295 296 pm = pci_find_bar(pdev->dev.bsddev, PCIR_BAR(bar)); 297 if (!pm) 298 return (-1); 299 300 if (PCI_BAR_IO(pm->pm_value)) 301 return (SYS_RES_IOPORT); 302 else 303 return (SYS_RES_MEMORY); 304 } 305 306 /* 307 * All drivers just seem to want to inspect the type not flags. 308 */ 309 static inline int 310 pci_resource_flags(struct pci_dev *pdev, int bar) 311 { 312 int type; 313 314 type = pci_resource_type(pdev, bar); 315 if (type < 0) 316 return (0); 317 return (1 << type); 318 } 319 320 static inline const char * 321 pci_name(struct pci_dev *d) 322 { 323 324 return device_get_desc(d->dev.bsddev); 325 } 326 327 static inline void * 328 pci_get_drvdata(struct pci_dev *pdev) 329 { 330 331 return dev_get_drvdata(&pdev->dev); 332 } 333 334 static inline void 335 pci_set_drvdata(struct pci_dev *pdev, void *data) 336 { 337 338 dev_set_drvdata(&pdev->dev, data); 339 } 340 341 static __inline void 342 pci_dev_put(struct pci_dev *pdev) 343 { 344 345 if (pdev != NULL) 346 put_device(&pdev->dev); 347 } 348 349 static inline int 350 pci_enable_device(struct pci_dev *pdev) 351 { 352 353 pci_enable_io(pdev->dev.bsddev, SYS_RES_IOPORT); 354 pci_enable_io(pdev->dev.bsddev, SYS_RES_MEMORY); 355 return (0); 356 } 357 358 static inline void 359 pci_disable_device(struct pci_dev *pdev) 360 { 361 362 pci_disable_busmaster(pdev->dev.bsddev); 363 } 364 365 static inline int 366 pci_set_master(struct pci_dev *pdev) 367 { 368 369 pci_enable_busmaster(pdev->dev.bsddev); 370 return (0); 371 } 372 373 static inline int 374 pci_set_power_state(struct pci_dev *pdev, int state) 375 { 376 377 pci_set_powerstate(pdev->dev.bsddev, state); 378 return (0); 379 } 380 381 static inline int 382 pci_clear_master(struct pci_dev *pdev) 383 { 384 385 pci_disable_busmaster(pdev->dev.bsddev); 386 return (0); 387 } 388 389 static inline int 390 pci_request_region(struct pci_dev *pdev, int bar, const char *res_name) 391 { 392 int rid; 393 int type; 394 395 type = pci_resource_type(pdev, bar); 396 if (type < 0) 397 return (-ENODEV); 398 rid = PCIR_BAR(bar); 399 if (bus_alloc_resource_any(pdev->dev.bsddev, type, &rid, 400 RF_ACTIVE) == NULL) 401 return (-EINVAL); 402 return (0); 403 } 404 405 static inline void 406 pci_release_region(struct pci_dev *pdev, int bar) 407 { 408 struct resource_list_entry *rle; 409 410 if ((rle = linux_pci_get_bar(pdev, bar)) == NULL) 411 return; 412 bus_release_resource(pdev->dev.bsddev, rle->type, rle->rid, rle->res); 413 } 414 415 static inline void 416 pci_release_regions(struct pci_dev *pdev) 417 { 418 int i; 419 420 for (i = 0; i <= PCIR_MAX_BAR_0; i++) 421 pci_release_region(pdev, i); 422 } 423 424 static inline int 425 pci_request_regions(struct pci_dev *pdev, const char *res_name) 426 { 427 int error; 428 int i; 429 430 for (i = 0; i <= PCIR_MAX_BAR_0; i++) { 431 error = pci_request_region(pdev, i, res_name); 432 if (error && error != -ENODEV) { 433 pci_release_regions(pdev); 434 return (error); 435 } 436 } 437 return (0); 438 } 439 440 static inline void 441 pci_disable_msix(struct pci_dev *pdev) 442 { 443 444 pci_release_msi(pdev->dev.bsddev); 445 446 /* 447 * The MSIX IRQ numbers associated with this PCI device are no 448 * longer valid and might be re-assigned. Make sure 449 * linux_pci_find_irq_dev() does no longer see them by 450 * resetting their references to zero: 451 */ 452 pdev->dev.irq_start = 0; 453 pdev->dev.irq_end = 0; 454 } 455 456 #define pci_disable_msi(pdev) \ 457 linux_pci_disable_msi(pdev) 458 459 static inline void 460 linux_pci_disable_msi(struct pci_dev *pdev) 461 { 462 463 pci_release_msi(pdev->dev.bsddev); 464 465 pdev->dev.irq_start = 0; 466 pdev->dev.irq_end = 0; 467 pdev->irq = pdev->dev.irq; 468 pdev->msi_enabled = false; 469 } 470 471 #define pci_free_irq_vectors(pdev) \ 472 linux_pci_disable_msi(pdev) 473 474 unsigned long pci_resource_start(struct pci_dev *pdev, int bar); 475 unsigned long pci_resource_len(struct pci_dev *pdev, int bar); 476 477 static inline bus_addr_t 478 pci_bus_address(struct pci_dev *pdev, int bar) 479 { 480 481 return (pci_resource_start(pdev, bar)); 482 } 483 484 #define PCI_CAP_ID_EXP PCIY_EXPRESS 485 #define PCI_CAP_ID_PCIX PCIY_PCIX 486 #define PCI_CAP_ID_AGP PCIY_AGP 487 #define PCI_CAP_ID_PM PCIY_PMG 488 489 #define PCI_EXP_DEVCTL PCIER_DEVICE_CTL 490 #define PCI_EXP_DEVCTL_PAYLOAD PCIEM_CTL_MAX_PAYLOAD 491 #define PCI_EXP_DEVCTL_READRQ PCIEM_CTL_MAX_READ_REQUEST 492 #define PCI_EXP_LNKCTL PCIER_LINK_CTL 493 #define PCI_EXP_LNKSTA PCIER_LINK_STA 494 495 static inline int 496 pci_find_capability(struct pci_dev *pdev, int capid) 497 { 498 int reg; 499 500 if (pci_find_cap(pdev->dev.bsddev, capid, ®)) 501 return (0); 502 return (reg); 503 } 504 505 static inline int pci_pcie_cap(struct pci_dev *dev) 506 { 507 return pci_find_capability(dev, PCI_CAP_ID_EXP); 508 } 509 510 static inline int 511 pci_read_config_byte(struct pci_dev *pdev, int where, u8 *val) 512 { 513 514 *val = (u8)pci_read_config(pdev->dev.bsddev, where, 1); 515 return (0); 516 } 517 518 static inline int 519 pci_read_config_word(struct pci_dev *pdev, int where, u16 *val) 520 { 521 522 *val = (u16)pci_read_config(pdev->dev.bsddev, where, 2); 523 return (0); 524 } 525 526 static inline int 527 pci_read_config_dword(struct pci_dev *pdev, int where, u32 *val) 528 { 529 530 *val = (u32)pci_read_config(pdev->dev.bsddev, where, 4); 531 return (0); 532 } 533 534 static inline int 535 pci_write_config_byte(struct pci_dev *pdev, int where, u8 val) 536 { 537 538 pci_write_config(pdev->dev.bsddev, where, val, 1); 539 return (0); 540 } 541 542 static inline int 543 pci_write_config_word(struct pci_dev *pdev, int where, u16 val) 544 { 545 546 pci_write_config(pdev->dev.bsddev, where, val, 2); 547 return (0); 548 } 549 550 static inline int 551 pci_write_config_dword(struct pci_dev *pdev, int where, u32 val) 552 { 553 554 pci_write_config(pdev->dev.bsddev, where, val, 4); 555 return (0); 556 } 557 558 int linux_pci_register_driver(struct pci_driver *pdrv); 559 int linux_pci_register_drm_driver(struct pci_driver *pdrv); 560 void linux_pci_unregister_driver(struct pci_driver *pdrv); 561 void linux_pci_unregister_drm_driver(struct pci_driver *pdrv); 562 563 #define pci_register_driver(pdrv) linux_pci_register_driver(pdrv) 564 #define pci_unregister_driver(pdrv) linux_pci_unregister_driver(pdrv) 565 566 struct msix_entry { 567 int entry; 568 int vector; 569 }; 570 571 /* 572 * Enable msix, positive errors indicate actual number of available 573 * vectors. Negative errors are failures. 574 * 575 * NB: define added to prevent this definition of pci_enable_msix from 576 * clashing with the native FreeBSD version. 577 */ 578 #define pci_enable_msix(...) \ 579 linux_pci_enable_msix(__VA_ARGS__) 580 581 static inline int 582 pci_enable_msix(struct pci_dev *pdev, struct msix_entry *entries, int nreq) 583 { 584 struct resource_list_entry *rle; 585 int error; 586 int avail; 587 int i; 588 589 avail = pci_msix_count(pdev->dev.bsddev); 590 if (avail < nreq) { 591 if (avail == 0) 592 return -EINVAL; 593 return avail; 594 } 595 avail = nreq; 596 if ((error = -pci_alloc_msix(pdev->dev.bsddev, &avail)) != 0) 597 return error; 598 /* 599 * Handle case where "pci_alloc_msix()" may allocate less 600 * interrupts than available and return with no error: 601 */ 602 if (avail < nreq) { 603 pci_release_msi(pdev->dev.bsddev); 604 return avail; 605 } 606 rle = linux_pci_get_rle(pdev, SYS_RES_IRQ, 1); 607 pdev->dev.irq_start = rle->start; 608 pdev->dev.irq_end = rle->start + avail; 609 for (i = 0; i < nreq; i++) 610 entries[i].vector = pdev->dev.irq_start + i; 611 return (0); 612 } 613 614 #define pci_enable_msix_range(...) \ 615 linux_pci_enable_msix_range(__VA_ARGS__) 616 617 static inline int 618 pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries, 619 int minvec, int maxvec) 620 { 621 int nvec = maxvec; 622 int rc; 623 624 if (maxvec < minvec) 625 return (-ERANGE); 626 627 do { 628 rc = pci_enable_msix(dev, entries, nvec); 629 if (rc < 0) { 630 return (rc); 631 } else if (rc > 0) { 632 if (rc < minvec) 633 return (-ENOSPC); 634 nvec = rc; 635 } 636 } while (rc); 637 return (nvec); 638 } 639 640 #define pci_enable_msi(pdev) \ 641 linux_pci_enable_msi(pdev) 642 643 static inline int 644 pci_enable_msi(struct pci_dev *pdev) 645 { 646 struct resource_list_entry *rle; 647 int error; 648 int avail; 649 650 avail = pci_msi_count(pdev->dev.bsddev); 651 if (avail < 1) 652 return -EINVAL; 653 654 avail = 1; /* this function only enable one MSI IRQ */ 655 if ((error = -pci_alloc_msi(pdev->dev.bsddev, &avail)) != 0) 656 return error; 657 658 rle = linux_pci_get_rle(pdev, SYS_RES_IRQ, 1); 659 pdev->dev.irq_start = rle->start; 660 pdev->dev.irq_end = rle->start + avail; 661 pdev->irq = rle->start; 662 pdev->msi_enabled = true; 663 return (0); 664 } 665 666 static inline int 667 pci_channel_offline(struct pci_dev *pdev) 668 { 669 670 return (pci_read_config(pdev->dev.bsddev, PCIR_VENDOR, 2) == PCIV_INVALID); 671 } 672 673 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn) 674 { 675 return -ENODEV; 676 } 677 static inline void pci_disable_sriov(struct pci_dev *dev) 678 { 679 } 680 681 static inline void * 682 pci_iomap(struct pci_dev *dev, int mmio_bar, int mmio_size __unused) 683 { 684 struct pci_mmio_region *mmio; 685 686 mmio = malloc(sizeof(*mmio), M_DEVBUF, M_WAITOK | M_ZERO); 687 mmio->rid = PCIR_BAR(mmio_bar); 688 mmio->type = pci_resource_type(dev, mmio_bar); 689 mmio->res = bus_alloc_resource_any(dev->dev.bsddev, mmio->type, 690 &mmio->rid, RF_ACTIVE); 691 if (mmio->res == NULL) { 692 free(mmio, M_DEVBUF); 693 return (NULL); 694 } 695 TAILQ_INSERT_TAIL(&dev->mmio, mmio, next); 696 697 return ((void *)rman_get_bushandle(mmio->res)); 698 } 699 700 static inline void 701 pci_iounmap(struct pci_dev *dev, void *res) 702 { 703 struct pci_mmio_region *mmio, *p; 704 705 TAILQ_FOREACH_SAFE(mmio, &dev->mmio, next, p) { 706 if (res != (void *)rman_get_bushandle(mmio->res)) 707 continue; 708 bus_release_resource(dev->dev.bsddev, 709 mmio->type, mmio->rid, mmio->res); 710 TAILQ_REMOVE(&dev->mmio, mmio, next); 711 free(mmio, M_DEVBUF); 712 return; 713 } 714 } 715 716 static inline void 717 lkpi_pci_save_state(struct pci_dev *pdev) 718 { 719 720 pci_save_state(pdev->dev.bsddev); 721 } 722 723 static inline void 724 lkpi_pci_restore_state(struct pci_dev *pdev) 725 { 726 727 pci_restore_state(pdev->dev.bsddev); 728 } 729 730 #define pci_save_state(dev) lkpi_pci_save_state(dev) 731 #define pci_restore_state(dev) lkpi_pci_restore_state(dev) 732 733 #define DEFINE_PCI_DEVICE_TABLE(_table) \ 734 const struct pci_device_id _table[] __devinitdata 735 736 /* XXX This should not be necessary. */ 737 #define pcix_set_mmrbc(d, v) 0 738 #define pcix_get_max_mmrbc(d) 0 739 #define pcie_set_readrq(d, v) pci_set_max_read_req(&(d)->dev, (v)) 740 741 #define PCI_DMA_BIDIRECTIONAL 0 742 #define PCI_DMA_TODEVICE 1 743 #define PCI_DMA_FROMDEVICE 2 744 #define PCI_DMA_NONE 3 745 746 #define pci_pool dma_pool 747 #define pci_pool_destroy(...) dma_pool_destroy(__VA_ARGS__) 748 #define pci_pool_alloc(...) dma_pool_alloc(__VA_ARGS__) 749 #define pci_pool_free(...) dma_pool_free(__VA_ARGS__) 750 #define pci_pool_create(_name, _pdev, _size, _align, _alloc) \ 751 dma_pool_create(_name, &(_pdev)->dev, _size, _align, _alloc) 752 #define pci_free_consistent(_hwdev, _size, _vaddr, _dma_handle) \ 753 dma_free_coherent((_hwdev) == NULL ? NULL : &(_hwdev)->dev, \ 754 _size, _vaddr, _dma_handle) 755 #define pci_map_sg(_hwdev, _sg, _nents, _dir) \ 756 dma_map_sg((_hwdev) == NULL ? NULL : &(_hwdev->dev), \ 757 _sg, _nents, (enum dma_data_direction)_dir) 758 #define pci_map_single(_hwdev, _ptr, _size, _dir) \ 759 dma_map_single((_hwdev) == NULL ? NULL : &(_hwdev->dev), \ 760 (_ptr), (_size), (enum dma_data_direction)_dir) 761 #define pci_unmap_single(_hwdev, _addr, _size, _dir) \ 762 dma_unmap_single((_hwdev) == NULL ? NULL : &(_hwdev)->dev, \ 763 _addr, _size, (enum dma_data_direction)_dir) 764 #define pci_unmap_sg(_hwdev, _sg, _nents, _dir) \ 765 dma_unmap_sg((_hwdev) == NULL ? NULL : &(_hwdev)->dev, \ 766 _sg, _nents, (enum dma_data_direction)_dir) 767 #define pci_map_page(_hwdev, _page, _offset, _size, _dir) \ 768 dma_map_page((_hwdev) == NULL ? NULL : &(_hwdev)->dev, _page,\ 769 _offset, _size, (enum dma_data_direction)_dir) 770 #define pci_unmap_page(_hwdev, _dma_address, _size, _dir) \ 771 dma_unmap_page((_hwdev) == NULL ? NULL : &(_hwdev)->dev, \ 772 _dma_address, _size, (enum dma_data_direction)_dir) 773 #define pci_set_dma_mask(_pdev, mask) dma_set_mask(&(_pdev)->dev, (mask)) 774 #define pci_dma_mapping_error(_pdev, _dma_addr) \ 775 dma_mapping_error(&(_pdev)->dev, _dma_addr) 776 #define pci_set_consistent_dma_mask(_pdev, _mask) \ 777 dma_set_coherent_mask(&(_pdev)->dev, (_mask)) 778 #define DECLARE_PCI_UNMAP_ADDR(x) DEFINE_DMA_UNMAP_ADDR(x); 779 #define DECLARE_PCI_UNMAP_LEN(x) DEFINE_DMA_UNMAP_LEN(x); 780 #define pci_unmap_addr dma_unmap_addr 781 #define pci_unmap_addr_set dma_unmap_addr_set 782 #define pci_unmap_len dma_unmap_len 783 #define pci_unmap_len_set dma_unmap_len_set 784 785 typedef unsigned int __bitwise pci_channel_state_t; 786 typedef unsigned int __bitwise pci_ers_result_t; 787 788 enum pci_channel_state { 789 pci_channel_io_normal = 1, 790 pci_channel_io_frozen = 2, 791 pci_channel_io_perm_failure = 3, 792 }; 793 794 enum pci_ers_result { 795 PCI_ERS_RESULT_NONE = 1, 796 PCI_ERS_RESULT_CAN_RECOVER = 2, 797 PCI_ERS_RESULT_NEED_RESET = 3, 798 PCI_ERS_RESULT_DISCONNECT = 4, 799 PCI_ERS_RESULT_RECOVERED = 5, 800 }; 801 802 /* PCI bus error event callbacks */ 803 struct pci_error_handlers { 804 pci_ers_result_t (*error_detected)(struct pci_dev *dev, 805 enum pci_channel_state error); 806 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev); 807 pci_ers_result_t (*link_reset)(struct pci_dev *dev); 808 pci_ers_result_t (*slot_reset)(struct pci_dev *dev); 809 void (*resume)(struct pci_dev *dev); 810 }; 811 812 /* FreeBSD does not support SRIOV - yet */ 813 static inline struct pci_dev *pci_physfn(struct pci_dev *dev) 814 { 815 return dev; 816 } 817 818 static inline bool pci_is_pcie(struct pci_dev *dev) 819 { 820 return !!pci_pcie_cap(dev); 821 } 822 823 static inline u16 pcie_flags_reg(struct pci_dev *dev) 824 { 825 int pos; 826 u16 reg16; 827 828 pos = pci_find_capability(dev, PCI_CAP_ID_EXP); 829 if (!pos) 830 return 0; 831 832 pci_read_config_word(dev, pos + PCI_EXP_FLAGS, ®16); 833 834 return reg16; 835 } 836 837 static inline int pci_pcie_type(struct pci_dev *dev) 838 { 839 return (pcie_flags_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4; 840 } 841 842 static inline int pcie_cap_version(struct pci_dev *dev) 843 { 844 return pcie_flags_reg(dev) & PCI_EXP_FLAGS_VERS; 845 } 846 847 static inline bool pcie_cap_has_lnkctl(struct pci_dev *dev) 848 { 849 int type = pci_pcie_type(dev); 850 851 return pcie_cap_version(dev) > 1 || 852 type == PCI_EXP_TYPE_ROOT_PORT || 853 type == PCI_EXP_TYPE_ENDPOINT || 854 type == PCI_EXP_TYPE_LEG_END; 855 } 856 857 static inline bool pcie_cap_has_devctl(const struct pci_dev *dev) 858 { 859 return true; 860 } 861 862 static inline bool pcie_cap_has_sltctl(struct pci_dev *dev) 863 { 864 int type = pci_pcie_type(dev); 865 866 return pcie_cap_version(dev) > 1 || type == PCI_EXP_TYPE_ROOT_PORT || 867 (type == PCI_EXP_TYPE_DOWNSTREAM && 868 pcie_flags_reg(dev) & PCI_EXP_FLAGS_SLOT); 869 } 870 871 static inline bool pcie_cap_has_rtctl(struct pci_dev *dev) 872 { 873 int type = pci_pcie_type(dev); 874 875 return pcie_cap_version(dev) > 1 || type == PCI_EXP_TYPE_ROOT_PORT || 876 type == PCI_EXP_TYPE_RC_EC; 877 } 878 879 static bool pcie_capability_reg_implemented(struct pci_dev *dev, int pos) 880 { 881 if (!pci_is_pcie(dev)) 882 return false; 883 884 switch (pos) { 885 case PCI_EXP_FLAGS_TYPE: 886 return true; 887 case PCI_EXP_DEVCAP: 888 case PCI_EXP_DEVCTL: 889 case PCI_EXP_DEVSTA: 890 return pcie_cap_has_devctl(dev); 891 case PCI_EXP_LNKCAP: 892 case PCI_EXP_LNKCTL: 893 case PCI_EXP_LNKSTA: 894 return pcie_cap_has_lnkctl(dev); 895 case PCI_EXP_SLTCAP: 896 case PCI_EXP_SLTCTL: 897 case PCI_EXP_SLTSTA: 898 return pcie_cap_has_sltctl(dev); 899 case PCI_EXP_RTCTL: 900 case PCI_EXP_RTCAP: 901 case PCI_EXP_RTSTA: 902 return pcie_cap_has_rtctl(dev); 903 case PCI_EXP_DEVCAP2: 904 case PCI_EXP_DEVCTL2: 905 case PCI_EXP_LNKCAP2: 906 case PCI_EXP_LNKCTL2: 907 case PCI_EXP_LNKSTA2: 908 return pcie_cap_version(dev) > 1; 909 default: 910 return false; 911 } 912 } 913 914 static inline int 915 pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *dst) 916 { 917 if (pos & 3) 918 return -EINVAL; 919 920 if (!pcie_capability_reg_implemented(dev, pos)) 921 return -EINVAL; 922 923 return pci_read_config_dword(dev, pci_pcie_cap(dev) + pos, dst); 924 } 925 926 static inline int 927 pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *dst) 928 { 929 if (pos & 3) 930 return -EINVAL; 931 932 if (!pcie_capability_reg_implemented(dev, pos)) 933 return -EINVAL; 934 935 return pci_read_config_word(dev, pci_pcie_cap(dev) + pos, dst); 936 } 937 938 static inline int 939 pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val) 940 { 941 if (pos & 1) 942 return -EINVAL; 943 944 if (!pcie_capability_reg_implemented(dev, pos)) 945 return 0; 946 947 return pci_write_config_word(dev, pci_pcie_cap(dev) + pos, val); 948 } 949 950 static inline int pcie_get_minimum_link(struct pci_dev *dev, 951 enum pci_bus_speed *speed, enum pcie_link_width *width) 952 { 953 *speed = PCI_SPEED_UNKNOWN; 954 *width = PCIE_LNK_WIDTH_UNKNOWN; 955 return (0); 956 } 957 958 static inline int 959 pci_num_vf(struct pci_dev *dev) 960 { 961 return (0); 962 } 963 964 static inline enum pci_bus_speed 965 pcie_get_speed_cap(struct pci_dev *dev) 966 { 967 device_t root; 968 uint32_t lnkcap, lnkcap2; 969 int error, pos; 970 971 root = device_get_parent(dev->dev.bsddev); 972 if (root == NULL) 973 return (PCI_SPEED_UNKNOWN); 974 root = device_get_parent(root); 975 if (root == NULL) 976 return (PCI_SPEED_UNKNOWN); 977 root = device_get_parent(root); 978 if (root == NULL) 979 return (PCI_SPEED_UNKNOWN); 980 981 if (pci_get_vendor(root) == PCI_VENDOR_ID_VIA || 982 pci_get_vendor(root) == PCI_VENDOR_ID_SERVERWORKS) 983 return (PCI_SPEED_UNKNOWN); 984 985 if ((error = pci_find_cap(root, PCIY_EXPRESS, &pos)) != 0) 986 return (PCI_SPEED_UNKNOWN); 987 988 lnkcap2 = pci_read_config(root, pos + PCIER_LINK_CAP2, 4); 989 990 if (lnkcap2) { /* PCIe r3.0-compliant */ 991 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_2_5GB) 992 return (PCIE_SPEED_2_5GT); 993 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_5_0GB) 994 return (PCIE_SPEED_5_0GT); 995 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_8_0GB) 996 return (PCIE_SPEED_8_0GT); 997 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_16_0GB) 998 return (PCIE_SPEED_16_0GT); 999 } else { /* pre-r3.0 */ 1000 lnkcap = pci_read_config(root, pos + PCIER_LINK_CAP, 4); 1001 if (lnkcap & PCI_EXP_LNKCAP_SLS_2_5GB) 1002 return (PCIE_SPEED_2_5GT); 1003 if (lnkcap & PCI_EXP_LNKCAP_SLS_5_0GB) 1004 return (PCIE_SPEED_5_0GT); 1005 if (lnkcap & PCI_EXP_LNKCAP_SLS_8_0GB) 1006 return (PCIE_SPEED_8_0GT); 1007 if (lnkcap & PCI_EXP_LNKCAP_SLS_16_0GB) 1008 return (PCIE_SPEED_16_0GT); 1009 } 1010 return (PCI_SPEED_UNKNOWN); 1011 } 1012 1013 static inline enum pcie_link_width 1014 pcie_get_width_cap(struct pci_dev *dev) 1015 { 1016 uint32_t lnkcap; 1017 1018 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap); 1019 if (lnkcap) 1020 return ((lnkcap & PCI_EXP_LNKCAP_MLW) >> 4); 1021 1022 return (PCIE_LNK_WIDTH_UNKNOWN); 1023 } 1024 1025 static inline int 1026 pcie_get_mps(struct pci_dev *dev) 1027 { 1028 return (pci_get_max_payload(dev->dev.bsddev)); 1029 } 1030 1031 static inline uint32_t 1032 PCIE_SPEED2MBS_ENC(enum pci_bus_speed spd) 1033 { 1034 1035 switch(spd) { 1036 case PCIE_SPEED_16_0GT: 1037 return (16000 * 128 / 130); 1038 case PCIE_SPEED_8_0GT: 1039 return (8000 * 128 / 130); 1040 case PCIE_SPEED_5_0GT: 1041 return (5000 * 8 / 10); 1042 case PCIE_SPEED_2_5GT: 1043 return (2500 * 8 / 10); 1044 default: 1045 return (0); 1046 } 1047 } 1048 1049 static inline uint32_t 1050 pcie_bandwidth_available(struct pci_dev *pdev, 1051 struct pci_dev **limiting, 1052 enum pci_bus_speed *speed, 1053 enum pcie_link_width *width) 1054 { 1055 enum pci_bus_speed nspeed = pcie_get_speed_cap(pdev); 1056 enum pcie_link_width nwidth = pcie_get_width_cap(pdev); 1057 1058 if (speed) 1059 *speed = nspeed; 1060 if (width) 1061 *width = nwidth; 1062 1063 return (nwidth * PCIE_SPEED2MBS_ENC(nspeed)); 1064 } 1065 1066 /* 1067 * The following functions can be used to attach/detach the LinuxKPI's 1068 * PCI device runtime. The pci_driver and pci_device_id pointer is 1069 * allowed to be NULL. Other pointers must be all valid. 1070 * The pci_dev structure should be zero-initialized before passed 1071 * to the linux_pci_attach_device function. 1072 */ 1073 extern int linux_pci_attach_device(device_t, struct pci_driver *, 1074 const struct pci_device_id *, struct pci_dev *); 1075 extern int linux_pci_detach_device(struct pci_dev *); 1076 1077 static inline int 1078 pci_dev_present(const struct pci_device_id *cur) 1079 { 1080 while (cur != NULL && (cur->vendor || cur->device)) { 1081 if (pci_find_device(cur->vendor, cur->device) != NULL) { 1082 return (1); 1083 } 1084 cur++; 1085 } 1086 return (0); 1087 } 1088 1089 static inline bool 1090 pci_is_root_bus(struct pci_bus *pbus) 1091 { 1092 1093 return (pbus->self == NULL); 1094 } 1095 1096 struct pci_dev *lkpi_pci_get_domain_bus_and_slot(int domain, 1097 unsigned int bus, unsigned int devfn); 1098 #define pci_get_domain_bus_and_slot(domain, bus, devfn) \ 1099 lkpi_pci_get_domain_bus_and_slot(domain, bus, devfn) 1100 1101 static inline int 1102 pci_domain_nr(struct pci_bus *pbus) 1103 { 1104 1105 return (pbus->domain); 1106 } 1107 1108 static inline int 1109 pci_bus_read_config(struct pci_bus *bus, unsigned int devfn, 1110 int pos, uint32_t *val, int len) 1111 { 1112 1113 *val = pci_read_config(bus->self->dev.bsddev, pos, len); 1114 return (0); 1115 } 1116 1117 static inline int 1118 pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn, int pos, u16 *val) 1119 { 1120 uint32_t tmp; 1121 int ret; 1122 1123 ret = pci_bus_read_config(bus, devfn, pos, &tmp, 2); 1124 *val = (u16)tmp; 1125 return (ret); 1126 } 1127 1128 static inline int 1129 pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn, int pos, u8 *val) 1130 { 1131 uint32_t tmp; 1132 int ret; 1133 1134 ret = pci_bus_read_config(bus, devfn, pos, &tmp, 1); 1135 *val = (u8)tmp; 1136 return (ret); 1137 } 1138 1139 static inline int 1140 pci_bus_write_config(struct pci_bus *bus, unsigned int devfn, int pos, 1141 uint32_t val, int size) 1142 { 1143 1144 pci_write_config(bus->self->dev.bsddev, pos, val, size); 1145 return (0); 1146 } 1147 1148 static inline int 1149 pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn, int pos, 1150 uint8_t val) 1151 { 1152 return (pci_bus_write_config(bus, devfn, pos, val, 1)); 1153 } 1154 1155 static inline int 1156 pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn, int pos, 1157 uint16_t val) 1158 { 1159 return (pci_bus_write_config(bus, devfn, pos, val, 2)); 1160 } 1161 1162 struct pci_dev *lkpi_pci_get_class(unsigned int class, struct pci_dev *from); 1163 #define pci_get_class(class, from) lkpi_pci_get_class(class, from) 1164 1165 #endif /* _LINUX_PCI_H_ */ 1166