xref: /openbmc/linux/drivers/s390/char/con3215.c (revision 12eb4683)
1 /*
2  * 3215 line mode terminal driver.
3  *
4  * Copyright IBM Corp. 1999, 2009
5  * Author(s): Martin Schwidefsky <schwidefsky@de.ibm.com>
6  *
7  * Updated:
8  *  Aug-2000: Added tab support
9  *	      Dan Morrison, IBM Corporation <dmorriso@cse.buffalo.edu>
10  */
11 
12 #include <linux/module.h>
13 #include <linux/types.h>
14 #include <linux/kdev_t.h>
15 #include <linux/tty.h>
16 #include <linux/tty_flip.h>
17 #include <linux/vt_kern.h>
18 #include <linux/init.h>
19 #include <linux/console.h>
20 #include <linux/interrupt.h>
21 #include <linux/err.h>
22 #include <linux/reboot.h>
23 #include <linux/serial.h> /* ASYNC_* flags */
24 #include <linux/slab.h>
25 #include <asm/ccwdev.h>
26 #include <asm/cio.h>
27 #include <asm/io.h>
28 #include <asm/ebcdic.h>
29 #include <asm/uaccess.h>
30 #include <asm/delay.h>
31 #include <asm/cpcmd.h>
32 #include <asm/setup.h>
33 
34 #include "ctrlchar.h"
35 
36 #define NR_3215		    1
37 #define NR_3215_REQ	    (4*NR_3215)
38 #define RAW3215_BUFFER_SIZE 65536     /* output buffer size */
39 #define RAW3215_INBUF_SIZE  256	      /* input buffer size */
40 #define RAW3215_MIN_SPACE   128	      /* minimum free space for wakeup */
41 #define RAW3215_MIN_WRITE   1024      /* min. length for immediate output */
42 #define RAW3215_MAX_BYTES   3968      /* max. bytes to write with one ssch */
43 #define RAW3215_MAX_NEWLINE 50	      /* max. lines to write with one ssch */
44 #define RAW3215_NR_CCWS	    3
45 #define RAW3215_TIMEOUT	    HZ/10     /* time for delayed output */
46 
47 #define RAW3215_FIXED	    1	      /* 3215 console device is not be freed */
48 #define RAW3215_WORKING	    4	      /* set if a request is being worked on */
49 #define RAW3215_THROTTLED   8	      /* set if reading is disabled */
50 #define RAW3215_STOPPED	    16	      /* set if writing is disabled */
51 #define RAW3215_TIMER_RUNS  64	      /* set if the output delay timer is on */
52 #define RAW3215_FLUSHING    128	      /* set to flush buffer (no delay) */
53 
54 #define TAB_STOP_SIZE	    8	      /* tab stop size */
55 
56 /*
57  * Request types for a 3215 device
58  */
59 enum raw3215_type {
60 	RAW3215_FREE, RAW3215_READ, RAW3215_WRITE
61 };
62 
63 /*
64  * Request structure for a 3215 device
65  */
66 struct raw3215_req {
67 	enum raw3215_type type;	      /* type of the request */
68 	int start, len;		      /* start index & len in output buffer */
69 	int delayable;		      /* indication to wait for more data */
70 	int residual;		      /* residual count for read request */
71 	struct ccw1 ccws[RAW3215_NR_CCWS]; /* space for the channel program */
72 	struct raw3215_info *info;    /* pointer to main structure */
73 	struct raw3215_req *next;     /* pointer to next request */
74 } __attribute__ ((aligned(8)));
75 
76 struct raw3215_info {
77 	struct tty_port port;
78 	struct ccw_device *cdev;      /* device for tty driver */
79 	spinlock_t *lock;	      /* pointer to irq lock */
80 	int flags;		      /* state flags */
81 	char *buffer;		      /* pointer to output buffer */
82 	char *inbuf;		      /* pointer to input buffer */
83 	int head;		      /* first free byte in output buffer */
84 	int count;		      /* number of bytes in output buffer */
85 	int written;		      /* number of bytes in write requests */
86 	struct raw3215_req *queued_read; /* pointer to queued read requests */
87 	struct raw3215_req *queued_write;/* pointer to queued write requests */
88 	struct tasklet_struct tlet;   /* tasklet to invoke tty_wakeup */
89 	wait_queue_head_t empty_wait; /* wait queue for flushing */
90 	struct timer_list timer;      /* timer for delayed output */
91 	int line_pos;		      /* position on the line (for tabs) */
92 	char ubuffer[80];	      /* copy_from_user buffer */
93 };
94 
95 /* array of 3215 devices structures */
96 static struct raw3215_info *raw3215[NR_3215];
97 /* spinlock to protect the raw3215 array */
98 static DEFINE_SPINLOCK(raw3215_device_lock);
99 /* list of free request structures */
100 static struct raw3215_req *raw3215_freelist;
101 /* spinlock to protect free list */
102 static spinlock_t raw3215_freelist_lock;
103 
104 static struct tty_driver *tty3215_driver;
105 
106 /*
107  * Get a request structure from the free list
108  */
109 static inline struct raw3215_req *raw3215_alloc_req(void)
110 {
111 	struct raw3215_req *req;
112 	unsigned long flags;
113 
114 	spin_lock_irqsave(&raw3215_freelist_lock, flags);
115 	req = raw3215_freelist;
116 	raw3215_freelist = req->next;
117 	spin_unlock_irqrestore(&raw3215_freelist_lock, flags);
118 	return req;
119 }
120 
121 /*
122  * Put a request structure back to the free list
123  */
124 static inline void raw3215_free_req(struct raw3215_req *req)
125 {
126 	unsigned long flags;
127 
128 	if (req->type == RAW3215_FREE)
129 		return;		/* don't free a free request */
130 	req->type = RAW3215_FREE;
131 	spin_lock_irqsave(&raw3215_freelist_lock, flags);
132 	req->next = raw3215_freelist;
133 	raw3215_freelist = req;
134 	spin_unlock_irqrestore(&raw3215_freelist_lock, flags);
135 }
136 
137 /*
138  * Set up a read request that reads up to 160 byte from the 3215 device.
139  * If there is a queued read request it is used, but that shouldn't happen
140  * because a 3215 terminal won't accept a new read before the old one is
141  * completed.
142  */
143 static void raw3215_mk_read_req(struct raw3215_info *raw)
144 {
145 	struct raw3215_req *req;
146 	struct ccw1 *ccw;
147 
148 	/* there can only be ONE read request at a time */
149 	req = raw->queued_read;
150 	if (req == NULL) {
151 		/* no queued read request, use new req structure */
152 		req = raw3215_alloc_req();
153 		req->type = RAW3215_READ;
154 		req->info = raw;
155 		raw->queued_read = req;
156 	}
157 
158 	ccw = req->ccws;
159 	ccw->cmd_code = 0x0A; /* read inquiry */
160 	ccw->flags = 0x20;    /* ignore incorrect length */
161 	ccw->count = 160;
162 	ccw->cda = (__u32) __pa(raw->inbuf);
163 }
164 
165 /*
166  * Set up a write request with the information from the main structure.
167  * A ccw chain is created that writes as much as possible from the output
168  * buffer to the 3215 device. If a queued write exists it is replaced by
169  * the new, probably lengthened request.
170  */
171 static void raw3215_mk_write_req(struct raw3215_info *raw)
172 {
173 	struct raw3215_req *req;
174 	struct ccw1 *ccw;
175 	int len, count, ix, lines;
176 
177 	if (raw->count <= raw->written)
178 		return;
179 	/* check if there is a queued write request */
180 	req = raw->queued_write;
181 	if (req == NULL) {
182 		/* no queued write request, use new req structure */
183 		req = raw3215_alloc_req();
184 		req->type = RAW3215_WRITE;
185 		req->info = raw;
186 		raw->queued_write = req;
187 	} else {
188 		raw->written -= req->len;
189 	}
190 
191 	ccw = req->ccws;
192 	req->start = (raw->head - raw->count + raw->written) &
193 		     (RAW3215_BUFFER_SIZE - 1);
194 	/*
195 	 * now we have to count newlines. We can at max accept
196 	 * RAW3215_MAX_NEWLINE newlines in a single ssch due to
197 	 * a restriction in VM
198 	 */
199 	lines = 0;
200 	ix = req->start;
201 	while (lines < RAW3215_MAX_NEWLINE && ix != raw->head) {
202 		if (raw->buffer[ix] == 0x15)
203 			lines++;
204 		ix = (ix + 1) & (RAW3215_BUFFER_SIZE - 1);
205 	}
206 	len = ((ix - 1 - req->start) & (RAW3215_BUFFER_SIZE - 1)) + 1;
207 	if (len > RAW3215_MAX_BYTES)
208 		len = RAW3215_MAX_BYTES;
209 	req->len = len;
210 	raw->written += len;
211 
212 	/* set the indication if we should try to enlarge this request */
213 	req->delayable = (ix == raw->head) && (len < RAW3215_MIN_WRITE);
214 
215 	ix = req->start;
216 	while (len > 0) {
217 		if (ccw > req->ccws)
218 			ccw[-1].flags |= 0x40; /* use command chaining */
219 		ccw->cmd_code = 0x01; /* write, auto carrier return */
220 		ccw->flags = 0x20;    /* ignore incorrect length ind.  */
221 		ccw->cda =
222 			(__u32) __pa(raw->buffer + ix);
223 		count = len;
224 		if (ix + count > RAW3215_BUFFER_SIZE)
225 			count = RAW3215_BUFFER_SIZE - ix;
226 		ccw->count = count;
227 		len -= count;
228 		ix = (ix + count) & (RAW3215_BUFFER_SIZE - 1);
229 		ccw++;
230 	}
231 	/*
232 	 * Add a NOP to the channel program. 3215 devices are purely
233 	 * emulated and its much better to avoid the channel end
234 	 * interrupt in this case.
235 	 */
236 	if (ccw > req->ccws)
237 		ccw[-1].flags |= 0x40; /* use command chaining */
238 	ccw->cmd_code = 0x03; /* NOP */
239 	ccw->flags = 0;
240 	ccw->cda = 0;
241 	ccw->count = 1;
242 }
243 
244 /*
245  * Start a read or a write request
246  */
247 static void raw3215_start_io(struct raw3215_info *raw)
248 {
249 	struct raw3215_req *req;
250 	int res;
251 
252 	req = raw->queued_read;
253 	if (req != NULL &&
254 	    !(raw->flags & (RAW3215_WORKING | RAW3215_THROTTLED))) {
255 		/* dequeue request */
256 		raw->queued_read = NULL;
257 		res = ccw_device_start(raw->cdev, req->ccws,
258 				       (unsigned long) req, 0, 0);
259 		if (res != 0) {
260 			/* do_IO failed, put request back to queue */
261 			raw->queued_read = req;
262 		} else {
263 			raw->flags |= RAW3215_WORKING;
264 		}
265 	}
266 	req = raw->queued_write;
267 	if (req != NULL &&
268 	    !(raw->flags & (RAW3215_WORKING | RAW3215_STOPPED))) {
269 		/* dequeue request */
270 		raw->queued_write = NULL;
271 		res = ccw_device_start(raw->cdev, req->ccws,
272 				       (unsigned long) req, 0, 0);
273 		if (res != 0) {
274 			/* do_IO failed, put request back to queue */
275 			raw->queued_write = req;
276 		} else {
277 			raw->flags |= RAW3215_WORKING;
278 		}
279 	}
280 }
281 
282 /*
283  * Function to start a delayed output after RAW3215_TIMEOUT seconds
284  */
285 static void raw3215_timeout(unsigned long __data)
286 {
287 	struct raw3215_info *raw = (struct raw3215_info *) __data;
288 	unsigned long flags;
289 
290 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
291 	if (raw->flags & RAW3215_TIMER_RUNS) {
292 		del_timer(&raw->timer);
293 		raw->flags &= ~RAW3215_TIMER_RUNS;
294 		if (!(raw->port.flags & ASYNC_SUSPENDED)) {
295 			raw3215_mk_write_req(raw);
296 			raw3215_start_io(raw);
297 		}
298 	}
299 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
300 }
301 
302 /*
303  * Function to conditionally start an IO. A read is started immediately,
304  * a write is only started immediately if the flush flag is on or the
305  * amount of data is bigger than RAW3215_MIN_WRITE. If a write is not
306  * done immediately a timer is started with a delay of RAW3215_TIMEOUT.
307  */
308 static inline void raw3215_try_io(struct raw3215_info *raw)
309 {
310 	if (!(raw->port.flags & ASYNC_INITIALIZED) ||
311 			(raw->port.flags & ASYNC_SUSPENDED))
312 		return;
313 	if (raw->queued_read != NULL)
314 		raw3215_start_io(raw);
315 	else if (raw->queued_write != NULL) {
316 		if ((raw->queued_write->delayable == 0) ||
317 		    (raw->flags & RAW3215_FLUSHING)) {
318 			/* execute write requests bigger than minimum size */
319 			raw3215_start_io(raw);
320 			if (raw->flags & RAW3215_TIMER_RUNS) {
321 				del_timer(&raw->timer);
322 				raw->flags &= ~RAW3215_TIMER_RUNS;
323 			}
324 		} else if (!(raw->flags & RAW3215_TIMER_RUNS)) {
325 			/* delay small writes */
326 			raw->timer.expires = RAW3215_TIMEOUT + jiffies;
327 			add_timer(&raw->timer);
328 			raw->flags |= RAW3215_TIMER_RUNS;
329 		}
330 	}
331 }
332 
333 /*
334  * Call tty_wakeup from tasklet context
335  */
336 static void raw3215_wakeup(unsigned long data)
337 {
338 	struct raw3215_info *raw = (struct raw3215_info *) data;
339 	struct tty_struct *tty;
340 
341 	tty = tty_port_tty_get(&raw->port);
342 	if (tty) {
343 		tty_wakeup(tty);
344 		tty_kref_put(tty);
345 	}
346 }
347 
348 /*
349  * Try to start the next IO and wake up processes waiting on the tty.
350  */
351 static void raw3215_next_io(struct raw3215_info *raw, struct tty_struct *tty)
352 {
353 	raw3215_mk_write_req(raw);
354 	raw3215_try_io(raw);
355 	if (tty && RAW3215_BUFFER_SIZE - raw->count >= RAW3215_MIN_SPACE)
356 		tasklet_schedule(&raw->tlet);
357 }
358 
359 /*
360  * Interrupt routine, called from common io layer
361  */
362 static void raw3215_irq(struct ccw_device *cdev, unsigned long intparm,
363 			struct irb *irb)
364 {
365 	struct raw3215_info *raw;
366 	struct raw3215_req *req;
367 	struct tty_struct *tty;
368 	int cstat, dstat;
369 	int count;
370 
371 	raw = dev_get_drvdata(&cdev->dev);
372 	req = (struct raw3215_req *) intparm;
373 	tty = tty_port_tty_get(&raw->port);
374 	cstat = irb->scsw.cmd.cstat;
375 	dstat = irb->scsw.cmd.dstat;
376 	if (cstat != 0)
377 		raw3215_next_io(raw, tty);
378 	if (dstat & 0x01) { /* we got a unit exception */
379 		dstat &= ~0x01;	 /* we can ignore it */
380 	}
381 	switch (dstat) {
382 	case 0x80:
383 		if (cstat != 0)
384 			break;
385 		/* Attention interrupt, someone hit the enter key */
386 		raw3215_mk_read_req(raw);
387 		raw3215_next_io(raw, tty);
388 		break;
389 	case 0x08:
390 	case 0x0C:
391 		/* Channel end interrupt. */
392 		if ((raw = req->info) == NULL)
393 			goto put_tty;	     /* That shouldn't happen ... */
394 		if (req->type == RAW3215_READ) {
395 			/* store residual count, then wait for device end */
396 			req->residual = irb->scsw.cmd.count;
397 		}
398 		if (dstat == 0x08)
399 			break;
400 	case 0x04:
401 		/* Device end interrupt. */
402 		if ((raw = req->info) == NULL)
403 			goto put_tty;	     /* That shouldn't happen ... */
404 		if (req->type == RAW3215_READ && tty != NULL) {
405 			unsigned int cchar;
406 
407 			count = 160 - req->residual;
408 			EBCASC(raw->inbuf, count);
409 			cchar = ctrlchar_handle(raw->inbuf, count, tty);
410 			switch (cchar & CTRLCHAR_MASK) {
411 			case CTRLCHAR_SYSRQ:
412 				break;
413 
414 			case CTRLCHAR_CTRL:
415 				tty_insert_flip_char(&raw->port, cchar,
416 						TTY_NORMAL);
417 				tty_flip_buffer_push(&raw->port);
418 				break;
419 
420 			case CTRLCHAR_NONE:
421 				if (count < 2 ||
422 				    (strncmp(raw->inbuf+count-2, "\252n", 2) &&
423 				     strncmp(raw->inbuf+count-2, "^n", 2)) ) {
424 					/* add the auto \n */
425 					raw->inbuf[count] = '\n';
426 					count++;
427 				} else
428 					count -= 2;
429 				tty_insert_flip_string(&raw->port, raw->inbuf,
430 						count);
431 				tty_flip_buffer_push(&raw->port);
432 				break;
433 			}
434 		} else if (req->type == RAW3215_WRITE) {
435 			raw->count -= req->len;
436 			raw->written -= req->len;
437 		}
438 		raw->flags &= ~RAW3215_WORKING;
439 		raw3215_free_req(req);
440 		/* check for empty wait */
441 		if (waitqueue_active(&raw->empty_wait) &&
442 		    raw->queued_write == NULL &&
443 		    raw->queued_read == NULL) {
444 			wake_up_interruptible(&raw->empty_wait);
445 		}
446 		raw3215_next_io(raw, tty);
447 		break;
448 	default:
449 		/* Strange interrupt, I'll do my best to clean up */
450 		if (req != NULL && req->type != RAW3215_FREE) {
451 			if (req->type == RAW3215_WRITE) {
452 				raw->count -= req->len;
453 				raw->written -= req->len;
454 			}
455 			raw->flags &= ~RAW3215_WORKING;
456 			raw3215_free_req(req);
457 		}
458 		raw3215_next_io(raw, tty);
459 	}
460 put_tty:
461 	tty_kref_put(tty);
462 }
463 
464 /*
465  * Drop the oldest line from the output buffer.
466  */
467 static void raw3215_drop_line(struct raw3215_info *raw)
468 {
469 	int ix;
470 	char ch;
471 
472 	BUG_ON(raw->written != 0);
473 	ix = (raw->head - raw->count) & (RAW3215_BUFFER_SIZE - 1);
474 	while (raw->count > 0) {
475 		ch = raw->buffer[ix];
476 		ix = (ix + 1) & (RAW3215_BUFFER_SIZE - 1);
477 		raw->count--;
478 		if (ch == 0x15)
479 			break;
480 	}
481 	raw->head = ix;
482 }
483 
484 /*
485  * Wait until length bytes are available int the output buffer.
486  * Has to be called with the s390irq lock held. Can be called
487  * disabled.
488  */
489 static void raw3215_make_room(struct raw3215_info *raw, unsigned int length)
490 {
491 	while (RAW3215_BUFFER_SIZE - raw->count < length) {
492 		/* While console is frozen for suspend we have no other
493 		 * choice but to drop message from the buffer to make
494 		 * room for even more messages. */
495 		if (raw->port.flags & ASYNC_SUSPENDED) {
496 			raw3215_drop_line(raw);
497 			continue;
498 		}
499 		/* there might be a request pending */
500 		raw->flags |= RAW3215_FLUSHING;
501 		raw3215_mk_write_req(raw);
502 		raw3215_try_io(raw);
503 		raw->flags &= ~RAW3215_FLUSHING;
504 #ifdef CONFIG_TN3215_CONSOLE
505 		ccw_device_wait_idle(raw->cdev);
506 #endif
507 		/* Enough room freed up ? */
508 		if (RAW3215_BUFFER_SIZE - raw->count >= length)
509 			break;
510 		/* there might be another cpu waiting for the lock */
511 		spin_unlock(get_ccwdev_lock(raw->cdev));
512 		udelay(100);
513 		spin_lock(get_ccwdev_lock(raw->cdev));
514 	}
515 }
516 
517 /*
518  * String write routine for 3215 devices
519  */
520 static void raw3215_write(struct raw3215_info *raw, const char *str,
521 			  unsigned int length)
522 {
523 	unsigned long flags;
524 	int c, count;
525 
526 	while (length > 0) {
527 		spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
528 		count = (length > RAW3215_BUFFER_SIZE) ?
529 					     RAW3215_BUFFER_SIZE : length;
530 		length -= count;
531 
532 		raw3215_make_room(raw, count);
533 
534 		/* copy string to output buffer and convert it to EBCDIC */
535 		while (1) {
536 			c = min_t(int, count,
537 				  min(RAW3215_BUFFER_SIZE - raw->count,
538 				      RAW3215_BUFFER_SIZE - raw->head));
539 			if (c <= 0)
540 				break;
541 			memcpy(raw->buffer + raw->head, str, c);
542 			ASCEBC(raw->buffer + raw->head, c);
543 			raw->head = (raw->head + c) & (RAW3215_BUFFER_SIZE - 1);
544 			raw->count += c;
545 			raw->line_pos += c;
546 			str += c;
547 			count -= c;
548 		}
549 		if (!(raw->flags & RAW3215_WORKING)) {
550 			raw3215_mk_write_req(raw);
551 			/* start or queue request */
552 			raw3215_try_io(raw);
553 		}
554 		spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
555 	}
556 }
557 
558 /*
559  * Put character routine for 3215 devices
560  */
561 static void raw3215_putchar(struct raw3215_info *raw, unsigned char ch)
562 {
563 	unsigned long flags;
564 	unsigned int length, i;
565 
566 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
567 	if (ch == '\t') {
568 		length = TAB_STOP_SIZE - (raw->line_pos%TAB_STOP_SIZE);
569 		raw->line_pos += length;
570 		ch = ' ';
571 	} else if (ch == '\n') {
572 		length = 1;
573 		raw->line_pos = 0;
574 	} else {
575 		length = 1;
576 		raw->line_pos++;
577 	}
578 	raw3215_make_room(raw, length);
579 
580 	for (i = 0; i < length; i++) {
581 		raw->buffer[raw->head] = (char) _ascebc[(int) ch];
582 		raw->head = (raw->head + 1) & (RAW3215_BUFFER_SIZE - 1);
583 		raw->count++;
584 	}
585 	if (!(raw->flags & RAW3215_WORKING)) {
586 		raw3215_mk_write_req(raw);
587 		/* start or queue request */
588 		raw3215_try_io(raw);
589 	}
590 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
591 }
592 
593 /*
594  * Flush routine, it simply sets the flush flag and tries to start
595  * pending IO.
596  */
597 static void raw3215_flush_buffer(struct raw3215_info *raw)
598 {
599 	unsigned long flags;
600 
601 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
602 	if (raw->count > 0) {
603 		raw->flags |= RAW3215_FLUSHING;
604 		raw3215_try_io(raw);
605 		raw->flags &= ~RAW3215_FLUSHING;
606 	}
607 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
608 }
609 
610 /*
611  * Fire up a 3215 device.
612  */
613 static int raw3215_startup(struct raw3215_info *raw)
614 {
615 	unsigned long flags;
616 
617 	if (raw->port.flags & ASYNC_INITIALIZED)
618 		return 0;
619 	raw->line_pos = 0;
620 	raw->port.flags |= ASYNC_INITIALIZED;
621 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
622 	raw3215_try_io(raw);
623 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
624 
625 	return 0;
626 }
627 
628 /*
629  * Shutdown a 3215 device.
630  */
631 static void raw3215_shutdown(struct raw3215_info *raw)
632 {
633 	DECLARE_WAITQUEUE(wait, current);
634 	unsigned long flags;
635 
636 	if (!(raw->port.flags & ASYNC_INITIALIZED) ||
637 	    (raw->flags & RAW3215_FIXED))
638 		return;
639 	/* Wait for outstanding requests, then free irq */
640 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
641 	if ((raw->flags & RAW3215_WORKING) ||
642 	    raw->queued_write != NULL ||
643 	    raw->queued_read != NULL) {
644 		raw->port.flags |= ASYNC_CLOSING;
645 		add_wait_queue(&raw->empty_wait, &wait);
646 		set_current_state(TASK_INTERRUPTIBLE);
647 		spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
648 		schedule();
649 		spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
650 		remove_wait_queue(&raw->empty_wait, &wait);
651 		set_current_state(TASK_RUNNING);
652 		raw->port.flags &= ~(ASYNC_INITIALIZED | ASYNC_CLOSING);
653 	}
654 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
655 }
656 
657 static struct raw3215_info *raw3215_alloc_info(void)
658 {
659 	struct raw3215_info *info;
660 
661 	info = kzalloc(sizeof(struct raw3215_info), GFP_KERNEL | GFP_DMA);
662 	if (!info)
663 		return NULL;
664 
665 	info->buffer = kzalloc(RAW3215_BUFFER_SIZE, GFP_KERNEL | GFP_DMA);
666 	info->inbuf = kzalloc(RAW3215_INBUF_SIZE, GFP_KERNEL | GFP_DMA);
667 	if (!info->buffer || !info->inbuf) {
668 		kfree(info);
669 		return NULL;
670 	}
671 
672 	setup_timer(&info->timer, raw3215_timeout, (unsigned long)info);
673 	init_waitqueue_head(&info->empty_wait);
674 	tasklet_init(&info->tlet, raw3215_wakeup, (unsigned long)info);
675 	tty_port_init(&info->port);
676 
677 	return info;
678 }
679 
680 static void raw3215_free_info(struct raw3215_info *raw)
681 {
682 	kfree(raw->inbuf);
683 	kfree(raw->buffer);
684 	tty_port_destroy(&raw->port);
685 	kfree(raw);
686 }
687 
688 static int raw3215_probe (struct ccw_device *cdev)
689 {
690 	struct raw3215_info *raw;
691 	int line;
692 
693 	/* Console is special. */
694 	if (raw3215[0] && (raw3215[0] == dev_get_drvdata(&cdev->dev)))
695 		return 0;
696 
697 	raw = raw3215_alloc_info();
698 	if (raw == NULL)
699 		return -ENOMEM;
700 
701 	raw->cdev = cdev;
702 	dev_set_drvdata(&cdev->dev, raw);
703 	cdev->handler = raw3215_irq;
704 
705 	spin_lock(&raw3215_device_lock);
706 	for (line = 0; line < NR_3215; line++) {
707 		if (!raw3215[line]) {
708 			raw3215[line] = raw;
709 			break;
710 		}
711 	}
712 	spin_unlock(&raw3215_device_lock);
713 	if (line == NR_3215) {
714 		raw3215_free_info(raw);
715 		return -ENODEV;
716 	}
717 
718 	return 0;
719 }
720 
721 static void raw3215_remove (struct ccw_device *cdev)
722 {
723 	struct raw3215_info *raw;
724 	unsigned int line;
725 
726 	ccw_device_set_offline(cdev);
727 	raw = dev_get_drvdata(&cdev->dev);
728 	if (raw) {
729 		spin_lock(&raw3215_device_lock);
730 		for (line = 0; line < NR_3215; line++)
731 			if (raw3215[line] == raw)
732 				break;
733 		raw3215[line] = NULL;
734 		spin_unlock(&raw3215_device_lock);
735 		dev_set_drvdata(&cdev->dev, NULL);
736 		raw3215_free_info(raw);
737 	}
738 }
739 
740 static int raw3215_set_online (struct ccw_device *cdev)
741 {
742 	struct raw3215_info *raw;
743 
744 	raw = dev_get_drvdata(&cdev->dev);
745 	if (!raw)
746 		return -ENODEV;
747 
748 	return raw3215_startup(raw);
749 }
750 
751 static int raw3215_set_offline (struct ccw_device *cdev)
752 {
753 	struct raw3215_info *raw;
754 
755 	raw = dev_get_drvdata(&cdev->dev);
756 	if (!raw)
757 		return -ENODEV;
758 
759 	raw3215_shutdown(raw);
760 
761 	return 0;
762 }
763 
764 static int raw3215_pm_stop(struct ccw_device *cdev)
765 {
766 	struct raw3215_info *raw;
767 	unsigned long flags;
768 
769 	/* Empty the output buffer, then prevent new I/O. */
770 	raw = dev_get_drvdata(&cdev->dev);
771 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
772 	raw3215_make_room(raw, RAW3215_BUFFER_SIZE);
773 	raw->port.flags |= ASYNC_SUSPENDED;
774 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
775 	return 0;
776 }
777 
778 static int raw3215_pm_start(struct ccw_device *cdev)
779 {
780 	struct raw3215_info *raw;
781 	unsigned long flags;
782 
783 	/* Allow I/O again and flush output buffer. */
784 	raw = dev_get_drvdata(&cdev->dev);
785 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
786 	raw->port.flags &= ~ASYNC_SUSPENDED;
787 	raw->flags |= RAW3215_FLUSHING;
788 	raw3215_try_io(raw);
789 	raw->flags &= ~RAW3215_FLUSHING;
790 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
791 	return 0;
792 }
793 
794 static struct ccw_device_id raw3215_id[] = {
795 	{ CCW_DEVICE(0x3215, 0) },
796 	{ /* end of list */ },
797 };
798 
799 static struct ccw_driver raw3215_ccw_driver = {
800 	.driver = {
801 		.name	= "3215",
802 		.owner	= THIS_MODULE,
803 	},
804 	.ids		= raw3215_id,
805 	.probe		= &raw3215_probe,
806 	.remove		= &raw3215_remove,
807 	.set_online	= &raw3215_set_online,
808 	.set_offline	= &raw3215_set_offline,
809 	.freeze		= &raw3215_pm_stop,
810 	.thaw		= &raw3215_pm_start,
811 	.restore	= &raw3215_pm_start,
812 	.int_class	= IRQIO_C15,
813 };
814 
815 #ifdef CONFIG_TN3215_CONSOLE
816 /*
817  * Write a string to the 3215 console
818  */
819 static void con3215_write(struct console *co, const char *str,
820 			  unsigned int count)
821 {
822 	struct raw3215_info *raw;
823 	int i;
824 
825 	if (count <= 0)
826 		return;
827 	raw = raw3215[0];	/* console 3215 is the first one */
828 	while (count > 0) {
829 		for (i = 0; i < count; i++)
830 			if (str[i] == '\t' || str[i] == '\n')
831 				break;
832 		raw3215_write(raw, str, i);
833 		count -= i;
834 		str += i;
835 		if (count > 0) {
836 			raw3215_putchar(raw, *str);
837 			count--;
838 			str++;
839 		}
840 	}
841 }
842 
843 static struct tty_driver *con3215_device(struct console *c, int *index)
844 {
845 	*index = c->index;
846 	return tty3215_driver;
847 }
848 
849 /*
850  * panic() calls con3215_flush through a panic_notifier
851  * before the system enters a disabled, endless loop.
852  */
853 static void con3215_flush(void)
854 {
855 	struct raw3215_info *raw;
856 	unsigned long flags;
857 
858 	raw = raw3215[0];  /* console 3215 is the first one */
859 	if (raw->port.flags & ASYNC_SUSPENDED)
860 		/* The console is still frozen for suspend. */
861 		if (ccw_device_force_console(raw->cdev))
862 			/* Forcing didn't work, no panic message .. */
863 			return;
864 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
865 	raw3215_make_room(raw, RAW3215_BUFFER_SIZE);
866 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
867 }
868 
869 static int con3215_notify(struct notifier_block *self,
870 			  unsigned long event, void *data)
871 {
872 	con3215_flush();
873 	return NOTIFY_OK;
874 }
875 
876 static struct notifier_block on_panic_nb = {
877 	.notifier_call = con3215_notify,
878 	.priority = 0,
879 };
880 
881 static struct notifier_block on_reboot_nb = {
882 	.notifier_call = con3215_notify,
883 	.priority = 0,
884 };
885 
886 /*
887  *  The console structure for the 3215 console
888  */
889 static struct console con3215 = {
890 	.name	 = "ttyS",
891 	.write	 = con3215_write,
892 	.device	 = con3215_device,
893 	.flags	 = CON_PRINTBUFFER,
894 };
895 
896 /*
897  * 3215 console initialization code called from console_init().
898  */
899 static int __init con3215_init(void)
900 {
901 	struct ccw_device *cdev;
902 	struct raw3215_info *raw;
903 	struct raw3215_req *req;
904 	int i;
905 
906 	/* Check if 3215 is to be the console */
907 	if (!CONSOLE_IS_3215)
908 		return -ENODEV;
909 
910 	/* Set the console mode for VM */
911 	if (MACHINE_IS_VM) {
912 		cpcmd("TERM CONMODE 3215", NULL, 0, NULL);
913 		cpcmd("TERM AUTOCR OFF", NULL, 0, NULL);
914 	}
915 
916 	/* allocate 3215 request structures */
917 	raw3215_freelist = NULL;
918 	spin_lock_init(&raw3215_freelist_lock);
919 	for (i = 0; i < NR_3215_REQ; i++) {
920 		req = kzalloc(sizeof(struct raw3215_req), GFP_KERNEL | GFP_DMA);
921 		req->next = raw3215_freelist;
922 		raw3215_freelist = req;
923 	}
924 
925 	cdev = ccw_device_probe_console();
926 	if (IS_ERR(cdev))
927 		return -ENODEV;
928 
929 	raw3215[0] = raw = raw3215_alloc_info();
930 	raw->cdev = cdev;
931 	dev_set_drvdata(&cdev->dev, raw);
932 	cdev->handler = raw3215_irq;
933 
934 	raw->flags |= RAW3215_FIXED;
935 
936 	/* Request the console irq */
937 	if (raw3215_startup(raw) != 0) {
938 		raw3215_free_info(raw);
939 		raw3215[0] = NULL;
940 		return -ENODEV;
941 	}
942 	atomic_notifier_chain_register(&panic_notifier_list, &on_panic_nb);
943 	register_reboot_notifier(&on_reboot_nb);
944 	register_console(&con3215);
945 	return 0;
946 }
947 console_initcall(con3215_init);
948 #endif
949 
950 static int tty3215_install(struct tty_driver *driver, struct tty_struct *tty)
951 {
952 	struct raw3215_info *raw;
953 
954 	raw = raw3215[tty->index];
955 	if (raw == NULL)
956 		return -ENODEV;
957 
958 	tty->driver_data = raw;
959 
960 	return tty_port_install(&raw->port, driver, tty);
961 }
962 
963 /*
964  * tty3215_open
965  *
966  * This routine is called whenever a 3215 tty is opened.
967  */
968 static int tty3215_open(struct tty_struct *tty, struct file * filp)
969 {
970 	struct raw3215_info *raw = tty->driver_data;
971 	int retval;
972 
973 	tty_port_tty_set(&raw->port, tty);
974 
975 	raw->port.low_latency = 0; /* don't use bottom half for pushing chars */
976 	/*
977 	 * Start up 3215 device
978 	 */
979 	retval = raw3215_startup(raw);
980 	if (retval)
981 		return retval;
982 
983 	return 0;
984 }
985 
986 /*
987  * tty3215_close()
988  *
989  * This routine is called when the 3215 tty is closed. We wait
990  * for the remaining request to be completed. Then we clean up.
991  */
992 static void tty3215_close(struct tty_struct *tty, struct file * filp)
993 {
994 	struct raw3215_info *raw;
995 
996 	raw = (struct raw3215_info *) tty->driver_data;
997 	if (raw == NULL || tty->count > 1)
998 		return;
999 	tty->closing = 1;
1000 	/* Shutdown the terminal */
1001 	raw3215_shutdown(raw);
1002 	tasklet_kill(&raw->tlet);
1003 	tty->closing = 0;
1004 	tty_port_tty_set(&raw->port, NULL);
1005 }
1006 
1007 /*
1008  * Returns the amount of free space in the output buffer.
1009  */
1010 static int tty3215_write_room(struct tty_struct *tty)
1011 {
1012 	struct raw3215_info *raw;
1013 
1014 	raw = (struct raw3215_info *) tty->driver_data;
1015 
1016 	/* Subtract TAB_STOP_SIZE to allow for a tab, 8 <<< 64K */
1017 	if ((RAW3215_BUFFER_SIZE - raw->count - TAB_STOP_SIZE) >= 0)
1018 		return RAW3215_BUFFER_SIZE - raw->count - TAB_STOP_SIZE;
1019 	else
1020 		return 0;
1021 }
1022 
1023 /*
1024  * String write routine for 3215 ttys
1025  */
1026 static int tty3215_write(struct tty_struct * tty,
1027 			 const unsigned char *buf, int count)
1028 {
1029 	struct raw3215_info *raw;
1030 
1031 	if (!tty)
1032 		return 0;
1033 	raw = (struct raw3215_info *) tty->driver_data;
1034 	raw3215_write(raw, buf, count);
1035 	return count;
1036 }
1037 
1038 /*
1039  * Put character routine for 3215 ttys
1040  */
1041 static int tty3215_put_char(struct tty_struct *tty, unsigned char ch)
1042 {
1043 	struct raw3215_info *raw;
1044 
1045 	if (!tty)
1046 		return 0;
1047 	raw = (struct raw3215_info *) tty->driver_data;
1048 	raw3215_putchar(raw, ch);
1049 	return 1;
1050 }
1051 
1052 static void tty3215_flush_chars(struct tty_struct *tty)
1053 {
1054 }
1055 
1056 /*
1057  * Returns the number of characters in the output buffer
1058  */
1059 static int tty3215_chars_in_buffer(struct tty_struct *tty)
1060 {
1061 	struct raw3215_info *raw;
1062 
1063 	raw = (struct raw3215_info *) tty->driver_data;
1064 	return raw->count;
1065 }
1066 
1067 static void tty3215_flush_buffer(struct tty_struct *tty)
1068 {
1069 	struct raw3215_info *raw;
1070 
1071 	raw = (struct raw3215_info *) tty->driver_data;
1072 	raw3215_flush_buffer(raw);
1073 	tty_wakeup(tty);
1074 }
1075 
1076 /*
1077  * Disable reading from a 3215 tty
1078  */
1079 static void tty3215_throttle(struct tty_struct * tty)
1080 {
1081 	struct raw3215_info *raw;
1082 
1083 	raw = (struct raw3215_info *) tty->driver_data;
1084 	raw->flags |= RAW3215_THROTTLED;
1085 }
1086 
1087 /*
1088  * Enable reading from a 3215 tty
1089  */
1090 static void tty3215_unthrottle(struct tty_struct * tty)
1091 {
1092 	struct raw3215_info *raw;
1093 	unsigned long flags;
1094 
1095 	raw = (struct raw3215_info *) tty->driver_data;
1096 	if (raw->flags & RAW3215_THROTTLED) {
1097 		spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
1098 		raw->flags &= ~RAW3215_THROTTLED;
1099 		raw3215_try_io(raw);
1100 		spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
1101 	}
1102 }
1103 
1104 /*
1105  * Disable writing to a 3215 tty
1106  */
1107 static void tty3215_stop(struct tty_struct *tty)
1108 {
1109 	struct raw3215_info *raw;
1110 
1111 	raw = (struct raw3215_info *) tty->driver_data;
1112 	raw->flags |= RAW3215_STOPPED;
1113 }
1114 
1115 /*
1116  * Enable writing to a 3215 tty
1117  */
1118 static void tty3215_start(struct tty_struct *tty)
1119 {
1120 	struct raw3215_info *raw;
1121 	unsigned long flags;
1122 
1123 	raw = (struct raw3215_info *) tty->driver_data;
1124 	if (raw->flags & RAW3215_STOPPED) {
1125 		spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
1126 		raw->flags &= ~RAW3215_STOPPED;
1127 		raw3215_try_io(raw);
1128 		spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
1129 	}
1130 }
1131 
1132 static const struct tty_operations tty3215_ops = {
1133 	.install = tty3215_install,
1134 	.open = tty3215_open,
1135 	.close = tty3215_close,
1136 	.write = tty3215_write,
1137 	.put_char = tty3215_put_char,
1138 	.flush_chars = tty3215_flush_chars,
1139 	.write_room = tty3215_write_room,
1140 	.chars_in_buffer = tty3215_chars_in_buffer,
1141 	.flush_buffer = tty3215_flush_buffer,
1142 	.throttle = tty3215_throttle,
1143 	.unthrottle = tty3215_unthrottle,
1144 	.stop = tty3215_stop,
1145 	.start = tty3215_start,
1146 };
1147 
1148 /*
1149  * 3215 tty registration code called from tty_init().
1150  * Most kernel services (incl. kmalloc) are available at this poimt.
1151  */
1152 static int __init tty3215_init(void)
1153 {
1154 	struct tty_driver *driver;
1155 	int ret;
1156 
1157 	if (!CONSOLE_IS_3215)
1158 		return 0;
1159 
1160 	driver = alloc_tty_driver(NR_3215);
1161 	if (!driver)
1162 		return -ENOMEM;
1163 
1164 	ret = ccw_driver_register(&raw3215_ccw_driver);
1165 	if (ret) {
1166 		put_tty_driver(driver);
1167 		return ret;
1168 	}
1169 	/*
1170 	 * Initialize the tty_driver structure
1171 	 * Entries in tty3215_driver that are NOT initialized:
1172 	 * proc_entry, set_termios, flush_buffer, set_ldisc, write_proc
1173 	 */
1174 
1175 	driver->driver_name = "tty3215";
1176 	driver->name = "ttyS";
1177 	driver->major = TTY_MAJOR;
1178 	driver->minor_start = 64;
1179 	driver->type = TTY_DRIVER_TYPE_SYSTEM;
1180 	driver->subtype = SYSTEM_TYPE_TTY;
1181 	driver->init_termios = tty_std_termios;
1182 	driver->init_termios.c_iflag = IGNBRK | IGNPAR;
1183 	driver->init_termios.c_oflag = ONLCR | XTABS;
1184 	driver->init_termios.c_lflag = ISIG;
1185 	driver->flags = TTY_DRIVER_REAL_RAW;
1186 	tty_set_operations(driver, &tty3215_ops);
1187 	ret = tty_register_driver(driver);
1188 	if (ret) {
1189 		put_tty_driver(driver);
1190 		return ret;
1191 	}
1192 	tty3215_driver = driver;
1193 	return 0;
1194 }
1195 
1196 static void __exit tty3215_exit(void)
1197 {
1198 	tty_unregister_driver(tty3215_driver);
1199 	put_tty_driver(tty3215_driver);
1200 	ccw_driver_unregister(&raw3215_ccw_driver);
1201 }
1202 
1203 module_init(tty3215_init);
1204 module_exit(tty3215_exit);
1205