2 * Copyright (C) 2001 Anton Blanchard <anton@au.ibm.com>, IBM
3 * Copyright (C) 2001 Paul Mackerras <paulus@au.ibm.com>, IBM
4 * Copyright (C) 2004 Benjamin Herrenschmidt <benh@kernel.crashing.org>, IBM Corp.
5 * Copyright (C) 2004 IBM Corporation
7 * Additional Author(s):
8 * Ryan S. Arnold <rsa@us.ibm.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/console.h>
26 #include <linux/cpumask.h>
27 #include <linux/init.h>
28 #include <linux/kbd_kern.h>
29 #include <linux/kernel.h>
30 #include <linux/kobject.h>
31 #include <linux/kthread.h>
32 #include <linux/list.h>
33 #include <linux/module.h>
34 #include <linux/major.h>
35 #include <linux/sysrq.h>
36 #include <linux/tty.h>
37 #include <linux/tty_flip.h>
38 #include <linux/sched.h>
39 #include <linux/spinlock.h>
40 #include <linux/delay.h>
41 #include <linux/freezer.h>
43 #include <asm/uaccess.h>
45 #include "hvc_console.h"
53 * Wait this long per iteration while trying to push buffered data to the
54 * hypervisor before allowing the tty to complete a close operation.
56 #define HVC_CLOSE_WAIT (HZ/100) /* 1/10 of a second */
59 * These sizes are most efficient for vio, because they are the
60 * native transfer size. We could make them selectable in the
61 * future to better deal with backends that want other buffer sizes.
66 #define __ALIGNED__ __attribute__((__aligned__(sizeof(long))))
68 static struct tty_driver *hvc_driver;
69 static struct task_struct *hvc_task;
71 /* Picks up late kicks after list walk but before schedule() */
72 static int hvc_kicked;
74 #ifdef CONFIG_MAGIC_SYSRQ
75 static int sysrq_pressed;
81 struct tty_struct *tty;
91 struct list_head next;
92 struct kobject kobj; /* ref count & hvc_struct lifetime */
95 /* dynamic list of hvc_struct instances */
96 static struct list_head hvc_structs = LIST_HEAD_INIT(hvc_structs);
99 * Protect the list of hvc_struct instances from inserts and removals during
102 static DEFINE_SPINLOCK(hvc_structs_lock);
105 * This value is used to assign a tty->index value to a hvc_struct based
106 * upon order of exposure via hvc_probe(), when we can not match it to
107 * a console canidate registered with hvc_instantiate().
109 static int last_hvc = -1;
112 * Do not call this function with either the hvc_strucst_lock or the hvc_struct
113 * lock held. If successful, this function increments the kobject reference
114 * count against the target hvc_struct so it should be released when finished.
116 struct hvc_struct *hvc_get_by_index(int index)
118 struct hvc_struct *hp;
121 spin_lock(&hvc_structs_lock);
123 list_for_each_entry(hp, &hvc_structs, next) {
124 spin_lock_irqsave(&hp->lock, flags);
125 if (hp->index == index) {
126 kobject_get(&hp->kobj);
127 spin_unlock_irqrestore(&hp->lock, flags);
128 spin_unlock(&hvc_structs_lock);
131 spin_unlock_irqrestore(&hp->lock, flags);
135 spin_unlock(&hvc_structs_lock);
141 * Initial console vtermnos for console API usage prior to full console
142 * initialization. Any vty adapter outside this range will not have usable
143 * console interfaces but can still be used as a tty device. This has to be
144 * static because kmalloc will not work during early console init.
146 static struct hv_ops *cons_ops[MAX_NR_HVC_CONSOLES];
147 static uint32_t vtermnos[MAX_NR_HVC_CONSOLES] =
148 {[0 ... MAX_NR_HVC_CONSOLES - 1] = -1};
151 * Console APIs, NOT TTY. These APIs are available immediately when
152 * hvc_console_setup() finds adapters.
155 void hvc_console_print(struct console *co, const char *b, unsigned count)
157 char c[N_OUTBUF] __ALIGNED__;
158 unsigned i = 0, n = 0;
159 int r, donecr = 0, index = co->index;
161 /* Console access attempt outside of acceptable console range. */
162 if (index >= MAX_NR_HVC_CONSOLES)
165 /* This console adapter was removed so it is not useable. */
166 if (vtermnos[index] < 0)
169 while (count > 0 || i > 0) {
170 if (count > 0 && i < sizeof(c)) {
171 if (b[n] == '\n' && !donecr) {
180 r = cons_ops[index]->put_chars(vtermnos[index], c, i);
182 /* throw away chars on error */
193 static struct tty_driver *hvc_console_device(struct console *c, int *index)
195 if (vtermnos[c->index] == -1)
202 static int __init hvc_console_setup(struct console *co, char *options)
204 if (co->index < 0 || co->index >= MAX_NR_HVC_CONSOLES)
207 if (vtermnos[co->index] == -1)
213 struct console hvc_con_driver = {
215 .write = hvc_console_print,
216 .device = hvc_console_device,
217 .setup = hvc_console_setup,
218 .flags = CON_PRINTBUFFER,
223 * Early console initialization. Preceeds driver initialization.
225 * (1) we are first, and the user specified another driver
226 * -- index will remain -1
227 * (2) we are first and the user specified no driver
228 * -- index will be set to 0, then we will fail setup.
229 * (3) we are first and the user specified our driver
230 * -- index will be set to user specified driver, and we will fail
231 * (4) we are after driver, and this initcall will register us
232 * -- if the user didn't specify a driver then the console will match
234 * Note that for cases 2 and 3, we will match later when the io driver
235 * calls hvc_instantiate() and call register again.
237 static int __init hvc_console_init(void)
239 register_console(&hvc_con_driver);
242 console_initcall(hvc_console_init);
245 * hvc_instantiate() is an early console discovery method which locates
246 * consoles * prior to the vio subsystem discovering them. Hotplugged
247 * vty adapters do NOT get an hvc_instantiate() callback since they
248 * appear after early console init.
250 int hvc_instantiate(uint32_t vtermno, int index, struct hv_ops *ops)
252 struct hvc_struct *hp;
254 if (index < 0 || index >= MAX_NR_HVC_CONSOLES)
257 if (vtermnos[index] != -1)
260 /* make sure no no tty has been registerd in this index */
261 hp = hvc_get_by_index(index);
263 kobject_put(&hp->kobj);
267 vtermnos[index] = vtermno;
268 cons_ops[index] = ops;
270 /* reserve all indices upto and including this index */
271 if (last_hvc < index)
274 /* if this index is what the user requested, then register
275 * now (setup won't fail at this point). It's ok to just
276 * call register again if previously .setup failed.
278 if (index == hvc_con_driver.index)
279 register_console(&hvc_con_driver);
283 EXPORT_SYMBOL(hvc_instantiate);
285 /* Wake the sleeping khvcd */
286 static void hvc_kick(void)
289 wake_up_process(hvc_task);
292 static int hvc_poll(struct hvc_struct *hp);
295 * NOTE: This API isn't used if the console adapter doesn't support interrupts.
296 * In this case the console is poll driven.
298 static irqreturn_t hvc_handle_interrupt(int irq, void *dev_instance)
300 /* if hvc_poll request a repoll, then kick the hvcd thread */
301 if (hvc_poll(dev_instance))
306 static void hvc_unthrottle(struct tty_struct *tty)
312 * The TTY interface won't be used until after the vio layer has exposed the vty
313 * adapter to the kernel.
315 static int hvc_open(struct tty_struct *tty, struct file * filp)
317 struct hvc_struct *hp;
321 struct kobject *kobjp;
323 /* Auto increments kobject reference if found. */
324 if (!(hp = hvc_get_by_index(tty->index)))
327 spin_lock_irqsave(&hp->lock, flags);
328 /* Check and then increment for fast path open. */
329 if (hp->count++ > 0) {
330 spin_unlock_irqrestore(&hp->lock, flags);
333 } /* else count == 0 */
335 tty->driver_data = hp;
336 tty->low_latency = 1; /* Makes flushes to ldisc synchronous. */
339 /* Save for request_irq outside of spin_lock. */
342 hp->irq_requested = 1;
346 spin_unlock_irqrestore(&hp->lock, flags);
347 /* check error, fallback to non-irq */
349 rc = request_irq(irq, hvc_handle_interrupt, IRQF_DISABLED, "hvc_console", hp);
352 * If the request_irq() fails and we return an error. The tty layer
353 * will call hvc_close() after a failed open but we don't want to clean
354 * up there so we'll clean up here and clear out the previously set
355 * tty fields and return the kobject reference.
358 spin_lock_irqsave(&hp->lock, flags);
360 hp->irq_requested = 0;
361 spin_unlock_irqrestore(&hp->lock, flags);
362 tty->driver_data = NULL;
364 printk(KERN_ERR "hvc_open: request_irq failed with rc %d.\n", rc);
366 /* Force wakeup of the polling thread */
372 static void hvc_close(struct tty_struct *tty, struct file * filp)
374 struct hvc_struct *hp;
375 struct kobject *kobjp;
379 if (tty_hung_up_p(filp))
383 * No driver_data means that this close was issued after a failed
384 * hvc_open by the tty layer's release_dev() function and we can just
385 * exit cleanly because the kobject reference wasn't made.
387 if (!tty->driver_data)
390 hp = tty->driver_data;
391 spin_lock_irqsave(&hp->lock, flags);
394 if (--hp->count == 0) {
395 if (hp->irq_requested)
397 hp->irq_requested = 0;
399 /* We are done with the tty pointer now. */
401 spin_unlock_irqrestore(&hp->lock, flags);
404 * Chain calls chars_in_buffer() and returns immediately if
405 * there is no buffered data otherwise sleeps on a wait queue
406 * waking periodically to check chars_in_buffer().
408 tty_wait_until_sent(tty, HVC_CLOSE_WAIT);
415 printk(KERN_ERR "hvc_close %X: oops, count is %d\n",
416 hp->vtermno, hp->count);
417 spin_unlock_irqrestore(&hp->lock, flags);
423 static void hvc_hangup(struct tty_struct *tty)
425 struct hvc_struct *hp = tty->driver_data;
429 struct kobject *kobjp;
434 spin_lock_irqsave(&hp->lock, flags);
437 * The N_TTY line discipline has problems such that in a close vs
438 * open->hangup case this can be called after the final close so prevent
439 * that from happening for now.
441 if (hp->count <= 0) {
442 spin_unlock_irqrestore(&hp->lock, flags);
447 temp_open_count = hp->count;
451 if (hp->irq_requested)
452 /* Saved for use outside of spin_lock. */
454 hp->irq_requested = 0;
455 spin_unlock_irqrestore(&hp->lock, flags);
458 while(temp_open_count) {
465 * Push buffered characters whether they were just recently buffered or waiting
466 * on a blocked hypervisor. Call this function with hp->lock held.
468 static void hvc_push(struct hvc_struct *hp)
472 n = hp->ops->put_chars(hp->vtermno, hp->outbuf, hp->n_outbuf);
478 /* throw away output on error; this happens when
479 there is no session connected to the vterm. */
483 if (hp->n_outbuf > 0)
484 memmove(hp->outbuf, hp->outbuf + n, hp->n_outbuf);
489 static int hvc_write(struct tty_struct *tty, const unsigned char *buf, int count)
491 struct hvc_struct *hp = tty->driver_data;
493 int rsize, written = 0;
495 /* This write was probably executed during a tty close. */
502 spin_lock_irqsave(&hp->lock, flags);
504 /* Push pending writes */
505 if (hp->n_outbuf > 0)
508 while (count > 0 && (rsize = hp->outbuf_size - hp->n_outbuf) > 0) {
511 memcpy(hp->outbuf + hp->n_outbuf, buf, rsize);
514 hp->n_outbuf += rsize;
518 spin_unlock_irqrestore(&hp->lock, flags);
521 * Racy, but harmless, kick thread if there is still pending data.
530 * This is actually a contract between the driver and the tty layer outlining
531 * how much write room the driver can guarentee will be sent OR BUFFERED. This
532 * driver MUST honor the return value.
534 static int hvc_write_room(struct tty_struct *tty)
536 struct hvc_struct *hp = tty->driver_data;
541 return hp->outbuf_size - hp->n_outbuf;
544 static int hvc_chars_in_buffer(struct tty_struct *tty)
546 struct hvc_struct *hp = tty->driver_data;
553 #define HVC_POLL_READ 0x00000001
554 #define HVC_POLL_WRITE 0x00000002
556 static int hvc_poll(struct hvc_struct *hp)
558 struct tty_struct *tty;
559 int i, n, poll_mask = 0;
560 char buf[N_INBUF] __ALIGNED__;
564 spin_lock_irqsave(&hp->lock, flags);
566 /* Push pending writes */
567 if (hp->n_outbuf > 0)
570 /* Reschedule us if still some write pending */
571 if (hp->n_outbuf > 0)
572 poll_mask |= HVC_POLL_WRITE;
574 /* No tty attached, just skip */
579 /* Now check if we can get data (are we throttled ?) */
580 if (test_bit(TTY_THROTTLED, &tty->flags))
583 /* If we aren't interrupt driven and aren't throttled, we always
584 * request a reschedule
587 poll_mask |= HVC_POLL_READ;
589 /* Read data if any */
591 int count = tty_buffer_request_room(tty, N_INBUF);
593 /* If flip is full, just reschedule a later read */
595 poll_mask |= HVC_POLL_READ;
599 n = hp->ops->get_chars(hp->vtermno, buf, count);
601 /* Hangup the tty when disconnected from host */
603 spin_unlock_irqrestore(&hp->lock, flags);
605 spin_lock_irqsave(&hp->lock, flags);
606 } else if ( n == -EAGAIN ) {
608 * Some back-ends can only ensure a certain min
609 * num of bytes read, which may be > 'count'.
610 * Let the tty clear the flip buff to make room.
612 poll_mask |= HVC_POLL_READ;
616 for (i = 0; i < n; ++i) {
617 #ifdef CONFIG_MAGIC_SYSRQ
618 if (hp->index == hvc_con_driver.index) {
619 /* Handle the SysRq Hack */
620 /* XXX should support a sequence */
621 if (buf[i] == '\x0f') { /* ^O */
624 } else if (sysrq_pressed) {
625 handle_sysrq(buf[i], tty);
630 #endif /* CONFIG_MAGIC_SYSRQ */
631 tty_insert_flip_char(tty, buf[i], 0);
637 /* Wakeup write queue if necessary */
643 spin_unlock_irqrestore(&hp->lock, flags);
646 tty_flip_buffer_push(tty);
651 #if defined(CONFIG_XMON) && defined(CONFIG_SMP)
652 extern cpumask_t cpus_in_xmon;
654 static const cpumask_t cpus_in_xmon = CPU_MASK_NONE;
658 * This kthread is either polling or interrupt driven. This is determined by
659 * calling hvc_poll() who determines whether a console adapter support
662 int khvcd(void *unused)
665 struct hvc_struct *hp;
667 __set_current_state(TASK_RUNNING);
673 if (cpus_empty(cpus_in_xmon)) {
674 spin_lock(&hvc_structs_lock);
675 list_for_each_entry(hp, &hvc_structs, next) {
676 poll_mask |= hvc_poll(hp);
678 spin_unlock(&hvc_structs_lock);
680 poll_mask |= HVC_POLL_READ;
683 if (poll_mask & HVC_POLL_WRITE) {
687 set_current_state(TASK_INTERRUPTIBLE);
692 msleep_interruptible(TIMEOUT);
694 __set_current_state(TASK_RUNNING);
695 } while (!kthread_should_stop());
700 static const struct tty_operations hvc_ops = {
704 .hangup = hvc_hangup,
705 .unthrottle = hvc_unthrottle,
706 .write_room = hvc_write_room,
707 .chars_in_buffer = hvc_chars_in_buffer,
710 /* callback when the kboject ref count reaches zero. */
711 static void destroy_hvc_struct(struct kobject *kobj)
713 struct hvc_struct *hp = container_of(kobj, struct hvc_struct, kobj);
716 spin_lock(&hvc_structs_lock);
718 spin_lock_irqsave(&hp->lock, flags);
719 list_del(&(hp->next));
720 spin_unlock_irqrestore(&hp->lock, flags);
722 spin_unlock(&hvc_structs_lock);
727 static struct kobj_type hvc_kobj_type = {
728 .release = destroy_hvc_struct,
731 struct hvc_struct __devinit *hvc_alloc(uint32_t vtermno, int irq,
732 struct hv_ops *ops, int outbuf_size)
734 struct hvc_struct *hp;
737 hp = kmalloc(ALIGN(sizeof(*hp), sizeof(long)) + outbuf_size,
740 return ERR_PTR(-ENOMEM);
742 memset(hp, 0x00, sizeof(*hp));
744 hp->vtermno = vtermno;
747 hp->outbuf_size = outbuf_size;
748 hp->outbuf = &((char *)hp)[ALIGN(sizeof(*hp), sizeof(long))];
750 kobject_init(&hp->kobj);
751 hp->kobj.ktype = &hvc_kobj_type;
753 spin_lock_init(&hp->lock);
754 spin_lock(&hvc_structs_lock);
758 * see if this vterm id matches one registered for console.
760 for (i=0; i < MAX_NR_HVC_CONSOLES; i++)
761 if (vtermnos[i] == hp->vtermno &&
762 cons_ops[i] == hp->ops)
765 /* no matching slot, just use a counter */
766 if (i >= MAX_NR_HVC_CONSOLES)
771 list_add_tail(&(hp->next), &hvc_structs);
772 spin_unlock(&hvc_structs_lock);
776 EXPORT_SYMBOL(hvc_alloc);
778 int __devexit hvc_remove(struct hvc_struct *hp)
781 struct kobject *kobjp;
782 struct tty_struct *tty;
784 spin_lock_irqsave(&hp->lock, flags);
788 if (hp->index < MAX_NR_HVC_CONSOLES)
789 vtermnos[hp->index] = -1;
791 /* Don't whack hp->irq because tty_hangup() will need to free the irq. */
793 spin_unlock_irqrestore(&hp->lock, flags);
796 * We 'put' the instance that was grabbed when the kobject instance
797 * was intialized using kobject_init(). Let the last holder of this
798 * kobject cause it to be removed, which will probably be the tty_hangup
804 * This function call will auto chain call hvc_hangup. The tty should
805 * always be valid at this time unless a simultaneous tty close already
806 * cleaned up the hvc_struct.
812 EXPORT_SYMBOL(hvc_remove);
814 /* Driver initialization. Follow console initialization. This is where the TTY
815 * interfaces start to become available. */
816 int __init hvc_init(void)
818 struct tty_driver *drv;
820 /* We need more than hvc_count adapters due to hotplug additions. */
821 drv = alloc_tty_driver(HVC_ALLOC_TTY_ADAPTERS);
825 drv->owner = THIS_MODULE;
826 drv->driver_name = "hvc";
828 drv->major = HVC_MAJOR;
829 drv->minor_start = HVC_MINOR;
830 drv->type = TTY_DRIVER_TYPE_SYSTEM;
831 drv->init_termios = tty_std_termios;
832 drv->flags = TTY_DRIVER_REAL_RAW;
833 tty_set_operations(drv, &hvc_ops);
835 /* Always start the kthread because there can be hotplug vty adapters
837 hvc_task = kthread_run(khvcd, NULL, "khvcd");
838 if (IS_ERR(hvc_task)) {
839 panic("Couldn't create kthread for console.\n");
844 if (tty_register_driver(drv))
845 panic("Couldn't register hvc console driver\n");
851 module_init(hvc_init);
853 /* This isn't particularily necessary due to this being a console driver
854 * but it is nice to be thorough.
856 static void __exit hvc_exit(void)
858 kthread_stop(hvc_task);
860 tty_unregister_driver(hvc_driver);
861 /* return tty_struct instances allocated in hvc_init(). */
862 put_tty_driver(hvc_driver);
863 unregister_console(&hvc_con_driver);
865 module_exit(hvc_exit);