2 * drivers/s390/char/tty3270.c
3 * IBM/3270 Driver - tty functions.
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 (C) 2003 IBM Deutschland Entwicklung GmbH, IBM Corporation
11 #include <linux/config.h>
12 #include <linux/module.h>
13 #include <linux/types.h>
14 #include <linux/kdev_t.h>
15 #include <linux/tty.h>
16 #include <linux/vt_kern.h>
17 #include <linux/init.h>
18 #include <linux/console.h>
19 #include <linux/interrupt.h>
21 #include <linux/slab.h>
22 #include <linux/bootmem.h>
24 #include <asm/ccwdev.h>
26 #include <asm/ebcdic.h>
27 #include <asm/uaccess.h>
33 #define TTY3270_CHAR_BUF_SIZE 256
34 #define TTY3270_OUTPUT_BUFFER_SIZE 1024
35 #define TTY3270_STRING_PAGES 5
37 struct tty_driver *tty3270_driver;
39 struct raw3270_fn tty3270_fn;
42 unsigned char character;
43 unsigned char highlight;
44 unsigned char f_color;
48 struct tty3270_cell *cells;
55 * The main tty view data structure.
57 * 1) describe line orientation & lines list concept against screen
58 * 2) describe conversion of screen to lines
59 * 3) describe line format.
62 struct raw3270_view view;
63 struct tty_struct *tty; /* Pointer to tty structure */
64 void **freemem_pages; /* Array of pages used for freemem. */
65 struct list_head freemem; /* List of free memory for strings. */
68 struct list_head lines; /* List of lines. */
69 struct list_head update; /* List of lines to update. */
70 unsigned char wcc; /* Write control character. */
71 int nr_lines; /* # lines in list. */
72 int nr_up; /* # lines up in history. */
73 unsigned long update_flags; /* Update indication bits. */
74 struct string *status; /* Lower right of display. */
75 struct raw3270_request *write; /* Single write request. */
76 struct timer_list timer; /* Output delay timer. */
78 /* Current tty screen. */
79 unsigned int cx, cy; /* Current output position. */
80 unsigned int highlight; /* Blink/reverse/underscore */
81 unsigned int f_color; /* Foreground color */
82 struct tty3270_line *screen;
85 struct string *prompt; /* Output string for input area. */
86 struct string *input; /* Input string for read request. */
87 struct raw3270_request *read; /* Single read request. */
88 struct raw3270_request *kreset; /* Single keyboard reset request. */
89 unsigned char inattr; /* Visible/invisible input. */
90 int throttle, attn; /* tty throttle/unthrottle. */
91 struct tasklet_struct readlet; /* Tasklet to issue read request. */
92 struct kbd_data *kbd; /* key_maps stuff. */
94 /* Escape sequence parsing. */
95 int esc_state, esc_ques, esc_npar;
96 int esc_par[ESCAPE_NPAR];
97 unsigned int saved_cx, saved_cy;
98 unsigned int saved_highlight, saved_f_color;
100 /* Command recalling. */
101 struct list_head rcl_lines; /* List of recallable lines. */
102 struct list_head *rcl_walk; /* Point in rcl_lines list. */
103 int rcl_nr, rcl_max; /* Number/max number of rcl_lines. */
105 /* Character array for put_char/flush_chars. */
106 unsigned int char_count;
107 char char_buf[TTY3270_CHAR_BUF_SIZE];
110 /* tty3270->update_flags. See tty3270_update for details. */
111 #define TTY_UPDATE_ERASE 1 /* Use EWRITEA instead of WRITE. */
112 #define TTY_UPDATE_LIST 2 /* Update lines in tty3270->update. */
113 #define TTY_UPDATE_INPUT 4 /* Update input line. */
114 #define TTY_UPDATE_STATUS 8 /* Update status line. */
115 #define TTY_UPDATE_ALL 15
117 static void tty3270_update(struct tty3270 *);
120 * Setup timeout for a device. On timeout trigger an update.
123 tty3270_set_timer(struct tty3270 *tp, int expires)
126 if (timer_pending(&tp->timer)) {
127 raw3270_put_view(&tp->view);
128 del_timer(&tp->timer);
132 if (timer_pending(&tp->timer)) {
133 if (mod_timer(&tp->timer, jiffies + expires))
136 raw3270_get_view(&tp->view);
137 tp->timer.function = (void (*)(unsigned long)) tty3270_update;
138 tp->timer.data = (unsigned long) tp;
139 tp->timer.expires = jiffies + expires;
140 add_timer(&tp->timer);
144 * The input line are the two last lines of the screen.
147 tty3270_update_prompt(struct tty3270 *tp, char *input, int count)
154 line->string[5] = TF_INMDT;
156 line->string[5] = tp->inattr;
157 if (count > tp->view.cols * 2 - 11)
158 count = tp->view.cols * 2 - 11;
159 memcpy(line->string + 6, input, count);
160 line->string[6 + count] = TO_IC;
161 /* Clear to end of input line. */
162 if (count < tp->view.cols * 2 - 11) {
163 line->string[7 + count] = TO_RA;
164 line->string[10 + count] = 0;
165 off = tp->view.cols * tp->view.rows - 9;
166 raw3270_buffer_address(tp->view.dev, line->string+count+8, off);
167 line->len = 11 + count;
169 line->len = 7 + count;
170 tp->update_flags |= TTY_UPDATE_INPUT;
174 tty3270_create_prompt(struct tty3270 *tp)
176 static const unsigned char blueprint[] =
177 { TO_SBA, 0, 0, 0x6e, TO_SF, TF_INPUT,
178 /* empty input string */
179 TO_IC, TO_RA, 0, 0, 0 };
183 line = alloc_string(&tp->freemem,
184 sizeof(blueprint) + tp->view.cols * 2 - 9);
186 tp->inattr = TF_INPUT;
187 /* Copy blueprint to status line */
188 memcpy(line->string, blueprint, sizeof(blueprint));
189 line->len = sizeof(blueprint);
190 /* Set output offsets. */
191 offset = tp->view.cols * (tp->view.rows - 2);
192 raw3270_buffer_address(tp->view.dev, line->string + 1, offset);
193 offset = tp->view.cols * tp->view.rows - 9;
194 raw3270_buffer_address(tp->view.dev, line->string + 8, offset);
196 /* Allocate input string for reading. */
197 tp->input = alloc_string(&tp->freemem, tp->view.cols * 2 - 9 + 6);
201 * The status line is the last line of the screen. It shows the string
202 * "Running"/"Holding" in the lower right corner of the screen.
205 tty3270_update_status(struct tty3270 * tp)
209 str = (tp->nr_up != 0) ? "History" : "Running";
210 memcpy(tp->status->string + 8, str, 7);
211 codepage_convert(tp->view.ascebc, tp->status->string + 8, 7);
212 tp->update_flags |= TTY_UPDATE_STATUS;
216 tty3270_create_status(struct tty3270 * tp)
218 static const unsigned char blueprint[] =
219 { TO_SBA, 0, 0, TO_SF, TF_LOG, TO_SA, TAT_COLOR, TAC_GREEN,
220 0, 0, 0, 0, 0, 0, 0, TO_SF, TF_LOG, TO_SA, TAT_COLOR,
225 line = alloc_string(&tp->freemem,sizeof(blueprint));
227 /* Copy blueprint to status line */
228 memcpy(line->string, blueprint, sizeof(blueprint));
229 /* Set address to start of status string (= last 9 characters). */
230 offset = tp->view.cols * tp->view.rows - 9;
231 raw3270_buffer_address(tp->view.dev, line->string + 1, offset);
235 * Set output offsets to 3270 datastream fragment of a tty string.
236 * (TO_SBA offset at the start and TO_RA offset at the end of the string)
239 tty3270_update_string(struct tty3270 *tp, struct string *line, int nr)
243 raw3270_buffer_address(tp->view.dev, line->string + 1,
245 cp = line->string + line->len - 4;
247 raw3270_buffer_address(tp->view.dev, cp + 1,
248 tp->view.cols * (nr + 1));
252 * Rebuild update list to print all lines.
255 tty3270_rebuild_update(struct tty3270 *tp)
257 struct string *s, *n;
261 * Throw away update list and create a new one,
262 * containing all lines that will fit on the screen.
264 list_for_each_entry_safe(s, n, &tp->update, update)
265 list_del_init(&s->update);
266 line = tp->view.rows - 3;
268 list_for_each_entry_reverse(s, &tp->lines, list) {
273 tty3270_update_string(tp, s, line);
274 list_add(&s->update, &tp->update);
278 tp->update_flags |= TTY_UPDATE_LIST;
282 * Alloc string for size bytes. If there is not enough room in
283 * freemem, free strings until there is room.
285 static struct string *
286 tty3270_alloc_string(struct tty3270 *tp, size_t size)
288 struct string *s, *n;
290 s = alloc_string(&tp->freemem, size);
293 list_for_each_entry_safe(s, n, &tp->lines, list) {
294 BUG_ON(tp->nr_lines <= tp->view.rows - 2);
296 if (!list_empty(&s->update))
297 list_del(&s->update);
299 if (free_string(&tp->freemem, s) >= size)
302 s = alloc_string(&tp->freemem, size);
304 if (tp->nr_up != 0 &&
305 tp->nr_up + tp->view.rows - 2 >= tp->nr_lines) {
306 tp->nr_up = tp->nr_lines - tp->view.rows + 2;
307 tty3270_rebuild_update(tp);
308 tty3270_update_status(tp);
314 * Add an empty line to the list.
317 tty3270_blank_line(struct tty3270 *tp)
319 static const unsigned char blueprint[] =
320 { TO_SBA, 0, 0, TO_SA, TAT_EXTHI, TAX_RESET,
321 TO_SA, TAT_COLOR, TAC_RESET, TO_RA, 0, 0, 0 };
324 s = tty3270_alloc_string(tp, sizeof(blueprint));
325 memcpy(s->string, blueprint, sizeof(blueprint));
326 s->len = sizeof(blueprint);
327 list_add_tail(&s->list, &tp->lines);
334 * Write request completion callback.
337 tty3270_write_callback(struct raw3270_request *rq, void *data)
341 tp = (struct tty3270 *) rq->view;
343 /* Write wasn't successfull. Refresh all. */
344 tty3270_rebuild_update(tp);
345 tp->update_flags = TTY_UPDATE_ALL;
346 tty3270_set_timer(tp, 1);
348 raw3270_request_reset(rq);
349 xchg(&tp->write, rq);
353 * Update 3270 display.
356 tty3270_update(struct tty3270 *tp)
358 static char invalid_sba[2] = { 0xff, 0xff };
359 struct raw3270_request *wrq;
360 unsigned long updated;
361 struct string *s, *n;
365 wrq = xchg(&tp->write, 0);
367 tty3270_set_timer(tp, 1);
371 spin_lock(&tp->view.lock);
373 if (tp->update_flags & TTY_UPDATE_ERASE) {
374 /* Use erase write alternate to erase display. */
375 raw3270_request_set_cmd(wrq, TC_EWRITEA);
376 updated |= TTY_UPDATE_ERASE;
378 raw3270_request_set_cmd(wrq, TC_WRITE);
380 raw3270_request_add_data(wrq, &tp->wcc, 1);
384 * Update status line.
386 if (tp->update_flags & TTY_UPDATE_STATUS)
387 if (raw3270_request_add_data(wrq, tp->status->string,
388 tp->status->len) == 0)
389 updated |= TTY_UPDATE_STATUS;
394 if (tp->update_flags & TTY_UPDATE_INPUT)
395 if (raw3270_request_add_data(wrq, tp->prompt->string,
396 tp->prompt->len) == 0)
397 updated |= TTY_UPDATE_INPUT;
401 if (tp->update_flags & TTY_UPDATE_LIST) {
402 /* Write strings in the update list to the screen. */
403 list_for_each_entry_safe(s, n, &tp->update, update) {
407 * Skip TO_SBA at the start of the string if the
408 * last output position matches the start address
411 if (s->string[1] == sba[0] && s->string[2] == sba[1])
413 if (raw3270_request_add_data(wrq, str, len) != 0)
415 list_del_init(&s->update);
416 sba = s->string + s->len - 3;
418 if (list_empty(&tp->update))
419 updated |= TTY_UPDATE_LIST;
421 wrq->callback = tty3270_write_callback;
422 rc = raw3270_start(&tp->view, wrq);
424 tp->update_flags &= ~updated;
425 if (tp->update_flags)
426 tty3270_set_timer(tp, 1);
428 raw3270_request_reset(wrq);
429 xchg(&tp->write, wrq);
431 spin_unlock(&tp->view.lock);
432 raw3270_put_view(&tp->view);
439 tty3270_rcl_add(struct tty3270 *tp, char *input, int len)
446 if (tp->rcl_nr >= tp->rcl_max) {
447 s = list_entry(tp->rcl_lines.next, struct string, list);
449 free_string(&tp->freemem, s);
452 s = tty3270_alloc_string(tp, len);
453 memcpy(s->string, input, len);
454 list_add_tail(&s->list, &tp->rcl_lines);
459 tty3270_rcl_backward(struct kbd_data *kbd)
464 tp = kbd->tty->driver_data;
465 spin_lock_bh(&tp->view.lock);
466 if (tp->inattr == TF_INPUT) {
467 if (tp->rcl_walk && tp->rcl_walk->prev != &tp->rcl_lines)
468 tp->rcl_walk = tp->rcl_walk->prev;
469 else if (!list_empty(&tp->rcl_lines))
470 tp->rcl_walk = tp->rcl_lines.prev;
472 list_entry(tp->rcl_walk, struct string, list) : 0;
474 s = list_entry(tp->rcl_walk, struct string, list);
475 tty3270_update_prompt(tp, s->string, s->len);
477 tty3270_update_prompt(tp, 0, 0);
478 tty3270_set_timer(tp, 1);
480 spin_unlock_bh(&tp->view.lock);
484 * Deactivate tty view.
487 tty3270_exit_tty(struct kbd_data *kbd)
491 tp = kbd->tty->driver_data;
492 raw3270_deactivate_view(&tp->view);
496 * Scroll forward in history.
499 tty3270_scroll_forward(struct kbd_data *kbd)
504 tp = kbd->tty->driver_data;
505 spin_lock_bh(&tp->view.lock);
506 nr_up = tp->nr_up - tp->view.rows + 2;
509 if (nr_up != tp->nr_up) {
511 tty3270_rebuild_update(tp);
512 tty3270_update_status(tp);
513 tty3270_set_timer(tp, 1);
515 spin_unlock_bh(&tp->view.lock);
519 * Scroll backward in history.
522 tty3270_scroll_backward(struct kbd_data *kbd)
527 tp = kbd->tty->driver_data;
528 spin_lock_bh(&tp->view.lock);
529 nr_up = tp->nr_up + tp->view.rows - 2;
530 if (nr_up + tp->view.rows - 2 > tp->nr_lines)
531 nr_up = tp->nr_lines - tp->view.rows + 2;
532 if (nr_up != tp->nr_up) {
534 tty3270_rebuild_update(tp);
535 tty3270_update_status(tp);
536 tty3270_set_timer(tp, 1);
538 spin_unlock_bh(&tp->view.lock);
542 * Pass input line to tty.
545 tty3270_read_tasklet(struct raw3270_request *rrq)
547 static char kreset_data = TW_KR;
552 tp = (struct tty3270 *) rrq->view;
553 spin_lock_bh(&tp->view.lock);
555 * Two AID keys are special: For 0x7d (enter) the input line
556 * has to be emitted to the tty and for 0x6d the screen
557 * needs to be redrawn.
561 if (tp->input->string[0] == 0x7d) {
562 /* Enter: write input to tty. */
563 input = tp->input->string + 6;
564 len = tp->input->len - 6 - rrq->rescnt;
565 if (tp->inattr != TF_INPUTN)
566 tty3270_rcl_add(tp, input, len);
569 tty3270_rebuild_update(tp);
570 tty3270_update_status(tp);
572 /* Clear input area. */
573 tty3270_update_prompt(tp, 0, 0);
574 tty3270_set_timer(tp, 1);
575 } else if (tp->input->string[0] == 0x6d) {
576 /* Display has been cleared. Redraw. */
577 tty3270_rebuild_update(tp);
578 tp->update_flags = TTY_UPDATE_ALL;
579 tty3270_set_timer(tp, 1);
581 spin_unlock_bh(&tp->view.lock);
583 /* Start keyboard reset command. */
584 raw3270_request_reset(tp->kreset);
585 raw3270_request_set_cmd(tp->kreset, TC_WRITE);
586 raw3270_request_add_data(tp->kreset, &kreset_data, 1);
587 raw3270_start(&tp->view, tp->kreset);
589 /* Emit input string. */
592 kbd_keycode(tp->kbd, *input++);
593 /* Emit keycode for AID byte. */
594 kbd_keycode(tp->kbd, 256 + tp->input->string[0]);
597 raw3270_request_reset(rrq);
598 xchg(&tp->read, rrq);
599 raw3270_put_view(&tp->view);
603 * Read request completion callback.
606 tty3270_read_callback(struct raw3270_request *rq, void *data)
608 raw3270_get_view(rq->view);
609 /* Schedule tasklet to pass input to tty. */
610 tasklet_schedule(&((struct tty3270 *) rq->view)->readlet);
614 * Issue a read request. Call with device lock.
617 tty3270_issue_read(struct tty3270 *tp, int lock)
619 struct raw3270_request *rrq;
622 rrq = xchg(&tp->read, 0);
624 /* Read already scheduled. */
626 rrq->callback = tty3270_read_callback;
627 rrq->callback_data = tp;
628 raw3270_request_set_cmd(rrq, TC_READMOD);
629 raw3270_request_set_data(rrq, tp->input->string, tp->input->len);
630 /* Issue the read modified request. */
632 rc = raw3270_start(&tp->view, rrq);
634 rc = raw3270_start_irq(&tp->view, rrq);
636 raw3270_request_reset(rrq);
637 xchg(&tp->read, rrq);
642 * Switch to the tty view.
645 tty3270_activate(struct raw3270_view *view)
650 tp = (struct tty3270 *) view;
651 spin_lock_irqsave(&tp->view.lock, flags);
653 tty3270_rebuild_update(tp);
654 tty3270_update_status(tp);
655 tp->update_flags = TTY_UPDATE_ALL;
656 tty3270_set_timer(tp, 1);
657 spin_unlock_irqrestore(&tp->view.lock, flags);
663 tty3270_deactivate(struct raw3270_view *view)
667 tp = (struct tty3270 *) view;
673 tty3270_irq(struct tty3270 *tp, struct raw3270_request *rq, struct irb *irb)
675 /* Handle ATTN. Schedule tasklet to read aid. */
676 if (irb->scsw.dstat & DEV_STAT_ATTENTION) {
678 tty3270_issue_read(tp, 0);
684 if (irb->scsw.dstat & DEV_STAT_UNIT_CHECK)
687 /* Normal end. Copy residual count. */
688 rq->rescnt = irb->scsw.count;
690 return RAW3270_IO_DONE;
694 * Allocate tty3270 structure.
696 static struct tty3270 *
697 tty3270_alloc_view(void)
702 tp = kmalloc(sizeof(struct tty3270),GFP_KERNEL);
705 memset(tp, 0, sizeof(struct tty3270));
707 kmalloc(sizeof(void *) * TTY3270_STRING_PAGES, GFP_KERNEL);
708 if (!tp->freemem_pages)
710 INIT_LIST_HEAD(&tp->freemem);
711 for (pages = 0; pages < TTY3270_STRING_PAGES; pages++) {
712 tp->freemem_pages[pages] = (void *)
713 __get_free_pages(GFP_KERNEL|GFP_DMA, 0);
714 if (!tp->freemem_pages[pages])
716 add_string_memory(&tp->freemem,
717 tp->freemem_pages[pages], PAGE_SIZE);
719 tp->write = raw3270_request_alloc(TTY3270_OUTPUT_BUFFER_SIZE);
722 tp->read = raw3270_request_alloc(0);
725 tp->kreset = raw3270_request_alloc(1);
728 tp->kbd = kbd_alloc();
734 raw3270_request_free(tp->kreset);
736 raw3270_request_free(tp->read);
738 raw3270_request_free(tp->write);
741 free_pages((unsigned long) tp->freemem_pages[pages], 0);
742 kfree(tp->freemem_pages);
746 return ERR_PTR(-ENOMEM);
750 * Free tty3270 structure.
753 tty3270_free_view(struct tty3270 *tp)
758 raw3270_request_free(tp->kreset);
759 raw3270_request_free(tp->read);
760 raw3270_request_free(tp->write);
761 for (pages = 0; pages < TTY3270_STRING_PAGES; pages++)
762 free_pages((unsigned long) tp->freemem_pages[pages], 0);
763 kfree(tp->freemem_pages);
768 * Allocate tty3270 screen.
771 tty3270_alloc_screen(struct tty3270 *tp)
776 size = sizeof(struct tty3270_line) * (tp->view.rows - 2);
777 tp->screen = kmalloc(size, GFP_KERNEL);
780 memset(tp->screen, 0, size);
781 for (lines = 0; lines < tp->view.rows - 2; lines++) {
782 size = sizeof(struct tty3270_cell) * tp->view.cols;
783 tp->screen[lines].cells = kmalloc(size, GFP_KERNEL);
784 if (!tp->screen[lines].cells)
786 memset(tp->screen[lines].cells, 0, size);
791 kfree(tp->screen[lines].cells);
798 * Free tty3270 screen.
801 tty3270_free_screen(struct tty3270 *tp)
805 for (lines = 0; lines < tp->view.rows - 2; lines++)
806 kfree(tp->screen[lines].cells);
811 * Unlink tty3270 data structure from tty.
814 tty3270_release(struct raw3270_view *view)
817 struct tty_struct *tty;
819 tp = (struct tty3270 *) view;
822 tty->driver_data = 0;
823 tp->tty = tp->kbd->tty = 0;
825 raw3270_put_view(&tp->view);
830 * Free tty3270 data structure
833 tty3270_free(struct raw3270_view *view)
835 tty3270_free_screen((struct tty3270 *) view);
836 tty3270_free_view((struct tty3270 *) view);
839 struct raw3270_fn tty3270_fn = {
840 .activate = tty3270_activate,
841 .deactivate = tty3270_deactivate,
842 .intv = (void *) tty3270_irq,
843 .release = tty3270_release,
848 * This routine is called whenever a 3270 tty is opened.
851 tty3270_open(struct tty_struct *tty, struct file * filp)
858 /* Check if the tty3270 is already there. */
859 tp = (struct tty3270 *) raw3270_find_view(&tty3270_fn, tty->index);
861 tty->driver_data = tp;
862 tty->winsize.ws_row = tp->view.rows - 2;
863 tty->winsize.ws_col = tp->view.cols;
864 tty->low_latency = 0;
867 tp->inattr = TF_INPUT;
871 /* Allocate tty3270 structure on first open. */
872 tp = tty3270_alloc_view();
876 INIT_LIST_HEAD(&tp->lines);
877 INIT_LIST_HEAD(&tp->update);
878 INIT_LIST_HEAD(&tp->rcl_lines);
880 init_timer(&tp->timer);
881 tasklet_init(&tp->readlet,
882 (void (*)(unsigned long)) tty3270_read_tasklet,
883 (unsigned long) tp->read);
885 rc = raw3270_add_view(&tp->view, &tty3270_fn, tty->index);
887 tty3270_free_view(tp);
891 rc = tty3270_alloc_screen(tp);
893 raw3270_del_view(&tp->view);
894 raw3270_put_view(&tp->view);
899 tty->low_latency = 0;
900 tty->driver_data = tp;
901 tty->winsize.ws_row = tp->view.rows - 2;
902 tty->winsize.ws_col = tp->view.cols;
904 tty3270_create_prompt(tp);
905 tty3270_create_status(tp);
906 tty3270_update_status(tp);
908 /* Create blank line for every line in the tty output area. */
909 for (i = 0; i < tp->view.rows - 2; i++)
910 tty3270_blank_line(tp);
913 tp->kbd->fn_handler[KVAL(K_INCRCONSOLE)] = tty3270_exit_tty;
914 tp->kbd->fn_handler[KVAL(K_SCROLLBACK)] = tty3270_scroll_backward;
915 tp->kbd->fn_handler[KVAL(K_SCROLLFORW)] = tty3270_scroll_forward;
916 tp->kbd->fn_handler[KVAL(K_CONS)] = tty3270_rcl_backward;
917 kbd_ascebc(tp->kbd, tp->view.ascebc);
919 raw3270_activate_view(&tp->view);
924 * This routine is called when the 3270 tty is closed. We wait
925 * for the remaining request to be completed. Then we clean up.
928 tty3270_close(struct tty_struct *tty, struct file * filp)
934 tp = (struct tty3270 *) tty->driver_data;
936 tty->driver_data = 0;
937 tp->tty = tp->kbd->tty = 0;
938 raw3270_put_view(&tp->view);
943 * We always have room.
946 tty3270_write_room(struct tty_struct *tty)
952 * Insert character into the screen at the current position with the
953 * current color and highlight. This function does NOT do cursor movement.
956 tty3270_put_character(struct tty3270 *tp, char ch)
958 struct tty3270_line *line;
959 struct tty3270_cell *cell;
961 line = tp->screen + tp->cy;
962 if (line->len <= tp->cx) {
963 while (line->len < tp->cx) {
964 cell = line->cells + line->len;
965 cell->character = tp->view.ascebc[' '];
966 cell->highlight = tp->highlight;
967 cell->f_color = tp->f_color;
972 cell = line->cells + tp->cx;
973 cell->character = tp->view.ascebc[(unsigned int) ch];
974 cell->highlight = tp->highlight;
975 cell->f_color = tp->f_color;
979 * Convert a tty3270_line to a 3270 data fragment usable for output.
982 tty3270_convert_line(struct tty3270 *tp, int line_nr)
984 struct tty3270_line *line;
985 struct tty3270_cell *cell;
986 struct string *s, *n;
987 unsigned char highlight;
988 unsigned char f_color;
992 /* Determine how long the fragment will be. */
993 flen = 3; /* Prefix (TO_SBA). */
994 line = tp->screen + line_nr;
996 highlight = TAX_RESET;
998 for (i = 0, cell = line->cells; i < line->len; i++, cell++) {
999 if (cell->highlight != highlight) {
1000 flen += 3; /* TO_SA to switch highlight. */
1001 highlight = cell->highlight;
1003 if (cell->f_color != f_color) {
1004 flen += 3; /* TO_SA to switch color. */
1005 f_color = cell->f_color;
1008 if (highlight != TAX_RESET)
1009 flen += 3; /* TO_SA to reset hightlight. */
1010 if (f_color != TAC_RESET)
1011 flen += 3; /* TO_SA to reset color. */
1012 if (line->len < tp->view.cols)
1013 flen += 4; /* Postfix (TO_RA). */
1015 /* Find the line in the list. */
1016 i = tp->view.rows - 2 - line_nr;
1017 list_for_each_entry_reverse(s, &tp->lines, list)
1021 * Check if the line needs to get reallocated.
1023 if (s->len != flen) {
1024 /* Reallocate string. */
1025 n = tty3270_alloc_string(tp, flen);
1026 list_add(&n->list, &s->list);
1027 list_del_init(&s->list);
1028 if (!list_empty(&s->update))
1029 list_del_init(&s->update);
1030 free_string(&tp->freemem, s);
1034 /* Write 3270 data fragment. */
1040 highlight = TAX_RESET;
1041 f_color = TAC_RESET;
1042 for (i = 0, cell = line->cells; i < line->len; i++, cell++) {
1043 if (cell->highlight != highlight) {
1046 *cp++ = cell->highlight;
1047 highlight = cell->highlight;
1049 if (cell->f_color != f_color) {
1052 *cp++ = cell->f_color;
1053 f_color = cell->f_color;
1055 *cp++ = cell->character;
1057 if (highlight != TAX_RESET) {
1062 if (f_color != TAC_RESET) {
1067 if (line->len < tp->view.cols) {
1074 if (tp->nr_up + line_nr < tp->view.rows - 2) {
1075 /* Line is currently visible on screen. */
1076 tty3270_update_string(tp, s, line_nr);
1077 /* Add line to update list. */
1078 if (list_empty(&s->update)) {
1079 list_add_tail(&s->update, &tp->update);
1080 tp->update_flags |= TTY_UPDATE_LIST;
1086 * Do carriage return.
1089 tty3270_cr(struct tty3270 *tp)
1098 tty3270_lf(struct tty3270 *tp)
1100 struct tty3270_line temp;
1103 tty3270_convert_line(tp, tp->cy);
1104 if (tp->cy < tp->view.rows - 3) {
1108 /* Last line just filled up. Add new, blank line. */
1109 tty3270_blank_line(tp);
1110 temp = tp->screen[0];
1112 for (i = 0; i < tp->view.rows - 3; i++)
1113 tp->screen[i] = tp->screen[i+1];
1114 tp->screen[tp->view.rows - 3] = temp;
1115 tty3270_rebuild_update(tp);
1119 tty3270_ri(struct tty3270 *tp)
1122 tty3270_convert_line(tp, tp->cy);
1128 * Insert characters at current position.
1131 tty3270_insert_characters(struct tty3270 *tp, int n)
1133 struct tty3270_line *line;
1136 line = tp->screen + tp->cy;
1137 while (line->len < tp->cx) {
1138 line->cells[line->len].character = tp->view.ascebc[' '];
1139 line->cells[line->len].highlight = TAX_RESET;
1140 line->cells[line->len].f_color = TAC_RESET;
1143 if (n > tp->view.cols - tp->cx)
1144 n = tp->view.cols - tp->cx;
1145 k = min_t(int, line->len - tp->cx, tp->view.cols - tp->cx - n);
1147 line->cells[tp->cx + n + k] = line->cells[tp->cx + k];
1149 if (line->len > tp->view.cols)
1150 line->len = tp->view.cols;
1152 line->cells[tp->cx + n].character = tp->view.ascebc[' '];
1153 line->cells[tp->cx + n].highlight = tp->highlight;
1154 line->cells[tp->cx + n].f_color = tp->f_color;
1159 * Delete characters at current position.
1162 tty3270_delete_characters(struct tty3270 *tp, int n)
1164 struct tty3270_line *line;
1167 line = tp->screen + tp->cy;
1168 if (line->len <= tp->cx)
1170 if (line->len - tp->cx <= n) {
1174 for (i = tp->cx; i + n < line->len; i++)
1175 line->cells[i] = line->cells[i + n];
1180 * Erase characters at current position.
1183 tty3270_erase_characters(struct tty3270 *tp, int n)
1185 struct tty3270_line *line;
1186 struct tty3270_cell *cell;
1188 line = tp->screen + tp->cy;
1189 while (line->len > tp->cx && n-- > 0) {
1190 cell = line->cells + tp->cx++;
1191 cell->character = ' ';
1192 cell->highlight = TAX_RESET;
1193 cell->f_color = TAC_RESET;
1196 tp->cx = min_t(int, tp->cx, tp->view.cols - 1);
1200 * Erase line, 3 different cases:
1201 * Esc [ 0 K Erase from current position to end of line inclusive
1202 * Esc [ 1 K Erase from beginning of line to current position inclusive
1203 * Esc [ 2 K Erase entire line (without moving cursor)
1206 tty3270_erase_line(struct tty3270 *tp, int mode)
1208 struct tty3270_line *line;
1209 struct tty3270_cell *cell;
1212 line = tp->screen + tp->cy;
1215 else if (mode == 1) {
1216 for (i = 0; i < tp->cx; i++) {
1217 cell = line->cells + i;
1218 cell->character = ' ';
1219 cell->highlight = TAX_RESET;
1220 cell->f_color = TAC_RESET;
1222 if (line->len <= tp->cx)
1223 line->len = tp->cx + 1;
1224 } else if (mode == 2)
1226 tty3270_convert_line(tp, tp->cy);
1230 * Erase display, 3 different cases:
1231 * Esc [ 0 J Erase from current position to bottom of screen inclusive
1232 * Esc [ 1 J Erase from top of screen to current position inclusive
1233 * Esc [ 2 J Erase entire screen (without moving the cursor)
1236 tty3270_erase_display(struct tty3270 *tp, int mode)
1241 tty3270_erase_line(tp, 0);
1242 for (i = tp->cy + 1; i < tp->view.rows - 2; i++) {
1243 tp->screen[i].len = 0;
1244 tty3270_convert_line(tp, i);
1246 } else if (mode == 1) {
1247 for (i = 0; i < tp->cy; i++) {
1248 tp->screen[i].len = 0;
1249 tty3270_convert_line(tp, i);
1251 tty3270_erase_line(tp, 1);
1252 } else if (mode == 2) {
1253 for (i = 0; i < tp->view.rows - 2; i++) {
1254 tp->screen[i].len = 0;
1255 tty3270_convert_line(tp, i);
1258 tty3270_rebuild_update(tp);
1262 * Set attributes found in an escape sequence.
1263 * Esc [ <attr> ; <attr> ; ... m
1266 tty3270_set_attributes(struct tty3270 *tp)
1268 static unsigned char f_colors[] = {
1269 TAC_DEFAULT, TAC_RED, TAC_GREEN, TAC_YELLOW, TAC_BLUE,
1270 TAC_PINK, TAC_TURQ, TAC_WHITE, 0, TAC_DEFAULT
1274 for (i = 0; i <= tp->esc_npar; i++) {
1275 attr = tp->esc_par[i];
1278 tp->highlight = TAX_RESET;
1279 tp->f_color = TAC_RESET;
1282 case 4: /* Start underlining. */
1283 tp->highlight = TAX_UNDER;
1285 case 5: /* Start blink. */
1286 tp->highlight = TAX_BLINK;
1288 case 7: /* Start reverse. */
1289 tp->highlight = TAX_REVER;
1291 case 24: /* End underlining */
1292 if (tp->highlight == TAX_UNDER)
1293 tp->highlight = TAX_RESET;
1295 case 25: /* End blink. */
1296 if (tp->highlight == TAX_BLINK)
1297 tp->highlight = TAX_RESET;
1299 case 27: /* End reverse. */
1300 if (tp->highlight == TAX_REVER)
1301 tp->highlight = TAX_RESET;
1303 /* Foreground color. */
1304 case 30: /* Black */
1306 case 32: /* Green */
1307 case 33: /* Yellow */
1309 case 35: /* Magenta */
1311 case 37: /* White */
1312 case 39: /* Black */
1313 tp->f_color = f_colors[attr - 30];
1320 tty3270_getpar(struct tty3270 *tp, int ix)
1322 return (tp->esc_par[ix] > 0) ? tp->esc_par[ix] : 1;
1326 tty3270_goto_xy(struct tty3270 *tp, int cx, int cy)
1328 tp->cx = min_t(int, tp->view.cols - 1, max_t(int, 0, cx));
1329 cy = min_t(int, tp->view.rows - 3, max_t(int, 0, cy));
1331 tty3270_convert_line(tp, tp->cy);
1337 * Process escape sequences. Known sequences:
1338 * Esc 7 Save Cursor Position
1339 * Esc 8 Restore Cursor Position
1340 * Esc [ Pn ; Pn ; .. m Set attributes
1341 * Esc [ Pn ; Pn H Cursor Position
1342 * Esc [ Pn ; Pn f Cursor Position
1343 * Esc [ Pn A Cursor Up
1344 * Esc [ Pn B Cursor Down
1345 * Esc [ Pn C Cursor Forward
1346 * Esc [ Pn D Cursor Backward
1347 * Esc [ Pn G Cursor Horizontal Absolute
1348 * Esc [ Pn X Erase Characters
1349 * Esc [ Ps J Erase in Display
1350 * Esc [ Ps K Erase in Line
1351 * // FIXME: add all the new ones.
1353 * Pn is a numeric parameter, a string of zero or more decimal digits.
1354 * Ps is a selective parameter.
1357 tty3270_escape_sequence(struct tty3270 *tp, char ch)
1359 enum { ESnormal, ESesc, ESsquare, ESgetpars };
1361 if (tp->esc_state == ESnormal) {
1363 /* Starting new escape sequence. */
1364 tp->esc_state = ESesc;
1367 if (tp->esc_state == ESesc) {
1368 tp->esc_state = ESnormal;
1371 tp->esc_state = ESsquare;
1383 case 'Z': /* Respond ID. */
1384 kbd_puts_queue(tp->tty, "\033[?6c");
1386 case '7': /* Save cursor position. */
1387 tp->saved_cx = tp->cx;
1388 tp->saved_cy = tp->cy;
1389 tp->saved_highlight = tp->highlight;
1390 tp->saved_f_color = tp->f_color;
1392 case '8': /* Restore cursor position. */
1393 tty3270_convert_line(tp, tp->cy);
1394 tty3270_goto_xy(tp, tp->saved_cx, tp->saved_cy);
1395 tp->highlight = tp->saved_highlight;
1396 tp->f_color = tp->saved_f_color;
1398 case 'c': /* Reset terminal. */
1399 tp->cx = tp->saved_cx = 0;
1400 tp->cy = tp->saved_cy = 0;
1401 tp->highlight = tp->saved_highlight = TAX_RESET;
1402 tp->f_color = tp->saved_f_color = TAC_RESET;
1403 tty3270_erase_display(tp, 2);
1408 if (tp->esc_state == ESsquare) {
1409 tp->esc_state = ESgetpars;
1410 memset(tp->esc_par, 0, sizeof(tp->esc_par));
1412 tp->esc_ques = (ch == '?');
1416 if (tp->esc_state == ESgetpars) {
1417 if (ch == ';' && tp->esc_npar < ESCAPE_NPAR - 1) {
1421 if (ch >= '0' && ch <= '9') {
1422 tp->esc_par[tp->esc_npar] *= 10;
1423 tp->esc_par[tp->esc_npar] += ch - '0';
1427 tp->esc_state = ESnormal;
1428 if (ch == 'n' && !tp->esc_ques) {
1429 if (tp->esc_par[0] == 5) /* Status report. */
1430 kbd_puts_queue(tp->tty, "\033[0n");
1431 else if (tp->esc_par[0] == 6) { /* Cursor report. */
1433 sprintf(buf, "\033[%d;%dR", tp->cy + 1, tp->cx + 1);
1434 kbd_puts_queue(tp->tty, buf);
1442 tty3270_set_attributes(tp);
1444 case 'H': /* Set cursor position. */
1446 tty3270_goto_xy(tp, tty3270_getpar(tp, 1) - 1,
1447 tty3270_getpar(tp, 0) - 1);
1449 case 'd': /* Set y position. */
1450 tty3270_goto_xy(tp, tp->cx, tty3270_getpar(tp, 0) - 1);
1452 case 'A': /* Cursor up. */
1454 tty3270_goto_xy(tp, tp->cx, tp->cy - tty3270_getpar(tp, 0));
1456 case 'B': /* Cursor down. */
1459 tty3270_goto_xy(tp, tp->cx, tp->cy + tty3270_getpar(tp, 0));
1461 case 'C': /* Cursor forward. */
1463 tty3270_goto_xy(tp, tp->cx + tty3270_getpar(tp, 0), tp->cy);
1465 case 'D': /* Cursor backward. */
1466 tty3270_goto_xy(tp, tp->cx - tty3270_getpar(tp, 0), tp->cy);
1468 case 'G': /* Set x position. */
1470 tty3270_goto_xy(tp, tty3270_getpar(tp, 0), tp->cy);
1472 case 'X': /* Erase Characters. */
1473 tty3270_erase_characters(tp, tty3270_getpar(tp, 0));
1475 case 'J': /* Erase display. */
1476 tty3270_erase_display(tp, tp->esc_par[0]);
1478 case 'K': /* Erase line. */
1479 tty3270_erase_line(tp, tp->esc_par[0]);
1481 case 'P': /* Delete characters. */
1482 tty3270_delete_characters(tp, tty3270_getpar(tp, 0));
1484 case '@': /* Insert characters. */
1485 tty3270_insert_characters(tp, tty3270_getpar(tp, 0));
1487 case 's': /* Save cursor position. */
1488 tp->saved_cx = tp->cx;
1489 tp->saved_cy = tp->cy;
1490 tp->saved_highlight = tp->highlight;
1491 tp->saved_f_color = tp->f_color;
1493 case 'u': /* Restore cursor position. */
1494 tty3270_convert_line(tp, tp->cy);
1495 tty3270_goto_xy(tp, tp->saved_cx, tp->saved_cy);
1496 tp->highlight = tp->saved_highlight;
1497 tp->f_color = tp->saved_f_color;
1503 * String write routine for 3270 ttys
1506 tty3270_do_write(struct tty3270 *tp, const unsigned char *buf, int count)
1510 spin_lock_bh(&tp->view.lock);
1511 for (i_msg = 0; !tp->tty->stopped && i_msg < count; i_msg++) {
1512 if (tp->esc_state != 0) {
1513 /* Continue escape sequence. */
1514 tty3270_escape_sequence(tp, buf[i_msg]);
1518 switch (buf[i_msg]) {
1519 case 0x07: /* '\a' -- Alarm */
1520 tp->wcc |= TW_PLUSALARM;
1522 case 0x08: /* Backspace. */
1525 tty3270_put_character(tp, ' ');
1528 case 0x09: /* '\t' -- Tabulate */
1529 for (i = tp->cx % 8; i < 8; i++) {
1530 if (tp->cx >= tp->view.cols) {
1535 tty3270_put_character(tp, ' ');
1539 case 0x0a: /* '\n' -- New Line */
1543 case 0x0c: /* '\f' -- Form Feed */
1544 tty3270_erase_display(tp, 2);
1545 tp->cx = tp->cy = 0;
1547 case 0x0d: /* '\r' -- Carriage Return */
1550 case 0x0f: /* SuSE "exit alternate mode" */
1552 case 0x1b: /* Start escape sequence. */
1553 tty3270_escape_sequence(tp, buf[i_msg]);
1555 default: /* Insert normal character. */
1556 if (tp->cx >= tp->view.cols) {
1560 tty3270_put_character(tp, buf[i_msg]);
1565 /* Convert current line to 3270 data fragment. */
1566 tty3270_convert_line(tp, tp->cy);
1568 /* Setup timer to update display after 1/10 second */
1569 if (!timer_pending(&tp->timer))
1570 tty3270_set_timer(tp, HZ/10);
1572 spin_unlock_bh(&tp->view.lock);
1576 * String write routine for 3270 ttys
1579 tty3270_write(struct tty_struct * tty, int from_user,
1580 const unsigned char *buf, int count)
1585 tp = tty->driver_data;
1588 if (tp->char_count > 0) {
1589 tty3270_do_write(tp, tp->char_buf, tp->char_count);
1593 tty3270_do_write(tp, buf, count);
1598 length = count < TTY3270_CHAR_BUF_SIZE ?
1599 count : TTY3270_CHAR_BUF_SIZE;
1600 length -= copy_from_user(tp->char_buf, buf, length);
1606 tty3270_do_write(tp, tp->char_buf, count);
1615 * Put single characters to the ttys character buffer
1618 tty3270_put_char(struct tty_struct *tty, unsigned char ch)
1622 tp = tty->driver_data;
1625 if (tp->char_count < TTY3270_CHAR_BUF_SIZE)
1626 tp->char_buf[tp->char_count++] = ch;
1630 * Flush all characters from the ttys characeter buffer put there
1631 * by tty3270_put_char.
1634 tty3270_flush_chars(struct tty_struct *tty)
1638 tp = tty->driver_data;
1641 if (tp->char_count > 0) {
1642 tty3270_do_write(tp, tp->char_buf, tp->char_count);
1648 * Returns the number of characters in the output buffer. This is
1649 * used in tty_wait_until_sent to wait until all characters have
1650 * appeared on the screen.
1653 tty3270_chars_in_buffer(struct tty_struct *tty)
1659 tty3270_flush_buffer(struct tty_struct *tty)
1664 * Check for visible/invisible input switches
1667 tty3270_set_termios(struct tty_struct *tty, struct termios *old)
1672 tp = tty->driver_data;
1675 spin_lock_bh(&tp->view.lock);
1676 if (L_ICANON(tty)) {
1677 new = L_ECHO(tty) ? TF_INPUT: TF_INPUTN;
1678 if (new != tp->inattr) {
1680 tty3270_update_prompt(tp, 0, 0);
1681 tty3270_set_timer(tp, 1);
1684 spin_unlock_bh(&tp->view.lock);
1688 * Disable reading from a 3270 tty
1691 tty3270_throttle(struct tty_struct * tty)
1695 tp = tty->driver_data;
1702 * Enable reading from a 3270 tty
1705 tty3270_unthrottle(struct tty_struct * tty)
1709 tp = tty->driver_data;
1714 tty3270_issue_read(tp, 1);
1718 * Hang up the tty device.
1721 tty3270_hangup(struct tty_struct *tty)
1727 tty3270_wait_until_sent(struct tty_struct *tty, int timeout)
1732 tty3270_ioctl(struct tty_struct *tty, struct file *file,
1733 unsigned int cmd, unsigned long arg)
1737 tp = tty->driver_data;
1740 if (tty->flags & (1 << TTY_IO_ERROR))
1742 return kbd_ioctl(tp->kbd, file, cmd, arg);
1745 static struct tty_operations tty3270_ops = {
1746 .open = tty3270_open,
1747 .close = tty3270_close,
1748 .write = tty3270_write,
1749 .put_char = tty3270_put_char,
1750 .flush_chars = tty3270_flush_chars,
1751 .write_room = tty3270_write_room,
1752 .chars_in_buffer = tty3270_chars_in_buffer,
1753 .flush_buffer = tty3270_flush_buffer,
1754 .throttle = tty3270_throttle,
1755 .unthrottle = tty3270_unthrottle,
1756 .hangup = tty3270_hangup,
1757 .wait_until_sent = tty3270_wait_until_sent,
1758 .ioctl = tty3270_ioctl,
1759 .set_termios = tty3270_set_termios
1763 tty3270_notifier(int index, int active)
1766 tty_register_device(tty3270_driver, index, 0);
1768 tty_unregister_device(tty3270_driver, index);
1772 * 3270 tty registration code called from tty_init().
1773 * Most kernel services (incl. kmalloc) are available at this poimt.
1778 struct tty_driver *driver;
1781 ret = raw3270_init();
1784 driver = alloc_tty_driver(256);
1789 * Initialize the tty_driver structure
1790 * Entries in tty3270_driver that are NOT initialized:
1791 * proc_entry, set_termios, flush_buffer, set_ldisc, write_proc
1793 driver->owner = THIS_MODULE;
1794 driver->devfs_name = "ttyTUB/";
1795 driver->driver_name = "ttyTUB";
1796 driver->name = "ttyTUB";
1797 driver->major = IBM_TTY3270_MAJOR;
1798 driver->type = TTY_DRIVER_TYPE_SYSTEM;
1799 driver->subtype = SYSTEM_TYPE_TTY;
1800 driver->init_termios = tty_std_termios;
1801 driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_NO_DEVFS;
1802 tty_set_operations(driver, &tty3270_ops);
1803 ret = tty_register_driver(driver);
1805 printk(KERN_ERR "tty3270 registration failed with %d\n", ret);
1806 put_tty_driver(driver);
1809 tty3270_driver = driver;
1816 struct tty_driver *driver;
1818 driver = tty3270_driver;
1820 tty_unregister_driver(driver);
1824 MODULE_LICENSE("GPL");
1825 MODULE_ALIAS_CHARDEV_MAJOR(IBM_TTY3270_MAJOR);
1827 module_init(tty3270_init);
1828 module_exit(tty3270_exit);