net/fm10k: remove local bool type
[dpdk.git] / drivers / bus / pci / pci_common.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation.
3  * Copyright 2013-2014 6WIND S.A.
4  */
5
6 #include <string.h>
7 #include <inttypes.h>
8 #include <stdint.h>
9 #include <stdbool.h>
10 #include <stdlib.h>
11 #include <stdio.h>
12 #include <sys/queue.h>
13 #include <sys/mman.h>
14
15 #include <rte_errno.h>
16 #include <rte_interrupts.h>
17 #include <rte_log.h>
18 #include <rte_bus.h>
19 #include <rte_pci.h>
20 #include <rte_bus_pci.h>
21 #include <rte_per_lcore.h>
22 #include <rte_memory.h>
23 #include <rte_eal.h>
24 #include <rte_string_fns.h>
25 #include <rte_common.h>
26 #include <rte_devargs.h>
27 #include <rte_vfio.h>
28
29 #include "private.h"
30
31
32 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
33
34 const char *rte_pci_get_sysfs_path(void)
35 {
36         const char *path = NULL;
37
38         path = getenv("SYSFS_PCI_DEVICES");
39         if (path == NULL)
40                 return SYSFS_PCI_DEVICES;
41
42         return path;
43 }
44
45 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
46 {
47         struct rte_devargs *devargs;
48         struct rte_pci_addr addr;
49
50         RTE_EAL_DEVARGS_FOREACH("pci", devargs) {
51                 devargs->bus->parse(devargs->name, &addr);
52                 if (!rte_pci_addr_cmp(&dev->addr, &addr))
53                         return devargs;
54         }
55         return NULL;
56 }
57
58 void
59 pci_name_set(struct rte_pci_device *dev)
60 {
61         struct rte_devargs *devargs;
62
63         /* Each device has its internal, canonical name set. */
64         rte_pci_device_name(&dev->addr,
65                         dev->name, sizeof(dev->name));
66         devargs = pci_devargs_lookup(dev);
67         dev->device.devargs = devargs;
68         /* In blacklist mode, if the device is not blacklisted, no
69          * rte_devargs exists for it.
70          */
71         if (devargs != NULL)
72                 /* If an rte_devargs exists, the generic rte_device uses the
73                  * given name as its name.
74                  */
75                 dev->device.name = dev->device.devargs->name;
76         else
77                 /* Otherwise, it uses the internal, canonical form. */
78                 dev->device.name = dev->name;
79 }
80
81 /*
82  * Match the PCI Driver and Device using the ID Table
83  */
84 int
85 rte_pci_match(const struct rte_pci_driver *pci_drv,
86               const struct rte_pci_device *pci_dev)
87 {
88         const struct rte_pci_id *id_table;
89
90         for (id_table = pci_drv->id_table; id_table->vendor_id != 0;
91              id_table++) {
92                 /* check if device's identifiers match the driver's ones */
93                 if (id_table->vendor_id != pci_dev->id.vendor_id &&
94                                 id_table->vendor_id != PCI_ANY_ID)
95                         continue;
96                 if (id_table->device_id != pci_dev->id.device_id &&
97                                 id_table->device_id != PCI_ANY_ID)
98                         continue;
99                 if (id_table->subsystem_vendor_id !=
100                     pci_dev->id.subsystem_vendor_id &&
101                     id_table->subsystem_vendor_id != PCI_ANY_ID)
102                         continue;
103                 if (id_table->subsystem_device_id !=
104                     pci_dev->id.subsystem_device_id &&
105                     id_table->subsystem_device_id != PCI_ANY_ID)
106                         continue;
107                 if (id_table->class_id != pci_dev->id.class_id &&
108                                 id_table->class_id != RTE_CLASS_ANY_ID)
109                         continue;
110
111                 return 1;
112         }
113
114         return 0;
115 }
116
117 /*
118  * If vendor/device ID match, call the probe() function of the
119  * driver.
120  */
121 static int
122 rte_pci_probe_one_driver(struct rte_pci_driver *dr,
123                          struct rte_pci_device *dev)
124 {
125         int ret;
126         bool already_probed;
127         struct rte_pci_addr *loc;
128
129         if ((dr == NULL) || (dev == NULL))
130                 return -EINVAL;
131
132         loc = &dev->addr;
133
134         /* The device is not blacklisted; Check if driver supports it */
135         if (!rte_pci_match(dr, dev))
136                 /* Match of device and driver failed */
137                 return 1;
138
139         RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
140                         loc->domain, loc->bus, loc->devid, loc->function,
141                         dev->device.numa_node);
142
143         /* no initialization when blacklisted, return without error */
144         if (dev->device.devargs != NULL &&
145                 dev->device.devargs->policy ==
146                         RTE_DEV_BLACKLISTED) {
147                 RTE_LOG(INFO, EAL, "  Device is blacklisted, not"
148                         " initializing\n");
149                 return 1;
150         }
151
152         if (dev->device.numa_node < 0) {
153                 RTE_LOG(WARNING, EAL, "  Invalid NUMA socket, default to 0\n");
154                 dev->device.numa_node = 0;
155         }
156
157         already_probed = rte_dev_is_probed(&dev->device);
158         if (already_probed && !(dr->drv_flags & RTE_PCI_DRV_PROBE_AGAIN)) {
159                 RTE_LOG(DEBUG, EAL, "Device %s is already probed\n",
160                                 dev->device.name);
161                 return -EEXIST;
162         }
163
164         RTE_LOG(INFO, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
165                 dev->id.device_id, dr->driver.name);
166
167         /*
168          * reference driver structure
169          * This needs to be before rte_pci_map_device(), as it enables to use
170          * driver flags for adjusting configuration.
171          */
172         if (!already_probed) {
173                 enum rte_iova_mode dev_iova_mode;
174                 enum rte_iova_mode iova_mode;
175
176                 dev_iova_mode = pci_device_iova_mode(dr, dev);
177                 iova_mode = rte_eal_iova_mode();
178                 if (dev_iova_mode != RTE_IOVA_DC &&
179                     dev_iova_mode != iova_mode) {
180                         RTE_LOG(ERR, EAL, "  Expecting '%s' IOVA mode but current mode is '%s', not initializing\n",
181                                 dev_iova_mode == RTE_IOVA_PA ? "PA" : "VA",
182                                 iova_mode == RTE_IOVA_PA ? "PA" : "VA");
183                         return -EINVAL;
184                 }
185
186                 dev->driver = dr;
187         }
188
189         if (!already_probed && (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)) {
190                 /* map resources for devices that use igb_uio */
191                 ret = rte_pci_map_device(dev);
192                 if (ret != 0) {
193                         dev->driver = NULL;
194                         return ret;
195                 }
196         }
197
198         /* call the driver probe() function */
199         ret = dr->probe(dr, dev);
200         if (already_probed)
201                 return ret; /* no rollback if already succeeded earlier */
202         if (ret) {
203                 dev->driver = NULL;
204                 if ((dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) &&
205                         /* Don't unmap if device is unsupported and
206                          * driver needs mapped resources.
207                          */
208                         !(ret > 0 &&
209                                 (dr->drv_flags & RTE_PCI_DRV_KEEP_MAPPED_RES)))
210                         rte_pci_unmap_device(dev);
211         } else {
212                 dev->device.driver = &dr->driver;
213         }
214
215         return ret;
216 }
217
218 /*
219  * If vendor/device ID match, call the remove() function of the
220  * driver.
221  */
222 static int
223 rte_pci_detach_dev(struct rte_pci_device *dev)
224 {
225         struct rte_pci_addr *loc;
226         struct rte_pci_driver *dr;
227         int ret = 0;
228
229         if (dev == NULL)
230                 return -EINVAL;
231
232         dr = dev->driver;
233         loc = &dev->addr;
234
235         RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
236                         loc->domain, loc->bus, loc->devid,
237                         loc->function, dev->device.numa_node);
238
239         RTE_LOG(DEBUG, EAL, "  remove driver: %x:%x %s\n", dev->id.vendor_id,
240                         dev->id.device_id, dr->driver.name);
241
242         if (dr->remove) {
243                 ret = dr->remove(dev);
244                 if (ret < 0)
245                         return ret;
246         }
247
248         /* clear driver structure */
249         dev->driver = NULL;
250         dev->device.driver = NULL;
251
252         if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
253                 /* unmap resources for devices that use igb_uio */
254                 rte_pci_unmap_device(dev);
255
256         return 0;
257 }
258
259 /*
260  * If vendor/device ID match, call the probe() function of all
261  * registered driver for the given device. Return < 0 if initialization
262  * failed, return 1 if no driver is found for this device.
263  */
264 static int
265 pci_probe_all_drivers(struct rte_pci_device *dev)
266 {
267         struct rte_pci_driver *dr = NULL;
268         int rc = 0;
269
270         if (dev == NULL)
271                 return -EINVAL;
272
273         FOREACH_DRIVER_ON_PCIBUS(dr) {
274                 rc = rte_pci_probe_one_driver(dr, dev);
275                 if (rc < 0)
276                         /* negative value is an error */
277                         return rc;
278                 if (rc > 0)
279                         /* positive value means driver doesn't support it */
280                         continue;
281                 return 0;
282         }
283         return 1;
284 }
285
286 /*
287  * Scan the content of the PCI bus, and call the probe() function for
288  * all registered drivers that have a matching entry in its id_table
289  * for discovered devices.
290  */
291 int
292 rte_pci_probe(void)
293 {
294         struct rte_pci_device *dev = NULL;
295         size_t probed = 0, failed = 0;
296         struct rte_devargs *devargs;
297         int probe_all = 0;
298         int ret = 0;
299
300         if (rte_pci_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST)
301                 probe_all = 1;
302
303         FOREACH_DEVICE_ON_PCIBUS(dev) {
304                 probed++;
305
306                 devargs = dev->device.devargs;
307                 /* probe all or only whitelisted devices */
308                 if (probe_all)
309                         ret = pci_probe_all_drivers(dev);
310                 else if (devargs != NULL &&
311                         devargs->policy == RTE_DEV_WHITELISTED)
312                         ret = pci_probe_all_drivers(dev);
313                 if (ret < 0) {
314                         if (ret != -EEXIST) {
315                                 RTE_LOG(ERR, EAL, "Requested device "
316                                         PCI_PRI_FMT " cannot be used\n",
317                                         dev->addr.domain, dev->addr.bus,
318                                         dev->addr.devid, dev->addr.function);
319                                 rte_errno = errno;
320                                 failed++;
321                         }
322                         ret = 0;
323                 }
324         }
325
326         return (probed && probed == failed) ? -1 : 0;
327 }
328
329 /* dump one device */
330 static int
331 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
332 {
333         int i;
334
335         fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
336                dev->addr.devid, dev->addr.function);
337         fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
338                dev->id.device_id);
339
340         for (i = 0; i != sizeof(dev->mem_resource) /
341                 sizeof(dev->mem_resource[0]); i++) {
342                 fprintf(f, "   %16.16"PRIx64" %16.16"PRIx64"\n",
343                         dev->mem_resource[i].phys_addr,
344                         dev->mem_resource[i].len);
345         }
346         return 0;
347 }
348
349 /* dump devices on the bus */
350 void
351 rte_pci_dump(FILE *f)
352 {
353         struct rte_pci_device *dev = NULL;
354
355         FOREACH_DEVICE_ON_PCIBUS(dev) {
356                 pci_dump_one_device(f, dev);
357         }
358 }
359
360 static int
361 pci_parse(const char *name, void *addr)
362 {
363         struct rte_pci_addr *out = addr;
364         struct rte_pci_addr pci_addr;
365         bool parse;
366
367         parse = (rte_pci_addr_parse(name, &pci_addr) == 0);
368         if (parse && addr != NULL)
369                 *out = pci_addr;
370         return parse == false;
371 }
372
373 /* register a driver */
374 void
375 rte_pci_register(struct rte_pci_driver *driver)
376 {
377         TAILQ_INSERT_TAIL(&rte_pci_bus.driver_list, driver, next);
378         driver->bus = &rte_pci_bus;
379 }
380
381 /* unregister a driver */
382 void
383 rte_pci_unregister(struct rte_pci_driver *driver)
384 {
385         TAILQ_REMOVE(&rte_pci_bus.driver_list, driver, next);
386         driver->bus = NULL;
387 }
388
389 /* Add a device to PCI bus */
390 void
391 rte_pci_add_device(struct rte_pci_device *pci_dev)
392 {
393         TAILQ_INSERT_TAIL(&rte_pci_bus.device_list, pci_dev, next);
394 }
395
396 /* Insert a device into a predefined position in PCI bus */
397 void
398 rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
399                       struct rte_pci_device *new_pci_dev)
400 {
401         TAILQ_INSERT_BEFORE(exist_pci_dev, new_pci_dev, next);
402 }
403
404 /* Remove a device from PCI bus */
405 static void
406 rte_pci_remove_device(struct rte_pci_device *pci_dev)
407 {
408         TAILQ_REMOVE(&rte_pci_bus.device_list, pci_dev, next);
409 }
410
411 static struct rte_device *
412 pci_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
413                 const void *data)
414 {
415         const struct rte_pci_device *pstart;
416         struct rte_pci_device *pdev;
417
418         if (start != NULL) {
419                 pstart = RTE_DEV_TO_PCI_CONST(start);
420                 pdev = TAILQ_NEXT(pstart, next);
421         } else {
422                 pdev = TAILQ_FIRST(&rte_pci_bus.device_list);
423         }
424         while (pdev != NULL) {
425                 if (cmp(&pdev->device, data) == 0)
426                         return &pdev->device;
427                 pdev = TAILQ_NEXT(pdev, next);
428         }
429         return NULL;
430 }
431
432 /*
433  * find the device which encounter the failure, by iterate over all device on
434  * PCI bus to check if the memory failure address is located in the range
435  * of the BARs of the device.
436  */
437 static struct rte_pci_device *
438 pci_find_device_by_addr(const void *failure_addr)
439 {
440         struct rte_pci_device *pdev = NULL;
441         uint64_t check_point, start, end, len;
442         int i;
443
444         check_point = (uint64_t)(uintptr_t)failure_addr;
445
446         FOREACH_DEVICE_ON_PCIBUS(pdev) {
447                 for (i = 0; i != RTE_DIM(pdev->mem_resource); i++) {
448                         start = (uint64_t)(uintptr_t)pdev->mem_resource[i].addr;
449                         len = pdev->mem_resource[i].len;
450                         end = start + len;
451                         if (check_point >= start && check_point < end) {
452                                 RTE_LOG(DEBUG, EAL, "Failure address %16.16"
453                                         PRIx64" belongs to device %s!\n",
454                                         check_point, pdev->device.name);
455                                 return pdev;
456                         }
457                 }
458         }
459         return NULL;
460 }
461
462 static int
463 pci_hot_unplug_handler(struct rte_device *dev)
464 {
465         struct rte_pci_device *pdev = NULL;
466         int ret = 0;
467
468         pdev = RTE_DEV_TO_PCI(dev);
469         if (!pdev)
470                 return -1;
471
472         switch (pdev->kdrv) {
473 #ifdef HAVE_VFIO_DEV_REQ_INTERFACE
474         case RTE_KDRV_VFIO:
475                 /*
476                  * vfio kernel module guaranty the pci device would not be
477                  * deleted until the user space release the resource, so no
478                  * need to remap BARs resource here, just directly notify
479                  * the req event to the user space to handle it.
480                  */
481                 rte_dev_event_callback_process(dev->name,
482                                                RTE_DEV_EVENT_REMOVE);
483                 break;
484 #endif
485         case RTE_KDRV_IGB_UIO:
486         case RTE_KDRV_UIO_GENERIC:
487         case RTE_KDRV_NIC_UIO:
488                 /* BARs resource is invalid, remap it to be safe. */
489                 ret = pci_uio_remap_resource(pdev);
490                 break;
491         default:
492                 RTE_LOG(DEBUG, EAL,
493                         "Not managed by a supported kernel driver, skipped\n");
494                 ret = -1;
495                 break;
496         }
497
498         return ret;
499 }
500
501 static int
502 pci_sigbus_handler(const void *failure_addr)
503 {
504         struct rte_pci_device *pdev = NULL;
505         int ret = 0;
506
507         pdev = pci_find_device_by_addr(failure_addr);
508         if (!pdev) {
509                 /* It is a generic sigbus error, no bus would handle it. */
510                 ret = 1;
511         } else {
512                 /* The sigbus error is caused of hot-unplug. */
513                 ret = pci_hot_unplug_handler(&pdev->device);
514                 if (ret) {
515                         RTE_LOG(ERR, EAL,
516                                 "Failed to handle hot-unplug for device %s",
517                                 pdev->name);
518                         ret = -1;
519                 }
520         }
521         return ret;
522 }
523
524 static int
525 pci_plug(struct rte_device *dev)
526 {
527         return pci_probe_all_drivers(RTE_DEV_TO_PCI(dev));
528 }
529
530 static int
531 pci_unplug(struct rte_device *dev)
532 {
533         struct rte_pci_device *pdev;
534         int ret;
535
536         pdev = RTE_DEV_TO_PCI(dev);
537         ret = rte_pci_detach_dev(pdev);
538         if (ret == 0) {
539                 rte_pci_remove_device(pdev);
540                 rte_devargs_remove(dev->devargs);
541                 free(pdev);
542         }
543         return ret;
544 }
545
546 static int
547 pci_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len)
548 {
549         struct rte_pci_device *pdev = RTE_DEV_TO_PCI(dev);
550
551         if (!pdev || !pdev->driver) {
552                 rte_errno = EINVAL;
553                 return -1;
554         }
555         if (pdev->driver->dma_map)
556                 return pdev->driver->dma_map(pdev, addr, iova, len);
557         /**
558          *  In case driver don't provides any specific mapping
559          *  try fallback to VFIO.
560          */
561         if (pdev->kdrv == RTE_KDRV_VFIO)
562                 return rte_vfio_container_dma_map
563                                 (RTE_VFIO_DEFAULT_CONTAINER_FD, (uintptr_t)addr,
564                                  iova, len);
565         rte_errno = ENOTSUP;
566         return -1;
567 }
568
569 static int
570 pci_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova, size_t len)
571 {
572         struct rte_pci_device *pdev = RTE_DEV_TO_PCI(dev);
573
574         if (!pdev || !pdev->driver) {
575                 rte_errno = EINVAL;
576                 return -1;
577         }
578         if (pdev->driver->dma_unmap)
579                 return pdev->driver->dma_unmap(pdev, addr, iova, len);
580         /**
581          *  In case driver don't provides any specific mapping
582          *  try fallback to VFIO.
583          */
584         if (pdev->kdrv == RTE_KDRV_VFIO)
585                 return rte_vfio_container_dma_unmap
586                                 (RTE_VFIO_DEFAULT_CONTAINER_FD, (uintptr_t)addr,
587                                  iova, len);
588         rte_errno = ENOTSUP;
589         return -1;
590 }
591
592 static bool
593 pci_ignore_device(const struct rte_pci_device *dev)
594 {
595         struct rte_devargs *devargs = dev->device.devargs;
596
597         switch (rte_pci_bus.bus.conf.scan_mode) {
598         case RTE_BUS_SCAN_WHITELIST:
599                 if (devargs && devargs->policy == RTE_DEV_WHITELISTED)
600                         return false;
601                 break;
602         case RTE_BUS_SCAN_UNDEFINED:
603         case RTE_BUS_SCAN_BLACKLIST:
604                 if (devargs == NULL ||
605                     devargs->policy != RTE_DEV_BLACKLISTED)
606                         return false;
607                 break;
608         }
609         return true;
610 }
611
612 enum rte_iova_mode
613 rte_pci_get_iommu_class(void)
614 {
615         enum rte_iova_mode iova_mode = RTE_IOVA_DC;
616         const struct rte_pci_device *dev;
617         const struct rte_pci_driver *drv;
618         bool devices_want_va = false;
619         bool devices_want_pa = false;
620         int iommu_no_va = -1;
621
622         FOREACH_DEVICE_ON_PCIBUS(dev) {
623                 /*
624                  * We can check this only once, because the IOMMU hardware is
625                  * the same for all of them.
626                  */
627                 if (iommu_no_va == -1)
628                         iommu_no_va = pci_device_iommu_support_va(dev)
629                                         ? 0 : 1;
630                 if (pci_ignore_device(dev))
631                         continue;
632                 if (dev->kdrv == RTE_KDRV_UNKNOWN ||
633                     dev->kdrv == RTE_KDRV_NONE)
634                         continue;
635                 FOREACH_DRIVER_ON_PCIBUS(drv) {
636                         enum rte_iova_mode dev_iova_mode;
637
638                         if (!rte_pci_match(drv, dev))
639                                 continue;
640
641                         dev_iova_mode = pci_device_iova_mode(drv, dev);
642                         RTE_LOG(DEBUG, EAL, "PCI driver %s for device "
643                                 PCI_PRI_FMT " wants IOVA as '%s'\n",
644                                 drv->driver.name,
645                                 dev->addr.domain, dev->addr.bus,
646                                 dev->addr.devid, dev->addr.function,
647                                 dev_iova_mode == RTE_IOVA_DC ? "DC" :
648                                 (dev_iova_mode == RTE_IOVA_PA ? "PA" : "VA"));
649                         if (dev_iova_mode == RTE_IOVA_PA)
650                                 devices_want_pa = true;
651                         else if (dev_iova_mode == RTE_IOVA_VA)
652                                 devices_want_va = true;
653                 }
654         }
655         if (iommu_no_va == 1) {
656                 iova_mode = RTE_IOVA_PA;
657                 if (devices_want_va) {
658                         RTE_LOG(WARNING, EAL, "Some devices want 'VA' but IOMMU does not support 'VA'.\n");
659                         RTE_LOG(WARNING, EAL, "The devices that want 'VA' won't initialize.\n");
660                 }
661         } else if (devices_want_va && !devices_want_pa) {
662                 iova_mode = RTE_IOVA_VA;
663         } else if (devices_want_pa && !devices_want_va) {
664                 iova_mode = RTE_IOVA_PA;
665         } else {
666                 iova_mode = RTE_IOVA_DC;
667                 if (devices_want_va) {
668                         RTE_LOG(WARNING, EAL, "Some devices want 'VA' but forcing 'DC' because other devices want 'PA'.\n");
669                         RTE_LOG(WARNING, EAL, "Depending on the final decision by the EAL, not all devices may be able to initialize.\n");
670                 }
671         }
672         return iova_mode;
673 }
674
675 struct rte_pci_bus rte_pci_bus = {
676         .bus = {
677                 .scan = rte_pci_scan,
678                 .probe = rte_pci_probe,
679                 .find_device = pci_find_device,
680                 .plug = pci_plug,
681                 .unplug = pci_unplug,
682                 .parse = pci_parse,
683                 .dma_map = pci_dma_map,
684                 .dma_unmap = pci_dma_unmap,
685                 .get_iommu_class = rte_pci_get_iommu_class,
686                 .dev_iterate = rte_pci_dev_iterate,
687                 .hot_unplug_handler = pci_hot_unplug_handler,
688                 .sigbus_handler = pci_sigbus_handler,
689         },
690         .device_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.device_list),
691         .driver_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.driver_list),
692 };
693
694 RTE_REGISTER_BUS(pci, rte_pci_bus.bus);