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