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, sizeof (ifr.ifr_name));
446 ifr.ifr_name[ARRAY_LEN (ifr.ifr_name) - 1] = '\0';
447 drvinfo.cmd = ETHTOOL_GDRVINFO;
448 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
450 /* Some interfaces (eg "lo") don't support this ioctl */
451 if ((errno != ENOTSUP) && (errno != ENODEV))
452 clib_unix_warning ("ioctl fetch intf %s bus info error",
457 if (strcmp ((char *) s, drvinfo.bus_info))
460 memset (&ifr, 0, sizeof (ifr));
461 strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name));
462 ifr.ifr_name[ARRAY_LEN (ifr.ifr_name) - 1] = '\0';
463 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
465 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
471 if (ifr.ifr_flags & IFF_UP)
473 error = clib_error_return (0, "Skipping PCI device %U as host "
474 "interface %s is up",
475 format_vlib_pci_addr, addr, e->d_name);
482 vec_reset_length (s);
484 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
485 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
486 vec_reset_length (s);
488 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
489 if (access ((char *) s, F_OK) == 0)
491 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
492 clear_driver_override = 1;
496 vec_reset_length (s);
497 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
498 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
501 vec_reset_length (s);
503 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
504 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
505 vec_reset_length (s);
507 if (clear_driver_override)
509 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
510 clib_sysfs_write ((char *) s, "%c", 0);
511 vec_reset_length (s);
517 vec_free (dev_dir_name);
518 vec_free (driver_name);
523 static clib_error_t *
524 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
526 linux_pci_device_t *l = arg;
527 unformat_input_t input;
529 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
531 if (!unformat (&input, "uio%d", &l->uio_minor))
534 unformat_free (&input);
538 static clib_error_t *
539 vfio_set_irqs (linux_pci_device_t * p, u32 index, u32 start, u32 count,
540 u32 flags, int *efds)
542 int data_len = efds ? count * sizeof (int) : 0;
543 u8 buf[sizeof (struct vfio_irq_set) + data_len];
544 struct vfio_irq_info irq_info = { 0 };
545 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
548 irq_info.argsz = sizeof (struct vfio_irq_info);
549 irq_info.index = index;
551 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &irq_info) < 0)
552 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
553 "'%U'", format_vlib_pci_addr, &p->addr);
555 if (irq_info.count < start + count)
556 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
557 "'%U'", format_vlib_pci_addr, &p->addr);
562 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
563 clib_memcpy (&irq_set->data, efds, data_len);
566 flags |= VFIO_IRQ_SET_DATA_NONE;
568 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
569 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
571 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
572 irq_set->index = index;
573 irq_set->start = start;
574 irq_set->count = count;
575 irq_set->flags = flags;
577 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
578 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
579 "[index = %u, start = %u, count = %u, "
581 format_vlib_pci_addr, &p->addr,
582 index, start, count, flags);
586 static clib_error_t *
587 linux_pci_uio_read_ready (clib_file_t * uf)
589 int __attribute__ ((unused)) rv;
590 vlib_pci_dev_handle_t h = uf->private_data;
591 linux_pci_device_t *p = linux_pci_get_device (h);
592 linux_pci_irq_t *irq = &p->intx_irq;
595 rv = read (uf->file_descriptor, &icount, 4);
597 if (irq->intx_handler)
598 irq->intx_handler (h);
600 vlib_pci_intr_enable (h);
602 return /* no error */ 0;
605 static clib_error_t *
606 linux_pci_vfio_unmask_intx (linux_pci_device_t * d)
608 return vfio_set_irqs (d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
609 VFIO_IRQ_SET_ACTION_UNMASK, 0);
612 static clib_error_t *
613 linux_pci_uio_error_ready (clib_file_t * uf)
615 u32 error_index = (u32) uf->private_data;
617 return clib_error_return (0, "pci device %d: error", error_index);
620 static clib_error_t *
621 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
623 int __attribute__ ((unused)) rv;
624 vlib_pci_dev_handle_t h = uf->private_data >> 16;
625 u16 line = uf->private_data & 0xffff;
626 linux_pci_device_t *p = linux_pci_get_device (h);
627 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
630 rv = read (uf->file_descriptor, &icount, sizeof (icount));
632 if (irq->msix_handler)
633 irq->msix_handler (h, line);
635 return /* no error */ 0;
638 static clib_error_t *
639 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
641 int __attribute__ ((unused)) rv;
642 vlib_pci_dev_handle_t h = uf->private_data;
643 linux_pci_device_t *p = linux_pci_get_device (h);
644 linux_pci_irq_t *irq = &p->intx_irq;
647 rv = read (uf->file_descriptor, &icount, sizeof (icount));
649 if (irq->intx_handler)
650 irq->intx_handler (h);
652 linux_pci_vfio_unmask_intx (p);
654 return /* no error */ 0;
657 static clib_error_t *
658 linux_pci_vfio_error_ready (clib_file_t * uf)
660 u32 error_index = (u32) uf->private_data;
662 return clib_error_return (0, "pci device %d: error", error_index);
665 static clib_error_t *
666 add_device_uio (linux_pci_device_t * p, vlib_pci_device_info_t * di,
667 pci_device_registration_t * r)
669 linux_pci_main_t *lpm = &linux_pci_main;
670 clib_error_t *err = 0;
673 p->addr.as_u32 = di->addr.as_u32;
675 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
677 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
678 format_vlib_pci_addr, &di->addr, 0);
680 p->config_fd = open ((char *) s, O_RDWR);
681 p->config_offset = 0;
682 vec_reset_length (s);
684 if (p->config_fd == -1)
686 err = clib_error_return_unix (0, "open '%s'", s);
690 s = format (0, "%s/%U/uio", sysfs_pci_dev_path,
691 format_vlib_pci_addr, &di->addr);
692 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
694 vec_reset_length (s);
696 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
697 p->fd = open ((char *) s, O_RDWR);
700 err = clib_error_return_unix (0, "open '%s'", s);
704 if (r && r->interrupt_handler)
705 vlib_pci_register_intx_handler (p->handle, r->interrupt_handler);
707 if (r && r->init_function)
708 err = r->init_function (lpm->vlib_main, p->handle);
714 if (p->config_fd != -1)
715 close (p->config_fd);
723 vlib_pci_register_intx_handler (vlib_pci_dev_handle_t h,
724 pci_intx_handler_function_t * intx_handler)
726 linux_pci_device_t *p = linux_pci_get_device (h);
727 clib_file_t t = { 0 };
728 linux_pci_irq_t *irq = &p->intx_irq;
729 ASSERT (irq->fd == -1);
731 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
733 struct vfio_irq_info irq_info = { 0 };
734 irq_info.argsz = sizeof (struct vfio_irq_info);
735 irq_info.index = VFIO_PCI_INTX_IRQ_INDEX;
736 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &irq_info) < 0)
737 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
738 "%U'", format_vlib_pci_addr, &p->addr);
739 if (irq_info.count != 1)
740 return clib_error_return (0, "INTx interrupt does not exist on device"
741 "'%U'", format_vlib_pci_addr, &p->addr);
743 irq->fd = eventfd (0, EFD_NONBLOCK);
745 return clib_error_return_unix (0, "eventfd");
746 t.file_descriptor = irq->fd;
747 t.read_function = linux_pci_vfio_intx_read_ready;
749 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
751 t.file_descriptor = p->fd;
752 t.read_function = linux_pci_uio_read_ready;
757 t.error_function = linux_pci_uio_error_ready;
758 t.private_data = p->handle;
759 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
760 irq->clib_file_index = clib_file_add (&file_main, &t);
761 irq->intx_handler = intx_handler;
766 vlib_pci_register_msix_handler (vlib_pci_dev_handle_t h, u32 start, u32 count,
767 pci_msix_handler_function_t * msix_handler)
769 clib_error_t *err = 0;
770 linux_pci_device_t *p = linux_pci_get_device (h);
773 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
774 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
778 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
782 for (i = start; i < start + count; i++)
784 clib_file_t t = { 0 };
785 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
786 ASSERT (irq->fd == -1);
788 irq->fd = eventfd (0, EFD_NONBLOCK);
791 err = clib_error_return_unix (0, "eventfd");
795 t.read_function = linux_pci_vfio_msix_read_ready;
796 t.file_descriptor = irq->fd;
797 t.error_function = linux_pci_vfio_error_ready;
798 t.private_data = p->handle << 16 | i;
799 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
801 irq->clib_file_index = clib_file_add (&file_main, &t);
802 irq->msix_handler = msix_handler;
810 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
813 clib_file_del_by_index (&file_main, irq->clib_file_index);
822 vlib_pci_enable_msix_irq (vlib_pci_dev_handle_t h, u16 start, u16 count)
824 linux_pci_device_t *p = linux_pci_get_device (h);
828 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
829 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
832 for (i = start; i < start + count; i++)
834 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
838 return vfio_set_irqs (p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
839 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
843 vlib_pci_disable_msix_irq (vlib_pci_dev_handle_t h, u16 start, u16 count)
845 linux_pci_device_t *p = linux_pci_get_device (h);
848 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
849 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
852 for (i = start; i < start + count; i++)
855 return vfio_set_irqs (p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
856 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
859 static clib_error_t *
860 add_device_vfio (linux_pci_device_t * p, vlib_pci_device_info_t * di,
861 pci_device_registration_t * r)
863 linux_pci_main_t *lpm = &linux_pci_main;
864 struct vfio_device_info device_info = { 0 };
865 struct vfio_region_info reg = { 0 };
866 clib_error_t *err = 0;
869 p->addr.as_u32 = di->addr.as_u32;
870 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
872 if (di->driver_name == 0 ||
873 (strcmp ("vfio-pci", (char *) di->driver_name) != 0))
874 return clib_error_return (0, "Device '%U' (iommu group %d) not bound to "
875 "vfio-pci", format_vlib_pci_addr, &di->addr,
878 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd)))
881 device_info.argsz = sizeof (device_info);
882 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
884 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
885 format_vlib_pci_addr, &di->addr);
889 reg.argsz = sizeof (struct vfio_region_info);
890 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
891 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
893 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
894 format_vlib_pci_addr, &di->addr);
897 p->config_offset = reg.offset;
898 p->config_fd = p->fd;
900 /* reset if device supports it */
901 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
902 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
904 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
905 format_vlib_pci_addr, &di->addr);
909 if (r && r->interrupt_handler)
911 vlib_pci_register_intx_handler (p->handle, r->interrupt_handler);
912 linux_pci_vfio_unmask_intx (p);
915 if (r && r->init_function)
916 err = r->init_function (lpm->vlib_main, p->handle);
924 if (p->config_fd != -1 && p->config_fd != p->fd)
925 close (p->config_fd);
926 p->config_fd = p->fd = -1;
931 /* Configuration space read/write. */
933 vlib_pci_read_write_config (vlib_pci_dev_handle_t h,
934 vlib_read_or_write_t read_or_write,
935 uword address, void *data, u32 n_bytes)
937 linux_pci_device_t *p = linux_pci_get_device (h);
940 if (read_or_write == VLIB_READ)
941 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
943 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
946 return clib_error_return_unix (0, "%s",
947 read_or_write == VLIB_READ
953 static clib_error_t *
954 vlib_pci_map_region_int (vlib_pci_dev_handle_t h,
955 u32 bar, u8 * addr, void **result)
957 linux_pci_device_t *p = linux_pci_get_device (h);
960 int flags = MAP_SHARED;
961 u64 size = 0, offset = 0;
967 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
970 struct stat stat_buf;
971 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
972 format_vlib_pci_addr, &p->addr, bar, 0);
974 fd = open ((char *) file_name, O_RDWR);
977 error = clib_error_return_unix (0, "open `%s'", file_name);
978 vec_free (file_name);
982 if (fstat (fd, &stat_buf) < 0)
984 error = clib_error_return_unix (0, "fstat `%s'", file_name);
985 vec_free (file_name);
990 vec_free (file_name);
993 size = stat_buf.st_size;
996 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
998 struct vfio_region_info reg = { 0 };
999 reg.argsz = sizeof (struct vfio_region_info);
1001 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1002 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1003 "'%U'", format_vlib_pci_addr,
1007 offset = reg.offset;
1012 *result = mmap (addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
1013 if (*result == (void *) -1)
1015 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1016 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1022 vec_validate_init_empty (p->regions, bar,
1023 (linux_pci_region_t) { .fd = -1});
1025 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1026 p->regions[bar].fd = fd;
1027 p->regions[bar].addr = *result;
1028 p->regions[bar].size = size;
1033 vlib_pci_map_region (vlib_pci_dev_handle_t h, u32 resource, void **result)
1035 return (vlib_pci_map_region_int (h, resource, 0 /* addr */ , result));
1039 vlib_pci_map_region_fixed (vlib_pci_dev_handle_t h, u32 resource, u8 * addr,
1042 return (vlib_pci_map_region_int (h, resource, addr, result));
1046 vlib_pci_device_open (vlib_pci_addr_t * addr,
1047 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1049 linux_pci_main_t *lpm = &linux_pci_main;
1050 vlib_pci_device_info_t *di;
1051 linux_pci_device_t *p;
1052 clib_error_t *err = 0;
1055 di = vlib_pci_get_device_info (addr, &err);
1059 for (i = ids; i->vendor_id != 0; i++)
1060 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1063 if (i->vendor_id == 0)
1064 return clib_error_return (0, "Wrong vendor or device id");
1066 pool_get (lpm->linux_pci_devices, p);
1067 p->handle = p - lpm->linux_pci_devices;
1068 p->intx_irq.fd = -1;
1070 if (di->iommu_group != -1)
1071 err = add_device_vfio (p, di, 0);
1073 err = add_device_uio (p, di, 0);
1077 *handle = p->handle;
1080 vlib_pci_free_device_info (di);
1083 memset (p, 0, sizeof (linux_pci_device_t));
1084 pool_put (lpm->linux_pci_devices, p);
1091 vlib_pci_device_close (vlib_pci_dev_handle_t h)
1093 linux_pci_main_t *lpm = &linux_pci_main;
1094 linux_pci_device_t *p = linux_pci_get_device (h);
1095 linux_pci_irq_t *irq;
1096 linux_pci_region_t *res;
1097 clib_error_t *err = 0;
1099 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1102 clib_file_del_by_index (&file_main, irq->clib_file_index);
1103 close (p->config_fd);
1105 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1108 /* close INTx irqs */
1111 err = vfio_set_irqs (p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1112 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1113 clib_error_free (err);
1114 clib_file_del_by_index (&file_main, irq->clib_file_index);
1118 /* close MSI-X irqs */
1119 if (vec_len (p->msix_irqs))
1121 err = vfio_set_irqs (p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1122 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1123 clib_error_free (err);
1125 vec_foreach (irq, p->msix_irqs)
1129 clib_file_del_by_index (&file_main, irq->clib_file_index);
1133 vec_free (p->msix_irqs);
1138 vec_foreach (res, p->regions)
1142 munmap (res->addr, res->size);
1147 vec_free (p->regions);
1150 memset (p, 0, sizeof (linux_pci_device_t));
1151 pool_put (lpm->linux_pci_devices, p);
1155 init_device_from_registered (vlib_pci_device_info_t * di)
1157 vlib_pci_main_t *pm = &pci_main;
1158 linux_pci_main_t *lpm = &linux_pci_main;
1159 pci_device_registration_t *r;
1161 clib_error_t *err = 0;
1162 linux_pci_device_t *p;
1164 pool_get (lpm->linux_pci_devices, p);
1165 p->handle = p - lpm->linux_pci_devices;
1166 p->intx_irq.fd = -1;
1168 r = pm->pci_device_registrations;
1172 for (i = r->supported_devices; i->vendor_id != 0; i++)
1173 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1175 if (di->iommu_group != -1)
1176 err = add_device_vfio (p, di, r);
1178 err = add_device_uio (p, di, r);
1181 clib_error_report (err);
1185 r = r->next_registration;
1188 /* No driver, close the PCI config-space FD */
1189 memset (p, 0, sizeof (linux_pci_device_t));
1190 pool_put (lpm->linux_pci_devices, p);
1193 static clib_error_t *
1194 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1196 vlib_pci_addr_t addr, **addrv = arg;
1197 unformat_input_t input;
1198 clib_error_t *err = 0;
1200 unformat_init_string (&input, (char *) dev_dir_name,
1201 vec_len (dev_dir_name));
1203 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1204 unformat_vlib_pci_addr, &addr))
1205 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1207 unformat_free (&input);
1212 vec_add1 (*addrv, addr);
1217 pci_addr_cmp (void *v1, void *v2)
1219 vlib_pci_addr_t *a1 = v1;
1220 vlib_pci_addr_t *a2 = v2;
1222 if (a1->domain > a2->domain)
1224 if (a1->domain < a2->domain)
1226 if (a1->bus > a2->bus)
1228 if (a1->bus < a2->bus)
1230 if (a1->slot > a2->slot)
1232 if (a1->slot < a2->slot)
1234 if (a1->function > a2->function)
1236 if (a1->function < a2->function)
1242 vlib_pci_get_all_dev_addrs ()
1244 vlib_pci_addr_t *addrs = 0;
1246 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1247 &addrs, /* scan_dirs */ 0);
1254 vec_sort_with_function (addrs, pci_addr_cmp);
1260 linux_pci_init (vlib_main_t * vm)
1262 vlib_pci_main_t *pm = &pci_main;
1263 vlib_pci_addr_t *addr = 0, *addrs;
1264 clib_error_t *error;
1268 if ((error = vlib_call_init_function (vm, unix_input_init)))
1271 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1273 addrs = vlib_pci_get_all_dev_addrs ();
1275 vec_foreach (addr, addrs)
1277 vlib_pci_device_info_t *d;
1278 if ((d = vlib_pci_get_device_info (addr, 0)))
1280 init_device_from_registered (d);
1281 vlib_pci_free_device_info (d);
1289 VLIB_INIT_FUNCTION (linux_pci_init);
1292 * fd.io coding-style-patch-verification: ON
1295 * eval: (c-set-style "gnu")