1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Private stuff for vfio_ccw driver
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright IBM Corp. 2017
6*4882a593Smuzhiyun * Copyright Red Hat, Inc. 2019
7*4882a593Smuzhiyun *
8*4882a593Smuzhiyun * Author(s): Dong Jia Shi <bjsdjshi@linux.vnet.ibm.com>
9*4882a593Smuzhiyun * Xiao Feng Ren <renxiaof@linux.vnet.ibm.com>
10*4882a593Smuzhiyun * Cornelia Huck <cohuck@redhat.com>
11*4882a593Smuzhiyun */
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun #ifndef _VFIO_CCW_PRIVATE_H_
14*4882a593Smuzhiyun #define _VFIO_CCW_PRIVATE_H_
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun #include <linux/completion.h>
17*4882a593Smuzhiyun #include <linux/eventfd.h>
18*4882a593Smuzhiyun #include <linux/workqueue.h>
19*4882a593Smuzhiyun #include <linux/vfio_ccw.h>
20*4882a593Smuzhiyun #include <asm/crw.h>
21*4882a593Smuzhiyun #include <asm/debug.h>
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun #include "css.h"
24*4882a593Smuzhiyun #include "vfio_ccw_cp.h"
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun #define VFIO_CCW_OFFSET_SHIFT 10
27*4882a593Smuzhiyun #define VFIO_CCW_OFFSET_TO_INDEX(off) (off >> VFIO_CCW_OFFSET_SHIFT)
28*4882a593Smuzhiyun #define VFIO_CCW_INDEX_TO_OFFSET(index) ((u64)(index) << VFIO_CCW_OFFSET_SHIFT)
29*4882a593Smuzhiyun #define VFIO_CCW_OFFSET_MASK (((u64)(1) << VFIO_CCW_OFFSET_SHIFT) - 1)
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun /* capability chain handling similar to vfio-pci */
32*4882a593Smuzhiyun struct vfio_ccw_private;
33*4882a593Smuzhiyun struct vfio_ccw_region;
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun struct vfio_ccw_regops {
36*4882a593Smuzhiyun ssize_t (*read)(struct vfio_ccw_private *private, char __user *buf,
37*4882a593Smuzhiyun size_t count, loff_t *ppos);
38*4882a593Smuzhiyun ssize_t (*write)(struct vfio_ccw_private *private,
39*4882a593Smuzhiyun const char __user *buf, size_t count, loff_t *ppos);
40*4882a593Smuzhiyun void (*release)(struct vfio_ccw_private *private,
41*4882a593Smuzhiyun struct vfio_ccw_region *region);
42*4882a593Smuzhiyun };
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun struct vfio_ccw_region {
45*4882a593Smuzhiyun u32 type;
46*4882a593Smuzhiyun u32 subtype;
47*4882a593Smuzhiyun const struct vfio_ccw_regops *ops;
48*4882a593Smuzhiyun void *data;
49*4882a593Smuzhiyun size_t size;
50*4882a593Smuzhiyun u32 flags;
51*4882a593Smuzhiyun };
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun int vfio_ccw_register_dev_region(struct vfio_ccw_private *private,
54*4882a593Smuzhiyun unsigned int subtype,
55*4882a593Smuzhiyun const struct vfio_ccw_regops *ops,
56*4882a593Smuzhiyun size_t size, u32 flags, void *data);
57*4882a593Smuzhiyun void vfio_ccw_unregister_dev_regions(struct vfio_ccw_private *private);
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun int vfio_ccw_register_async_dev_regions(struct vfio_ccw_private *private);
60*4882a593Smuzhiyun int vfio_ccw_register_schib_dev_regions(struct vfio_ccw_private *private);
61*4882a593Smuzhiyun int vfio_ccw_register_crw_dev_regions(struct vfio_ccw_private *private);
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun struct vfio_ccw_crw {
64*4882a593Smuzhiyun struct list_head next;
65*4882a593Smuzhiyun struct crw crw;
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun /**
69*4882a593Smuzhiyun * struct vfio_ccw_private
70*4882a593Smuzhiyun * @sch: pointer to the subchannel
71*4882a593Smuzhiyun * @state: internal state of the device
72*4882a593Smuzhiyun * @completion: synchronization helper of the I/O completion
73*4882a593Smuzhiyun * @avail: available for creating a mediated device
74*4882a593Smuzhiyun * @mdev: pointer to the mediated device
75*4882a593Smuzhiyun * @nb: notifier for vfio events
76*4882a593Smuzhiyun * @io_region: MMIO region to input/output I/O arguments/results
77*4882a593Smuzhiyun * @io_mutex: protect against concurrent update of I/O regions
78*4882a593Smuzhiyun * @region: additional regions for other subchannel operations
79*4882a593Smuzhiyun * @cmd_region: MMIO region for asynchronous I/O commands other than START
80*4882a593Smuzhiyun * @schib_region: MMIO region for SCHIB information
81*4882a593Smuzhiyun * @crw_region: MMIO region for getting channel report words
82*4882a593Smuzhiyun * @num_regions: number of additional regions
83*4882a593Smuzhiyun * @cp: channel program for the current I/O operation
84*4882a593Smuzhiyun * @irb: irb info received from interrupt
85*4882a593Smuzhiyun * @scsw: scsw info
86*4882a593Smuzhiyun * @io_trigger: eventfd ctx for signaling userspace I/O results
87*4882a593Smuzhiyun * @io_work: work for deferral process of I/O handling
88*4882a593Smuzhiyun */
89*4882a593Smuzhiyun struct vfio_ccw_private {
90*4882a593Smuzhiyun struct subchannel *sch;
91*4882a593Smuzhiyun int state;
92*4882a593Smuzhiyun struct completion *completion;
93*4882a593Smuzhiyun atomic_t avail;
94*4882a593Smuzhiyun struct mdev_device *mdev;
95*4882a593Smuzhiyun struct notifier_block nb;
96*4882a593Smuzhiyun struct ccw_io_region *io_region;
97*4882a593Smuzhiyun struct mutex io_mutex;
98*4882a593Smuzhiyun struct vfio_ccw_region *region;
99*4882a593Smuzhiyun struct ccw_cmd_region *cmd_region;
100*4882a593Smuzhiyun struct ccw_schib_region *schib_region;
101*4882a593Smuzhiyun struct ccw_crw_region *crw_region;
102*4882a593Smuzhiyun int num_regions;
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun struct channel_program cp;
105*4882a593Smuzhiyun struct irb irb;
106*4882a593Smuzhiyun union scsw scsw;
107*4882a593Smuzhiyun struct list_head crw;
108*4882a593Smuzhiyun
109*4882a593Smuzhiyun struct eventfd_ctx *io_trigger;
110*4882a593Smuzhiyun struct eventfd_ctx *crw_trigger;
111*4882a593Smuzhiyun struct work_struct io_work;
112*4882a593Smuzhiyun struct work_struct crw_work;
113*4882a593Smuzhiyun } __aligned(8);
114*4882a593Smuzhiyun
115*4882a593Smuzhiyun extern int vfio_ccw_mdev_reg(struct subchannel *sch);
116*4882a593Smuzhiyun extern void vfio_ccw_mdev_unreg(struct subchannel *sch);
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun extern int vfio_ccw_sch_quiesce(struct subchannel *sch);
119*4882a593Smuzhiyun
120*4882a593Smuzhiyun /*
121*4882a593Smuzhiyun * States of the device statemachine.
122*4882a593Smuzhiyun */
123*4882a593Smuzhiyun enum vfio_ccw_state {
124*4882a593Smuzhiyun VFIO_CCW_STATE_NOT_OPER,
125*4882a593Smuzhiyun VFIO_CCW_STATE_STANDBY,
126*4882a593Smuzhiyun VFIO_CCW_STATE_IDLE,
127*4882a593Smuzhiyun VFIO_CCW_STATE_CP_PROCESSING,
128*4882a593Smuzhiyun VFIO_CCW_STATE_CP_PENDING,
129*4882a593Smuzhiyun /* last element! */
130*4882a593Smuzhiyun NR_VFIO_CCW_STATES
131*4882a593Smuzhiyun };
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun /*
134*4882a593Smuzhiyun * Asynchronous events of the device statemachine.
135*4882a593Smuzhiyun */
136*4882a593Smuzhiyun enum vfio_ccw_event {
137*4882a593Smuzhiyun VFIO_CCW_EVENT_NOT_OPER,
138*4882a593Smuzhiyun VFIO_CCW_EVENT_IO_REQ,
139*4882a593Smuzhiyun VFIO_CCW_EVENT_INTERRUPT,
140*4882a593Smuzhiyun VFIO_CCW_EVENT_ASYNC_REQ,
141*4882a593Smuzhiyun /* last element! */
142*4882a593Smuzhiyun NR_VFIO_CCW_EVENTS
143*4882a593Smuzhiyun };
144*4882a593Smuzhiyun
145*4882a593Smuzhiyun /*
146*4882a593Smuzhiyun * Action called through jumptable.
147*4882a593Smuzhiyun */
148*4882a593Smuzhiyun typedef void (fsm_func_t)(struct vfio_ccw_private *, enum vfio_ccw_event);
149*4882a593Smuzhiyun extern fsm_func_t *vfio_ccw_jumptable[NR_VFIO_CCW_STATES][NR_VFIO_CCW_EVENTS];
150*4882a593Smuzhiyun
vfio_ccw_fsm_event(struct vfio_ccw_private * private,int event)151*4882a593Smuzhiyun static inline void vfio_ccw_fsm_event(struct vfio_ccw_private *private,
152*4882a593Smuzhiyun int event)
153*4882a593Smuzhiyun {
154*4882a593Smuzhiyun trace_vfio_ccw_fsm_event(private->sch->schid, private->state, event);
155*4882a593Smuzhiyun vfio_ccw_jumptable[private->state][event](private, event);
156*4882a593Smuzhiyun }
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun extern struct workqueue_struct *vfio_ccw_work_q;
159*4882a593Smuzhiyun
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun /* s390 debug feature, similar to base cio */
162*4882a593Smuzhiyun extern debug_info_t *vfio_ccw_debug_msg_id;
163*4882a593Smuzhiyun extern debug_info_t *vfio_ccw_debug_trace_id;
164*4882a593Smuzhiyun
165*4882a593Smuzhiyun #define VFIO_CCW_TRACE_EVENT(imp, txt) \
166*4882a593Smuzhiyun debug_text_event(vfio_ccw_debug_trace_id, imp, txt)
167*4882a593Smuzhiyun
168*4882a593Smuzhiyun #define VFIO_CCW_MSG_EVENT(imp, args...) \
169*4882a593Smuzhiyun debug_sprintf_event(vfio_ccw_debug_msg_id, imp, ##args)
170*4882a593Smuzhiyun
VFIO_CCW_HEX_EVENT(int level,void * data,int length)171*4882a593Smuzhiyun static inline void VFIO_CCW_HEX_EVENT(int level, void *data, int length)
172*4882a593Smuzhiyun {
173*4882a593Smuzhiyun debug_event(vfio_ccw_debug_trace_id, level, data, length);
174*4882a593Smuzhiyun }
175*4882a593Smuzhiyun
176*4882a593Smuzhiyun #endif
177