2 * drivers/s390/char/sclp_vt220.c
3 * SCLP VT220 terminal driver.
6 * Copyright (C) 2003 IBM Deutschland Entwicklung GmbH, IBM Corporation
7 * Author(s): Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com>
10 #include <linux/module.h>
11 #include <linux/spinlock.h>
12 #include <linux/list.h>
13 #include <linux/wait.h>
14 #include <linux/timer.h>
15 #include <linux/kernel.h>
16 #include <linux/tty.h>
17 #include <linux/tty_driver.h>
18 #include <linux/tty_flip.h>
19 #include <linux/sched.h>
20 #include <linux/errno.h>
22 #include <linux/major.h>
23 #include <linux/console.h>
24 #include <linux/kdev_t.h>
25 #include <linux/bootmem.h>
26 #include <linux/interrupt.h>
27 #include <linux/init.h>
28 #include <asm/uaccess.h>
31 #define SCLP_VT220_PRINT_HEADER "sclp vt220 tty driver: "
32 #define SCLP_VT220_MAJOR TTY_MAJOR
33 #define SCLP_VT220_MINOR 65
34 #define SCLP_VT220_DRIVER_NAME "sclp_vt220"
35 #define SCLP_VT220_DEVICE_NAME "ttysclp"
36 #define SCLP_VT220_CONSOLE_NAME "ttyS"
37 #define SCLP_VT220_CONSOLE_INDEX 1 /* console=ttyS1 */
38 #define SCLP_VT220_BUF_SIZE 80
40 /* Representation of a single write request */
41 struct sclp_vt220_request {
42 struct list_head list;
43 struct sclp_req sclp_req;
48 struct sclp_vt220_sccb {
49 struct sccb_header header;
50 struct evbuf_header evbuf;
53 #define SCLP_VT220_MAX_CHARS_PER_BUFFER (PAGE_SIZE - \
54 sizeof(struct sclp_vt220_request) - \
55 sizeof(struct sclp_vt220_sccb))
57 /* Structures and data needed to register tty driver */
58 static struct tty_driver *sclp_vt220_driver;
60 /* The tty_struct that the kernel associated with us */
61 static struct tty_struct *sclp_vt220_tty;
63 /* Lock to protect internal data from concurrent access */
64 static spinlock_t sclp_vt220_lock;
66 /* List of empty pages to be used as write request buffers */
67 static struct list_head sclp_vt220_empty;
69 /* List of pending requests */
70 static struct list_head sclp_vt220_outqueue;
72 /* Number of requests in outqueue */
73 static int sclp_vt220_outqueue_count;
75 /* Wait queue used to delay write requests while we've run out of buffers */
76 static wait_queue_head_t sclp_vt220_waitq;
78 /* Timer used for delaying write requests to merge subsequent messages into
80 static struct timer_list sclp_vt220_timer;
82 /* Pointer to current request buffer which has been partially filled but not
84 static struct sclp_vt220_request *sclp_vt220_current_request;
86 /* Number of characters in current request buffer */
87 static int sclp_vt220_buffered_chars;
89 /* Flag indicating whether this driver has already been initialized */
90 static int sclp_vt220_initialized = 0;
92 /* Flag indicating that sclp_vt220_current_request should really
93 * have been already queued but wasn't because the SCLP was processing
95 static int sclp_vt220_flush_later;
97 static void sclp_vt220_receiver_fn(struct evbuf_header *evbuf);
98 static int __sclp_vt220_emit(struct sclp_vt220_request *request);
99 static void sclp_vt220_emit_current(void);
101 /* Registration structure for our interest in SCLP event buffers */
102 static struct sclp_register sclp_vt220_register = {
103 .send_mask = EvTyp_VT220Msg_Mask,
104 .receive_mask = EvTyp_VT220Msg_Mask,
105 .state_change_fn = NULL,
106 .receiver_fn = sclp_vt220_receiver_fn
111 * Put provided request buffer back into queue and check emit pending
112 * buffers if necessary.
115 sclp_vt220_process_queue(struct sclp_vt220_request *request)
121 /* Put buffer back to list of empty buffers */
122 page = request->sclp_req.sccb;
123 spin_lock_irqsave(&sclp_vt220_lock, flags);
124 /* Move request from outqueue to empty queue */
125 list_del(&request->list);
126 sclp_vt220_outqueue_count--;
127 list_add_tail((struct list_head *) page, &sclp_vt220_empty);
128 /* Check if there is a pending buffer on the out queue. */
130 if (!list_empty(&sclp_vt220_outqueue))
131 request = list_entry(sclp_vt220_outqueue.next,
132 struct sclp_vt220_request, list);
133 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
134 } while (request && __sclp_vt220_emit(request));
135 if (request == NULL && sclp_vt220_flush_later)
136 sclp_vt220_emit_current();
137 wake_up(&sclp_vt220_waitq);
138 /* Check if the tty needs a wake up call */
139 if (sclp_vt220_tty != NULL) {
140 tty_wakeup(sclp_vt220_tty);
144 #define SCLP_BUFFER_MAX_RETRY 1
147 * Callback through which the result of a write request is reported by the
151 sclp_vt220_callback(struct sclp_req *request, void *data)
153 struct sclp_vt220_request *vt220_request;
154 struct sclp_vt220_sccb *sccb;
156 vt220_request = (struct sclp_vt220_request *) data;
157 if (request->status == SCLP_REQ_FAILED) {
158 sclp_vt220_process_queue(vt220_request);
161 sccb = (struct sclp_vt220_sccb *) vt220_request->sclp_req.sccb;
163 /* Check SCLP response code and choose suitable action */
164 switch (sccb->header.response_code) {
168 case 0x05f0: /* Target resource in improper state */
171 case 0x0340: /* Contained SCLP equipment check */
172 if (++vt220_request->retry_count > SCLP_BUFFER_MAX_RETRY)
174 /* Remove processed buffers and requeue rest */
175 if (sclp_remove_processed((struct sccb_header *) sccb) > 0) {
176 /* Not all buffers were processed */
177 sccb->header.response_code = 0x0000;
178 vt220_request->sclp_req.status = SCLP_REQ_FILLED;
179 if (sclp_add_request(request) == 0)
184 case 0x0040: /* SCLP equipment check */
185 if (++vt220_request->retry_count > SCLP_BUFFER_MAX_RETRY)
187 sccb->header.response_code = 0x0000;
188 vt220_request->sclp_req.status = SCLP_REQ_FILLED;
189 if (sclp_add_request(request) == 0)
196 sclp_vt220_process_queue(vt220_request);
200 * Emit vt220 request buffer to SCLP. Return zero on success, non-zero
204 __sclp_vt220_emit(struct sclp_vt220_request *request)
206 if (!(sclp_vt220_register.sclp_send_mask & EvTyp_VT220Msg_Mask)) {
207 request->sclp_req.status = SCLP_REQ_FAILED;
210 request->sclp_req.command = SCLP_CMDW_WRITEDATA;
211 request->sclp_req.status = SCLP_REQ_FILLED;
212 request->sclp_req.callback = sclp_vt220_callback;
213 request->sclp_req.callback_data = (void *) request;
215 return sclp_add_request(&request->sclp_req);
219 * Queue and emit given request.
222 sclp_vt220_emit(struct sclp_vt220_request *request)
227 spin_lock_irqsave(&sclp_vt220_lock, flags);
228 list_add_tail(&request->list, &sclp_vt220_outqueue);
229 count = sclp_vt220_outqueue_count++;
230 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
231 /* Emit only the first buffer immediately - callback takes care of
233 if (count == 0 && __sclp_vt220_emit(request))
234 sclp_vt220_process_queue(request);
238 * Queue and emit current request. Return zero on success, non-zero otherwise.
241 sclp_vt220_emit_current(void)
244 struct sclp_vt220_request *request;
245 struct sclp_vt220_sccb *sccb;
247 spin_lock_irqsave(&sclp_vt220_lock, flags);
249 if (sclp_vt220_current_request != NULL) {
250 sccb = (struct sclp_vt220_sccb *)
251 sclp_vt220_current_request->sclp_req.sccb;
252 /* Only emit buffers with content */
253 if (sccb->header.length != sizeof(struct sclp_vt220_sccb)) {
254 request = sclp_vt220_current_request;
255 sclp_vt220_current_request = NULL;
256 if (timer_pending(&sclp_vt220_timer))
257 del_timer(&sclp_vt220_timer);
259 sclp_vt220_flush_later = 0;
261 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
263 sclp_vt220_emit(request);
266 #define SCLP_NORMAL_WRITE 0x00
269 * Helper function to initialize a page with the sclp request structure.
271 static struct sclp_vt220_request *
272 sclp_vt220_initialize_page(void *page)
274 struct sclp_vt220_request *request;
275 struct sclp_vt220_sccb *sccb;
277 /* Place request structure at end of page */
278 request = ((struct sclp_vt220_request *)
279 ((addr_t) page + PAGE_SIZE)) - 1;
280 request->retry_count = 0;
281 request->sclp_req.sccb = page;
282 /* SCCB goes at start of page */
283 sccb = (struct sclp_vt220_sccb *) page;
284 memset((void *) sccb, 0, sizeof(struct sclp_vt220_sccb));
285 sccb->header.length = sizeof(struct sclp_vt220_sccb);
286 sccb->header.function_code = SCLP_NORMAL_WRITE;
287 sccb->header.response_code = 0x0000;
288 sccb->evbuf.type = EvTyp_VT220Msg;
289 sccb->evbuf.length = sizeof(struct evbuf_header);
294 static inline unsigned int
295 sclp_vt220_space_left(struct sclp_vt220_request *request)
297 struct sclp_vt220_sccb *sccb;
298 sccb = (struct sclp_vt220_sccb *) request->sclp_req.sccb;
299 return PAGE_SIZE - sizeof(struct sclp_vt220_request) -
303 static inline unsigned int
304 sclp_vt220_chars_stored(struct sclp_vt220_request *request)
306 struct sclp_vt220_sccb *sccb;
307 sccb = (struct sclp_vt220_sccb *) request->sclp_req.sccb;
308 return sccb->evbuf.length - sizeof(struct evbuf_header);
312 * Add msg to buffer associated with request. Return the number of characters
316 sclp_vt220_add_msg(struct sclp_vt220_request *request,
317 const unsigned char *msg, int count, int convertlf)
319 struct sclp_vt220_sccb *sccb;
325 if (count > sclp_vt220_space_left(request))
326 count = sclp_vt220_space_left(request);
330 sccb = (struct sclp_vt220_sccb *) request->sclp_req.sccb;
331 buffer = (void *) ((addr_t) sccb + sccb->header.length);
334 /* Perform Linefeed conversion (0x0a -> 0x0a 0x0d)*/
336 (from < count) && (to < sclp_vt220_space_left(request));
338 /* Retrieve character */
340 /* Perform conversion */
342 if (to + 1 < sclp_vt220_space_left(request)) {
343 ((unsigned char *) buffer)[to++] = c;
344 ((unsigned char *) buffer)[to++] = 0x0d;
349 ((unsigned char *) buffer)[to++] = c;
351 sccb->header.length += to;
352 sccb->evbuf.length += to;
355 memcpy(buffer, (const void *) msg, count);
356 sccb->header.length += count;
357 sccb->evbuf.length += count;
363 * Emit buffer after having waited long enough for more data to arrive.
366 sclp_vt220_timeout(unsigned long data)
368 sclp_vt220_emit_current();
371 #define BUFFER_MAX_DELAY HZ/2
374 * Internal implementation of the write function. Write COUNT bytes of data
376 * to the SCLP interface. In case that the data does not fit into the current
377 * write buffer, emit the current one and allocate a new one. If there are no
378 * more empty buffers available, wait until one gets emptied. If DO_SCHEDULE
379 * is non-zero, the buffer will be scheduled for emitting after a timeout -
380 * otherwise the user has to explicitly call the flush function.
381 * A non-zero CONVERTLF parameter indicates that 0x0a characters in the message
382 * buffer should be converted to 0x0a 0x0d. After completion, return the number
386 __sclp_vt220_write(const unsigned char *buf, int count, int do_schedule,
397 spin_lock_irqsave(&sclp_vt220_lock, flags);
399 /* Create a sclp output buffer if none exists yet */
400 if (sclp_vt220_current_request == NULL) {
401 while (list_empty(&sclp_vt220_empty)) {
402 spin_unlock_irqrestore(&sclp_vt220_lock,
407 wait_event(sclp_vt220_waitq,
408 !list_empty(&sclp_vt220_empty));
409 spin_lock_irqsave(&sclp_vt220_lock, flags);
411 page = (void *) sclp_vt220_empty.next;
412 list_del((struct list_head *) page);
413 sclp_vt220_current_request =
414 sclp_vt220_initialize_page(page);
416 /* Try to write the string to the current request buffer */
417 written = sclp_vt220_add_msg(sclp_vt220_current_request,
418 buf, count, convertlf);
419 overall_written += written;
420 if (written == count)
423 * Not all characters could be written to the current
424 * output buffer. Emit the buffer, create a new buffer
425 * and then output the rest of the string.
427 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
428 sclp_vt220_emit_current();
429 spin_lock_irqsave(&sclp_vt220_lock, flags);
433 /* Setup timer to output current console buffer after some time */
434 if (sclp_vt220_current_request != NULL &&
435 !timer_pending(&sclp_vt220_timer) && do_schedule) {
436 sclp_vt220_timer.function = sclp_vt220_timeout;
437 sclp_vt220_timer.data = 0UL;
438 sclp_vt220_timer.expires = jiffies + BUFFER_MAX_DELAY;
439 add_timer(&sclp_vt220_timer);
441 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
442 return overall_written;
446 * This routine is called by the kernel to write a series of
447 * characters to the tty device. The characters may come from
448 * user space or kernel space. This routine will return the
449 * number of characters actually accepted for writing.
452 sclp_vt220_write(struct tty_struct *tty, const unsigned char *buf, int count)
454 return __sclp_vt220_write(buf, count, 1, 0);
457 #define SCLP_VT220_SESSION_ENDED 0x01
458 #define SCLP_VT220_SESSION_STARTED 0x80
459 #define SCLP_VT220_SESSION_DATA 0x00
462 * Called by the SCLP to report incoming event buffers.
465 sclp_vt220_receiver_fn(struct evbuf_header *evbuf)
470 /* Ignore input if device is not open */
471 if (sclp_vt220_tty == NULL)
474 buffer = (char *) ((addr_t) evbuf + sizeof(struct evbuf_header));
475 count = evbuf->length - sizeof(struct evbuf_header);
478 case SCLP_VT220_SESSION_ENDED:
479 case SCLP_VT220_SESSION_STARTED:
481 case SCLP_VT220_SESSION_DATA:
482 /* Send input to line discipline */
485 tty_insert_flip_string(sclp_vt220_tty, buffer, count);
486 tty_flip_buffer_push(sclp_vt220_tty);
492 * This routine is called when a particular tty device is opened.
495 sclp_vt220_open(struct tty_struct *tty, struct file *filp)
497 if (tty->count == 1) {
498 sclp_vt220_tty = tty;
499 tty->driver_data = kmalloc(SCLP_VT220_BUF_SIZE, GFP_KERNEL);
500 if (tty->driver_data == NULL)
502 tty->low_latency = 0;
508 * This routine is called when a particular tty device is closed.
511 sclp_vt220_close(struct tty_struct *tty, struct file *filp)
513 if (tty->count == 1) {
514 sclp_vt220_tty = NULL;
515 kfree(tty->driver_data);
516 tty->driver_data = NULL;
521 * This routine is called by the kernel to write a single
522 * character to the tty device. If the kernel uses this routine,
523 * it must call the flush_chars() routine (if defined) when it is
524 * done stuffing characters into the driver.
526 * NOTE: include/linux/tty_driver.h specifies that a character should be
527 * ignored if there is no room in the queue. This driver implements a different
528 * semantic in that it will block when there is no more room left.
531 sclp_vt220_put_char(struct tty_struct *tty, unsigned char ch)
533 __sclp_vt220_write(&ch, 1, 0, 0);
537 * This routine is called by the kernel after it has written a
538 * series of characters to the tty device using put_char().
541 sclp_vt220_flush_chars(struct tty_struct *tty)
543 if (sclp_vt220_outqueue_count == 0)
544 sclp_vt220_emit_current();
546 sclp_vt220_flush_later = 1;
550 * This routine returns the numbers of characters the tty driver
551 * will accept for queuing to be written. This number is subject
552 * to change as output buffers get emptied, or if the output flow
556 sclp_vt220_write_room(struct tty_struct *tty)
562 spin_lock_irqsave(&sclp_vt220_lock, flags);
564 if (sclp_vt220_current_request != NULL)
565 count = sclp_vt220_space_left(sclp_vt220_current_request);
566 list_for_each(l, &sclp_vt220_empty)
567 count += SCLP_VT220_MAX_CHARS_PER_BUFFER;
568 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
573 * Return number of buffered chars.
576 sclp_vt220_chars_in_buffer(struct tty_struct *tty)
580 struct sclp_vt220_request *r;
583 spin_lock_irqsave(&sclp_vt220_lock, flags);
585 if (sclp_vt220_current_request != NULL)
586 count = sclp_vt220_chars_stored(sclp_vt220_current_request);
587 list_for_each(l, &sclp_vt220_outqueue) {
588 r = list_entry(l, struct sclp_vt220_request, list);
589 count += sclp_vt220_chars_stored(r);
591 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
596 __sclp_vt220_flush_buffer(void)
600 sclp_vt220_emit_current();
601 spin_lock_irqsave(&sclp_vt220_lock, flags);
602 if (timer_pending(&sclp_vt220_timer))
603 del_timer(&sclp_vt220_timer);
604 while (sclp_vt220_outqueue_count > 0) {
605 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
607 spin_lock_irqsave(&sclp_vt220_lock, flags);
609 spin_unlock_irqrestore(&sclp_vt220_lock, flags);
613 * Pass on all buffers to the hardware. Return only when there are no more
617 sclp_vt220_flush_buffer(struct tty_struct *tty)
619 sclp_vt220_emit_current();
623 * Initialize all relevant components and register driver with system.
626 __sclp_vt220_init(int early)
631 if (sclp_vt220_initialized)
633 sclp_vt220_initialized = 1;
634 spin_lock_init(&sclp_vt220_lock);
635 INIT_LIST_HEAD(&sclp_vt220_empty);
636 INIT_LIST_HEAD(&sclp_vt220_outqueue);
637 init_waitqueue_head(&sclp_vt220_waitq);
638 init_timer(&sclp_vt220_timer);
639 sclp_vt220_current_request = NULL;
640 sclp_vt220_buffered_chars = 0;
641 sclp_vt220_outqueue_count = 0;
642 sclp_vt220_tty = NULL;
643 sclp_vt220_flush_later = 0;
645 /* Allocate pages for output buffering */
646 for (i = 0; i < (early ? MAX_CONSOLE_PAGES : MAX_KMEM_PAGES); i++) {
648 page = alloc_bootmem_low_pages(PAGE_SIZE);
650 page = (void *) get_zeroed_page(GFP_KERNEL | GFP_DMA);
653 list_add_tail((struct list_head *) page, &sclp_vt220_empty);
658 static const struct tty_operations sclp_vt220_ops = {
659 .open = sclp_vt220_open,
660 .close = sclp_vt220_close,
661 .write = sclp_vt220_write,
662 .put_char = sclp_vt220_put_char,
663 .flush_chars = sclp_vt220_flush_chars,
664 .write_room = sclp_vt220_write_room,
665 .chars_in_buffer = sclp_vt220_chars_in_buffer,
666 .flush_buffer = sclp_vt220_flush_buffer
670 * Register driver with SCLP and Linux and initialize internal tty structures.
673 sclp_vt220_tty_init(void)
675 struct tty_driver *driver;
678 /* Note: we're not testing for CONSOLE_IS_SCLP here to preserve
679 * symmetry between VM and LPAR systems regarding ttyS1. */
680 driver = alloc_tty_driver(1);
683 rc = __sclp_vt220_init(0);
685 put_tty_driver(driver);
688 rc = sclp_register(&sclp_vt220_register);
690 printk(KERN_ERR SCLP_VT220_PRINT_HEADER
691 "could not register tty - "
692 "sclp_register returned %d\n", rc);
693 put_tty_driver(driver);
697 driver->owner = THIS_MODULE;
698 driver->driver_name = SCLP_VT220_DRIVER_NAME;
699 driver->name = SCLP_VT220_DEVICE_NAME;
700 driver->major = SCLP_VT220_MAJOR;
701 driver->minor_start = SCLP_VT220_MINOR;
702 driver->type = TTY_DRIVER_TYPE_SYSTEM;
703 driver->subtype = SYSTEM_TYPE_TTY;
704 driver->init_termios = tty_std_termios;
705 driver->flags = TTY_DRIVER_REAL_RAW;
706 tty_set_operations(driver, &sclp_vt220_ops);
708 rc = tty_register_driver(driver);
710 printk(KERN_ERR SCLP_VT220_PRINT_HEADER
711 "could not register tty - "
712 "tty_register_driver returned %d\n", rc);
713 put_tty_driver(driver);
716 sclp_vt220_driver = driver;
720 module_init(sclp_vt220_tty_init);
722 #ifdef CONFIG_SCLP_VT220_CONSOLE
725 sclp_vt220_con_write(struct console *con, const char *buf, unsigned int count)
727 __sclp_vt220_write((const unsigned char *) buf, count, 1, 1);
730 static struct tty_driver *
731 sclp_vt220_con_device(struct console *c, int *index)
734 return sclp_vt220_driver;
738 * This routine is called from panic when the kernel is going to give up.
739 * We have to make sure that all buffers will be flushed to the SCLP.
740 * Note that this function may be called from within an interrupt context.
743 sclp_vt220_con_unblank(void)
745 __sclp_vt220_flush_buffer();
748 /* Structure needed to register with printk */
749 static struct console sclp_vt220_console =
751 .name = SCLP_VT220_CONSOLE_NAME,
752 .write = sclp_vt220_con_write,
753 .device = sclp_vt220_con_device,
754 .unblank = sclp_vt220_con_unblank,
755 .flags = CON_PRINTBUFFER,
756 .index = SCLP_VT220_CONSOLE_INDEX
760 sclp_vt220_con_init(void)
764 if (!CONSOLE_IS_SCLP)
766 rc = __sclp_vt220_init(1);
769 /* Attach linux console */
770 register_console(&sclp_vt220_console);
774 console_initcall(sclp_vt220_con_init);
775 #endif /* CONFIG_SCLP_VT220_CONSOLE */