xref: /openbmc/linux/drivers/s390/char/con3215.c (revision d0b73b48)
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(tty, cchar, TTY_NORMAL);
416 				tty_flip_buffer_push(tty);
417 				break;
418 
419 			case CTRLCHAR_NONE:
420 				if (count < 2 ||
421 				    (strncmp(raw->inbuf+count-2, "\252n", 2) &&
422 				     strncmp(raw->inbuf+count-2, "^n", 2)) ) {
423 					/* add the auto \n */
424 					raw->inbuf[count] = '\n';
425 					count++;
426 				} else
427 					count -= 2;
428 				tty_insert_flip_string(tty, raw->inbuf, count);
429 				tty_flip_buffer_push(tty);
430 				break;
431 			}
432 		} else if (req->type == RAW3215_WRITE) {
433 			raw->count -= req->len;
434 			raw->written -= req->len;
435 		}
436 		raw->flags &= ~RAW3215_WORKING;
437 		raw3215_free_req(req);
438 		/* check for empty wait */
439 		if (waitqueue_active(&raw->empty_wait) &&
440 		    raw->queued_write == NULL &&
441 		    raw->queued_read == NULL) {
442 			wake_up_interruptible(&raw->empty_wait);
443 		}
444 		raw3215_next_io(raw, tty);
445 		break;
446 	default:
447 		/* Strange interrupt, I'll do my best to clean up */
448 		if (req != NULL && req->type != RAW3215_FREE) {
449 			if (req->type == RAW3215_WRITE) {
450 				raw->count -= req->len;
451 				raw->written -= req->len;
452 			}
453 			raw->flags &= ~RAW3215_WORKING;
454 			raw3215_free_req(req);
455 		}
456 		raw3215_next_io(raw, tty);
457 	}
458 put_tty:
459 	tty_kref_put(tty);
460 }
461 
462 /*
463  * Drop the oldest line from the output buffer.
464  */
465 static void raw3215_drop_line(struct raw3215_info *raw)
466 {
467 	int ix;
468 	char ch;
469 
470 	BUG_ON(raw->written != 0);
471 	ix = (raw->head - raw->count) & (RAW3215_BUFFER_SIZE - 1);
472 	while (raw->count > 0) {
473 		ch = raw->buffer[ix];
474 		ix = (ix + 1) & (RAW3215_BUFFER_SIZE - 1);
475 		raw->count--;
476 		if (ch == 0x15)
477 			break;
478 	}
479 	raw->head = ix;
480 }
481 
482 /*
483  * Wait until length bytes are available int the output buffer.
484  * Has to be called with the s390irq lock held. Can be called
485  * disabled.
486  */
487 static void raw3215_make_room(struct raw3215_info *raw, unsigned int length)
488 {
489 	while (RAW3215_BUFFER_SIZE - raw->count < length) {
490 		/* While console is frozen for suspend we have no other
491 		 * choice but to drop message from the buffer to make
492 		 * room for even more messages. */
493 		if (raw->port.flags & ASYNC_SUSPENDED) {
494 			raw3215_drop_line(raw);
495 			continue;
496 		}
497 		/* there might be a request pending */
498 		raw->flags |= RAW3215_FLUSHING;
499 		raw3215_mk_write_req(raw);
500 		raw3215_try_io(raw);
501 		raw->flags &= ~RAW3215_FLUSHING;
502 #ifdef CONFIG_TN3215_CONSOLE
503 		wait_cons_dev();
504 #endif
505 		/* Enough room freed up ? */
506 		if (RAW3215_BUFFER_SIZE - raw->count >= length)
507 			break;
508 		/* there might be another cpu waiting for the lock */
509 		spin_unlock(get_ccwdev_lock(raw->cdev));
510 		udelay(100);
511 		spin_lock(get_ccwdev_lock(raw->cdev));
512 	}
513 }
514 
515 /*
516  * String write routine for 3215 devices
517  */
518 static void raw3215_write(struct raw3215_info *raw, const char *str,
519 			  unsigned int length)
520 {
521 	unsigned long flags;
522 	int c, count;
523 
524 	while (length > 0) {
525 		spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
526 		count = (length > RAW3215_BUFFER_SIZE) ?
527 					     RAW3215_BUFFER_SIZE : length;
528 		length -= count;
529 
530 		raw3215_make_room(raw, count);
531 
532 		/* copy string to output buffer and convert it to EBCDIC */
533 		while (1) {
534 			c = min_t(int, count,
535 				  min(RAW3215_BUFFER_SIZE - raw->count,
536 				      RAW3215_BUFFER_SIZE - raw->head));
537 			if (c <= 0)
538 				break;
539 			memcpy(raw->buffer + raw->head, str, c);
540 			ASCEBC(raw->buffer + raw->head, c);
541 			raw->head = (raw->head + c) & (RAW3215_BUFFER_SIZE - 1);
542 			raw->count += c;
543 			raw->line_pos += c;
544 			str += c;
545 			count -= c;
546 		}
547 		if (!(raw->flags & RAW3215_WORKING)) {
548 			raw3215_mk_write_req(raw);
549 			/* start or queue request */
550 			raw3215_try_io(raw);
551 		}
552 		spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
553 	}
554 }
555 
556 /*
557  * Put character routine for 3215 devices
558  */
559 static void raw3215_putchar(struct raw3215_info *raw, unsigned char ch)
560 {
561 	unsigned long flags;
562 	unsigned int length, i;
563 
564 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
565 	if (ch == '\t') {
566 		length = TAB_STOP_SIZE - (raw->line_pos%TAB_STOP_SIZE);
567 		raw->line_pos += length;
568 		ch = ' ';
569 	} else if (ch == '\n') {
570 		length = 1;
571 		raw->line_pos = 0;
572 	} else {
573 		length = 1;
574 		raw->line_pos++;
575 	}
576 	raw3215_make_room(raw, length);
577 
578 	for (i = 0; i < length; i++) {
579 		raw->buffer[raw->head] = (char) _ascebc[(int) ch];
580 		raw->head = (raw->head + 1) & (RAW3215_BUFFER_SIZE - 1);
581 		raw->count++;
582 	}
583 	if (!(raw->flags & RAW3215_WORKING)) {
584 		raw3215_mk_write_req(raw);
585 		/* start or queue request */
586 		raw3215_try_io(raw);
587 	}
588 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
589 }
590 
591 /*
592  * Flush routine, it simply sets the flush flag and tries to start
593  * pending IO.
594  */
595 static void raw3215_flush_buffer(struct raw3215_info *raw)
596 {
597 	unsigned long flags;
598 
599 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
600 	if (raw->count > 0) {
601 		raw->flags |= RAW3215_FLUSHING;
602 		raw3215_try_io(raw);
603 		raw->flags &= ~RAW3215_FLUSHING;
604 	}
605 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
606 }
607 
608 /*
609  * Fire up a 3215 device.
610  */
611 static int raw3215_startup(struct raw3215_info *raw)
612 {
613 	unsigned long flags;
614 
615 	if (raw->port.flags & ASYNC_INITIALIZED)
616 		return 0;
617 	raw->line_pos = 0;
618 	raw->port.flags |= ASYNC_INITIALIZED;
619 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
620 	raw3215_try_io(raw);
621 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
622 
623 	return 0;
624 }
625 
626 /*
627  * Shutdown a 3215 device.
628  */
629 static void raw3215_shutdown(struct raw3215_info *raw)
630 {
631 	DECLARE_WAITQUEUE(wait, current);
632 	unsigned long flags;
633 
634 	if (!(raw->port.flags & ASYNC_INITIALIZED) ||
635 	    (raw->flags & RAW3215_FIXED))
636 		return;
637 	/* Wait for outstanding requests, then free irq */
638 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
639 	if ((raw->flags & RAW3215_WORKING) ||
640 	    raw->queued_write != NULL ||
641 	    raw->queued_read != NULL) {
642 		raw->port.flags |= ASYNC_CLOSING;
643 		add_wait_queue(&raw->empty_wait, &wait);
644 		set_current_state(TASK_INTERRUPTIBLE);
645 		spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
646 		schedule();
647 		spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
648 		remove_wait_queue(&raw->empty_wait, &wait);
649 		set_current_state(TASK_RUNNING);
650 		raw->port.flags &= ~(ASYNC_INITIALIZED | ASYNC_CLOSING);
651 	}
652 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
653 }
654 
655 static struct raw3215_info *raw3215_alloc_info(void)
656 {
657 	struct raw3215_info *info;
658 
659 	info = kzalloc(sizeof(struct raw3215_info), GFP_KERNEL | GFP_DMA);
660 	if (!info)
661 		return NULL;
662 
663 	info->buffer = kzalloc(RAW3215_BUFFER_SIZE, GFP_KERNEL | GFP_DMA);
664 	info->inbuf = kzalloc(RAW3215_INBUF_SIZE, GFP_KERNEL | GFP_DMA);
665 	if (!info->buffer || !info->inbuf) {
666 		kfree(info);
667 		return NULL;
668 	}
669 
670 	setup_timer(&info->timer, raw3215_timeout, (unsigned long)info);
671 	init_waitqueue_head(&info->empty_wait);
672 	tasklet_init(&info->tlet, raw3215_wakeup, (unsigned long)info);
673 	tty_port_init(&info->port);
674 
675 	return info;
676 }
677 
678 static void raw3215_free_info(struct raw3215_info *raw)
679 {
680 	kfree(raw->inbuf);
681 	kfree(raw->buffer);
682 	tty_port_destroy(&raw->port);
683 	kfree(raw);
684 }
685 
686 static int raw3215_probe (struct ccw_device *cdev)
687 {
688 	struct raw3215_info *raw;
689 	int line;
690 
691 	/* Console is special. */
692 	if (raw3215[0] && (raw3215[0] == dev_get_drvdata(&cdev->dev)))
693 		return 0;
694 
695 	raw = raw3215_alloc_info();
696 	if (raw == NULL)
697 		return -ENOMEM;
698 
699 	raw->cdev = cdev;
700 	dev_set_drvdata(&cdev->dev, raw);
701 	cdev->handler = raw3215_irq;
702 
703 	spin_lock(&raw3215_device_lock);
704 	for (line = 0; line < NR_3215; line++) {
705 		if (!raw3215[line]) {
706 			raw3215[line] = raw;
707 			break;
708 		}
709 	}
710 	spin_unlock(&raw3215_device_lock);
711 	if (line == NR_3215) {
712 		raw3215_free_info(raw);
713 		return -ENODEV;
714 	}
715 
716 	return 0;
717 }
718 
719 static void raw3215_remove (struct ccw_device *cdev)
720 {
721 	struct raw3215_info *raw;
722 	unsigned int line;
723 
724 	ccw_device_set_offline(cdev);
725 	raw = dev_get_drvdata(&cdev->dev);
726 	if (raw) {
727 		spin_lock(&raw3215_device_lock);
728 		for (line = 0; line < NR_3215; line++)
729 			if (raw3215[line] == raw)
730 				break;
731 		raw3215[line] = NULL;
732 		spin_unlock(&raw3215_device_lock);
733 		dev_set_drvdata(&cdev->dev, NULL);
734 		raw3215_free_info(raw);
735 	}
736 }
737 
738 static int raw3215_set_online (struct ccw_device *cdev)
739 {
740 	struct raw3215_info *raw;
741 
742 	raw = dev_get_drvdata(&cdev->dev);
743 	if (!raw)
744 		return -ENODEV;
745 
746 	return raw3215_startup(raw);
747 }
748 
749 static int raw3215_set_offline (struct ccw_device *cdev)
750 {
751 	struct raw3215_info *raw;
752 
753 	raw = dev_get_drvdata(&cdev->dev);
754 	if (!raw)
755 		return -ENODEV;
756 
757 	raw3215_shutdown(raw);
758 
759 	return 0;
760 }
761 
762 static int raw3215_pm_stop(struct ccw_device *cdev)
763 {
764 	struct raw3215_info *raw;
765 	unsigned long flags;
766 
767 	/* Empty the output buffer, then prevent new I/O. */
768 	raw = dev_get_drvdata(&cdev->dev);
769 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
770 	raw3215_make_room(raw, RAW3215_BUFFER_SIZE);
771 	raw->port.flags |= ASYNC_SUSPENDED;
772 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
773 	return 0;
774 }
775 
776 static int raw3215_pm_start(struct ccw_device *cdev)
777 {
778 	struct raw3215_info *raw;
779 	unsigned long flags;
780 
781 	/* Allow I/O again and flush output buffer. */
782 	raw = dev_get_drvdata(&cdev->dev);
783 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
784 	raw->port.flags &= ~ASYNC_SUSPENDED;
785 	raw->flags |= RAW3215_FLUSHING;
786 	raw3215_try_io(raw);
787 	raw->flags &= ~RAW3215_FLUSHING;
788 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
789 	return 0;
790 }
791 
792 static struct ccw_device_id raw3215_id[] = {
793 	{ CCW_DEVICE(0x3215, 0) },
794 	{ /* end of list */ },
795 };
796 
797 static struct ccw_driver raw3215_ccw_driver = {
798 	.driver = {
799 		.name	= "3215",
800 		.owner	= THIS_MODULE,
801 	},
802 	.ids		= raw3215_id,
803 	.probe		= &raw3215_probe,
804 	.remove		= &raw3215_remove,
805 	.set_online	= &raw3215_set_online,
806 	.set_offline	= &raw3215_set_offline,
807 	.freeze		= &raw3215_pm_stop,
808 	.thaw		= &raw3215_pm_start,
809 	.restore	= &raw3215_pm_start,
810 	.int_class	= IRQIO_C15,
811 };
812 
813 #ifdef CONFIG_TN3215_CONSOLE
814 /*
815  * Write a string to the 3215 console
816  */
817 static void con3215_write(struct console *co, const char *str,
818 			  unsigned int count)
819 {
820 	struct raw3215_info *raw;
821 	int i;
822 
823 	if (count <= 0)
824 		return;
825 	raw = raw3215[0];	/* console 3215 is the first one */
826 	while (count > 0) {
827 		for (i = 0; i < count; i++)
828 			if (str[i] == '\t' || str[i] == '\n')
829 				break;
830 		raw3215_write(raw, str, i);
831 		count -= i;
832 		str += i;
833 		if (count > 0) {
834 			raw3215_putchar(raw, *str);
835 			count--;
836 			str++;
837 		}
838 	}
839 }
840 
841 static struct tty_driver *con3215_device(struct console *c, int *index)
842 {
843 	*index = c->index;
844 	return tty3215_driver;
845 }
846 
847 /*
848  * panic() calls con3215_flush through a panic_notifier
849  * before the system enters a disabled, endless loop.
850  */
851 static void con3215_flush(void)
852 {
853 	struct raw3215_info *raw;
854 	unsigned long flags;
855 
856 	raw = raw3215[0];  /* console 3215 is the first one */
857 	if (raw->port.flags & ASYNC_SUSPENDED)
858 		/* The console is still frozen for suspend. */
859 		if (ccw_device_force_console())
860 			/* Forcing didn't work, no panic message .. */
861 			return;
862 	spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
863 	raw3215_make_room(raw, RAW3215_BUFFER_SIZE);
864 	spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
865 }
866 
867 static int con3215_notify(struct notifier_block *self,
868 			  unsigned long event, void *data)
869 {
870 	con3215_flush();
871 	return NOTIFY_OK;
872 }
873 
874 static struct notifier_block on_panic_nb = {
875 	.notifier_call = con3215_notify,
876 	.priority = 0,
877 };
878 
879 static struct notifier_block on_reboot_nb = {
880 	.notifier_call = con3215_notify,
881 	.priority = 0,
882 };
883 
884 /*
885  *  The console structure for the 3215 console
886  */
887 static struct console con3215 = {
888 	.name	 = "ttyS",
889 	.write	 = con3215_write,
890 	.device	 = con3215_device,
891 	.flags	 = CON_PRINTBUFFER,
892 };
893 
894 /*
895  * 3215 console initialization code called from console_init().
896  */
897 static int __init con3215_init(void)
898 {
899 	struct ccw_device *cdev;
900 	struct raw3215_info *raw;
901 	struct raw3215_req *req;
902 	int i;
903 
904 	/* Check if 3215 is to be the console */
905 	if (!CONSOLE_IS_3215)
906 		return -ENODEV;
907 
908 	/* Set the console mode for VM */
909 	if (MACHINE_IS_VM) {
910 		cpcmd("TERM CONMODE 3215", NULL, 0, NULL);
911 		cpcmd("TERM AUTOCR OFF", NULL, 0, NULL);
912 	}
913 
914 	/* allocate 3215 request structures */
915 	raw3215_freelist = NULL;
916 	spin_lock_init(&raw3215_freelist_lock);
917 	for (i = 0; i < NR_3215_REQ; i++) {
918 		req = kzalloc(sizeof(struct raw3215_req), GFP_KERNEL | GFP_DMA);
919 		req->next = raw3215_freelist;
920 		raw3215_freelist = req;
921 	}
922 
923 	cdev = ccw_device_probe_console();
924 	if (IS_ERR(cdev))
925 		return -ENODEV;
926 
927 	raw3215[0] = raw = raw3215_alloc_info();
928 	raw->cdev = cdev;
929 	dev_set_drvdata(&cdev->dev, raw);
930 	cdev->handler = raw3215_irq;
931 
932 	raw->flags |= RAW3215_FIXED;
933 
934 	/* Request the console irq */
935 	if (raw3215_startup(raw) != 0) {
936 		raw3215_free_info(raw);
937 		raw3215[0] = NULL;
938 		return -ENODEV;
939 	}
940 	atomic_notifier_chain_register(&panic_notifier_list, &on_panic_nb);
941 	register_reboot_notifier(&on_reboot_nb);
942 	register_console(&con3215);
943 	return 0;
944 }
945 console_initcall(con3215_init);
946 #endif
947 
948 static int tty3215_install(struct tty_driver *driver, struct tty_struct *tty)
949 {
950 	struct raw3215_info *raw;
951 
952 	raw = raw3215[tty->index];
953 	if (raw == NULL)
954 		return -ENODEV;
955 
956 	tty->driver_data = raw;
957 
958 	return tty_port_install(&raw->port, driver, tty);
959 }
960 
961 /*
962  * tty3215_open
963  *
964  * This routine is called whenever a 3215 tty is opened.
965  */
966 static int tty3215_open(struct tty_struct *tty, struct file * filp)
967 {
968 	struct raw3215_info *raw = tty->driver_data;
969 	int retval;
970 
971 	tty_port_tty_set(&raw->port, tty);
972 
973 	tty->low_latency = 0;  /* don't use bottom half for pushing chars */
974 	/*
975 	 * Start up 3215 device
976 	 */
977 	retval = raw3215_startup(raw);
978 	if (retval)
979 		return retval;
980 
981 	return 0;
982 }
983 
984 /*
985  * tty3215_close()
986  *
987  * This routine is called when the 3215 tty is closed. We wait
988  * for the remaining request to be completed. Then we clean up.
989  */
990 static void tty3215_close(struct tty_struct *tty, struct file * filp)
991 {
992 	struct raw3215_info *raw;
993 
994 	raw = (struct raw3215_info *) tty->driver_data;
995 	if (raw == NULL || tty->count > 1)
996 		return;
997 	tty->closing = 1;
998 	/* Shutdown the terminal */
999 	raw3215_shutdown(raw);
1000 	tasklet_kill(&raw->tlet);
1001 	tty->closing = 0;
1002 	tty_port_tty_set(&raw->port, NULL);
1003 }
1004 
1005 /*
1006  * Returns the amount of free space in the output buffer.
1007  */
1008 static int tty3215_write_room(struct tty_struct *tty)
1009 {
1010 	struct raw3215_info *raw;
1011 
1012 	raw = (struct raw3215_info *) tty->driver_data;
1013 
1014 	/* Subtract TAB_STOP_SIZE to allow for a tab, 8 <<< 64K */
1015 	if ((RAW3215_BUFFER_SIZE - raw->count - TAB_STOP_SIZE) >= 0)
1016 		return RAW3215_BUFFER_SIZE - raw->count - TAB_STOP_SIZE;
1017 	else
1018 		return 0;
1019 }
1020 
1021 /*
1022  * String write routine for 3215 ttys
1023  */
1024 static int tty3215_write(struct tty_struct * tty,
1025 			 const unsigned char *buf, int count)
1026 {
1027 	struct raw3215_info *raw;
1028 
1029 	if (!tty)
1030 		return 0;
1031 	raw = (struct raw3215_info *) tty->driver_data;
1032 	raw3215_write(raw, buf, count);
1033 	return count;
1034 }
1035 
1036 /*
1037  * Put character routine for 3215 ttys
1038  */
1039 static int tty3215_put_char(struct tty_struct *tty, unsigned char ch)
1040 {
1041 	struct raw3215_info *raw;
1042 
1043 	if (!tty)
1044 		return 0;
1045 	raw = (struct raw3215_info *) tty->driver_data;
1046 	raw3215_putchar(raw, ch);
1047 	return 1;
1048 }
1049 
1050 static void tty3215_flush_chars(struct tty_struct *tty)
1051 {
1052 }
1053 
1054 /*
1055  * Returns the number of characters in the output buffer
1056  */
1057 static int tty3215_chars_in_buffer(struct tty_struct *tty)
1058 {
1059 	struct raw3215_info *raw;
1060 
1061 	raw = (struct raw3215_info *) tty->driver_data;
1062 	return raw->count;
1063 }
1064 
1065 static void tty3215_flush_buffer(struct tty_struct *tty)
1066 {
1067 	struct raw3215_info *raw;
1068 
1069 	raw = (struct raw3215_info *) tty->driver_data;
1070 	raw3215_flush_buffer(raw);
1071 	tty_wakeup(tty);
1072 }
1073 
1074 /*
1075  * Disable reading from a 3215 tty
1076  */
1077 static void tty3215_throttle(struct tty_struct * tty)
1078 {
1079 	struct raw3215_info *raw;
1080 
1081 	raw = (struct raw3215_info *) tty->driver_data;
1082 	raw->flags |= RAW3215_THROTTLED;
1083 }
1084 
1085 /*
1086  * Enable reading from a 3215 tty
1087  */
1088 static void tty3215_unthrottle(struct tty_struct * tty)
1089 {
1090 	struct raw3215_info *raw;
1091 	unsigned long flags;
1092 
1093 	raw = (struct raw3215_info *) tty->driver_data;
1094 	if (raw->flags & RAW3215_THROTTLED) {
1095 		spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
1096 		raw->flags &= ~RAW3215_THROTTLED;
1097 		raw3215_try_io(raw);
1098 		spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
1099 	}
1100 }
1101 
1102 /*
1103  * Disable writing to a 3215 tty
1104  */
1105 static void tty3215_stop(struct tty_struct *tty)
1106 {
1107 	struct raw3215_info *raw;
1108 
1109 	raw = (struct raw3215_info *) tty->driver_data;
1110 	raw->flags |= RAW3215_STOPPED;
1111 }
1112 
1113 /*
1114  * Enable writing to a 3215 tty
1115  */
1116 static void tty3215_start(struct tty_struct *tty)
1117 {
1118 	struct raw3215_info *raw;
1119 	unsigned long flags;
1120 
1121 	raw = (struct raw3215_info *) tty->driver_data;
1122 	if (raw->flags & RAW3215_STOPPED) {
1123 		spin_lock_irqsave(get_ccwdev_lock(raw->cdev), flags);
1124 		raw->flags &= ~RAW3215_STOPPED;
1125 		raw3215_try_io(raw);
1126 		spin_unlock_irqrestore(get_ccwdev_lock(raw->cdev), flags);
1127 	}
1128 }
1129 
1130 static const struct tty_operations tty3215_ops = {
1131 	.install = tty3215_install,
1132 	.open = tty3215_open,
1133 	.close = tty3215_close,
1134 	.write = tty3215_write,
1135 	.put_char = tty3215_put_char,
1136 	.flush_chars = tty3215_flush_chars,
1137 	.write_room = tty3215_write_room,
1138 	.chars_in_buffer = tty3215_chars_in_buffer,
1139 	.flush_buffer = tty3215_flush_buffer,
1140 	.throttle = tty3215_throttle,
1141 	.unthrottle = tty3215_unthrottle,
1142 	.stop = tty3215_stop,
1143 	.start = tty3215_start,
1144 };
1145 
1146 /*
1147  * 3215 tty registration code called from tty_init().
1148  * Most kernel services (incl. kmalloc) are available at this poimt.
1149  */
1150 static int __init tty3215_init(void)
1151 {
1152 	struct tty_driver *driver;
1153 	int ret;
1154 
1155 	if (!CONSOLE_IS_3215)
1156 		return 0;
1157 
1158 	driver = alloc_tty_driver(NR_3215);
1159 	if (!driver)
1160 		return -ENOMEM;
1161 
1162 	ret = ccw_driver_register(&raw3215_ccw_driver);
1163 	if (ret) {
1164 		put_tty_driver(driver);
1165 		return ret;
1166 	}
1167 	/*
1168 	 * Initialize the tty_driver structure
1169 	 * Entries in tty3215_driver that are NOT initialized:
1170 	 * proc_entry, set_termios, flush_buffer, set_ldisc, write_proc
1171 	 */
1172 
1173 	driver->driver_name = "tty3215";
1174 	driver->name = "ttyS";
1175 	driver->major = TTY_MAJOR;
1176 	driver->minor_start = 64;
1177 	driver->type = TTY_DRIVER_TYPE_SYSTEM;
1178 	driver->subtype = SYSTEM_TYPE_TTY;
1179 	driver->init_termios = tty_std_termios;
1180 	driver->init_termios.c_iflag = IGNBRK | IGNPAR;
1181 	driver->init_termios.c_oflag = ONLCR | XTABS;
1182 	driver->init_termios.c_lflag = ISIG;
1183 	driver->flags = TTY_DRIVER_REAL_RAW;
1184 	tty_set_operations(driver, &tty3215_ops);
1185 	ret = tty_register_driver(driver);
1186 	if (ret) {
1187 		put_tty_driver(driver);
1188 		return ret;
1189 	}
1190 	tty3215_driver = driver;
1191 	return 0;
1192 }
1193 
1194 static void __exit tty3215_exit(void)
1195 {
1196 	tty_unregister_driver(tty3215_driver);
1197 	put_tty_driver(tty3215_driver);
1198 	ccw_driver_unregister(&raw3215_ccw_driver);
1199 }
1200 
1201 module_init(tty3215_init);
1202 module_exit(tty3215_exit);
1203