xref: /openbmc/linux/drivers/s390/cio/vfio_ccw_cp.c (revision c389377c01bf2d6e2a178e86aef8535931bfbd75)
10a19e61eSDong Jia Shi /*
20a19e61eSDong Jia Shi  * channel program interfaces
30a19e61eSDong Jia Shi  *
40a19e61eSDong Jia Shi  * Copyright IBM Corp. 2017
50a19e61eSDong Jia Shi  *
60a19e61eSDong Jia Shi  * Author(s): Dong Jia Shi <bjsdjshi@linux.vnet.ibm.com>
70a19e61eSDong Jia Shi  *            Xiao Feng Ren <renxiaof@linux.vnet.ibm.com>
80a19e61eSDong Jia Shi  */
90a19e61eSDong Jia Shi 
100a19e61eSDong Jia Shi #include <linux/mm.h>
110a19e61eSDong Jia Shi #include <linux/slab.h>
120a19e61eSDong Jia Shi #include <linux/iommu.h>
130a19e61eSDong Jia Shi #include <linux/vfio.h>
140a19e61eSDong Jia Shi #include <asm/idals.h>
150a19e61eSDong Jia Shi 
160a19e61eSDong Jia Shi #include "vfio_ccw_cp.h"
170a19e61eSDong Jia Shi 
180a19e61eSDong Jia Shi /*
190a19e61eSDong Jia Shi  * Max length for ccw chain.
200a19e61eSDong Jia Shi  * XXX: Limit to 256, need to check more?
210a19e61eSDong Jia Shi  */
220a19e61eSDong Jia Shi #define CCWCHAIN_LEN_MAX	256
230a19e61eSDong Jia Shi 
240a19e61eSDong Jia Shi struct pfn_array {
250a19e61eSDong Jia Shi 	unsigned long		pa_iova;
260a19e61eSDong Jia Shi 	unsigned long		*pa_iova_pfn;
270a19e61eSDong Jia Shi 	unsigned long		*pa_pfn;
280a19e61eSDong Jia Shi 	int			pa_nr;
290a19e61eSDong Jia Shi };
300a19e61eSDong Jia Shi 
310a19e61eSDong Jia Shi struct pfn_array_table {
320a19e61eSDong Jia Shi 	struct pfn_array	*pat_pa;
330a19e61eSDong Jia Shi 	int			pat_nr;
340a19e61eSDong Jia Shi };
350a19e61eSDong Jia Shi 
360a19e61eSDong Jia Shi struct ccwchain {
370a19e61eSDong Jia Shi 	struct list_head	next;
380a19e61eSDong Jia Shi 	struct ccw1		*ch_ccw;
390a19e61eSDong Jia Shi 	/* Guest physical address of the current chain. */
400a19e61eSDong Jia Shi 	u64			ch_iova;
410a19e61eSDong Jia Shi 	/* Count of the valid ccws in chain. */
420a19e61eSDong Jia Shi 	int			ch_len;
430a19e61eSDong Jia Shi 	/* Pinned PAGEs for the original data. */
440a19e61eSDong Jia Shi 	struct pfn_array_table	*ch_pat;
450a19e61eSDong Jia Shi };
460a19e61eSDong Jia Shi 
470a19e61eSDong Jia Shi /*
480a19e61eSDong Jia Shi  * pfn_array_pin() - pin user pages in memory
490a19e61eSDong Jia Shi  * @pa: pfn_array on which to perform the operation
500a19e61eSDong Jia Shi  * @mdev: the mediated device to perform pin/unpin operations
510a19e61eSDong Jia Shi  *
520a19e61eSDong Jia Shi  * Attempt to pin user pages in memory.
530a19e61eSDong Jia Shi  *
540a19e61eSDong Jia Shi  * Usage of pfn_array:
550a19e61eSDong Jia Shi  * @pa->pa_iova     starting guest physical I/O address. Assigned by caller.
560a19e61eSDong Jia Shi  * @pa->pa_iova_pfn array that stores PFNs of the pages need to pin. Allocated
570a19e61eSDong Jia Shi  *                  by caller.
580a19e61eSDong Jia Shi  * @pa->pa_pfn      array that receives PFNs of the pages pinned. Allocated by
590a19e61eSDong Jia Shi  *                  caller.
600a19e61eSDong Jia Shi  * @pa->pa_nr       number of pages from @pa->pa_iova to pin. Assigned by
610a19e61eSDong Jia Shi  *                  caller.
620a19e61eSDong Jia Shi  *                  number of pages pinned. Assigned by callee.
630a19e61eSDong Jia Shi  *
640a19e61eSDong Jia Shi  * Returns:
650a19e61eSDong Jia Shi  *   Number of pages pinned on success.
660a19e61eSDong Jia Shi  *   If @pa->pa_nr is 0 or negative, returns 0.
670a19e61eSDong Jia Shi  *   If no pages were pinned, returns -errno.
680a19e61eSDong Jia Shi  */
690a19e61eSDong Jia Shi static int pfn_array_pin(struct pfn_array *pa, struct device *mdev)
700a19e61eSDong Jia Shi {
710a19e61eSDong Jia Shi 	int i, ret;
720a19e61eSDong Jia Shi 
730a19e61eSDong Jia Shi 	if (pa->pa_nr <= 0) {
740a19e61eSDong Jia Shi 		pa->pa_nr = 0;
750a19e61eSDong Jia Shi 		return 0;
760a19e61eSDong Jia Shi 	}
770a19e61eSDong Jia Shi 
780a19e61eSDong Jia Shi 	pa->pa_iova_pfn[0] = pa->pa_iova >> PAGE_SHIFT;
790a19e61eSDong Jia Shi 	for (i = 1; i < pa->pa_nr; i++)
800a19e61eSDong Jia Shi 		pa->pa_iova_pfn[i] = pa->pa_iova_pfn[i - 1] + 1;
810a19e61eSDong Jia Shi 
820a19e61eSDong Jia Shi 	ret = vfio_pin_pages(mdev, pa->pa_iova_pfn, pa->pa_nr,
830a19e61eSDong Jia Shi 			     IOMMU_READ | IOMMU_WRITE, pa->pa_pfn);
840a19e61eSDong Jia Shi 
850a19e61eSDong Jia Shi 	if (ret > 0 && ret != pa->pa_nr) {
860a19e61eSDong Jia Shi 		vfio_unpin_pages(mdev, pa->pa_iova_pfn, ret);
870a19e61eSDong Jia Shi 		pa->pa_nr = 0;
880a19e61eSDong Jia Shi 		return 0;
890a19e61eSDong Jia Shi 	}
900a19e61eSDong Jia Shi 
910a19e61eSDong Jia Shi 	return ret;
920a19e61eSDong Jia Shi }
930a19e61eSDong Jia Shi 
940a19e61eSDong Jia Shi /* Unpin the pages before releasing the memory. */
950a19e61eSDong Jia Shi static void pfn_array_unpin_free(struct pfn_array *pa, struct device *mdev)
960a19e61eSDong Jia Shi {
970a19e61eSDong Jia Shi 	vfio_unpin_pages(mdev, pa->pa_iova_pfn, pa->pa_nr);
980a19e61eSDong Jia Shi 	pa->pa_nr = 0;
990a19e61eSDong Jia Shi 	kfree(pa->pa_iova_pfn);
1000a19e61eSDong Jia Shi }
1010a19e61eSDong Jia Shi 
1020a19e61eSDong Jia Shi /* Alloc memory for PFNs, then pin pages with them. */
1030a19e61eSDong Jia Shi static int pfn_array_alloc_pin(struct pfn_array *pa, struct device *mdev,
1040a19e61eSDong Jia Shi 			       u64 iova, unsigned int len)
1050a19e61eSDong Jia Shi {
1060a19e61eSDong Jia Shi 	int ret = 0;
1070a19e61eSDong Jia Shi 
1080a19e61eSDong Jia Shi 	if (!len || pa->pa_nr)
1090a19e61eSDong Jia Shi 		return -EINVAL;
1100a19e61eSDong Jia Shi 
1110a19e61eSDong Jia Shi 	pa->pa_iova = iova;
1120a19e61eSDong Jia Shi 
1130a19e61eSDong Jia Shi 	pa->pa_nr = ((iova & ~PAGE_MASK) + len + (PAGE_SIZE - 1)) >> PAGE_SHIFT;
1140a19e61eSDong Jia Shi 	if (!pa->pa_nr)
1150a19e61eSDong Jia Shi 		return -EINVAL;
1160a19e61eSDong Jia Shi 
1170a19e61eSDong Jia Shi 	pa->pa_iova_pfn = kcalloc(pa->pa_nr,
1180a19e61eSDong Jia Shi 				  sizeof(*pa->pa_iova_pfn) +
1190a19e61eSDong Jia Shi 				  sizeof(*pa->pa_pfn),
1200a19e61eSDong Jia Shi 				  GFP_KERNEL);
1210a19e61eSDong Jia Shi 	if (unlikely(!pa->pa_iova_pfn))
1220a19e61eSDong Jia Shi 		return -ENOMEM;
1230a19e61eSDong Jia Shi 	pa->pa_pfn = pa->pa_iova_pfn + pa->pa_nr;
1240a19e61eSDong Jia Shi 
1250a19e61eSDong Jia Shi 	ret = pfn_array_pin(pa, mdev);
1260a19e61eSDong Jia Shi 
1270a19e61eSDong Jia Shi 	if (ret > 0)
1280a19e61eSDong Jia Shi 		return ret;
1290a19e61eSDong Jia Shi 	else if (!ret)
1300a19e61eSDong Jia Shi 		ret = -EINVAL;
1310a19e61eSDong Jia Shi 
1320a19e61eSDong Jia Shi 	kfree(pa->pa_iova_pfn);
1330a19e61eSDong Jia Shi 
1340a19e61eSDong Jia Shi 	return ret;
1350a19e61eSDong Jia Shi }
1360a19e61eSDong Jia Shi 
1370a19e61eSDong Jia Shi static int pfn_array_table_init(struct pfn_array_table *pat, int nr)
1380a19e61eSDong Jia Shi {
1390a19e61eSDong Jia Shi 	pat->pat_pa = kcalloc(nr, sizeof(*pat->pat_pa), GFP_KERNEL);
1400a19e61eSDong Jia Shi 	if (unlikely(ZERO_OR_NULL_PTR(pat->pat_pa))) {
1410a19e61eSDong Jia Shi 		pat->pat_nr = 0;
1420a19e61eSDong Jia Shi 		return -ENOMEM;
1430a19e61eSDong Jia Shi 	}
1440a19e61eSDong Jia Shi 
1450a19e61eSDong Jia Shi 	pat->pat_nr = nr;
1460a19e61eSDong Jia Shi 
1470a19e61eSDong Jia Shi 	return 0;
1480a19e61eSDong Jia Shi }
1490a19e61eSDong Jia Shi 
1500a19e61eSDong Jia Shi static void pfn_array_table_unpin_free(struct pfn_array_table *pat,
1510a19e61eSDong Jia Shi 				       struct device *mdev)
1520a19e61eSDong Jia Shi {
1530a19e61eSDong Jia Shi 	int i;
1540a19e61eSDong Jia Shi 
1550a19e61eSDong Jia Shi 	for (i = 0; i < pat->pat_nr; i++)
1560a19e61eSDong Jia Shi 		pfn_array_unpin_free(pat->pat_pa + i, mdev);
1570a19e61eSDong Jia Shi 
1580a19e61eSDong Jia Shi 	if (pat->pat_nr) {
1590a19e61eSDong Jia Shi 		kfree(pat->pat_pa);
1600a19e61eSDong Jia Shi 		pat->pat_pa = NULL;
1610a19e61eSDong Jia Shi 		pat->pat_nr = 0;
1620a19e61eSDong Jia Shi 	}
1630a19e61eSDong Jia Shi }
1640a19e61eSDong Jia Shi 
1650a19e61eSDong Jia Shi static bool pfn_array_table_iova_pinned(struct pfn_array_table *pat,
1660a19e61eSDong Jia Shi 					unsigned long iova)
1670a19e61eSDong Jia Shi {
1680a19e61eSDong Jia Shi 	struct pfn_array *pa = pat->pat_pa;
1690a19e61eSDong Jia Shi 	unsigned long iova_pfn = iova >> PAGE_SHIFT;
1700a19e61eSDong Jia Shi 	int i, j;
1710a19e61eSDong Jia Shi 
1720a19e61eSDong Jia Shi 	for (i = 0; i < pat->pat_nr; i++, pa++)
1730a19e61eSDong Jia Shi 		for (j = 0; j < pa->pa_nr; j++)
1740a19e61eSDong Jia Shi 			if (pa->pa_iova_pfn[i] == iova_pfn)
1750a19e61eSDong Jia Shi 				return true;
1760a19e61eSDong Jia Shi 
1770a19e61eSDong Jia Shi 	return false;
1780a19e61eSDong Jia Shi }
1790a19e61eSDong Jia Shi /* Create the list idal words for a pfn_array_table. */
1800a19e61eSDong Jia Shi static inline void pfn_array_table_idal_create_words(
1810a19e61eSDong Jia Shi 	struct pfn_array_table *pat,
1820a19e61eSDong Jia Shi 	unsigned long *idaws)
1830a19e61eSDong Jia Shi {
1840a19e61eSDong Jia Shi 	struct pfn_array *pa;
1850a19e61eSDong Jia Shi 	int i, j, k;
1860a19e61eSDong Jia Shi 
1870a19e61eSDong Jia Shi 	/*
1880a19e61eSDong Jia Shi 	 * Idal words (execept the first one) rely on the memory being 4k
1890a19e61eSDong Jia Shi 	 * aligned. If a user virtual address is 4K aligned, then it's
1900a19e61eSDong Jia Shi 	 * corresponding kernel physical address will also be 4K aligned. Thus
1910a19e61eSDong Jia Shi 	 * there will be no problem here to simply use the phys to create an
1920a19e61eSDong Jia Shi 	 * idaw.
1930a19e61eSDong Jia Shi 	 */
1940a19e61eSDong Jia Shi 	k = 0;
1950a19e61eSDong Jia Shi 	for (i = 0; i < pat->pat_nr; i++) {
1960a19e61eSDong Jia Shi 		pa = pat->pat_pa + i;
1970a19e61eSDong Jia Shi 		for (j = 0; j < pa->pa_nr; j++) {
1980a19e61eSDong Jia Shi 			idaws[k] = pa->pa_pfn[j] << PAGE_SHIFT;
1990a19e61eSDong Jia Shi 			if (k == 0)
2000a19e61eSDong Jia Shi 				idaws[k] += pa->pa_iova & (PAGE_SIZE - 1);
2010a19e61eSDong Jia Shi 			k++;
2020a19e61eSDong Jia Shi 		}
2030a19e61eSDong Jia Shi 	}
2040a19e61eSDong Jia Shi }
2050a19e61eSDong Jia Shi 
2060a19e61eSDong Jia Shi 
2070a19e61eSDong Jia Shi /*
2080a19e61eSDong Jia Shi  * Within the domain (@mdev), copy @n bytes from a guest physical
2090a19e61eSDong Jia Shi  * address (@iova) to a host physical address (@to).
2100a19e61eSDong Jia Shi  */
2110a19e61eSDong Jia Shi static long copy_from_iova(struct device *mdev,
2120a19e61eSDong Jia Shi 			   void *to, u64 iova,
2130a19e61eSDong Jia Shi 			   unsigned long n)
2140a19e61eSDong Jia Shi {
2150a19e61eSDong Jia Shi 	struct pfn_array pa = {0};
2160a19e61eSDong Jia Shi 	u64 from;
2170a19e61eSDong Jia Shi 	int i, ret;
2180a19e61eSDong Jia Shi 	unsigned long l, m;
2190a19e61eSDong Jia Shi 
2200a19e61eSDong Jia Shi 	ret = pfn_array_alloc_pin(&pa, mdev, iova, n);
2210a19e61eSDong Jia Shi 	if (ret <= 0)
2220a19e61eSDong Jia Shi 		return ret;
2230a19e61eSDong Jia Shi 
2240a19e61eSDong Jia Shi 	l = n;
2250a19e61eSDong Jia Shi 	for (i = 0; i < pa.pa_nr; i++) {
2260a19e61eSDong Jia Shi 		from = pa.pa_pfn[i] << PAGE_SHIFT;
2270a19e61eSDong Jia Shi 		m = PAGE_SIZE;
2280a19e61eSDong Jia Shi 		if (i == 0) {
2290a19e61eSDong Jia Shi 			from += iova & (PAGE_SIZE - 1);
2300a19e61eSDong Jia Shi 			m -= iova & (PAGE_SIZE - 1);
2310a19e61eSDong Jia Shi 		}
2320a19e61eSDong Jia Shi 
2330a19e61eSDong Jia Shi 		m = min(l, m);
2340a19e61eSDong Jia Shi 		memcpy(to + (n - l), (void *)from, m);
2350a19e61eSDong Jia Shi 
2360a19e61eSDong Jia Shi 		l -= m;
2370a19e61eSDong Jia Shi 		if (l == 0)
2380a19e61eSDong Jia Shi 			break;
2390a19e61eSDong Jia Shi 	}
2400a19e61eSDong Jia Shi 
2410a19e61eSDong Jia Shi 	pfn_array_unpin_free(&pa, mdev);
2420a19e61eSDong Jia Shi 
2430a19e61eSDong Jia Shi 	return l;
2440a19e61eSDong Jia Shi }
2450a19e61eSDong Jia Shi 
2460a19e61eSDong Jia Shi static long copy_ccw_from_iova(struct channel_program *cp,
2470a19e61eSDong Jia Shi 			       struct ccw1 *to, u64 iova,
2480a19e61eSDong Jia Shi 			       unsigned long len)
2490a19e61eSDong Jia Shi {
250d686f21aSDong Jia Shi 	struct ccw0 ccw0;
251d686f21aSDong Jia Shi 	struct ccw1 *pccw1;
252d686f21aSDong Jia Shi 	int ret;
253d686f21aSDong Jia Shi 	int i;
254d686f21aSDong Jia Shi 
255d686f21aSDong Jia Shi 	ret = copy_from_iova(cp->mdev, to, iova, len * sizeof(struct ccw1));
256d686f21aSDong Jia Shi 	if (ret)
257d686f21aSDong Jia Shi 		return ret;
258d686f21aSDong Jia Shi 
259d686f21aSDong Jia Shi 	if (!cp->orb.cmd.fmt) {
260d686f21aSDong Jia Shi 		pccw1 = to;
261d686f21aSDong Jia Shi 		for (i = 0; i < len; i++) {
262d686f21aSDong Jia Shi 			ccw0 = *(struct ccw0 *)pccw1;
263d686f21aSDong Jia Shi 			if ((pccw1->cmd_code & 0x0f) == CCW_CMD_TIC) {
264d686f21aSDong Jia Shi 				pccw1->cmd_code = CCW_CMD_TIC;
265d686f21aSDong Jia Shi 				pccw1->flags = 0;
266d686f21aSDong Jia Shi 				pccw1->count = 0;
267d686f21aSDong Jia Shi 			} else {
268d686f21aSDong Jia Shi 				pccw1->cmd_code = ccw0.cmd_code;
269d686f21aSDong Jia Shi 				pccw1->flags = ccw0.flags;
270d686f21aSDong Jia Shi 				pccw1->count = ccw0.count;
271d686f21aSDong Jia Shi 			}
272d686f21aSDong Jia Shi 			pccw1->cda = ccw0.cda;
273d686f21aSDong Jia Shi 			pccw1++;
274d686f21aSDong Jia Shi 		}
275d686f21aSDong Jia Shi 	}
276d686f21aSDong Jia Shi 
277d686f21aSDong Jia Shi 	return ret;
2780a19e61eSDong Jia Shi }
2790a19e61eSDong Jia Shi 
2800a19e61eSDong Jia Shi /*
2810a19e61eSDong Jia Shi  * Helpers to operate ccwchain.
2820a19e61eSDong Jia Shi  */
2830a19e61eSDong Jia Shi #define ccw_is_test(_ccw) (((_ccw)->cmd_code & 0x0F) == 0)
2840a19e61eSDong Jia Shi 
2850a19e61eSDong Jia Shi #define ccw_is_noop(_ccw) ((_ccw)->cmd_code == CCW_CMD_NOOP)
2860a19e61eSDong Jia Shi 
2870a19e61eSDong Jia Shi #define ccw_is_tic(_ccw) ((_ccw)->cmd_code == CCW_CMD_TIC)
2880a19e61eSDong Jia Shi 
2890a19e61eSDong Jia Shi #define ccw_is_idal(_ccw) ((_ccw)->flags & CCW_FLAG_IDA)
2900a19e61eSDong Jia Shi 
2910a19e61eSDong Jia Shi 
2920a19e61eSDong Jia Shi #define ccw_is_chain(_ccw) ((_ccw)->flags & (CCW_FLAG_CC | CCW_FLAG_DC))
2930a19e61eSDong Jia Shi 
2940a19e61eSDong Jia Shi static struct ccwchain *ccwchain_alloc(struct channel_program *cp, int len)
2950a19e61eSDong Jia Shi {
2960a19e61eSDong Jia Shi 	struct ccwchain *chain;
2970a19e61eSDong Jia Shi 	void *data;
2980a19e61eSDong Jia Shi 	size_t size;
2990a19e61eSDong Jia Shi 
3000a19e61eSDong Jia Shi 	/* Make ccw address aligned to 8. */
3010a19e61eSDong Jia Shi 	size = ((sizeof(*chain) + 7L) & -8L) +
3020a19e61eSDong Jia Shi 		sizeof(*chain->ch_ccw) * len +
3030a19e61eSDong Jia Shi 		sizeof(*chain->ch_pat) * len;
3040a19e61eSDong Jia Shi 	chain = kzalloc(size, GFP_DMA | GFP_KERNEL);
3050a19e61eSDong Jia Shi 	if (!chain)
3060a19e61eSDong Jia Shi 		return NULL;
3070a19e61eSDong Jia Shi 
3080a19e61eSDong Jia Shi 	data = (u8 *)chain + ((sizeof(*chain) + 7L) & -8L);
3090a19e61eSDong Jia Shi 	chain->ch_ccw = (struct ccw1 *)data;
3100a19e61eSDong Jia Shi 
3110a19e61eSDong Jia Shi 	data = (u8 *)(chain->ch_ccw) + sizeof(*chain->ch_ccw) * len;
3120a19e61eSDong Jia Shi 	chain->ch_pat = (struct pfn_array_table *)data;
3130a19e61eSDong Jia Shi 
3140a19e61eSDong Jia Shi 	chain->ch_len = len;
3150a19e61eSDong Jia Shi 
3160a19e61eSDong Jia Shi 	list_add_tail(&chain->next, &cp->ccwchain_list);
3170a19e61eSDong Jia Shi 
3180a19e61eSDong Jia Shi 	return chain;
3190a19e61eSDong Jia Shi }
3200a19e61eSDong Jia Shi 
3210a19e61eSDong Jia Shi static void ccwchain_free(struct ccwchain *chain)
3220a19e61eSDong Jia Shi {
3230a19e61eSDong Jia Shi 	list_del(&chain->next);
3240a19e61eSDong Jia Shi 	kfree(chain);
3250a19e61eSDong Jia Shi }
3260a19e61eSDong Jia Shi 
3270a19e61eSDong Jia Shi /* Free resource for a ccw that allocated memory for its cda. */
3280a19e61eSDong Jia Shi static void ccwchain_cda_free(struct ccwchain *chain, int idx)
3290a19e61eSDong Jia Shi {
3300a19e61eSDong Jia Shi 	struct ccw1 *ccw = chain->ch_ccw + idx;
3310a19e61eSDong Jia Shi 
3320a19e61eSDong Jia Shi 	if (!ccw->count)
3330a19e61eSDong Jia Shi 		return;
3340a19e61eSDong Jia Shi 
3350a19e61eSDong Jia Shi 	kfree((void *)(u64)ccw->cda);
3360a19e61eSDong Jia Shi }
3370a19e61eSDong Jia Shi 
3380a19e61eSDong Jia Shi /* Unpin the pages then free the memory resources. */
3390a19e61eSDong Jia Shi static void cp_unpin_free(struct channel_program *cp)
3400a19e61eSDong Jia Shi {
3410a19e61eSDong Jia Shi 	struct ccwchain *chain, *temp;
3420a19e61eSDong Jia Shi 	int i;
3430a19e61eSDong Jia Shi 
3440a19e61eSDong Jia Shi 	list_for_each_entry_safe(chain, temp, &cp->ccwchain_list, next) {
3450a19e61eSDong Jia Shi 		for (i = 0; i < chain->ch_len; i++) {
3460a19e61eSDong Jia Shi 			pfn_array_table_unpin_free(chain->ch_pat + i,
3470a19e61eSDong Jia Shi 						   cp->mdev);
3480a19e61eSDong Jia Shi 			ccwchain_cda_free(chain, i);
3490a19e61eSDong Jia Shi 		}
3500a19e61eSDong Jia Shi 		ccwchain_free(chain);
3510a19e61eSDong Jia Shi 	}
3520a19e61eSDong Jia Shi }
3530a19e61eSDong Jia Shi 
3540a19e61eSDong Jia Shi /**
3550a19e61eSDong Jia Shi  * ccwchain_calc_length - calculate the length of the ccw chain.
3560a19e61eSDong Jia Shi  * @iova: guest physical address of the target ccw chain
3570a19e61eSDong Jia Shi  * @cp: channel_program on which to perform the operation
3580a19e61eSDong Jia Shi  *
3590a19e61eSDong Jia Shi  * This is the chain length not considering any TICs.
3600a19e61eSDong Jia Shi  * You need to do a new round for each TIC target.
3610a19e61eSDong Jia Shi  *
3620a19e61eSDong Jia Shi  * Returns: the length of the ccw chain or -errno.
3630a19e61eSDong Jia Shi  */
3640a19e61eSDong Jia Shi static int ccwchain_calc_length(u64 iova, struct channel_program *cp)
3650a19e61eSDong Jia Shi {
3660a19e61eSDong Jia Shi 	struct ccw1 *ccw, *p;
3670a19e61eSDong Jia Shi 	int cnt;
3680a19e61eSDong Jia Shi 
3690a19e61eSDong Jia Shi 	/*
3700a19e61eSDong Jia Shi 	 * Copy current chain from guest to host kernel.
3710a19e61eSDong Jia Shi 	 * Currently the chain length is limited to CCWCHAIN_LEN_MAX (256).
3720a19e61eSDong Jia Shi 	 * So copying 2K is enough (safe).
3730a19e61eSDong Jia Shi 	 */
3740a19e61eSDong Jia Shi 	p = ccw = kcalloc(CCWCHAIN_LEN_MAX, sizeof(*ccw), GFP_KERNEL);
3750a19e61eSDong Jia Shi 	if (!ccw)
3760a19e61eSDong Jia Shi 		return -ENOMEM;
3770a19e61eSDong Jia Shi 
3780a19e61eSDong Jia Shi 	cnt = copy_ccw_from_iova(cp, ccw, iova, CCWCHAIN_LEN_MAX);
3790a19e61eSDong Jia Shi 	if (cnt) {
3800a19e61eSDong Jia Shi 		kfree(ccw);
3810a19e61eSDong Jia Shi 		return cnt;
3820a19e61eSDong Jia Shi 	}
3830a19e61eSDong Jia Shi 
3840a19e61eSDong Jia Shi 	cnt = 0;
3850a19e61eSDong Jia Shi 	do {
3860a19e61eSDong Jia Shi 		cnt++;
3870a19e61eSDong Jia Shi 
3880a19e61eSDong Jia Shi 		if ((!ccw_is_chain(ccw)) && (!ccw_is_tic(ccw)))
3890a19e61eSDong Jia Shi 			break;
3900a19e61eSDong Jia Shi 
3910a19e61eSDong Jia Shi 		ccw++;
3920a19e61eSDong Jia Shi 	} while (cnt < CCWCHAIN_LEN_MAX + 1);
3930a19e61eSDong Jia Shi 
3940a19e61eSDong Jia Shi 	if (cnt == CCWCHAIN_LEN_MAX + 1)
3950a19e61eSDong Jia Shi 		cnt = -EINVAL;
3960a19e61eSDong Jia Shi 
3970a19e61eSDong Jia Shi 	kfree(p);
3980a19e61eSDong Jia Shi 	return cnt;
3990a19e61eSDong Jia Shi }
4000a19e61eSDong Jia Shi 
4010a19e61eSDong Jia Shi static int tic_target_chain_exists(struct ccw1 *tic, struct channel_program *cp)
4020a19e61eSDong Jia Shi {
4030a19e61eSDong Jia Shi 	struct ccwchain *chain;
4040a19e61eSDong Jia Shi 	u32 ccw_head, ccw_tail;
4050a19e61eSDong Jia Shi 
4060a19e61eSDong Jia Shi 	list_for_each_entry(chain, &cp->ccwchain_list, next) {
4070a19e61eSDong Jia Shi 		ccw_head = chain->ch_iova;
4080a19e61eSDong Jia Shi 		ccw_tail = ccw_head + (chain->ch_len - 1) * sizeof(struct ccw1);
4090a19e61eSDong Jia Shi 
4100a19e61eSDong Jia Shi 		if ((ccw_head <= tic->cda) && (tic->cda <= ccw_tail))
4110a19e61eSDong Jia Shi 			return 1;
4120a19e61eSDong Jia Shi 	}
4130a19e61eSDong Jia Shi 
4140a19e61eSDong Jia Shi 	return 0;
4150a19e61eSDong Jia Shi }
4160a19e61eSDong Jia Shi 
4170a19e61eSDong Jia Shi static int ccwchain_loop_tic(struct ccwchain *chain,
4180a19e61eSDong Jia Shi 			     struct channel_program *cp);
4190a19e61eSDong Jia Shi 
4200a19e61eSDong Jia Shi static int ccwchain_handle_tic(struct ccw1 *tic, struct channel_program *cp)
4210a19e61eSDong Jia Shi {
4220a19e61eSDong Jia Shi 	struct ccwchain *chain;
4230a19e61eSDong Jia Shi 	int len, ret;
4240a19e61eSDong Jia Shi 
4250a19e61eSDong Jia Shi 	/* May transfer to an existing chain. */
4260a19e61eSDong Jia Shi 	if (tic_target_chain_exists(tic, cp))
4270a19e61eSDong Jia Shi 		return 0;
4280a19e61eSDong Jia Shi 
4290a19e61eSDong Jia Shi 	/* Get chain length. */
4300a19e61eSDong Jia Shi 	len = ccwchain_calc_length(tic->cda, cp);
4310a19e61eSDong Jia Shi 	if (len < 0)
4320a19e61eSDong Jia Shi 		return len;
4330a19e61eSDong Jia Shi 
4340a19e61eSDong Jia Shi 	/* Need alloc a new chain for this one. */
4350a19e61eSDong Jia Shi 	chain = ccwchain_alloc(cp, len);
4360a19e61eSDong Jia Shi 	if (!chain)
4370a19e61eSDong Jia Shi 		return -ENOMEM;
4380a19e61eSDong Jia Shi 	chain->ch_iova = tic->cda;
4390a19e61eSDong Jia Shi 
4400a19e61eSDong Jia Shi 	/* Copy the new chain from user. */
4410a19e61eSDong Jia Shi 	ret = copy_ccw_from_iova(cp, chain->ch_ccw, tic->cda, len);
4420a19e61eSDong Jia Shi 	if (ret) {
4430a19e61eSDong Jia Shi 		ccwchain_free(chain);
4440a19e61eSDong Jia Shi 		return ret;
4450a19e61eSDong Jia Shi 	}
4460a19e61eSDong Jia Shi 
4470a19e61eSDong Jia Shi 	/* Loop for tics on this new chain. */
4480a19e61eSDong Jia Shi 	return ccwchain_loop_tic(chain, cp);
4490a19e61eSDong Jia Shi }
4500a19e61eSDong Jia Shi 
4510a19e61eSDong Jia Shi /* Loop for TICs. */
4520a19e61eSDong Jia Shi static int ccwchain_loop_tic(struct ccwchain *chain, struct channel_program *cp)
4530a19e61eSDong Jia Shi {
4540a19e61eSDong Jia Shi 	struct ccw1 *tic;
4550a19e61eSDong Jia Shi 	int i, ret;
4560a19e61eSDong Jia Shi 
4570a19e61eSDong Jia Shi 	for (i = 0; i < chain->ch_len; i++) {
4580a19e61eSDong Jia Shi 		tic = chain->ch_ccw + i;
4590a19e61eSDong Jia Shi 
4600a19e61eSDong Jia Shi 		if (!ccw_is_tic(tic))
4610a19e61eSDong Jia Shi 			continue;
4620a19e61eSDong Jia Shi 
4630a19e61eSDong Jia Shi 		ret = ccwchain_handle_tic(tic, cp);
4640a19e61eSDong Jia Shi 		if (ret)
4650a19e61eSDong Jia Shi 			return ret;
4660a19e61eSDong Jia Shi 	}
4670a19e61eSDong Jia Shi 
4680a19e61eSDong Jia Shi 	return 0;
4690a19e61eSDong Jia Shi }
4700a19e61eSDong Jia Shi 
4710a19e61eSDong Jia Shi static int ccwchain_fetch_tic(struct ccwchain *chain,
4720a19e61eSDong Jia Shi 			      int idx,
4730a19e61eSDong Jia Shi 			      struct channel_program *cp)
4740a19e61eSDong Jia Shi {
4750a19e61eSDong Jia Shi 	struct ccw1 *ccw = chain->ch_ccw + idx;
4760a19e61eSDong Jia Shi 	struct ccwchain *iter;
4770a19e61eSDong Jia Shi 	u32 ccw_head, ccw_tail;
4780a19e61eSDong Jia Shi 
4790a19e61eSDong Jia Shi 	list_for_each_entry(iter, &cp->ccwchain_list, next) {
4800a19e61eSDong Jia Shi 		ccw_head = iter->ch_iova;
4810a19e61eSDong Jia Shi 		ccw_tail = ccw_head + (iter->ch_len - 1) * sizeof(struct ccw1);
4820a19e61eSDong Jia Shi 
4830a19e61eSDong Jia Shi 		if ((ccw_head <= ccw->cda) && (ccw->cda <= ccw_tail)) {
484*c389377cSJason J. Herne 			ccw->cda = (__u32) (addr_t) (((char *)iter->ch_ccw) +
4850a19e61eSDong Jia Shi 						     (ccw->cda - ccw_head));
4860a19e61eSDong Jia Shi 			return 0;
4870a19e61eSDong Jia Shi 		}
4880a19e61eSDong Jia Shi 	}
4890a19e61eSDong Jia Shi 
4900a19e61eSDong Jia Shi 	return -EFAULT;
4910a19e61eSDong Jia Shi }
4920a19e61eSDong Jia Shi 
4930a19e61eSDong Jia Shi static int ccwchain_fetch_direct(struct ccwchain *chain,
4940a19e61eSDong Jia Shi 				 int idx,
4950a19e61eSDong Jia Shi 				 struct channel_program *cp)
4960a19e61eSDong Jia Shi {
4970a19e61eSDong Jia Shi 	struct ccw1 *ccw;
4980a19e61eSDong Jia Shi 	struct pfn_array_table *pat;
4990a19e61eSDong Jia Shi 	unsigned long *idaws;
5000a19e61eSDong Jia Shi 	int idaw_nr;
5010a19e61eSDong Jia Shi 
5020a19e61eSDong Jia Shi 	ccw = chain->ch_ccw + idx;
5030a19e61eSDong Jia Shi 
5040a19e61eSDong Jia Shi 	/*
5050a19e61eSDong Jia Shi 	 * Pin data page(s) in memory.
5060a19e61eSDong Jia Shi 	 * The number of pages actually is the count of the idaws which will be
5070a19e61eSDong Jia Shi 	 * needed when translating a direct ccw to a idal ccw.
5080a19e61eSDong Jia Shi 	 */
5090a19e61eSDong Jia Shi 	pat = chain->ch_pat + idx;
5100a19e61eSDong Jia Shi 	if (pfn_array_table_init(pat, 1))
5110a19e61eSDong Jia Shi 		return -ENOMEM;
5120a19e61eSDong Jia Shi 	idaw_nr = pfn_array_alloc_pin(pat->pat_pa, cp->mdev,
5130a19e61eSDong Jia Shi 				      ccw->cda, ccw->count);
5140a19e61eSDong Jia Shi 	if (idaw_nr < 0)
5150a19e61eSDong Jia Shi 		return idaw_nr;
5160a19e61eSDong Jia Shi 
5170a19e61eSDong Jia Shi 	/* Translate this direct ccw to a idal ccw. */
5180a19e61eSDong Jia Shi 	idaws = kcalloc(idaw_nr, sizeof(*idaws), GFP_DMA | GFP_KERNEL);
5190a19e61eSDong Jia Shi 	if (!idaws) {
5200a19e61eSDong Jia Shi 		pfn_array_table_unpin_free(pat, cp->mdev);
5210a19e61eSDong Jia Shi 		return -ENOMEM;
5220a19e61eSDong Jia Shi 	}
5230a19e61eSDong Jia Shi 	ccw->cda = (__u32) virt_to_phys(idaws);
5240a19e61eSDong Jia Shi 	ccw->flags |= CCW_FLAG_IDA;
5250a19e61eSDong Jia Shi 
5260a19e61eSDong Jia Shi 	pfn_array_table_idal_create_words(pat, idaws);
5270a19e61eSDong Jia Shi 
5280a19e61eSDong Jia Shi 	return 0;
5290a19e61eSDong Jia Shi }
5300a19e61eSDong Jia Shi 
5310a19e61eSDong Jia Shi static int ccwchain_fetch_idal(struct ccwchain *chain,
5320a19e61eSDong Jia Shi 			       int idx,
5330a19e61eSDong Jia Shi 			       struct channel_program *cp)
5340a19e61eSDong Jia Shi {
5350a19e61eSDong Jia Shi 	struct ccw1 *ccw;
5360a19e61eSDong Jia Shi 	struct pfn_array_table *pat;
5370a19e61eSDong Jia Shi 	unsigned long *idaws;
5380a19e61eSDong Jia Shi 	u64 idaw_iova;
5390a19e61eSDong Jia Shi 	unsigned int idaw_nr, idaw_len;
5400a19e61eSDong Jia Shi 	int i, ret;
5410a19e61eSDong Jia Shi 
5420a19e61eSDong Jia Shi 	ccw = chain->ch_ccw + idx;
5430a19e61eSDong Jia Shi 
5440a19e61eSDong Jia Shi 	/* Calculate size of idaws. */
5450a19e61eSDong Jia Shi 	ret = copy_from_iova(cp->mdev, &idaw_iova, ccw->cda, sizeof(idaw_iova));
5460a19e61eSDong Jia Shi 	if (ret)
5470a19e61eSDong Jia Shi 		return ret;
5480a19e61eSDong Jia Shi 	idaw_nr = idal_nr_words((void *)(idaw_iova), ccw->count);
5490a19e61eSDong Jia Shi 	idaw_len = idaw_nr * sizeof(*idaws);
5500a19e61eSDong Jia Shi 
5510a19e61eSDong Jia Shi 	/* Pin data page(s) in memory. */
5520a19e61eSDong Jia Shi 	pat = chain->ch_pat + idx;
5530a19e61eSDong Jia Shi 	ret = pfn_array_table_init(pat, idaw_nr);
5540a19e61eSDong Jia Shi 	if (ret)
5550a19e61eSDong Jia Shi 		return ret;
5560a19e61eSDong Jia Shi 
5570a19e61eSDong Jia Shi 	/* Translate idal ccw to use new allocated idaws. */
5580a19e61eSDong Jia Shi 	idaws = kzalloc(idaw_len, GFP_DMA | GFP_KERNEL);
5590a19e61eSDong Jia Shi 	if (!idaws) {
5600a19e61eSDong Jia Shi 		ret = -ENOMEM;
5610a19e61eSDong Jia Shi 		goto out_unpin;
5620a19e61eSDong Jia Shi 	}
5630a19e61eSDong Jia Shi 
5640a19e61eSDong Jia Shi 	ret = copy_from_iova(cp->mdev, idaws, ccw->cda, idaw_len);
5650a19e61eSDong Jia Shi 	if (ret)
5660a19e61eSDong Jia Shi 		goto out_free_idaws;
5670a19e61eSDong Jia Shi 
5680a19e61eSDong Jia Shi 	ccw->cda = virt_to_phys(idaws);
5690a19e61eSDong Jia Shi 
5700a19e61eSDong Jia Shi 	for (i = 0; i < idaw_nr; i++) {
5710a19e61eSDong Jia Shi 		idaw_iova = *(idaws + i);
5720a19e61eSDong Jia Shi 		if (IS_ERR_VALUE(idaw_iova)) {
5730a19e61eSDong Jia Shi 			ret = -EFAULT;
5740a19e61eSDong Jia Shi 			goto out_free_idaws;
5750a19e61eSDong Jia Shi 		}
5760a19e61eSDong Jia Shi 
5770a19e61eSDong Jia Shi 		ret = pfn_array_alloc_pin(pat->pat_pa + i, cp->mdev,
5780a19e61eSDong Jia Shi 					  idaw_iova, 1);
5790a19e61eSDong Jia Shi 		if (ret < 0)
5800a19e61eSDong Jia Shi 			goto out_free_idaws;
5810a19e61eSDong Jia Shi 	}
5820a19e61eSDong Jia Shi 
5830a19e61eSDong Jia Shi 	pfn_array_table_idal_create_words(pat, idaws);
5840a19e61eSDong Jia Shi 
5850a19e61eSDong Jia Shi 	return 0;
5860a19e61eSDong Jia Shi 
5870a19e61eSDong Jia Shi out_free_idaws:
5880a19e61eSDong Jia Shi 	kfree(idaws);
5890a19e61eSDong Jia Shi out_unpin:
5900a19e61eSDong Jia Shi 	pfn_array_table_unpin_free(pat, cp->mdev);
5910a19e61eSDong Jia Shi 	return ret;
5920a19e61eSDong Jia Shi }
5930a19e61eSDong Jia Shi 
5940a19e61eSDong Jia Shi /*
5950a19e61eSDong Jia Shi  * Fetch one ccw.
5960a19e61eSDong Jia Shi  * To reduce memory copy, we'll pin the cda page in memory,
5970a19e61eSDong Jia Shi  * and to get rid of the cda 2G limitiaion of ccw1, we'll translate
5980a19e61eSDong Jia Shi  * direct ccws to idal ccws.
5990a19e61eSDong Jia Shi  */
6000a19e61eSDong Jia Shi static int ccwchain_fetch_one(struct ccwchain *chain,
6010a19e61eSDong Jia Shi 			      int idx,
6020a19e61eSDong Jia Shi 			      struct channel_program *cp)
6030a19e61eSDong Jia Shi {
6040a19e61eSDong Jia Shi 	struct ccw1 *ccw = chain->ch_ccw + idx;
6050a19e61eSDong Jia Shi 
6060a19e61eSDong Jia Shi 	if (ccw_is_test(ccw) || ccw_is_noop(ccw))
6070a19e61eSDong Jia Shi 		return 0;
6080a19e61eSDong Jia Shi 
6090a19e61eSDong Jia Shi 	if (ccw_is_tic(ccw))
6100a19e61eSDong Jia Shi 		return ccwchain_fetch_tic(chain, idx, cp);
6110a19e61eSDong Jia Shi 
6120a19e61eSDong Jia Shi 	if (ccw_is_idal(ccw))
6130a19e61eSDong Jia Shi 		return ccwchain_fetch_idal(chain, idx, cp);
6140a19e61eSDong Jia Shi 
6150a19e61eSDong Jia Shi 	return ccwchain_fetch_direct(chain, idx, cp);
6160a19e61eSDong Jia Shi }
6170a19e61eSDong Jia Shi 
6180a19e61eSDong Jia Shi /**
6190a19e61eSDong Jia Shi  * cp_init() - allocate ccwchains for a channel program.
6200a19e61eSDong Jia Shi  * @cp: channel_program on which to perform the operation
6210a19e61eSDong Jia Shi  * @mdev: the mediated device to perform pin/unpin operations
6220a19e61eSDong Jia Shi  * @orb: control block for the channel program from the guest
6230a19e61eSDong Jia Shi  *
6240a19e61eSDong Jia Shi  * This creates one or more ccwchain(s), and copies the raw data of
6250a19e61eSDong Jia Shi  * the target channel program from @orb->cmd.iova to the new ccwchain(s).
6260a19e61eSDong Jia Shi  *
6270a19e61eSDong Jia Shi  * Limitations:
6280a19e61eSDong Jia Shi  * 1. Supports only prefetch enabled mode.
6290a19e61eSDong Jia Shi  * 2. Supports idal(c64) ccw chaining.
6300a19e61eSDong Jia Shi  * 3. Supports 4k idaw.
6310a19e61eSDong Jia Shi  *
6320a19e61eSDong Jia Shi  * Returns:
6330a19e61eSDong Jia Shi  *   %0 on success and a negative error value on failure.
6340a19e61eSDong Jia Shi  */
6350a19e61eSDong Jia Shi int cp_init(struct channel_program *cp, struct device *mdev, union orb *orb)
6360a19e61eSDong Jia Shi {
6370a19e61eSDong Jia Shi 	u64 iova = orb->cmd.cpa;
6380a19e61eSDong Jia Shi 	struct ccwchain *chain;
6390a19e61eSDong Jia Shi 	int len, ret;
6400a19e61eSDong Jia Shi 
6410a19e61eSDong Jia Shi 	/*
6420a19e61eSDong Jia Shi 	 * XXX:
6430a19e61eSDong Jia Shi 	 * Only support prefetch enable mode now.
6440a19e61eSDong Jia Shi 	 * Only support 64bit addressing idal.
6450a19e61eSDong Jia Shi 	 * Only support 4k IDAW.
6460a19e61eSDong Jia Shi 	 */
647d686f21aSDong Jia Shi 	if (!orb->cmd.pfch || !orb->cmd.c64 || orb->cmd.i2k)
6480a19e61eSDong Jia Shi 		return -EOPNOTSUPP;
6490a19e61eSDong Jia Shi 
6500a19e61eSDong Jia Shi 	INIT_LIST_HEAD(&cp->ccwchain_list);
6510a19e61eSDong Jia Shi 	memcpy(&cp->orb, orb, sizeof(*orb));
6520a19e61eSDong Jia Shi 	cp->mdev = mdev;
6530a19e61eSDong Jia Shi 
6540a19e61eSDong Jia Shi 	/* Get chain length. */
6550a19e61eSDong Jia Shi 	len = ccwchain_calc_length(iova, cp);
6560a19e61eSDong Jia Shi 	if (len < 0)
6570a19e61eSDong Jia Shi 		return len;
6580a19e61eSDong Jia Shi 
6590a19e61eSDong Jia Shi 	/* Alloc mem for the head chain. */
6600a19e61eSDong Jia Shi 	chain = ccwchain_alloc(cp, len);
6610a19e61eSDong Jia Shi 	if (!chain)
6620a19e61eSDong Jia Shi 		return -ENOMEM;
6630a19e61eSDong Jia Shi 	chain->ch_iova = iova;
6640a19e61eSDong Jia Shi 
6650a19e61eSDong Jia Shi 	/* Copy the head chain from guest. */
6660a19e61eSDong Jia Shi 	ret = copy_ccw_from_iova(cp, chain->ch_ccw, iova, len);
6670a19e61eSDong Jia Shi 	if (ret) {
6680a19e61eSDong Jia Shi 		ccwchain_free(chain);
6690a19e61eSDong Jia Shi 		return ret;
6700a19e61eSDong Jia Shi 	}
6710a19e61eSDong Jia Shi 
6720a19e61eSDong Jia Shi 	/* Now loop for its TICs. */
6730a19e61eSDong Jia Shi 	ret = ccwchain_loop_tic(chain, cp);
6740a19e61eSDong Jia Shi 	if (ret)
6750a19e61eSDong Jia Shi 		cp_unpin_free(cp);
6760a19e61eSDong Jia Shi 
6770a19e61eSDong Jia Shi 	return ret;
6780a19e61eSDong Jia Shi }
6790a19e61eSDong Jia Shi 
6800a19e61eSDong Jia Shi 
6810a19e61eSDong Jia Shi /**
6820a19e61eSDong Jia Shi  * cp_free() - free resources for channel program.
6830a19e61eSDong Jia Shi  * @cp: channel_program on which to perform the operation
6840a19e61eSDong Jia Shi  *
6850a19e61eSDong Jia Shi  * This unpins the memory pages and frees the memory space occupied by
6860a19e61eSDong Jia Shi  * @cp, which must have been returned by a previous call to cp_init().
6870a19e61eSDong Jia Shi  * Otherwise, undefined behavior occurs.
6880a19e61eSDong Jia Shi  */
6890a19e61eSDong Jia Shi void cp_free(struct channel_program *cp)
6900a19e61eSDong Jia Shi {
6910a19e61eSDong Jia Shi 	cp_unpin_free(cp);
6920a19e61eSDong Jia Shi }
6930a19e61eSDong Jia Shi 
6940a19e61eSDong Jia Shi /**
6950a19e61eSDong Jia Shi  * cp_prefetch() - translate a guest physical address channel program to
6960a19e61eSDong Jia Shi  *                 a real-device runnable channel program.
6970a19e61eSDong Jia Shi  * @cp: channel_program on which to perform the operation
6980a19e61eSDong Jia Shi  *
6990a19e61eSDong Jia Shi  * This function translates the guest-physical-address channel program
7000a19e61eSDong Jia Shi  * and stores the result to ccwchain list. @cp must have been
7010a19e61eSDong Jia Shi  * initialized by a previous call with cp_init(). Otherwise, undefined
7020a19e61eSDong Jia Shi  * behavior occurs.
7030a19e61eSDong Jia Shi  *
7040a19e61eSDong Jia Shi  * The S/390 CCW Translation APIS (prefixed by 'cp_') are introduced
7050a19e61eSDong Jia Shi  * as helpers to do ccw chain translation inside the kernel. Basically
7060a19e61eSDong Jia Shi  * they accept a channel program issued by a virtual machine, and
7070a19e61eSDong Jia Shi  * translate the channel program to a real-device runnable channel
7080a19e61eSDong Jia Shi  * program.
7090a19e61eSDong Jia Shi  *
7100a19e61eSDong Jia Shi  * These APIs will copy the ccws into kernel-space buffers, and update
7110a19e61eSDong Jia Shi  * the guest phsical addresses with their corresponding host physical
7120a19e61eSDong Jia Shi  * addresses.  Then channel I/O device drivers could issue the
7130a19e61eSDong Jia Shi  * translated channel program to real devices to perform an I/O
7140a19e61eSDong Jia Shi  * operation.
7150a19e61eSDong Jia Shi  *
7160a19e61eSDong Jia Shi  * These interfaces are designed to support translation only for
7170a19e61eSDong Jia Shi  * channel programs, which are generated and formatted by a
7180a19e61eSDong Jia Shi  * guest. Thus this will make it possible for things like VFIO to
7190a19e61eSDong Jia Shi  * leverage the interfaces to passthrough a channel I/O mediated
7200a19e61eSDong Jia Shi  * device in QEMU.
7210a19e61eSDong Jia Shi  *
7220a19e61eSDong Jia Shi  * We support direct ccw chaining by translating them to idal ccws.
7230a19e61eSDong Jia Shi  *
7240a19e61eSDong Jia Shi  * Returns:
7250a19e61eSDong Jia Shi  *   %0 on success and a negative error value on failure.
7260a19e61eSDong Jia Shi  */
7270a19e61eSDong Jia Shi int cp_prefetch(struct channel_program *cp)
7280a19e61eSDong Jia Shi {
7290a19e61eSDong Jia Shi 	struct ccwchain *chain;
7300a19e61eSDong Jia Shi 	int len, idx, ret;
7310a19e61eSDong Jia Shi 
7320a19e61eSDong Jia Shi 	list_for_each_entry(chain, &cp->ccwchain_list, next) {
7330a19e61eSDong Jia Shi 		len = chain->ch_len;
7340a19e61eSDong Jia Shi 		for (idx = 0; idx < len; idx++) {
7350a19e61eSDong Jia Shi 			ret = ccwchain_fetch_one(chain, idx, cp);
7360a19e61eSDong Jia Shi 			if (ret)
7370a19e61eSDong Jia Shi 				return ret;
7380a19e61eSDong Jia Shi 		}
7390a19e61eSDong Jia Shi 	}
7400a19e61eSDong Jia Shi 
7410a19e61eSDong Jia Shi 	return 0;
7420a19e61eSDong Jia Shi }
7430a19e61eSDong Jia Shi 
7440a19e61eSDong Jia Shi /**
7450a19e61eSDong Jia Shi  * cp_get_orb() - get the orb of the channel program
7460a19e61eSDong Jia Shi  * @cp: channel_program on which to perform the operation
7470a19e61eSDong Jia Shi  * @intparm: new intparm for the returned orb
7480a19e61eSDong Jia Shi  * @lpm: candidate value of the logical-path mask for the returned orb
7490a19e61eSDong Jia Shi  *
7500a19e61eSDong Jia Shi  * This function returns the address of the updated orb of the channel
7510a19e61eSDong Jia Shi  * program. Channel I/O device drivers could use this orb to issue a
7520a19e61eSDong Jia Shi  * ssch.
7530a19e61eSDong Jia Shi  */
7540a19e61eSDong Jia Shi union orb *cp_get_orb(struct channel_program *cp, u32 intparm, u8 lpm)
7550a19e61eSDong Jia Shi {
7560a19e61eSDong Jia Shi 	union orb *orb;
7570a19e61eSDong Jia Shi 	struct ccwchain *chain;
7580a19e61eSDong Jia Shi 	struct ccw1 *cpa;
7590a19e61eSDong Jia Shi 
7600a19e61eSDong Jia Shi 	orb = &cp->orb;
7610a19e61eSDong Jia Shi 
7620a19e61eSDong Jia Shi 	orb->cmd.intparm = intparm;
7630a19e61eSDong Jia Shi 	orb->cmd.fmt = 1;
7640a19e61eSDong Jia Shi 	orb->cmd.key = PAGE_DEFAULT_KEY >> 4;
7650a19e61eSDong Jia Shi 
7660a19e61eSDong Jia Shi 	if (orb->cmd.lpm == 0)
7670a19e61eSDong Jia Shi 		orb->cmd.lpm = lpm;
7680a19e61eSDong Jia Shi 
7690a19e61eSDong Jia Shi 	chain = list_first_entry(&cp->ccwchain_list, struct ccwchain, next);
7700a19e61eSDong Jia Shi 	cpa = chain->ch_ccw;
7710a19e61eSDong Jia Shi 	orb->cmd.cpa = (__u32) __pa(cpa);
7720a19e61eSDong Jia Shi 
7730a19e61eSDong Jia Shi 	return orb;
7740a19e61eSDong Jia Shi }
7750a19e61eSDong Jia Shi 
7760a19e61eSDong Jia Shi /**
7770a19e61eSDong Jia Shi  * cp_update_scsw() - update scsw for a channel program.
7780a19e61eSDong Jia Shi  * @cp: channel_program on which to perform the operation
7790a19e61eSDong Jia Shi  * @scsw: I/O results of the channel program and also the target to be
7800a19e61eSDong Jia Shi  *        updated
7810a19e61eSDong Jia Shi  *
7820a19e61eSDong Jia Shi  * @scsw contains the I/O results of the channel program that pointed
7830a19e61eSDong Jia Shi  * to by @cp. However what @scsw->cpa stores is a host physical
7840a19e61eSDong Jia Shi  * address, which is meaningless for the guest, which is waiting for
7850a19e61eSDong Jia Shi  * the I/O results.
7860a19e61eSDong Jia Shi  *
7870a19e61eSDong Jia Shi  * This function updates @scsw->cpa to its coressponding guest physical
7880a19e61eSDong Jia Shi  * address.
7890a19e61eSDong Jia Shi  */
7900a19e61eSDong Jia Shi void cp_update_scsw(struct channel_program *cp, union scsw *scsw)
7910a19e61eSDong Jia Shi {
7920a19e61eSDong Jia Shi 	struct ccwchain *chain;
7930a19e61eSDong Jia Shi 	u32 cpa = scsw->cmd.cpa;
7940a19e61eSDong Jia Shi 	u32 ccw_head, ccw_tail;
7950a19e61eSDong Jia Shi 
7960a19e61eSDong Jia Shi 	/*
7970a19e61eSDong Jia Shi 	 * LATER:
7980a19e61eSDong Jia Shi 	 * For now, only update the cmd.cpa part. We may need to deal with
7990a19e61eSDong Jia Shi 	 * other portions of the schib as well, even if we don't return them
8000a19e61eSDong Jia Shi 	 * in the ioctl directly. Path status changes etc.
8010a19e61eSDong Jia Shi 	 */
8020a19e61eSDong Jia Shi 	list_for_each_entry(chain, &cp->ccwchain_list, next) {
8030a19e61eSDong Jia Shi 		ccw_head = (u32)(u64)chain->ch_ccw;
8040a19e61eSDong Jia Shi 		ccw_tail = (u32)(u64)(chain->ch_ccw + chain->ch_len - 1);
8050a19e61eSDong Jia Shi 
8060a19e61eSDong Jia Shi 		if ((ccw_head <= cpa) && (cpa <= ccw_tail)) {
8070a19e61eSDong Jia Shi 			/*
8080a19e61eSDong Jia Shi 			 * (cpa - ccw_head) is the offset value of the host
8090a19e61eSDong Jia Shi 			 * physical ccw to its chain head.
8100a19e61eSDong Jia Shi 			 * Adding this value to the guest physical ccw chain
8110a19e61eSDong Jia Shi 			 * head gets us the guest cpa.
8120a19e61eSDong Jia Shi 			 */
8130a19e61eSDong Jia Shi 			cpa = chain->ch_iova + (cpa - ccw_head);
8140a19e61eSDong Jia Shi 			break;
8150a19e61eSDong Jia Shi 		}
8160a19e61eSDong Jia Shi 	}
8170a19e61eSDong Jia Shi 
8180a19e61eSDong Jia Shi 	scsw->cmd.cpa = cpa;
8190a19e61eSDong Jia Shi }
8200a19e61eSDong Jia Shi 
8210a19e61eSDong Jia Shi /**
8220a19e61eSDong Jia Shi  * cp_iova_pinned() - check if an iova is pinned for a ccw chain.
8230a19e61eSDong Jia Shi  * @cmd: ccwchain command on which to perform the operation
8240a19e61eSDong Jia Shi  * @iova: the iova to check
8250a19e61eSDong Jia Shi  *
8260a19e61eSDong Jia Shi  * If the @iova is currently pinned for the ccw chain, return true;
8270a19e61eSDong Jia Shi  * else return false.
8280a19e61eSDong Jia Shi  */
8290a19e61eSDong Jia Shi bool cp_iova_pinned(struct channel_program *cp, u64 iova)
8300a19e61eSDong Jia Shi {
8310a19e61eSDong Jia Shi 	struct ccwchain *chain;
8320a19e61eSDong Jia Shi 	int i;
8330a19e61eSDong Jia Shi 
8340a19e61eSDong Jia Shi 	list_for_each_entry(chain, &cp->ccwchain_list, next) {
8350a19e61eSDong Jia Shi 		for (i = 0; i < chain->ch_len; i++)
8360a19e61eSDong Jia Shi 			if (pfn_array_table_iova_pinned(chain->ch_pat + i,
8370a19e61eSDong Jia Shi 							iova))
8380a19e61eSDong Jia Shi 				return true;
8390a19e61eSDong Jia Shi 	}
8400a19e61eSDong Jia Shi 
8410a19e61eSDong Jia Shi 	return false;
8420a19e61eSDong Jia Shi }
843