xref: /openbmc/linux/drivers/s390/char/sclp.h (revision 66aec647)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright IBM Corp. 1999,2012
4  *
5  * Author(s): Martin Peschke <mpeschke@de.ibm.com>
6  *	      Martin Schwidefsky <schwidefsky@de.ibm.com>
7  */
8 
9 #ifndef __SCLP_H__
10 #define __SCLP_H__
11 
12 #include <linux/types.h>
13 #include <linux/list.h>
14 #include <asm/sclp.h>
15 #include <asm/ebcdic.h>
16 
17 /* maximum number of pages concerning our own memory management */
18 #define MAX_KMEM_PAGES (sizeof(unsigned long) << 3)
19 #define SCLP_CONSOLE_PAGES	6
20 
21 #define SCLP_EVTYP_MASK(T)	(1U << (32 - (T)))
22 
23 #define EVTYP_OPCMD		0x01
24 #define EVTYP_MSG		0x02
25 #define EVTYP_CONFMGMDATA	0x04
26 #define EVTYP_DIAG_TEST		0x07
27 #define EVTYP_STATECHANGE	0x08
28 #define EVTYP_PMSGCMD		0x09
29 #define EVTYP_ASYNC		0x0A
30 #define EVTYP_CTLPROGIDENT	0x0B
31 #define EVTYP_STORE_DATA	0x0C
32 #define EVTYP_ERRNOTIFY		0x18
33 #define EVTYP_VT220MSG		0x1A
34 #define EVTYP_SDIAS		0x1C
35 #define EVTYP_SIGQUIESCE	0x1D
36 #define EVTYP_OCF		0x1E
37 
38 #define EVTYP_OPCMD_MASK	SCLP_EVTYP_MASK(EVTYP_OPCMD)
39 #define EVTYP_MSG_MASK		SCLP_EVTYP_MASK(EVTYP_MSG)
40 #define EVTYP_CONFMGMDATA_MASK	SCLP_EVTYP_MASK(EVTYP_CONFMGMDATA)
41 #define EVTYP_DIAG_TEST_MASK	SCLP_EVTYP_MASK(EVTYP_DIAG_TEST)
42 #define EVTYP_STATECHANGE_MASK	SCLP_EVTYP_MASK(EVTYP_STATECHANGE)
43 #define EVTYP_PMSGCMD_MASK	SCLP_EVTYP_MASK(EVTYP_PMSGCMD)
44 #define EVTYP_ASYNC_MASK	SCLP_EVTYP_MASK(EVTYP_ASYNC)
45 #define EVTYP_CTLPROGIDENT_MASK	SCLP_EVTYP_MASK(EVTYP_CTLPROGIDENT)
46 #define EVTYP_STORE_DATA_MASK	SCLP_EVTYP_MASK(EVTYP_STORE_DATA)
47 #define EVTYP_ERRNOTIFY_MASK	SCLP_EVTYP_MASK(EVTYP_ERRNOTIFY)
48 #define EVTYP_VT220MSG_MASK	SCLP_EVTYP_MASK(EVTYP_VT220MSG)
49 #define EVTYP_SDIAS_MASK	SCLP_EVTYP_MASK(EVTYP_SDIAS)
50 #define EVTYP_SIGQUIESCE_MASK	SCLP_EVTYP_MASK(EVTYP_SIGQUIESCE)
51 #define EVTYP_OCF_MASK		SCLP_EVTYP_MASK(EVTYP_OCF)
52 
53 #define GNRLMSGFLGS_DOM		0x8000
54 #define GNRLMSGFLGS_SNDALRM	0x4000
55 #define GNRLMSGFLGS_HOLDMSG	0x2000
56 
57 #define LNTPFLGS_CNTLTEXT	0x8000
58 #define LNTPFLGS_LABELTEXT	0x4000
59 #define LNTPFLGS_DATATEXT	0x2000
60 #define LNTPFLGS_ENDTEXT	0x1000
61 #define LNTPFLGS_PROMPTTEXT	0x0800
62 
63 typedef unsigned int sclp_cmdw_t;
64 
65 #define SCLP_CMDW_READ_CPU_INFO		0x00010001
66 #define SCLP_CMDW_READ_EVENT_DATA	0x00770005
67 #define SCLP_CMDW_WRITE_EVENT_DATA	0x00760005
68 #define SCLP_CMDW_WRITE_EVENT_MASK	0x00780005
69 
70 #define GDS_ID_MDSMU		0x1310
71 #define GDS_ID_MDSROUTEINFO	0x1311
72 #define GDS_ID_AGUNWRKCORR	0x1549
73 #define GDS_ID_SNACONDREPORT	0x1532
74 #define GDS_ID_CPMSU		0x1212
75 #define GDS_ID_ROUTTARGINSTR	0x154D
76 #define GDS_ID_OPREQ		0x8070
77 #define GDS_ID_TEXTCMD		0x1320
78 
79 #define GDS_KEY_SELFDEFTEXTMSG	0x31
80 
81 enum sclp_pm_event {
82 	SCLP_PM_EVENT_FREEZE,
83 	SCLP_PM_EVENT_THAW,
84 	SCLP_PM_EVENT_RESTORE,
85 };
86 
87 #define SCLP_PANIC_PRIO		1
88 #define SCLP_PANIC_PRIO_CLIENT	0
89 
90 typedef u32 sccb_mask_t;	/* ATTENTION: assumes 32bit mask !!! */
91 
92 struct sccb_header {
93 	u16	length;
94 	u8	function_code;
95 	u8	control_mask[3];
96 	u16	response_code;
97 } __attribute__((packed));
98 
99 struct init_sccb {
100 	struct sccb_header header;
101 	u16 _reserved;
102 	u16 mask_length;
103 	sccb_mask_t receive_mask;
104 	sccb_mask_t send_mask;
105 	sccb_mask_t sclp_receive_mask;
106 	sccb_mask_t sclp_send_mask;
107 } __attribute__((packed));
108 
109 struct read_cpu_info_sccb {
110 	struct	sccb_header header;
111 	u16	nr_configured;
112 	u16	offset_configured;
113 	u16	nr_standby;
114 	u16	offset_standby;
115 	u8	reserved[4096 - 16];
116 } __attribute__((packed, aligned(PAGE_SIZE)));
117 
118 static inline void sclp_fill_core_info(struct sclp_core_info *info,
119 				       struct read_cpu_info_sccb *sccb)
120 {
121 	char *page = (char *) sccb;
122 
123 	memset(info, 0, sizeof(*info));
124 	info->configured = sccb->nr_configured;
125 	info->standby = sccb->nr_standby;
126 	info->combined = sccb->nr_configured + sccb->nr_standby;
127 	memcpy(&info->core, page + sccb->offset_configured,
128 	       info->combined * sizeof(struct sclp_core_entry));
129 }
130 
131 #define SCLP_HAS_CHP_INFO	(sclp.facilities & 0x8000000000000000ULL)
132 #define SCLP_HAS_CHP_RECONFIG	(sclp.facilities & 0x2000000000000000ULL)
133 #define SCLP_HAS_CPU_INFO	(sclp.facilities & 0x0800000000000000ULL)
134 #define SCLP_HAS_CPU_RECONFIG	(sclp.facilities & 0x0400000000000000ULL)
135 #define SCLP_HAS_PCI_RECONFIG	(sclp.facilities & 0x0000000040000000ULL)
136 
137 
138 struct gds_subvector {
139 	u8	length;
140 	u8	key;
141 } __attribute__((packed));
142 
143 struct gds_vector {
144 	u16	length;
145 	u16	gds_id;
146 } __attribute__((packed));
147 
148 struct evbuf_header {
149 	u16	length;
150 	u8	type;
151 	u8	flags;
152 	u16	_reserved;
153 } __attribute__((packed));
154 
155 struct sclp_req {
156 	struct list_head list;		/* list_head for request queueing. */
157 	sclp_cmdw_t command;		/* sclp command to execute */
158 	void	*sccb;			/* pointer to the sccb to execute */
159 	char	status;			/* status of this request */
160 	int     start_count;		/* number of SVCs done for this req */
161 	/* Callback that is called after reaching final status. */
162 	void (*callback)(struct sclp_req *, void *data);
163 	void *callback_data;
164 	int queue_timeout;		/* request queue timeout (sec), set by
165 					   caller of sclp_add_request(), if
166 					   needed */
167 	/* Internal fields */
168 	unsigned long queue_expires;	/* request queue timeout (jiffies) */
169 };
170 
171 #define SCLP_REQ_FILLED	  0x00	/* request is ready to be processed */
172 #define SCLP_REQ_QUEUED	  0x01	/* request is queued to be processed */
173 #define SCLP_REQ_RUNNING  0x02	/* request is currently running */
174 #define SCLP_REQ_DONE	  0x03	/* request is completed successfully */
175 #define SCLP_REQ_FAILED	  0x05	/* request is finally failed */
176 #define SCLP_REQ_QUEUED_TIMEOUT 0x06	/* request on queue timed out */
177 
178 #define SCLP_QUEUE_INTERVAL 5	/* timeout interval for request queue */
179 
180 /* function pointers that a high level driver has to use for registration */
181 /* of some routines it wants to be called from the low level driver */
182 struct sclp_register {
183 	struct list_head list;
184 	/* User wants to receive: */
185 	sccb_mask_t receive_mask;
186 	/* User wants to send: */
187 	sccb_mask_t send_mask;
188 	/* H/W can receive: */
189 	sccb_mask_t sclp_receive_mask;
190 	/* H/W can send: */
191 	sccb_mask_t sclp_send_mask;
192 	/* called if event type availability changes */
193 	void (*state_change_fn)(struct sclp_register *);
194 	/* called for events in cp_receive_mask/sclp_receive_mask */
195 	void (*receiver_fn)(struct evbuf_header *);
196 	/* called for power management events */
197 	void (*pm_event_fn)(struct sclp_register *, enum sclp_pm_event);
198 	/* pm event posted flag */
199 	int pm_event_posted;
200 };
201 
202 /* externals from sclp.c */
203 int sclp_add_request(struct sclp_req *req);
204 void sclp_sync_wait(void);
205 int sclp_register(struct sclp_register *reg);
206 void sclp_unregister(struct sclp_register *reg);
207 int sclp_remove_processed(struct sccb_header *sccb);
208 int sclp_deactivate(void);
209 int sclp_reactivate(void);
210 int sclp_sync_request(sclp_cmdw_t command, void *sccb);
211 int sclp_sync_request_timeout(sclp_cmdw_t command, void *sccb, int timeout);
212 
213 int sclp_sdias_init(void);
214 void sclp_sdias_exit(void);
215 
216 enum {
217 	sclp_init_state_uninitialized,
218 	sclp_init_state_initializing,
219 	sclp_init_state_initialized
220 };
221 
222 extern int sclp_init_state;
223 extern int sclp_console_pages;
224 extern int sclp_console_drop;
225 extern unsigned long sclp_console_full;
226 
227 extern char sclp_early_sccb[PAGE_SIZE];
228 
229 void sclp_early_wait_irq(void);
230 int sclp_early_cmd(sclp_cmdw_t cmd, void *sccb);
231 unsigned int sclp_early_con_check_linemode(struct init_sccb *sccb);
232 int sclp_early_set_event_mask(struct init_sccb *sccb,
233 			      unsigned long receive_mask,
234 			      unsigned long send_mask);
235 
236 /* useful inlines */
237 
238 /* Perform service call. Return 0 on success, non-zero otherwise. */
239 static inline int sclp_service_call(sclp_cmdw_t command, void *sccb)
240 {
241 	int cc = 4; /* Initialize for program check handling */
242 
243 	asm volatile(
244 		"0:	.insn	rre,0xb2200000,%1,%2\n"	 /* servc %1,%2 */
245 		"1:	ipm	%0\n"
246 		"	srl	%0,28\n"
247 		"2:\n"
248 		EX_TABLE(0b, 2b)
249 		EX_TABLE(1b, 2b)
250 		: "+&d" (cc) : "d" (command), "a" ((unsigned long)sccb)
251 		: "cc", "memory");
252 	if (cc == 4)
253 		return -EINVAL;
254 	if (cc == 3)
255 		return -EIO;
256 	if (cc == 2)
257 		return -EBUSY;
258 	return 0;
259 }
260 
261 /* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
262 /* translate single character from ASCII to EBCDIC */
263 static inline unsigned char
264 sclp_ascebc(unsigned char ch)
265 {
266 	return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
267 }
268 
269 /* translate string from EBCDIC to ASCII */
270 static inline void
271 sclp_ebcasc_str(unsigned char *str, int nr)
272 {
273 	(MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
274 }
275 
276 /* translate string from ASCII to EBCDIC */
277 static inline void
278 sclp_ascebc_str(unsigned char *str, int nr)
279 {
280 	(MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
281 }
282 
283 static inline struct gds_vector *
284 sclp_find_gds_vector(void *start, void *end, u16 id)
285 {
286 	struct gds_vector *v;
287 
288 	for (v = start; (void *) v < end; v = (void *) v + v->length)
289 		if (v->gds_id == id)
290 			return v;
291 	return NULL;
292 }
293 
294 static inline struct gds_subvector *
295 sclp_find_gds_subvector(void *start, void *end, u8 key)
296 {
297 	struct gds_subvector *sv;
298 
299 	for (sv = start; (void *) sv < end; sv = (void *) sv + sv->length)
300 		if (sv->key == key)
301 			return sv;
302 	return NULL;
303 }
304 
305 #endif	 /* __SCLP_H__ */
306