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 * Copyright (c) 2020-2025 The FreeBSD Foundation 8 * 9 * Portions of this software were developed by Björn Zeeb 10 * under sponsorship from the FreeBSD Foundation. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice unmodified, this list of conditions, and the following 17 * disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 #ifndef _LINUXKPI_LINUX_PCI_H_ 34 #define _LINUXKPI_LINUX_PCI_H_ 35 36 #define CONFIG_PCI_MSI 37 38 #include <linux/types.h> 39 #include <linux/device/driver.h> 40 41 #include <sys/param.h> 42 #include <sys/bus.h> 43 #include <sys/module.h> 44 #include <sys/nv.h> 45 #include <sys/pciio.h> 46 #include <dev/pci/pcivar.h> 47 #include <dev/pci/pcireg.h> 48 #include <dev/pci/pci_private.h> 49 50 #include <machine/resource.h> 51 52 #include <linux/list.h> 53 #include <linux/dmapool.h> 54 #include <linux/dma-mapping.h> 55 #include <linux/compiler.h> 56 #include <linux/errno.h> 57 #include <asm/atomic.h> 58 #include <asm/memtype.h> 59 #include <linux/device.h> 60 #include <linux/pci_ids.h> 61 #include <linux/pm.h> 62 63 /* 64 * <linux/ioport.h> should be included here, like Linux, but we can't have that 65 * because Linux `struct resource` definition would conflict with FreeBSD 66 * native definition. 67 * 68 * At least the amdgpu DRM driver (amdgpu_isp.c at the time of this writing) 69 * relies on this indirect include to get the definition of Linux `struct 70 * resource`. As a workaround, we include <linux/ioport.h> from 71 * <linux/mfd/core.h>. 72 */ 73 74 #include <linux/kernel.h> /* pr_debug */ 75 76 struct pci_device_id { 77 uint32_t vendor; 78 uint32_t device; 79 uint32_t subvendor; 80 uint32_t subdevice; 81 uint32_t class; 82 uint32_t class_mask; 83 uintptr_t driver_data; 84 }; 85 86 #define MODULE_DEVICE_TABLE_BUS_pci(_bus, _table) \ 87 MODULE_PNP_INFO("U32:vendor;U32:device;V32:subvendor;V32:subdevice", \ 88 _bus, lkpi_ ## _table, _table, nitems(_table) - 1) 89 90 #define PCI_ANY_ID -1U 91 92 #define PCI_DEVFN(slot, func) ((((slot) & 0x1f) << 3) | ((func) & 0x07)) 93 #define PCI_SLOT(devfn) (((devfn) >> 3) & 0x1f) 94 #define PCI_FUNC(devfn) ((devfn) & 0x07) 95 #define PCI_BUS_NUM(devfn) (((devfn) >> 8) & 0xff) 96 #define PCI_DEVID(bus, devfn) ((((uint16_t)(bus)) << 8) | (devfn)) 97 98 #define PCI_VDEVICE(_vendor, _device) \ 99 .vendor = PCI_VENDOR_ID_##_vendor, .device = (_device), \ 100 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID 101 #define PCI_DEVICE(_vendor, _device) \ 102 .vendor = (_vendor), .device = (_device), \ 103 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID 104 105 #define to_pci_dev(n) container_of(n, struct pci_dev, dev) 106 107 #define PCI_STD_NUM_BARS 6 108 #define PCI_BASE_ADDRESS_0 PCIR_BARS 109 #define PCI_BASE_ADDRESS_MEM_TYPE_64 PCIM_BAR_MEM_64 110 #define PCI_VENDOR_ID PCIR_VENDOR 111 #define PCI_DEVICE_ID PCIR_DEVICE 112 #define PCI_COMMAND PCIR_COMMAND 113 #define PCI_COMMAND_INTX_DISABLE PCIM_CMD_INTxDIS 114 #define PCI_COMMAND_MEMORY PCIM_CMD_MEMEN 115 #define PCI_PRIMARY_BUS PCIR_PRIBUS_1 116 #define PCI_SECONDARY_BUS PCIR_SECBUS_1 117 #define PCI_SUBORDINATE_BUS PCIR_SUBBUS_1 118 #define PCI_SEC_LATENCY_TIMER PCIR_SECLAT_1 119 #define PCI_EXP_DEVCTL PCIER_DEVICE_CTL /* Device Control */ 120 #define PCI_EXP_LNKCTL PCIER_LINK_CTL /* Link Control */ 121 #define PCI_EXP_LNKCTL_ASPM_L0S PCIEM_LINK_CTL_ASPMC_L0S 122 #define PCI_EXP_LNKCTL_ASPM_L1 PCIEM_LINK_CTL_ASPMC_L1 123 #define PCI_EXP_LNKCTL_ASPMC PCIEM_LINK_CTL_ASPMC 124 #define PCI_EXP_LNKCTL_CLKREQ_EN PCIEM_LINK_CTL_ECPM /* Enable clock PM */ 125 #define PCI_EXP_LNKCTL_HAWD PCIEM_LINK_CTL_HAWD 126 #define PCI_EXP_FLAGS_TYPE PCIEM_FLAGS_TYPE /* Device/Port type */ 127 #define PCI_EXP_DEVCAP PCIER_DEVICE_CAP /* Device capabilities */ 128 #define PCI_EXP_DEVSTA PCIER_DEVICE_STA /* Device Status */ 129 #define PCI_EXP_LNKCAP PCIER_LINK_CAP /* Link Capabilities */ 130 #define PCI_EXP_LNKSTA PCIER_LINK_STA /* Link Status */ 131 #define PCI_EXP_SLTCAP PCIER_SLOT_CAP /* Slot Capabilities */ 132 #define PCI_EXP_SLTCTL PCIER_SLOT_CTL /* Slot Control */ 133 #define PCI_EXP_SLTSTA PCIER_SLOT_STA /* Slot Status */ 134 #define PCI_EXP_RTCTL PCIER_ROOT_CTL /* Root Control */ 135 #define PCI_EXP_RTCAP PCIER_ROOT_CAP /* Root Capabilities */ 136 #define PCI_EXP_RTSTA PCIER_ROOT_STA /* Root Status */ 137 #define PCI_EXP_DEVCAP2 PCIER_DEVICE_CAP2 /* Device Capabilities 2 */ 138 #define PCI_EXP_DEVCTL2 PCIER_DEVICE_CTL2 /* Device Control 2 */ 139 #define PCI_EXP_DEVCTL2_LTR_EN PCIEM_CTL2_LTR_ENABLE 140 #define PCI_EXP_DEVCTL2_COMP_TMOUT_DIS PCIEM_CTL2_COMP_TIMO_DISABLE 141 #define PCI_EXP_LNKCAP2 PCIER_LINK_CAP2 /* Link Capabilities 2 */ 142 #define PCI_EXP_LNKCTL2 PCIER_LINK_CTL2 /* Link Control 2 */ 143 #define PCI_EXP_LNKSTA2 PCIER_LINK_STA2 /* Link Status 2 */ 144 #define PCI_EXP_FLAGS PCIER_FLAGS /* Capabilities register */ 145 #define PCI_EXP_FLAGS_VERS PCIEM_FLAGS_VERSION /* Capability version */ 146 #define PCI_EXP_TYPE_ROOT_PORT PCIEM_TYPE_ROOT_PORT /* Root Port */ 147 #define PCI_EXP_TYPE_ENDPOINT PCIEM_TYPE_ENDPOINT /* Express Endpoint */ 148 #define PCI_EXP_TYPE_LEG_END PCIEM_TYPE_LEGACY_ENDPOINT /* Legacy Endpoint */ 149 #define PCI_EXP_TYPE_DOWNSTREAM PCIEM_TYPE_DOWNSTREAM_PORT /* Downstream Port */ 150 #define PCI_EXP_FLAGS_SLOT PCIEM_FLAGS_SLOT /* Slot implemented */ 151 #define PCI_EXP_TYPE_RC_EC PCIEM_TYPE_ROOT_EC /* Root Complex Event Collector */ 152 #define PCI_EXP_LNKSTA_CLS PCIEM_LINK_STA_SPEED 153 #define PCI_EXP_LNKSTA_CLS_8_0GB 0x0003 /* Current Link Speed 8.0GT/s */ 154 #define PCI_EXP_LNKCAP_SLS_2_5GB 0x01 /* Supported Link Speed 2.5GT/s */ 155 #define PCI_EXP_LNKCAP_SLS_5_0GB 0x02 /* Supported Link Speed 5.0GT/s */ 156 #define PCI_EXP_LNKCAP_SLS_8_0GB 0x03 /* Supported Link Speed 8.0GT/s */ 157 #define PCI_EXP_LNKCAP_SLS_16_0GB 0x04 /* Supported Link Speed 16.0GT/s */ 158 #define PCI_EXP_LNKCAP_SLS_32_0GB 0x05 /* Supported Link Speed 32.0GT/s */ 159 #define PCI_EXP_LNKCAP_SLS_64_0GB 0x06 /* Supported Link Speed 64.0GT/s */ 160 #define PCI_EXP_LNKCAP_MLW 0x03f0 /* Maximum Link Width */ 161 #define PCI_EXP_LNKCAP2_SLS_2_5GB 0x02 /* Supported Link Speed 2.5GT/s */ 162 #define PCI_EXP_LNKCAP2_SLS_5_0GB 0x04 /* Supported Link Speed 5.0GT/s */ 163 #define PCI_EXP_LNKCAP2_SLS_8_0GB 0x08 /* Supported Link Speed 8.0GT/s */ 164 #define PCI_EXP_LNKCAP2_SLS_16_0GB 0x10 /* Supported Link Speed 16.0GT/s */ 165 #define PCI_EXP_LNKCAP2_SLS_32_0GB 0x20 /* Supported Link Speed 32.0GT/s */ 166 #define PCI_EXP_LNKCAP2_SLS_64_0GB 0x40 /* Supported Link Speed 64.0GT/s */ 167 #define PCI_EXP_LNKCTL2_TLS 0x000f 168 #define PCI_EXP_LNKCTL2_TLS_2_5GT 0x0001 /* Supported Speed 2.5GT/s */ 169 #define PCI_EXP_LNKCTL2_TLS_5_0GT 0x0002 /* Supported Speed 5GT/s */ 170 #define PCI_EXP_LNKCTL2_TLS_8_0GT 0x0003 /* Supported Speed 8GT/s */ 171 #define PCI_EXP_LNKCTL2_TLS_16_0GT 0x0004 /* Supported Speed 16GT/s */ 172 #define PCI_EXP_LNKCTL2_TLS_32_0GT 0x0005 /* Supported Speed 32GT/s */ 173 #define PCI_EXP_LNKCTL2_TLS_64_0GT 0x0006 /* Supported Speed 64GT/s */ 174 #define PCI_EXP_LNKCTL2_ENTER_COMP 0x0010 /* Enter Compliance */ 175 #define PCI_EXP_LNKCTL2_TX_MARGIN 0x0380 /* Transmit Margin */ 176 177 #define PCI_MSI_ADDRESS_LO PCIR_MSI_ADDR 178 #define PCI_MSI_ADDRESS_HI PCIR_MSI_ADDR_HIGH 179 #define PCI_MSI_FLAGS PCIR_MSI_CTRL 180 #define PCI_MSI_FLAGS_ENABLE PCIM_MSICTRL_MSI_ENABLE 181 #define PCI_MSIX_FLAGS PCIR_MSIX_CTRL 182 #define PCI_MSIX_FLAGS_ENABLE PCIM_MSIXCTRL_MSIX_ENABLE 183 184 #define PCI_EXP_LNKCAP_CLKPM 0x00040000 185 #define PCI_EXP_DEVSTA_TRPND 0x0020 186 187 #define IORESOURCE_MEM (1 << SYS_RES_MEMORY) 188 #define IORESOURCE_IO (1 << SYS_RES_IOPORT) 189 #define IORESOURCE_IRQ (1 << SYS_RES_IRQ) 190 191 enum pci_bus_speed { 192 PCI_SPEED_UNKNOWN = -1, 193 PCIE_SPEED_2_5GT, 194 PCIE_SPEED_5_0GT, 195 PCIE_SPEED_8_0GT, 196 PCIE_SPEED_16_0GT, 197 PCIE_SPEED_32_0GT, 198 PCIE_SPEED_64_0GT, 199 }; 200 201 enum pcie_link_width { 202 PCIE_LNK_WIDTH_RESRV = 0x00, 203 PCIE_LNK_X1 = 0x01, 204 PCIE_LNK_X2 = 0x02, 205 PCIE_LNK_X4 = 0x04, 206 PCIE_LNK_X8 = 0x08, 207 PCIE_LNK_X12 = 0x0c, 208 PCIE_LNK_X16 = 0x10, 209 PCIE_LNK_X32 = 0x20, 210 PCIE_LNK_WIDTH_UNKNOWN = 0xff, 211 }; 212 213 #define PCIE_LINK_STATE_L0S 0x00000001 214 #define PCIE_LINK_STATE_L1 0x00000002 215 #define PCIE_LINK_STATE_CLKPM 0x00000004 216 217 typedef int pci_power_t; 218 219 #define PCI_D0 PCI_POWERSTATE_D0 220 #define PCI_D1 PCI_POWERSTATE_D1 221 #define PCI_D2 PCI_POWERSTATE_D2 222 #define PCI_D3hot PCI_POWERSTATE_D3_HOT 223 #define PCI_D3cold PCI_POWERSTATE_D3_COLD 224 225 #define PCI_POWER_ERROR PCI_POWERSTATE_UNKNOWN 226 227 extern const char *pci_power_names[6]; 228 229 #define PCI_ERR_UNCOR_STATUS PCIR_AER_UC_STATUS 230 #define PCI_ERR_COR_STATUS PCIR_AER_COR_STATUS 231 #define PCI_ERR_ROOT_COMMAND PCIR_AER_ROOTERR_CMD 232 #define PCI_ERR_ROOT_ERR_SRC PCIR_AER_COR_SOURCE_ID 233 234 #define PCI_EXT_CAP_ID_ERR PCIZ_AER 235 #define PCI_EXT_CAP_ID_L1SS PCIZ_L1PM 236 237 #define PCI_L1SS_CTL1 0x8 238 #define PCI_L1SS_CTL1_L1SS_MASK 0xf 239 240 #define PCI_IRQ_INTX 0x01 241 #define PCI_IRQ_MSI 0x02 242 #define PCI_IRQ_MSIX 0x04 243 #define PCI_IRQ_ALL_TYPES (PCI_IRQ_MSIX|PCI_IRQ_MSI|PCI_IRQ_INTX) 244 245 #if defined(LINUXKPI_VERSION) && (LINUXKPI_VERSION <= 61000) 246 #define PCI_IRQ_LEGACY PCI_IRQ_INTX 247 #endif 248 249 /* 250 * Linux PCI code uses `PCI_SET_ERROR_RESPONSE()` to indicate to the caller of 251 * a `pci_read_*()` function that the read failed. An example of failure is 252 * whether the device was disconnected. It is a bit weird because Linux 253 * `pci_read_*()` can return an error value, as the read value is stored in a 254 * integer passed by pointer. 255 * 256 * We don't set PCI_ERROR_RESPONSE anywhere as of this commit, but the DRM 257 * drivers started to use `PCI_POSSIBLE_ERROR()`. 258 */ 259 #define PCI_ERROR_RESPONSE (~0ULL) 260 #define PCI_SET_ERROR_RESPONSE(val) (*(val) = ((typeof(*(val))) PCI_ERROR_RESPONSE)) 261 #define PCI_POSSIBLE_ERROR(val) ((val) == ((typeof(val)) PCI_ERROR_RESPONSE)) 262 263 struct pci_dev; 264 265 struct pci_driver { 266 struct list_head node; 267 char *name; 268 const struct pci_device_id *id_table; 269 int (*probe)(struct pci_dev *dev, const struct pci_device_id *id); 270 void (*remove)(struct pci_dev *dev); 271 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */ 272 int (*resume) (struct pci_dev *dev); /* Device woken up */ 273 void (*shutdown) (struct pci_dev *dev); /* Device shutdown */ 274 driver_t bsddriver; 275 devclass_t bsdclass; 276 struct device_driver driver; 277 const struct pci_error_handlers *err_handler; 278 bool isdrm; 279 int bsd_probe_return; 280 int (*bsd_iov_init)(device_t dev, uint16_t num_vfs, 281 const nvlist_t *pf_config); 282 void (*bsd_iov_uninit)(device_t dev); 283 int (*bsd_iov_add_vf)(device_t dev, uint16_t vfnum, 284 const nvlist_t *vf_config); 285 }; 286 287 struct pci_bus { 288 struct pci_dev *self; 289 /* struct pci_bus *parent */ 290 int domain; 291 int number; 292 }; 293 294 extern struct list_head pci_drivers; 295 extern struct list_head pci_devices; 296 extern spinlock_t pci_lock; 297 298 #define __devexit_p(x) x 299 300 #define module_pci_driver(_drv) \ 301 module_driver(_drv, linux_pci_register_driver, linux_pci_unregister_driver) 302 303 struct msi_msg { 304 uint32_t data; 305 }; 306 307 struct pci_msi_desc { 308 struct { 309 bool is_64; 310 } msi_attrib; 311 }; 312 313 struct msi_desc { 314 struct msi_msg msg; 315 struct pci_msi_desc pci; 316 }; 317 318 struct msix_entry { 319 int entry; 320 int vector; 321 }; 322 323 /* 324 * If we find drivers accessing this from multiple KPIs we may have to 325 * refcount objects of this structure. 326 */ 327 struct resource; 328 struct pci_mmio_region { 329 TAILQ_ENTRY(pci_mmio_region) next; 330 struct resource *res; 331 int rid; 332 int type; 333 }; 334 335 struct pci_dev { 336 struct device dev; 337 struct list_head links; 338 struct pci_driver *pdrv; 339 struct pci_bus *bus; 340 struct pci_dev *root; 341 pci_power_t current_state; 342 uint16_t device; 343 uint16_t vendor; 344 uint16_t subsystem_vendor; 345 uint16_t subsystem_device; 346 unsigned int irq; 347 unsigned int devfn; 348 uint32_t class; 349 uint8_t revision; 350 uint8_t msi_cap; 351 uint8_t msix_cap; 352 bool managed; /* devres "pcim_*(). */ 353 bool want_iomap_res; 354 bool msi_enabled; 355 bool msix_enabled; 356 phys_addr_t rom; 357 size_t romlen; 358 struct msi_desc **msi_desc; 359 char *path_name; 360 spinlock_t pcie_cap_lock; 361 362 TAILQ_HEAD(, pci_mmio_region) mmio; 363 }; 364 365 int pci_alloc_irq_vectors(struct pci_dev *pdev, int minv, int maxv, 366 unsigned int flags); 367 bool pci_device_is_present(struct pci_dev *pdev); 368 369 int linuxkpi_pcim_enable_device(struct pci_dev *pdev); 370 void __iomem **linuxkpi_pcim_iomap_table(struct pci_dev *pdev); 371 void *linuxkpi_pci_iomap_range(struct pci_dev *, int, 372 unsigned long, unsigned long); 373 void *linuxkpi_pci_iomap(struct pci_dev *, int, unsigned long); 374 void *linuxkpi_pcim_iomap(struct pci_dev *, int, unsigned long); 375 void linuxkpi_pci_iounmap(struct pci_dev *pdev, void *res); 376 int linuxkpi_pcim_iomap_regions(struct pci_dev *pdev, uint32_t mask, 377 const char *name); 378 int linuxkpi_pci_request_region(struct pci_dev *, int, const char *); 379 int linuxkpi_pci_request_regions(struct pci_dev *pdev, const char *res_name); 380 int linuxkpi_pcim_request_all_regions(struct pci_dev *, const char *); 381 void linuxkpi_pci_release_region(struct pci_dev *pdev, int bar); 382 void linuxkpi_pci_release_regions(struct pci_dev *pdev); 383 int linuxkpi_pci_enable_msix(struct pci_dev *pdev, struct msix_entry *entries, 384 int nreq); 385 386 /* Internal helper function(s). */ 387 struct pci_dev *lkpinew_pci_dev(device_t); 388 void lkpi_pci_devres_release(struct device *, void *); 389 struct pci_dev *lkpi_pci_get_device(uint32_t, uint32_t, struct pci_dev *); 390 struct msi_desc *lkpi_pci_msi_desc_alloc(int); 391 struct device *lkpi_pci_find_irq_dev(unsigned int irq); 392 int _lkpi_pci_enable_msi_range(struct pci_dev *pdev, int minvec, int maxvec); 393 394 #define pci_err(pdev, fmt, ...) \ 395 dev_err(&(pdev)->dev, fmt, ##__VA_ARGS__) 396 #define pci_info(pdev, fmt, ...) \ 397 dev_info(&(pdev)->dev, fmt, ##__VA_ARGS__) 398 399 static inline bool 400 dev_is_pci(struct device *dev) 401 { 402 return (is_pci_device(dev->bsddev)); 403 } 404 405 static inline uint16_t 406 pci_dev_id(struct pci_dev *pdev) 407 { 408 return (PCI_DEVID(pdev->bus->number, pdev->devfn)); 409 } 410 411 static inline int 412 pci_resource_type(struct pci_dev *pdev, int bar) 413 { 414 struct pci_map *pm; 415 416 pm = pci_find_bar(pdev->dev.bsddev, PCIR_BAR(bar)); 417 if (!pm) 418 return (-1); 419 420 if (PCI_BAR_IO(pm->pm_value)) 421 return (SYS_RES_IOPORT); 422 else 423 return (SYS_RES_MEMORY); 424 } 425 426 /* 427 * All drivers just seem to want to inspect the type not flags. 428 */ 429 static inline int 430 pci_resource_flags(struct pci_dev *pdev, int bar) 431 { 432 int type; 433 434 type = pci_resource_type(pdev, bar); 435 if (type < 0) 436 return (0); 437 return (1 << type); 438 } 439 440 static inline const char * 441 pci_name(struct pci_dev *d) 442 { 443 return d->path_name; 444 } 445 446 static inline void * 447 pci_get_drvdata(struct pci_dev *pdev) 448 { 449 450 return dev_get_drvdata(&pdev->dev); 451 } 452 453 static inline void 454 pci_set_drvdata(struct pci_dev *pdev, void *data) 455 { 456 457 dev_set_drvdata(&pdev->dev, data); 458 } 459 460 static inline struct pci_dev * 461 pci_dev_get(struct pci_dev *pdev) 462 { 463 464 if (pdev != NULL) 465 get_device(&pdev->dev); 466 return (pdev); 467 } 468 469 static __inline void 470 pci_dev_put(struct pci_dev *pdev) 471 { 472 473 if (pdev != NULL) 474 put_device(&pdev->dev); 475 } 476 477 static inline int 478 pci_enable_device(struct pci_dev *pdev) 479 { 480 481 pci_enable_io(pdev->dev.bsddev, SYS_RES_IOPORT); 482 pci_enable_io(pdev->dev.bsddev, SYS_RES_MEMORY); 483 return (0); 484 } 485 486 static inline void 487 pci_disable_device(struct pci_dev *pdev) 488 { 489 490 pci_disable_busmaster(pdev->dev.bsddev); 491 } 492 493 static inline int 494 pci_set_master(struct pci_dev *pdev) 495 { 496 497 pci_enable_busmaster(pdev->dev.bsddev); 498 return (0); 499 } 500 501 static inline int 502 pci_set_power_state(struct pci_dev *pdev, int state) 503 { 504 505 pci_set_powerstate(pdev->dev.bsddev, state); 506 return (0); 507 } 508 509 static inline int 510 pci_clear_master(struct pci_dev *pdev) 511 { 512 513 pci_disable_busmaster(pdev->dev.bsddev); 514 return (0); 515 } 516 517 static inline bool 518 pci_is_root_bus(struct pci_bus *pbus) 519 { 520 521 return (pbus->self == NULL); 522 } 523 524 static inline struct pci_dev * 525 pci_upstream_bridge(struct pci_dev *pdev) 526 { 527 528 if (pci_is_root_bus(pdev->bus)) 529 return (NULL); 530 531 /* 532 * If we do not have a (proper) "upstream bridge" set, e.g., we point 533 * to ourselves, try to handle this case on the fly like we do 534 * for pcie_find_root_port(). 535 */ 536 if (pdev == pdev->bus->self) { 537 device_t bridge; 538 539 /* 540 * In the case of DRM drivers, the passed device is a child of 541 * `vgapci`. We want to start the lookup from `vgapci`, so the 542 * parent of the passed `drmn`. 543 * 544 * We can use the `isdrm` flag to determine this. 545 */ 546 bridge = pdev->dev.bsddev; 547 if (pdev->pdrv != NULL && pdev->pdrv->isdrm) 548 bridge = device_get_parent(bridge); 549 if (bridge == NULL) 550 goto done; 551 552 bridge = device_get_parent(bridge); 553 if (bridge == NULL) 554 goto done; 555 bridge = device_get_parent(bridge); 556 if (bridge == NULL) 557 goto done; 558 if (!is_pci_device(bridge)) 559 goto done; 560 561 /* 562 * "bridge" is a PCI-to-PCI bridge. Create a Linux pci_dev 563 * for it so it can be returned. 564 */ 565 pdev->bus->self = lkpinew_pci_dev(bridge); 566 } 567 done: 568 return (pdev->bus->self); 569 } 570 571 #define pci_request_region(pdev, bar, res_name) \ 572 linuxkpi_pci_request_region(pdev, bar, res_name) 573 #define pci_release_region(pdev, bar) \ 574 linuxkpi_pci_release_region(pdev, bar) 575 #define pci_request_regions(pdev, res_name) \ 576 linuxkpi_pci_request_regions(pdev, res_name) 577 #define pci_release_regions(pdev) \ 578 linuxkpi_pci_release_regions(pdev) 579 #define pcim_request_all_regions(pdev, name) \ 580 linuxkpi_pcim_request_all_regions(pdev, name) 581 582 static inline void 583 lkpi_pci_disable_msix(struct pci_dev *pdev) 584 { 585 586 pci_release_msi(pdev->dev.bsddev); 587 588 /* 589 * The MSIX IRQ numbers associated with this PCI device are no 590 * longer valid and might be re-assigned. Make sure 591 * lkpi_pci_find_irq_dev() does no longer see them by 592 * resetting their references to zero: 593 */ 594 pdev->dev.irq_start = 0; 595 pdev->dev.irq_end = 0; 596 pdev->msix_enabled = false; 597 } 598 /* Only for consistency. No conflict on that one. */ 599 #define pci_disable_msix(pdev) lkpi_pci_disable_msix(pdev) 600 601 static inline void 602 lkpi_pci_disable_msi(struct pci_dev *pdev) 603 { 604 605 pci_release_msi(pdev->dev.bsddev); 606 607 pdev->dev.irq_start = 0; 608 pdev->dev.irq_end = 0; 609 pdev->irq = pdev->dev.irq; 610 pdev->msi_enabled = false; 611 } 612 #define pci_disable_msi(pdev) lkpi_pci_disable_msi(pdev) 613 #define pci_free_irq_vectors(pdev) lkpi_pci_disable_msi(pdev) 614 615 unsigned long pci_resource_start(struct pci_dev *pdev, int bar); 616 unsigned long pci_resource_len(struct pci_dev *pdev, int bar); 617 618 static inline bus_addr_t 619 pci_bus_address(struct pci_dev *pdev, int bar) 620 { 621 622 return (pci_resource_start(pdev, bar)); 623 } 624 625 #define PCI_CAP_ID_EXP PCIY_EXPRESS 626 #define PCI_CAP_ID_PCIX PCIY_PCIX 627 #define PCI_CAP_ID_AGP PCIY_AGP 628 #define PCI_CAP_ID_PM PCIY_PMG 629 630 #define PCI_EXP_DEVCTL PCIER_DEVICE_CTL 631 #define PCI_EXP_DEVCTL_PAYLOAD PCIEM_CTL_MAX_PAYLOAD 632 #define PCI_EXP_DEVCTL_READRQ PCIEM_CTL_MAX_READ_REQUEST 633 #define PCI_EXP_LNKCTL PCIER_LINK_CTL 634 #define PCI_EXP_LNKSTA PCIER_LINK_STA 635 636 static inline int 637 pci_find_capability(struct pci_dev *pdev, int capid) 638 { 639 int reg; 640 641 if (pci_find_cap(pdev->dev.bsddev, capid, ®)) 642 return (0); 643 return (reg); 644 } 645 646 static inline int pci_pcie_cap(struct pci_dev *dev) 647 { 648 return pci_find_capability(dev, PCI_CAP_ID_EXP); 649 } 650 651 static inline int 652 pci_find_ext_capability(struct pci_dev *pdev, int capid) 653 { 654 int reg; 655 656 if (pci_find_extcap(pdev->dev.bsddev, capid, ®)) 657 return (0); 658 return (reg); 659 } 660 661 static __inline bool 662 pci_pme_capable(struct pci_dev *pdev, pci_power_t state) 663 { 664 return (pci_has_pme(pdev->dev.bsddev, state)); 665 } 666 667 static inline int 668 pci_disable_link_state(struct pci_dev *pdev, uint32_t flags) 669 { 670 671 if (!pci_enable_aspm) 672 return (-EPERM); 673 674 return (-ENXIO); 675 } 676 677 static inline int 678 pci_read_config_byte(const struct pci_dev *pdev, int where, u8 *val) 679 { 680 681 *val = (u8)pci_read_config(pdev->dev.bsddev, where, 1); 682 return (0); 683 } 684 685 static inline int 686 pci_read_config_word(const struct pci_dev *pdev, int where, u16 *val) 687 { 688 689 *val = (u16)pci_read_config(pdev->dev.bsddev, where, 2); 690 return (0); 691 } 692 693 static inline int 694 pci_read_config_dword(const struct pci_dev *pdev, int where, u32 *val) 695 { 696 697 *val = (u32)pci_read_config(pdev->dev.bsddev, where, 4); 698 return (0); 699 } 700 701 static inline int 702 pci_write_config_byte(const struct pci_dev *pdev, int where, u8 val) 703 { 704 705 pci_write_config(pdev->dev.bsddev, where, val, 1); 706 return (0); 707 } 708 709 static inline int 710 pci_write_config_word(const struct pci_dev *pdev, int where, u16 val) 711 { 712 713 pci_write_config(pdev->dev.bsddev, where, val, 2); 714 return (0); 715 } 716 717 static inline int 718 pci_write_config_dword(const struct pci_dev *pdev, int where, u32 val) 719 { 720 721 pci_write_config(pdev->dev.bsddev, where, val, 4); 722 return (0); 723 } 724 725 int linux_pci_register_driver(struct pci_driver *pdrv); 726 int linux_pci_register_drm_driver(struct pci_driver *pdrv); 727 void linux_pci_unregister_driver(struct pci_driver *pdrv); 728 void linux_pci_unregister_drm_driver(struct pci_driver *pdrv); 729 730 #define pci_register_driver(pdrv) \ 731 linux_pci_register_driver(pdrv) 732 #define pci_unregister_driver(pdrv) \ 733 linux_pci_unregister_driver(pdrv) 734 735 /* 736 * Enable msix, positive errors indicate actual number of available 737 * vectors. Negative errors are failures. 738 * 739 * NB: define added to prevent this definition of pci_enable_msix from 740 * clashing with the native FreeBSD version. 741 */ 742 #define pci_enable_msix(...) \ 743 linuxkpi_pci_enable_msix(__VA_ARGS__) 744 745 #define pci_enable_msix_range(...) \ 746 linux_pci_enable_msix_range(__VA_ARGS__) 747 748 static inline int 749 pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries, 750 int minvec, int maxvec) 751 { 752 int nvec = maxvec; 753 int rc; 754 755 if (maxvec < minvec) 756 return (-ERANGE); 757 758 do { 759 rc = pci_enable_msix(dev, entries, nvec); 760 if (rc < 0) { 761 return (rc); 762 } else if (rc > 0) { 763 if (rc < minvec) 764 return (-ENOSPC); 765 nvec = rc; 766 } 767 } while (rc); 768 return (nvec); 769 } 770 771 #define pci_enable_msi(pdev) \ 772 linux_pci_enable_msi(pdev) 773 774 static inline int 775 pci_enable_msi(struct pci_dev *pdev) 776 { 777 778 return (_lkpi_pci_enable_msi_range(pdev, 1, 1)); 779 } 780 781 static inline int 782 pci_channel_offline(struct pci_dev *pdev) 783 { 784 785 return (pci_read_config(pdev->dev.bsddev, PCIR_VENDOR, 2) == PCIV_INVALID); 786 } 787 788 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn) 789 { 790 return -ENODEV; 791 } 792 793 static inline void pci_disable_sriov(struct pci_dev *dev) 794 { 795 } 796 797 #define pci_iomap_range(pdev, mmio_bar, mmio_off, mmio_size) \ 798 linuxkpi_pci_iomap_range(pdev, mmio_bar, mmio_off, mmio_size) 799 #define pci_iomap(pdev, mmio_bar, mmio_size) \ 800 linuxkpi_pci_iomap(pdev, mmio_bar, mmio_size) 801 #define pcim_iomap(pdev, bar, maxlen) \ 802 linuxkpi_pcim_iomap(pdev, bar, maxlen) 803 #define pci_iounmap(pdev, res) \ 804 linuxkpi_pci_iounmap(pdev, res) 805 806 static inline void 807 lkpi_pci_save_state(struct pci_dev *pdev) 808 { 809 810 pci_save_state(pdev->dev.bsddev); 811 } 812 813 static inline void 814 lkpi_pci_restore_state(struct pci_dev *pdev) 815 { 816 817 pci_restore_state(pdev->dev.bsddev); 818 } 819 820 #define pci_save_state(dev) lkpi_pci_save_state(dev) 821 #define pci_restore_state(dev) lkpi_pci_restore_state(dev) 822 823 static inline int 824 linuxkpi_pci_enable_wake(struct pci_dev *pdev, pci_power_t state, bool ena) 825 { 826 /* 827 * We do not currently support this in device.h either to 828 * check if the device is allowed to wake up in first place. 829 */ 830 pr_debug("%s: TODO\n", __func__); 831 return (0); 832 } 833 #define pci_enable_wake(dev, state, ena) \ 834 linuxkpi_pci_enable_wake(dev, state, ena) 835 836 static inline int 837 pci_reset_function(struct pci_dev *pdev) 838 { 839 840 return (-ENOSYS); 841 } 842 843 #define DEFINE_PCI_DEVICE_TABLE(_table) \ 844 const struct pci_device_id _table[] __devinitdata 845 846 /* XXX This should not be necessary. */ 847 #define pcix_set_mmrbc(d, v) 0 848 #define pcix_get_max_mmrbc(d) 0 849 #define pcie_set_readrq(d, v) pci_set_max_read_req((d)->dev.bsddev, (v)) 850 851 #define PCI_DMA_BIDIRECTIONAL 0 852 #define PCI_DMA_TODEVICE 1 853 #define PCI_DMA_FROMDEVICE 2 854 #define PCI_DMA_NONE 3 855 856 #define pci_pool dma_pool 857 #define pci_pool_destroy(...) dma_pool_destroy(__VA_ARGS__) 858 #define pci_pool_alloc(...) dma_pool_alloc(__VA_ARGS__) 859 #define pci_pool_free(...) dma_pool_free(__VA_ARGS__) 860 #define pci_pool_create(_name, _pdev, _size, _align, _alloc) \ 861 dma_pool_create(_name, &(_pdev)->dev, _size, _align, _alloc) 862 #define pci_free_consistent(_hwdev, _size, _vaddr, _dma_handle) \ 863 dma_free_coherent((_hwdev) == NULL ? NULL : &(_hwdev)->dev, \ 864 _size, _vaddr, _dma_handle) 865 #define pci_map_sg(_hwdev, _sg, _nents, _dir) \ 866 dma_map_sg((_hwdev) == NULL ? NULL : &(_hwdev->dev), \ 867 _sg, _nents, (enum dma_data_direction)_dir) 868 #define pci_map_single(_hwdev, _ptr, _size, _dir) \ 869 dma_map_single((_hwdev) == NULL ? NULL : &(_hwdev->dev), \ 870 (_ptr), (_size), (enum dma_data_direction)_dir) 871 #define pci_unmap_single(_hwdev, _addr, _size, _dir) \ 872 dma_unmap_single((_hwdev) == NULL ? NULL : &(_hwdev)->dev, \ 873 _addr, _size, (enum dma_data_direction)_dir) 874 #define pci_unmap_sg(_hwdev, _sg, _nents, _dir) \ 875 dma_unmap_sg((_hwdev) == NULL ? NULL : &(_hwdev)->dev, \ 876 _sg, _nents, (enum dma_data_direction)_dir) 877 #define pci_map_page(_hwdev, _page, _offset, _size, _dir) \ 878 dma_map_page((_hwdev) == NULL ? NULL : &(_hwdev)->dev, _page,\ 879 _offset, _size, (enum dma_data_direction)_dir) 880 #define pci_unmap_page(_hwdev, _dma_address, _size, _dir) \ 881 dma_unmap_page((_hwdev) == NULL ? NULL : &(_hwdev)->dev, \ 882 _dma_address, _size, (enum dma_data_direction)_dir) 883 #define pci_set_dma_mask(_pdev, mask) dma_set_mask(&(_pdev)->dev, (mask)) 884 #define pci_dma_mapping_error(_pdev, _dma_addr) \ 885 dma_mapping_error(&(_pdev)->dev, _dma_addr) 886 #define pci_set_consistent_dma_mask(_pdev, _mask) \ 887 dma_set_coherent_mask(&(_pdev)->dev, (_mask)) 888 #define DECLARE_PCI_UNMAP_ADDR(x) DEFINE_DMA_UNMAP_ADDR(x); 889 #define DECLARE_PCI_UNMAP_LEN(x) DEFINE_DMA_UNMAP_LEN(x); 890 #define pci_unmap_addr dma_unmap_addr 891 #define pci_unmap_addr_set dma_unmap_addr_set 892 #define pci_unmap_len dma_unmap_len 893 #define pci_unmap_len_set dma_unmap_len_set 894 895 typedef unsigned int __bitwise pci_channel_state_t; 896 typedef unsigned int __bitwise pci_ers_result_t; 897 898 enum pci_channel_state { 899 pci_channel_io_normal = 1, 900 pci_channel_io_frozen = 2, 901 pci_channel_io_perm_failure = 3, 902 }; 903 904 enum pci_ers_result { 905 PCI_ERS_RESULT_NONE = 1, 906 PCI_ERS_RESULT_CAN_RECOVER = 2, 907 PCI_ERS_RESULT_NEED_RESET = 3, 908 PCI_ERS_RESULT_DISCONNECT = 4, 909 PCI_ERS_RESULT_RECOVERED = 5, 910 }; 911 912 /* PCI bus error event callbacks */ 913 struct pci_error_handlers { 914 pci_ers_result_t (*error_detected)(struct pci_dev *dev, 915 enum pci_channel_state error); 916 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev); 917 pci_ers_result_t (*link_reset)(struct pci_dev *dev); 918 pci_ers_result_t (*slot_reset)(struct pci_dev *dev); 919 void (*resume)(struct pci_dev *dev); 920 }; 921 922 /* FreeBSD does not support SRIOV - yet */ 923 static inline struct pci_dev *pci_physfn(struct pci_dev *dev) 924 { 925 return dev; 926 } 927 928 static inline bool pci_is_pcie(struct pci_dev *dev) 929 { 930 return !!pci_pcie_cap(dev); 931 } 932 933 static inline u16 pcie_flags_reg(struct pci_dev *dev) 934 { 935 int pos; 936 u16 reg16; 937 938 pos = pci_find_capability(dev, PCI_CAP_ID_EXP); 939 if (!pos) 940 return 0; 941 942 pci_read_config_word(dev, pos + PCI_EXP_FLAGS, ®16); 943 944 return reg16; 945 } 946 947 static inline int pci_pcie_type(struct pci_dev *dev) 948 { 949 return (pcie_flags_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4; 950 } 951 952 static inline int pcie_cap_version(struct pci_dev *dev) 953 { 954 return pcie_flags_reg(dev) & PCI_EXP_FLAGS_VERS; 955 } 956 957 static inline bool pcie_cap_has_lnkctl(struct pci_dev *dev) 958 { 959 int type = pci_pcie_type(dev); 960 961 return pcie_cap_version(dev) > 1 || 962 type == PCI_EXP_TYPE_ROOT_PORT || 963 type == PCI_EXP_TYPE_ENDPOINT || 964 type == PCI_EXP_TYPE_LEG_END; 965 } 966 967 static inline bool pcie_cap_has_devctl(const struct pci_dev *dev) 968 { 969 return true; 970 } 971 972 static inline bool pcie_cap_has_sltctl(struct pci_dev *dev) 973 { 974 int type = pci_pcie_type(dev); 975 976 return pcie_cap_version(dev) > 1 || type == PCI_EXP_TYPE_ROOT_PORT || 977 (type == PCI_EXP_TYPE_DOWNSTREAM && 978 pcie_flags_reg(dev) & PCI_EXP_FLAGS_SLOT); 979 } 980 981 static inline bool pcie_cap_has_rtctl(struct pci_dev *dev) 982 { 983 int type = pci_pcie_type(dev); 984 985 return pcie_cap_version(dev) > 1 || type == PCI_EXP_TYPE_ROOT_PORT || 986 type == PCI_EXP_TYPE_RC_EC; 987 } 988 989 static bool pcie_capability_reg_implemented(struct pci_dev *dev, int pos) 990 { 991 if (!pci_is_pcie(dev)) 992 return false; 993 994 switch (pos) { 995 case PCI_EXP_FLAGS_TYPE: 996 return true; 997 case PCI_EXP_DEVCAP: 998 case PCI_EXP_DEVCTL: 999 case PCI_EXP_DEVSTA: 1000 return pcie_cap_has_devctl(dev); 1001 case PCI_EXP_LNKCAP: 1002 case PCI_EXP_LNKCTL: 1003 case PCI_EXP_LNKSTA: 1004 return pcie_cap_has_lnkctl(dev); 1005 case PCI_EXP_SLTCAP: 1006 case PCI_EXP_SLTCTL: 1007 case PCI_EXP_SLTSTA: 1008 return pcie_cap_has_sltctl(dev); 1009 case PCI_EXP_RTCTL: 1010 case PCI_EXP_RTCAP: 1011 case PCI_EXP_RTSTA: 1012 return pcie_cap_has_rtctl(dev); 1013 case PCI_EXP_DEVCAP2: 1014 case PCI_EXP_DEVCTL2: 1015 case PCI_EXP_LNKCAP2: 1016 case PCI_EXP_LNKCTL2: 1017 case PCI_EXP_LNKSTA2: 1018 return pcie_cap_version(dev) > 1; 1019 default: 1020 return false; 1021 } 1022 } 1023 1024 static inline int 1025 pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *dst) 1026 { 1027 *dst = 0; 1028 if (pos & 3) 1029 return -EINVAL; 1030 1031 if (!pcie_capability_reg_implemented(dev, pos)) 1032 return -EINVAL; 1033 1034 return pci_read_config_dword(dev, pci_pcie_cap(dev) + pos, dst); 1035 } 1036 1037 static inline int 1038 pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *dst) 1039 { 1040 *dst = 0; 1041 if (pos & 3) 1042 return -EINVAL; 1043 1044 if (!pcie_capability_reg_implemented(dev, pos)) 1045 return -EINVAL; 1046 1047 return pci_read_config_word(dev, pci_pcie_cap(dev) + pos, dst); 1048 } 1049 1050 static inline int 1051 pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val) 1052 { 1053 if (pos & 1) 1054 return -EINVAL; 1055 1056 if (!pcie_capability_reg_implemented(dev, pos)) 1057 return 0; 1058 1059 return pci_write_config_word(dev, pci_pcie_cap(dev) + pos, val); 1060 } 1061 1062 static inline int 1063 pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos, 1064 uint16_t clear, uint16_t set) 1065 { 1066 int error; 1067 uint16_t v; 1068 1069 if (pos == PCI_EXP_LNKCTL || pos == PCI_EXP_RTCTL) 1070 spin_lock(&dev->pcie_cap_lock); 1071 1072 error = pcie_capability_read_word(dev, pos, &v); 1073 if (error == 0) { 1074 v &= ~clear; 1075 v |= set; 1076 error = pcie_capability_write_word(dev, pos, v); 1077 } 1078 1079 if (pos == PCI_EXP_LNKCTL || pos == PCI_EXP_RTCTL) 1080 spin_unlock(&dev->pcie_cap_lock); 1081 1082 return (error); 1083 } 1084 1085 static inline int 1086 pcie_capability_set_word(struct pci_dev *dev, int pos, uint16_t val) 1087 { 1088 return (pcie_capability_clear_and_set_word(dev, pos, 0, val)); 1089 } 1090 1091 static inline int 1092 pcie_capability_clear_word(struct pci_dev *dev, int pos, uint16_t val) 1093 { 1094 return (pcie_capability_clear_and_set_word(dev, pos, val, 0)); 1095 } 1096 1097 static inline int pcie_get_minimum_link(struct pci_dev *dev, 1098 enum pci_bus_speed *speed, enum pcie_link_width *width) 1099 { 1100 *speed = PCI_SPEED_UNKNOWN; 1101 *width = PCIE_LNK_WIDTH_UNKNOWN; 1102 return (0); 1103 } 1104 1105 static inline int 1106 pci_num_vf(struct pci_dev *dev) 1107 { 1108 return (0); 1109 } 1110 1111 static inline enum pci_bus_speed 1112 pcie_get_speed_cap(struct pci_dev *dev) 1113 { 1114 struct pci_dev *pbus; 1115 device_t root; 1116 uint32_t lnkcap, lnkcap2; 1117 int error, pos; 1118 1119 /* 1120 * We should always be called on a PCI device. 1121 * The only current consumer I could find was amdgpu which either 1122 * calls us directly on a pdev(drmn?) or with the result of 1123 * pci_upstream_bridge(). 1124 * 1125 * Treat "drmn" as special again as it is not a PCI device. 1126 */ 1127 if (dev->pdrv != NULL && dev->pdrv->isdrm) { 1128 pbus = pci_upstream_bridge(dev); 1129 if (pbus == NULL) 1130 return (PCI_SPEED_UNKNOWN); 1131 } else 1132 pbus = dev; 1133 1134 /* "root" may be misleading as it may not be that. */ 1135 root = pbus->dev.bsddev; 1136 1137 if (pci_get_vendor(root) == PCI_VENDOR_ID_VIA || 1138 pci_get_vendor(root) == PCI_VENDOR_ID_SERVERWORKS) 1139 return (PCI_SPEED_UNKNOWN); 1140 1141 if ((error = pci_find_cap(root, PCIY_EXPRESS, &pos)) != 0) 1142 return (PCI_SPEED_UNKNOWN); 1143 1144 lnkcap2 = pci_read_config(root, pos + PCIER_LINK_CAP2, 4); 1145 1146 if (lnkcap2) { /* PCIe r3.0-compliant */ 1147 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_2_5GB) 1148 return (PCIE_SPEED_2_5GT); 1149 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_5_0GB) 1150 return (PCIE_SPEED_5_0GT); 1151 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_8_0GB) 1152 return (PCIE_SPEED_8_0GT); 1153 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_16_0GB) 1154 return (PCIE_SPEED_16_0GT); 1155 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_32_0GB) 1156 return (PCIE_SPEED_32_0GT); 1157 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_64_0GB) 1158 return (PCIE_SPEED_64_0GT); 1159 } else { /* pre-r3.0 */ 1160 lnkcap = pci_read_config(root, pos + PCIER_LINK_CAP, 4); 1161 if (lnkcap & PCI_EXP_LNKCAP_SLS_2_5GB) 1162 return (PCIE_SPEED_2_5GT); 1163 if (lnkcap & PCI_EXP_LNKCAP_SLS_5_0GB) 1164 return (PCIE_SPEED_5_0GT); 1165 if (lnkcap & PCI_EXP_LNKCAP_SLS_8_0GB) 1166 return (PCIE_SPEED_8_0GT); 1167 if (lnkcap & PCI_EXP_LNKCAP_SLS_16_0GB) 1168 return (PCIE_SPEED_16_0GT); 1169 if (lnkcap & PCI_EXP_LNKCAP_SLS_32_0GB) 1170 return (PCIE_SPEED_32_0GT); 1171 if (lnkcap & PCI_EXP_LNKCAP_SLS_64_0GB) 1172 return (PCIE_SPEED_64_0GT); 1173 } 1174 return (PCI_SPEED_UNKNOWN); 1175 } 1176 1177 static inline enum pcie_link_width 1178 pcie_get_width_cap(struct pci_dev *dev) 1179 { 1180 uint32_t lnkcap; 1181 1182 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap); 1183 if (lnkcap) 1184 return ((lnkcap & PCI_EXP_LNKCAP_MLW) >> 4); 1185 1186 return (PCIE_LNK_WIDTH_UNKNOWN); 1187 } 1188 1189 static inline int 1190 pcie_get_mps(struct pci_dev *dev) 1191 { 1192 return (pci_get_max_payload(dev->dev.bsddev)); 1193 } 1194 1195 static inline uint32_t 1196 PCIE_SPEED2MBS_ENC(enum pci_bus_speed spd) 1197 { 1198 1199 switch(spd) { 1200 case PCIE_SPEED_64_0GT: 1201 return (64000 * 128 / 130); 1202 case PCIE_SPEED_32_0GT: 1203 return (32000 * 128 / 130); 1204 case PCIE_SPEED_16_0GT: 1205 return (16000 * 128 / 130); 1206 case PCIE_SPEED_8_0GT: 1207 return (8000 * 128 / 130); 1208 case PCIE_SPEED_5_0GT: 1209 return (5000 * 8 / 10); 1210 case PCIE_SPEED_2_5GT: 1211 return (2500 * 8 / 10); 1212 default: 1213 return (0); 1214 } 1215 } 1216 1217 static inline uint32_t 1218 pcie_bandwidth_available(struct pci_dev *pdev, 1219 struct pci_dev **limiting, 1220 enum pci_bus_speed *speed, 1221 enum pcie_link_width *width) 1222 { 1223 enum pci_bus_speed nspeed = pcie_get_speed_cap(pdev); 1224 enum pcie_link_width nwidth = pcie_get_width_cap(pdev); 1225 1226 if (speed) 1227 *speed = nspeed; 1228 if (width) 1229 *width = nwidth; 1230 1231 return (nwidth * PCIE_SPEED2MBS_ENC(nspeed)); 1232 } 1233 1234 static inline bool 1235 pcie_aspm_enabled(struct pci_dev *pdev) 1236 { 1237 return (false); 1238 } 1239 1240 static inline struct pci_dev * 1241 pcie_find_root_port(struct pci_dev *pdev) 1242 { 1243 device_t root; 1244 1245 if (pdev->root != NULL) 1246 return (pdev->root); 1247 1248 root = pci_find_pcie_root_port(pdev->dev.bsddev); 1249 if (root == NULL) 1250 return (NULL); 1251 1252 pdev->root = lkpinew_pci_dev(root); 1253 return (pdev->root); 1254 } 1255 1256 /* This is needed when people rip out the device "HotPlug". */ 1257 static inline void 1258 pci_lock_rescan_remove(void) 1259 { 1260 } 1261 1262 static inline void 1263 pci_unlock_rescan_remove(void) 1264 { 1265 } 1266 1267 static __inline void 1268 pci_stop_and_remove_bus_device(struct pci_dev *pdev) 1269 { 1270 } 1271 1272 static inline int 1273 pci_rescan_bus(struct pci_bus *pbus) 1274 { 1275 device_t *devlist, parent; 1276 int devcount, error; 1277 1278 if (!device_is_attached(pbus->self->dev.bsddev)) 1279 return (0); 1280 /* pci_rescan_method() will work on the pcib (parent). */ 1281 error = BUS_RESCAN(pbus->self->dev.bsddev); 1282 if (error != 0) 1283 return (0); 1284 1285 parent = device_get_parent(pbus->self->dev.bsddev); 1286 error = device_get_children(parent, &devlist, &devcount); 1287 if (error != 0) 1288 return (0); 1289 if (devcount != 0) 1290 free(devlist, M_TEMP); 1291 1292 return (devcount); 1293 } 1294 1295 /* 1296 * The following functions can be used to attach/detach the LinuxKPI's 1297 * PCI device runtime. The pci_driver and pci_device_id pointer is 1298 * allowed to be NULL. Other pointers must be all valid. 1299 * The pci_dev structure should be zero-initialized before passed 1300 * to the linux_pci_attach_device function. 1301 */ 1302 extern int linux_pci_attach_device(device_t, struct pci_driver *, 1303 const struct pci_device_id *, struct pci_dev *); 1304 extern int linux_pci_detach_device(struct pci_dev *); 1305 1306 static inline int 1307 pci_dev_present(const struct pci_device_id *cur) 1308 { 1309 while (cur != NULL && (cur->vendor || cur->device)) { 1310 if (pci_find_device(cur->vendor, cur->device) != NULL) { 1311 return (1); 1312 } 1313 cur++; 1314 } 1315 return (0); 1316 } 1317 1318 static inline bool 1319 pci_dev_is_disconnected(const struct pci_dev *pdev) 1320 { 1321 pr_debug("TODO: %s\n", __func__); 1322 return (false); 1323 } 1324 1325 static inline const struct pci_device_id * 1326 pci_match_id(const struct pci_device_id *ids, struct pci_dev *pdev) 1327 { 1328 if (ids == NULL) 1329 return (NULL); 1330 1331 for (; 1332 ids->vendor != 0 || ids->subvendor != 0 || ids->class_mask != 0; 1333 ids++) 1334 if ((ids->vendor == PCI_ANY_ID || 1335 ids->vendor == pdev->vendor) && 1336 (ids->device == PCI_ANY_ID || 1337 ids->device == pdev->device) && 1338 (ids->subvendor == PCI_ANY_ID || 1339 ids->subvendor == pdev->subsystem_vendor) && 1340 (ids->subdevice == PCI_ANY_ID || 1341 ids->subdevice == pdev->subsystem_device) && 1342 ((ids->class ^ pdev->class) & ids->class_mask) == 0) 1343 return (ids); 1344 1345 return (NULL); 1346 } 1347 1348 struct pci_dev *lkpi_pci_get_domain_bus_and_slot(int domain, 1349 unsigned int bus, unsigned int devfn); 1350 #define pci_get_domain_bus_and_slot(domain, bus, devfn) \ 1351 lkpi_pci_get_domain_bus_and_slot(domain, bus, devfn) 1352 1353 struct pci_dev *lkpi_pci_get_slot(struct pci_bus *, unsigned int); 1354 #ifndef WANT_NATIVE_PCI_GET_SLOT 1355 #define pci_get_slot(_pbus, _devfn) \ 1356 lkpi_pci_get_slot(_pbus, _devfn) 1357 #endif 1358 1359 static inline int 1360 pci_domain_nr(struct pci_bus *pbus) 1361 { 1362 1363 return (pbus->domain); 1364 } 1365 1366 static inline int 1367 pci_bus_read_config(struct pci_bus *bus, unsigned int devfn, 1368 int pos, uint32_t *val, int len) 1369 { 1370 1371 *val = pci_read_config(bus->self->dev.bsddev, pos, len); 1372 return (0); 1373 } 1374 1375 static inline int 1376 pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn, int pos, u16 *val) 1377 { 1378 uint32_t tmp; 1379 int ret; 1380 1381 ret = pci_bus_read_config(bus, devfn, pos, &tmp, 2); 1382 *val = (u16)tmp; 1383 return (ret); 1384 } 1385 1386 static inline int 1387 pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn, int pos, u8 *val) 1388 { 1389 uint32_t tmp; 1390 int ret; 1391 1392 ret = pci_bus_read_config(bus, devfn, pos, &tmp, 1); 1393 *val = (u8)tmp; 1394 return (ret); 1395 } 1396 1397 static inline int 1398 pci_bus_write_config(struct pci_bus *bus, unsigned int devfn, int pos, 1399 uint32_t val, int size) 1400 { 1401 1402 pci_write_config(bus->self->dev.bsddev, pos, val, size); 1403 return (0); 1404 } 1405 1406 static inline int 1407 pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn, int pos, 1408 uint8_t val) 1409 { 1410 return (pci_bus_write_config(bus, devfn, pos, val, 1)); 1411 } 1412 1413 static inline int 1414 pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn, int pos, 1415 uint16_t val) 1416 { 1417 return (pci_bus_write_config(bus, devfn, pos, val, 2)); 1418 } 1419 1420 struct pci_dev *lkpi_pci_get_class(unsigned int class, struct pci_dev *from); 1421 #define pci_get_class(class, from) lkpi_pci_get_class(class, from) 1422 struct pci_dev *lkpi_pci_get_base_class(unsigned int class, 1423 struct pci_dev *from); 1424 #define pci_get_base_class(class, from) lkpi_pci_get_base_class(class, from) 1425 1426 /* -------------------------------------------------------------------------- */ 1427 1428 #define pcim_enable_device(pdev) \ 1429 linuxkpi_pcim_enable_device(pdev) 1430 #define pcim_iomap_table(pdev) \ 1431 linuxkpi_pcim_iomap_table(pdev) 1432 #define pcim_iomap_regions(pdev, mask, name) \ 1433 linuxkpi_pcim_iomap_regions(pdev, mask, name) 1434 1435 static inline int 1436 pcim_iomap_regions_request_all(struct pci_dev *pdev, uint32_t mask, char *name) 1437 { 1438 uint32_t requests, req_mask; 1439 int bar, error; 1440 1441 /* Request all the BARs ("regions") we do not iomap. */ 1442 req_mask = ((1 << (PCIR_MAX_BAR_0 + 1)) - 1) & ~mask; 1443 for (bar = requests = 0; requests != req_mask; bar++) { 1444 if ((req_mask & (1 << bar)) == 0) 1445 continue; 1446 error = pci_request_region(pdev, bar, name); 1447 if (error != 0 && error != -ENODEV) 1448 goto err; 1449 requests |= (1 << bar); 1450 } 1451 1452 error = pcim_iomap_regions(pdev, mask, name); 1453 if (error != 0) 1454 goto err; 1455 1456 return (0); 1457 1458 err: 1459 for (bar = PCIR_MAX_BAR_0; bar >= 0; bar--) { 1460 if ((requests & (1 << bar)) != 0) 1461 pci_release_region(pdev, bar); 1462 } 1463 1464 return (-EINVAL); 1465 } 1466 1467 /* 1468 * We cannot simply re-define pci_get_device() as we would normally do 1469 * and then hide it in linux_pci.c as too many semi-native drivers still 1470 * include linux/pci.h and run into the conflict with native PCI. Linux drivers 1471 * using pci_get_device() need to be changed to call linuxkpi_pci_get_device(). 1472 */ 1473 static inline struct pci_dev * 1474 linuxkpi_pci_get_device(uint32_t vendor, uint32_t device, struct pci_dev *odev) 1475 { 1476 1477 return (lkpi_pci_get_device(vendor, device, odev)); 1478 } 1479 1480 #define for_each_pci_dev(_pdev) \ 1481 while ((_pdev = linuxkpi_pci_get_device(PCI_ANY_ID, PCI_ANY_ID, _pdev)) != NULL) 1482 1483 /* This is a FreeBSD extension so we can use bus_*(). */ 1484 static inline void 1485 linuxkpi_pcim_want_to_use_bus_functions(struct pci_dev *pdev) 1486 { 1487 pdev->want_iomap_res = true; 1488 } 1489 1490 static inline bool 1491 pci_is_thunderbolt_attached(struct pci_dev *pdev) 1492 { 1493 1494 return (false); 1495 } 1496 1497 static inline void * 1498 pci_platform_rom(struct pci_dev *pdev, size_t *size) 1499 { 1500 1501 return (NULL); 1502 } 1503 1504 static inline void 1505 pci_ignore_hotplug(struct pci_dev *pdev) 1506 { 1507 } 1508 1509 static inline const char * 1510 pci_power_name(pci_power_t state) 1511 { 1512 int pstate = state + 1; 1513 1514 if (pstate >= 0 && pstate < nitems(pci_power_names)) 1515 return (pci_power_names[pstate]); 1516 else 1517 return (pci_power_names[0]); 1518 } 1519 1520 static inline int 1521 pcie_get_readrq(struct pci_dev *dev) 1522 { 1523 u16 ctl; 1524 1525 if (pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl)) 1526 return (-EINVAL); 1527 1528 return (128 << ((ctl & PCI_EXP_DEVCTL_READRQ) >> 12)); 1529 } 1530 1531 static inline bool 1532 pci_is_enabled(struct pci_dev *pdev) 1533 { 1534 1535 return ((pci_read_config(pdev->dev.bsddev, PCIR_COMMAND, 2) & 1536 PCIM_CMD_BUSMASTEREN) != 0); 1537 } 1538 1539 static inline int 1540 pci_wait_for_pending_transaction(struct pci_dev *pdev) 1541 { 1542 1543 return (0); 1544 } 1545 1546 static inline int 1547 pci_assign_resource(struct pci_dev *pdev, int bar) 1548 { 1549 1550 return (0); 1551 } 1552 1553 static inline int 1554 pci_irq_vector(struct pci_dev *pdev, unsigned int vector) 1555 { 1556 1557 if (!pdev->msix_enabled && !pdev->msi_enabled) { 1558 if (vector != 0) 1559 return (-EINVAL); 1560 return (pdev->irq); 1561 } 1562 1563 if (pdev->msix_enabled || pdev->msi_enabled) { 1564 if ((pdev->dev.irq_start + vector) >= pdev->dev.irq_end) 1565 return (-EINVAL); 1566 return (pdev->dev.irq_start + vector); 1567 } 1568 1569 return (-ENXIO); 1570 } 1571 1572 static inline int 1573 pci_wake_from_d3(struct pci_dev *pdev, bool enable) 1574 { 1575 1576 pr_debug("%s: TODO\n", __func__); 1577 return (0); 1578 } 1579 1580 #endif /* _LINUXKPI_LINUX_PCI_H_ */ 1581