xref: /openbmc/linux/drivers/s390/cio/cio.h (revision 64c70b1c)
1 #ifndef S390_CIO_H
2 #define S390_CIO_H
3 
4 #include <linux/mutex.h>
5 #include <linux/device.h>
6 #include <asm/chpid.h>
7 #include "chsc.h"
8 #include "schid.h"
9 
10 /*
11  * path management control word
12  */
13 struct pmcw {
14 	__u32 intparm;		/* interruption parameter */
15 	__u32 qf   : 1;		/* qdio facility */
16 	__u32 res0 : 1;		/* reserved zeros */
17 	__u32 isc  : 3;		/* interruption sublass */
18 	__u32 res5 : 3;		/* reserved zeros */
19 	__u32 ena  : 1;		/* enabled */
20 	__u32 lm   : 2;		/* limit mode */
21 	__u32 mme  : 2;		/* measurement-mode enable */
22 	__u32 mp   : 1;		/* multipath mode */
23 	__u32 tf   : 1;		/* timing facility */
24 	__u32 dnv  : 1;		/* device number valid */
25 	__u32 dev  : 16;	/* device number */
26 	__u8  lpm;		/* logical path mask */
27 	__u8  pnom;		/* path not operational mask */
28 	__u8  lpum;		/* last path used mask */
29 	__u8  pim;		/* path installed mask */
30 	__u16 mbi;		/* measurement-block index */
31 	__u8  pom;		/* path operational mask */
32 	__u8  pam;		/* path available mask */
33 	__u8  chpid[8];		/* CHPID 0-7 (if available) */
34 	__u32 unused1 : 8;	/* reserved zeros */
35 	__u32 st      : 3;	/* subchannel type */
36 	__u32 unused2 : 18;	/* reserved zeros */
37 	__u32 mbfc    : 1;      /* measurement block format control */
38 	__u32 xmwme   : 1;      /* extended measurement word mode enable */
39 	__u32 csense  : 1;	/* concurrent sense; can be enabled ...*/
40 				/*  ... per MSCH, however, if facility */
41 				/*  ... is not installed, this results */
42 				/*  ... in an operand exception.       */
43 } __attribute__ ((packed));
44 
45 /*
46  * subchannel information block
47  */
48 struct schib {
49 	struct pmcw pmcw;	 /* path management control word */
50 	struct scsw scsw;	 /* subchannel status word */
51 	__u64 mba;               /* measurement block address */
52 	__u8 mda[4];		 /* model dependent area */
53 } __attribute__ ((packed,aligned(4)));
54 
55 /*
56  * operation request block
57  */
58 struct orb {
59 	__u32 intparm;		/* interruption parameter */
60 	__u32 key  : 4; 	/* flags, like key, suspend control, etc. */
61 	__u32 spnd : 1; 	/* suspend control */
62 	__u32 res1 : 1; 	/* reserved */
63 	__u32 mod  : 1; 	/* modification control */
64 	__u32 sync : 1; 	/* synchronize control */
65 	__u32 fmt  : 1; 	/* format control */
66 	__u32 pfch : 1; 	/* prefetch control */
67 	__u32 isic : 1; 	/* initial-status-interruption control */
68 	__u32 alcc : 1; 	/* address-limit-checking control */
69 	__u32 ssic : 1; 	/* suppress-suspended-interr. control */
70 	__u32 res2 : 1; 	/* reserved */
71 	__u32 c64  : 1; 	/* IDAW/QDIO 64 bit control  */
72 	__u32 i2k  : 1; 	/* IDAW 2/4kB block size control */
73 	__u32 lpm  : 8; 	/* logical path mask */
74 	__u32 ils  : 1; 	/* incorrect length */
75 	__u32 zero : 6; 	/* reserved zeros */
76 	__u32 orbx : 1; 	/* ORB extension control */
77 	__u32 cpa;		/* channel program address */
78 }  __attribute__ ((packed,aligned(4)));
79 
80 /* subchannel data structure used by I/O subroutines */
81 struct subchannel {
82 	struct subchannel_id schid;
83 	spinlock_t *lock;	/* subchannel lock */
84 	struct mutex reg_mutex;
85 	enum {
86 		SUBCHANNEL_TYPE_IO = 0,
87 		SUBCHANNEL_TYPE_CHSC = 1,
88 		SUBCHANNEL_TYPE_MESSAGE = 2,
89 		SUBCHANNEL_TYPE_ADM = 3,
90 	} st;			/* subchannel type */
91 
92 	struct {
93 		unsigned int suspend:1; /* allow suspend */
94 		unsigned int prefetch:1;/* deny prefetch */
95 		unsigned int inter:1;   /* suppress intermediate interrupts */
96 	} __attribute__ ((packed)) options;
97 
98 	__u8 vpm;		/* verified path mask */
99 	__u8 lpm;		/* logical path mask */
100 	__u8 opm;               /* operational path mask */
101 	struct schib schib;	/* subchannel information block */
102 	struct orb orb;		/* operation request block */
103 	struct ccw1 sense_ccw;	/* static ccw for sense command */
104 	struct chsc_ssd_info ssd_info;	/* subchannel description */
105 	struct device dev;	/* entry in device tree */
106 	struct css_driver *driver;
107 } __attribute__ ((aligned(8)));
108 
109 #define IO_INTERRUPT_TYPE	   0 /* I/O interrupt type */
110 
111 #define to_subchannel(n) container_of(n, struct subchannel, dev)
112 
113 extern int cio_validate_subchannel (struct subchannel *, struct subchannel_id);
114 extern int cio_enable_subchannel (struct subchannel *, unsigned int);
115 extern int cio_disable_subchannel (struct subchannel *);
116 extern int cio_cancel (struct subchannel *);
117 extern int cio_clear (struct subchannel *);
118 extern int cio_resume (struct subchannel *);
119 extern int cio_halt (struct subchannel *);
120 extern int cio_start (struct subchannel *, struct ccw1 *, __u8);
121 extern int cio_start_key (struct subchannel *, struct ccw1 *, __u8, __u8);
122 extern int cio_cancel (struct subchannel *);
123 extern int cio_set_options (struct subchannel *, int);
124 extern int cio_get_options (struct subchannel *);
125 extern int cio_modify (struct subchannel *);
126 
127 int cio_create_sch_lock(struct subchannel *);
128 
129 /* Use with care. */
130 #ifdef CONFIG_CCW_CONSOLE
131 extern struct subchannel *cio_probe_console(void);
132 extern void cio_release_console(void);
133 extern int cio_is_console(struct subchannel_id);
134 extern struct subchannel *cio_get_console_subchannel(void);
135 extern spinlock_t * cio_get_console_lock(void);
136 #else
137 #define cio_is_console(schid) 0
138 #define cio_get_console_subchannel() NULL
139 #define cio_get_console_lock() NULL;
140 #endif
141 
142 extern int cio_show_msg;
143 
144 #endif
145