2 * PCI Stub Driver - Grabs devices in backend to be exported later
4 * Ryan Wilson <hap9@epoch.ncsc.mil>
5 * Chris Bookholt <hap10@epoch.ncsc.mil>
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/module.h>
11 #include <linux/init.h>
12 #include <linux/rwsem.h>
13 #include <linux/list.h>
14 #include <linux/spinlock.h>
15 #include <linux/kref.h>
16 #include <linux/pci.h>
17 #include <linux/wait.h>
18 #include <linux/sched.h>
19 #include <linux/atomic.h>
20 #include <xen/events.h>
21 #include <asm/xen/pci.h>
22 #include <asm/xen/hypervisor.h>
23 #include <xen/interface/physdev.h>
25 #include "conf_space.h"
26 #include "conf_space_quirks.h"
28 static char *pci_devs_to_hide;
29 wait_queue_head_t xen_pcibk_aer_wait_queue;
30 /*Add sem for sync AER handling and xen_pcibk remove/reconfigue ops,
31 * We want to avoid in middle of AER ops, xen_pcibk devices is being removed
33 static DECLARE_RWSEM(pcistub_sem);
34 module_param_named(hide, pci_devs_to_hide, charp, 0444);
36 struct pcistub_device_id {
37 struct list_head slot_list;
42 static LIST_HEAD(pcistub_device_ids);
43 static DEFINE_SPINLOCK(device_ids_lock);
45 struct pcistub_device {
47 struct list_head dev_list;
51 struct xen_pcibk_device *pdev;/* non-NULL if struct pci_dev is in use */
54 /* Access to pcistub_devices & seized_devices lists and the initialize_devices
55 * flag must be locked with pcistub_devices_lock
57 static DEFINE_SPINLOCK(pcistub_devices_lock);
58 static LIST_HEAD(pcistub_devices);
60 /* wait for device_initcall before initializing our devices
61 * (see pcistub_init_devices_late)
63 static int initialize_devices;
64 static LIST_HEAD(seized_devices);
66 static struct pcistub_device *pcistub_device_alloc(struct pci_dev *dev)
68 struct pcistub_device *psdev;
70 dev_dbg(&dev->dev, "pcistub_device_alloc\n");
72 psdev = kzalloc(sizeof(*psdev), GFP_ATOMIC);
76 psdev->dev = pci_dev_get(dev);
82 kref_init(&psdev->kref);
83 spin_lock_init(&psdev->lock);
88 /* Don't call this directly as it's called by pcistub_device_put */
89 static void pcistub_device_release(struct kref *kref)
91 struct pcistub_device *psdev;
93 struct xen_pcibk_dev_data *dev_data;
95 psdev = container_of(kref, struct pcistub_device, kref);
97 dev_data = pci_get_drvdata(dev);
99 dev_dbg(&dev->dev, "pcistub_device_release\n");
101 xen_unregister_device_domain_owner(dev);
103 /* Call the reset function which does not take lock as this
104 * is called from "unbind" which takes a device_lock mutex.
106 __pci_reset_function_locked(dev);
107 if (pci_load_and_free_saved_state(dev, &dev_data->pci_saved_state))
108 dev_dbg(&dev->dev, "Could not reload PCI state\n");
110 pci_restore_state(dev);
113 struct physdev_pci_device ppdev = {
114 .seg = pci_domain_nr(dev->bus),
115 .bus = dev->bus->number,
118 int err = HYPERVISOR_physdev_op(PHYSDEVOP_release_msix,
122 dev_warn(&dev->dev, "MSI-X release failed (%d)\n",
126 /* Disable the device */
127 xen_pcibk_reset_device(dev);
130 pci_set_drvdata(dev, NULL);
132 /* Clean-up the device */
133 xen_pcibk_config_free_dyn_fields(dev);
134 xen_pcibk_config_free_dev(dev);
136 pci_clear_dev_assigned(dev);
142 static inline void pcistub_device_get(struct pcistub_device *psdev)
144 kref_get(&psdev->kref);
147 static inline void pcistub_device_put(struct pcistub_device *psdev)
149 kref_put(&psdev->kref, pcistub_device_release);
152 static struct pcistub_device *pcistub_device_find(int domain, int bus,
155 struct pcistub_device *psdev = NULL;
158 spin_lock_irqsave(&pcistub_devices_lock, flags);
160 list_for_each_entry(psdev, &pcistub_devices, dev_list) {
161 if (psdev->dev != NULL
162 && domain == pci_domain_nr(psdev->dev->bus)
163 && bus == psdev->dev->bus->number
164 && slot == PCI_SLOT(psdev->dev->devfn)
165 && func == PCI_FUNC(psdev->dev->devfn)) {
166 pcistub_device_get(psdev);
175 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
179 static struct pci_dev *pcistub_device_get_pci_dev(struct xen_pcibk_device *pdev,
180 struct pcistub_device *psdev)
182 struct pci_dev *pci_dev = NULL;
185 pcistub_device_get(psdev);
187 spin_lock_irqsave(&psdev->lock, flags);
190 pci_dev = psdev->dev;
192 spin_unlock_irqrestore(&psdev->lock, flags);
195 pcistub_device_put(psdev);
200 struct pci_dev *pcistub_get_pci_dev_by_slot(struct xen_pcibk_device *pdev,
204 struct pcistub_device *psdev;
205 struct pci_dev *found_dev = NULL;
208 spin_lock_irqsave(&pcistub_devices_lock, flags);
210 list_for_each_entry(psdev, &pcistub_devices, dev_list) {
211 if (psdev->dev != NULL
212 && domain == pci_domain_nr(psdev->dev->bus)
213 && bus == psdev->dev->bus->number
214 && slot == PCI_SLOT(psdev->dev->devfn)
215 && func == PCI_FUNC(psdev->dev->devfn)) {
216 found_dev = pcistub_device_get_pci_dev(pdev, psdev);
221 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
225 struct pci_dev *pcistub_get_pci_dev(struct xen_pcibk_device *pdev,
228 struct pcistub_device *psdev;
229 struct pci_dev *found_dev = NULL;
232 spin_lock_irqsave(&pcistub_devices_lock, flags);
234 list_for_each_entry(psdev, &pcistub_devices, dev_list) {
235 if (psdev->dev == dev) {
236 found_dev = pcistub_device_get_pci_dev(pdev, psdev);
241 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
247 * - XenBus state has been reconfigure (pci unplug). See xen_pcibk_remove_device
248 * - XenBus state has been disconnected (guest shutdown). See xen_pcibk_xenbus_remove
249 * - 'echo BDF > unbind' on pciback module with no guest attached. See pcistub_remove
250 * - 'echo BDF > unbind' with a guest still using it. See pcistub_remove
252 * As such we have to be careful.
254 * To make this easier, the caller has to hold the device lock.
256 void pcistub_put_pci_dev(struct pci_dev *dev)
258 struct pcistub_device *psdev, *found_psdev = NULL;
261 spin_lock_irqsave(&pcistub_devices_lock, flags);
263 list_for_each_entry(psdev, &pcistub_devices, dev_list) {
264 if (psdev->dev == dev) {
270 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
271 if (WARN_ON(!found_psdev))
274 /*hold this lock for avoiding breaking link between
275 * pcistub and xen_pcibk when AER is in processing
277 down_write(&pcistub_sem);
278 /* Cleanup our device
279 * (so it's ready for the next domain)
281 device_lock_assert(&dev->dev);
282 __pci_reset_function_locked(dev);
283 pci_restore_state(dev);
285 /* This disables the device. */
286 xen_pcibk_reset_device(dev);
288 /* And cleanup up our emulated fields. */
289 xen_pcibk_config_reset_dev(dev);
290 xen_pcibk_config_free_dyn_fields(dev);
292 xen_unregister_device_domain_owner(dev);
294 spin_lock_irqsave(&found_psdev->lock, flags);
295 found_psdev->pdev = NULL;
296 spin_unlock_irqrestore(&found_psdev->lock, flags);
298 pcistub_device_put(found_psdev);
299 up_write(&pcistub_sem);
302 static int pcistub_match_one(struct pci_dev *dev,
303 struct pcistub_device_id *pdev_id)
305 /* Match the specified device by domain, bus, slot, func and also if
306 * any of the device's parent bridges match.
308 for (; dev != NULL; dev = dev->bus->self) {
309 if (pci_domain_nr(dev->bus) == pdev_id->domain
310 && dev->bus->number == pdev_id->bus
311 && dev->devfn == pdev_id->devfn)
314 /* Sometimes topmost bridge links to itself. */
315 if (dev == dev->bus->self)
322 static int pcistub_match(struct pci_dev *dev)
324 struct pcistub_device_id *pdev_id;
328 spin_lock_irqsave(&device_ids_lock, flags);
329 list_for_each_entry(pdev_id, &pcistub_device_ids, slot_list) {
330 if (pcistub_match_one(dev, pdev_id)) {
335 spin_unlock_irqrestore(&device_ids_lock, flags);
340 static int pcistub_init_device(struct pci_dev *dev)
342 struct xen_pcibk_dev_data *dev_data;
345 dev_dbg(&dev->dev, "initializing...\n");
347 /* The PCI backend is not intended to be a module (or to work with
348 * removable PCI devices (yet). If it were, xen_pcibk_config_free()
349 * would need to be called somewhere to free the memory allocated
350 * here and then to call kfree(pci_get_drvdata(psdev->dev)).
352 dev_data = kzalloc(sizeof(*dev_data) + strlen(DRV_NAME "[]")
353 + strlen(pci_name(dev)) + 1, GFP_ATOMIC);
358 pci_set_drvdata(dev, dev_data);
361 * Setup name for fake IRQ handler. It will only be enabled
362 * once the device is turned on by the guest.
364 sprintf(dev_data->irq_name, DRV_NAME "[%s]", pci_name(dev));
366 dev_dbg(&dev->dev, "initializing config\n");
368 init_waitqueue_head(&xen_pcibk_aer_wait_queue);
369 err = xen_pcibk_config_init_dev(dev);
373 /* HACK: Force device (& ACPI) to determine what IRQ it's on - we
374 * must do this here because pcibios_enable_device may specify
375 * the pci device's true irq (and possibly its other resources)
376 * if they differ from what's in the configuration space.
377 * This makes the assumption that the device's resources won't
378 * change after this point (otherwise this code may break!)
380 dev_dbg(&dev->dev, "enabling device\n");
381 err = pci_enable_device(dev);
386 struct physdev_pci_device ppdev = {
387 .seg = pci_domain_nr(dev->bus),
388 .bus = dev->bus->number,
392 err = HYPERVISOR_physdev_op(PHYSDEVOP_prepare_msix, &ppdev);
394 dev_err(&dev->dev, "MSI-X preparation failed (%d)\n",
398 /* We need the device active to save the state. */
399 dev_dbg(&dev->dev, "save state of device\n");
401 dev_data->pci_saved_state = pci_store_saved_state(dev);
402 if (!dev_data->pci_saved_state)
403 dev_err(&dev->dev, "Could not store PCI conf saved state!\n");
405 dev_dbg(&dev->dev, "resetting (FLR, D3, etc) the device\n");
406 __pci_reset_function_locked(dev);
407 pci_restore_state(dev);
409 /* Now disable the device (this also ensures some private device
410 * data is setup before we export)
412 dev_dbg(&dev->dev, "reset device\n");
413 xen_pcibk_reset_device(dev);
415 pci_set_dev_assigned(dev);
419 xen_pcibk_config_free_dev(dev);
422 pci_set_drvdata(dev, NULL);
428 * Because some initialization still happens on
429 * devices during fs_initcall, we need to defer
430 * full initialization of our devices until
433 static int __init pcistub_init_devices_late(void)
435 struct pcistub_device *psdev;
439 spin_lock_irqsave(&pcistub_devices_lock, flags);
441 while (!list_empty(&seized_devices)) {
442 psdev = container_of(seized_devices.next,
443 struct pcistub_device, dev_list);
444 list_del(&psdev->dev_list);
446 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
448 err = pcistub_init_device(psdev->dev);
450 dev_err(&psdev->dev->dev,
451 "error %d initializing device\n", err);
456 spin_lock_irqsave(&pcistub_devices_lock, flags);
459 list_add_tail(&psdev->dev_list, &pcistub_devices);
462 initialize_devices = 1;
464 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
469 static int pcistub_seize(struct pci_dev *dev)
471 struct pcistub_device *psdev;
475 psdev = pcistub_device_alloc(dev);
479 spin_lock_irqsave(&pcistub_devices_lock, flags);
481 if (initialize_devices) {
482 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
484 /* don't want irqs disabled when calling pcistub_init_device */
485 err = pcistub_init_device(psdev->dev);
487 spin_lock_irqsave(&pcistub_devices_lock, flags);
490 list_add(&psdev->dev_list, &pcistub_devices);
492 dev_dbg(&dev->dev, "deferring initialization\n");
493 list_add(&psdev->dev_list, &seized_devices);
496 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
499 pcistub_device_put(psdev);
504 /* Called when 'bind'. This means we must _NOT_ call pci_reset_function or
505 * other functions that take the sysfs lock. */
506 static int pcistub_probe(struct pci_dev *dev, const struct pci_device_id *id)
510 dev_dbg(&dev->dev, "probing...\n");
512 if (pcistub_match(dev)) {
514 if (dev->hdr_type != PCI_HEADER_TYPE_NORMAL
515 && dev->hdr_type != PCI_HEADER_TYPE_BRIDGE) {
516 dev_err(&dev->dev, "can't export pci devices that "
517 "don't have a normal (0) or bridge (1) "
523 dev_info(&dev->dev, "seizing device\n");
524 err = pcistub_seize(dev);
526 /* Didn't find the device */
533 /* Called when 'unbind'. This means we must _NOT_ call pci_reset_function or
534 * other functions that take the sysfs lock. */
535 static void pcistub_remove(struct pci_dev *dev)
537 struct pcistub_device *psdev, *found_psdev = NULL;
540 dev_dbg(&dev->dev, "removing\n");
542 spin_lock_irqsave(&pcistub_devices_lock, flags);
544 xen_pcibk_config_quirk_release(dev);
546 list_for_each_entry(psdev, &pcistub_devices, dev_list) {
547 if (psdev->dev == dev) {
553 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
556 dev_dbg(&dev->dev, "found device to remove %s\n",
557 found_psdev->pdev ? "- in-use" : "");
559 if (found_psdev->pdev) {
560 int domid = xen_find_device_domain_owner(dev);
562 pr_warn("****** removing device %s while still in-use by domain %d! ******\n",
563 pci_name(found_psdev->dev), domid);
564 pr_warn("****** driver domain may still access this device's i/o resources!\n");
565 pr_warn("****** shutdown driver domain before binding device\n");
566 pr_warn("****** to other drivers or domains\n");
568 /* N.B. This ends up calling pcistub_put_pci_dev which ends up
570 xen_pcibk_release_pci_dev(found_psdev->pdev,
572 false /* caller holds the lock. */);
575 spin_lock_irqsave(&pcistub_devices_lock, flags);
576 list_del(&found_psdev->dev_list);
577 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
579 /* the final put for releasing from the list */
580 pcistub_device_put(found_psdev);
584 static const struct pci_device_id pcistub_ids[] = {
586 .vendor = PCI_ANY_ID,
587 .device = PCI_ANY_ID,
588 .subvendor = PCI_ANY_ID,
589 .subdevice = PCI_ANY_ID,
594 #define PCI_NODENAME_MAX 40
595 static void kill_domain_by_device(struct pcistub_device *psdev)
597 struct xenbus_transaction xbt;
599 char nodename[PCI_NODENAME_MAX];
602 snprintf(nodename, PCI_NODENAME_MAX, "/local/domain/0/backend/pci/%d/0",
603 psdev->pdev->xdev->otherend_id);
606 err = xenbus_transaction_start(&xbt);
608 dev_err(&psdev->dev->dev,
609 "error %d when start xenbus transaction\n", err);
612 /*PV AER handlers will set this flag*/
613 xenbus_printf(xbt, nodename, "aerState" , "aerfail");
614 err = xenbus_transaction_end(xbt, 0);
618 dev_err(&psdev->dev->dev,
619 "error %d when end xenbus transaction\n", err);
624 /* For each aer recovery step error_detected, mmio_enabled, etc, front_end and
625 * backend need to have cooperation. In xen_pcibk, those steps will do similar
626 * jobs: send service request and waiting for front_end response.
628 static pci_ers_result_t common_process(struct pcistub_device *psdev,
629 pci_channel_state_t state, int aer_cmd,
630 pci_ers_result_t result)
632 pci_ers_result_t res = result;
633 struct xen_pcie_aer_op *aer_op;
634 struct xen_pcibk_device *pdev = psdev->pdev;
635 struct xen_pci_sharedinfo *sh_info = pdev->sh_info;
638 /*with PV AER drivers*/
639 aer_op = &(sh_info->aer_op);
640 aer_op->cmd = aer_cmd ;
641 /*useful for error_detected callback*/
644 ret = xen_pcibk_get_pcifront_dev(psdev->dev, psdev->pdev,
645 &aer_op->domain, &aer_op->bus, &aer_op->devfn);
647 dev_err(&psdev->dev->dev,
648 DRV_NAME ": failed to get pcifront device\n");
649 return PCI_ERS_RESULT_NONE;
653 dev_dbg(&psdev->dev->dev,
654 DRV_NAME ": aer_op %x dom %x bus %x devfn %x\n",
655 aer_cmd, aer_op->domain, aer_op->bus, aer_op->devfn);
656 /*local flag to mark there's aer request, xen_pcibk callback will use
657 * this flag to judge whether we need to check pci-front give aer
660 set_bit(_PCIB_op_pending, (unsigned long *)&pdev->flags);
662 /*It is possible that a pcifront conf_read_write ops request invokes
663 * the callback which cause the spurious execution of wake_up.
664 * Yet it is harmless and better than a spinlock here
666 set_bit(_XEN_PCIB_active,
667 (unsigned long *)&sh_info->flags);
669 notify_remote_via_irq(pdev->evtchn_irq);
671 ret = wait_event_timeout(xen_pcibk_aer_wait_queue,
672 !(test_bit(_XEN_PCIB_active, (unsigned long *)
673 &sh_info->flags)), 300*HZ);
676 if (test_bit(_XEN_PCIB_active,
677 (unsigned long *)&sh_info->flags)) {
678 dev_err(&psdev->dev->dev,
679 "pcifront aer process not responding!\n");
680 clear_bit(_XEN_PCIB_active,
681 (unsigned long *)&sh_info->flags);
682 aer_op->err = PCI_ERS_RESULT_NONE;
686 clear_bit(_PCIB_op_pending, (unsigned long *)&pdev->flags);
688 if (test_bit(_XEN_PCIF_active,
689 (unsigned long *)&sh_info->flags)) {
690 dev_dbg(&psdev->dev->dev,
691 "schedule pci_conf service in " DRV_NAME "\n");
692 xen_pcibk_test_and_schedule_op(psdev->pdev);
695 res = (pci_ers_result_t)aer_op->err;
700 * xen_pcibk_slot_reset: it will send the slot_reset request to pcifront in case
701 * of the device driver could provide this service, and then wait for pcifront
703 * @dev: pointer to PCI devices
704 * return value is used by aer_core do_recovery policy
706 static pci_ers_result_t xen_pcibk_slot_reset(struct pci_dev *dev)
708 struct pcistub_device *psdev;
709 pci_ers_result_t result;
711 result = PCI_ERS_RESULT_RECOVERED;
712 dev_dbg(&dev->dev, "xen_pcibk_slot_reset(bus:%x,devfn:%x)\n",
713 dev->bus->number, dev->devfn);
715 down_write(&pcistub_sem);
716 psdev = pcistub_device_find(pci_domain_nr(dev->bus),
718 PCI_SLOT(dev->devfn),
719 PCI_FUNC(dev->devfn));
721 if (!psdev || !psdev->pdev) {
723 DRV_NAME " device is not found/assigned\n");
727 if (!psdev->pdev->sh_info) {
728 dev_err(&dev->dev, DRV_NAME " device is not connected or owned"
729 " by HVM, kill it\n");
730 kill_domain_by_device(psdev);
734 if (!test_bit(_XEN_PCIB_AERHANDLER,
735 (unsigned long *)&psdev->pdev->sh_info->flags)) {
737 "guest with no AER driver should have been killed\n");
740 result = common_process(psdev, 1, XEN_PCI_OP_aer_slotreset, result);
742 if (result == PCI_ERS_RESULT_NONE ||
743 result == PCI_ERS_RESULT_DISCONNECT) {
745 "No AER slot_reset service or disconnected!\n");
746 kill_domain_by_device(psdev);
750 pcistub_device_put(psdev);
751 up_write(&pcistub_sem);
757 /*xen_pcibk_mmio_enabled: it will send the mmio_enabled request to pcifront
758 * in case of the device driver could provide this service, and then wait
760 * @dev: pointer to PCI devices
761 * return value is used by aer_core do_recovery policy
764 static pci_ers_result_t xen_pcibk_mmio_enabled(struct pci_dev *dev)
766 struct pcistub_device *psdev;
767 pci_ers_result_t result;
769 result = PCI_ERS_RESULT_RECOVERED;
770 dev_dbg(&dev->dev, "xen_pcibk_mmio_enabled(bus:%x,devfn:%x)\n",
771 dev->bus->number, dev->devfn);
773 down_write(&pcistub_sem);
774 psdev = pcistub_device_find(pci_domain_nr(dev->bus),
776 PCI_SLOT(dev->devfn),
777 PCI_FUNC(dev->devfn));
779 if (!psdev || !psdev->pdev) {
781 DRV_NAME " device is not found/assigned\n");
785 if (!psdev->pdev->sh_info) {
786 dev_err(&dev->dev, DRV_NAME " device is not connected or owned"
787 " by HVM, kill it\n");
788 kill_domain_by_device(psdev);
792 if (!test_bit(_XEN_PCIB_AERHANDLER,
793 (unsigned long *)&psdev->pdev->sh_info->flags)) {
795 "guest with no AER driver should have been killed\n");
798 result = common_process(psdev, 1, XEN_PCI_OP_aer_mmio, result);
800 if (result == PCI_ERS_RESULT_NONE ||
801 result == PCI_ERS_RESULT_DISCONNECT) {
803 "No AER mmio_enabled service or disconnected!\n");
804 kill_domain_by_device(psdev);
808 pcistub_device_put(psdev);
809 up_write(&pcistub_sem);
813 /*xen_pcibk_error_detected: it will send the error_detected request to pcifront
814 * in case of the device driver could provide this service, and then wait
816 * @dev: pointer to PCI devices
817 * @error: the current PCI connection state
818 * return value is used by aer_core do_recovery policy
821 static pci_ers_result_t xen_pcibk_error_detected(struct pci_dev *dev,
822 pci_channel_state_t error)
824 struct pcistub_device *psdev;
825 pci_ers_result_t result;
827 result = PCI_ERS_RESULT_CAN_RECOVER;
828 dev_dbg(&dev->dev, "xen_pcibk_error_detected(bus:%x,devfn:%x)\n",
829 dev->bus->number, dev->devfn);
831 down_write(&pcistub_sem);
832 psdev = pcistub_device_find(pci_domain_nr(dev->bus),
834 PCI_SLOT(dev->devfn),
835 PCI_FUNC(dev->devfn));
837 if (!psdev || !psdev->pdev) {
839 DRV_NAME " device is not found/assigned\n");
843 if (!psdev->pdev->sh_info) {
844 dev_err(&dev->dev, DRV_NAME " device is not connected or owned"
845 " by HVM, kill it\n");
846 kill_domain_by_device(psdev);
850 /*Guest owns the device yet no aer handler regiested, kill guest*/
851 if (!test_bit(_XEN_PCIB_AERHANDLER,
852 (unsigned long *)&psdev->pdev->sh_info->flags)) {
853 dev_dbg(&dev->dev, "guest may have no aer driver, kill it\n");
854 kill_domain_by_device(psdev);
857 result = common_process(psdev, error, XEN_PCI_OP_aer_detected, result);
859 if (result == PCI_ERS_RESULT_NONE ||
860 result == PCI_ERS_RESULT_DISCONNECT) {
862 "No AER error_detected service or disconnected!\n");
863 kill_domain_by_device(psdev);
867 pcistub_device_put(psdev);
868 up_write(&pcistub_sem);
872 /*xen_pcibk_error_resume: it will send the error_resume request to pcifront
873 * in case of the device driver could provide this service, and then wait
875 * @dev: pointer to PCI devices
878 static void xen_pcibk_error_resume(struct pci_dev *dev)
880 struct pcistub_device *psdev;
882 dev_dbg(&dev->dev, "xen_pcibk_error_resume(bus:%x,devfn:%x)\n",
883 dev->bus->number, dev->devfn);
885 down_write(&pcistub_sem);
886 psdev = pcistub_device_find(pci_domain_nr(dev->bus),
888 PCI_SLOT(dev->devfn),
889 PCI_FUNC(dev->devfn));
891 if (!psdev || !psdev->pdev) {
893 DRV_NAME " device is not found/assigned\n");
897 if (!psdev->pdev->sh_info) {
898 dev_err(&dev->dev, DRV_NAME " device is not connected or owned"
899 " by HVM, kill it\n");
900 kill_domain_by_device(psdev);
904 if (!test_bit(_XEN_PCIB_AERHANDLER,
905 (unsigned long *)&psdev->pdev->sh_info->flags)) {
907 "guest with no AER driver should have been killed\n");
908 kill_domain_by_device(psdev);
911 common_process(psdev, 1, XEN_PCI_OP_aer_resume,
912 PCI_ERS_RESULT_RECOVERED);
915 pcistub_device_put(psdev);
916 up_write(&pcistub_sem);
920 /*add xen_pcibk AER handling*/
921 static const struct pci_error_handlers xen_pcibk_error_handler = {
922 .error_detected = xen_pcibk_error_detected,
923 .mmio_enabled = xen_pcibk_mmio_enabled,
924 .slot_reset = xen_pcibk_slot_reset,
925 .resume = xen_pcibk_error_resume,
929 * Note: There is no MODULE_DEVICE_TABLE entry here because this isn't
930 * for a normal device. I don't want it to be loaded automatically.
933 static struct pci_driver xen_pcibk_pci_driver = {
934 /* The name should be xen_pciback, but until the tools are updated
935 * we will keep it as pciback. */
937 .id_table = pcistub_ids,
938 .probe = pcistub_probe,
939 .remove = pcistub_remove,
940 .err_handler = &xen_pcibk_error_handler,
943 static inline int str_to_slot(const char *buf, int *domain, int *bus,
944 int *slot, int *func)
948 switch (sscanf(buf, " %x:%x:%x.%x %n", domain, bus, slot, func,
952 sscanf(buf, " %x:%x:%x.* %n", domain, bus, slot, &parsed);
956 sscanf(buf, " %x:%x:*.* %n", domain, bus, &parsed);
959 if (parsed && !buf[parsed])
962 /* try again without domain */
964 switch (sscanf(buf, " %x:%x.%x %n", bus, slot, func, &parsed)) {
967 sscanf(buf, " %x:%x.* %n", bus, slot, &parsed);
971 sscanf(buf, " %x:*.* %n", bus, &parsed);
974 if (parsed && !buf[parsed])
980 static inline int str_to_quirk(const char *buf, int *domain, int *bus, int
981 *slot, int *func, int *reg, int *size, int *mask)
985 sscanf(buf, " %x:%x:%x.%x-%x:%x:%x %n", domain, bus, slot, func,
986 reg, size, mask, &parsed);
987 if (parsed && !buf[parsed])
990 /* try again without domain */
992 sscanf(buf, " %x:%x.%x-%x:%x:%x %n", bus, slot, func, reg, size,
994 if (parsed && !buf[parsed])
1000 static int pcistub_device_id_add(int domain, int bus, int slot, int func)
1002 struct pcistub_device_id *pci_dev_id;
1003 unsigned long flags;
1004 int rc = 0, devfn = PCI_DEVFN(slot, func);
1007 for (slot = 0; !rc && slot < 32; ++slot)
1008 rc = pcistub_device_id_add(domain, bus, slot, func);
1013 for (func = 0; !rc && func < 8; ++func)
1014 rc = pcistub_device_id_add(domain, bus, slot, func);
1019 #if !defined(MODULE) /* pci_domains_supported is not being exported */ \
1020 || !defined(CONFIG_PCI_DOMAINS)
1021 !pci_domains_supported ? domain :
1023 domain < 0 || domain > 0xffff)
1024 || bus < 0 || bus > 0xff
1025 || PCI_SLOT(devfn) != slot
1026 || PCI_FUNC(devfn) != func)
1029 pci_dev_id = kmalloc(sizeof(*pci_dev_id), GFP_KERNEL);
1033 pci_dev_id->domain = domain;
1034 pci_dev_id->bus = bus;
1035 pci_dev_id->devfn = devfn;
1037 pr_debug("wants to seize %04x:%02x:%02x.%d\n",
1038 domain, bus, slot, func);
1040 spin_lock_irqsave(&device_ids_lock, flags);
1041 list_add_tail(&pci_dev_id->slot_list, &pcistub_device_ids);
1042 spin_unlock_irqrestore(&device_ids_lock, flags);
1047 static int pcistub_device_id_remove(int domain, int bus, int slot, int func)
1049 struct pcistub_device_id *pci_dev_id, *t;
1051 unsigned long flags;
1053 spin_lock_irqsave(&device_ids_lock, flags);
1054 list_for_each_entry_safe(pci_dev_id, t, &pcistub_device_ids,
1056 if (pci_dev_id->domain == domain && pci_dev_id->bus == bus
1057 && (slot < 0 || PCI_SLOT(pci_dev_id->devfn) == slot)
1058 && (func < 0 || PCI_FUNC(pci_dev_id->devfn) == func)) {
1059 /* Don't break; here because it's possible the same
1060 * slot could be in the list more than once
1062 list_del(&pci_dev_id->slot_list);
1067 pr_debug("removed %04x:%02x:%02x.%d from seize list\n",
1068 domain, bus, slot, func);
1071 spin_unlock_irqrestore(&device_ids_lock, flags);
1076 static int pcistub_reg_add(int domain, int bus, int slot, int func,
1077 unsigned int reg, unsigned int size,
1081 struct pcistub_device *psdev;
1082 struct pci_dev *dev;
1083 struct config_field *field;
1085 if (reg > 0xfff || (size < 4 && (mask >> (size * 8))))
1088 psdev = pcistub_device_find(domain, bus, slot, func);
1095 field = kzalloc(sizeof(*field), GFP_ATOMIC);
1101 field->offset = reg;
1105 field->reset = NULL;
1106 field->release = NULL;
1107 field->clean = xen_pcibk_config_field_free;
1109 err = xen_pcibk_config_quirks_add_field(dev, field);
1114 pcistub_device_put(psdev);
1118 static ssize_t pcistub_slot_add(struct device_driver *drv, const char *buf,
1121 int domain, bus, slot, func;
1124 err = str_to_slot(buf, &domain, &bus, &slot, &func);
1128 err = pcistub_device_id_add(domain, bus, slot, func);
1135 static DRIVER_ATTR(new_slot, S_IWUSR, NULL, pcistub_slot_add);
1137 static ssize_t pcistub_slot_remove(struct device_driver *drv, const char *buf,
1140 int domain, bus, slot, func;
1143 err = str_to_slot(buf, &domain, &bus, &slot, &func);
1147 err = pcistub_device_id_remove(domain, bus, slot, func);
1154 static DRIVER_ATTR(remove_slot, S_IWUSR, NULL, pcistub_slot_remove);
1156 static ssize_t pcistub_slot_show(struct device_driver *drv, char *buf)
1158 struct pcistub_device_id *pci_dev_id;
1160 unsigned long flags;
1162 spin_lock_irqsave(&device_ids_lock, flags);
1163 list_for_each_entry(pci_dev_id, &pcistub_device_ids, slot_list) {
1164 if (count >= PAGE_SIZE)
1167 count += scnprintf(buf + count, PAGE_SIZE - count,
1168 "%04x:%02x:%02x.%d\n",
1169 pci_dev_id->domain, pci_dev_id->bus,
1170 PCI_SLOT(pci_dev_id->devfn),
1171 PCI_FUNC(pci_dev_id->devfn));
1173 spin_unlock_irqrestore(&device_ids_lock, flags);
1177 static DRIVER_ATTR(slots, S_IRUSR, pcistub_slot_show, NULL);
1179 static ssize_t pcistub_irq_handler_show(struct device_driver *drv, char *buf)
1181 struct pcistub_device *psdev;
1182 struct xen_pcibk_dev_data *dev_data;
1184 unsigned long flags;
1186 spin_lock_irqsave(&pcistub_devices_lock, flags);
1187 list_for_each_entry(psdev, &pcistub_devices, dev_list) {
1188 if (count >= PAGE_SIZE)
1192 dev_data = pci_get_drvdata(psdev->dev);
1196 scnprintf(buf + count, PAGE_SIZE - count,
1197 "%s:%s:%sing:%ld\n",
1198 pci_name(psdev->dev),
1199 dev_data->isr_on ? "on" : "off",
1200 dev_data->ack_intr ? "ack" : "not ack",
1203 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
1206 static DRIVER_ATTR(irq_handlers, S_IRUSR, pcistub_irq_handler_show, NULL);
1208 static ssize_t pcistub_irq_handler_switch(struct device_driver *drv,
1212 struct pcistub_device *psdev;
1213 struct xen_pcibk_dev_data *dev_data;
1214 int domain, bus, slot, func;
1217 err = str_to_slot(buf, &domain, &bus, &slot, &func);
1221 psdev = pcistub_device_find(domain, bus, slot, func);
1227 dev_data = pci_get_drvdata(psdev->dev);
1233 dev_dbg(&psdev->dev->dev, "%s fake irq handler: %d->%d\n",
1234 dev_data->irq_name, dev_data->isr_on,
1237 dev_data->isr_on = !(dev_data->isr_on);
1238 if (dev_data->isr_on)
1239 dev_data->ack_intr = 1;
1242 pcistub_device_put(psdev);
1247 static DRIVER_ATTR(irq_handler_state, S_IWUSR, NULL,
1248 pcistub_irq_handler_switch);
1250 static ssize_t pcistub_quirk_add(struct device_driver *drv, const char *buf,
1253 int domain, bus, slot, func, reg, size, mask;
1256 err = str_to_quirk(buf, &domain, &bus, &slot, &func, ®, &size,
1261 err = pcistub_reg_add(domain, bus, slot, func, reg, size, mask);
1269 static ssize_t pcistub_quirk_show(struct device_driver *drv, char *buf)
1272 unsigned long flags;
1273 struct xen_pcibk_config_quirk *quirk;
1274 struct xen_pcibk_dev_data *dev_data;
1275 const struct config_field *field;
1276 const struct config_field_entry *cfg_entry;
1278 spin_lock_irqsave(&device_ids_lock, flags);
1279 list_for_each_entry(quirk, &xen_pcibk_quirks, quirks_list) {
1280 if (count >= PAGE_SIZE)
1283 count += scnprintf(buf + count, PAGE_SIZE - count,
1284 "%02x:%02x.%01x\n\t%04x:%04x:%04x:%04x\n",
1285 quirk->pdev->bus->number,
1286 PCI_SLOT(quirk->pdev->devfn),
1287 PCI_FUNC(quirk->pdev->devfn),
1288 quirk->devid.vendor, quirk->devid.device,
1289 quirk->devid.subvendor,
1290 quirk->devid.subdevice);
1292 dev_data = pci_get_drvdata(quirk->pdev);
1294 list_for_each_entry(cfg_entry, &dev_data->config_fields, list) {
1295 field = cfg_entry->field;
1296 if (count >= PAGE_SIZE)
1299 count += scnprintf(buf + count, PAGE_SIZE - count,
1300 "\t\t%08x:%01x:%08x\n",
1301 cfg_entry->base_offset +
1302 field->offset, field->size,
1308 spin_unlock_irqrestore(&device_ids_lock, flags);
1312 static DRIVER_ATTR(quirks, S_IRUSR | S_IWUSR, pcistub_quirk_show,
1315 static ssize_t permissive_add(struct device_driver *drv, const char *buf,
1318 int domain, bus, slot, func;
1320 struct pcistub_device *psdev;
1321 struct xen_pcibk_dev_data *dev_data;
1323 err = str_to_slot(buf, &domain, &bus, &slot, &func);
1327 psdev = pcistub_device_find(domain, bus, slot, func);
1333 dev_data = pci_get_drvdata(psdev->dev);
1334 /* the driver data for a device should never be null at this point */
1339 if (!dev_data->permissive) {
1340 dev_data->permissive = 1;
1341 /* Let user know that what they're doing could be unsafe */
1342 dev_warn(&psdev->dev->dev, "enabling permissive mode "
1343 "configuration space accesses!\n");
1344 dev_warn(&psdev->dev->dev,
1345 "permissive mode is potentially unsafe!\n");
1348 pcistub_device_put(psdev);
1355 static ssize_t permissive_show(struct device_driver *drv, char *buf)
1357 struct pcistub_device *psdev;
1358 struct xen_pcibk_dev_data *dev_data;
1360 unsigned long flags;
1361 spin_lock_irqsave(&pcistub_devices_lock, flags);
1362 list_for_each_entry(psdev, &pcistub_devices, dev_list) {
1363 if (count >= PAGE_SIZE)
1367 dev_data = pci_get_drvdata(psdev->dev);
1368 if (!dev_data || !dev_data->permissive)
1371 scnprintf(buf + count, PAGE_SIZE - count, "%s\n",
1372 pci_name(psdev->dev));
1374 spin_unlock_irqrestore(&pcistub_devices_lock, flags);
1377 static DRIVER_ATTR(permissive, S_IRUSR | S_IWUSR, permissive_show,
1380 static void pcistub_exit(void)
1382 driver_remove_file(&xen_pcibk_pci_driver.driver, &driver_attr_new_slot);
1383 driver_remove_file(&xen_pcibk_pci_driver.driver,
1384 &driver_attr_remove_slot);
1385 driver_remove_file(&xen_pcibk_pci_driver.driver, &driver_attr_slots);
1386 driver_remove_file(&xen_pcibk_pci_driver.driver, &driver_attr_quirks);
1387 driver_remove_file(&xen_pcibk_pci_driver.driver,
1388 &driver_attr_permissive);
1389 driver_remove_file(&xen_pcibk_pci_driver.driver,
1390 &driver_attr_irq_handlers);
1391 driver_remove_file(&xen_pcibk_pci_driver.driver,
1392 &driver_attr_irq_handler_state);
1393 pci_unregister_driver(&xen_pcibk_pci_driver);
1396 static int __init pcistub_init(void)
1400 int domain, bus, slot, func;
1403 if (pci_devs_to_hide && *pci_devs_to_hide) {
1407 err = sscanf(pci_devs_to_hide + pos,
1408 " (%x:%x:%x.%x) %n",
1409 &domain, &bus, &slot, &func, &parsed);
1413 sscanf(pci_devs_to_hide + pos,
1415 &domain, &bus, &slot, &parsed);
1419 sscanf(pci_devs_to_hide + pos,
1421 &domain, &bus, &parsed);
1427 err = sscanf(pci_devs_to_hide + pos,
1429 &bus, &slot, &func, &parsed);
1433 sscanf(pci_devs_to_hide + pos,
1435 &bus, &slot, &parsed);
1439 sscanf(pci_devs_to_hide + pos,
1449 err = pcistub_device_id_add(domain, bus, slot, func);
1454 } while (pci_devs_to_hide[pos]);
1457 /* If we're the first PCI Device Driver to register, we're the
1458 * first one to get offered PCI devices as they become
1459 * available (and thus we can be the first to grab them)
1461 err = pci_register_driver(&xen_pcibk_pci_driver);
1465 err = driver_create_file(&xen_pcibk_pci_driver.driver,
1466 &driver_attr_new_slot);
1468 err = driver_create_file(&xen_pcibk_pci_driver.driver,
1469 &driver_attr_remove_slot);
1471 err = driver_create_file(&xen_pcibk_pci_driver.driver,
1472 &driver_attr_slots);
1474 err = driver_create_file(&xen_pcibk_pci_driver.driver,
1475 &driver_attr_quirks);
1477 err = driver_create_file(&xen_pcibk_pci_driver.driver,
1478 &driver_attr_permissive);
1481 err = driver_create_file(&xen_pcibk_pci_driver.driver,
1482 &driver_attr_irq_handlers);
1484 err = driver_create_file(&xen_pcibk_pci_driver.driver,
1485 &driver_attr_irq_handler_state);
1493 pr_err("Error parsing pci_devs_to_hide at \"%s\"\n",
1494 pci_devs_to_hide + pos);
1500 * fs_initcall happens before device_initcall
1501 * so xen_pcibk *should* get called first (b/c we
1502 * want to suck up any device before other drivers
1503 * get a chance by being the first pci device
1504 * driver to register)
1506 fs_initcall(pcistub_init);
1509 static int __init xen_pcibk_init(void)
1513 if (!xen_initial_domain())
1516 err = xen_pcibk_config_init();
1521 err = pcistub_init();
1526 pcistub_init_devices_late();
1527 err = xen_pcibk_xenbus_register();
1534 static void __exit xen_pcibk_cleanup(void)
1536 xen_pcibk_xenbus_unregister();
1540 module_init(xen_pcibk_init);
1541 module_exit(xen_pcibk_cleanup);
1543 MODULE_LICENSE("Dual BSD/GPL");
1544 MODULE_ALIAS("xen-backend:pci");