1/*
2 * Copyright IBM Corp. 1999,2012
3 *
4 * Author(s): Martin Peschke <mpeschke@de.ibm.com>
5 *	      Martin Schwidefsky <schwidefsky@de.ibm.com>
6 */
7
8#ifndef __SCLP_H__
9#define __SCLP_H__
10
11#include <linux/types.h>
12#include <linux/list.h>
13#include <asm/sclp.h>
14#include <asm/ebcdic.h>
15
16/* maximum number of pages concerning our own memory management */
17#define MAX_KMEM_PAGES (sizeof(unsigned long) << 3)
18#define SCLP_CONSOLE_PAGES	6
19
20#define EVTYP_OPCMD		0x01
21#define EVTYP_MSG		0x02
22#define EVTYP_DIAG_TEST		0x07
23#define EVTYP_STATECHANGE	0x08
24#define EVTYP_PMSGCMD		0x09
25#define EVTYP_CNTLPROGOPCMD	0x20
26#define EVTYP_CNTLPROGIDENT	0x0B
27#define EVTYP_SIGQUIESCE	0x1D
28#define EVTYP_VT220MSG		0x1A
29#define EVTYP_CONFMGMDATA	0x04
30#define EVTYP_SDIAS		0x1C
31#define EVTYP_ASYNC		0x0A
32#define EVTYP_OCF		0x1E
33
34#define EVTYP_OPCMD_MASK	0x80000000
35#define EVTYP_MSG_MASK		0x40000000
36#define EVTYP_DIAG_TEST_MASK	0x02000000
37#define EVTYP_STATECHANGE_MASK	0x01000000
38#define EVTYP_PMSGCMD_MASK	0x00800000
39#define EVTYP_CTLPROGOPCMD_MASK	0x00000001
40#define EVTYP_CTLPROGIDENT_MASK	0x00200000
41#define EVTYP_SIGQUIESCE_MASK	0x00000008
42#define EVTYP_VT220MSG_MASK	0x00000040
43#define EVTYP_CONFMGMDATA_MASK	0x10000000
44#define EVTYP_SDIAS_MASK	0x00000010
45#define EVTYP_ASYNC_MASK	0x00400000
46#define EVTYP_OCF_MASK		0x00000004
47
48#define GNRLMSGFLGS_DOM		0x8000
49#define GNRLMSGFLGS_SNDALRM	0x4000
50#define GNRLMSGFLGS_HOLDMSG	0x2000
51
52#define LNTPFLGS_CNTLTEXT	0x8000
53#define LNTPFLGS_LABELTEXT	0x4000
54#define LNTPFLGS_DATATEXT	0x2000
55#define LNTPFLGS_ENDTEXT	0x1000
56#define LNTPFLGS_PROMPTTEXT	0x0800
57
58typedef unsigned int sclp_cmdw_t;
59
60#define SCLP_CMDW_READ_EVENT_DATA	0x00770005
61#define SCLP_CMDW_WRITE_EVENT_DATA	0x00760005
62#define SCLP_CMDW_WRITE_EVENT_MASK	0x00780005
63
64#define GDS_ID_MDSMU		0x1310
65#define GDS_ID_MDSROUTEINFO	0x1311
66#define GDS_ID_AGUNWRKCORR	0x1549
67#define GDS_ID_SNACONDREPORT	0x1532
68#define GDS_ID_CPMSU		0x1212
69#define GDS_ID_ROUTTARGINSTR	0x154D
70#define GDS_ID_OPREQ		0x8070
71#define GDS_ID_TEXTCMD		0x1320
72
73#define GDS_KEY_SELFDEFTEXTMSG	0x31
74
75enum sclp_pm_event {
76	SCLP_PM_EVENT_FREEZE,
77	SCLP_PM_EVENT_THAW,
78	SCLP_PM_EVENT_RESTORE,
79};
80
81#define SCLP_PANIC_PRIO		1
82#define SCLP_PANIC_PRIO_CLIENT	0
83
84typedef u32 sccb_mask_t;	/* ATTENTION: assumes 32bit mask !!! */
85
86struct sccb_header {
87	u16	length;
88	u8	function_code;
89	u8	control_mask[3];
90	u16	response_code;
91} __attribute__((packed));
92
93struct init_sccb {
94	struct sccb_header header;
95	u16 _reserved;
96	u16 mask_length;
97	sccb_mask_t receive_mask;
98	sccb_mask_t send_mask;
99	sccb_mask_t sclp_receive_mask;
100	sccb_mask_t sclp_send_mask;
101} __attribute__((packed));
102
103#define SCLP_HAS_CHP_INFO	(sclp.facilities & 0x8000000000000000ULL)
104#define SCLP_HAS_CHP_RECONFIG	(sclp.facilities & 0x2000000000000000ULL)
105#define SCLP_HAS_CPU_INFO	(sclp.facilities & 0x0800000000000000ULL)
106#define SCLP_HAS_CPU_RECONFIG	(sclp.facilities & 0x0400000000000000ULL)
107#define SCLP_HAS_PCI_RECONFIG	(sclp.facilities & 0x0000000040000000ULL)
108
109
110struct gds_subvector {
111	u8	length;
112	u8	key;
113} __attribute__((packed));
114
115struct gds_vector {
116	u16	length;
117	u16	gds_id;
118} __attribute__((packed));
119
120struct evbuf_header {
121	u16	length;
122	u8	type;
123	u8	flags;
124	u16	_reserved;
125} __attribute__((packed));
126
127struct sclp_req {
128	struct list_head list;		/* list_head for request queueing. */
129	sclp_cmdw_t command;		/* sclp command to execute */
130	void	*sccb;			/* pointer to the sccb to execute */
131	char	status;			/* status of this request */
132	int     start_count;		/* number of SVCs done for this req */
133	/* Callback that is called after reaching final status. */
134	void (*callback)(struct sclp_req *, void *data);
135	void *callback_data;
136	int queue_timeout;		/* request queue timeout (sec), set by
137					   caller of sclp_add_request(), if
138					   needed */
139	/* Internal fields */
140	unsigned long queue_expires;	/* request queue timeout (jiffies) */
141};
142
143#define SCLP_REQ_FILLED	  0x00	/* request is ready to be processed */
144#define SCLP_REQ_QUEUED	  0x01	/* request is queued to be processed */
145#define SCLP_REQ_RUNNING  0x02	/* request is currently running */
146#define SCLP_REQ_DONE	  0x03	/* request is completed successfully */
147#define SCLP_REQ_FAILED	  0x05	/* request is finally failed */
148#define SCLP_REQ_QUEUED_TIMEOUT 0x06	/* request on queue timed out */
149
150#define SCLP_QUEUE_INTERVAL 5	/* timeout interval for request queue */
151
152/* function pointers that a high level driver has to use for registration */
153/* of some routines it wants to be called from the low level driver */
154struct sclp_register {
155	struct list_head list;
156	/* User wants to receive: */
157	sccb_mask_t receive_mask;
158	/* User wants to send: */
159	sccb_mask_t send_mask;
160	/* H/W can receive: */
161	sccb_mask_t sclp_receive_mask;
162	/* H/W can send: */
163	sccb_mask_t sclp_send_mask;
164	/* called if event type availability changes */
165	void (*state_change_fn)(struct sclp_register *);
166	/* called for events in cp_receive_mask/sclp_receive_mask */
167	void (*receiver_fn)(struct evbuf_header *);
168	/* called for power management events */
169	void (*pm_event_fn)(struct sclp_register *, enum sclp_pm_event);
170	/* pm event posted flag */
171	int pm_event_posted;
172};
173
174/* externals from sclp.c */
175int sclp_add_request(struct sclp_req *req);
176void sclp_sync_wait(void);
177int sclp_register(struct sclp_register *reg);
178void sclp_unregister(struct sclp_register *reg);
179int sclp_remove_processed(struct sccb_header *sccb);
180int sclp_deactivate(void);
181int sclp_reactivate(void);
182int sclp_service_call(sclp_cmdw_t command, void *sccb);
183int sclp_sync_request(sclp_cmdw_t command, void *sccb);
184int sclp_sync_request_timeout(sclp_cmdw_t command, void *sccb, int timeout);
185
186int sclp_sdias_init(void);
187void sclp_sdias_exit(void);
188
189extern int sclp_console_pages;
190extern int sclp_console_drop;
191extern unsigned long sclp_console_full;
192
193/* useful inlines */
194
195/* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
196/* translate single character from ASCII to EBCDIC */
197static inline unsigned char
198sclp_ascebc(unsigned char ch)
199{
200	return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
201}
202
203/* translate string from EBCDIC to ASCII */
204static inline void
205sclp_ebcasc_str(unsigned char *str, int nr)
206{
207	(MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
208}
209
210/* translate string from ASCII to EBCDIC */
211static inline void
212sclp_ascebc_str(unsigned char *str, int nr)
213{
214	(MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
215}
216
217static inline struct gds_vector *
218sclp_find_gds_vector(void *start, void *end, u16 id)
219{
220	struct gds_vector *v;
221
222	for (v = start; (void *) v < end; v = (void *) v + v->length)
223		if (v->gds_id == id)
224			return v;
225	return NULL;
226}
227
228static inline struct gds_subvector *
229sclp_find_gds_subvector(void *start, void *end, u8 key)
230{
231	struct gds_subvector *sv;
232
233	for (sv = start; (void *) sv < end; sv = (void *) sv + sv->length)
234		if (sv->key == key)
235			return sv;
236	return NULL;
237}
238
239#endif	 /* __SCLP_H__ */
240