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/module.h>
12 #include <linux/types.h>
13 #include <linux/kdev_t.h>
14 #include <linux/tty.h>
15 #include <linux/vt_kern.h>
16 #include <linux/init.h>
17 #include <linux/console.h>
18 #include <linux/interrupt.h>
20 #include <linux/slab.h>
21 #include <linux/bootmem.h>
23 #include <asm/ccwdev.h>
25 #include <asm/ebcdic.h>
26 #include <asm/uaccess.h>
32 #define TTY3270_CHAR_BUF_SIZE 256
33 #define TTY3270_OUTPUT_BUFFER_SIZE 1024
34 #define TTY3270_STRING_PAGES 5
36 struct tty_driver *tty3270_driver;
37 static int tty3270_max_index;
39 static 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 16 /* Recreate screen. */
117 static void tty3270_update(struct tty3270 *);
120 * Setup timeout for a device. On timeout trigger an update.
122 static void tty3270_set_timer(struct tty3270 *tp, int expires)
125 del_timer(&tp->timer);
127 mod_timer(&tp->timer, jiffies + expires);
131 * The input line are the two last lines of the screen.
134 tty3270_update_prompt(struct tty3270 *tp, char *input, int count)
141 line->string[5] = TF_INMDT;
143 line->string[5] = tp->inattr;
144 if (count > tp->view.cols * 2 - 11)
145 count = tp->view.cols * 2 - 11;
146 memcpy(line->string + 6, input, count);
147 line->string[6 + count] = TO_IC;
148 /* Clear to end of input line. */
149 if (count < tp->view.cols * 2 - 11) {
150 line->string[7 + count] = TO_RA;
151 line->string[10 + count] = 0;
152 off = tp->view.cols * tp->view.rows - 9;
153 raw3270_buffer_address(tp->view.dev, line->string+count+8, off);
154 line->len = 11 + count;
156 line->len = 7 + count;
157 tp->update_flags |= TTY_UPDATE_INPUT;
161 tty3270_create_prompt(struct tty3270 *tp)
163 static const unsigned char blueprint[] =
164 { TO_SBA, 0, 0, 0x6e, TO_SF, TF_INPUT,
165 /* empty input string */
166 TO_IC, TO_RA, 0, 0, 0 };
170 line = alloc_string(&tp->freemem,
171 sizeof(blueprint) + tp->view.cols * 2 - 9);
173 tp->inattr = TF_INPUT;
174 /* Copy blueprint to status line */
175 memcpy(line->string, blueprint, sizeof(blueprint));
176 line->len = sizeof(blueprint);
177 /* Set output offsets. */
178 offset = tp->view.cols * (tp->view.rows - 2);
179 raw3270_buffer_address(tp->view.dev, line->string + 1, offset);
180 offset = tp->view.cols * tp->view.rows - 9;
181 raw3270_buffer_address(tp->view.dev, line->string + 8, offset);
183 /* Allocate input string for reading. */
184 tp->input = alloc_string(&tp->freemem, tp->view.cols * 2 - 9 + 6);
188 * The status line is the last line of the screen. It shows the string
189 * "Running"/"Holding" in the lower right corner of the screen.
192 tty3270_update_status(struct tty3270 * tp)
196 str = (tp->nr_up != 0) ? "History" : "Running";
197 memcpy(tp->status->string + 8, str, 7);
198 codepage_convert(tp->view.ascebc, tp->status->string + 8, 7);
199 tp->update_flags |= TTY_UPDATE_STATUS;
203 tty3270_create_status(struct tty3270 * tp)
205 static const unsigned char blueprint[] =
206 { TO_SBA, 0, 0, TO_SF, TF_LOG, TO_SA, TAT_COLOR, TAC_GREEN,
207 0, 0, 0, 0, 0, 0, 0, TO_SF, TF_LOG, TO_SA, TAT_COLOR,
212 line = alloc_string(&tp->freemem,sizeof(blueprint));
214 /* Copy blueprint to status line */
215 memcpy(line->string, blueprint, sizeof(blueprint));
216 /* Set address to start of status string (= last 9 characters). */
217 offset = tp->view.cols * tp->view.rows - 9;
218 raw3270_buffer_address(tp->view.dev, line->string + 1, offset);
222 * Set output offsets to 3270 datastream fragment of a tty string.
223 * (TO_SBA offset at the start and TO_RA offset at the end of the string)
226 tty3270_update_string(struct tty3270 *tp, struct string *line, int nr)
230 raw3270_buffer_address(tp->view.dev, line->string + 1,
232 cp = line->string + line->len - 4;
234 raw3270_buffer_address(tp->view.dev, cp + 1,
235 tp->view.cols * (nr + 1));
239 * Rebuild update list to print all lines.
242 tty3270_rebuild_update(struct tty3270 *tp)
244 struct string *s, *n;
248 * Throw away update list and create a new one,
249 * containing all lines that will fit on the screen.
251 list_for_each_entry_safe(s, n, &tp->update, update)
252 list_del_init(&s->update);
253 line = tp->view.rows - 3;
255 list_for_each_entry_reverse(s, &tp->lines, list) {
260 tty3270_update_string(tp, s, line);
261 list_add(&s->update, &tp->update);
265 tp->update_flags |= TTY_UPDATE_LIST;
269 * Alloc string for size bytes. If there is not enough room in
270 * freemem, free strings until there is room.
272 static struct string *
273 tty3270_alloc_string(struct tty3270 *tp, size_t size)
275 struct string *s, *n;
277 s = alloc_string(&tp->freemem, size);
280 list_for_each_entry_safe(s, n, &tp->lines, list) {
281 BUG_ON(tp->nr_lines <= tp->view.rows - 2);
283 if (!list_empty(&s->update))
284 list_del(&s->update);
286 if (free_string(&tp->freemem, s) >= size)
289 s = alloc_string(&tp->freemem, size);
291 if (tp->nr_up != 0 &&
292 tp->nr_up + tp->view.rows - 2 >= tp->nr_lines) {
293 tp->nr_up = tp->nr_lines - tp->view.rows + 2;
294 tty3270_rebuild_update(tp);
295 tty3270_update_status(tp);
301 * Add an empty line to the list.
304 tty3270_blank_line(struct tty3270 *tp)
306 static const unsigned char blueprint[] =
307 { TO_SBA, 0, 0, TO_SA, TAT_EXTHI, TAX_RESET,
308 TO_SA, TAT_COLOR, TAC_RESET, TO_RA, 0, 0, 0 };
311 s = tty3270_alloc_string(tp, sizeof(blueprint));
312 memcpy(s->string, blueprint, sizeof(blueprint));
313 s->len = sizeof(blueprint);
314 list_add_tail(&s->list, &tp->lines);
321 * Write request completion callback.
324 tty3270_write_callback(struct raw3270_request *rq, void *data)
328 tp = (struct tty3270 *) rq->view;
330 /* Write wasn't successfull. Refresh all. */
331 tp->update_flags = TTY_UPDATE_ALL;
332 tty3270_set_timer(tp, 1);
334 raw3270_request_reset(rq);
335 xchg(&tp->write, rq);
339 * Update 3270 display.
342 tty3270_update(struct tty3270 *tp)
344 static char invalid_sba[2] = { 0xff, 0xff };
345 struct raw3270_request *wrq;
346 unsigned long updated;
347 struct string *s, *n;
351 wrq = xchg(&tp->write, 0);
353 tty3270_set_timer(tp, 1);
357 spin_lock(&tp->view.lock);
359 if (tp->update_flags & TTY_UPDATE_ALL) {
360 tty3270_rebuild_update(tp);
361 tty3270_update_status(tp);
362 tp->update_flags = TTY_UPDATE_ERASE | TTY_UPDATE_LIST |
363 TTY_UPDATE_INPUT | TTY_UPDATE_STATUS;
365 if (tp->update_flags & TTY_UPDATE_ERASE) {
366 /* Use erase write alternate to erase display. */
367 raw3270_request_set_cmd(wrq, TC_EWRITEA);
368 updated |= TTY_UPDATE_ERASE;
370 raw3270_request_set_cmd(wrq, TC_WRITE);
372 raw3270_request_add_data(wrq, &tp->wcc, 1);
376 * Update status line.
378 if (tp->update_flags & TTY_UPDATE_STATUS)
379 if (raw3270_request_add_data(wrq, tp->status->string,
380 tp->status->len) == 0)
381 updated |= TTY_UPDATE_STATUS;
386 if (tp->update_flags & TTY_UPDATE_INPUT)
387 if (raw3270_request_add_data(wrq, tp->prompt->string,
388 tp->prompt->len) == 0)
389 updated |= TTY_UPDATE_INPUT;
393 if (tp->update_flags & TTY_UPDATE_LIST) {
394 /* Write strings in the update list to the screen. */
395 list_for_each_entry_safe(s, n, &tp->update, update) {
399 * Skip TO_SBA at the start of the string if the
400 * last output position matches the start address
403 if (s->string[1] == sba[0] && s->string[2] == sba[1])
405 if (raw3270_request_add_data(wrq, str, len) != 0)
407 list_del_init(&s->update);
408 sba = s->string + s->len - 3;
410 if (list_empty(&tp->update))
411 updated |= TTY_UPDATE_LIST;
413 wrq->callback = tty3270_write_callback;
414 rc = raw3270_start(&tp->view, wrq);
416 tp->update_flags &= ~updated;
417 if (tp->update_flags)
418 tty3270_set_timer(tp, 1);
420 raw3270_request_reset(wrq);
421 xchg(&tp->write, wrq);
423 spin_unlock(&tp->view.lock);
430 tty3270_rcl_add(struct tty3270 *tp, char *input, int len)
437 if (tp->rcl_nr >= tp->rcl_max) {
438 s = list_entry(tp->rcl_lines.next, struct string, list);
440 free_string(&tp->freemem, s);
443 s = tty3270_alloc_string(tp, len);
444 memcpy(s->string, input, len);
445 list_add_tail(&s->list, &tp->rcl_lines);
450 tty3270_rcl_backward(struct kbd_data *kbd)
455 tp = kbd->tty->driver_data;
456 spin_lock_bh(&tp->view.lock);
457 if (tp->inattr == TF_INPUT) {
458 if (tp->rcl_walk && tp->rcl_walk->prev != &tp->rcl_lines)
459 tp->rcl_walk = tp->rcl_walk->prev;
460 else if (!list_empty(&tp->rcl_lines))
461 tp->rcl_walk = tp->rcl_lines.prev;
463 list_entry(tp->rcl_walk, struct string, list) : NULL;
465 s = list_entry(tp->rcl_walk, struct string, list);
466 tty3270_update_prompt(tp, s->string, s->len);
468 tty3270_update_prompt(tp, NULL, 0);
469 tty3270_set_timer(tp, 1);
471 spin_unlock_bh(&tp->view.lock);
475 * Deactivate tty view.
478 tty3270_exit_tty(struct kbd_data *kbd)
482 tp = kbd->tty->driver_data;
483 raw3270_deactivate_view(&tp->view);
487 * Scroll forward in history.
490 tty3270_scroll_forward(struct kbd_data *kbd)
495 tp = kbd->tty->driver_data;
496 spin_lock_bh(&tp->view.lock);
497 nr_up = tp->nr_up - tp->view.rows + 2;
500 if (nr_up != tp->nr_up) {
502 tty3270_rebuild_update(tp);
503 tty3270_update_status(tp);
504 tty3270_set_timer(tp, 1);
506 spin_unlock_bh(&tp->view.lock);
510 * Scroll backward in history.
513 tty3270_scroll_backward(struct kbd_data *kbd)
518 tp = kbd->tty->driver_data;
519 spin_lock_bh(&tp->view.lock);
520 nr_up = tp->nr_up + tp->view.rows - 2;
521 if (nr_up + tp->view.rows - 2 > tp->nr_lines)
522 nr_up = tp->nr_lines - tp->view.rows + 2;
523 if (nr_up != tp->nr_up) {
525 tty3270_rebuild_update(tp);
526 tty3270_update_status(tp);
527 tty3270_set_timer(tp, 1);
529 spin_unlock_bh(&tp->view.lock);
533 * Pass input line to tty.
536 tty3270_read_tasklet(struct raw3270_request *rrq)
538 static char kreset_data = TW_KR;
543 tp = (struct tty3270 *) rrq->view;
544 spin_lock_bh(&tp->view.lock);
546 * Two AID keys are special: For 0x7d (enter) the input line
547 * has to be emitted to the tty and for 0x6d the screen
548 * needs to be redrawn.
552 if (tp->input->string[0] == 0x7d) {
553 /* Enter: write input to tty. */
554 input = tp->input->string + 6;
555 len = tp->input->len - 6 - rrq->rescnt;
556 if (tp->inattr != TF_INPUTN)
557 tty3270_rcl_add(tp, input, len);
560 tty3270_rebuild_update(tp);
561 tty3270_update_status(tp);
563 /* Clear input area. */
564 tty3270_update_prompt(tp, NULL, 0);
565 tty3270_set_timer(tp, 1);
566 } else if (tp->input->string[0] == 0x6d) {
567 /* Display has been cleared. Redraw. */
568 tp->update_flags = TTY_UPDATE_ALL;
569 tty3270_set_timer(tp, 1);
571 spin_unlock_bh(&tp->view.lock);
573 /* Start keyboard reset command. */
574 raw3270_request_reset(tp->kreset);
575 raw3270_request_set_cmd(tp->kreset, TC_WRITE);
576 raw3270_request_add_data(tp->kreset, &kreset_data, 1);
577 raw3270_start(&tp->view, tp->kreset);
579 /* Emit input string. */
582 kbd_keycode(tp->kbd, *input++);
583 /* Emit keycode for AID byte. */
584 kbd_keycode(tp->kbd, 256 + tp->input->string[0]);
587 raw3270_request_reset(rrq);
588 xchg(&tp->read, rrq);
589 raw3270_put_view(&tp->view);
593 * Read request completion callback.
596 tty3270_read_callback(struct raw3270_request *rq, void *data)
598 raw3270_get_view(rq->view);
599 /* Schedule tasklet to pass input to tty. */
600 tasklet_schedule(&((struct tty3270 *) rq->view)->readlet);
604 * Issue a read request. Call with device lock.
607 tty3270_issue_read(struct tty3270 *tp, int lock)
609 struct raw3270_request *rrq;
612 rrq = xchg(&tp->read, 0);
614 /* Read already scheduled. */
616 rrq->callback = tty3270_read_callback;
617 rrq->callback_data = tp;
618 raw3270_request_set_cmd(rrq, TC_READMOD);
619 raw3270_request_set_data(rrq, tp->input->string, tp->input->len);
620 /* Issue the read modified request. */
622 rc = raw3270_start(&tp->view, rrq);
624 rc = raw3270_start_irq(&tp->view, rrq);
626 raw3270_request_reset(rrq);
627 xchg(&tp->read, rrq);
632 * Switch to the tty view.
635 tty3270_activate(struct raw3270_view *view)
639 tp = (struct tty3270 *) view;
640 tp->update_flags = TTY_UPDATE_ALL;
641 tty3270_set_timer(tp, 1);
646 tty3270_deactivate(struct raw3270_view *view)
650 tp = (struct tty3270 *) view;
651 del_timer(&tp->timer);
655 tty3270_irq(struct tty3270 *tp, struct raw3270_request *rq, struct irb *irb)
657 /* Handle ATTN. Schedule tasklet to read aid. */
658 if (irb->scsw.cmd.dstat & DEV_STAT_ATTENTION) {
660 tty3270_issue_read(tp, 0);
666 if (irb->scsw.cmd.dstat & DEV_STAT_UNIT_CHECK)
669 /* Normal end. Copy residual count. */
670 rq->rescnt = irb->scsw.cmd.count;
672 return RAW3270_IO_DONE;
676 * Allocate tty3270 structure.
678 static struct tty3270 *
679 tty3270_alloc_view(void)
684 tp = kzalloc(sizeof(struct tty3270), GFP_KERNEL);
688 kmalloc(sizeof(void *) * TTY3270_STRING_PAGES, GFP_KERNEL);
689 if (!tp->freemem_pages)
691 INIT_LIST_HEAD(&tp->freemem);
692 for (pages = 0; pages < TTY3270_STRING_PAGES; pages++) {
693 tp->freemem_pages[pages] = (void *)
694 __get_free_pages(GFP_KERNEL|GFP_DMA, 0);
695 if (!tp->freemem_pages[pages])
697 add_string_memory(&tp->freemem,
698 tp->freemem_pages[pages], PAGE_SIZE);
700 tp->write = raw3270_request_alloc(TTY3270_OUTPUT_BUFFER_SIZE);
701 if (IS_ERR(tp->write))
703 tp->read = raw3270_request_alloc(0);
704 if (IS_ERR(tp->read))
706 tp->kreset = raw3270_request_alloc(1);
707 if (IS_ERR(tp->kreset))
709 tp->kbd = kbd_alloc();
715 raw3270_request_free(tp->kreset);
717 raw3270_request_free(tp->read);
719 raw3270_request_free(tp->write);
722 free_pages((unsigned long) tp->freemem_pages[pages], 0);
723 kfree(tp->freemem_pages);
727 return ERR_PTR(-ENOMEM);
731 * Free tty3270 structure.
734 tty3270_free_view(struct tty3270 *tp)
738 del_timer_sync(&tp->timer);
740 raw3270_request_free(tp->kreset);
741 raw3270_request_free(tp->read);
742 raw3270_request_free(tp->write);
743 for (pages = 0; pages < TTY3270_STRING_PAGES; pages++)
744 free_pages((unsigned long) tp->freemem_pages[pages], 0);
745 kfree(tp->freemem_pages);
750 * Allocate tty3270 screen.
753 tty3270_alloc_screen(struct tty3270 *tp)
758 size = sizeof(struct tty3270_line) * (tp->view.rows - 2);
759 tp->screen = kzalloc(size, GFP_KERNEL);
762 for (lines = 0; lines < tp->view.rows - 2; lines++) {
763 size = sizeof(struct tty3270_cell) * tp->view.cols;
764 tp->screen[lines].cells = kzalloc(size, GFP_KERNEL);
765 if (!tp->screen[lines].cells)
771 kfree(tp->screen[lines].cells);
778 * Free tty3270 screen.
781 tty3270_free_screen(struct tty3270 *tp)
785 for (lines = 0; lines < tp->view.rows - 2; lines++)
786 kfree(tp->screen[lines].cells);
791 * Unlink tty3270 data structure from tty.
794 tty3270_release(struct raw3270_view *view)
797 struct tty_struct *tty;
799 tp = (struct tty3270 *) view;
802 tty->driver_data = NULL;
803 tp->tty = tp->kbd->tty = NULL;
805 raw3270_put_view(&tp->view);
810 * Free tty3270 data structure
813 tty3270_free(struct raw3270_view *view)
815 tty3270_free_screen((struct tty3270 *) view);
816 tty3270_free_view((struct tty3270 *) view);
820 * Delayed freeing of tty3270 views.
823 tty3270_del_views(void)
828 for (i = 0; i < tty3270_max_index; i++) {
829 tp = (struct tty3270 *)
830 raw3270_find_view(&tty3270_fn, i + RAW3270_FIRSTMINOR);
832 raw3270_del_view(&tp->view);
836 static struct raw3270_fn tty3270_fn = {
837 .activate = tty3270_activate,
838 .deactivate = tty3270_deactivate,
839 .intv = (void *) tty3270_irq,
840 .release = tty3270_release,
845 * This routine is called whenever a 3270 tty is opened.
848 tty3270_open(struct tty_struct *tty, struct file * filp)
855 /* Check if the tty3270 is already there. */
856 tp = (struct tty3270 *)
857 raw3270_find_view(&tty3270_fn,
858 tty->index + RAW3270_FIRSTMINOR);
860 tty->driver_data = tp;
861 tty->winsize.ws_row = tp->view.rows - 2;
862 tty->winsize.ws_col = tp->view.cols;
863 tty->low_latency = 0;
866 tp->inattr = TF_INPUT;
869 if (tty3270_max_index < tty->index + 1)
870 tty3270_max_index = tty->index + 1;
872 /* Quick exit if there is no device for tty->index. */
873 if (PTR_ERR(tp) == -ENODEV)
876 /* Allocate tty3270 structure on first open. */
877 tp = tty3270_alloc_view();
881 INIT_LIST_HEAD(&tp->lines);
882 INIT_LIST_HEAD(&tp->update);
883 INIT_LIST_HEAD(&tp->rcl_lines);
885 setup_timer(&tp->timer, (void (*)(unsigned long)) tty3270_update,
887 tasklet_init(&tp->readlet,
888 (void (*)(unsigned long)) tty3270_read_tasklet,
889 (unsigned long) tp->read);
891 rc = raw3270_add_view(&tp->view, &tty3270_fn,
892 tty->index + RAW3270_FIRSTMINOR);
894 tty3270_free_view(tp);
898 rc = tty3270_alloc_screen(tp);
900 raw3270_put_view(&tp->view);
901 raw3270_del_view(&tp->view);
906 tty->low_latency = 0;
907 tty->driver_data = tp;
908 tty->winsize.ws_row = tp->view.rows - 2;
909 tty->winsize.ws_col = tp->view.cols;
911 tty3270_create_prompt(tp);
912 tty3270_create_status(tp);
913 tty3270_update_status(tp);
915 /* Create blank line for every line in the tty output area. */
916 for (i = 0; i < tp->view.rows - 2; i++)
917 tty3270_blank_line(tp);
920 tp->kbd->fn_handler[KVAL(K_INCRCONSOLE)] = tty3270_exit_tty;
921 tp->kbd->fn_handler[KVAL(K_SCROLLBACK)] = tty3270_scroll_backward;
922 tp->kbd->fn_handler[KVAL(K_SCROLLFORW)] = tty3270_scroll_forward;
923 tp->kbd->fn_handler[KVAL(K_CONS)] = tty3270_rcl_backward;
924 kbd_ascebc(tp->kbd, tp->view.ascebc);
926 raw3270_activate_view(&tp->view);
931 * This routine is called when the 3270 tty is closed. We wait
932 * for the remaining request to be completed. Then we clean up.
935 tty3270_close(struct tty_struct *tty, struct file * filp)
941 tp = (struct tty3270 *) tty->driver_data;
943 tty->driver_data = NULL;
944 tp->tty = tp->kbd->tty = NULL;
945 raw3270_put_view(&tp->view);
950 * We always have room.
953 tty3270_write_room(struct tty_struct *tty)
959 * Insert character into the screen at the current position with the
960 * current color and highlight. This function does NOT do cursor movement.
962 static void tty3270_put_character(struct tty3270 *tp, char ch)
964 struct tty3270_line *line;
965 struct tty3270_cell *cell;
967 line = tp->screen + tp->cy;
968 if (line->len <= tp->cx) {
969 while (line->len < tp->cx) {
970 cell = line->cells + line->len;
971 cell->character = tp->view.ascebc[' '];
972 cell->highlight = tp->highlight;
973 cell->f_color = tp->f_color;
978 cell = line->cells + tp->cx;
979 cell->character = tp->view.ascebc[(unsigned int) ch];
980 cell->highlight = tp->highlight;
981 cell->f_color = tp->f_color;
985 * Convert a tty3270_line to a 3270 data fragment usable for output.
988 tty3270_convert_line(struct tty3270 *tp, int line_nr)
990 struct tty3270_line *line;
991 struct tty3270_cell *cell;
992 struct string *s, *n;
993 unsigned char highlight;
994 unsigned char f_color;
998 /* Determine how long the fragment will be. */
999 flen = 3; /* Prefix (TO_SBA). */
1000 line = tp->screen + line_nr;
1002 highlight = TAX_RESET;
1003 f_color = TAC_RESET;
1004 for (i = 0, cell = line->cells; i < line->len; i++, cell++) {
1005 if (cell->highlight != highlight) {
1006 flen += 3; /* TO_SA to switch highlight. */
1007 highlight = cell->highlight;
1009 if (cell->f_color != f_color) {
1010 flen += 3; /* TO_SA to switch color. */
1011 f_color = cell->f_color;
1014 if (highlight != TAX_RESET)
1015 flen += 3; /* TO_SA to reset hightlight. */
1016 if (f_color != TAC_RESET)
1017 flen += 3; /* TO_SA to reset color. */
1018 if (line->len < tp->view.cols)
1019 flen += 4; /* Postfix (TO_RA). */
1021 /* Find the line in the list. */
1022 i = tp->view.rows - 2 - line_nr;
1023 list_for_each_entry_reverse(s, &tp->lines, list)
1027 * Check if the line needs to get reallocated.
1029 if (s->len != flen) {
1030 /* Reallocate string. */
1031 n = tty3270_alloc_string(tp, flen);
1032 list_add(&n->list, &s->list);
1033 list_del_init(&s->list);
1034 if (!list_empty(&s->update))
1035 list_del_init(&s->update);
1036 free_string(&tp->freemem, s);
1040 /* Write 3270 data fragment. */
1046 highlight = TAX_RESET;
1047 f_color = TAC_RESET;
1048 for (i = 0, cell = line->cells; i < line->len; i++, cell++) {
1049 if (cell->highlight != highlight) {
1052 *cp++ = cell->highlight;
1053 highlight = cell->highlight;
1055 if (cell->f_color != f_color) {
1058 *cp++ = cell->f_color;
1059 f_color = cell->f_color;
1061 *cp++ = cell->character;
1063 if (highlight != TAX_RESET) {
1068 if (f_color != TAC_RESET) {
1073 if (line->len < tp->view.cols) {
1080 if (tp->nr_up + line_nr < tp->view.rows - 2) {
1081 /* Line is currently visible on screen. */
1082 tty3270_update_string(tp, s, line_nr);
1083 /* Add line to update list. */
1084 if (list_empty(&s->update)) {
1085 list_add_tail(&s->update, &tp->update);
1086 tp->update_flags |= TTY_UPDATE_LIST;
1092 * Do carriage return.
1095 tty3270_cr(struct tty3270 *tp)
1104 tty3270_lf(struct tty3270 *tp)
1106 struct tty3270_line temp;
1109 tty3270_convert_line(tp, tp->cy);
1110 if (tp->cy < tp->view.rows - 3) {
1114 /* Last line just filled up. Add new, blank line. */
1115 tty3270_blank_line(tp);
1116 temp = tp->screen[0];
1118 for (i = 0; i < tp->view.rows - 3; i++)
1119 tp->screen[i] = tp->screen[i+1];
1120 tp->screen[tp->view.rows - 3] = temp;
1121 tty3270_rebuild_update(tp);
1125 tty3270_ri(struct tty3270 *tp)
1128 tty3270_convert_line(tp, tp->cy);
1134 * Insert characters at current position.
1137 tty3270_insert_characters(struct tty3270 *tp, int n)
1139 struct tty3270_line *line;
1142 line = tp->screen + tp->cy;
1143 while (line->len < tp->cx) {
1144 line->cells[line->len].character = tp->view.ascebc[' '];
1145 line->cells[line->len].highlight = TAX_RESET;
1146 line->cells[line->len].f_color = TAC_RESET;
1149 if (n > tp->view.cols - tp->cx)
1150 n = tp->view.cols - tp->cx;
1151 k = min_t(int, line->len - tp->cx, tp->view.cols - tp->cx - n);
1153 line->cells[tp->cx + n + k] = line->cells[tp->cx + k];
1155 if (line->len > tp->view.cols)
1156 line->len = tp->view.cols;
1158 line->cells[tp->cx + n].character = tp->view.ascebc[' '];
1159 line->cells[tp->cx + n].highlight = tp->highlight;
1160 line->cells[tp->cx + n].f_color = tp->f_color;
1165 * Delete characters at current position.
1168 tty3270_delete_characters(struct tty3270 *tp, int n)
1170 struct tty3270_line *line;
1173 line = tp->screen + tp->cy;
1174 if (line->len <= tp->cx)
1176 if (line->len - tp->cx <= n) {
1180 for (i = tp->cx; i + n < line->len; i++)
1181 line->cells[i] = line->cells[i + n];
1186 * Erase characters at current position.
1189 tty3270_erase_characters(struct tty3270 *tp, int n)
1191 struct tty3270_line *line;
1192 struct tty3270_cell *cell;
1194 line = tp->screen + tp->cy;
1195 while (line->len > tp->cx && n-- > 0) {
1196 cell = line->cells + tp->cx++;
1197 cell->character = ' ';
1198 cell->highlight = TAX_RESET;
1199 cell->f_color = TAC_RESET;
1202 tp->cx = min_t(int, tp->cx, tp->view.cols - 1);
1206 * Erase line, 3 different cases:
1207 * Esc [ 0 K Erase from current position to end of line inclusive
1208 * Esc [ 1 K Erase from beginning of line to current position inclusive
1209 * Esc [ 2 K Erase entire line (without moving cursor)
1212 tty3270_erase_line(struct tty3270 *tp, int mode)
1214 struct tty3270_line *line;
1215 struct tty3270_cell *cell;
1218 line = tp->screen + tp->cy;
1221 else if (mode == 1) {
1222 for (i = 0; i < tp->cx; i++) {
1223 cell = line->cells + i;
1224 cell->character = ' ';
1225 cell->highlight = TAX_RESET;
1226 cell->f_color = TAC_RESET;
1228 if (line->len <= tp->cx)
1229 line->len = tp->cx + 1;
1230 } else if (mode == 2)
1232 tty3270_convert_line(tp, tp->cy);
1236 * Erase display, 3 different cases:
1237 * Esc [ 0 J Erase from current position to bottom of screen inclusive
1238 * Esc [ 1 J Erase from top of screen to current position inclusive
1239 * Esc [ 2 J Erase entire screen (without moving the cursor)
1242 tty3270_erase_display(struct tty3270 *tp, int mode)
1247 tty3270_erase_line(tp, 0);
1248 for (i = tp->cy + 1; i < tp->view.rows - 2; i++) {
1249 tp->screen[i].len = 0;
1250 tty3270_convert_line(tp, i);
1252 } else if (mode == 1) {
1253 for (i = 0; i < tp->cy; i++) {
1254 tp->screen[i].len = 0;
1255 tty3270_convert_line(tp, i);
1257 tty3270_erase_line(tp, 1);
1258 } else if (mode == 2) {
1259 for (i = 0; i < tp->view.rows - 2; i++) {
1260 tp->screen[i].len = 0;
1261 tty3270_convert_line(tp, i);
1264 tty3270_rebuild_update(tp);
1268 * Set attributes found in an escape sequence.
1269 * Esc [ <attr> ; <attr> ; ... m
1272 tty3270_set_attributes(struct tty3270 *tp)
1274 static unsigned char f_colors[] = {
1275 TAC_DEFAULT, TAC_RED, TAC_GREEN, TAC_YELLOW, TAC_BLUE,
1276 TAC_PINK, TAC_TURQ, TAC_WHITE, 0, TAC_DEFAULT
1280 for (i = 0; i <= tp->esc_npar; i++) {
1281 attr = tp->esc_par[i];
1284 tp->highlight = TAX_RESET;
1285 tp->f_color = TAC_RESET;
1288 case 4: /* Start underlining. */
1289 tp->highlight = TAX_UNDER;
1291 case 5: /* Start blink. */
1292 tp->highlight = TAX_BLINK;
1294 case 7: /* Start reverse. */
1295 tp->highlight = TAX_REVER;
1297 case 24: /* End underlining */
1298 if (tp->highlight == TAX_UNDER)
1299 tp->highlight = TAX_RESET;
1301 case 25: /* End blink. */
1302 if (tp->highlight == TAX_BLINK)
1303 tp->highlight = TAX_RESET;
1305 case 27: /* End reverse. */
1306 if (tp->highlight == TAX_REVER)
1307 tp->highlight = TAX_RESET;
1309 /* Foreground color. */
1310 case 30: /* Black */
1312 case 32: /* Green */
1313 case 33: /* Yellow */
1315 case 35: /* Magenta */
1317 case 37: /* White */
1318 case 39: /* Black */
1319 tp->f_color = f_colors[attr - 30];
1326 tty3270_getpar(struct tty3270 *tp, int ix)
1328 return (tp->esc_par[ix] > 0) ? tp->esc_par[ix] : 1;
1332 tty3270_goto_xy(struct tty3270 *tp, int cx, int cy)
1334 int max_cx = max(0, cx);
1335 int max_cy = max(0, cy);
1337 tp->cx = min_t(int, tp->view.cols - 1, max_cx);
1338 cy = min_t(int, tp->view.rows - 3, max_cy);
1340 tty3270_convert_line(tp, tp->cy);
1346 * Process escape sequences. Known sequences:
1347 * Esc 7 Save Cursor Position
1348 * Esc 8 Restore Cursor Position
1349 * Esc [ Pn ; Pn ; .. m Set attributes
1350 * Esc [ Pn ; Pn H Cursor Position
1351 * Esc [ Pn ; Pn f Cursor Position
1352 * Esc [ Pn A Cursor Up
1353 * Esc [ Pn B Cursor Down
1354 * Esc [ Pn C Cursor Forward
1355 * Esc [ Pn D Cursor Backward
1356 * Esc [ Pn G Cursor Horizontal Absolute
1357 * Esc [ Pn X Erase Characters
1358 * Esc [ Ps J Erase in Display
1359 * Esc [ Ps K Erase in Line
1360 * // FIXME: add all the new ones.
1362 * Pn is a numeric parameter, a string of zero or more decimal digits.
1363 * Ps is a selective parameter.
1366 tty3270_escape_sequence(struct tty3270 *tp, char ch)
1368 enum { ESnormal, ESesc, ESsquare, ESgetpars };
1370 if (tp->esc_state == ESnormal) {
1372 /* Starting new escape sequence. */
1373 tp->esc_state = ESesc;
1376 if (tp->esc_state == ESesc) {
1377 tp->esc_state = ESnormal;
1380 tp->esc_state = ESsquare;
1392 case 'Z': /* Respond ID. */
1393 kbd_puts_queue(tp->tty, "\033[?6c");
1395 case '7': /* Save cursor position. */
1396 tp->saved_cx = tp->cx;
1397 tp->saved_cy = tp->cy;
1398 tp->saved_highlight = tp->highlight;
1399 tp->saved_f_color = tp->f_color;
1401 case '8': /* Restore cursor position. */
1402 tty3270_convert_line(tp, tp->cy);
1403 tty3270_goto_xy(tp, tp->saved_cx, tp->saved_cy);
1404 tp->highlight = tp->saved_highlight;
1405 tp->f_color = tp->saved_f_color;
1407 case 'c': /* Reset terminal. */
1408 tp->cx = tp->saved_cx = 0;
1409 tp->cy = tp->saved_cy = 0;
1410 tp->highlight = tp->saved_highlight = TAX_RESET;
1411 tp->f_color = tp->saved_f_color = TAC_RESET;
1412 tty3270_erase_display(tp, 2);
1417 if (tp->esc_state == ESsquare) {
1418 tp->esc_state = ESgetpars;
1419 memset(tp->esc_par, 0, sizeof(tp->esc_par));
1421 tp->esc_ques = (ch == '?');
1425 if (tp->esc_state == ESgetpars) {
1426 if (ch == ';' && tp->esc_npar < ESCAPE_NPAR - 1) {
1430 if (ch >= '0' && ch <= '9') {
1431 tp->esc_par[tp->esc_npar] *= 10;
1432 tp->esc_par[tp->esc_npar] += ch - '0';
1436 tp->esc_state = ESnormal;
1437 if (ch == 'n' && !tp->esc_ques) {
1438 if (tp->esc_par[0] == 5) /* Status report. */
1439 kbd_puts_queue(tp->tty, "\033[0n");
1440 else if (tp->esc_par[0] == 6) { /* Cursor report. */
1442 sprintf(buf, "\033[%d;%dR", tp->cy + 1, tp->cx + 1);
1443 kbd_puts_queue(tp->tty, buf);
1451 tty3270_set_attributes(tp);
1453 case 'H': /* Set cursor position. */
1455 tty3270_goto_xy(tp, tty3270_getpar(tp, 1) - 1,
1456 tty3270_getpar(tp, 0) - 1);
1458 case 'd': /* Set y position. */
1459 tty3270_goto_xy(tp, tp->cx, tty3270_getpar(tp, 0) - 1);
1461 case 'A': /* Cursor up. */
1463 tty3270_goto_xy(tp, tp->cx, tp->cy - tty3270_getpar(tp, 0));
1465 case 'B': /* Cursor down. */
1468 tty3270_goto_xy(tp, tp->cx, tp->cy + tty3270_getpar(tp, 0));
1470 case 'C': /* Cursor forward. */
1472 tty3270_goto_xy(tp, tp->cx + tty3270_getpar(tp, 0), tp->cy);
1474 case 'D': /* Cursor backward. */
1475 tty3270_goto_xy(tp, tp->cx - tty3270_getpar(tp, 0), tp->cy);
1477 case 'G': /* Set x position. */
1479 tty3270_goto_xy(tp, tty3270_getpar(tp, 0), tp->cy);
1481 case 'X': /* Erase Characters. */
1482 tty3270_erase_characters(tp, tty3270_getpar(tp, 0));
1484 case 'J': /* Erase display. */
1485 tty3270_erase_display(tp, tp->esc_par[0]);
1487 case 'K': /* Erase line. */
1488 tty3270_erase_line(tp, tp->esc_par[0]);
1490 case 'P': /* Delete characters. */
1491 tty3270_delete_characters(tp, tty3270_getpar(tp, 0));
1493 case '@': /* Insert characters. */
1494 tty3270_insert_characters(tp, tty3270_getpar(tp, 0));
1496 case 's': /* Save cursor position. */
1497 tp->saved_cx = tp->cx;
1498 tp->saved_cy = tp->cy;
1499 tp->saved_highlight = tp->highlight;
1500 tp->saved_f_color = tp->f_color;
1502 case 'u': /* Restore cursor position. */
1503 tty3270_convert_line(tp, tp->cy);
1504 tty3270_goto_xy(tp, tp->saved_cx, tp->saved_cy);
1505 tp->highlight = tp->saved_highlight;
1506 tp->f_color = tp->saved_f_color;
1512 * String write routine for 3270 ttys
1515 tty3270_do_write(struct tty3270 *tp, const unsigned char *buf, int count)
1519 spin_lock_bh(&tp->view.lock);
1520 for (i_msg = 0; !tp->tty->stopped && i_msg < count; i_msg++) {
1521 if (tp->esc_state != 0) {
1522 /* Continue escape sequence. */
1523 tty3270_escape_sequence(tp, buf[i_msg]);
1527 switch (buf[i_msg]) {
1528 case 0x07: /* '\a' -- Alarm */
1529 tp->wcc |= TW_PLUSALARM;
1531 case 0x08: /* Backspace. */
1534 tty3270_put_character(tp, ' ');
1537 case 0x09: /* '\t' -- Tabulate */
1538 for (i = tp->cx % 8; i < 8; i++) {
1539 if (tp->cx >= tp->view.cols) {
1544 tty3270_put_character(tp, ' ');
1548 case 0x0a: /* '\n' -- New Line */
1552 case 0x0c: /* '\f' -- Form Feed */
1553 tty3270_erase_display(tp, 2);
1554 tp->cx = tp->cy = 0;
1556 case 0x0d: /* '\r' -- Carriage Return */
1559 case 0x0f: /* SuSE "exit alternate mode" */
1561 case 0x1b: /* Start escape sequence. */
1562 tty3270_escape_sequence(tp, buf[i_msg]);
1564 default: /* Insert normal character. */
1565 if (tp->cx >= tp->view.cols) {
1569 tty3270_put_character(tp, buf[i_msg]);
1574 /* Convert current line to 3270 data fragment. */
1575 tty3270_convert_line(tp, tp->cy);
1577 /* Setup timer to update display after 1/10 second */
1578 if (!timer_pending(&tp->timer))
1579 tty3270_set_timer(tp, HZ/10);
1581 spin_unlock_bh(&tp->view.lock);
1585 * String write routine for 3270 ttys
1588 tty3270_write(struct tty_struct * tty,
1589 const unsigned char *buf, int count)
1593 tp = tty->driver_data;
1596 if (tp->char_count > 0) {
1597 tty3270_do_write(tp, tp->char_buf, tp->char_count);
1600 tty3270_do_write(tp, buf, count);
1605 * Put single characters to the ttys character buffer
1607 static int tty3270_put_char(struct tty_struct *tty, unsigned char ch)
1611 tp = tty->driver_data;
1612 if (!tp || tp->char_count >= TTY3270_CHAR_BUF_SIZE)
1614 tp->char_buf[tp->char_count++] = ch;
1619 * Flush all characters from the ttys characeter buffer put there
1620 * by tty3270_put_char.
1623 tty3270_flush_chars(struct tty_struct *tty)
1627 tp = tty->driver_data;
1630 if (tp->char_count > 0) {
1631 tty3270_do_write(tp, tp->char_buf, tp->char_count);
1637 * Returns the number of characters in the output buffer. This is
1638 * used in tty_wait_until_sent to wait until all characters have
1639 * appeared on the screen.
1642 tty3270_chars_in_buffer(struct tty_struct *tty)
1648 tty3270_flush_buffer(struct tty_struct *tty)
1653 * Check for visible/invisible input switches
1656 tty3270_set_termios(struct tty_struct *tty, struct ktermios *old)
1661 tp = tty->driver_data;
1664 spin_lock_bh(&tp->view.lock);
1665 if (L_ICANON(tty)) {
1666 new = L_ECHO(tty) ? TF_INPUT: TF_INPUTN;
1667 if (new != tp->inattr) {
1669 tty3270_update_prompt(tp, NULL, 0);
1670 tty3270_set_timer(tp, 1);
1673 spin_unlock_bh(&tp->view.lock);
1677 * Disable reading from a 3270 tty
1680 tty3270_throttle(struct tty_struct * tty)
1684 tp = tty->driver_data;
1691 * Enable reading from a 3270 tty
1694 tty3270_unthrottle(struct tty_struct * tty)
1698 tp = tty->driver_data;
1703 tty3270_issue_read(tp, 1);
1707 * Hang up the tty device.
1710 tty3270_hangup(struct tty_struct *tty)
1716 tty3270_wait_until_sent(struct tty_struct *tty, int timeout)
1721 tty3270_ioctl(struct tty_struct *tty, struct file *file,
1722 unsigned int cmd, unsigned long arg)
1726 tp = tty->driver_data;
1729 if (tty->flags & (1 << TTY_IO_ERROR))
1731 return kbd_ioctl(tp->kbd, file, cmd, arg);
1734 static const struct tty_operations tty3270_ops = {
1735 .open = tty3270_open,
1736 .close = tty3270_close,
1737 .write = tty3270_write,
1738 .put_char = tty3270_put_char,
1739 .flush_chars = tty3270_flush_chars,
1740 .write_room = tty3270_write_room,
1741 .chars_in_buffer = tty3270_chars_in_buffer,
1742 .flush_buffer = tty3270_flush_buffer,
1743 .throttle = tty3270_throttle,
1744 .unthrottle = tty3270_unthrottle,
1745 .hangup = tty3270_hangup,
1746 .wait_until_sent = tty3270_wait_until_sent,
1747 .ioctl = tty3270_ioctl,
1748 .set_termios = tty3270_set_termios
1752 * 3270 tty registration code called from tty_init().
1753 * Most kernel services (incl. kmalloc) are available at this poimt.
1755 static int __init tty3270_init(void)
1757 struct tty_driver *driver;
1760 driver = alloc_tty_driver(RAW3270_MAXDEVS);
1765 * Initialize the tty_driver structure
1766 * Entries in tty3270_driver that are NOT initialized:
1767 * proc_entry, set_termios, flush_buffer, set_ldisc, write_proc
1769 driver->owner = THIS_MODULE;
1770 driver->driver_name = "ttyTUB";
1771 driver->name = "ttyTUB";
1772 driver->major = IBM_TTY3270_MAJOR;
1773 driver->minor_start = RAW3270_FIRSTMINOR;
1774 driver->type = TTY_DRIVER_TYPE_SYSTEM;
1775 driver->subtype = SYSTEM_TYPE_TTY;
1776 driver->init_termios = tty_std_termios;
1777 driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_DYNAMIC_DEV;
1778 tty_set_operations(driver, &tty3270_ops);
1779 ret = tty_register_driver(driver);
1781 put_tty_driver(driver);
1784 tty3270_driver = driver;
1791 struct tty_driver *driver;
1793 driver = tty3270_driver;
1794 tty3270_driver = NULL;
1795 tty_unregister_driver(driver);
1796 tty3270_del_views();
1799 MODULE_LICENSE("GPL");
1800 MODULE_ALIAS_CHARDEV_MAJOR(IBM_TTY3270_MAJOR);
1802 module_init(tty3270_init);
1803 module_exit(tty3270_exit);