xref: /openbmc/linux/drivers/s390/cio/cio.h (revision f3539c12)
1 #ifndef S390_CIO_H
2 #define S390_CIO_H
3 
4 #include <linux/mutex.h>
5 #include <linux/device.h>
6 #include <linux/mod_devicetable.h>
7 #include <asm/chpid.h>
8 #include <asm/cio.h>
9 #include <asm/fcx.h>
10 #include <asm/schid.h>
11 #include "chsc.h"
12 
13 /*
14  * path management control word
15  */
16 struct pmcw {
17 	u32 intparm;		/* interruption parameter */
18 	u32 qf	 : 1;		/* qdio facility */
19 	u32 w	 : 1;
20 	u32 isc  : 3;		/* interruption sublass */
21 	u32 res5 : 3;		/* reserved zeros */
22 	u32 ena  : 1;		/* enabled */
23 	u32 lm	 : 2;		/* limit mode */
24 	u32 mme  : 2;		/* measurement-mode enable */
25 	u32 mp	 : 1;		/* multipath mode */
26 	u32 tf	 : 1;		/* timing facility */
27 	u32 dnv  : 1;		/* device number valid */
28 	u32 dev  : 16;		/* device number */
29 	u8  lpm;		/* logical path mask */
30 	u8  pnom;		/* path not operational mask */
31 	u8  lpum;		/* last path used mask */
32 	u8  pim;		/* path installed mask */
33 	u16 mbi;		/* measurement-block index */
34 	u8  pom;		/* path operational mask */
35 	u8  pam;		/* path available mask */
36 	u8  chpid[8];		/* CHPID 0-7 (if available) */
37 	u32 unused1 : 8;	/* reserved zeros */
38 	u32 st	    : 3;	/* subchannel type */
39 	u32 unused2 : 18;	/* reserved zeros */
40 	u32 mbfc    : 1;	/* measurement block format control */
41 	u32 xmwme   : 1;	/* extended measurement word mode enable */
42 	u32 csense  : 1;	/* concurrent sense; can be enabled ...*/
43 				/*  ... per MSCH, however, if facility */
44 				/*  ... is not installed, this results */
45 				/*  ... in an operand exception.       */
46 } __attribute__ ((packed));
47 
48 /* I/O-Interruption Code as stored by TEST PENDING INTERRUPTION (TPI). */
49 struct tpi_info {
50 	struct subchannel_id schid;
51 	u32 intparm;
52 	u32 adapter_IO:1;
53 	u32 :1;
54 	u32 isc:3;
55 	u32 :27;
56 	u32 type:3;
57 	u32 :12;
58 } __packed __aligned(4);
59 
60 /* Target SCHIB configuration. */
61 struct schib_config {
62 	u64 mba;
63 	u32 intparm;
64 	u16 mbi;
65 	u32 isc:3;
66 	u32 ena:1;
67 	u32 mme:2;
68 	u32 mp:1;
69 	u32 csense:1;
70 	u32 mbfc:1;
71 } __attribute__ ((packed));
72 
73 /*
74  * subchannel information block
75  */
76 struct schib {
77 	struct pmcw pmcw;	 /* path management control word */
78 	union scsw scsw;	 /* subchannel status word */
79 	__u64 mba;               /* measurement block address */
80 	__u8 mda[4];		 /* model dependent area */
81 } __attribute__ ((packed,aligned(4)));
82 
83 /*
84  * When rescheduled, todo's with higher values will overwrite those
85  * with lower values.
86  */
87 enum sch_todo {
88 	SCH_TODO_NOTHING,
89 	SCH_TODO_EVAL,
90 	SCH_TODO_UNREG,
91 };
92 
93 /* subchannel data structure used by I/O subroutines */
94 struct subchannel {
95 	struct subchannel_id schid;
96 	spinlock_t *lock;	/* subchannel lock */
97 	struct mutex reg_mutex;
98 	enum {
99 		SUBCHANNEL_TYPE_IO = 0,
100 		SUBCHANNEL_TYPE_CHSC = 1,
101 		SUBCHANNEL_TYPE_MSG = 2,
102 		SUBCHANNEL_TYPE_ADM = 3,
103 	} st;			/* subchannel type */
104 	__u8 vpm;		/* verified path mask */
105 	__u8 lpm;		/* logical path mask */
106 	__u8 opm;               /* operational path mask */
107 	struct schib schib;	/* subchannel information block */
108 	int isc; /* desired interruption subclass */
109 	struct chsc_ssd_info ssd_info;	/* subchannel description */
110 	struct device dev;	/* entry in device tree */
111 	struct css_driver *driver;
112 	enum sch_todo todo;
113 	struct work_struct todo_work;
114 	struct schib_config config;
115 } __attribute__ ((aligned(8)));
116 
117 DECLARE_PER_CPU(struct irb, cio_irb);
118 
119 #define to_subchannel(n) container_of(n, struct subchannel, dev)
120 
121 extern int cio_validate_subchannel (struct subchannel *, struct subchannel_id);
122 extern int cio_enable_subchannel(struct subchannel *, u32);
123 extern int cio_disable_subchannel (struct subchannel *);
124 extern int cio_cancel (struct subchannel *);
125 extern int cio_clear (struct subchannel *);
126 extern int cio_resume (struct subchannel *);
127 extern int cio_halt (struct subchannel *);
128 extern int cio_start (struct subchannel *, struct ccw1 *, __u8);
129 extern int cio_start_key (struct subchannel *, struct ccw1 *, __u8, __u8);
130 extern int cio_cancel (struct subchannel *);
131 extern int cio_set_options (struct subchannel *, int);
132 extern int cio_update_schib(struct subchannel *sch);
133 extern int cio_commit_config(struct subchannel *sch);
134 
135 int cio_tm_start_key(struct subchannel *sch, struct tcw *tcw, u8 lpm, u8 key);
136 int cio_tm_intrg(struct subchannel *sch);
137 
138 /* Use with care. */
139 #ifdef CONFIG_CCW_CONSOLE
140 extern struct subchannel *cio_probe_console(void);
141 extern int cio_is_console(struct subchannel_id);
142 extern void cio_register_early_subchannels(void);
143 extern void cio_tsch(struct subchannel *sch);
144 #else
145 #define cio_is_console(schid) 0
146 static inline void cio_register_early_subchannels(void) {}
147 #endif
148 
149 #endif
150