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/kref.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"
51 * Wait this long per iteration while trying to push buffered data to the
52 * hypervisor before allowing the tty to complete a close operation.
54 #define HVC_CLOSE_WAIT (HZ/100) /* 1/10 of a second */
57 * These sizes are most efficient for vio, because they are the
58 * native transfer size. We could make them selectable in the
59 * future to better deal with backends that want other buffer sizes.
64 #define __ALIGNED__ __attribute__((__aligned__(sizeof(long))))
66 static struct tty_driver
*hvc_driver
;
67 static struct task_struct
*hvc_task
;
69 /* Picks up late kicks after list walk but before schedule() */
70 static int hvc_kicked
;
72 static int hvc_init(void);
74 #ifdef CONFIG_MAGIC_SYSRQ
75 static int sysrq_pressed
;
81 struct tty_struct
*tty
;
91 struct list_head next
;
92 struct kref kref
; /* 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 candidate registered with hvc_instantiate().
109 static int last_hvc
= -1;
112 * Do not call this function with either the hvc_structs_lock or the hvc_struct
113 * lock held. If successful, this function increments the kref reference
114 * count against the target hvc_struct so it should be released when finished.
116 static 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
) {
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 static void hvc_console_print(struct console
*co
, const char *b
,
158 char c
[N_OUTBUF
] __ALIGNED__
;
159 unsigned i
= 0, n
= 0;
160 int r
, donecr
= 0, index
= co
->index
;
162 /* Console access attempt outside of acceptable console range. */
163 if (index
>= MAX_NR_HVC_CONSOLES
)
166 /* This console adapter was removed so it is not usable. */
167 if (vtermnos
[index
] < 0)
170 while (count
> 0 || i
> 0) {
171 if (count
> 0 && i
< sizeof(c
)) {
172 if (b
[n
] == '\n' && !donecr
) {
181 r
= cons_ops
[index
]->put_chars(vtermnos
[index
], c
, i
);
183 /* throw away chars on error */
194 static struct tty_driver
*hvc_console_device(struct console
*c
, int *index
)
196 if (vtermnos
[c
->index
] == -1)
203 static int __init
hvc_console_setup(struct console
*co
, char *options
)
205 if (co
->index
< 0 || co
->index
>= MAX_NR_HVC_CONSOLES
)
208 if (vtermnos
[co
->index
] == -1)
214 static struct console hvc_con_driver
= {
216 .write
= hvc_console_print
,
217 .device
= hvc_console_device
,
218 .setup
= hvc_console_setup
,
219 .flags
= CON_PRINTBUFFER
,
224 * Early console initialization. Precedes driver initialization.
226 * (1) we are first, and the user specified another driver
227 * -- index will remain -1
228 * (2) we are first and the user specified no driver
229 * -- index will be set to 0, then we will fail setup.
230 * (3) we are first and the user specified our driver
231 * -- index will be set to user specified driver, and we will fail
232 * (4) we are after driver, and this initcall will register us
233 * -- if the user didn't specify a driver then the console will match
235 * Note that for cases 2 and 3, we will match later when the io driver
236 * calls hvc_instantiate() and call register again.
238 static int __init
hvc_console_init(void)
240 register_console(&hvc_con_driver
);
243 console_initcall(hvc_console_init
);
245 /* callback when the kboject ref count reaches zero. */
246 static void destroy_hvc_struct(struct kref
*kref
)
248 struct hvc_struct
*hp
= container_of(kref
, struct hvc_struct
, kref
);
251 spin_lock(&hvc_structs_lock
);
253 spin_lock_irqsave(&hp
->lock
, flags
);
254 list_del(&(hp
->next
));
255 spin_unlock_irqrestore(&hp
->lock
, flags
);
257 spin_unlock(&hvc_structs_lock
);
263 * hvc_instantiate() is an early console discovery method which locates
264 * consoles * prior to the vio subsystem discovering them. Hotplugged
265 * vty adapters do NOT get an hvc_instantiate() callback since they
266 * appear after early console init.
268 int hvc_instantiate(uint32_t vtermno
, int index
, struct hv_ops
*ops
)
270 struct hvc_struct
*hp
;
272 if (index
< 0 || index
>= MAX_NR_HVC_CONSOLES
)
275 if (vtermnos
[index
] != -1)
278 /* make sure no no tty has been registered in this index */
279 hp
= hvc_get_by_index(index
);
281 kref_put(&hp
->kref
, destroy_hvc_struct
);
285 vtermnos
[index
] = vtermno
;
286 cons_ops
[index
] = ops
;
288 /* reserve all indices up to and including this index */
289 if (last_hvc
< index
)
292 /* if this index is what the user requested, then register
293 * now (setup won't fail at this point). It's ok to just
294 * call register again if previously .setup failed.
296 if (index
== hvc_con_driver
.index
)
297 register_console(&hvc_con_driver
);
302 /* Wake the sleeping khvcd */
303 static void hvc_kick(void)
306 wake_up_process(hvc_task
);
309 static int hvc_poll(struct hvc_struct
*hp
);
312 * NOTE: This API isn't used if the console adapter doesn't support interrupts.
313 * In this case the console is poll driven.
315 static irqreturn_t
hvc_handle_interrupt(int irq
, void *dev_instance
)
317 /* if hvc_poll request a repoll, then kick the hvcd thread */
318 if (hvc_poll(dev_instance
))
323 static void hvc_unthrottle(struct tty_struct
*tty
)
329 * The TTY interface won't be used until after the vio layer has exposed the vty
330 * adapter to the kernel.
332 static int hvc_open(struct tty_struct
*tty
, struct file
* filp
)
334 struct hvc_struct
*hp
;
339 /* Auto increments kref reference if found. */
340 if (!(hp
= hvc_get_by_index(tty
->index
)))
343 spin_lock_irqsave(&hp
->lock
, flags
);
344 /* Check and then increment for fast path open. */
345 if (hp
->count
++ > 0) {
346 spin_unlock_irqrestore(&hp
->lock
, flags
);
349 } /* else count == 0 */
351 tty
->driver_data
= hp
;
352 tty
->low_latency
= 1; /* Makes flushes to ldisc synchronous. */
355 /* Save for request_irq outside of spin_lock. */
358 hp
->irq_requested
= 1;
360 spin_unlock_irqrestore(&hp
->lock
, flags
);
361 /* check error, fallback to non-irq */
363 rc
= request_irq(irq
, hvc_handle_interrupt
, IRQF_DISABLED
, "hvc_console", hp
);
366 * If the request_irq() fails and we return an error. The tty layer
367 * will call hvc_close() after a failed open but we don't want to clean
368 * up there so we'll clean up here and clear out the previously set
369 * tty fields and return the kref reference.
372 spin_lock_irqsave(&hp
->lock
, flags
);
374 hp
->irq_requested
= 0;
375 spin_unlock_irqrestore(&hp
->lock
, flags
);
376 tty
->driver_data
= NULL
;
377 kref_put(&hp
->kref
, destroy_hvc_struct
);
378 printk(KERN_ERR
"hvc_open: request_irq failed with rc %d.\n", rc
);
380 /* Force wakeup of the polling thread */
386 static void hvc_close(struct tty_struct
*tty
, struct file
* filp
)
388 struct hvc_struct
*hp
;
392 if (tty_hung_up_p(filp
))
396 * No driver_data means that this close was issued after a failed
397 * hvc_open by the tty layer's release_dev() function and we can just
398 * exit cleanly because the kref reference wasn't made.
400 if (!tty
->driver_data
)
403 hp
= tty
->driver_data
;
404 spin_lock_irqsave(&hp
->lock
, flags
);
406 if (--hp
->count
== 0) {
407 if (hp
->irq_requested
)
409 hp
->irq_requested
= 0;
411 /* We are done with the tty pointer now. */
413 spin_unlock_irqrestore(&hp
->lock
, flags
);
416 * Chain calls chars_in_buffer() and returns immediately if
417 * there is no buffered data otherwise sleeps on a wait queue
418 * waking periodically to check chars_in_buffer().
420 tty_wait_until_sent(tty
, HVC_CLOSE_WAIT
);
427 printk(KERN_ERR
"hvc_close %X: oops, count is %d\n",
428 hp
->vtermno
, hp
->count
);
429 spin_unlock_irqrestore(&hp
->lock
, flags
);
432 kref_put(&hp
->kref
, destroy_hvc_struct
);
435 static void hvc_hangup(struct tty_struct
*tty
)
437 struct hvc_struct
*hp
= tty
->driver_data
;
445 spin_lock_irqsave(&hp
->lock
, flags
);
448 * The N_TTY line discipline has problems such that in a close vs
449 * open->hangup case this can be called after the final close so prevent
450 * that from happening for now.
452 if (hp
->count
<= 0) {
453 spin_unlock_irqrestore(&hp
->lock
, flags
);
457 temp_open_count
= hp
->count
;
461 if (hp
->irq_requested
)
462 /* Saved for use outside of spin_lock. */
464 hp
->irq_requested
= 0;
465 spin_unlock_irqrestore(&hp
->lock
, flags
);
468 while(temp_open_count
) {
470 kref_put(&hp
->kref
, destroy_hvc_struct
);
475 * Push buffered characters whether they were just recently buffered or waiting
476 * on a blocked hypervisor. Call this function with hp->lock held.
478 static void hvc_push(struct hvc_struct
*hp
)
482 n
= hp
->ops
->put_chars(hp
->vtermno
, hp
->outbuf
, hp
->n_outbuf
);
488 /* throw away output on error; this happens when
489 there is no session connected to the vterm. */
493 if (hp
->n_outbuf
> 0)
494 memmove(hp
->outbuf
, hp
->outbuf
+ n
, hp
->n_outbuf
);
499 static int hvc_write(struct tty_struct
*tty
, const unsigned char *buf
, int count
)
501 struct hvc_struct
*hp
= tty
->driver_data
;
503 int rsize
, written
= 0;
505 /* This write was probably executed during a tty close. */
512 spin_lock_irqsave(&hp
->lock
, flags
);
514 /* Push pending writes */
515 if (hp
->n_outbuf
> 0)
518 while (count
> 0 && (rsize
= hp
->outbuf_size
- hp
->n_outbuf
) > 0) {
521 memcpy(hp
->outbuf
+ hp
->n_outbuf
, buf
, rsize
);
524 hp
->n_outbuf
+= rsize
;
528 spin_unlock_irqrestore(&hp
->lock
, flags
);
531 * Racy, but harmless, kick thread if there is still pending data.
540 * This is actually a contract between the driver and the tty layer outlining
541 * how much write room the driver can guarantee will be sent OR BUFFERED. This
542 * driver MUST honor the return value.
544 static int hvc_write_room(struct tty_struct
*tty
)
546 struct hvc_struct
*hp
= tty
->driver_data
;
551 return hp
->outbuf_size
- hp
->n_outbuf
;
554 static int hvc_chars_in_buffer(struct tty_struct
*tty
)
556 struct hvc_struct
*hp
= tty
->driver_data
;
564 * timeout will vary between the MIN and MAX values defined here. By default
565 * and during console activity we will use a default MIN_TIMEOUT of 10. When
566 * the console is idle, we increase the timeout value on each pass through
567 * msleep until we reach the max. This may be noticeable as a brief (average
568 * one second) delay on the console before the console responds to input when
569 * there has been no input for some time.
571 #define MIN_TIMEOUT (10)
572 #define MAX_TIMEOUT (2000)
573 static u32 timeout
= MIN_TIMEOUT
;
575 #define HVC_POLL_READ 0x00000001
576 #define HVC_POLL_WRITE 0x00000002
578 static int hvc_poll(struct hvc_struct
*hp
)
580 struct tty_struct
*tty
;
581 int i
, n
, poll_mask
= 0;
582 char buf
[N_INBUF
] __ALIGNED__
;
586 spin_lock_irqsave(&hp
->lock
, flags
);
588 /* Push pending writes */
589 if (hp
->n_outbuf
> 0)
592 /* Reschedule us if still some write pending */
593 if (hp
->n_outbuf
> 0)
594 poll_mask
|= HVC_POLL_WRITE
;
596 /* No tty attached, just skip */
601 /* Now check if we can get data (are we throttled ?) */
602 if (test_bit(TTY_THROTTLED
, &tty
->flags
))
605 /* If we aren't interrupt driven and aren't throttled, we always
606 * request a reschedule
609 poll_mask
|= HVC_POLL_READ
;
611 /* Read data if any */
613 int count
= tty_buffer_request_room(tty
, N_INBUF
);
615 /* If flip is full, just reschedule a later read */
617 poll_mask
|= HVC_POLL_READ
;
621 n
= hp
->ops
->get_chars(hp
->vtermno
, buf
, count
);
623 /* Hangup the tty when disconnected from host */
625 spin_unlock_irqrestore(&hp
->lock
, flags
);
627 spin_lock_irqsave(&hp
->lock
, flags
);
628 } else if ( n
== -EAGAIN
) {
630 * Some back-ends can only ensure a certain min
631 * num of bytes read, which may be > 'count'.
632 * Let the tty clear the flip buff to make room.
634 poll_mask
|= HVC_POLL_READ
;
638 for (i
= 0; i
< n
; ++i
) {
639 #ifdef CONFIG_MAGIC_SYSRQ
640 if (hp
->index
== hvc_con_driver
.index
) {
641 /* Handle the SysRq Hack */
642 /* XXX should support a sequence */
643 if (buf
[i
] == '\x0f') { /* ^O */
646 } else if (sysrq_pressed
) {
647 handle_sysrq(buf
[i
], tty
);
652 #endif /* CONFIG_MAGIC_SYSRQ */
653 tty_insert_flip_char(tty
, buf
[i
], 0);
659 /* Wakeup write queue if necessary */
665 spin_unlock_irqrestore(&hp
->lock
, flags
);
668 /* Activity is occurring, so reset the polling backoff value to
669 a minimum for performance. */
670 timeout
= MIN_TIMEOUT
;
672 tty_flip_buffer_push(tty
);
678 #if defined(CONFIG_XMON) && defined(CONFIG_SMP)
679 extern cpumask_t cpus_in_xmon
;
681 static const cpumask_t cpus_in_xmon
= CPU_MASK_NONE
;
685 * This kthread is either polling or interrupt driven. This is determined by
686 * calling hvc_poll() who determines whether a console adapter support
689 static int khvcd(void *unused
)
692 struct hvc_struct
*hp
;
695 __set_current_state(TASK_RUNNING
);
701 if (cpus_empty(cpus_in_xmon
)) {
702 spin_lock(&hvc_structs_lock
);
703 list_for_each_entry(hp
, &hvc_structs
, next
) {
704 poll_mask
|= hvc_poll(hp
);
706 spin_unlock(&hvc_structs_lock
);
708 poll_mask
|= HVC_POLL_READ
;
711 if (poll_mask
& HVC_POLL_WRITE
) {
715 set_current_state(TASK_INTERRUPTIBLE
);
720 if (timeout
< MAX_TIMEOUT
)
721 timeout
+= (timeout
>> 6) + 1;
723 msleep_interruptible(timeout
);
726 __set_current_state(TASK_RUNNING
);
727 } while (!kthread_should_stop());
732 static const struct tty_operations hvc_ops
= {
736 .hangup
= hvc_hangup
,
737 .unthrottle
= hvc_unthrottle
,
738 .write_room
= hvc_write_room
,
739 .chars_in_buffer
= hvc_chars_in_buffer
,
742 struct hvc_struct __devinit
*hvc_alloc(uint32_t vtermno
, int irq
,
743 struct hv_ops
*ops
, int outbuf_size
)
745 struct hvc_struct
*hp
;
748 /* We wait until a driver actually comes along */
750 int err
= hvc_init();
755 hp
= kmalloc(ALIGN(sizeof(*hp
), sizeof(long)) + outbuf_size
,
758 return ERR_PTR(-ENOMEM
);
760 memset(hp
, 0x00, sizeof(*hp
));
762 hp
->vtermno
= vtermno
;
765 hp
->outbuf_size
= outbuf_size
;
766 hp
->outbuf
= &((char *)hp
)[ALIGN(sizeof(*hp
), sizeof(long))];
768 kref_init(&hp
->kref
);
770 spin_lock_init(&hp
->lock
);
771 spin_lock(&hvc_structs_lock
);
775 * see if this vterm id matches one registered for console.
777 for (i
=0; i
< MAX_NR_HVC_CONSOLES
; i
++)
778 if (vtermnos
[i
] == hp
->vtermno
&&
779 cons_ops
[i
] == hp
->ops
)
782 /* no matching slot, just use a counter */
783 if (i
>= MAX_NR_HVC_CONSOLES
)
788 list_add_tail(&(hp
->next
), &hvc_structs
);
789 spin_unlock(&hvc_structs_lock
);
794 int __devexit
hvc_remove(struct hvc_struct
*hp
)
797 struct tty_struct
*tty
;
799 spin_lock_irqsave(&hp
->lock
, flags
);
802 if (hp
->index
< MAX_NR_HVC_CONSOLES
)
803 vtermnos
[hp
->index
] = -1;
805 /* Don't whack hp->irq because tty_hangup() will need to free the irq. */
807 spin_unlock_irqrestore(&hp
->lock
, flags
);
810 * We 'put' the instance that was grabbed when the kref instance
811 * was initialized using kref_init(). Let the last holder of this
812 * kref cause it to be removed, which will probably be the tty_hangup
815 kref_put(&hp
->kref
, destroy_hvc_struct
);
818 * This function call will auto chain call hvc_hangup. The tty should
819 * always be valid at this time unless a simultaneous tty close already
820 * cleaned up the hvc_struct.
827 /* Driver initialization: called as soon as someone uses hvc_alloc(). */
828 static int hvc_init(void)
830 struct tty_driver
*drv
;
833 /* We need more than hvc_count adapters due to hotplug additions. */
834 drv
= alloc_tty_driver(HVC_ALLOC_TTY_ADAPTERS
);
840 drv
->owner
= THIS_MODULE
;
841 drv
->driver_name
= "hvc";
843 drv
->major
= HVC_MAJOR
;
844 drv
->minor_start
= HVC_MINOR
;
845 drv
->type
= TTY_DRIVER_TYPE_SYSTEM
;
846 drv
->init_termios
= tty_std_termios
;
847 drv
->flags
= TTY_DRIVER_REAL_RAW
;
848 tty_set_operations(drv
, &hvc_ops
);
850 /* Always start the kthread because there can be hotplug vty adapters
852 hvc_task
= kthread_run(khvcd
, NULL
, "khvcd");
853 if (IS_ERR(hvc_task
)) {
854 printk(KERN_ERR
"Couldn't create kthread for console.\n");
855 err
= PTR_ERR(hvc_task
);
859 err
= tty_register_driver(drv
);
861 printk(KERN_ERR
"Couldn't register hvc console driver\n");
865 /* FIXME: This mb() seems completely random. Remove it. */
871 put_tty_driver(hvc_driver
);
873 kthread_stop(hvc_task
);
879 /* This isn't particularly necessary due to this being a console driver
880 * but it is nice to be thorough.
882 static void __exit
hvc_exit(void)
885 kthread_stop(hvc_task
);
887 tty_unregister_driver(hvc_driver
);
888 /* return tty_struct instances allocated in hvc_init(). */
889 put_tty_driver(hvc_driver
);
890 unregister_console(&hvc_con_driver
);
893 module_exit(hvc_exit
);