xref: /OK3568_Linux_fs/kernel/drivers/s390/cio/vfio_ccw_cp.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * channel program interfaces
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright IBM Corp. 2017
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Author(s): Dong Jia Shi <bjsdjshi@linux.vnet.ibm.com>
8*4882a593Smuzhiyun  *            Xiao Feng Ren <renxiaof@linux.vnet.ibm.com>
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef _VFIO_CCW_CP_H_
12*4882a593Smuzhiyun #define _VFIO_CCW_CP_H_
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <asm/cio.h>
15*4882a593Smuzhiyun #include <asm/scsw.h>
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #include "orb.h"
18*4882a593Smuzhiyun #include "vfio_ccw_trace.h"
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun /*
21*4882a593Smuzhiyun  * Max length for ccw chain.
22*4882a593Smuzhiyun  * XXX: Limit to 256, need to check more?
23*4882a593Smuzhiyun  */
24*4882a593Smuzhiyun #define CCWCHAIN_LEN_MAX	256
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun /**
27*4882a593Smuzhiyun  * struct channel_program - manage information for channel program
28*4882a593Smuzhiyun  * @ccwchain_list: list head of ccwchains
29*4882a593Smuzhiyun  * @orb: orb for the currently processed ssch request
30*4882a593Smuzhiyun  * @mdev: the mediated device to perform page pinning/unpinning
31*4882a593Smuzhiyun  * @initialized: whether this instance is actually initialized
32*4882a593Smuzhiyun  *
33*4882a593Smuzhiyun  * @ccwchain_list is the head of a ccwchain list, that contents the
34*4882a593Smuzhiyun  * translated result of the guest channel program that pointed out by
35*4882a593Smuzhiyun  * the iova parameter when calling cp_init.
36*4882a593Smuzhiyun  */
37*4882a593Smuzhiyun struct channel_program {
38*4882a593Smuzhiyun 	struct list_head ccwchain_list;
39*4882a593Smuzhiyun 	union orb orb;
40*4882a593Smuzhiyun 	struct device *mdev;
41*4882a593Smuzhiyun 	bool initialized;
42*4882a593Smuzhiyun 	struct ccw1 *guest_cp;
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun extern int cp_init(struct channel_program *cp, struct device *mdev,
46*4882a593Smuzhiyun 		   union orb *orb);
47*4882a593Smuzhiyun extern void cp_free(struct channel_program *cp);
48*4882a593Smuzhiyun extern int cp_prefetch(struct channel_program *cp);
49*4882a593Smuzhiyun extern union orb *cp_get_orb(struct channel_program *cp, u32 intparm, u8 lpm);
50*4882a593Smuzhiyun extern void cp_update_scsw(struct channel_program *cp, union scsw *scsw);
51*4882a593Smuzhiyun extern bool cp_iova_pinned(struct channel_program *cp, u64 iova);
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun #endif
54