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 15
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 if (timer_pending(&tp->timer) && del_timer(&tp->timer))
126 raw3270_put_view(&tp->view);
129 if (timer_pending(&tp->timer) &&
130 mod_timer(&tp->timer, jiffies + expires))
132 raw3270_get_view(&tp->view);
133 tp->timer.function = (void (*)(unsigned long)) tty3270_update;
134 tp->timer.data = (unsigned long) tp;
135 tp->timer.expires = jiffies + expires;
136 add_timer(&tp->timer);
140 * The input line are the two last lines of the screen.
143 tty3270_update_prompt(struct tty3270 *tp, char *input, int count)
150 line->string[5] = TF_INMDT;
152 line->string[5] = tp->inattr;
153 if (count > tp->view.cols * 2 - 11)
154 count = tp->view.cols * 2 - 11;
155 memcpy(line->string + 6, input, count);
156 line->string[6 + count] = TO_IC;
157 /* Clear to end of input line. */
158 if (count < tp->view.cols * 2 - 11) {
159 line->string[7 + count] = TO_RA;
160 line->string[10 + count] = 0;
161 off = tp->view.cols * tp->view.rows - 9;
162 raw3270_buffer_address(tp->view.dev, line->string+count+8, off);
163 line->len = 11 + count;
165 line->len = 7 + count;
166 tp->update_flags |= TTY_UPDATE_INPUT;
170 tty3270_create_prompt(struct tty3270 *tp)
172 static const unsigned char blueprint[] =
173 { TO_SBA, 0, 0, 0x6e, TO_SF, TF_INPUT,
174 /* empty input string */
175 TO_IC, TO_RA, 0, 0, 0 };
179 line = alloc_string(&tp->freemem,
180 sizeof(blueprint) + tp->view.cols * 2 - 9);
182 tp->inattr = TF_INPUT;
183 /* Copy blueprint to status line */
184 memcpy(line->string, blueprint, sizeof(blueprint));
185 line->len = sizeof(blueprint);
186 /* Set output offsets. */
187 offset = tp->view.cols * (tp->view.rows - 2);
188 raw3270_buffer_address(tp->view.dev, line->string + 1, offset);
189 offset = tp->view.cols * tp->view.rows - 9;
190 raw3270_buffer_address(tp->view.dev, line->string + 8, offset);
192 /* Allocate input string for reading. */
193 tp->input = alloc_string(&tp->freemem, tp->view.cols * 2 - 9 + 6);
197 * The status line is the last line of the screen. It shows the string
198 * "Running"/"Holding" in the lower right corner of the screen.
201 tty3270_update_status(struct tty3270 * tp)
205 str = (tp->nr_up != 0) ? "History" : "Running";
206 memcpy(tp->status->string + 8, str, 7);
207 codepage_convert(tp->view.ascebc, tp->status->string + 8, 7);
208 tp->update_flags |= TTY_UPDATE_STATUS;
212 tty3270_create_status(struct tty3270 * tp)
214 static const unsigned char blueprint[] =
215 { TO_SBA, 0, 0, TO_SF, TF_LOG, TO_SA, TAT_COLOR, TAC_GREEN,
216 0, 0, 0, 0, 0, 0, 0, TO_SF, TF_LOG, TO_SA, TAT_COLOR,
221 line = alloc_string(&tp->freemem,sizeof(blueprint));
223 /* Copy blueprint to status line */
224 memcpy(line->string, blueprint, sizeof(blueprint));
225 /* Set address to start of status string (= last 9 characters). */
226 offset = tp->view.cols * tp->view.rows - 9;
227 raw3270_buffer_address(tp->view.dev, line->string + 1, offset);
231 * Set output offsets to 3270 datastream fragment of a tty string.
232 * (TO_SBA offset at the start and TO_RA offset at the end of the string)
235 tty3270_update_string(struct tty3270 *tp, struct string *line, int nr)
239 raw3270_buffer_address(tp->view.dev, line->string + 1,
241 cp = line->string + line->len - 4;
243 raw3270_buffer_address(tp->view.dev, cp + 1,
244 tp->view.cols * (nr + 1));
248 * Rebuild update list to print all lines.
251 tty3270_rebuild_update(struct tty3270 *tp)
253 struct string *s, *n;
257 * Throw away update list and create a new one,
258 * containing all lines that will fit on the screen.
260 list_for_each_entry_safe(s, n, &tp->update, update)
261 list_del_init(&s->update);
262 line = tp->view.rows - 3;
264 list_for_each_entry_reverse(s, &tp->lines, list) {
269 tty3270_update_string(tp, s, line);
270 list_add(&s->update, &tp->update);
274 tp->update_flags |= TTY_UPDATE_LIST;
278 * Alloc string for size bytes. If there is not enough room in
279 * freemem, free strings until there is room.
281 static struct string *
282 tty3270_alloc_string(struct tty3270 *tp, size_t size)
284 struct string *s, *n;
286 s = alloc_string(&tp->freemem, size);
289 list_for_each_entry_safe(s, n, &tp->lines, list) {
290 BUG_ON(tp->nr_lines <= tp->view.rows - 2);
292 if (!list_empty(&s->update))
293 list_del(&s->update);
295 if (free_string(&tp->freemem, s) >= size)
298 s = alloc_string(&tp->freemem, size);
300 if (tp->nr_up != 0 &&
301 tp->nr_up + tp->view.rows - 2 >= tp->nr_lines) {
302 tp->nr_up = tp->nr_lines - tp->view.rows + 2;
303 tty3270_rebuild_update(tp);
304 tty3270_update_status(tp);
310 * Add an empty line to the list.
313 tty3270_blank_line(struct tty3270 *tp)
315 static const unsigned char blueprint[] =
316 { TO_SBA, 0, 0, TO_SA, TAT_EXTHI, TAX_RESET,
317 TO_SA, TAT_COLOR, TAC_RESET, TO_RA, 0, 0, 0 };
320 s = tty3270_alloc_string(tp, sizeof(blueprint));
321 memcpy(s->string, blueprint, sizeof(blueprint));
322 s->len = sizeof(blueprint);
323 list_add_tail(&s->list, &tp->lines);
330 * Write request completion callback.
333 tty3270_write_callback(struct raw3270_request *rq, void *data)
337 tp = (struct tty3270 *) rq->view;
339 /* Write wasn't successfull. Refresh all. */
340 tty3270_rebuild_update(tp);
341 tp->update_flags = TTY_UPDATE_ALL;
342 tty3270_set_timer(tp, 1);
344 raw3270_request_reset(rq);
345 xchg(&tp->write, rq);
349 * Update 3270 display.
352 tty3270_update(struct tty3270 *tp)
354 static char invalid_sba[2] = { 0xff, 0xff };
355 struct raw3270_request *wrq;
356 unsigned long updated;
357 struct string *s, *n;
361 wrq = xchg(&tp->write, 0);
363 tty3270_set_timer(tp, 1);
367 spin_lock(&tp->view.lock);
369 if (tp->update_flags & TTY_UPDATE_ERASE) {
370 /* Use erase write alternate to erase display. */
371 raw3270_request_set_cmd(wrq, TC_EWRITEA);
372 updated |= TTY_UPDATE_ERASE;
374 raw3270_request_set_cmd(wrq, TC_WRITE);
376 raw3270_request_add_data(wrq, &tp->wcc, 1);
380 * Update status line.
382 if (tp->update_flags & TTY_UPDATE_STATUS)
383 if (raw3270_request_add_data(wrq, tp->status->string,
384 tp->status->len) == 0)
385 updated |= TTY_UPDATE_STATUS;
390 if (tp->update_flags & TTY_UPDATE_INPUT)
391 if (raw3270_request_add_data(wrq, tp->prompt->string,
392 tp->prompt->len) == 0)
393 updated |= TTY_UPDATE_INPUT;
397 if (tp->update_flags & TTY_UPDATE_LIST) {
398 /* Write strings in the update list to the screen. */
399 list_for_each_entry_safe(s, n, &tp->update, update) {
403 * Skip TO_SBA at the start of the string if the
404 * last output position matches the start address
407 if (s->string[1] == sba[0] && s->string[2] == sba[1])
409 if (raw3270_request_add_data(wrq, str, len) != 0)
411 list_del_init(&s->update);
412 sba = s->string + s->len - 3;
414 if (list_empty(&tp->update))
415 updated |= TTY_UPDATE_LIST;
417 wrq->callback = tty3270_write_callback;
418 rc = raw3270_start(&tp->view, wrq);
420 tp->update_flags &= ~updated;
421 if (tp->update_flags)
422 tty3270_set_timer(tp, 1);
424 raw3270_request_reset(wrq);
425 xchg(&tp->write, wrq);
427 spin_unlock(&tp->view.lock);
428 raw3270_put_view(&tp->view);
435 tty3270_rcl_add(struct tty3270 *tp, char *input, int len)
442 if (tp->rcl_nr >= tp->rcl_max) {
443 s = list_entry(tp->rcl_lines.next, struct string, list);
445 free_string(&tp->freemem, s);
448 s = tty3270_alloc_string(tp, len);
449 memcpy(s->string, input, len);
450 list_add_tail(&s->list, &tp->rcl_lines);
455 tty3270_rcl_backward(struct kbd_data *kbd)
460 tp = kbd->tty->driver_data;
461 spin_lock_bh(&tp->view.lock);
462 if (tp->inattr == TF_INPUT) {
463 if (tp->rcl_walk && tp->rcl_walk->prev != &tp->rcl_lines)
464 tp->rcl_walk = tp->rcl_walk->prev;
465 else if (!list_empty(&tp->rcl_lines))
466 tp->rcl_walk = tp->rcl_lines.prev;
468 list_entry(tp->rcl_walk, struct string, list) : NULL;
470 s = list_entry(tp->rcl_walk, struct string, list);
471 tty3270_update_prompt(tp, s->string, s->len);
473 tty3270_update_prompt(tp, NULL, 0);
474 tty3270_set_timer(tp, 1);
476 spin_unlock_bh(&tp->view.lock);
480 * Deactivate tty view.
483 tty3270_exit_tty(struct kbd_data *kbd)
487 tp = kbd->tty->driver_data;
488 raw3270_deactivate_view(&tp->view);
492 * Scroll forward in history.
495 tty3270_scroll_forward(struct kbd_data *kbd)
500 tp = kbd->tty->driver_data;
501 spin_lock_bh(&tp->view.lock);
502 nr_up = tp->nr_up - tp->view.rows + 2;
505 if (nr_up != tp->nr_up) {
507 tty3270_rebuild_update(tp);
508 tty3270_update_status(tp);
509 tty3270_set_timer(tp, 1);
511 spin_unlock_bh(&tp->view.lock);
515 * Scroll backward in history.
518 tty3270_scroll_backward(struct kbd_data *kbd)
523 tp = kbd->tty->driver_data;
524 spin_lock_bh(&tp->view.lock);
525 nr_up = tp->nr_up + tp->view.rows - 2;
526 if (nr_up + tp->view.rows - 2 > tp->nr_lines)
527 nr_up = tp->nr_lines - tp->view.rows + 2;
528 if (nr_up != tp->nr_up) {
530 tty3270_rebuild_update(tp);
531 tty3270_update_status(tp);
532 tty3270_set_timer(tp, 1);
534 spin_unlock_bh(&tp->view.lock);
538 * Pass input line to tty.
541 tty3270_read_tasklet(struct raw3270_request *rrq)
543 static char kreset_data = TW_KR;
548 tp = (struct tty3270 *) rrq->view;
549 spin_lock_bh(&tp->view.lock);
551 * Two AID keys are special: For 0x7d (enter) the input line
552 * has to be emitted to the tty and for 0x6d the screen
553 * needs to be redrawn.
557 if (tp->input->string[0] == 0x7d) {
558 /* Enter: write input to tty. */
559 input = tp->input->string + 6;
560 len = tp->input->len - 6 - rrq->rescnt;
561 if (tp->inattr != TF_INPUTN)
562 tty3270_rcl_add(tp, input, len);
565 tty3270_rebuild_update(tp);
566 tty3270_update_status(tp);
568 /* Clear input area. */
569 tty3270_update_prompt(tp, NULL, 0);
570 tty3270_set_timer(tp, 1);
571 } else if (tp->input->string[0] == 0x6d) {
572 /* Display has been cleared. Redraw. */
573 tty3270_rebuild_update(tp);
574 tp->update_flags = TTY_UPDATE_ALL;
575 tty3270_set_timer(tp, 1);
577 spin_unlock_bh(&tp->view.lock);
579 /* Start keyboard reset command. */
580 raw3270_request_reset(tp->kreset);
581 raw3270_request_set_cmd(tp->kreset, TC_WRITE);
582 raw3270_request_add_data(tp->kreset, &kreset_data, 1);
583 raw3270_start(&tp->view, tp->kreset);
585 /* Emit input string. */
588 kbd_keycode(tp->kbd, *input++);
589 /* Emit keycode for AID byte. */
590 kbd_keycode(tp->kbd, 256 + tp->input->string[0]);
593 raw3270_request_reset(rrq);
594 xchg(&tp->read, rrq);
595 raw3270_put_view(&tp->view);
599 * Read request completion callback.
602 tty3270_read_callback(struct raw3270_request *rq, void *data)
604 raw3270_get_view(rq->view);
605 /* Schedule tasklet to pass input to tty. */
606 tasklet_schedule(&((struct tty3270 *) rq->view)->readlet);
610 * Issue a read request. Call with device lock.
613 tty3270_issue_read(struct tty3270 *tp, int lock)
615 struct raw3270_request *rrq;
618 rrq = xchg(&tp->read, 0);
620 /* Read already scheduled. */
622 rrq->callback = tty3270_read_callback;
623 rrq->callback_data = tp;
624 raw3270_request_set_cmd(rrq, TC_READMOD);
625 raw3270_request_set_data(rrq, tp->input->string, tp->input->len);
626 /* Issue the read modified request. */
628 rc = raw3270_start(&tp->view, rrq);
630 rc = raw3270_start_irq(&tp->view, rrq);
632 raw3270_request_reset(rrq);
633 xchg(&tp->read, rrq);
638 * Switch to the tty view.
641 tty3270_activate(struct raw3270_view *view)
646 tp = (struct tty3270 *) view;
647 spin_lock_irqsave(&tp->view.lock, flags);
649 tty3270_rebuild_update(tp);
650 tty3270_update_status(tp);
651 tp->update_flags = TTY_UPDATE_ALL;
652 tty3270_set_timer(tp, 1);
653 spin_unlock_irqrestore(&tp->view.lock, flags);
658 tty3270_deactivate(struct raw3270_view *view)
663 tty3270_irq(struct tty3270 *tp, struct raw3270_request *rq, struct irb *irb)
665 /* Handle ATTN. Schedule tasklet to read aid. */
666 if (irb->scsw.dstat & DEV_STAT_ATTENTION) {
668 tty3270_issue_read(tp, 0);
674 if (irb->scsw.dstat & DEV_STAT_UNIT_CHECK)
677 /* Normal end. Copy residual count. */
678 rq->rescnt = irb->scsw.count;
680 return RAW3270_IO_DONE;
684 * Allocate tty3270 structure.
686 static struct tty3270 *
687 tty3270_alloc_view(void)
692 tp = kzalloc(sizeof(struct tty3270), GFP_KERNEL);
696 kmalloc(sizeof(void *) * TTY3270_STRING_PAGES, GFP_KERNEL);
697 if (!tp->freemem_pages)
699 INIT_LIST_HEAD(&tp->freemem);
700 for (pages = 0; pages < TTY3270_STRING_PAGES; pages++) {
701 tp->freemem_pages[pages] = (void *)
702 __get_free_pages(GFP_KERNEL|GFP_DMA, 0);
703 if (!tp->freemem_pages[pages])
705 add_string_memory(&tp->freemem,
706 tp->freemem_pages[pages], PAGE_SIZE);
708 tp->write = raw3270_request_alloc(TTY3270_OUTPUT_BUFFER_SIZE);
709 if (IS_ERR(tp->write))
711 tp->read = raw3270_request_alloc(0);
712 if (IS_ERR(tp->read))
714 tp->kreset = raw3270_request_alloc(1);
715 if (IS_ERR(tp->kreset))
717 tp->kbd = kbd_alloc();
723 raw3270_request_free(tp->kreset);
725 raw3270_request_free(tp->read);
727 raw3270_request_free(tp->write);
730 free_pages((unsigned long) tp->freemem_pages[pages], 0);
731 kfree(tp->freemem_pages);
735 return ERR_PTR(-ENOMEM);
739 * Free tty3270 structure.
742 tty3270_free_view(struct tty3270 *tp)
747 raw3270_request_free(tp->kreset);
748 raw3270_request_free(tp->read);
749 raw3270_request_free(tp->write);
750 for (pages = 0; pages < TTY3270_STRING_PAGES; pages++)
751 free_pages((unsigned long) tp->freemem_pages[pages], 0);
752 kfree(tp->freemem_pages);
757 * Allocate tty3270 screen.
760 tty3270_alloc_screen(struct tty3270 *tp)
765 size = sizeof(struct tty3270_line) * (tp->view.rows - 2);
766 tp->screen = kzalloc(size, GFP_KERNEL);
769 for (lines = 0; lines < tp->view.rows - 2; lines++) {
770 size = sizeof(struct tty3270_cell) * tp->view.cols;
771 tp->screen[lines].cells = kzalloc(size, GFP_KERNEL);
772 if (!tp->screen[lines].cells)
778 kfree(tp->screen[lines].cells);
785 * Free tty3270 screen.
788 tty3270_free_screen(struct tty3270 *tp)
792 for (lines = 0; lines < tp->view.rows - 2; lines++)
793 kfree(tp->screen[lines].cells);
798 * Unlink tty3270 data structure from tty.
801 tty3270_release(struct raw3270_view *view)
804 struct tty_struct *tty;
806 tp = (struct tty3270 *) view;
809 tty->driver_data = NULL;
810 tp->tty = tp->kbd->tty = NULL;
812 raw3270_put_view(&tp->view);
817 * Free tty3270 data structure
820 tty3270_free(struct raw3270_view *view)
822 tty3270_free_screen((struct tty3270 *) view);
823 tty3270_free_view((struct tty3270 *) view);
827 * Delayed freeing of tty3270 views.
830 tty3270_del_views(void)
835 for (i = 0; i < tty3270_max_index; i++) {
836 tp = (struct tty3270 *)
837 raw3270_find_view(&tty3270_fn, i + RAW3270_FIRSTMINOR);
839 raw3270_del_view(&tp->view);
843 static struct raw3270_fn tty3270_fn = {
844 .activate = tty3270_activate,
845 .deactivate = tty3270_deactivate,
846 .intv = (void *) tty3270_irq,
847 .release = tty3270_release,
852 * This routine is called whenever a 3270 tty is opened.
855 tty3270_open(struct tty_struct *tty, struct file * filp)
862 /* Check if the tty3270 is already there. */
863 tp = (struct tty3270 *)
864 raw3270_find_view(&tty3270_fn,
865 tty->index + RAW3270_FIRSTMINOR);
867 tty->driver_data = tp;
868 tty->winsize.ws_row = tp->view.rows - 2;
869 tty->winsize.ws_col = tp->view.cols;
870 tty->low_latency = 0;
873 tp->inattr = TF_INPUT;
876 if (tty3270_max_index < tty->index + 1)
877 tty3270_max_index = tty->index + 1;
879 /* Quick exit if there is no device for tty->index. */
880 if (PTR_ERR(tp) == -ENODEV)
883 /* Allocate tty3270 structure on first open. */
884 tp = tty3270_alloc_view();
888 INIT_LIST_HEAD(&tp->lines);
889 INIT_LIST_HEAD(&tp->update);
890 INIT_LIST_HEAD(&tp->rcl_lines);
892 init_timer(&tp->timer);
893 tasklet_init(&tp->readlet,
894 (void (*)(unsigned long)) tty3270_read_tasklet,
895 (unsigned long) tp->read);
897 rc = raw3270_add_view(&tp->view, &tty3270_fn,
898 tty->index + RAW3270_FIRSTMINOR);
900 tty3270_free_view(tp);
904 rc = tty3270_alloc_screen(tp);
906 raw3270_put_view(&tp->view);
907 raw3270_del_view(&tp->view);
912 tty->low_latency = 0;
913 tty->driver_data = tp;
914 tty->winsize.ws_row = tp->view.rows - 2;
915 tty->winsize.ws_col = tp->view.cols;
917 tty3270_create_prompt(tp);
918 tty3270_create_status(tp);
919 tty3270_update_status(tp);
921 /* Create blank line for every line in the tty output area. */
922 for (i = 0; i < tp->view.rows - 2; i++)
923 tty3270_blank_line(tp);
926 tp->kbd->fn_handler[KVAL(K_INCRCONSOLE)] = tty3270_exit_tty;
927 tp->kbd->fn_handler[KVAL(K_SCROLLBACK)] = tty3270_scroll_backward;
928 tp->kbd->fn_handler[KVAL(K_SCROLLFORW)] = tty3270_scroll_forward;
929 tp->kbd->fn_handler[KVAL(K_CONS)] = tty3270_rcl_backward;
930 kbd_ascebc(tp->kbd, tp->view.ascebc);
932 raw3270_activate_view(&tp->view);
937 * This routine is called when the 3270 tty is closed. We wait
938 * for the remaining request to be completed. Then we clean up.
941 tty3270_close(struct tty_struct *tty, struct file * filp)
947 tp = (struct tty3270 *) tty->driver_data;
949 tty->driver_data = NULL;
950 tp->tty = tp->kbd->tty = NULL;
951 raw3270_put_view(&tp->view);
956 * We always have room.
959 tty3270_write_room(struct tty_struct *tty)
965 * Insert character into the screen at the current position with the
966 * current color and highlight. This function does NOT do cursor movement.
969 tty3270_put_character(struct tty3270 *tp, char ch)
971 struct tty3270_line *line;
972 struct tty3270_cell *cell;
974 line = tp->screen + tp->cy;
975 if (line->len <= tp->cx) {
976 while (line->len < tp->cx) {
977 cell = line->cells + line->len;
978 cell->character = tp->view.ascebc[' '];
979 cell->highlight = tp->highlight;
980 cell->f_color = tp->f_color;
985 cell = line->cells + tp->cx;
986 cell->character = tp->view.ascebc[(unsigned int) ch];
987 cell->highlight = tp->highlight;
988 cell->f_color = tp->f_color;
993 * Convert a tty3270_line to a 3270 data fragment usable for output.
996 tty3270_convert_line(struct tty3270 *tp, int line_nr)
998 struct tty3270_line *line;
999 struct tty3270_cell *cell;
1000 struct string *s, *n;
1001 unsigned char highlight;
1002 unsigned char f_color;
1006 /* Determine how long the fragment will be. */
1007 flen = 3; /* Prefix (TO_SBA). */
1008 line = tp->screen + line_nr;
1010 highlight = TAX_RESET;
1011 f_color = TAC_RESET;
1012 for (i = 0, cell = line->cells; i < line->len; i++, cell++) {
1013 if (cell->highlight != highlight) {
1014 flen += 3; /* TO_SA to switch highlight. */
1015 highlight = cell->highlight;
1017 if (cell->f_color != f_color) {
1018 flen += 3; /* TO_SA to switch color. */
1019 f_color = cell->f_color;
1022 if (highlight != TAX_RESET)
1023 flen += 3; /* TO_SA to reset hightlight. */
1024 if (f_color != TAC_RESET)
1025 flen += 3; /* TO_SA to reset color. */
1026 if (line->len < tp->view.cols)
1027 flen += 4; /* Postfix (TO_RA). */
1029 /* Find the line in the list. */
1030 i = tp->view.rows - 2 - line_nr;
1031 list_for_each_entry_reverse(s, &tp->lines, list)
1035 * Check if the line needs to get reallocated.
1037 if (s->len != flen) {
1038 /* Reallocate string. */
1039 n = tty3270_alloc_string(tp, flen);
1040 list_add(&n->list, &s->list);
1041 list_del_init(&s->list);
1042 if (!list_empty(&s->update))
1043 list_del_init(&s->update);
1044 free_string(&tp->freemem, s);
1048 /* Write 3270 data fragment. */
1054 highlight = TAX_RESET;
1055 f_color = TAC_RESET;
1056 for (i = 0, cell = line->cells; i < line->len; i++, cell++) {
1057 if (cell->highlight != highlight) {
1060 *cp++ = cell->highlight;
1061 highlight = cell->highlight;
1063 if (cell->f_color != f_color) {
1066 *cp++ = cell->f_color;
1067 f_color = cell->f_color;
1069 *cp++ = cell->character;
1071 if (highlight != TAX_RESET) {
1076 if (f_color != TAC_RESET) {
1081 if (line->len < tp->view.cols) {
1088 if (tp->nr_up + line_nr < tp->view.rows - 2) {
1089 /* Line is currently visible on screen. */
1090 tty3270_update_string(tp, s, line_nr);
1091 /* Add line to update list. */
1092 if (list_empty(&s->update)) {
1093 list_add_tail(&s->update, &tp->update);
1094 tp->update_flags |= TTY_UPDATE_LIST;
1100 * Do carriage return.
1103 tty3270_cr(struct tty3270 *tp)
1112 tty3270_lf(struct tty3270 *tp)
1114 struct tty3270_line temp;
1117 tty3270_convert_line(tp, tp->cy);
1118 if (tp->cy < tp->view.rows - 3) {
1122 /* Last line just filled up. Add new, blank line. */
1123 tty3270_blank_line(tp);
1124 temp = tp->screen[0];
1126 for (i = 0; i < tp->view.rows - 3; i++)
1127 tp->screen[i] = tp->screen[i+1];
1128 tp->screen[tp->view.rows - 3] = temp;
1129 tty3270_rebuild_update(tp);
1133 tty3270_ri(struct tty3270 *tp)
1136 tty3270_convert_line(tp, tp->cy);
1142 * Insert characters at current position.
1145 tty3270_insert_characters(struct tty3270 *tp, int n)
1147 struct tty3270_line *line;
1150 line = tp->screen + tp->cy;
1151 while (line->len < tp->cx) {
1152 line->cells[line->len].character = tp->view.ascebc[' '];
1153 line->cells[line->len].highlight = TAX_RESET;
1154 line->cells[line->len].f_color = TAC_RESET;
1157 if (n > tp->view.cols - tp->cx)
1158 n = tp->view.cols - tp->cx;
1159 k = min_t(int, line->len - tp->cx, tp->view.cols - tp->cx - n);
1161 line->cells[tp->cx + n + k] = line->cells[tp->cx + k];
1163 if (line->len > tp->view.cols)
1164 line->len = tp->view.cols;
1166 line->cells[tp->cx + n].character = tp->view.ascebc[' '];
1167 line->cells[tp->cx + n].highlight = tp->highlight;
1168 line->cells[tp->cx + n].f_color = tp->f_color;
1173 * Delete characters at current position.
1176 tty3270_delete_characters(struct tty3270 *tp, int n)
1178 struct tty3270_line *line;
1181 line = tp->screen + tp->cy;
1182 if (line->len <= tp->cx)
1184 if (line->len - tp->cx <= n) {
1188 for (i = tp->cx; i + n < line->len; i++)
1189 line->cells[i] = line->cells[i + n];
1194 * Erase characters at current position.
1197 tty3270_erase_characters(struct tty3270 *tp, int n)
1199 struct tty3270_line *line;
1200 struct tty3270_cell *cell;
1202 line = tp->screen + tp->cy;
1203 while (line->len > tp->cx && n-- > 0) {
1204 cell = line->cells + tp->cx++;
1205 cell->character = ' ';
1206 cell->highlight = TAX_RESET;
1207 cell->f_color = TAC_RESET;
1210 tp->cx = min_t(int, tp->cx, tp->view.cols - 1);
1214 * Erase line, 3 different cases:
1215 * Esc [ 0 K Erase from current position to end of line inclusive
1216 * Esc [ 1 K Erase from beginning of line to current position inclusive
1217 * Esc [ 2 K Erase entire line (without moving cursor)
1220 tty3270_erase_line(struct tty3270 *tp, int mode)
1222 struct tty3270_line *line;
1223 struct tty3270_cell *cell;
1226 line = tp->screen + tp->cy;
1229 else if (mode == 1) {
1230 for (i = 0; i < tp->cx; i++) {
1231 cell = line->cells + i;
1232 cell->character = ' ';
1233 cell->highlight = TAX_RESET;
1234 cell->f_color = TAC_RESET;
1236 if (line->len <= tp->cx)
1237 line->len = tp->cx + 1;
1238 } else if (mode == 2)
1240 tty3270_convert_line(tp, tp->cy);
1244 * Erase display, 3 different cases:
1245 * Esc [ 0 J Erase from current position to bottom of screen inclusive
1246 * Esc [ 1 J Erase from top of screen to current position inclusive
1247 * Esc [ 2 J Erase entire screen (without moving the cursor)
1250 tty3270_erase_display(struct tty3270 *tp, int mode)
1255 tty3270_erase_line(tp, 0);
1256 for (i = tp->cy + 1; i < tp->view.rows - 2; i++) {
1257 tp->screen[i].len = 0;
1258 tty3270_convert_line(tp, i);
1260 } else if (mode == 1) {
1261 for (i = 0; i < tp->cy; i++) {
1262 tp->screen[i].len = 0;
1263 tty3270_convert_line(tp, i);
1265 tty3270_erase_line(tp, 1);
1266 } else if (mode == 2) {
1267 for (i = 0; i < tp->view.rows - 2; i++) {
1268 tp->screen[i].len = 0;
1269 tty3270_convert_line(tp, i);
1272 tty3270_rebuild_update(tp);
1276 * Set attributes found in an escape sequence.
1277 * Esc [ <attr> ; <attr> ; ... m
1280 tty3270_set_attributes(struct tty3270 *tp)
1282 static unsigned char f_colors[] = {
1283 TAC_DEFAULT, TAC_RED, TAC_GREEN, TAC_YELLOW, TAC_BLUE,
1284 TAC_PINK, TAC_TURQ, TAC_WHITE, 0, TAC_DEFAULT
1288 for (i = 0; i <= tp->esc_npar; i++) {
1289 attr = tp->esc_par[i];
1292 tp->highlight = TAX_RESET;
1293 tp->f_color = TAC_RESET;
1296 case 4: /* Start underlining. */
1297 tp->highlight = TAX_UNDER;
1299 case 5: /* Start blink. */
1300 tp->highlight = TAX_BLINK;
1302 case 7: /* Start reverse. */
1303 tp->highlight = TAX_REVER;
1305 case 24: /* End underlining */
1306 if (tp->highlight == TAX_UNDER)
1307 tp->highlight = TAX_RESET;
1309 case 25: /* End blink. */
1310 if (tp->highlight == TAX_BLINK)
1311 tp->highlight = TAX_RESET;
1313 case 27: /* End reverse. */
1314 if (tp->highlight == TAX_REVER)
1315 tp->highlight = TAX_RESET;
1317 /* Foreground color. */
1318 case 30: /* Black */
1320 case 32: /* Green */
1321 case 33: /* Yellow */
1323 case 35: /* Magenta */
1325 case 37: /* White */
1326 case 39: /* Black */
1327 tp->f_color = f_colors[attr - 30];
1334 tty3270_getpar(struct tty3270 *tp, int ix)
1336 return (tp->esc_par[ix] > 0) ? tp->esc_par[ix] : 1;
1340 tty3270_goto_xy(struct tty3270 *tp, int cx, int cy)
1342 int max_cx = max(0, cx);
1343 int max_cy = max(0, cy);
1345 tp->cx = min_t(int, tp->view.cols - 1, max_cx);
1346 cy = min_t(int, tp->view.rows - 3, max_cy);
1348 tty3270_convert_line(tp, tp->cy);
1354 * Process escape sequences. Known sequences:
1355 * Esc 7 Save Cursor Position
1356 * Esc 8 Restore Cursor Position
1357 * Esc [ Pn ; Pn ; .. m Set attributes
1358 * Esc [ Pn ; Pn H Cursor Position
1359 * Esc [ Pn ; Pn f Cursor Position
1360 * Esc [ Pn A Cursor Up
1361 * Esc [ Pn B Cursor Down
1362 * Esc [ Pn C Cursor Forward
1363 * Esc [ Pn D Cursor Backward
1364 * Esc [ Pn G Cursor Horizontal Absolute
1365 * Esc [ Pn X Erase Characters
1366 * Esc [ Ps J Erase in Display
1367 * Esc [ Ps K Erase in Line
1368 * // FIXME: add all the new ones.
1370 * Pn is a numeric parameter, a string of zero or more decimal digits.
1371 * Ps is a selective parameter.
1374 tty3270_escape_sequence(struct tty3270 *tp, char ch)
1376 enum { ESnormal, ESesc, ESsquare, ESgetpars };
1378 if (tp->esc_state == ESnormal) {
1380 /* Starting new escape sequence. */
1381 tp->esc_state = ESesc;
1384 if (tp->esc_state == ESesc) {
1385 tp->esc_state = ESnormal;
1388 tp->esc_state = ESsquare;
1400 case 'Z': /* Respond ID. */
1401 kbd_puts_queue(tp->tty, "\033[?6c");
1403 case '7': /* Save cursor position. */
1404 tp->saved_cx = tp->cx;
1405 tp->saved_cy = tp->cy;
1406 tp->saved_highlight = tp->highlight;
1407 tp->saved_f_color = tp->f_color;
1409 case '8': /* Restore cursor position. */
1410 tty3270_convert_line(tp, tp->cy);
1411 tty3270_goto_xy(tp, tp->saved_cx, tp->saved_cy);
1412 tp->highlight = tp->saved_highlight;
1413 tp->f_color = tp->saved_f_color;
1415 case 'c': /* Reset terminal. */
1416 tp->cx = tp->saved_cx = 0;
1417 tp->cy = tp->saved_cy = 0;
1418 tp->highlight = tp->saved_highlight = TAX_RESET;
1419 tp->f_color = tp->saved_f_color = TAC_RESET;
1420 tty3270_erase_display(tp, 2);
1425 if (tp->esc_state == ESsquare) {
1426 tp->esc_state = ESgetpars;
1427 memset(tp->esc_par, 0, sizeof(tp->esc_par));
1429 tp->esc_ques = (ch == '?');
1433 if (tp->esc_state == ESgetpars) {
1434 if (ch == ';' && tp->esc_npar < ESCAPE_NPAR - 1) {
1438 if (ch >= '0' && ch <= '9') {
1439 tp->esc_par[tp->esc_npar] *= 10;
1440 tp->esc_par[tp->esc_npar] += ch - '0';
1444 tp->esc_state = ESnormal;
1445 if (ch == 'n' && !tp->esc_ques) {
1446 if (tp->esc_par[0] == 5) /* Status report. */
1447 kbd_puts_queue(tp->tty, "\033[0n");
1448 else if (tp->esc_par[0] == 6) { /* Cursor report. */
1450 sprintf(buf, "\033[%d;%dR", tp->cy + 1, tp->cx + 1);
1451 kbd_puts_queue(tp->tty, buf);
1459 tty3270_set_attributes(tp);
1461 case 'H': /* Set cursor position. */
1463 tty3270_goto_xy(tp, tty3270_getpar(tp, 1) - 1,
1464 tty3270_getpar(tp, 0) - 1);
1466 case 'd': /* Set y position. */
1467 tty3270_goto_xy(tp, tp->cx, tty3270_getpar(tp, 0) - 1);
1469 case 'A': /* Cursor up. */
1471 tty3270_goto_xy(tp, tp->cx, tp->cy - tty3270_getpar(tp, 0));
1473 case 'B': /* Cursor down. */
1476 tty3270_goto_xy(tp, tp->cx, tp->cy + tty3270_getpar(tp, 0));
1478 case 'C': /* Cursor forward. */
1480 tty3270_goto_xy(tp, tp->cx + tty3270_getpar(tp, 0), tp->cy);
1482 case 'D': /* Cursor backward. */
1483 tty3270_goto_xy(tp, tp->cx - tty3270_getpar(tp, 0), tp->cy);
1485 case 'G': /* Set x position. */
1487 tty3270_goto_xy(tp, tty3270_getpar(tp, 0), tp->cy);
1489 case 'X': /* Erase Characters. */
1490 tty3270_erase_characters(tp, tty3270_getpar(tp, 0));
1492 case 'J': /* Erase display. */
1493 tty3270_erase_display(tp, tp->esc_par[0]);
1495 case 'K': /* Erase line. */
1496 tty3270_erase_line(tp, tp->esc_par[0]);
1498 case 'P': /* Delete characters. */
1499 tty3270_delete_characters(tp, tty3270_getpar(tp, 0));
1501 case '@': /* Insert characters. */
1502 tty3270_insert_characters(tp, tty3270_getpar(tp, 0));
1504 case 's': /* Save cursor position. */
1505 tp->saved_cx = tp->cx;
1506 tp->saved_cy = tp->cy;
1507 tp->saved_highlight = tp->highlight;
1508 tp->saved_f_color = tp->f_color;
1510 case 'u': /* Restore cursor position. */
1511 tty3270_convert_line(tp, tp->cy);
1512 tty3270_goto_xy(tp, tp->saved_cx, tp->saved_cy);
1513 tp->highlight = tp->saved_highlight;
1514 tp->f_color = tp->saved_f_color;
1520 * String write routine for 3270 ttys
1523 tty3270_do_write(struct tty3270 *tp, const unsigned char *buf, int count)
1527 spin_lock_bh(&tp->view.lock);
1528 for (i_msg = 0; !tp->tty->stopped && i_msg < count; i_msg++) {
1529 if (tp->esc_state != 0) {
1530 /* Continue escape sequence. */
1531 tty3270_escape_sequence(tp, buf[i_msg]);
1535 switch (buf[i_msg]) {
1536 case 0x07: /* '\a' -- Alarm */
1537 tp->wcc |= TW_PLUSALARM;
1539 case 0x08: /* Backspace. */
1542 tty3270_put_character(tp, ' ');
1545 case 0x09: /* '\t' -- Tabulate */
1546 for (i = tp->cx % 8; i < 8; i++) {
1547 if (tp->cx >= tp->view.cols) {
1552 tty3270_put_character(tp, ' ');
1556 case 0x0a: /* '\n' -- New Line */
1560 case 0x0c: /* '\f' -- Form Feed */
1561 tty3270_erase_display(tp, 2);
1562 tp->cx = tp->cy = 0;
1564 case 0x0d: /* '\r' -- Carriage Return */
1567 case 0x0f: /* SuSE "exit alternate mode" */
1569 case 0x1b: /* Start escape sequence. */
1570 tty3270_escape_sequence(tp, buf[i_msg]);
1572 default: /* Insert normal character. */
1573 if (tp->cx >= tp->view.cols) {
1577 tty3270_put_character(tp, buf[i_msg]);
1582 /* Convert current line to 3270 data fragment. */
1583 tty3270_convert_line(tp, tp->cy);
1585 /* Setup timer to update display after 1/10 second */
1586 if (!timer_pending(&tp->timer))
1587 tty3270_set_timer(tp, HZ/10);
1589 spin_unlock_bh(&tp->view.lock);
1593 * String write routine for 3270 ttys
1596 tty3270_write(struct tty_struct * tty,
1597 const unsigned char *buf, int count)
1601 tp = tty->driver_data;
1604 if (tp->char_count > 0) {
1605 tty3270_do_write(tp, tp->char_buf, tp->char_count);
1608 tty3270_do_write(tp, buf, count);
1613 * Put single characters to the ttys character buffer
1616 tty3270_put_char(struct tty_struct *tty, unsigned char ch)
1620 tp = tty->driver_data;
1623 if (tp->char_count < TTY3270_CHAR_BUF_SIZE)
1624 tp->char_buf[tp->char_count++] = ch;
1628 * Flush all characters from the ttys characeter buffer put there
1629 * by tty3270_put_char.
1632 tty3270_flush_chars(struct tty_struct *tty)
1636 tp = tty->driver_data;
1639 if (tp->char_count > 0) {
1640 tty3270_do_write(tp, tp->char_buf, tp->char_count);
1646 * Returns the number of characters in the output buffer. This is
1647 * used in tty_wait_until_sent to wait until all characters have
1648 * appeared on the screen.
1651 tty3270_chars_in_buffer(struct tty_struct *tty)
1657 tty3270_flush_buffer(struct tty_struct *tty)
1662 * Check for visible/invisible input switches
1665 tty3270_set_termios(struct tty_struct *tty, struct ktermios *old)
1670 tp = tty->driver_data;
1673 spin_lock_bh(&tp->view.lock);
1674 if (L_ICANON(tty)) {
1675 new = L_ECHO(tty) ? TF_INPUT: TF_INPUTN;
1676 if (new != tp->inattr) {
1678 tty3270_update_prompt(tp, NULL, 0);
1679 tty3270_set_timer(tp, 1);
1682 spin_unlock_bh(&tp->view.lock);
1686 * Disable reading from a 3270 tty
1689 tty3270_throttle(struct tty_struct * tty)
1693 tp = tty->driver_data;
1700 * Enable reading from a 3270 tty
1703 tty3270_unthrottle(struct tty_struct * tty)
1707 tp = tty->driver_data;
1712 tty3270_issue_read(tp, 1);
1716 * Hang up the tty device.
1719 tty3270_hangup(struct tty_struct *tty)
1725 tty3270_wait_until_sent(struct tty_struct *tty, int timeout)
1730 tty3270_ioctl(struct tty_struct *tty, struct file *file,
1731 unsigned int cmd, unsigned long arg)
1735 tp = tty->driver_data;
1738 if (tty->flags & (1 << TTY_IO_ERROR))
1740 return kbd_ioctl(tp->kbd, file, cmd, arg);
1743 static const struct tty_operations tty3270_ops = {
1744 .open = tty3270_open,
1745 .close = tty3270_close,
1746 .write = tty3270_write,
1747 .put_char = tty3270_put_char,
1748 .flush_chars = tty3270_flush_chars,
1749 .write_room = tty3270_write_room,
1750 .chars_in_buffer = tty3270_chars_in_buffer,
1751 .flush_buffer = tty3270_flush_buffer,
1752 .throttle = tty3270_throttle,
1753 .unthrottle = tty3270_unthrottle,
1754 .hangup = tty3270_hangup,
1755 .wait_until_sent = tty3270_wait_until_sent,
1756 .ioctl = tty3270_ioctl,
1757 .set_termios = tty3270_set_termios
1760 static void tty3270_notifier(int index, int active)
1763 tty_register_device(tty3270_driver, index, NULL);
1765 tty_unregister_device(tty3270_driver, index);
1769 * 3270 tty registration code called from tty_init().
1770 * Most kernel services (incl. kmalloc) are available at this poimt.
1772 static int __init tty3270_init(void)
1774 struct tty_driver *driver;
1777 driver = alloc_tty_driver(RAW3270_MAXDEVS);
1782 * Initialize the tty_driver structure
1783 * Entries in tty3270_driver that are NOT initialized:
1784 * proc_entry, set_termios, flush_buffer, set_ldisc, write_proc
1786 driver->owner = THIS_MODULE;
1787 driver->driver_name = "ttyTUB";
1788 driver->name = "ttyTUB";
1789 driver->major = IBM_TTY3270_MAJOR;
1790 driver->minor_start = RAW3270_FIRSTMINOR;
1791 driver->type = TTY_DRIVER_TYPE_SYSTEM;
1792 driver->subtype = SYSTEM_TYPE_TTY;
1793 driver->init_termios = tty_std_termios;
1794 driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_DYNAMIC_DEV;
1795 tty_set_operations(driver, &tty3270_ops);
1796 ret = tty_register_driver(driver);
1798 printk(KERN_ERR "tty3270 registration failed with %d\n", ret);
1799 put_tty_driver(driver);
1802 tty3270_driver = driver;
1803 ret = raw3270_register_notifier(tty3270_notifier);
1805 printk(KERN_ERR "tty3270 notifier registration failed "
1807 put_tty_driver(driver);
1817 struct tty_driver *driver;
1819 raw3270_unregister_notifier(tty3270_notifier);
1820 driver = tty3270_driver;
1821 tty3270_driver = NULL;
1822 tty_unregister_driver(driver);
1823 tty3270_del_views();
1826 MODULE_LICENSE("GPL");
1827 MODULE_ALIAS_CHARDEV_MAJOR(IBM_TTY3270_MAJOR);
1829 module_init(tty3270_init);
1830 module_exit(tty3270_exit);