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) (1UL << (sizeof(sccb_mask_t) * BITS_PER_BYTE - (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_SCP_INFO 0x00020001
67 #define SCLP_CMDW_READ_STORAGE_INFO 0x00040001
68 #define SCLP_CMDW_READ_SCP_INFO_FORCED 0x00120001
69 #define SCLP_CMDW_READ_EVENT_DATA 0x00770005
70 #define SCLP_CMDW_WRITE_EVENT_DATA 0x00760005
71 #define SCLP_CMDW_WRITE_EVENT_MASK 0x00780005
72
73 #define GDS_ID_MDSMU 0x1310
74 #define GDS_ID_MDSROUTEINFO 0x1311
75 #define GDS_ID_AGUNWRKCORR 0x1549
76 #define GDS_ID_SNACONDREPORT 0x1532
77 #define GDS_ID_CPMSU 0x1212
78 #define GDS_ID_ROUTTARGINSTR 0x154D
79 #define GDS_ID_OPREQ 0x8070
80 #define GDS_ID_TEXTCMD 0x1320
81
82 #define GDS_KEY_SELFDEFTEXTMSG 0x31
83
84 typedef u64 sccb_mask_t;
85
86 struct sccb_header {
87 u16 length;
88 u8 function_code;
89 u8 control_mask[3];
90 u16 response_code;
91 } __attribute__((packed));
92
93 struct init_sccb {
94 struct sccb_header header;
95 u16 _reserved;
96 u16 mask_length;
97 u8 masks[4 * 1021]; /* variable length */
98 /*
99 * u8 receive_mask[mask_length];
100 * u8 send_mask[mask_length];
101 * u8 sclp_receive_mask[mask_length];
102 * u8 sclp_send_mask[mask_length];
103 */
104 } __attribute__((packed));
105
106 #define SCLP_MASK_SIZE_COMPAT 4
107
sccb_get_mask(u8 * masks,size_t len,int i)108 static inline sccb_mask_t sccb_get_mask(u8 *masks, size_t len, int i)
109 {
110 sccb_mask_t res = 0;
111
112 memcpy(&res, masks + i * len, min(sizeof(res), len));
113 return res;
114 }
115
sccb_set_mask(u8 * masks,size_t len,int i,sccb_mask_t val)116 static inline void sccb_set_mask(u8 *masks, size_t len, int i, sccb_mask_t val)
117 {
118 memset(masks + i * len, 0, len);
119 memcpy(masks + i * len, &val, min(sizeof(val), len));
120 }
121
122 #define sccb_get_generic_mask(sccb, i) \
123 ({ \
124 __typeof__(sccb) __sccb = sccb; \
125 \
126 sccb_get_mask(__sccb->masks, __sccb->mask_length, i); \
127 })
128 #define sccb_get_recv_mask(sccb) sccb_get_generic_mask(sccb, 0)
129 #define sccb_get_send_mask(sccb) sccb_get_generic_mask(sccb, 1)
130 #define sccb_get_sclp_recv_mask(sccb) sccb_get_generic_mask(sccb, 2)
131 #define sccb_get_sclp_send_mask(sccb) sccb_get_generic_mask(sccb, 3)
132
133 #define sccb_set_generic_mask(sccb, i, val) \
134 ({ \
135 __typeof__(sccb) __sccb = sccb; \
136 \
137 sccb_set_mask(__sccb->masks, __sccb->mask_length, i, val); \
138 })
139 #define sccb_set_recv_mask(sccb, val) sccb_set_generic_mask(sccb, 0, val)
140 #define sccb_set_send_mask(sccb, val) sccb_set_generic_mask(sccb, 1, val)
141 #define sccb_set_sclp_recv_mask(sccb, val) sccb_set_generic_mask(sccb, 2, val)
142 #define sccb_set_sclp_send_mask(sccb, val) sccb_set_generic_mask(sccb, 3, val)
143
144 struct read_cpu_info_sccb {
145 struct sccb_header header;
146 u16 nr_configured;
147 u16 offset_configured;
148 u16 nr_standby;
149 u16 offset_standby;
150 /*
151 * Without ext sccb, struct size is PAGE_SIZE.
152 * With ext sccb, struct size is EXT_SCCB_READ_CPU.
153 */
154 u8 reserved[];
155 } __attribute__((packed, aligned(PAGE_SIZE)));
156
157 struct read_info_sccb {
158 struct sccb_header header; /* 0-7 */
159 u16 rnmax; /* 8-9 */
160 u8 rnsize; /* 10 */
161 u8 _pad_11[16 - 11]; /* 11-15 */
162 u16 ncpurl; /* 16-17 */
163 u16 cpuoff; /* 18-19 */
164 u8 _pad_20[24 - 20]; /* 20-23 */
165 u8 loadparm[8]; /* 24-31 */
166 u8 _pad_32[42 - 32]; /* 32-41 */
167 u8 fac42; /* 42 */
168 u8 fac43; /* 43 */
169 u8 _pad_44[48 - 44]; /* 44-47 */
170 u64 facilities; /* 48-55 */
171 u8 _pad_56[66 - 56]; /* 56-65 */
172 u8 fac66; /* 66 */
173 u8 _pad_67[76 - 67]; /* 67-83 */
174 u32 ibc; /* 76-79 */
175 u8 _pad80[84 - 80]; /* 80-83 */
176 u8 fac84; /* 84 */
177 u8 fac85; /* 85 */
178 u8 _pad_86[91 - 86]; /* 86-90 */
179 u8 fac91; /* 91 */
180 u8 _pad_92[98 - 92]; /* 92-97 */
181 u8 fac98; /* 98 */
182 u8 hamaxpow; /* 99 */
183 u32 rnsize2; /* 100-103 */
184 u64 rnmax2; /* 104-111 */
185 u32 hsa_size; /* 112-115 */
186 u8 fac116; /* 116 */
187 u8 fac117; /* 117 */
188 u8 fac118; /* 118 */
189 u8 fac119; /* 119 */
190 u16 hcpua; /* 120-121 */
191 u8 _pad_122[124 - 122]; /* 122-123 */
192 u32 hmfai; /* 124-127 */
193 u8 _pad_128[134 - 128]; /* 128-133 */
194 u8 byte_134; /* 134 */
195 u8 cpudirq; /* 135 */
196 u16 cbl; /* 136-137 */
197 u8 _pad_138[EXT_SCCB_READ_SCP - 138];
198 } __packed __aligned(PAGE_SIZE);
199
200 struct read_storage_sccb {
201 struct sccb_header header;
202 u16 max_id;
203 u16 assigned;
204 u16 standby;
205 u16 :16;
206 u32 entries[0];
207 } __packed;
208
sclp_fill_core_info(struct sclp_core_info * info,struct read_cpu_info_sccb * sccb)209 static inline void sclp_fill_core_info(struct sclp_core_info *info,
210 struct read_cpu_info_sccb *sccb)
211 {
212 char *page = (char *) sccb;
213
214 memset(info, 0, sizeof(*info));
215 info->configured = sccb->nr_configured;
216 info->standby = sccb->nr_standby;
217 info->combined = sccb->nr_configured + sccb->nr_standby;
218 memcpy(&info->core, page + sccb->offset_configured,
219 info->combined * sizeof(struct sclp_core_entry));
220 }
221
222 #define SCLP_HAS_CHP_INFO (sclp.facilities & 0x8000000000000000ULL)
223 #define SCLP_HAS_CHP_RECONFIG (sclp.facilities & 0x2000000000000000ULL)
224 #define SCLP_HAS_CPU_INFO (sclp.facilities & 0x0800000000000000ULL)
225 #define SCLP_HAS_CPU_RECONFIG (sclp.facilities & 0x0400000000000000ULL)
226 #define SCLP_HAS_PCI_RECONFIG (sclp.facilities & 0x0000000040000000ULL)
227 #define SCLP_HAS_AP_RECONFIG (sclp.facilities & 0x0000000100000000ULL)
228
229 struct gds_subvector {
230 u8 length;
231 u8 key;
232 } __attribute__((packed));
233
234 struct gds_vector {
235 u16 length;
236 u16 gds_id;
237 } __attribute__((packed));
238
239 struct evbuf_header {
240 u16 length;
241 u8 type;
242 u8 flags;
243 u16 _reserved;
244 } __attribute__((packed));
245
246 struct sclp_req {
247 struct list_head list; /* list_head for request queueing. */
248 sclp_cmdw_t command; /* sclp command to execute */
249 void *sccb; /* pointer to the sccb to execute */
250 char status; /* status of this request */
251 int start_count; /* number of SVCs done for this req */
252 /* Callback that is called after reaching final status. */
253 void (*callback)(struct sclp_req *, void *data);
254 void *callback_data;
255 int queue_timeout; /* request queue timeout (sec), set by
256 caller of sclp_add_request(), if
257 needed */
258 /* Internal fields */
259 unsigned long queue_expires; /* request queue timeout (jiffies) */
260 };
261
262 #define SCLP_REQ_FILLED 0x00 /* request is ready to be processed */
263 #define SCLP_REQ_QUEUED 0x01 /* request is queued to be processed */
264 #define SCLP_REQ_RUNNING 0x02 /* request is currently running */
265 #define SCLP_REQ_DONE 0x03 /* request is completed successfully */
266 #define SCLP_REQ_FAILED 0x05 /* request is finally failed */
267 #define SCLP_REQ_QUEUED_TIMEOUT 0x06 /* request on queue timed out */
268
269 #define SCLP_QUEUE_INTERVAL 5 /* timeout interval for request queue */
270
271 /* function pointers that a high level driver has to use for registration */
272 /* of some routines it wants to be called from the low level driver */
273 struct sclp_register {
274 struct list_head list;
275 /* User wants to receive: */
276 sccb_mask_t receive_mask;
277 /* User wants to send: */
278 sccb_mask_t send_mask;
279 /* H/W can receive: */
280 sccb_mask_t sclp_receive_mask;
281 /* H/W can send: */
282 sccb_mask_t sclp_send_mask;
283 /* called if event type availability changes */
284 void (*state_change_fn)(struct sclp_register *);
285 /* called for events in cp_receive_mask/sclp_receive_mask */
286 void (*receiver_fn)(struct evbuf_header *);
287 };
288
289 /* externals from sclp.c */
290 int sclp_add_request(struct sclp_req *req);
291 void sclp_sync_wait(void);
292 int sclp_register(struct sclp_register *reg);
293 void sclp_unregister(struct sclp_register *reg);
294 int sclp_remove_processed(struct sccb_header *sccb);
295 int sclp_deactivate(void);
296 int sclp_reactivate(void);
297 int sclp_sync_request(sclp_cmdw_t command, void *sccb);
298 int sclp_sync_request_timeout(sclp_cmdw_t command, void *sccb, int timeout);
299 int sclp_sdias_init(void);
300
301 enum {
302 sclp_init_state_uninitialized,
303 sclp_init_state_initializing,
304 sclp_init_state_initialized
305 };
306
307 extern int sclp_init_state;
308 extern int sclp_console_pages;
309 extern int sclp_console_drop;
310 extern unsigned long sclp_console_full;
311 extern bool sclp_mask_compat_mode;
312
313 void sclp_early_wait_irq(void);
314 int sclp_early_cmd(sclp_cmdw_t cmd, void *sccb);
315 unsigned int sclp_early_con_check_linemode(struct init_sccb *sccb);
316 unsigned int sclp_early_con_check_vt220(struct init_sccb *sccb);
317 int sclp_early_set_event_mask(struct init_sccb *sccb,
318 sccb_mask_t receive_mask,
319 sccb_mask_t send_mask);
320 struct read_info_sccb * __init sclp_early_get_info(void);
321
322 /* useful inlines */
323
324 /* Perform service call. Return 0 on success, non-zero otherwise. */
sclp_service_call(sclp_cmdw_t command,void * sccb)325 static inline int sclp_service_call(sclp_cmdw_t command, void *sccb)
326 {
327 int cc = 4; /* Initialize for program check handling */
328
329 asm volatile(
330 "0: .insn rre,0xb2200000,%1,%2\n" /* servc %1,%2 */
331 "1: ipm %0\n"
332 " srl %0,28\n"
333 "2:\n"
334 EX_TABLE(0b, 2b)
335 EX_TABLE(1b, 2b)
336 : "+&d" (cc) : "d" (command), "a" (__pa(sccb))
337 : "cc", "memory");
338 if (cc == 4)
339 return -EINVAL;
340 if (cc == 3)
341 return -EIO;
342 if (cc == 2)
343 return -EBUSY;
344 return 0;
345 }
346
347 /* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
348 /* translate single character from ASCII to EBCDIC */
349 static inline unsigned char
sclp_ascebc(unsigned char ch)350 sclp_ascebc(unsigned char ch)
351 {
352 return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
353 }
354
355 /* translate string from EBCDIC to ASCII */
356 static inline void
sclp_ebcasc_str(char * str,int nr)357 sclp_ebcasc_str(char *str, int nr)
358 {
359 (MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
360 }
361
362 /* translate string from ASCII to EBCDIC */
363 static inline void
sclp_ascebc_str(char * str,int nr)364 sclp_ascebc_str(char *str, int nr)
365 {
366 (MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
367 }
368
369 static inline struct gds_vector *
sclp_find_gds_vector(void * start,void * end,u16 id)370 sclp_find_gds_vector(void *start, void *end, u16 id)
371 {
372 struct gds_vector *v;
373
374 for (v = start; (void *) v < end; v = (void *) v + v->length)
375 if (v->gds_id == id)
376 return v;
377 return NULL;
378 }
379
380 static inline struct gds_subvector *
sclp_find_gds_subvector(void * start,void * end,u8 key)381 sclp_find_gds_subvector(void *start, void *end, u8 key)
382 {
383 struct gds_subvector *sv;
384
385 for (sv = start; (void *) sv < end; sv = (void *) sv + sv->length)
386 if (sv->key == key)
387 return sv;
388 return NULL;
389 }
390
391 #endif /* __SCLP_H__ */
392