[linux-block.git] / drivers / s390 / crypto / vfio_ap_private.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Private data and functions for adjunct processor VFIO matrix driver.
 *
 * Author(s): Tony Krowiak <akrowiak@linux.ibm.com>
 *	      Halil Pasic <pasic@linux.ibm.com>
 *	      Pierre Morel <pmorel@linux.ibm.com>
 *
 * Copyright IBM Corp. 2018
 */

#ifndef _VFIO_AP_PRIVATE_H_
#define _VFIO_AP_PRIVATE_H_

#include <linux/types.h>
#include <linux/mdev.h>
#include <linux/delay.h>
#include <linux/eventfd.h>
#include <linux/mutex.h>
#include <linux/kvm_host.h>
#include <linux/vfio.h>
#include <linux/hashtable.h>

#include "ap_bus.h"

#define VFIO_AP_MODULE_NAME "vfio_ap"
#define VFIO_AP_DRV_NAME "vfio_ap"

/**
 * struct ap_matrix_dev - Contains the data for the matrix device.
 *
 * @device:	generic device structure associated with the AP matrix device
 * @info:	the struct containing the output from the PQAP(QCI) instruction
 * @mdev_list:	the list of mediated matrix devices created
 * @mdevs_lock: mutex for locking the AP matrix device. This lock will be
 *		taken every time we fiddle with state managed by the vfio_ap
 *		driver, be it using @mdev_list or writing the state of a
 *		single ap_matrix_mdev device. It's quite coarse but we don't
 *		expect much contention.
 * @vfio_ap_drv: the vfio_ap device driver
 * @guests_lock: mutex for controlling access to a guest that is using AP
 *		 devices passed through by the vfio_ap device driver. This lock
 *		 will be taken when the AP devices are plugged into or unplugged
 *		 from a guest, and when an ap_matrix_mdev device is added to or
 *		 removed from @mdev_list or the list is iterated.
 */
struct ap_matrix_dev {
	struct device device;
	struct ap_config_info info;
	struct list_head mdev_list;
	struct mutex mdevs_lock; /* serializes access to each ap_matrix_mdev */
	struct ap_driver  *vfio_ap_drv;
	struct mutex guests_lock; /* serializes access to each KVM guest */
	struct mdev_parent parent;
	struct mdev_type mdev_type;
	struct mdev_type *mdev_types[1];
};

extern struct ap_matrix_dev *matrix_dev;

/**
 * struct ap_matrix - matrix of adapters, domains and control domains
 *
 * @apm_max: max adapter number in @apm
 * @apm: identifies the AP adapters in the matrix
 * @aqm_max: max domain number in @aqm
 * @aqm: identifies the AP queues (domains) in the matrix
 * @adm_max: max domain number in @adm
 * @adm: identifies the AP control domains in the matrix
 *
 * The AP matrix is comprised of three bit masks identifying the adapters,
 * queues (domains) and control domains that belong to an AP matrix. The bits in
 * each mask, from left to right, correspond to IDs 0 to 255. When a bit is set
 * the corresponding ID belongs to the matrix.
 */
struct ap_matrix {
	unsigned long apm_max;
	DECLARE_BITMAP(apm, 256);
	unsigned long aqm_max;
	DECLARE_BITMAP(aqm, 256);
	unsigned long adm_max;
	DECLARE_BITMAP(adm, 256);
};

/**
 * struct ap_queue_table - a table of queue objects.
 *
 * @queues: a hashtable of queues (struct vfio_ap_queue).
 */
struct ap_queue_table {
	DECLARE_HASHTABLE(queues, 8);
};

/**
 * struct ap_matrix_mdev - Contains the data associated with a matrix mediated
 *			   device.
 * @vdev:	the vfio device
 * @node:	allows the ap_matrix_mdev struct to be added to a list
 * @matrix:	the adapters, usage domains and control domains assigned to the
 *		mediated matrix device.
 * @shadow_apcb:    the shadow copy of the APCB field of the KVM guest's CRYCB
 * @kvm:	the struct holding guest's state
 * @pqap_hook:	the function pointer to the interception handler for the
 *		PQAP(AQIC) instruction.
 * @mdev:	the mediated device
 * @qtable:	table of queues (struct vfio_ap_queue) assigned to the mdev
 * @req_trigger eventfd ctx for signaling userspace to return a device
 * @apm_add:	bitmap of APIDs added to the host's AP configuration
 * @aqm_add:	bitmap of APQIs added to the host's AP configuration
 * @adm_add:	bitmap of control domain numbers added to the host's AP
 *		configuration
 */
struct ap_matrix_mdev {
	struct vfio_device vdev;
	struct list_head node;
	struct ap_matrix matrix;
	struct ap_matrix shadow_apcb;
	struct kvm *kvm;
	crypto_hook pqap_hook;
	struct mdev_device *mdev;
	struct ap_queue_table qtable;
	struct eventfd_ctx *req_trigger;
	DECLARE_BITMAP(apm_add, AP_DEVICES);
	DECLARE_BITMAP(aqm_add, AP_DOMAINS);
	DECLARE_BITMAP(adm_add, AP_DOMAINS);
};

/**
 * struct vfio_ap_queue - contains the data associated with a queue bound to the
 *			  vfio_ap device driver
 * @matrix_mdev: the matrix mediated device
 * @saved_iova: the notification indicator byte (nib) address
 * @apqn: the APQN of the AP queue device
 * @saved_isc: the guest ISC registered with the GIB interface
 * @mdev_qnode: allows the vfio_ap_queue struct to be added to a hashtable
 * @reset_rc: the status response code from the last reset of the queue
 */
struct vfio_ap_queue {
	struct ap_matrix_mdev *matrix_mdev;
	dma_addr_t saved_iova;
	int	apqn;
#define VFIO_AP_ISC_INVALID 0xff
	unsigned char saved_isc;
	struct hlist_node mdev_qnode;
	unsigned int reset_rc;
};

int vfio_ap_mdev_register(void);
void vfio_ap_mdev_unregister(void);

int vfio_ap_mdev_probe_queue(struct ap_device *queue);
void vfio_ap_mdev_remove_queue(struct ap_device *queue);

int vfio_ap_mdev_resource_in_use(unsigned long *apm, unsigned long *aqm);

void vfio_ap_on_cfg_changed(struct ap_config_info *new_config_info,
			    struct ap_config_info *old_config_info);
void vfio_ap_on_scan_complete(struct ap_config_info *new_config_info,
			      struct ap_config_info *old_config_info);

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