1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Private data and functions for adjunct processor VFIO matrix driver. 4 * 5 * Author(s): Tony Krowiak <akrowiak@linux.ibm.com> 6 * Halil Pasic <pasic@linux.ibm.com> 7 * Pierre Morel <pmorel@linux.ibm.com> 8 * 9 * Copyright IBM Corp. 2018 10 */ 11 12 #ifndef _VFIO_AP_PRIVATE_H_ 13 #define _VFIO_AP_PRIVATE_H_ 14 15 #include <linux/types.h> 16 #include <linux/mdev.h> 17 #include <linux/delay.h> 18 #include <linux/mutex.h> 19 #include <linux/kvm_host.h> 20 #include <linux/vfio.h> 21 #include <linux/hashtable.h> 22 23 #include "ap_bus.h" 24 25 #define VFIO_AP_MODULE_NAME "vfio_ap" 26 #define VFIO_AP_DRV_NAME "vfio_ap" 27 28 /** 29 * struct ap_matrix_dev - Contains the data for the matrix device. 30 * 31 * @device: generic device structure associated with the AP matrix device 32 * @info: the struct containing the output from the PQAP(QCI) instruction 33 * @mdev_list: the list of mediated matrix devices created 34 * @mdevs_lock: mutex for locking the AP matrix device. This lock will be 35 * taken every time we fiddle with state managed by the vfio_ap 36 * driver, be it using @mdev_list or writing the state of a 37 * single ap_matrix_mdev device. It's quite coarse but we don't 38 * expect much contention. 39 * @vfio_ap_drv: the vfio_ap device driver 40 * @guests_lock: mutex for controlling access to a guest that is using AP 41 * devices passed through by the vfio_ap device driver. This lock 42 * will be taken when the AP devices are plugged into or unplugged 43 * from a guest, and when an ap_matrix_mdev device is added to or 44 * removed from @mdev_list or the list is iterated. 45 */ 46 struct ap_matrix_dev { 47 struct device device; 48 struct ap_config_info info; 49 struct list_head mdev_list; 50 struct mutex mdevs_lock; /* serializes access to each ap_matrix_mdev */ 51 struct ap_driver *vfio_ap_drv; 52 struct mutex guests_lock; /* serializes access to each KVM guest */ 53 struct mdev_parent parent; 54 struct mdev_type mdev_type; 55 struct mdev_type *mdev_types[1]; 56 }; 57 58 extern struct ap_matrix_dev *matrix_dev; 59 60 /** 61 * struct ap_matrix - matrix of adapters, domains and control domains 62 * 63 * @apm_max: max adapter number in @apm 64 * @apm: identifies the AP adapters in the matrix 65 * @aqm_max: max domain number in @aqm 66 * @aqm: identifies the AP queues (domains) in the matrix 67 * @adm_max: max domain number in @adm 68 * @adm: identifies the AP control domains in the matrix 69 * 70 * The AP matrix is comprised of three bit masks identifying the adapters, 71 * queues (domains) and control domains that belong to an AP matrix. The bits in 72 * each mask, from left to right, correspond to IDs 0 to 255. When a bit is set 73 * the corresponding ID belongs to the matrix. 74 */ 75 struct ap_matrix { 76 unsigned long apm_max; 77 DECLARE_BITMAP(apm, 256); 78 unsigned long aqm_max; 79 DECLARE_BITMAP(aqm, 256); 80 unsigned long adm_max; 81 DECLARE_BITMAP(adm, 256); 82 }; 83 84 /** 85 * struct ap_queue_table - a table of queue objects. 86 * 87 * @queues: a hashtable of queues (struct vfio_ap_queue). 88 */ 89 struct ap_queue_table { 90 DECLARE_HASHTABLE(queues, 8); 91 }; 92 93 /** 94 * struct ap_matrix_mdev - Contains the data associated with a matrix mediated 95 * device. 96 * @vdev: the vfio device 97 * @node: allows the ap_matrix_mdev struct to be added to a list 98 * @matrix: the adapters, usage domains and control domains assigned to the 99 * mediated matrix device. 100 * @shadow_apcb: the shadow copy of the APCB field of the KVM guest's CRYCB 101 * @kvm: the struct holding guest's state 102 * @pqap_hook: the function pointer to the interception handler for the 103 * PQAP(AQIC) instruction. 104 * @mdev: the mediated device 105 * @qtable: table of queues (struct vfio_ap_queue) assigned to the mdev 106 * @apm_add: bitmap of APIDs added to the host's AP configuration 107 * @aqm_add: bitmap of APQIs added to the host's AP configuration 108 * @adm_add: bitmap of control domain numbers added to the host's AP 109 * configuration 110 */ 111 struct ap_matrix_mdev { 112 struct vfio_device vdev; 113 struct list_head node; 114 struct ap_matrix matrix; 115 struct ap_matrix shadow_apcb; 116 struct kvm *kvm; 117 crypto_hook pqap_hook; 118 struct mdev_device *mdev; 119 struct ap_queue_table qtable; 120 DECLARE_BITMAP(apm_add, AP_DEVICES); 121 DECLARE_BITMAP(aqm_add, AP_DOMAINS); 122 DECLARE_BITMAP(adm_add, AP_DOMAINS); 123 }; 124 125 /** 126 * struct vfio_ap_queue - contains the data associated with a queue bound to the 127 * vfio_ap device driver 128 * @matrix_mdev: the matrix mediated device 129 * @saved_iova: the notification indicator byte (nib) address 130 * @apqn: the APQN of the AP queue device 131 * @saved_isc: the guest ISC registered with the GIB interface 132 * @mdev_qnode: allows the vfio_ap_queue struct to be added to a hashtable 133 * @reset_rc: the status response code from the last reset of the queue 134 */ 135 struct vfio_ap_queue { 136 struct ap_matrix_mdev *matrix_mdev; 137 dma_addr_t saved_iova; 138 int apqn; 139 #define VFIO_AP_ISC_INVALID 0xff 140 unsigned char saved_isc; 141 struct hlist_node mdev_qnode; 142 unsigned int reset_rc; 143 }; 144 145 int vfio_ap_mdev_register(void); 146 void vfio_ap_mdev_unregister(void); 147 148 int vfio_ap_mdev_probe_queue(struct ap_device *queue); 149 void vfio_ap_mdev_remove_queue(struct ap_device *queue); 150 151 int vfio_ap_mdev_resource_in_use(unsigned long *apm, unsigned long *aqm); 152 153 void vfio_ap_on_cfg_changed(struct ap_config_info *new_config_info, 154 struct ap_config_info *old_config_info); 155 void vfio_ap_on_scan_complete(struct ap_config_info *new_config_info, 156 struct ap_config_info *old_config_info); 157 158 #endif /* _VFIO_AP_PRIVATE_H_ */ 159