[mirror_ubuntu-bionic-kernel.git] / drivers / s390 / char / sclp.h

/*
 *  drivers/s390/char/sclp.h
 *
 *  S390 version
 *    Copyright (C) 1999 IBM Deutschland Entwicklung GmbH, IBM Corporation
 *    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 MAX_CONSOLE_PAGES	4

#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_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 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 SCLP_CMDW_READ_SCP_INFO		0x00020001
#define SCLP_CMDW_READ_SCP_INFO_FORCED	0x00120001

#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

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

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;
};

#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 */

/* 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;
	/* event masks this user is registered for */
	sccb_mask_t receive_mask;
	sccb_mask_t send_mask;
	/* actually present events */
	sccb_mask_t sclp_receive_mask;
	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 *);
};

/* 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);

/* 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);
}

#endif	 /* __SCLP_H__ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* drivers/s390/char/sclp.h
	3	*
	4	* S390 version
	5	* Copyright (C) 1999 IBM Deutschland Entwicklung GmbH, IBM Corporation
	6	* Author(s): Martin Peschke <mpeschke@de.ibm.com>
	7	* Martin Schwidefsky <schwidefsky@de.ibm.com>
	8	*/
	9
	10	#ifndef __SCLP_H__
	11	#define __SCLP_H__
	12
	13	#include <linux/types.h>
	14	#include <linux/list.h>
ab14de6c	15	#include <asm/sclp.h>
1da177e4 LT	16	#include <asm/ebcdic.h>
	17
	18	/* maximum number of pages concerning our own memory management */
	19	#define MAX_KMEM_PAGES (sizeof(unsigned long) << 3)
	20	#define MAX_CONSOLE_PAGES 4
	21
6d4740c8 SH	22	#define EVTYP_OPCMD 0x01
	23	#define EVTYP_MSG 0x02
	24	#define EVTYP_STATECHANGE 0x08
	25	#define EVTYP_PMSGCMD 0x09
	26	#define EVTYP_CNTLPROGOPCMD 0x20
	27	#define EVTYP_CNTLPROGIDENT 0x0B
	28	#define EVTYP_SIGQUIESCE 0x1D
	29	#define EVTYP_VT220MSG 0x1A
2fc2d1e9	30	#define EVTYP_CONFMGMDATA 0x04
6d4740c8 SH	31	#define EVTYP_SDIAS 0x1C
	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 SH	42	#define EVTYP_SDIAS_MASK 0x00000010
	43
	44	#define GNRLMSGFLGS_DOM 0x8000
	45	#define GNRLMSGFLGS_SNDALRM 0x4000
	46	#define GNRLMSGFLGS_HOLDMSG 0x2000
	47
	48	#define LNTPFLGS_CNTLTEXT 0x8000
	49	#define LNTPFLGS_LABELTEXT 0x4000
	50	#define LNTPFLGS_DATATEXT 0x2000
	51	#define LNTPFLGS_ENDTEXT 0x1000
	52	#define LNTPFLGS_PROMPTTEXT 0x0800
1da177e4 LT	53
	54	typedef unsigned int sclp_cmdw_t;
	55
ab14de6c HC	56	#define SCLP_CMDW_READ_EVENT_DATA 0x00770005
	57	#define SCLP_CMDW_WRITE_EVENT_DATA 0x00760005
	58	#define SCLP_CMDW_WRITE_EVENT_MASK 0x00780005
	59	#define SCLP_CMDW_READ_SCP_INFO 0x00020001
	60	#define SCLP_CMDW_READ_SCP_INFO_FORCED 0x00120001
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 LT	72
	73	typedef u32 sccb_mask_t; /* ATTENTION: assumes 32bit mask !!! */
	74
1da177e4 LT	75	struct gds_subvector {
	76	u8 length;
	77	u8 key;
	78	} __attribute__((packed));
	79
	80	struct gds_vector {
	81	u16 length;
	82	u16 gds_id;
	83	} __attribute__((packed));
	84
	85	struct evbuf_header {
	86	u16 length;
	87	u8 type;
	88	u8 flags;
	89	u16 _reserved;
	90	} __attribute__((packed));
	91
	92	struct sclp_req {
	93	struct list_head list; /* list_head for request queueing. */
	94	sclp_cmdw_t command; /* sclp command to execute */
	95	void sccb; / pointer to the sccb to execute */
	96	char status; /* status of this request */
	97	int start_count; /* number of SVCs done for this req */
	98	/* Callback that is called after reaching final status. */
	99	void (callback)(struct sclp_req , void *data);
	100	void *callback_data;
	101	};
	102
	103	#define SCLP_REQ_FILLED 0x00 /* request is ready to be processed */
	104	#define SCLP_REQ_QUEUED 0x01 /* request is queued to be processed */
	105	#define SCLP_REQ_RUNNING 0x02 /* request is currently running */
	106	#define SCLP_REQ_DONE 0x03 /* request is completed successfully */
	107	#define SCLP_REQ_FAILED 0x05 /* request is finally failed */
	108
	109	/* function pointers that a high level driver has to use for registration */
	110	/* of some routines it wants to be called from the low level driver */
	111	struct sclp_register {
	112	struct list_head list;
	113	/* event masks this user is registered for */
	114	sccb_mask_t receive_mask;
	115	sccb_mask_t send_mask;
	116	/* actually present events */
	117	sccb_mask_t sclp_receive_mask;
	118	sccb_mask_t sclp_send_mask;
	119	/* called if event type availability changes */
	120	void (state_change_fn)(struct sclp_register );
	121	/* called for events in cp_receive_mask/sclp_receive_mask */
	122	void (receiver_fn)(struct evbuf_header );
	123	};
	124
	125	/* externals from sclp.c */
	126	int sclp_add_request(struct sclp_req *req);
	127	void sclp_sync_wait(void);
	128	int sclp_register(struct sclp_register *reg);
	129	void sclp_unregister(struct sclp_register *reg);
	130	int sclp_remove_processed(struct sccb_header *sccb);
	131	int sclp_deactivate(void);
	132	int sclp_reactivate(void);
ab14de6c	133	int sclp_service_call(sclp_cmdw_t command, void *sccb);
1da177e4 LT	134
	135	/* useful inlines */
	136
	137	/* VM uses EBCDIC 037, LPAR+native(SE+HMC) use EBCDIC 500 */
	138	/* translate single character from ASCII to EBCDIC */
	139	static inline unsigned char
	140	sclp_ascebc(unsigned char ch)
	141	{
	142	return (MACHINE_IS_VM) ? _ascebc[ch] : _ascebc_500[ch];
	143	}
	144
	145	/* translate string from EBCDIC to ASCII */
	146	static inline void
	147	sclp_ebcasc_str(unsigned char *str, int nr)
	148	{
	149	(MACHINE_IS_VM) ? EBCASC(str, nr) : EBCASC_500(str, nr);
	150	}
	151
	152	/* translate string from ASCII to EBCDIC */
	153	static inline void
	154	sclp_ascebc_str(unsigned char *str, int nr)
	155	{
	156	(MACHINE_IS_VM) ? ASCEBC(str, nr) : ASCEBC_500(str, nr);
	157	}
	158
	159	#endif /* __SCLP_H__ */