1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * IBM/3270 Driver
4 *
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
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 */
24 #define TC_RDBUF 0x02 /* Read Buffer */
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
80 #define RAW3270_FIRSTMINOR 1 /* First minor number */
81 #define RAW3270_MAXDEVS 255 /* Max number of 3270 devices */
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;
95 extern struct class *class3270;
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
raw3270_request_final(struct raw3270_request * rq)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
129 /*
130 * Functions of a 3270 view.
131 */
132 struct raw3270_fn {
133 int (*activate)(struct raw3270_view *);
134 void (*deactivate)(struct raw3270_view *);
135 void (*intv)(struct raw3270_view *,
136 struct raw3270_request *, struct irb *);
137 void (*release)(struct raw3270_view *);
138 void (*free)(struct raw3270_view *);
139 void (*resize)(struct raw3270_view *, int, int, int);
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 #define RAW3270_VIEW_LOCK_IRQ 0
154 #define RAW3270_VIEW_LOCK_BH 1
155 atomic_t ref_count;
156 struct raw3270 *dev;
157 struct raw3270_fn *fn;
158 unsigned int model;
159 unsigned int rows, cols; /* # of rows & colums of the view */
160 unsigned char *ascebc; /* ascii -> ebcdic table */
161 };
162
163 int raw3270_add_view(struct raw3270_view *, struct raw3270_fn *, int, int);
164 int raw3270_activate_view(struct raw3270_view *);
165 void raw3270_del_view(struct raw3270_view *);
166 void raw3270_deactivate_view(struct raw3270_view *);
167 struct raw3270_view *raw3270_find_view(struct raw3270_fn *, int);
168 int raw3270_start(struct raw3270_view *, struct raw3270_request *);
169 int raw3270_start_locked(struct raw3270_view *, struct raw3270_request *);
170 int raw3270_start_irq(struct raw3270_view *, struct raw3270_request *);
171 int raw3270_reset(struct raw3270_view *);
172 struct raw3270_view *raw3270_view(struct raw3270_view *);
173 int raw3270_view_active(struct raw3270_view *);
174
175 /* Reference count inliner for view structures. */
176 static inline void
raw3270_get_view(struct raw3270_view * view)177 raw3270_get_view(struct raw3270_view *view)
178 {
179 atomic_inc(&view->ref_count);
180 }
181
182 extern wait_queue_head_t raw3270_wait_queue;
183
184 static inline void
raw3270_put_view(struct raw3270_view * view)185 raw3270_put_view(struct raw3270_view *view)
186 {
187 if (atomic_dec_return(&view->ref_count) == 0)
188 wake_up(&raw3270_wait_queue);
189 }
190
191 struct raw3270 *raw3270_setup_console(void);
192 void raw3270_wait_cons_dev(struct raw3270 *);
193
194 /* Notifier for device addition/removal */
195 struct raw3270_notifier {
196 struct list_head list;
197 void (*create)(int minor);
198 void (*destroy)(int minor);
199 };
200
201 int raw3270_register_notifier(struct raw3270_notifier *);
202 void raw3270_unregister_notifier(struct raw3270_notifier *);
203 void raw3270_pm_unfreeze(struct raw3270_view *);
204
205 /*
206 * Little memory allocator for string objects.
207 */
208 struct string
209 {
210 struct list_head list;
211 struct list_head update;
212 unsigned long size;
213 unsigned long len;
214 char string[0];
215 } __attribute__ ((aligned(8)));
216
217 static inline struct string *
alloc_string(struct list_head * free_list,unsigned long len)218 alloc_string(struct list_head *free_list, unsigned long len)
219 {
220 struct string *cs, *tmp;
221 unsigned long size;
222
223 size = (len + 7L) & -8L;
224 list_for_each_entry(cs, free_list, list) {
225 if (cs->size < size)
226 continue;
227 if (cs->size > size + sizeof(struct string)) {
228 char *endaddr = (char *) (cs + 1) + cs->size;
229 tmp = (struct string *) (endaddr - size) - 1;
230 tmp->size = size;
231 cs->size -= size + sizeof(struct string);
232 cs = tmp;
233 } else
234 list_del(&cs->list);
235 cs->len = len;
236 INIT_LIST_HEAD(&cs->list);
237 INIT_LIST_HEAD(&cs->update);
238 return cs;
239 }
240 return NULL;
241 }
242
243 static inline unsigned long
free_string(struct list_head * free_list,struct string * cs)244 free_string(struct list_head *free_list, struct string *cs)
245 {
246 struct string *tmp;
247 struct list_head *p, *left;
248
249 /* Find out the left neighbour in free memory list. */
250 left = free_list;
251 list_for_each(p, free_list) {
252 if (list_entry(p, struct string, list) > cs)
253 break;
254 left = p;
255 }
256 /* Try to merge with right neighbour = next element from left. */
257 if (left->next != free_list) {
258 tmp = list_entry(left->next, struct string, list);
259 if ((char *) (cs + 1) + cs->size == (char *) tmp) {
260 list_del(&tmp->list);
261 cs->size += tmp->size + sizeof(struct string);
262 }
263 }
264 /* Try to merge with left neighbour. */
265 if (left != free_list) {
266 tmp = list_entry(left, struct string, list);
267 if ((char *) (tmp + 1) + tmp->size == (char *) cs) {
268 tmp->size += cs->size + sizeof(struct string);
269 return tmp->size;
270 }
271 }
272 __list_add(&cs->list, left, left->next);
273 return cs->size;
274 }
275
276 static inline void
add_string_memory(struct list_head * free_list,void * mem,unsigned long size)277 add_string_memory(struct list_head *free_list, void *mem, unsigned long size)
278 {
279 struct string *cs;
280
281 cs = (struct string *) mem;
282 cs->size = size - sizeof(struct string);
283 free_string(free_list, cs);
284 }
285
286