[thirdparty/linux.git] / drivers / s390 / char / raw3270.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * IBM/3270 Driver
 *
 * Author(s):
 *   Original 3270 Code for 2.4 written by Richard Hitt (UTS Global)
 *   Rewritten for 2.5 by Martin Schwidefsky <schwidefsky@de.ibm.com>
 *     Copyright IBM Corp. 2003, 2009
 */

#include <asm/idals.h>
#include <asm/ioctl.h>

/* ioctls for fullscreen 3270 */
#define TUBICMD		_IO('3', 3)	/* set ccw command for fs reads. */
#define TUBOCMD		_IO('3', 4)	/* set ccw command for fs writes. */
#define TUBGETI		_IO('3', 7)	/* get ccw command for fs reads. */
#define TUBGETO		_IO('3', 8)	/* get ccw command for fs writes. */
#define TUBSETMOD	_IO('3',12)	/* FIXME: what does it do ?*/
#define TUBGETMOD	_IO('3',13)	/* FIXME: what does it do ?*/

/* Local Channel Commands */
#define TC_WRITE	0x01		/* Write */
#define TC_RDBUF	0x02		/* Read Buffer */
#define TC_EWRITE	0x05		/* Erase write */
#define TC_READMOD	0x06		/* Read modified */
#define TC_EWRITEA	0x0d		/* Erase write alternate */
#define TC_WRITESF	0x11		/* Write structured field */

/* Buffer Control Orders */
#define TO_SF		0x1d		/* Start field */
#define TO_SBA		0x11		/* Set buffer address */
#define TO_IC		0x13		/* Insert cursor */
#define TO_PT		0x05		/* Program tab */
#define TO_RA		0x3c		/* Repeat to address */
#define TO_SFE		0x29		/* Start field extended */
#define TO_EUA		0x12		/* Erase unprotected to address */
#define TO_MF		0x2c		/* Modify field */
#define TO_SA		0x28		/* Set attribute */

/* Field Attribute Bytes */
#define TF_INPUT	0x40		/* Visible input */
#define TF_INPUTN	0x4c		/* Invisible input */
#define TF_INMDT	0xc1		/* Visible, Set-MDT */
#define TF_LOG		0x60

/* Character Attribute Bytes */
#define TAT_RESET	0x00
#define TAT_FIELD	0xc0
#define TAT_EXTHI	0x41
#define TAT_COLOR	0x42
#define TAT_CHARS	0x43
#define TAT_TRANS	0x46

/* Extended-Highlighting Bytes */
#define TAX_RESET	0x00
#define TAX_BLINK	0xf1
#define TAX_REVER	0xf2
#define TAX_UNDER	0xf4

/* Reset value */
#define TAR_RESET	0x00

/* Color values */
#define TAC_RESET	0x00
#define TAC_BLUE	0xf1
#define TAC_RED		0xf2
#define TAC_PINK	0xf3
#define TAC_GREEN	0xf4
#define TAC_TURQ	0xf5
#define TAC_YELLOW	0xf6
#define TAC_WHITE	0xf7
#define TAC_DEFAULT	0x00

/* Write Control Characters */
#define TW_NONE		0x40		/* No particular action */
#define TW_KR		0xc2		/* Keyboard restore */
#define TW_PLUSALARM	0x04		/* Add this bit for alarm */

#define RAW3270_FIRSTMINOR	1	/* First minor number */
#define RAW3270_MAXDEVS		255	/* Max number of 3270 devices */

/* For TUBGETMOD and TUBSETMOD. Should include. */
struct raw3270_iocb {
	short model;
	short line_cnt;
	short col_cnt;
	short pf_cnt;
	short re_cnt;
	short map;
};

struct raw3270;
struct raw3270_view;
extern struct class *class3270;

/* 3270 CCW request */
struct raw3270_request {
	struct list_head list;		/* list head for request queueing. */
	struct raw3270_view *view;	/* view of this request */
	struct ccw1 ccw;		/* single ccw. */
	void *buffer;			/* output buffer. */
	size_t size;			/* size of output buffer. */
	int rescnt;			/* residual count from devstat. */
	int rc;				/* return code for this request. */

	/* Callback for delivering final status. */
	void (*callback)(struct raw3270_request *, void *);
	void *callback_data;
};

struct raw3270_request *raw3270_request_alloc(size_t size);
struct raw3270_request *raw3270_request_alloc_bootmem(size_t size);
void raw3270_request_free(struct raw3270_request *);
void raw3270_request_reset(struct raw3270_request *);
void raw3270_request_set_cmd(struct raw3270_request *, u8 cmd);
int  raw3270_request_add_data(struct raw3270_request *, void *, size_t);
void raw3270_request_set_data(struct raw3270_request *, void *, size_t);
void raw3270_request_set_idal(struct raw3270_request *, struct idal_buffer *);

static inline int
raw3270_request_final(struct raw3270_request *rq)
{
	return list_empty(&rq->list);
}

void raw3270_buffer_address(struct raw3270 *, char *, unsigned short);

/*
 * Functions of a 3270 view.
 */
struct raw3270_fn {
	int  (*activate)(struct raw3270_view *);
	void (*deactivate)(struct raw3270_view *);
	void (*intv)(struct raw3270_view *,
		     struct raw3270_request *, struct irb *);
	void (*release)(struct raw3270_view *);
	void (*free)(struct raw3270_view *);
	void (*resize)(struct raw3270_view *, int, int, int);
};

/*
 * View structure chaining. The raw3270_view structure is meant to
 * be embedded at the start of the real view data structure, e.g.:
 *   struct example {
 *     struct raw3270_view view;
 *     ...
 *   };
 */
struct raw3270_view {
	struct list_head list;
	spinlock_t lock;
	atomic_t ref_count;
	struct raw3270 *dev;
	struct raw3270_fn *fn;
	unsigned int model;
	unsigned int rows, cols;	/* # of rows & colums of the view */
	unsigned char *ascebc;		/* ascii -> ebcdic table */
};

int raw3270_add_view(struct raw3270_view *, struct raw3270_fn *, int);
int raw3270_activate_view(struct raw3270_view *);
void raw3270_del_view(struct raw3270_view *);
void raw3270_deactivate_view(struct raw3270_view *);
struct raw3270_view *raw3270_find_view(struct raw3270_fn *, int);
int raw3270_start(struct raw3270_view *, struct raw3270_request *);
int raw3270_start_locked(struct raw3270_view *, struct raw3270_request *);
int raw3270_start_irq(struct raw3270_view *, struct raw3270_request *);
int raw3270_reset(struct raw3270_view *);
struct raw3270_view *raw3270_view(struct raw3270_view *);
int raw3270_view_active(struct raw3270_view *);

/* Reference count inliner for view structures. */
static inline void
raw3270_get_view(struct raw3270_view *view)
{
	atomic_inc(&view->ref_count);
}

extern wait_queue_head_t raw3270_wait_queue;

static inline void
raw3270_put_view(struct raw3270_view *view)
{
	if (atomic_dec_return(&view->ref_count) == 0)
		wake_up(&raw3270_wait_queue);
}

struct raw3270 *raw3270_setup_console(void);
void raw3270_wait_cons_dev(struct raw3270 *);

/* Notifier for device addition/removal */
struct raw3270_notifier {
	struct list_head list;
	void (*create)(int minor);
	void (*destroy)(int minor);
};

int raw3270_register_notifier(struct raw3270_notifier *);
void raw3270_unregister_notifier(struct raw3270_notifier *);
void raw3270_pm_unfreeze(struct raw3270_view *);

/*
 * Little memory allocator for string objects. 
 */
struct string
{
	struct list_head list;
	struct list_head update;
	unsigned long size;
	unsigned long len;
	char string[0];
} __attribute__ ((aligned(8)));

static inline struct string *
alloc_string(struct list_head *free_list, unsigned long len)
{
	struct string *cs, *tmp;
	unsigned long size;

	size = (len + 7L) & -8L;
	list_for_each_entry(cs, free_list, list) {
		if (cs->size < size)
			continue;
		if (cs->size > size + sizeof(struct string)) {
			char *endaddr = (char *) (cs + 1) + cs->size;
			tmp = (struct string *) (endaddr - size) - 1;
			tmp->size = size;
			cs->size -= size + sizeof(struct string);
			cs = tmp;
		} else
			list_del(&cs->list);
		cs->len = len;
		INIT_LIST_HEAD(&cs->list);
		INIT_LIST_HEAD(&cs->update);
		return cs;
	}
	return NULL;
}

static inline unsigned long
free_string(struct list_head *free_list, struct string *cs)
{
	struct string *tmp;
	struct list_head *p, *left;

	/* Find out the left neighbour in free memory list. */
	left = free_list;
	list_for_each(p, free_list) {
		if (list_entry(p, struct string, list) > cs)
			break;
		left = p;
	}
	/* Try to merge with right neighbour = next element from left. */
	if (left->next != free_list) {
		tmp = list_entry(left->next, struct string, list);
		if ((char *) (cs + 1) + cs->size == (char *) tmp) {
			list_del(&tmp->list);
			cs->size += tmp->size + sizeof(struct string);
		}
	}
	/* Try to merge with left neighbour. */
	if (left != free_list) {
		tmp = list_entry(left, struct string, list);
		if ((char *) (tmp + 1) + tmp->size == (char *) cs) {
			tmp->size += cs->size + sizeof(struct string);
			return tmp->size;
		}
	}
	__list_add(&cs->list, left, left->next);
	return cs->size;
}

static inline void
add_string_memory(struct list_head *free_list, void *mem, unsigned long size)
{
	struct string *cs;

	cs = (struct string *) mem;
	cs->size = size - sizeof(struct string);
	free_string(free_list, cs);
}
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4	2	/*
4b214a0c	3	* IBM/3270 Driver
1da177e4	4	*
4b214a0c MS	5	* Author(s):
	6	* Original 3270 Code for 2.4 written by Richard Hitt (UTS Global)
	7	* Rewritten for 2.5 by Martin Schwidefsky <schwidefsky@de.ibm.com>
	8	* Copyright IBM Corp. 2003, 2009
1da177e4 LT	9	*/
	10
	11	#include <asm/idals.h>
	12	#include <asm/ioctl.h>
	13
	14	/* ioctls for fullscreen 3270 */
	15	#define TUBICMD _IO('3', 3) /* set ccw command for fs reads. */
	16	#define TUBOCMD _IO('3', 4) /* set ccw command for fs writes. */
	17	#define TUBGETI _IO('3', 7) /* get ccw command for fs reads. */
	18	#define TUBGETO _IO('3', 8) /* get ccw command for fs writes. */
	19	#define TUBSETMOD _IO('3',12) /* FIXME: what does it do ?*/
	20	#define TUBGETMOD _IO('3',13) /* FIXME: what does it do ?*/
	21
	22	/* Local Channel Commands */
	23	#define TC_WRITE 0x01 /* Write */
ed3cb6f0	24	#define TC_RDBUF 0x02 /* Read Buffer */
1da177e4 LT	25	#define TC_EWRITE 0x05 /* Erase write */
	26	#define TC_READMOD 0x06 /* Read modified */
	27	#define TC_EWRITEA 0x0d /* Erase write alternate */
	28	#define TC_WRITESF 0x11 /* Write structured field */
	29
	30	/* Buffer Control Orders */
	31	#define TO_SF 0x1d /* Start field */
	32	#define TO_SBA 0x11 /* Set buffer address */
	33	#define TO_IC 0x13 /* Insert cursor */
	34	#define TO_PT 0x05 /* Program tab */
	35	#define TO_RA 0x3c /* Repeat to address */
	36	#define TO_SFE 0x29 /* Start field extended */
	37	#define TO_EUA 0x12 /* Erase unprotected to address */
	38	#define TO_MF 0x2c /* Modify field */
	39	#define TO_SA 0x28 /* Set attribute */
	40
	41	/* Field Attribute Bytes */
	42	#define TF_INPUT 0x40 /* Visible input */
	43	#define TF_INPUTN 0x4c /* Invisible input */
	44	#define TF_INMDT 0xc1 /* Visible, Set-MDT */
	45	#define TF_LOG 0x60
	46
	47	/* Character Attribute Bytes */
	48	#define TAT_RESET 0x00
	49	#define TAT_FIELD 0xc0
	50	#define TAT_EXTHI 0x41
	51	#define TAT_COLOR 0x42
	52	#define TAT_CHARS 0x43
	53	#define TAT_TRANS 0x46
	54
	55	/* Extended-Highlighting Bytes */
	56	#define TAX_RESET 0x00
	57	#define TAX_BLINK 0xf1
	58	#define TAX_REVER 0xf2
	59	#define TAX_UNDER 0xf4
	60
	61	/* Reset value */
	62	#define TAR_RESET 0x00
	63
	64	/* Color values */
	65	#define TAC_RESET 0x00
	66	#define TAC_BLUE 0xf1
	67	#define TAC_RED 0xf2
	68	#define TAC_PINK 0xf3
	69	#define TAC_GREEN 0xf4
	70	#define TAC_TURQ 0xf5
	71	#define TAC_YELLOW 0xf6
	72	#define TAC_WHITE 0xf7
	73	#define TAC_DEFAULT 0x00
	74
	75	/* Write Control Characters */
	76	#define TW_NONE 0x40 /* No particular action */
	77	#define TW_KR 0xc2 /* Keyboard restore */
	78	#define TW_PLUSALARM 0x04 /* Add this bit for alarm */
	79
ed3cb6f0 RH	80	#define RAW3270_FIRSTMINOR 1 /* First minor number */
ed3cb6f0 RH	81	#define RAW3270_MAXDEVS 255 /* Max number of 3270 devices */
1da177e4 LT	82
	83	/* For TUBGETMOD and TUBSETMOD. Should include. */
	84	struct raw3270_iocb {
	85	short model;
	86	short line_cnt;
	87	short col_cnt;
	88	short pf_cnt;
	89	short re_cnt;
	90	short map;
	91	};
	92
	93	struct raw3270;
	94	struct raw3270_view;
c95571e6	95	extern struct class *class3270;
1da177e4 LT	96
	97	/* 3270 CCW request */
	98	struct raw3270_request {
	99	struct list_head list; /* list head for request queueing. */
	100	struct raw3270_view view; / view of this request */
	101	struct ccw1 ccw; /* single ccw. */
	102	void buffer; / output buffer. */
	103	size_t size; /* size of output buffer. */
	104	int rescnt; /* residual count from devstat. */
	105	int rc; /* return code for this request. */
	106
	107	/* Callback for delivering final status. */
	108	void (callback)(struct raw3270_request , void *);
	109	void *callback_data;
	110	};
	111
	112	struct raw3270_request *raw3270_request_alloc(size_t size);
	113	struct raw3270_request *raw3270_request_alloc_bootmem(size_t size);
	114	void raw3270_request_free(struct raw3270_request *);
	115	void raw3270_request_reset(struct raw3270_request *);
	116	void raw3270_request_set_cmd(struct raw3270_request *, u8 cmd);
	117	int raw3270_request_add_data(struct raw3270_request , void , size_t);
	118	void raw3270_request_set_data(struct raw3270_request , void , size_t);
	119	void raw3270_request_set_idal(struct raw3270_request , struct idal_buffer );
	120
	121	static inline int
	122	raw3270_request_final(struct raw3270_request *rq)
	123	{
	124	return list_empty(&rq->list);
	125	}
	126
	127	void raw3270_buffer_address(struct raw3270 , char , unsigned short);
	128
1da177e4 LT	129	/*
	130	* Functions of a 3270 view.
	131	*/
	132	struct raw3270_fn {
	133	int (activate)(struct raw3270_view );
	134	void (deactivate)(struct raw3270_view );
8340ab60	135	void (intv)(struct raw3270_view ,
1da177e4 LT	136	struct raw3270_request , struct irb );
	137	void (release)(struct raw3270_view );
	138	void (free)(struct raw3270_view );
4d334fd1	139	void (resize)(struct raw3270_view , int, int, int);
1da177e4 LT	140	};
	141
	142	/*
	143	* View structure chaining. The raw3270_view structure is meant to
	144	* be embedded at the start of the real view data structure, e.g.:
	145	* struct example {
	146	* struct raw3270_view view;
	147	* ...
	148	* };
	149	*/
	150	struct raw3270_view {
	151	struct list_head list;
	152	spinlock_t lock;
	153	atomic_t ref_count;
	154	struct raw3270 *dev;
	155	struct raw3270_fn *fn;
	156	unsigned int model;
	157	unsigned int rows, cols; /* # of rows & colums of the view */
	158	unsigned char ascebc; / ascii -> ebcdic table */
	159	};
	160
	161	int raw3270_add_view(struct raw3270_view , struct raw3270_fn , int);
	162	int raw3270_activate_view(struct raw3270_view *);
	163	void raw3270_del_view(struct raw3270_view *);
	164	void raw3270_deactivate_view(struct raw3270_view *);
	165	struct raw3270_view raw3270_find_view(struct raw3270_fn , int);
	166	int raw3270_start(struct raw3270_view , struct raw3270_request );
ed3cb6f0	167	int raw3270_start_locked(struct raw3270_view , struct raw3270_request );
1da177e4	168	int raw3270_start_irq(struct raw3270_view , struct raw3270_request );
ed3cb6f0 RH	169	int raw3270_reset(struct raw3270_view *);
ed3cb6f0 RH	170	struct raw3270_view raw3270_view(struct raw3270_view );
233faec9	171	int raw3270_view_active(struct raw3270_view *);
1da177e4 LT	172
	173	/* Reference count inliner for view structures. */
	174	static inline void
	175	raw3270_get_view(struct raw3270_view *view)
	176	{
	177	atomic_inc(&view->ref_count);
	178	}
	179
	180	extern wait_queue_head_t raw3270_wait_queue;
	181
	182	static inline void
	183	raw3270_put_view(struct raw3270_view *view)
	184	{
	185	if (atomic_dec_return(&view->ref_count) == 0)
	186	wake_up(&raw3270_wait_queue);
	187	}
	188
2253e8d7	189	struct raw3270 *raw3270_setup_console(void);
1da177e4 LT	190	void raw3270_wait_cons_dev(struct raw3270 *);
	191
	192	/* Notifier for device addition/removal */
c95571e6 MS	193	struct raw3270_notifier {
	194	struct list_head list;
	195	void (*create)(int minor);
	196	void (*destroy)(int minor);
	197	};
	198
	199	int raw3270_register_notifier(struct raw3270_notifier *);
	200	void raw3270_unregister_notifier(struct raw3270_notifier *);
4b214a0c	201	void raw3270_pm_unfreeze(struct raw3270_view *);
1da177e4 LT	202
	203	/*
	204	* Little memory allocator for string objects.
	205	*/
	206	struct string
	207	{
	208	struct list_head list;
	209	struct list_head update;
	210	unsigned long size;
	211	unsigned long len;
	212	char string[0];
	213	} __attribute__ ((aligned(8)));
	214
	215	static inline struct string *
	216	alloc_string(struct list_head *free_list, unsigned long len)
	217	{
	218	struct string cs, tmp;
	219	unsigned long size;
	220
	221	size = (len + 7L) & -8L;
	222	list_for_each_entry(cs, free_list, list) {
	223	if (cs->size < size)
	224	continue;
	225	if (cs->size > size + sizeof(struct string)) {
	226	char endaddr = (char ) (cs + 1) + cs->size;
	227	tmp = (struct string *) (endaddr - size) - 1;
	228	tmp->size = size;
	229	cs->size -= size + sizeof(struct string);
	230	cs = tmp;
	231	} else
	232	list_del(&cs->list);
	233	cs->len = len;
	234	INIT_LIST_HEAD(&cs->list);
	235	INIT_LIST_HEAD(&cs->update);
	236	return cs;
	237	}
d2c993d8	238	return NULL;
1da177e4 LT	239	}
	240
	241	static inline unsigned long
	242	free_string(struct list_head free_list, struct string cs)
	243	{
	244	struct string *tmp;
	245	struct list_head p, left;
	246
	247	/* Find out the left neighbour in free memory list. */
	248	left = free_list;
	249	list_for_each(p, free_list) {
	250	if (list_entry(p, struct string, list) > cs)
	251	break;
	252	left = p;
	253	}
	254	/* Try to merge with right neighbour = next element from left. */
	255	if (left->next != free_list) {
	256	tmp = list_entry(left->next, struct string, list);
	257	if ((char ) (cs + 1) + cs->size == (char ) tmp) {
	258	list_del(&tmp->list);
	259	cs->size += tmp->size + sizeof(struct string);
	260	}
	261	}
	262	/* Try to merge with left neighbour. */
	263	if (left != free_list) {
	264	tmp = list_entry(left, struct string, list);
	265	if ((char ) (tmp + 1) + tmp->size == (char ) cs) {
	266	tmp->size += cs->size + sizeof(struct string);
	267	return tmp->size;
	268	}
	269	}
	270	__list_add(&cs->list, left, left->next);
	271	return cs->size;
	272	}
	273
	274	static inline void
	275	add_string_memory(struct list_head free_list, void mem, unsigned long size)
	276	{
	277	struct string *cs;
	278
	279	cs = (struct string *) mem;
	280	cs->size = size - sizeof(struct string);
	281	free_string(free_list, cs);
	282	}
	283