2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * pci.c: Linux user space PCI bus management.
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vppinfra/linux/sysfs.h>
42 #include <vlib/vlib.h>
43 #include <vlib/pci/pci.h>
44 #include <vlib/unix/unix.h>
45 #include <vlib/linux/vfio.h>
47 #include <sys/types.h>
51 #include <sys/ioctl.h>
53 #include <linux/ethtool.h>
54 #include <linux/sockios.h>
55 #include <linux/vfio.h>
56 #include <sys/eventfd.h>
58 static const char *sysfs_pci_dev_path = "/sys/bus/pci/devices";
59 static const char *sysfs_pci_drv_path = "/sys/bus/pci/drivers";
60 static char *sysfs_mod_vfio_noiommu =
61 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode";
76 pci_intx_handler_function_t *intx_handler;
77 pci_msix_handler_function_t *msix_handler;
83 LINUX_PCI_DEVICE_TYPE_UNKNOWN,
84 LINUX_PCI_DEVICE_TYPE_UIO,
85 LINUX_PCI_DEVICE_TYPE_VFIO,
86 } linux_pci_device_type_t;
90 linux_pci_device_type_t type;
91 vlib_pci_dev_handle_t handle;
94 /* Resource file descriptors. */
95 linux_pci_region_t *regions;
97 /* File descriptor for config space read/write. */
101 /* Device File descriptor */
104 /* Minor device for uio device. */
107 /* Interrupt handlers */
108 linux_pci_irq_t intx_irq;
109 linux_pci_irq_t *msix_irqs;
114 } linux_pci_device_t;
116 /* Pool of PCI devices. */
119 vlib_main_t *vlib_main;
120 linux_pci_device_t *linux_pci_devices;
124 extern linux_pci_main_t linux_pci_main;
126 static linux_pci_device_t *
127 linux_pci_get_device (vlib_pci_dev_handle_t h)
129 linux_pci_main_t *lpm = &linux_pci_main;
130 return pool_elt_at_index (lpm->linux_pci_devices, h);
134 vlib_pci_get_private_data (vlib_pci_dev_handle_t h)
136 linux_pci_device_t *d = linux_pci_get_device (h);
137 return d->private_data;
141 vlib_pci_set_private_data (vlib_pci_dev_handle_t h, uword private_data)
143 linux_pci_device_t *d = linux_pci_get_device (h);
144 d->private_data = private_data;
148 vlib_pci_get_addr (vlib_pci_dev_handle_t h)
150 linux_pci_device_t *d = linux_pci_get_device (h);
154 /* Call to allocate/initialize the pci subsystem.
155 This is not an init function so that users can explicitly enable
156 pci only when it's needed. */
157 clib_error_t *pci_bus_init (vlib_main_t * vm);
159 linux_pci_main_t linux_pci_main;
161 vlib_pci_device_info_t *
162 vlib_pci_get_device_info (vlib_pci_addr_t * addr, clib_error_t ** error)
164 linux_vfio_main_t *lvm = &vfio_main;
166 vlib_pci_device_info_t *di;
171 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
172 memset (di, 0, sizeof (vlib_pci_device_info_t));
173 di->addr.as_u32 = addr->as_u32;
175 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
176 format_vlib_pci_addr, addr);
178 f = format (0, "%v/config%c", dev_dir_name, 0);
179 fd = open ((char *) f, O_RDWR);
181 /* Try read-only access if write fails. */
183 fd = open ((char *) f, O_RDONLY);
187 err = clib_error_return_unix (0, "open `%s'", f);
191 /* You can only read more that 64 bytes of config space as root; so we try to
192 read the full space but fall back to just the first 64 bytes. */
193 if (read (fd, &di->config_data, sizeof (di->config_data)) <
194 sizeof (di->config0))
196 err = clib_error_return_unix (0, "read `%s'", f);
202 static pci_config_header_t all_ones;
203 if (all_ones.vendor_id == 0)
204 memset (&all_ones, ~0, sizeof (all_ones));
206 if (!memcmp (&di->config0.header, &all_ones, sizeof (all_ones)))
208 err = clib_error_return (0, "invalid PCI config for `%s'", f);
214 if (di->config0.header.header_type == 0)
215 pci_config_type0_little_to_host (&di->config0);
217 pci_config_type1_little_to_host (&di->config1);
220 vec_reset_length (f);
221 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
222 err = clib_sysfs_read ((char *) f, "%u", &di->numa_node);
226 clib_error_free (err);
229 vec_reset_length (f);
230 f = format (f, "%v/class%c", dev_dir_name, 0);
231 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
234 di->device_class = tmp >> 8;
236 vec_reset_length (f);
237 f = format (f, "%v/vendor%c", dev_dir_name, 0);
238 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
243 vec_reset_length (f);
244 f = format (f, "%v/device%c", dev_dir_name, 0);
245 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
250 vec_reset_length (f);
251 f = format (f, "%v/driver%c", dev_dir_name, 0);
252 di->driver_name = clib_sysfs_link_to_name ((char *) f);
254 di->iommu_group = -1;
255 if (lvm->container_fd != -1)
258 vec_reset_length (f);
259 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
260 tmpstr = clib_sysfs_link_to_name ((char *) f);
263 di->iommu_group = atoi ((char *) tmpstr);
266 vec_reset_length (f);
267 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
268 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
271 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
272 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
276 clib_error_free (err);
281 vec_reset_length (f);
282 f = format (f, "%v/vpd%c", dev_dir_name, 0);
283 fd = open ((char *) f, O_RDONLY);
292 if (read (fd, &tag, 3) != 3)
295 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
298 len = (tag[2] << 8) | tag[1];
299 vec_validate (data, len);
301 if (read (fd, data, len) != len)
307 di->product_name = data;
308 else if (tag[0] == 0x90)
310 else if (tag[0] == 0x91)
321 vlib_pci_free_device_info (di);
326 vec_free (dev_dir_name);
330 clib_error_free (err);
335 directory_exists (char *path)
337 struct stat s = { 0 };
338 if (stat (path, &s) == -1)
341 return S_ISDIR (s.st_mode);
345 vlib_pci_bind_to_uio (vlib_pci_addr_t * addr, char *uio_drv_name)
347 clib_error_t *error = 0;
348 u8 *s = 0, *driver_name = 0;
351 vlib_pci_device_info_t *di;
352 int fd, clear_driver_override = 0;
353 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
354 format_vlib_pci_addr, addr);
356 di = vlib_pci_get_device_info (addr, &error);
361 if (strncmp ("auto", uio_drv_name, 5) == 0)
363 int vfio_pci_loaded = 0;
365 if (directory_exists ("/sys/module/vfio_pci"))
368 if (di->iommu_group != -1)
370 /* device is bound to IOMMU group */
371 if (!vfio_pci_loaded)
373 error = clib_error_return (0, "Skipping PCI device %U: device "
374 "is bound to IOMMU group and "
375 "vfio-pci driver is not loaded",
376 format_vlib_pci_addr, addr);
380 uio_drv_name = "vfio-pci";
384 /* device is not bound to IOMMU group so we have multiple options */
385 if (vfio_pci_loaded &&
386 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
387 uio_drv_name = "vfio-pci";
388 else if (directory_exists ("/sys/module/uio_pci_generic"))
389 uio_drv_name = "uio_pci_generic";
390 else if (directory_exists ("/sys/module/igb_uio"))
391 uio_drv_name = "igb_uio";
394 clib_error_free (error);
395 error = clib_error_return (0, "Skipping PCI device %U: missing "
396 "kernel VFIO or UIO driver",
397 format_vlib_pci_addr, addr);
400 clib_error_free (error);
404 s = format (s, "%v/driver%c", dev_dir_name, 0);
405 driver_name = clib_sysfs_link_to_name ((char *) s);
406 vec_reset_length (s);
409 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
410 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
411 (strcmp ("igb_uio", (char *) driver_name) == 0)))
414 /* walk trough all linux interfaces and if interface belonging to
415 this device is founf check if interface is admin up */
416 dir = opendir ("/sys/class/net");
417 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
421 error = clib_error_return (0, "Skipping PCI device %U: failed to "
422 "read /sys/class/net",
423 format_vlib_pci_addr, addr);
427 fd = socket (PF_INET, SOCK_DGRAM, 0);
430 error = clib_error_return_unix (0, "socket");
434 while ((e = readdir (dir)))
437 struct ethtool_drvinfo drvinfo;
439 if (e->d_name[0] == '.') /* skip . and .. */
442 memset (&ifr, 0, sizeof ifr);
443 memset (&drvinfo, 0, sizeof drvinfo);
444 ifr.ifr_data = (char *) &drvinfo;
445 strncpy (ifr.ifr_name, e->d_name, IFNAMSIZ - 1);
446 drvinfo.cmd = ETHTOOL_GDRVINFO;
447 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
449 /* Some interfaces (eg "lo") don't support this ioctl */
450 if ((errno != ENOTSUP) && (errno != ENODEV))
451 clib_unix_warning ("ioctl fetch intf %s bus info error",
456 if (strcmp ((char *) s, drvinfo.bus_info))
459 memset (&ifr, 0, sizeof (ifr));
460 strncpy (ifr.ifr_name, e->d_name, IFNAMSIZ - 1);
461 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
463 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
469 if (ifr.ifr_flags & IFF_UP)
471 error = clib_error_return (0, "Skipping PCI device %U as host "
472 "interface %s is up",
473 format_vlib_pci_addr, addr, e->d_name);
480 vec_reset_length (s);
482 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
483 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
484 vec_reset_length (s);
486 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
487 if (access ((char *) s, F_OK) == 0)
489 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
490 clear_driver_override = 1;
494 vec_reset_length (s);
495 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
496 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
499 vec_reset_length (s);
501 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
502 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
503 vec_reset_length (s);
505 if (clear_driver_override)
507 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
508 clib_sysfs_write ((char *) s, "%c", 0);
509 vec_reset_length (s);
515 vec_free (dev_dir_name);
516 vec_free (driver_name);
521 static clib_error_t *
522 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
524 linux_pci_device_t *l = arg;
525 unformat_input_t input;
527 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
529 if (!unformat (&input, "uio%d", &l->uio_minor))
532 unformat_free (&input);
536 static clib_error_t *
537 vfio_set_irqs (linux_pci_device_t * p, u32 index, u32 start, u32 count,
538 u32 flags, int *efds)
540 int data_len = efds ? count * sizeof (int) : 0;
541 u8 buf[sizeof (struct vfio_irq_set) + data_len];
542 struct vfio_irq_info irq_info = { 0 };
543 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
546 irq_info.argsz = sizeof (struct vfio_irq_info);
547 irq_info.index = index;
549 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &irq_info) < 0)
550 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
551 "'%U'", format_vlib_pci_addr, &p->addr);
553 if (irq_info.count < start + count)
554 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
555 "'%U'", format_vlib_pci_addr, &p->addr);
560 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
561 clib_memcpy (&irq_set->data, efds, data_len);
564 flags |= VFIO_IRQ_SET_DATA_NONE;
566 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
567 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
569 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
570 irq_set->index = index;
571 irq_set->start = start;
572 irq_set->count = count;
573 irq_set->flags = flags;
575 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
576 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
577 "[index = %u, start = %u, count = %u, "
579 format_vlib_pci_addr, &p->addr,
580 index, start, count, flags);
584 static clib_error_t *
585 linux_pci_uio_read_ready (clib_file_t * uf)
587 int __attribute__ ((unused)) rv;
588 vlib_pci_dev_handle_t h = uf->private_data;
589 linux_pci_device_t *p = linux_pci_get_device (h);
590 linux_pci_irq_t *irq = &p->intx_irq;
593 rv = read (uf->file_descriptor, &icount, 4);
595 if (irq->intx_handler)
596 irq->intx_handler (h);
598 vlib_pci_intr_enable (h);
600 return /* no error */ 0;
603 static clib_error_t *
604 linux_pci_vfio_unmask_intx (linux_pci_device_t * d)
606 return vfio_set_irqs (d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
607 VFIO_IRQ_SET_ACTION_UNMASK, 0);
610 static clib_error_t *
611 linux_pci_uio_error_ready (clib_file_t * uf)
613 u32 error_index = (u32) uf->private_data;
615 return clib_error_return (0, "pci device %d: error", error_index);
618 static clib_error_t *
619 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
621 int __attribute__ ((unused)) rv;
622 vlib_pci_dev_handle_t h = uf->private_data >> 16;
623 u16 line = uf->private_data & 0xffff;
624 linux_pci_device_t *p = linux_pci_get_device (h);
625 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
628 rv = read (uf->file_descriptor, &icount, sizeof (icount));
630 if (irq->msix_handler)
631 irq->msix_handler (h, line);
633 return /* no error */ 0;
636 static clib_error_t *
637 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
639 int __attribute__ ((unused)) rv;
640 vlib_pci_dev_handle_t h = uf->private_data;
641 linux_pci_device_t *p = linux_pci_get_device (h);
642 linux_pci_irq_t *irq = &p->intx_irq;
645 rv = read (uf->file_descriptor, &icount, sizeof (icount));
647 if (irq->intx_handler)
648 irq->intx_handler (h);
650 linux_pci_vfio_unmask_intx (p);
652 return /* no error */ 0;
655 static clib_error_t *
656 linux_pci_vfio_error_ready (clib_file_t * uf)
658 u32 error_index = (u32) uf->private_data;
660 return clib_error_return (0, "pci device %d: error", error_index);
663 static clib_error_t *
664 add_device_uio (linux_pci_device_t * p, vlib_pci_device_info_t * di,
665 pci_device_registration_t * r)
667 linux_pci_main_t *lpm = &linux_pci_main;
668 clib_error_t *err = 0;
671 p->addr.as_u32 = di->addr.as_u32;
673 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
675 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
676 format_vlib_pci_addr, &di->addr, 0);
678 p->config_fd = open ((char *) s, O_RDWR);
679 p->config_offset = 0;
680 vec_reset_length (s);
682 if (p->config_fd == -1)
684 err = clib_error_return_unix (0, "open '%s'", s);
688 s = format (0, "%s/%U/uio", sysfs_pci_dev_path,
689 format_vlib_pci_addr, &di->addr);
690 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
692 vec_reset_length (s);
694 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
695 p->fd = open ((char *) s, O_RDWR);
698 err = clib_error_return_unix (0, "open '%s'", s);
702 if (r && r->interrupt_handler)
703 vlib_pci_register_intx_handler (p->handle, r->interrupt_handler);
705 if (r && r->init_function)
706 err = r->init_function (lpm->vlib_main, p->handle);
712 if (p->config_fd != -1)
713 close (p->config_fd);
721 vlib_pci_register_intx_handler (vlib_pci_dev_handle_t h,
722 pci_intx_handler_function_t * intx_handler)
724 linux_pci_device_t *p = linux_pci_get_device (h);
725 clib_file_t t = { 0 };
726 linux_pci_irq_t *irq = &p->intx_irq;
727 ASSERT (irq->fd == -1);
729 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
731 struct vfio_irq_info irq_info = { 0 };
732 irq_info.argsz = sizeof (struct vfio_irq_info);
733 irq_info.index = VFIO_PCI_INTX_IRQ_INDEX;
734 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &irq_info) < 0)
735 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
736 "%U'", format_vlib_pci_addr, &p->addr);
737 if (irq_info.count != 1)
738 return clib_error_return (0, "INTx interrupt does not exist on device"
739 "'%U'", format_vlib_pci_addr, &p->addr);
741 irq->fd = eventfd (0, EFD_NONBLOCK);
743 return clib_error_return_unix (0, "eventfd");
744 t.file_descriptor = irq->fd;
745 t.read_function = linux_pci_vfio_intx_read_ready;
747 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
749 t.file_descriptor = p->fd;
750 t.read_function = linux_pci_uio_read_ready;
755 t.error_function = linux_pci_uio_error_ready;
756 t.private_data = p->handle;
757 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
758 irq->clib_file_index = clib_file_add (&file_main, &t);
759 irq->intx_handler = intx_handler;
764 vlib_pci_register_msix_handler (vlib_pci_dev_handle_t h, u32 start, u32 count,
765 pci_msix_handler_function_t * msix_handler)
767 clib_error_t *err = 0;
768 linux_pci_device_t *p = linux_pci_get_device (h);
771 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
772 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
776 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
780 for (i = start; i < start + count; i++)
782 clib_file_t t = { 0 };
783 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
784 ASSERT (irq->fd == -1);
786 irq->fd = eventfd (0, EFD_NONBLOCK);
789 err = clib_error_return_unix (0, "eventfd");
793 t.read_function = linux_pci_vfio_msix_read_ready;
794 t.file_descriptor = irq->fd;
795 t.error_function = linux_pci_vfio_error_ready;
796 t.private_data = p->handle << 16 | i;
797 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
799 irq->clib_file_index = clib_file_add (&file_main, &t);
800 irq->msix_handler = msix_handler;
808 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
811 clib_file_del_by_index (&file_main, irq->clib_file_index);
820 vlib_pci_enable_msix_irq (vlib_pci_dev_handle_t h, u16 start, u16 count)
822 linux_pci_device_t *p = linux_pci_get_device (h);
826 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
827 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
830 for (i = start; i < start + count; i++)
832 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
836 return vfio_set_irqs (p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
837 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
841 vlib_pci_disable_msix_irq (vlib_pci_dev_handle_t h, u16 start, u16 count)
843 linux_pci_device_t *p = linux_pci_get_device (h);
846 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
847 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
850 for (i = start; i < start + count; i++)
853 return vfio_set_irqs (p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
854 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
857 static clib_error_t *
858 add_device_vfio (linux_pci_device_t * p, vlib_pci_device_info_t * di,
859 pci_device_registration_t * r)
861 linux_pci_main_t *lpm = &linux_pci_main;
862 struct vfio_device_info device_info = { 0 };
863 struct vfio_region_info reg = { 0 };
864 clib_error_t *err = 0;
867 p->addr.as_u32 = di->addr.as_u32;
868 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
870 if (di->driver_name == 0 ||
871 (strcmp ("vfio-pci", (char *) di->driver_name) != 0))
872 return clib_error_return (0, "Device '%U' (iommu group %d) not bound to "
873 "vfio-pci", format_vlib_pci_addr, &di->addr,
876 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd)))
879 device_info.argsz = sizeof (device_info);
880 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
882 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
883 format_vlib_pci_addr, &di->addr);
887 reg.argsz = sizeof (struct vfio_region_info);
888 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
889 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
891 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
892 format_vlib_pci_addr, &di->addr);
895 p->config_offset = reg.offset;
896 p->config_fd = p->fd;
898 /* reset if device supports it */
899 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
900 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
902 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
903 format_vlib_pci_addr, &di->addr);
907 if (r && r->interrupt_handler)
909 vlib_pci_register_intx_handler (p->handle, r->interrupt_handler);
910 linux_pci_vfio_unmask_intx (p);
913 if (r && r->init_function)
914 err = r->init_function (lpm->vlib_main, p->handle);
922 if (p->config_fd != -1)
923 close (p->config_fd);
928 /* Configuration space read/write. */
930 vlib_pci_read_write_config (vlib_pci_dev_handle_t h,
931 vlib_read_or_write_t read_or_write,
932 uword address, void *data, u32 n_bytes)
934 linux_pci_device_t *p = linux_pci_get_device (h);
937 if (read_or_write == VLIB_READ)
938 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
940 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
943 return clib_error_return_unix (0, "%s",
944 read_or_write == VLIB_READ
950 static clib_error_t *
951 vlib_pci_map_region_int (vlib_pci_dev_handle_t h,
952 u32 bar, u8 * addr, void **result)
954 linux_pci_device_t *p = linux_pci_get_device (h);
957 int flags = MAP_SHARED;
958 u64 size = 0, offset = 0;
964 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
967 struct stat stat_buf;
968 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
969 format_vlib_pci_addr, &p->addr, bar, 0);
971 fd = open ((char *) file_name, O_RDWR);
974 error = clib_error_return_unix (0, "open `%s'", file_name);
975 vec_free (file_name);
979 if (fstat (fd, &stat_buf) < 0)
981 error = clib_error_return_unix (0, "fstat `%s'", file_name);
982 vec_free (file_name);
987 vec_free (file_name);
990 size = stat_buf.st_size;
993 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
995 struct vfio_region_info reg = { 0 };
996 reg.argsz = sizeof (struct vfio_region_info);
998 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
999 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1000 "'%U'", format_vlib_pci_addr,
1004 offset = reg.offset;
1009 *result = mmap (addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
1010 if (*result == (void *) -1)
1012 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1013 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1019 vec_validate_init_empty (p->regions, bar,
1020 (linux_pci_region_t) { .fd = -1});
1022 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1023 p->regions[bar].fd = fd;
1024 p->regions[bar].addr = *result;
1025 p->regions[bar].size = size;
1030 vlib_pci_map_region (vlib_pci_dev_handle_t h, u32 resource, void **result)
1032 return (vlib_pci_map_region_int (h, resource, 0 /* addr */ , result));
1036 vlib_pci_map_region_fixed (vlib_pci_dev_handle_t h, u32 resource, u8 * addr,
1039 return (vlib_pci_map_region_int (h, resource, addr, result));
1043 vlib_pci_device_open (vlib_pci_addr_t * addr,
1044 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1046 linux_pci_main_t *lpm = &linux_pci_main;
1047 vlib_pci_device_info_t *di;
1048 linux_pci_device_t *p;
1049 clib_error_t *err = 0;
1052 di = vlib_pci_get_device_info (addr, &err);
1056 for (i = ids; i->vendor_id != 0; i++)
1057 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1060 if (i->vendor_id == 0)
1061 return clib_error_return (0, "Wrong vendor or device id");
1063 pool_get (lpm->linux_pci_devices, p);
1064 p->handle = p - lpm->linux_pci_devices;
1065 p->intx_irq.fd = -1;
1067 if (di->iommu_group != -1)
1068 err = add_device_vfio (p, di, 0);
1070 err = add_device_uio (p, di, 0);
1074 *handle = p->handle;
1077 vlib_pci_free_device_info (di);
1080 memset (p, 0, sizeof (linux_pci_device_t));
1081 pool_put (lpm->linux_pci_devices, p);
1088 vlib_pci_device_close (vlib_pci_dev_handle_t h)
1090 linux_pci_main_t *lpm = &linux_pci_main;
1091 linux_pci_device_t *p = linux_pci_get_device (h);
1092 linux_pci_irq_t *irq;
1093 linux_pci_region_t *res;
1094 clib_error_t *err = 0;
1096 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1099 clib_file_del_by_index (&file_main, irq->clib_file_index);
1100 close (p->config_fd);
1102 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1105 /* close INTx irqs */
1108 err = vfio_set_irqs (p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1109 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1110 clib_error_free (err);
1111 clib_file_del_by_index (&file_main, irq->clib_file_index);
1115 /* close MSI-X irqs */
1116 if (vec_len (p->msix_irqs))
1118 err = vfio_set_irqs (p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1119 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1120 clib_error_free (err);
1122 vec_foreach (irq, p->msix_irqs)
1126 clib_file_del_by_index (&file_main, irq->clib_file_index);
1130 vec_free (p->msix_irqs);
1135 vec_foreach (res, p->regions)
1139 munmap (res->addr, res->size);
1144 vec_free (p->regions);
1147 memset (p, 0, sizeof (linux_pci_device_t));
1148 pool_put (lpm->linux_pci_devices, p);
1152 init_device_from_registered (vlib_pci_device_info_t * di)
1154 vlib_pci_main_t *pm = &pci_main;
1155 linux_pci_main_t *lpm = &linux_pci_main;
1156 pci_device_registration_t *r;
1158 clib_error_t *err = 0;
1159 linux_pci_device_t *p;
1161 pool_get (lpm->linux_pci_devices, p);
1162 p->handle = p - lpm->linux_pci_devices;
1163 p->intx_irq.fd = -1;
1165 r = pm->pci_device_registrations;
1169 for (i = r->supported_devices; i->vendor_id != 0; i++)
1170 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1172 if (di->iommu_group != -1)
1173 err = add_device_vfio (p, di, r);
1175 err = add_device_uio (p, di, r);
1178 clib_error_report (err);
1182 r = r->next_registration;
1185 /* No driver, close the PCI config-space FD */
1186 memset (p, 0, sizeof (linux_pci_device_t));
1187 pool_put (lpm->linux_pci_devices, p);
1190 static clib_error_t *
1191 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1193 vlib_pci_addr_t addr, **addrv = arg;
1194 unformat_input_t input;
1195 clib_error_t *err = 0;
1197 unformat_init_string (&input, (char *) dev_dir_name,
1198 vec_len (dev_dir_name));
1200 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1201 unformat_vlib_pci_addr, &addr))
1202 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1204 unformat_free (&input);
1209 vec_add1 (*addrv, addr);
1214 pci_addr_cmp (void *v1, void *v2)
1216 vlib_pci_addr_t *a1 = v1;
1217 vlib_pci_addr_t *a2 = v2;
1219 if (a1->domain > a2->domain)
1221 if (a1->domain < a2->domain)
1223 if (a1->bus > a2->bus)
1225 if (a1->bus < a2->bus)
1227 if (a1->slot > a2->slot)
1229 if (a1->slot < a2->slot)
1231 if (a1->function > a2->function)
1233 if (a1->function < a2->function)
1239 vlib_pci_get_all_dev_addrs ()
1241 vlib_pci_addr_t *addrs = 0;
1243 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1244 &addrs, /* scan_dirs */ 0);
1251 vec_sort_with_function (addrs, pci_addr_cmp);
1257 linux_pci_init (vlib_main_t * vm)
1259 vlib_pci_main_t *pm = &pci_main;
1260 vlib_pci_addr_t *addr = 0, *addrs;
1261 clib_error_t *error;
1265 if ((error = vlib_call_init_function (vm, unix_input_init)))
1268 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1270 addrs = vlib_pci_get_all_dev_addrs ();
1272 vec_foreach (addr, addrs)
1274 vlib_pci_device_info_t *d;
1275 if ((d = vlib_pci_get_device_info (addr, 0)))
1277 init_device_from_registered (d);
1278 vlib_pci_free_device_info (d);
1286 VLIB_INIT_FUNCTION (linux_pci_init);
1289 * fd.io coding-style-patch-verification: ON
1292 * eval: (c-set-style "gnu")