[deliverable/linux.git] / drivers / s390 / char / sclp.h

/*
 * Copyright IBM Corp. 1999,2012
 *
 * Author(s): Martin Peschke <mpeschke@de.ibm.com>
 *	      Martin Schwidefsky <schwidefsky@de.ibm.com>
 */

#ifndef __SCLP_H__
#define __SCLP_H__

#include <linux/types.h>
#include <linux/list.h>
#include <asm/sclp.h>
#include <asm/ebcdic.h>

/* maximum number of pages concerning our own memory management */
#define MAX_KMEM_PAGES (sizeof(unsigned long) << 3)
#define SCLP_CONSOLE_PAGES	6

#define EVTYP_OPCMD		0x01
#define EVTYP_MSG		0x02
#define EVTYP_STATECHANGE	0x08
#define EVTYP_PMSGCMD		0x09
#define EVTYP_CNTLPROGOPCMD	0x20
#define EVTYP_CNTLPROGIDENT	0x0B
#define EVTYP_SIGQUIESCE	0x1D
#define EVTYP_VT220MSG		0x1A
#define EVTYP_CONFMGMDATA	0x04
#define EVTYP_SDIAS		0x1C
#define EVTYP_ASYNC		0x0A
#define EVTYP_OCF		0x1E

#define EVTYP_OPCMD_MASK	0x80000000
#define EVTYP_MSG_MASK		0x40000000
#define EVTYP_STATECHANGE_MASK	0x01000000
#define EVTYP_PMSGCMD_MASK	0x00800000
#define EVTYP_CTLPROGOPCMD_MASK	0x00000001
#define EVTYP_CTLPROGIDENT_MASK	0x00200000
#define EVTYP_SIGQUIESCE_MASK	0x00000008
#define EVTYP_VT220MSG_MASK	0x00000040
#define EVTYP_CONFMGMDATA_MASK	0x10000000
#define EVTYP_SDIAS_MASK	0x00000010
#define EVTYP_ASYNC_MASK	0x00400000
#define EVTYP_OCF_MASK		0x00000004

#define GNRLMSGFLGS_DOM		0x8000
#define GNRLMSGFLGS_SNDALRM	0x4000
#define GNRLMSGFLGS_HOLDMSG	0x2000

#define LNTPFLGS_CNTLTEXT	0x8000
#define LNTPFLGS_LABELTEXT	0x4000
#define LNTPFLGS_DATATEXT	0x2000
#define LNTPFLGS_ENDTEXT	0x1000
#define LNTPFLGS_PROMPTTEXT	0x0800

typedef unsigned int sclp_cmdw_t;

#define SCLP_CMDW_READ_EVENT_DATA	0x00770005
#define SCLP_CMDW_WRITE_EVENT_DATA	0x00760005
#define SCLP_CMDW_WRITE_EVENT_MASK	0x00780005

#define GDS_ID_MDSMU		0x1310
#define GDS_ID_MDSROUTEINFO	0x1311
#define GDS_ID_AGUNWRKCORR	0x1549
#define GDS_ID_SNACONDREPORT	0x1532
#define GDS_ID_CPMSU		0x1212
#define GDS_ID_ROUTTARGINSTR	0x154D
#define GDS_ID_OPREQ		0x8070
#define GDS_ID_TEXTCMD		0x1320

#define GDS_KEY_SELFDEFTEXTMSG	0x31

enum sclp_pm_event {
	SCLP_PM_EVENT_FREEZE,
	SCLP_PM_EVENT_THAW,
	SCLP_PM_EVENT_RESTORE,
};

#define SCLP_PANIC_PRIO		1
#define SCLP_PANIC_PRIO_CLIENT	0

typedef u32 sccb_mask_t;	/* ATTENTION: assumes 32bit mask !!! */

struct sccb_header {
	u16	length;
	u8	function_code;
	u8	control_mask[3];
	u16	response_code;
} __attribute__((packed));

struct init_sccb {
	struct sccb_header header;
	u16 _reserved;
	u16 mask_length;
	sccb_mask_t receive_mask;
	sccb_mask_t send_mask;
	sccb_mask_t sclp_receive_mask;
	sccb_mask_t sclp_send_mask;
} __attribute__((packed));

extern u64 sclp_facilities;

#define SCLP_HAS_CHP_INFO	(sclp_facilities & 0x8000000000000000ULL)
#define SCLP_HAS_CHP_RECONFIG	(sclp_facilities & 0x2000000000000000ULL)
#define SCLP_HAS_CPU_INFO	(sclp_facilities & 0x0800000000000000ULL)
#define SCLP_HAS_CPU_RECONFIG	(sclp_facilities & 0x0400000000000000ULL)
#define SCLP_HAS_PCI_RECONFIG	(sclp_facilities & 0x0000000040000000ULL)


struct gds_subvector {
	u8	length;
	u8	key;
} __attribute__((packed));

struct gds_vector {
	u16	length;
	u16	gds_id;
} __attribute__((packed));

struct evbuf_header {
	u16	length;
	u8	type;
	u8	flags;
	u16	_reserved;
} __attribute__((packed));

struct sclp_req {
	struct list_head list;		/* list_head for request queueing. */
	sclp_cmdw_t command;		/* sclp command to execute */
	void	*sccb;			/* pointer to the sccb to execute */
	char	status;			/* status of this request */
	int     start_count;		/* number of SVCs done for this req */
	/* Callback that is called after reaching final status. */
	void (*callback)(struct sclp_req *, void *data);
	void *callback_data;
	int queue_timeout;		/* request queue timeout (sec), set by
					   caller of sclp_add_request(), if
					   needed */
	/* Internal fields */
	unsigned long queue_expires;	/* request queue timeout (jiffies) */
};

#define SCLP_REQ_FILLED	  0x00	/* request is ready to be processed */
#define SCLP_REQ_QUEUED	  0x01	/* request is queued to be processed */
#define SCLP_REQ_RUNNING  0x02	/* request is currently running */
#define SCLP_REQ_DONE	  0x03	/* request is completed successfully */
#define SCLP_REQ_FAILED	  0x05	/* request is finally failed */
#define SCLP_REQ_QUEUED_TIMEOUT 0x06	/* request on queue timed out */

#define SCLP_QUEUE_INTERVAL 5	/* timeout interval for request queue */

/* function pointers that a high level driver has to use for registration */
/* of some routines it wants to be called from the low level driver */
struct sclp_register {
	struct list_head list;
	/* User wants to receive: */
	sccb_mask_t receive_mask;
	/* User wants to send: */
	sccb_mask_t send_mask;
	/* H/W can receive: */
	sccb_mask_t sclp_receive_mask;
	/* H/W can send: */
	sccb_mask_t sclp_send_mask;
	/* called if event type availability changes */
	void (*state_change_fn)(struct sclp_register *);
	/* called for events in cp_receive_mask/sclp_receive_mask */
	void (*receiver_fn)(struct evbuf_header *);
	/* called for power management events */
	void (*pm_event_fn)(struct sclp_register *, enum sclp_pm_event);
	/* pm event posted flag */
	int pm_event_posted;
};

/* externals from sclp.c */
int sclp_add_request(struct sclp_req *req);
void sclp_sync_wait(void);
int sclp_register(struct sclp_register *reg);
void sclp_unregister(struct sclp_register *reg);
int sclp_remove_processed(struct sccb_header *sccb);
int sclp_deactivate(void);
int sclp_reactivate(void);
int sclp_service_call(sclp_cmdw_t command, void *sccb);
int sclp_sync_request(sclp_cmdw_t command, void *sccb);
int sclp_sync_request_timeout(sclp_cmdw_t command, void *sccb, int timeout);

int sclp_sdias_init(void);
void sclp_sdias_exit(void);

extern int sclp_console_pages;
extern int sclp_console_drop;
extern unsigned long sclp_console_full;
extern u8 sclp_fac84;
extern unsigned long long sclp_rzm;
extern unsigned long long sclp_rnmax;

/* useful inlines */

/* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
/* translate single character from ASCII to EBCDIC */
static inline unsigned char
sclp_ascebc(unsigned char ch)
{
	return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
}

/* translate string from EBCDIC to ASCII */
static inline void
sclp_ebcasc_str(unsigned char *str, int nr)
{
	(MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
}

/* translate string from ASCII to EBCDIC */
static inline void
sclp_ascebc_str(unsigned char *str, int nr)
{
	(MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
}

static inline struct gds_vector *
sclp_find_gds_vector(void *start, void *end, u16 id)
{
	struct gds_vector *v;

	for (v = start; (void *) v < end; v = (void *) v + v->length)
		if (v->gds_id == id)
			return v;
	return NULL;
}

static inline struct gds_subvector *
sclp_find_gds_subvector(void *start, void *end, u8 key)
{
	struct gds_subvector *sv;

	for (sv = start; (void *) sv < end; sv = (void *) sv + sv->length)
		if (sv->key == key)
			return sv;
	return NULL;
}

#endif	 /* __SCLP_H__ */
Commit	Line	Data
1da177e4	1	/*
7441b062	2	* Copyright IBM Corp. 1999,2012
1da177e4	3	*
62b74942 MH	4	* Author(s): Martin Peschke <mpeschke@de.ibm.com>
62b74942 MH	5	* Martin Schwidefsky <schwidefsky@de.ibm.com>
1da177e4 LT	6	*/
	7
	8	#ifndef __SCLP_H__
	9	#define __SCLP_H__
	10
	11	#include <linux/types.h>
	12	#include <linux/list.h>
ab14de6c	13	#include <asm/sclp.h>
1da177e4 LT	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)
25b41a7b	18	#define SCLP_CONSOLE_PAGES 6
1da177e4	19
6d4740c8 SH	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
2fc2d1e9	28	#define EVTYP_CONFMGMDATA 0x04
6d4740c8	29	#define EVTYP_SDIAS 0x1C
c114728a	30	#define EVTYP_ASYNC 0x0A
7eb9d5be	31	#define EVTYP_OCF 0x1E
6d4740c8 SH	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
2fc2d1e9	41	#define EVTYP_CONFMGMDATA_MASK 0x10000000
6d4740c8	42	#define EVTYP_SDIAS_MASK 0x00000010
c114728a	43	#define EVTYP_ASYNC_MASK 0x00400000
7eb9d5be	44	#define EVTYP_OCF_MASK 0x00000004
6d4740c8 SH	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
1da177e4 LT	55
	56	typedef unsigned int sclp_cmdw_t;
	57
ab14de6c HC	58	#define SCLP_CMDW_READ_EVENT_DATA 0x00770005
	59	#define SCLP_CMDW_WRITE_EVENT_DATA 0x00760005
	60	#define SCLP_CMDW_WRITE_EVENT_MASK 0x00780005
1da177e4 LT	61
1da177e4 LT	62	#define GDS_ID_MDSMU 0x1310
6d4740c8 SH	63	#define GDS_ID_MDSROUTEINFO 0x1311
	64	#define GDS_ID_AGUNWRKCORR 0x1549
	65	#define GDS_ID_SNACONDREPORT 0x1532
1da177e4	66	#define GDS_ID_CPMSU 0x1212
6d4740c8 SH	67	#define GDS_ID_ROUTTARGINSTR 0x154D
	68	#define GDS_ID_OPREQ 0x8070
	69	#define GDS_ID_TEXTCMD 0x1320
1da177e4	70
6d4740c8	71	#define GDS_KEY_SELFDEFTEXTMSG 0x31
1da177e4	72
62b74942 MH	73	enum 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
1da177e4 LT	82	typedef u32 sccb_mask_t; /* ATTENTION: assumes 32bit mask !!! */
1da177e4 LT	83
05dd2530 HC	84	struct sccb_header {
	85	u16 length;
	86	u8 function_code;
	87	u8 control_mask[3];
	88	u16 response_code;
	89	} __attribute__((packed));
	90
cd183459 HG	91	struct 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
83119ad4	101	extern u64 sclp_facilities;
acf6a004	102
83119ad4 HC	103	#define SCLP_HAS_CHP_INFO (sclp_facilities & 0x8000000000000000ULL)
83119ad4 HC	104	#define SCLP_HAS_CHP_RECONFIG (sclp_facilities & 0x2000000000000000ULL)
08d07968 HC	105	#define SCLP_HAS_CPU_INFO (sclp_facilities & 0x0800000000000000ULL)
08d07968 HC	106	#define SCLP_HAS_CPU_RECONFIG (sclp_facilities & 0x0400000000000000ULL)
7441b062	107	#define SCLP_HAS_PCI_RECONFIG (sclp_facilities & 0x0000000040000000ULL)
83119ad4	108
c114728a	109
1da177e4 LT	110	struct gds_subvector {
	111	u8 length;
	112	u8 key;
	113	} __attribute__((packed));
	114
	115	struct gds_vector {
	116	u16 length;
	117	u16 gds_id;
	118	} __attribute__((packed));
	119
	120	struct evbuf_header {
	121	u16 length;
	122	u8 type;
	123	u8 flags;
	124	u16 _reserved;
	125	} __attribute__((packed));
	126
	127	struct 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;
9f0128f9 GS	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) */
1da177e4 LT	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 */
9f0128f9 GS	148	#define SCLP_REQ_QUEUED_TIMEOUT 0x06 /* request on queue timed out */
	149
	150	#define SCLP_QUEUE_INTERVAL 5 /* timeout interval for request queue */
1da177e4 LT	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 */
	154	struct sclp_register {
	155	struct list_head list;
d082d3ce	156	/* User wants to receive: */
1da177e4	157	sccb_mask_t receive_mask;
d082d3ce	158	/* User wants to send: */
1da177e4	159	sccb_mask_t send_mask;
d082d3ce	160	/* H/W can receive: */
1da177e4	161	sccb_mask_t sclp_receive_mask;
d082d3ce	162	/* H/W can send: */
1da177e4 LT	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 );
62b74942 MH	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;
1da177e4 LT	172	};
	173
	174	/* externals from sclp.c */
	175	int sclp_add_request(struct sclp_req *req);
	176	void sclp_sync_wait(void);
	177	int sclp_register(struct sclp_register *reg);
	178	void sclp_unregister(struct sclp_register *reg);
	179	int sclp_remove_processed(struct sccb_header *sccb);
	180	int sclp_deactivate(void);
	181	int sclp_reactivate(void);
ab14de6c	182	int sclp_service_call(sclp_cmdw_t command, void *sccb);
d475f942	183	int sclp_sync_request(sclp_cmdw_t command, void *sccb);
9f0128f9	184	int sclp_sync_request_timeout(sclp_cmdw_t command, void *sccb, int timeout);
1da177e4	185
763968e2 HC	186	int sclp_sdias_init(void);
	187	void sclp_sdias_exit(void);
	188
25b41a7b MS	189	extern int sclp_console_pages;
	190	extern int sclp_console_drop;
	191	extern unsigned long sclp_console_full;
acf6a004 MH	192	extern u8 sclp_fac84;
	193	extern unsigned long long sclp_rzm;
	194	extern unsigned long long sclp_rnmax;
25b41a7b	195
1da177e4 LT	196	/* useful inlines */
	197
	198	/* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
	199	/* translate single character from ASCII to EBCDIC */
	200	static inline unsigned char
	201	sclp_ascebc(unsigned char ch)
	202	{
	203	return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
	204	}
	205
	206	/* translate string from EBCDIC to ASCII */
	207	static inline void
	208	sclp_ebcasc_str(unsigned char *str, int nr)
	209	{
	210	(MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
	211	}
	212
	213	/* translate string from ASCII to EBCDIC */
	214	static inline void
	215	sclp_ascebc_str(unsigned char *str, int nr)
	216	{
	217	(MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
	218	}
	219
30c2df51 MS	220	static inline struct gds_vector *
	221	sclp_find_gds_vector(void start, void end, u16 id)
	222	{
	223	struct gds_vector *v;
	224
	225	for (v = start; (void ) v < end; v = (void ) v + v->length)
	226	if (v->gds_id == id)
	227	return v;
	228	return NULL;
	229	}
	230
	231	static inline struct gds_subvector *
	232	sclp_find_gds_subvector(void start, void end, u8 key)
	233	{
	234	struct gds_subvector *sv;
	235
	236	for (sv = start; (void ) sv < end; sv = (void ) sv + sv->length)
	237	if (sv->key == key)
	238	return sv;
	239	return NULL;
	240	}
	241
1da177e4	242	#endif /* __SCLP_H__ */