2 * Copyright (C) 2001 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
3 * Licensed under the GPL
6 #include "linux/irqreturn.h"
8 #include "linux/sched.h"
9 #include "linux/slab.h"
13 #include "kern_util.h"
16 #define LINE_BUFSIZE 4096
18 static irqreturn_t line_interrupt(int irq, void *data)
20 struct chan *chan = data;
21 struct line *line = chan->line;
22 struct tty_struct *tty = tty_port_tty_get(&line->port);
25 chan_interrupt(line, tty, irq);
31 * Returns the free space inside the ring buffer of this line.
33 * Should be called while holding line->lock (this does not modify data).
35 static int write_room(struct line *line)
39 if (line->buffer == NULL)
40 return LINE_BUFSIZE - 1;
42 /* This is for the case where the buffer is wrapped! */
43 n = line->head - line->tail;
46 n += LINE_BUFSIZE; /* The other case */
50 int line_write_room(struct tty_struct *tty)
52 struct line *line = tty->driver_data;
56 spin_lock_irqsave(&line->lock, flags);
57 room = write_room(line);
58 spin_unlock_irqrestore(&line->lock, flags);
63 int line_chars_in_buffer(struct tty_struct *tty)
65 struct line *line = tty->driver_data;
69 spin_lock_irqsave(&line->lock, flags);
70 /* write_room subtracts 1 for the needed NULL, so we readd it.*/
71 ret = LINE_BUFSIZE - (write_room(line) + 1);
72 spin_unlock_irqrestore(&line->lock, flags);
78 * This copies the content of buf into the circular buffer associated with
80 * The return value is the number of characters actually copied, i.e. the ones
81 * for which there was space: this function is not supposed to ever flush out
82 * the circular buffer.
84 * Must be called while holding line->lock!
86 static int buffer_data(struct line *line, const char *buf, int len)
90 if (line->buffer == NULL) {
91 line->buffer = kmalloc(LINE_BUFSIZE, GFP_ATOMIC);
92 if (line->buffer == NULL) {
93 printk(KERN_ERR "buffer_data - atomic allocation "
97 line->head = line->buffer;
98 line->tail = line->buffer;
101 room = write_room(line);
102 len = (len > room) ? room : len;
104 end = line->buffer + LINE_BUFSIZE - line->tail;
107 memcpy(line->tail, buf, len);
111 /* The circular buffer is wrapping */
112 memcpy(line->tail, buf, end);
114 memcpy(line->buffer, buf, len - end);
115 line->tail = line->buffer + len - end;
122 * Flushes the ring buffer to the output channels. That is, write_chan is
123 * called, passing it line->head as buffer, and an appropriate count.
125 * On exit, returns 1 when the buffer is empty,
126 * 0 when the buffer is not empty on exit,
127 * and -errno when an error occurred.
129 * Must be called while holding line->lock!*/
130 static int flush_buffer(struct line *line)
134 if ((line->buffer == NULL) || (line->head == line->tail))
137 if (line->tail < line->head) {
138 /* line->buffer + LINE_BUFSIZE is the end of the buffer! */
139 count = line->buffer + LINE_BUFSIZE - line->head;
141 n = write_chan(line->chan_out, line->head, count,
142 line->driver->write_irq);
147 * We have flushed from ->head to buffer end, now we
148 * must flush only from the beginning to ->tail.
150 line->head = line->buffer;
157 count = line->tail - line->head;
158 n = write_chan(line->chan_out, line->head, count,
159 line->driver->write_irq);
165 return line->head == line->tail;
168 void line_flush_buffer(struct tty_struct *tty)
170 struct line *line = tty->driver_data;
173 spin_lock_irqsave(&line->lock, flags);
175 spin_unlock_irqrestore(&line->lock, flags);
179 * We map both ->flush_chars and ->put_char (which go in pair) onto
180 * ->flush_buffer and ->write. Hope it's not that bad.
182 void line_flush_chars(struct tty_struct *tty)
184 line_flush_buffer(tty);
187 int line_put_char(struct tty_struct *tty, unsigned char ch)
189 return line_write(tty, &ch, sizeof(ch));
192 int line_write(struct tty_struct *tty, const unsigned char *buf, int len)
194 struct line *line = tty->driver_data;
198 spin_lock_irqsave(&line->lock, flags);
199 if (line->head != line->tail)
200 ret = buffer_data(line, buf, len);
202 n = write_chan(line->chan_out, buf, len,
203 line->driver->write_irq);
212 ret += buffer_data(line, buf + n, len);
215 spin_unlock_irqrestore(&line->lock, flags);
219 void line_set_termios(struct tty_struct *tty, struct ktermios * old)
224 static const struct {
229 /* don't print these, they flood the log ... */
230 { TCGETS, NULL, "TCGETS" },
231 { TCSETS, NULL, "TCSETS" },
232 { TCSETSW, NULL, "TCSETSW" },
233 { TCFLSH, NULL, "TCFLSH" },
234 { TCSBRK, NULL, "TCSBRK" },
236 /* general tty stuff */
237 { TCSETSF, KERN_DEBUG, "TCSETSF" },
238 { TCGETA, KERN_DEBUG, "TCGETA" },
239 { TIOCMGET, KERN_DEBUG, "TIOCMGET" },
240 { TCSBRKP, KERN_DEBUG, "TCSBRKP" },
241 { TIOCMSET, KERN_DEBUG, "TIOCMSET" },
243 /* linux-specific ones */
244 { TIOCLINUX, KERN_INFO, "TIOCLINUX" },
245 { KDGKBMODE, KERN_INFO, "KDGKBMODE" },
246 { KDGKBTYPE, KERN_INFO, "KDGKBTYPE" },
247 { KDSIGACCEPT, KERN_INFO, "KDSIGACCEPT" },
250 int line_ioctl(struct tty_struct *tty, unsigned int cmd,
271 /* Note: these are out of date as we now have TCGETS2 etc but this
272 whole lot should probably go away */
297 for (i = 0; i < ARRAY_SIZE(tty_ioctls); i++)
298 if (cmd == tty_ioctls[i].cmd)
300 if (i == ARRAY_SIZE(tty_ioctls)) {
301 printk(KERN_ERR "%s: %s: unknown ioctl: 0x%x\n",
302 __func__, tty->name, cmd);
310 void line_throttle(struct tty_struct *tty)
312 struct line *line = tty->driver_data;
314 deactivate_chan(line->chan_in, line->driver->read_irq);
318 void line_unthrottle(struct tty_struct *tty)
320 struct line *line = tty->driver_data;
323 chan_interrupt(line, tty, line->driver->read_irq);
326 * Maybe there is enough stuff pending that calling the interrupt
327 * throttles us again. In this case, line->throttled will be 1
328 * again and we shouldn't turn the interrupt back on.
330 if (!line->throttled)
331 reactivate_chan(line->chan_in, line->driver->read_irq);
334 static irqreturn_t line_write_interrupt(int irq, void *data)
336 struct chan *chan = data;
337 struct line *line = chan->line;
338 struct tty_struct *tty;
342 * Interrupts are disabled here because genirq keep irqs disabled when
343 * calling the action handler.
346 spin_lock(&line->lock);
347 err = flush_buffer(line);
349 spin_unlock(&line->lock);
351 } else if (err < 0) {
352 line->head = line->buffer;
353 line->tail = line->buffer;
355 spin_unlock(&line->lock);
357 tty = tty_port_tty_get(&line->port);
367 int line_setup_irq(int fd, int input, int output, struct line *line, void *data)
369 const struct line_driver *driver = line->driver;
370 int err = 0, flags = IRQF_SHARED | IRQF_SAMPLE_RANDOM;
373 err = um_request_irq(driver->read_irq, fd, IRQ_READ,
374 line_interrupt, flags,
375 driver->read_irq_name, data);
379 err = um_request_irq(driver->write_irq, fd, IRQ_WRITE,
380 line_write_interrupt, flags,
381 driver->write_irq_name, data);
386 * Normally, a driver like this can rely mostly on the tty layer
387 * locking, particularly when it comes to the driver structure.
388 * However, in this case, mconsole requests can come in "from the
389 * side", and race with opens and closes.
391 * mconsole config requests will want to be sure the device isn't in
392 * use, and get_config, open, and close will want a stable
393 * configuration. The checking and modification of the configuration
394 * is done under a spinlock. Checking whether the device is in use is
395 * line->tty->count > 1, also under the spinlock.
397 * line->count serves to decide whether the device should be enabled or
398 * disabled on the host. If it's equal to 0, then we are doing the
399 * first open or last close. Otherwise, open and close just return.
402 int line_open(struct line *lines, struct tty_struct *tty)
404 struct line *line = &lines[tty->index];
407 mutex_lock(&line->count_lock);
412 if (line->port.count++)
415 BUG_ON(tty->driver_data);
416 tty->driver_data = line;
417 tty_port_tty_set(&line->port, tty);
419 err = enable_chan(line);
420 if (err) /* line_close() will be called by our caller */
424 chan_enable_winch(line->chan_out, tty);
428 chan_window_size(line, &tty->winsize.ws_row,
429 &tty->winsize.ws_col);
431 mutex_unlock(&line->count_lock);
435 static void unregister_winch(struct tty_struct *tty);
437 void line_close(struct tty_struct *tty, struct file * filp)
439 struct line *line = tty->driver_data;
442 * If line_open fails (and tty->driver_data is never set),
443 * tty_open will call line_close. So just return in this case.
448 /* We ignore the error anyway! */
451 mutex_lock(&line->count_lock);
452 BUG_ON(!line->valid);
454 if (--line->port.count)
457 tty_port_tty_set(&line->port, NULL);
458 tty->driver_data = NULL;
461 unregister_winch(tty);
466 mutex_unlock(&line->count_lock);
469 void close_lines(struct line *lines, int nlines)
473 for(i = 0; i < nlines; i++)
474 close_chan(&lines[i]);
477 int setup_one_line(struct line *lines, int n, char *init,
478 const struct chan_opts *opts, char **error_out)
480 struct line *line = &lines[n];
481 struct tty_driver *driver = line->driver->driver;
484 mutex_lock(&line->count_lock);
486 if (line->port.count) {
487 *error_out = "Device is already open";
491 if (!strcmp(init, "none")) {
494 kfree(line->init_str);
495 tty_unregister_device(driver, n);
496 parse_chan_pair(NULL, line, n, opts, error_out);
500 char *new = kstrdup(init, GFP_KERNEL);
502 *error_out = "Failed to allocate memory";
506 tty_unregister_device(driver, n);
507 kfree(line->init_str);
509 line->init_str = new;
511 err = parse_chan_pair(new, line, n, opts, error_out);
513 struct device *d = tty_register_device(driver, n, NULL);
515 *error_out = "Failed to register device";
517 parse_chan_pair(NULL, line, n, opts, error_out);
521 line->init_str = NULL;
527 mutex_unlock(&line->count_lock);
532 * Common setup code for both startup command line and mconsole initialization.
533 * @lines contains the array (of size @num) to modify;
534 * @init is the setup string;
535 * @error_out is an error string in the case of failure;
538 int line_setup(char **conf, unsigned int num, char **def,
539 char *init, char *name)
545 * We said con=/ssl= instead of con#=, so we are configuring all
551 unsigned n = simple_strtoul(init, &end, 0);
554 error = "Couldn't parse device number";
558 error = "Device number out of range";
566 printk(KERN_ERR "Failed to set up %s with "
567 "configuration string \"%s\" : %s\n", name, init, error);
571 int line_config(struct line *lines, unsigned int num, char *str,
572 const struct chan_opts *opts, char **error_out)
578 *error_out = "Can't configure all devices from mconsole";
582 n = simple_strtoul(str, &end, 0);
584 *error_out = "Couldn't parse device number";
588 *error_out = "Device number out of range";
592 return setup_one_line(lines, n, end, opts, error_out);
595 int line_get_config(char *name, struct line *lines, unsigned int num, char *str,
596 int size, char **error_out)
602 dev = simple_strtoul(name, &end, 0);
603 if ((*end != '\0') || (end == name)) {
604 *error_out = "line_get_config failed to parse device number";
608 if ((dev < 0) || (dev >= num)) {
609 *error_out = "device number out of range";
615 mutex_lock(&line->count_lock);
617 CONFIG_CHUNK(str, size, n, "none", 1);
619 struct tty_struct *tty = tty_port_tty_get(&line->port);
621 CONFIG_CHUNK(str, size, n, line->init_str, 1);
623 n = chan_config_string(line, str, size, error_out);
627 mutex_unlock(&line->count_lock);
632 int line_id(char **str, int *start_out, int *end_out)
637 n = simple_strtoul(*str, &end, 0);
638 if ((*end != '\0') || (end == *str))
647 int line_remove(struct line *lines, unsigned int num, int n, char **error_out)
650 *error_out = "Device number out of range";
653 return setup_one_line(lines, n, "none", NULL, error_out);
656 int register_lines(struct line_driver *line_driver,
657 const struct tty_operations *ops,
658 struct line *lines, int nlines)
660 struct tty_driver *driver = alloc_tty_driver(nlines);
667 driver->driver_name = line_driver->name;
668 driver->name = line_driver->device_name;
669 driver->major = line_driver->major;
670 driver->minor_start = line_driver->minor_start;
671 driver->type = line_driver->type;
672 driver->subtype = line_driver->subtype;
673 driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
674 driver->init_termios = tty_std_termios;
676 for (i = 0; i < nlines; i++) {
677 tty_port_init(&lines[i].port);
678 spin_lock_init(&lines[i].lock);
679 mutex_init(&lines[i].count_lock);
680 lines[i].driver = line_driver;
681 INIT_LIST_HEAD(&lines[i].chan_list);
683 tty_set_operations(driver, ops);
685 err = tty_register_driver(driver);
687 printk(KERN_ERR "register_lines : can't register %s driver\n",
689 put_tty_driver(driver);
693 line_driver->driver = driver;
694 mconsole_register_dev(&line_driver->mc);
698 static DEFINE_SPINLOCK(winch_handler_lock);
699 static LIST_HEAD(winch_handlers);
702 struct list_head list;
706 struct tty_struct *tty;
708 struct work_struct work;
711 static void __free_winch(struct work_struct *work)
713 struct winch *winch = container_of(work, struct winch, work);
714 um_free_irq(WINCH_IRQ, winch);
716 if (winch->pid != -1)
717 os_kill_process(winch->pid, 1);
718 if (winch->stack != 0)
719 free_stack(winch->stack, 0);
723 static void free_winch(struct winch *winch)
729 list_del(&winch->list);
730 __free_winch(&winch->work);
733 static irqreturn_t winch_interrupt(int irq, void *data)
735 struct winch *winch = data;
736 struct tty_struct *tty;
743 err = generic_read(fd, &c, NULL);
745 if (err != -EAGAIN) {
747 list_del(&winch->list);
749 printk(KERN_ERR "winch_interrupt : "
750 "read failed, errno = %d\n", -err);
751 printk(KERN_ERR "fd %d is losing SIGWINCH "
752 "support\n", winch->tty_fd);
753 INIT_WORK(&winch->work, __free_winch);
754 schedule_work(&winch->work);
762 line = tty->driver_data;
764 chan_window_size(line, &tty->winsize.ws_row,
765 &tty->winsize.ws_col);
766 kill_pgrp(tty->pgrp, SIGWINCH, 1);
771 reactivate_fd(winch->fd, WINCH_IRQ);
775 void register_winch_irq(int fd, int tty_fd, int pid, struct tty_struct *tty,
780 winch = kmalloc(sizeof(*winch), GFP_KERNEL);
782 printk(KERN_ERR "register_winch_irq - kmalloc failed\n");
786 *winch = ((struct winch) { .list = LIST_HEAD_INIT(winch->list),
793 if (um_request_irq(WINCH_IRQ, fd, IRQ_READ, winch_interrupt,
794 IRQF_SHARED | IRQF_SAMPLE_RANDOM,
795 "winch", winch) < 0) {
796 printk(KERN_ERR "register_winch_irq - failed to register "
801 spin_lock(&winch_handler_lock);
802 list_add(&winch->list, &winch_handlers);
803 spin_unlock(&winch_handler_lock);
810 os_kill_process(pid, 1);
813 free_stack(stack, 0);
816 static void unregister_winch(struct tty_struct *tty)
818 struct list_head *ele, *next;
821 spin_lock(&winch_handler_lock);
823 list_for_each_safe(ele, next, &winch_handlers) {
824 winch = list_entry(ele, struct winch, list);
825 if (winch->tty == tty) {
830 spin_unlock(&winch_handler_lock);
833 static void winch_cleanup(void)
835 struct list_head *ele, *next;
838 spin_lock(&winch_handler_lock);
840 list_for_each_safe(ele, next, &winch_handlers) {
841 winch = list_entry(ele, struct winch, list);
845 spin_unlock(&winch_handler_lock);
847 __uml_exitcall(winch_cleanup);
849 char *add_xterm_umid(char *base)
858 len = strlen(base) + strlen(" ()") + strlen(umid) + 1;
859 title = kmalloc(len, GFP_KERNEL);
861 printk(KERN_ERR "Failed to allocate buffer for xterm title\n");
865 snprintf(title, len, "%s (%s)", base, umid);