xref: /openbmc/qemu/hw/xen/xen_pt.c (revision 798141799ccd5235a928b8fc0411d7d74e706489)
1 /*
2  * Copyright (c) 2007, Neocleus Corporation.
3  * Copyright (c) 2007, Intel Corporation.
4  *
5  * This work is licensed under the terms of the GNU GPL, version 2.  See
6  * the COPYING file in the top-level directory.
7  *
8  * Alex Novik <alex@neocleus.com>
9  * Allen Kay <allen.m.kay@intel.com>
10  * Guy Zana <guy@neocleus.com>
11  *
12  * This file implements direct PCI assignment to a HVM guest
13  */
14 
15 /*
16  * Interrupt Disable policy:
17  *
18  * INTx interrupt:
19  *   Initialize(register_real_device)
20  *     Map INTx(xc_physdev_map_pirq):
21  *       <fail>
22  *         - Set real Interrupt Disable bit to '1'.
23  *         - Set machine_irq and assigned_device->machine_irq to '0'.
24  *         * Don't bind INTx.
25  *
26  *     Bind INTx(xc_domain_bind_pt_pci_irq):
27  *       <fail>
28  *         - Set real Interrupt Disable bit to '1'.
29  *         - Unmap INTx.
30  *         - Decrement xen_pt_mapped_machine_irq[machine_irq]
31  *         - Set assigned_device->machine_irq to '0'.
32  *
33  *   Write to Interrupt Disable bit by guest software(xen_pt_cmd_reg_write)
34  *     Write '0'
35  *       - Set real bit to '0' if assigned_device->machine_irq isn't '0'.
36  *
37  *     Write '1'
38  *       - Set real bit to '1'.
39  *
40  * MSI interrupt:
41  *   Initialize MSI register(xen_pt_msi_setup, xen_pt_msi_update)
42  *     Bind MSI(xc_domain_update_msi_irq)
43  *       <fail>
44  *         - Unmap MSI.
45  *         - Set dev->msi->pirq to '-1'.
46  *
47  * MSI-X interrupt:
48  *   Initialize MSI-X register(xen_pt_msix_update_one)
49  *     Bind MSI-X(xc_domain_update_msi_irq)
50  *       <fail>
51  *         - Unmap MSI-X.
52  *         - Set entry->pirq to '-1'.
53  */
54 
55 #include <sys/ioctl.h>
56 
57 #include "hw/pci/pci.h"
58 #include "hw/xen/xen.h"
59 #include "hw/xen/xen_backend.h"
60 #include "xen_pt.h"
61 #include "qemu/range.h"
62 #include "exec/address-spaces.h"
63 
64 #define XEN_PT_NR_IRQS (256)
65 static uint8_t xen_pt_mapped_machine_irq[XEN_PT_NR_IRQS] = {0};
66 
67 void xen_pt_log(const PCIDevice *d, const char *f, ...)
68 {
69     va_list ap;
70 
71     va_start(ap, f);
72     if (d) {
73         fprintf(stderr, "[%02x:%02x.%d] ", pci_bus_num(d->bus),
74                 PCI_SLOT(d->devfn), PCI_FUNC(d->devfn));
75     }
76     vfprintf(stderr, f, ap);
77     va_end(ap);
78 }
79 
80 /* Config Space */
81 
82 static int xen_pt_pci_config_access_check(PCIDevice *d, uint32_t addr, int len)
83 {
84     /* check offset range */
85     if (addr >= 0xFF) {
86         XEN_PT_ERR(d, "Failed to access register with offset exceeding 0xFF. "
87                    "(addr: 0x%02x, len: %d)\n", addr, len);
88         return -1;
89     }
90 
91     /* check read size */
92     if ((len != 1) && (len != 2) && (len != 4)) {
93         XEN_PT_ERR(d, "Failed to access register with invalid access length. "
94                    "(addr: 0x%02x, len: %d)\n", addr, len);
95         return -1;
96     }
97 
98     /* check offset alignment */
99     if (addr & (len - 1)) {
100         XEN_PT_ERR(d, "Failed to access register with invalid access size "
101                    "alignment. (addr: 0x%02x, len: %d)\n", addr, len);
102         return -1;
103     }
104 
105     return 0;
106 }
107 
108 int xen_pt_bar_offset_to_index(uint32_t offset)
109 {
110     int index = 0;
111 
112     /* check Exp ROM BAR */
113     if (offset == PCI_ROM_ADDRESS) {
114         return PCI_ROM_SLOT;
115     }
116 
117     /* calculate BAR index */
118     index = (offset - PCI_BASE_ADDRESS_0) >> 2;
119     if (index >= PCI_NUM_REGIONS) {
120         return -1;
121     }
122 
123     return index;
124 }
125 
126 static uint32_t xen_pt_pci_read_config(PCIDevice *d, uint32_t addr, int len)
127 {
128     XenPCIPassthroughState *s = XEN_PT_DEVICE(d);
129     uint32_t val = 0;
130     XenPTRegGroup *reg_grp_entry = NULL;
131     XenPTReg *reg_entry = NULL;
132     int rc = 0;
133     int emul_len = 0;
134     uint32_t find_addr = addr;
135 
136     if (xen_pt_pci_config_access_check(d, addr, len)) {
137         goto exit;
138     }
139 
140     /* find register group entry */
141     reg_grp_entry = xen_pt_find_reg_grp(s, addr);
142     if (reg_grp_entry) {
143         /* check 0-Hardwired register group */
144         if (reg_grp_entry->reg_grp->grp_type == XEN_PT_GRP_TYPE_HARDWIRED) {
145             /* no need to emulate, just return 0 */
146             val = 0;
147             goto exit;
148         }
149     }
150 
151     /* read I/O device register value */
152     rc = xen_host_pci_get_block(&s->real_device, addr, (uint8_t *)&val, len);
153     if (rc < 0) {
154         XEN_PT_ERR(d, "pci_read_block failed. return value: %d.\n", rc);
155         memset(&val, 0xff, len);
156     }
157 
158     /* just return the I/O device register value for
159      * passthrough type register group */
160     if (reg_grp_entry == NULL) {
161         goto exit;
162     }
163 
164     /* adjust the read value to appropriate CFC-CFF window */
165     val <<= (addr & 3) << 3;
166     emul_len = len;
167 
168     /* loop around the guest requested size */
169     while (emul_len > 0) {
170         /* find register entry to be emulated */
171         reg_entry = xen_pt_find_reg(reg_grp_entry, find_addr);
172         if (reg_entry) {
173             XenPTRegInfo *reg = reg_entry->reg;
174             uint32_t real_offset = reg_grp_entry->base_offset + reg->offset;
175             uint32_t valid_mask = 0xFFFFFFFF >> ((4 - emul_len) << 3);
176             uint8_t *ptr_val = NULL;
177 
178             valid_mask <<= (find_addr - real_offset) << 3;
179             ptr_val = (uint8_t *)&val + (real_offset & 3);
180 
181             /* do emulation based on register size */
182             switch (reg->size) {
183             case 1:
184                 if (reg->u.b.read) {
185                     rc = reg->u.b.read(s, reg_entry, ptr_val, valid_mask);
186                 }
187                 break;
188             case 2:
189                 if (reg->u.w.read) {
190                     rc = reg->u.w.read(s, reg_entry,
191                                        (uint16_t *)ptr_val, valid_mask);
192                 }
193                 break;
194             case 4:
195                 if (reg->u.dw.read) {
196                     rc = reg->u.dw.read(s, reg_entry,
197                                         (uint32_t *)ptr_val, valid_mask);
198                 }
199                 break;
200             }
201 
202             if (rc < 0) {
203                 xen_shutdown_fatal_error("Internal error: Invalid read "
204                                          "emulation. (%s, rc: %d)\n",
205                                          __func__, rc);
206                 return 0;
207             }
208 
209             /* calculate next address to find */
210             emul_len -= reg->size;
211             if (emul_len > 0) {
212                 find_addr = real_offset + reg->size;
213             }
214         } else {
215             /* nothing to do with passthrough type register,
216              * continue to find next byte */
217             emul_len--;
218             find_addr++;
219         }
220     }
221 
222     /* need to shift back before returning them to pci bus emulator */
223     val >>= ((addr & 3) << 3);
224 
225 exit:
226     XEN_PT_LOG_CONFIG(d, addr, val, len);
227     return val;
228 }
229 
230 static void xen_pt_pci_write_config(PCIDevice *d, uint32_t addr,
231                                     uint32_t val, int len)
232 {
233     XenPCIPassthroughState *s = XEN_PT_DEVICE(d);
234     int index = 0;
235     XenPTRegGroup *reg_grp_entry = NULL;
236     int rc = 0;
237     uint32_t read_val = 0, wb_mask;
238     int emul_len = 0;
239     XenPTReg *reg_entry = NULL;
240     uint32_t find_addr = addr;
241     XenPTRegInfo *reg = NULL;
242     bool wp_flag = false;
243 
244     if (xen_pt_pci_config_access_check(d, addr, len)) {
245         return;
246     }
247 
248     XEN_PT_LOG_CONFIG(d, addr, val, len);
249 
250     /* check unused BAR register */
251     index = xen_pt_bar_offset_to_index(addr);
252     if ((index >= 0) && (val != 0)) {
253         uint32_t chk = val;
254 
255         if (index == PCI_ROM_SLOT)
256             chk |= (uint32_t)~PCI_ROM_ADDRESS_MASK;
257 
258         if ((chk != XEN_PT_BAR_ALLF) &&
259             (s->bases[index].bar_flag == XEN_PT_BAR_FLAG_UNUSED)) {
260             XEN_PT_WARN(d, "Guest attempt to set address to unused "
261                         "Base Address Register. (addr: 0x%02x, len: %d)\n",
262                         addr, len);
263         }
264     }
265 
266     /* find register group entry */
267     reg_grp_entry = xen_pt_find_reg_grp(s, addr);
268     if (reg_grp_entry) {
269         /* check 0-Hardwired register group */
270         if (reg_grp_entry->reg_grp->grp_type == XEN_PT_GRP_TYPE_HARDWIRED) {
271             /* ignore silently */
272             XEN_PT_WARN(d, "Access to 0-Hardwired register. "
273                         "(addr: 0x%02x, len: %d)\n", addr, len);
274             return;
275         }
276     }
277 
278     rc = xen_host_pci_get_block(&s->real_device, addr,
279                                 (uint8_t *)&read_val, len);
280     if (rc < 0) {
281         XEN_PT_ERR(d, "pci_read_block failed. return value: %d.\n", rc);
282         memset(&read_val, 0xff, len);
283         wb_mask = 0;
284     } else {
285         wb_mask = 0xFFFFFFFF >> ((4 - len) << 3);
286     }
287 
288     /* pass directly to the real device for passthrough type register group */
289     if (reg_grp_entry == NULL) {
290         if (!s->permissive) {
291             wb_mask = 0;
292             wp_flag = true;
293         }
294         goto out;
295     }
296 
297     memory_region_transaction_begin();
298     pci_default_write_config(d, addr, val, len);
299 
300     /* adjust the read and write value to appropriate CFC-CFF window */
301     read_val <<= (addr & 3) << 3;
302     val <<= (addr & 3) << 3;
303     emul_len = len;
304 
305     /* loop around the guest requested size */
306     while (emul_len > 0) {
307         /* find register entry to be emulated */
308         reg_entry = xen_pt_find_reg(reg_grp_entry, find_addr);
309         if (reg_entry) {
310             reg = reg_entry->reg;
311             uint32_t real_offset = reg_grp_entry->base_offset + reg->offset;
312             uint32_t valid_mask = 0xFFFFFFFF >> ((4 - emul_len) << 3);
313             uint8_t *ptr_val = NULL;
314             uint32_t wp_mask = reg->emu_mask | reg->ro_mask;
315 
316             valid_mask <<= (find_addr - real_offset) << 3;
317             ptr_val = (uint8_t *)&val + (real_offset & 3);
318             if (!s->permissive) {
319                 wp_mask |= reg->res_mask;
320             }
321             if (wp_mask == (0xFFFFFFFF >> ((4 - reg->size) << 3))) {
322                 wb_mask &= ~((wp_mask >> ((find_addr - real_offset) << 3))
323                              << ((len - emul_len) << 3));
324             }
325 
326             /* do emulation based on register size */
327             switch (reg->size) {
328             case 1:
329                 if (reg->u.b.write) {
330                     rc = reg->u.b.write(s, reg_entry, ptr_val,
331                                         read_val >> ((real_offset & 3) << 3),
332                                         valid_mask);
333                 }
334                 break;
335             case 2:
336                 if (reg->u.w.write) {
337                     rc = reg->u.w.write(s, reg_entry, (uint16_t *)ptr_val,
338                                         (read_val >> ((real_offset & 3) << 3)),
339                                         valid_mask);
340                 }
341                 break;
342             case 4:
343                 if (reg->u.dw.write) {
344                     rc = reg->u.dw.write(s, reg_entry, (uint32_t *)ptr_val,
345                                          (read_val >> ((real_offset & 3) << 3)),
346                                          valid_mask);
347                 }
348                 break;
349             }
350 
351             if (rc < 0) {
352                 xen_shutdown_fatal_error("Internal error: Invalid write"
353                                          " emulation. (%s, rc: %d)\n",
354                                          __func__, rc);
355                 return;
356             }
357 
358             /* calculate next address to find */
359             emul_len -= reg->size;
360             if (emul_len > 0) {
361                 find_addr = real_offset + reg->size;
362             }
363         } else {
364             /* nothing to do with passthrough type register,
365              * continue to find next byte */
366             if (!s->permissive) {
367                 wb_mask &= ~(0xff << ((len - emul_len) << 3));
368                 /* Unused BARs will make it here, but we don't want to issue
369                  * warnings for writes to them (bogus writes get dealt with
370                  * above).
371                  */
372                 if (index < 0) {
373                     wp_flag = true;
374                 }
375             }
376             emul_len--;
377             find_addr++;
378         }
379     }
380 
381     /* need to shift back before passing them to xen_host_pci_device */
382     val >>= (addr & 3) << 3;
383 
384     memory_region_transaction_commit();
385 
386 out:
387     if (wp_flag && !s->permissive_warned) {
388         s->permissive_warned = true;
389         xen_pt_log(d, "Write-back to unknown field 0x%02x (partially) inhibited (0x%0*x)\n",
390                    addr, len * 2, wb_mask);
391         xen_pt_log(d, "If the device doesn't work, try enabling permissive mode\n");
392         xen_pt_log(d, "(unsafe) and if it helps report the problem to xen-devel\n");
393     }
394     for (index = 0; wb_mask; index += len) {
395         /* unknown regs are passed through */
396         while (!(wb_mask & 0xff)) {
397             index++;
398             wb_mask >>= 8;
399         }
400         len = 0;
401         do {
402             len++;
403             wb_mask >>= 8;
404         } while (wb_mask & 0xff);
405         rc = xen_host_pci_set_block(&s->real_device, addr + index,
406                                     (uint8_t *)&val + index, len);
407 
408         if (rc < 0) {
409             XEN_PT_ERR(d, "pci_write_block failed. return value: %d.\n", rc);
410         }
411     }
412 }
413 
414 /* register regions */
415 
416 static uint64_t xen_pt_bar_read(void *o, hwaddr addr,
417                                 unsigned size)
418 {
419     PCIDevice *d = o;
420     /* if this function is called, that probably means that there is a
421      * misconfiguration of the IOMMU. */
422     XEN_PT_ERR(d, "Should not read BAR through QEMU. @0x"TARGET_FMT_plx"\n",
423                addr);
424     return 0;
425 }
426 static void xen_pt_bar_write(void *o, hwaddr addr, uint64_t val,
427                              unsigned size)
428 {
429     PCIDevice *d = o;
430     /* Same comment as xen_pt_bar_read function */
431     XEN_PT_ERR(d, "Should not write BAR through QEMU. @0x"TARGET_FMT_plx"\n",
432                addr);
433 }
434 
435 static const MemoryRegionOps ops = {
436     .endianness = DEVICE_NATIVE_ENDIAN,
437     .read = xen_pt_bar_read,
438     .write = xen_pt_bar_write,
439 };
440 
441 static int xen_pt_register_regions(XenPCIPassthroughState *s, uint16_t *cmd)
442 {
443     int i = 0;
444     XenHostPCIDevice *d = &s->real_device;
445 
446     /* Register PIO/MMIO BARs */
447     for (i = 0; i < PCI_ROM_SLOT; i++) {
448         XenHostPCIIORegion *r = &d->io_regions[i];
449         uint8_t type;
450 
451         if (r->base_addr == 0 || r->size == 0) {
452             continue;
453         }
454 
455         s->bases[i].access.u = r->base_addr;
456 
457         if (r->type & XEN_HOST_PCI_REGION_TYPE_IO) {
458             type = PCI_BASE_ADDRESS_SPACE_IO;
459             *cmd |= PCI_COMMAND_IO;
460         } else {
461             type = PCI_BASE_ADDRESS_SPACE_MEMORY;
462             if (r->type & XEN_HOST_PCI_REGION_TYPE_PREFETCH) {
463                 type |= PCI_BASE_ADDRESS_MEM_PREFETCH;
464             }
465             if (r->type & XEN_HOST_PCI_REGION_TYPE_MEM_64) {
466                 type |= PCI_BASE_ADDRESS_MEM_TYPE_64;
467             }
468             *cmd |= PCI_COMMAND_MEMORY;
469         }
470 
471         memory_region_init_io(&s->bar[i], OBJECT(s), &ops, &s->dev,
472                               "xen-pci-pt-bar", r->size);
473         pci_register_bar(&s->dev, i, type, &s->bar[i]);
474 
475         XEN_PT_LOG(&s->dev, "IO region %i registered (size=0x%08"PRIx64
476                    " base_addr=0x%08"PRIx64" type: %#x)\n",
477                    i, r->size, r->base_addr, type);
478     }
479 
480     /* Register expansion ROM address */
481     if (d->rom.base_addr && d->rom.size) {
482         uint32_t bar_data = 0;
483 
484         /* Re-set BAR reported by OS, otherwise ROM can't be read. */
485         if (xen_host_pci_get_long(d, PCI_ROM_ADDRESS, &bar_data)) {
486             return 0;
487         }
488         if ((bar_data & PCI_ROM_ADDRESS_MASK) == 0) {
489             bar_data |= d->rom.base_addr & PCI_ROM_ADDRESS_MASK;
490             xen_host_pci_set_long(d, PCI_ROM_ADDRESS, bar_data);
491         }
492 
493         s->bases[PCI_ROM_SLOT].access.maddr = d->rom.base_addr;
494 
495         memory_region_init_io(&s->rom, OBJECT(s), &ops, &s->dev,
496                               "xen-pci-pt-rom", d->rom.size);
497         pci_register_bar(&s->dev, PCI_ROM_SLOT, PCI_BASE_ADDRESS_MEM_PREFETCH,
498                          &s->rom);
499 
500         XEN_PT_LOG(&s->dev, "Expansion ROM registered (size=0x%08"PRIx64
501                    " base_addr=0x%08"PRIx64")\n",
502                    d->rom.size, d->rom.base_addr);
503     }
504 
505     xen_pt_register_vga_regions(d);
506     return 0;
507 }
508 
509 /* region mapping */
510 
511 static int xen_pt_bar_from_region(XenPCIPassthroughState *s, MemoryRegion *mr)
512 {
513     int i = 0;
514 
515     for (i = 0; i < PCI_NUM_REGIONS - 1; i++) {
516         if (mr == &s->bar[i]) {
517             return i;
518         }
519     }
520     if (mr == &s->rom) {
521         return PCI_ROM_SLOT;
522     }
523     return -1;
524 }
525 
526 /*
527  * This function checks if an io_region overlaps an io_region from another
528  * device.  The io_region to check is provided with (addr, size and type)
529  * A callback can be provided and will be called for every region that is
530  * overlapped.
531  * The return value indicates if the region is overlappsed */
532 struct CheckBarArgs {
533     XenPCIPassthroughState *s;
534     pcibus_t addr;
535     pcibus_t size;
536     uint8_t type;
537     bool rc;
538 };
539 static void xen_pt_check_bar_overlap(PCIBus *bus, PCIDevice *d, void *opaque)
540 {
541     struct CheckBarArgs *arg = opaque;
542     XenPCIPassthroughState *s = arg->s;
543     uint8_t type = arg->type;
544     int i;
545 
546     if (d->devfn == s->dev.devfn) {
547         return;
548     }
549 
550     /* xxx: This ignores bridges. */
551     for (i = 0; i < PCI_NUM_REGIONS; i++) {
552         const PCIIORegion *r = &d->io_regions[i];
553 
554         if (!r->size) {
555             continue;
556         }
557         if ((type & PCI_BASE_ADDRESS_SPACE_IO)
558             != (r->type & PCI_BASE_ADDRESS_SPACE_IO)) {
559             continue;
560         }
561 
562         if (ranges_overlap(arg->addr, arg->size, r->addr, r->size)) {
563             XEN_PT_WARN(&s->dev,
564                         "Overlapped to device [%02x:%02x.%d] Region: %i"
565                         " (addr: %#"FMT_PCIBUS", len: %#"FMT_PCIBUS")\n",
566                         pci_bus_num(bus), PCI_SLOT(d->devfn),
567                         PCI_FUNC(d->devfn), i, r->addr, r->size);
568             arg->rc = true;
569         }
570     }
571 }
572 
573 static void xen_pt_region_update(XenPCIPassthroughState *s,
574                                  MemoryRegionSection *sec, bool adding)
575 {
576     PCIDevice *d = &s->dev;
577     MemoryRegion *mr = sec->mr;
578     int bar = -1;
579     int rc;
580     int op = adding ? DPCI_ADD_MAPPING : DPCI_REMOVE_MAPPING;
581     struct CheckBarArgs args = {
582         .s = s,
583         .addr = sec->offset_within_address_space,
584         .size = int128_get64(sec->size),
585         .rc = false,
586     };
587 
588     bar = xen_pt_bar_from_region(s, mr);
589     if (bar == -1 && (!s->msix || &s->msix->mmio != mr)) {
590         return;
591     }
592 
593     if (s->msix && &s->msix->mmio == mr) {
594         if (adding) {
595             s->msix->mmio_base_addr = sec->offset_within_address_space;
596             rc = xen_pt_msix_update_remap(s, s->msix->bar_index);
597         }
598         return;
599     }
600 
601     args.type = d->io_regions[bar].type;
602     pci_for_each_device(d->bus, pci_bus_num(d->bus),
603                         xen_pt_check_bar_overlap, &args);
604     if (args.rc) {
605         XEN_PT_WARN(d, "Region: %d (addr: %#"FMT_PCIBUS
606                     ", len: %#"FMT_PCIBUS") is overlapped.\n",
607                     bar, sec->offset_within_address_space,
608                     int128_get64(sec->size));
609     }
610 
611     if (d->io_regions[bar].type & PCI_BASE_ADDRESS_SPACE_IO) {
612         uint32_t guest_port = sec->offset_within_address_space;
613         uint32_t machine_port = s->bases[bar].access.pio_base;
614         uint32_t size = int128_get64(sec->size);
615         rc = xc_domain_ioport_mapping(xen_xc, xen_domid,
616                                       guest_port, machine_port, size,
617                                       op);
618         if (rc) {
619             XEN_PT_ERR(d, "%s ioport mapping failed! (err: %i)\n",
620                        adding ? "create new" : "remove old", errno);
621         }
622     } else {
623         pcibus_t guest_addr = sec->offset_within_address_space;
624         pcibus_t machine_addr = s->bases[bar].access.maddr
625             + sec->offset_within_region;
626         pcibus_t size = int128_get64(sec->size);
627         rc = xc_domain_memory_mapping(xen_xc, xen_domid,
628                                       XEN_PFN(guest_addr + XC_PAGE_SIZE - 1),
629                                       XEN_PFN(machine_addr + XC_PAGE_SIZE - 1),
630                                       XEN_PFN(size + XC_PAGE_SIZE - 1),
631                                       op);
632         if (rc) {
633             XEN_PT_ERR(d, "%s mem mapping failed! (err: %i)\n",
634                        adding ? "create new" : "remove old", errno);
635         }
636     }
637 }
638 
639 static void xen_pt_region_add(MemoryListener *l, MemoryRegionSection *sec)
640 {
641     XenPCIPassthroughState *s = container_of(l, XenPCIPassthroughState,
642                                              memory_listener);
643 
644     memory_region_ref(sec->mr);
645     xen_pt_region_update(s, sec, true);
646 }
647 
648 static void xen_pt_region_del(MemoryListener *l, MemoryRegionSection *sec)
649 {
650     XenPCIPassthroughState *s = container_of(l, XenPCIPassthroughState,
651                                              memory_listener);
652 
653     xen_pt_region_update(s, sec, false);
654     memory_region_unref(sec->mr);
655 }
656 
657 static void xen_pt_io_region_add(MemoryListener *l, MemoryRegionSection *sec)
658 {
659     XenPCIPassthroughState *s = container_of(l, XenPCIPassthroughState,
660                                              io_listener);
661 
662     memory_region_ref(sec->mr);
663     xen_pt_region_update(s, sec, true);
664 }
665 
666 static void xen_pt_io_region_del(MemoryListener *l, MemoryRegionSection *sec)
667 {
668     XenPCIPassthroughState *s = container_of(l, XenPCIPassthroughState,
669                                              io_listener);
670 
671     xen_pt_region_update(s, sec, false);
672     memory_region_unref(sec->mr);
673 }
674 
675 static const MemoryListener xen_pt_memory_listener = {
676     .region_add = xen_pt_region_add,
677     .region_del = xen_pt_region_del,
678     .priority = 10,
679 };
680 
681 static const MemoryListener xen_pt_io_listener = {
682     .region_add = xen_pt_io_region_add,
683     .region_del = xen_pt_io_region_del,
684     .priority = 10,
685 };
686 
687 /* init */
688 
689 static int xen_pt_initfn(PCIDevice *d)
690 {
691     XenPCIPassthroughState *s = XEN_PT_DEVICE(d);
692     int rc = 0;
693     uint8_t machine_irq = 0;
694     uint16_t cmd = 0;
695     int pirq = XEN_PT_UNASSIGNED_PIRQ;
696 
697     /* register real device */
698     XEN_PT_LOG(d, "Assigning real physical device %02x:%02x.%d"
699                " to devfn %#x\n",
700                s->hostaddr.bus, s->hostaddr.slot, s->hostaddr.function,
701                s->dev.devfn);
702 
703     rc = xen_host_pci_device_get(&s->real_device,
704                                  s->hostaddr.domain, s->hostaddr.bus,
705                                  s->hostaddr.slot, s->hostaddr.function);
706     if (rc) {
707         XEN_PT_ERR(d, "Failed to \"open\" the real pci device. rc: %i\n", rc);
708         return -1;
709     }
710 
711     s->is_virtfn = s->real_device.is_virtfn;
712     if (s->is_virtfn) {
713         XEN_PT_LOG(d, "%04x:%02x:%02x.%d is a SR-IOV Virtual Function\n",
714                    s->real_device.domain, s->real_device.bus,
715                    s->real_device.dev, s->real_device.func);
716     }
717 
718     /* Initialize virtualized PCI configuration (Extended 256 Bytes) */
719     if (xen_host_pci_get_block(&s->real_device, 0, d->config,
720                                PCI_CONFIG_SPACE_SIZE) == -1) {
721         xen_host_pci_device_put(&s->real_device);
722         return -1;
723     }
724 
725     s->memory_listener = xen_pt_memory_listener;
726     s->io_listener = xen_pt_io_listener;
727 
728     /* Handle real device's MMIO/PIO BARs */
729     xen_pt_register_regions(s, &cmd);
730 
731     /* reinitialize each config register to be emulated */
732     if (xen_pt_config_init(s)) {
733         XEN_PT_ERR(d, "PCI Config space initialisation failed.\n");
734         xen_host_pci_device_put(&s->real_device);
735         return -1;
736     }
737 
738     /* Bind interrupt */
739     if (!s->dev.config[PCI_INTERRUPT_PIN]) {
740         XEN_PT_LOG(d, "no pin interrupt\n");
741         goto out;
742     }
743 
744     machine_irq = s->real_device.irq;
745     rc = xc_physdev_map_pirq(xen_xc, xen_domid, machine_irq, &pirq);
746 
747     if (rc < 0) {
748         XEN_PT_ERR(d, "Mapping machine irq %u to pirq %i failed, (err: %d)\n",
749                    machine_irq, pirq, errno);
750 
751         /* Disable PCI intx assertion (turn on bit10 of devctl) */
752         cmd |= PCI_COMMAND_INTX_DISABLE;
753         machine_irq = 0;
754         s->machine_irq = 0;
755     } else {
756         machine_irq = pirq;
757         s->machine_irq = pirq;
758         xen_pt_mapped_machine_irq[machine_irq]++;
759     }
760 
761     /* bind machine_irq to device */
762     if (machine_irq != 0) {
763         uint8_t e_intx = xen_pt_pci_intx(s);
764 
765         rc = xc_domain_bind_pt_pci_irq(xen_xc, xen_domid, machine_irq,
766                                        pci_bus_num(d->bus),
767                                        PCI_SLOT(d->devfn),
768                                        e_intx);
769         if (rc < 0) {
770             XEN_PT_ERR(d, "Binding of interrupt %i failed! (err: %d)\n",
771                        e_intx, errno);
772 
773             /* Disable PCI intx assertion (turn on bit10 of devctl) */
774             cmd |= PCI_COMMAND_INTX_DISABLE;
775             xen_pt_mapped_machine_irq[machine_irq]--;
776 
777             if (xen_pt_mapped_machine_irq[machine_irq] == 0) {
778                 if (xc_physdev_unmap_pirq(xen_xc, xen_domid, machine_irq)) {
779                     XEN_PT_ERR(d, "Unmapping of machine interrupt %i failed!"
780                                " (err: %d)\n", machine_irq, errno);
781                 }
782             }
783             s->machine_irq = 0;
784         }
785     }
786 
787 out:
788     if (cmd) {
789         xen_host_pci_set_word(&s->real_device, PCI_COMMAND,
790                               pci_get_word(d->config + PCI_COMMAND) | cmd);
791     }
792 
793     memory_listener_register(&s->memory_listener, &s->dev.bus_master_as);
794     memory_listener_register(&s->io_listener, &address_space_io);
795     XEN_PT_LOG(d,
796                "Real physical device %02x:%02x.%d registered successfully!\n",
797                s->hostaddr.bus, s->hostaddr.slot, s->hostaddr.function);
798 
799     return 0;
800 }
801 
802 static void xen_pt_unregister_device(PCIDevice *d)
803 {
804     XenPCIPassthroughState *s = XEN_PT_DEVICE(d);
805     XenHostPCIDevice *host_dev = &s->real_device;
806     uint8_t machine_irq = s->machine_irq;
807     uint8_t intx = xen_pt_pci_intx(s);
808     int rc;
809 
810     if (machine_irq) {
811         rc = xc_domain_unbind_pt_irq(xen_xc, xen_domid, machine_irq,
812                                      PT_IRQ_TYPE_PCI,
813                                      pci_bus_num(d->bus),
814                                      PCI_SLOT(s->dev.devfn),
815                                      intx,
816                                      0 /* isa_irq */);
817         if (rc < 0) {
818             XEN_PT_ERR(d, "unbinding of interrupt INT%c failed."
819                        " (machine irq: %i, err: %d)"
820                        " But bravely continuing on..\n",
821                        'a' + intx, machine_irq, errno);
822         }
823     }
824 
825     if (s->msi) {
826         xen_pt_msi_disable(s);
827     }
828     if (s->msix) {
829         xen_pt_msix_disable(s);
830     }
831 
832     if (machine_irq) {
833         xen_pt_mapped_machine_irq[machine_irq]--;
834 
835         if (xen_pt_mapped_machine_irq[machine_irq] == 0) {
836             rc = xc_physdev_unmap_pirq(xen_xc, xen_domid, machine_irq);
837 
838             if (rc < 0) {
839                 XEN_PT_ERR(d, "unmapping of interrupt %i failed. (err: %d)"
840                            " But bravely continuing on..\n",
841                            machine_irq, errno);
842             }
843         }
844     }
845 
846     /* delete all emulated config registers */
847     xen_pt_config_delete(s);
848 
849     xen_pt_unregister_vga_regions(host_dev);
850 
851     memory_listener_unregister(&s->memory_listener);
852     memory_listener_unregister(&s->io_listener);
853 
854     xen_host_pci_device_put(&s->real_device);
855 }
856 
857 static Property xen_pci_passthrough_properties[] = {
858     DEFINE_PROP_PCI_HOST_DEVADDR("hostaddr", XenPCIPassthroughState, hostaddr),
859     DEFINE_PROP_BOOL("permissive", XenPCIPassthroughState, permissive, false),
860     DEFINE_PROP_END_OF_LIST(),
861 };
862 
863 static void xen_pci_passthrough_class_init(ObjectClass *klass, void *data)
864 {
865     DeviceClass *dc = DEVICE_CLASS(klass);
866     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
867 
868     k->init = xen_pt_initfn;
869     k->exit = xen_pt_unregister_device;
870     k->config_read = xen_pt_pci_read_config;
871     k->config_write = xen_pt_pci_write_config;
872     set_bit(DEVICE_CATEGORY_MISC, dc->categories);
873     dc->desc = "Assign an host PCI device with Xen";
874     dc->props = xen_pci_passthrough_properties;
875 };
876 
877 static const TypeInfo xen_pci_passthrough_info = {
878     .name = TYPE_XEN_PT_DEVICE,
879     .parent = TYPE_PCI_DEVICE,
880     .instance_size = sizeof(XenPCIPassthroughState),
881     .class_init = xen_pci_passthrough_class_init,
882 };
883 
884 static void xen_pci_passthrough_register_types(void)
885 {
886     type_register_static(&xen_pci_passthrough_info);
887 }
888 
889 type_init(xen_pci_passthrough_register_types)
890