Merge git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb-2.6
[linux-2.6] / drivers / char / hvc_console.c
1 /*
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
6  *
7  * Additional Author(s):
8  *  Ryan S. Arnold <rsa@us.ibm.com>
9  *
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.
14  * 
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.
19  * 
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
23  */
24
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/kthread.h>
31 #include <linux/list.h>
32 #include <linux/module.h>
33 #include <linux/major.h>
34 #include <linux/sysrq.h>
35 #include <linux/tty.h>
36 #include <linux/tty_flip.h>
37 #include <linux/sched.h>
38 #include <linux/spinlock.h>
39 #include <linux/delay.h>
40 #include <linux/freezer.h>
41
42 #include <asm/uaccess.h>
43
44 #include "hvc_console.h"
45
46 #define HVC_MAJOR       229
47 #define HVC_MINOR       0
48
49 /*
50  * Wait this long per iteration while trying to push buffered data to the
51  * hypervisor before allowing the tty to complete a close operation.
52  */
53 #define HVC_CLOSE_WAIT (HZ/100) /* 1/10 of a second */
54
55 /*
56  * These sizes are most efficient for vio, because they are the
57  * native transfer size. We could make them selectable in the
58  * future to better deal with backends that want other buffer sizes.
59  */
60 #define N_OUTBUF        16
61 #define N_INBUF         16
62
63 #define __ALIGNED__ __attribute__((__aligned__(sizeof(long))))
64
65 static struct tty_driver *hvc_driver;
66 static struct task_struct *hvc_task;
67
68 /* Picks up late kicks after list walk but before schedule() */
69 static int hvc_kicked;
70
71 static int hvc_init(void);
72
73 #ifdef CONFIG_MAGIC_SYSRQ
74 static int sysrq_pressed;
75 #endif
76
77 /* dynamic list of hvc_struct instances */
78 static LIST_HEAD(hvc_structs);
79
80 /*
81  * Protect the list of hvc_struct instances from inserts and removals during
82  * list traversal.
83  */
84 static DEFINE_SPINLOCK(hvc_structs_lock);
85
86 /*
87  * This value is used to assign a tty->index value to a hvc_struct based
88  * upon order of exposure via hvc_probe(), when we can not match it to
89  * a console candidate registered with hvc_instantiate().
90  */
91 static int last_hvc = -1;
92
93 /*
94  * Do not call this function with either the hvc_structs_lock or the hvc_struct
95  * lock held.  If successful, this function increments the kref reference
96  * count against the target hvc_struct so it should be released when finished.
97  */
98 static struct hvc_struct *hvc_get_by_index(int index)
99 {
100         struct hvc_struct *hp;
101         unsigned long flags;
102
103         spin_lock(&hvc_structs_lock);
104
105         list_for_each_entry(hp, &hvc_structs, next) {
106                 spin_lock_irqsave(&hp->lock, flags);
107                 if (hp->index == index) {
108                         kref_get(&hp->kref);
109                         spin_unlock_irqrestore(&hp->lock, flags);
110                         spin_unlock(&hvc_structs_lock);
111                         return hp;
112                 }
113                 spin_unlock_irqrestore(&hp->lock, flags);
114         }
115         hp = NULL;
116
117         spin_unlock(&hvc_structs_lock);
118         return hp;
119 }
120
121
122 /*
123  * Initial console vtermnos for console API usage prior to full console
124  * initialization.  Any vty adapter outside this range will not have usable
125  * console interfaces but can still be used as a tty device.  This has to be
126  * static because kmalloc will not work during early console init.
127  */
128 static struct hv_ops *cons_ops[MAX_NR_HVC_CONSOLES];
129 static uint32_t vtermnos[MAX_NR_HVC_CONSOLES] =
130         {[0 ... MAX_NR_HVC_CONSOLES - 1] = -1};
131
132 /*
133  * Console APIs, NOT TTY.  These APIs are available immediately when
134  * hvc_console_setup() finds adapters.
135  */
136
137 static void hvc_console_print(struct console *co, const char *b,
138                               unsigned count)
139 {
140         char c[N_OUTBUF] __ALIGNED__;
141         unsigned i = 0, n = 0;
142         int r, donecr = 0, index = co->index;
143
144         /* Console access attempt outside of acceptable console range. */
145         if (index >= MAX_NR_HVC_CONSOLES)
146                 return;
147
148         /* This console adapter was removed so it is not usable. */
149         if (vtermnos[index] < 0)
150                 return;
151
152         while (count > 0 || i > 0) {
153                 if (count > 0 && i < sizeof(c)) {
154                         if (b[n] == '\n' && !donecr) {
155                                 c[i++] = '\r';
156                                 donecr = 1;
157                         } else {
158                                 c[i++] = b[n++];
159                                 donecr = 0;
160                                 --count;
161                         }
162                 } else {
163                         r = cons_ops[index]->put_chars(vtermnos[index], c, i);
164                         if (r <= 0) {
165                                 /* throw away chars on error */
166                                 i = 0;
167                         } else if (r > 0) {
168                                 i -= r;
169                                 if (i > 0)
170                                         memmove(c, c+r, i);
171                         }
172                 }
173         }
174 }
175
176 static struct tty_driver *hvc_console_device(struct console *c, int *index)
177 {
178         if (vtermnos[c->index] == -1)
179                 return NULL;
180
181         *index = c->index;
182         return hvc_driver;
183 }
184
185 static int __init hvc_console_setup(struct console *co, char *options)
186 {
187         if (co->index < 0 || co->index >= MAX_NR_HVC_CONSOLES)
188                 return -ENODEV;
189
190         if (vtermnos[co->index] == -1)
191                 return -ENODEV;
192
193         return 0;
194 }
195
196 static struct console hvc_con_driver = {
197         .name           = "hvc",
198         .write          = hvc_console_print,
199         .device         = hvc_console_device,
200         .setup          = hvc_console_setup,
201         .flags          = CON_PRINTBUFFER,
202         .index          = -1,
203 };
204
205 /*
206  * Early console initialization.  Precedes driver initialization.
207  *
208  * (1) we are first, and the user specified another driver
209  * -- index will remain -1
210  * (2) we are first and the user specified no driver
211  * -- index will be set to 0, then we will fail setup.
212  * (3)  we are first and the user specified our driver
213  * -- index will be set to user specified driver, and we will fail
214  * (4) we are after driver, and this initcall will register us
215  * -- if the user didn't specify a driver then the console will match
216  *
217  * Note that for cases 2 and 3, we will match later when the io driver
218  * calls hvc_instantiate() and call register again.
219  */
220 static int __init hvc_console_init(void)
221 {
222         register_console(&hvc_con_driver);
223         return 0;
224 }
225 console_initcall(hvc_console_init);
226
227 /* callback when the kboject ref count reaches zero. */
228 static void destroy_hvc_struct(struct kref *kref)
229 {
230         struct hvc_struct *hp = container_of(kref, struct hvc_struct, kref);
231         unsigned long flags;
232
233         spin_lock(&hvc_structs_lock);
234
235         spin_lock_irqsave(&hp->lock, flags);
236         list_del(&(hp->next));
237         spin_unlock_irqrestore(&hp->lock, flags);
238
239         spin_unlock(&hvc_structs_lock);
240
241         kfree(hp);
242 }
243
244 /*
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.
249  */
250 int hvc_instantiate(uint32_t vtermno, int index, struct hv_ops *ops)
251 {
252         struct hvc_struct *hp;
253
254         if (index < 0 || index >= MAX_NR_HVC_CONSOLES)
255                 return -1;
256
257         if (vtermnos[index] != -1)
258                 return -1;
259
260         /* make sure no no tty has been registered in this index */
261         hp = hvc_get_by_index(index);
262         if (hp) {
263                 kref_put(&hp->kref, destroy_hvc_struct);
264                 return -1;
265         }
266
267         vtermnos[index] = vtermno;
268         cons_ops[index] = ops;
269
270         /* reserve all indices up to and including this index */
271         if (last_hvc < index)
272                 last_hvc = index;
273
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.
277          */
278         if (index == hvc_con_driver.index)
279                 register_console(&hvc_con_driver);
280
281         return 0;
282 }
283 EXPORT_SYMBOL_GPL(hvc_instantiate);
284
285 /* Wake the sleeping khvcd */
286 void hvc_kick(void)
287 {
288         hvc_kicked = 1;
289         wake_up_process(hvc_task);
290 }
291 EXPORT_SYMBOL_GPL(hvc_kick);
292
293 static void hvc_unthrottle(struct tty_struct *tty)
294 {
295         hvc_kick();
296 }
297
298 /*
299  * The TTY interface won't be used until after the vio layer has exposed the vty
300  * adapter to the kernel.
301  */
302 static int hvc_open(struct tty_struct *tty, struct file * filp)
303 {
304         struct hvc_struct *hp;
305         unsigned long flags;
306         int rc = 0;
307
308         /* Auto increments kref reference if found. */
309         if (!(hp = hvc_get_by_index(tty->index)))
310                 return -ENODEV;
311
312         spin_lock_irqsave(&hp->lock, flags);
313         /* Check and then increment for fast path open. */
314         if (hp->count++ > 0) {
315                 spin_unlock_irqrestore(&hp->lock, flags);
316                 hvc_kick();
317                 return 0;
318         } /* else count == 0 */
319
320         tty->driver_data = hp;
321         tty->low_latency = 1; /* Makes flushes to ldisc synchronous. */
322
323         hp->tty = tty;
324
325         spin_unlock_irqrestore(&hp->lock, flags);
326
327         if (hp->ops->notifier_add)
328                 rc = hp->ops->notifier_add(hp, hp->data);
329
330         /*
331          * If the notifier fails we return an error.  The tty layer
332          * will call hvc_close() after a failed open but we don't want to clean
333          * up there so we'll clean up here and clear out the previously set
334          * tty fields and return the kref reference.
335          */
336         if (rc) {
337                 spin_lock_irqsave(&hp->lock, flags);
338                 hp->tty = NULL;
339                 spin_unlock_irqrestore(&hp->lock, flags);
340                 tty->driver_data = NULL;
341                 kref_put(&hp->kref, destroy_hvc_struct);
342                 printk(KERN_ERR "hvc_open: request_irq failed with rc %d.\n", rc);
343         }
344         /* Force wakeup of the polling thread */
345         hvc_kick();
346
347         return rc;
348 }
349
350 static void hvc_close(struct tty_struct *tty, struct file * filp)
351 {
352         struct hvc_struct *hp;
353         unsigned long flags;
354
355         if (tty_hung_up_p(filp))
356                 return;
357
358         /*
359          * No driver_data means that this close was issued after a failed
360          * hvc_open by the tty layer's release_dev() function and we can just
361          * exit cleanly because the kref reference wasn't made.
362          */
363         if (!tty->driver_data)
364                 return;
365
366         hp = tty->driver_data;
367         spin_lock_irqsave(&hp->lock, flags);
368
369         if (--hp->count == 0) {
370                 /* We are done with the tty pointer now. */
371                 hp->tty = NULL;
372                 spin_unlock_irqrestore(&hp->lock, flags);
373
374                 if (hp->ops->notifier_del)
375                         hp->ops->notifier_del(hp, hp->data);
376
377                 /* cancel pending tty resize work */
378                 cancel_work_sync(&hp->tty_resize);
379
380                 /*
381                  * Chain calls chars_in_buffer() and returns immediately if
382                  * there is no buffered data otherwise sleeps on a wait queue
383                  * waking periodically to check chars_in_buffer().
384                  */
385                 tty_wait_until_sent(tty, HVC_CLOSE_WAIT);
386         } else {
387                 if (hp->count < 0)
388                         printk(KERN_ERR "hvc_close %X: oops, count is %d\n",
389                                 hp->vtermno, hp->count);
390                 spin_unlock_irqrestore(&hp->lock, flags);
391         }
392
393         kref_put(&hp->kref, destroy_hvc_struct);
394 }
395
396 static void hvc_hangup(struct tty_struct *tty)
397 {
398         struct hvc_struct *hp = tty->driver_data;
399         unsigned long flags;
400         int temp_open_count;
401
402         if (!hp)
403                 return;
404
405         /* cancel pending tty resize work */
406         cancel_work_sync(&hp->tty_resize);
407
408         spin_lock_irqsave(&hp->lock, flags);
409
410         /*
411          * The N_TTY line discipline has problems such that in a close vs
412          * open->hangup case this can be called after the final close so prevent
413          * that from happening for now.
414          */
415         if (hp->count <= 0) {
416                 spin_unlock_irqrestore(&hp->lock, flags);
417                 return;
418         }
419
420         temp_open_count = hp->count;
421         hp->count = 0;
422         hp->n_outbuf = 0;
423         hp->tty = NULL;
424
425         spin_unlock_irqrestore(&hp->lock, flags);
426
427         if (hp->ops->notifier_hangup)
428                         hp->ops->notifier_hangup(hp, hp->data);
429
430         while(temp_open_count) {
431                 --temp_open_count;
432                 kref_put(&hp->kref, destroy_hvc_struct);
433         }
434 }
435
436 /*
437  * Push buffered characters whether they were just recently buffered or waiting
438  * on a blocked hypervisor.  Call this function with hp->lock held.
439  */
440 static int hvc_push(struct hvc_struct *hp)
441 {
442         int n;
443
444         n = hp->ops->put_chars(hp->vtermno, hp->outbuf, hp->n_outbuf);
445         if (n <= 0) {
446                 if (n == 0) {
447                         hp->do_wakeup = 1;
448                         return 0;
449                 }
450                 /* throw away output on error; this happens when
451                    there is no session connected to the vterm. */
452                 hp->n_outbuf = 0;
453         } else
454                 hp->n_outbuf -= n;
455         if (hp->n_outbuf > 0)
456                 memmove(hp->outbuf, hp->outbuf + n, hp->n_outbuf);
457         else
458                 hp->do_wakeup = 1;
459
460         return n;
461 }
462
463 static int hvc_write(struct tty_struct *tty, const unsigned char *buf, int count)
464 {
465         struct hvc_struct *hp = tty->driver_data;
466         unsigned long flags;
467         int rsize, written = 0;
468
469         /* This write was probably executed during a tty close. */
470         if (!hp)
471                 return -EPIPE;
472
473         if (hp->count <= 0)
474                 return -EIO;
475
476         spin_lock_irqsave(&hp->lock, flags);
477
478         /* Push pending writes */
479         if (hp->n_outbuf > 0)
480                 hvc_push(hp);
481
482         while (count > 0 && (rsize = hp->outbuf_size - hp->n_outbuf) > 0) {
483                 if (rsize > count)
484                         rsize = count;
485                 memcpy(hp->outbuf + hp->n_outbuf, buf, rsize);
486                 count -= rsize;
487                 buf += rsize;
488                 hp->n_outbuf += rsize;
489                 written += rsize;
490                 hvc_push(hp);
491         }
492         spin_unlock_irqrestore(&hp->lock, flags);
493
494         /*
495          * Racy, but harmless, kick thread if there is still pending data.
496          */
497         if (hp->n_outbuf)
498                 hvc_kick();
499
500         return written;
501 }
502
503 /**
504  * hvc_set_winsz() - Resize the hvc tty terminal window.
505  * @work:       work structure.
506  *
507  * The routine shall not be called within an atomic context because it
508  * might sleep.
509  *
510  * Locking:     hp->lock
511  */
512 static void hvc_set_winsz(struct work_struct *work)
513 {
514         struct hvc_struct *hp;
515         unsigned long hvc_flags;
516         struct tty_struct *tty;
517         struct winsize ws;
518
519         hp = container_of(work, struct hvc_struct, tty_resize);
520         if (!hp)
521                 return;
522
523         spin_lock_irqsave(&hp->lock, hvc_flags);
524         if (!hp->tty) {
525                 spin_unlock_irqrestore(&hp->lock, hvc_flags);
526                 return;
527         }
528         ws  = hp->ws;
529         tty = tty_kref_get(hp->tty);
530         spin_unlock_irqrestore(&hp->lock, hvc_flags);
531
532         tty_do_resize(tty, tty, &ws);
533         tty_kref_put(tty);
534 }
535
536 /*
537  * This is actually a contract between the driver and the tty layer outlining
538  * how much write room the driver can guarantee will be sent OR BUFFERED.  This
539  * driver MUST honor the return value.
540  */
541 static int hvc_write_room(struct tty_struct *tty)
542 {
543         struct hvc_struct *hp = tty->driver_data;
544
545         if (!hp)
546                 return -1;
547
548         return hp->outbuf_size - hp->n_outbuf;
549 }
550
551 static int hvc_chars_in_buffer(struct tty_struct *tty)
552 {
553         struct hvc_struct *hp = tty->driver_data;
554
555         if (!hp)
556                 return -1;
557         return hp->n_outbuf;
558 }
559
560 /*
561  * timeout will vary between the MIN and MAX values defined here.  By default
562  * and during console activity we will use a default MIN_TIMEOUT of 10.  When
563  * the console is idle, we increase the timeout value on each pass through
564  * msleep until we reach the max.  This may be noticeable as a brief (average
565  * one second) delay on the console before the console responds to input when
566  * there has been no input for some time.
567  */
568 #define MIN_TIMEOUT             (10)
569 #define MAX_TIMEOUT             (2000)
570 static u32 timeout = MIN_TIMEOUT;
571
572 #define HVC_POLL_READ   0x00000001
573 #define HVC_POLL_WRITE  0x00000002
574
575 int hvc_poll(struct hvc_struct *hp)
576 {
577         struct tty_struct *tty;
578         int i, n, poll_mask = 0;
579         char buf[N_INBUF] __ALIGNED__;
580         unsigned long flags;
581         int read_total = 0;
582         int written_total = 0;
583
584         spin_lock_irqsave(&hp->lock, flags);
585
586         /* Push pending writes */
587         if (hp->n_outbuf > 0)
588                 written_total = hvc_push(hp);
589
590         /* Reschedule us if still some write pending */
591         if (hp->n_outbuf > 0) {
592                 poll_mask |= HVC_POLL_WRITE;
593                 /* If hvc_push() was not able to write, sleep a few msecs */
594                 timeout = (written_total) ? 0 : MIN_TIMEOUT;
595         }
596
597         /* No tty attached, just skip */
598         tty = hp->tty;
599         if (tty == NULL)
600                 goto bail;
601
602         /* Now check if we can get data (are we throttled ?) */
603         if (test_bit(TTY_THROTTLED, &tty->flags))
604                 goto throttled;
605
606         /* If we aren't notifier driven and aren't throttled, we always
607          * request a reschedule
608          */
609         if (!hp->irq_requested)
610                 poll_mask |= HVC_POLL_READ;
611
612         /* Read data if any */
613         for (;;) {
614                 int count = tty_buffer_request_room(tty, N_INBUF);
615
616                 /* If flip is full, just reschedule a later read */
617                 if (count == 0) {
618                         poll_mask |= HVC_POLL_READ;
619                         break;
620                 }
621
622                 n = hp->ops->get_chars(hp->vtermno, buf, count);
623                 if (n <= 0) {
624                         /* Hangup the tty when disconnected from host */
625                         if (n == -EPIPE) {
626                                 spin_unlock_irqrestore(&hp->lock, flags);
627                                 tty_hangup(tty);
628                                 spin_lock_irqsave(&hp->lock, flags);
629                         } else if ( n == -EAGAIN ) {
630                                 /*
631                                  * Some back-ends can only ensure a certain min
632                                  * num of bytes read, which may be > 'count'.
633                                  * Let the tty clear the flip buff to make room.
634                                  */
635                                 poll_mask |= HVC_POLL_READ;
636                         }
637                         break;
638                 }
639                 for (i = 0; i < n; ++i) {
640 #ifdef CONFIG_MAGIC_SYSRQ
641                         if (hp->index == hvc_con_driver.index) {
642                                 /* Handle the SysRq Hack */
643                                 /* XXX should support a sequence */
644                                 if (buf[i] == '\x0f') { /* ^O */
645                                         sysrq_pressed = 1;
646                                         continue;
647                                 } else if (sysrq_pressed) {
648                                         handle_sysrq(buf[i], tty);
649                                         sysrq_pressed = 0;
650                                         continue;
651                                 }
652                         }
653 #endif /* CONFIG_MAGIC_SYSRQ */
654                         tty_insert_flip_char(tty, buf[i], 0);
655                 }
656
657                 read_total += n;
658         }
659  throttled:
660         /* Wakeup write queue if necessary */
661         if (hp->do_wakeup) {
662                 hp->do_wakeup = 0;
663                 tty_wakeup(tty);
664         }
665  bail:
666         spin_unlock_irqrestore(&hp->lock, flags);
667
668         if (read_total) {
669                 /* Activity is occurring, so reset the polling backoff value to
670                    a minimum for performance. */
671                 timeout = MIN_TIMEOUT;
672
673                 tty_flip_buffer_push(tty);
674         }
675
676         return poll_mask;
677 }
678 EXPORT_SYMBOL_GPL(hvc_poll);
679
680 /**
681  * hvc_resize() - Update terminal window size information.
682  * @hp:         HVC console pointer
683  * @ws:         Terminal window size structure
684  *
685  * Stores the specified window size information in the hvc structure of @hp.
686  * The function schedule the tty resize update.
687  *
688  * Locking:     Locking free; the function MUST be called holding hp->lock
689  */
690 void hvc_resize(struct hvc_struct *hp, struct winsize ws)
691 {
692         if ((hp->ws.ws_row != ws.ws_row) || (hp->ws.ws_col != ws.ws_col)) {
693                 hp->ws = ws;
694                 schedule_work(&hp->tty_resize);
695         }
696 }
697
698 /*
699  * This kthread is either polling or interrupt driven.  This is determined by
700  * calling hvc_poll() who determines whether a console adapter support
701  * interrupts.
702  */
703 static int khvcd(void *unused)
704 {
705         int poll_mask;
706         struct hvc_struct *hp;
707
708         set_freezable();
709         __set_current_state(TASK_RUNNING);
710         do {
711                 poll_mask = 0;
712                 hvc_kicked = 0;
713                 try_to_freeze();
714                 wmb();
715                 if (!cpus_are_in_xmon()) {
716                         spin_lock(&hvc_structs_lock);
717                         list_for_each_entry(hp, &hvc_structs, next) {
718                                 poll_mask |= hvc_poll(hp);
719                         }
720                         spin_unlock(&hvc_structs_lock);
721                 } else
722                         poll_mask |= HVC_POLL_READ;
723                 if (hvc_kicked)
724                         continue;
725                 set_current_state(TASK_INTERRUPTIBLE);
726                 if (!hvc_kicked) {
727                         if (poll_mask == 0)
728                                 schedule();
729                         else {
730                                 if (timeout < MAX_TIMEOUT)
731                                         timeout += (timeout >> 6) + 1;
732
733                                 msleep_interruptible(timeout);
734                         }
735                 }
736                 __set_current_state(TASK_RUNNING);
737         } while (!kthread_should_stop());
738
739         return 0;
740 }
741
742 static const struct tty_operations hvc_ops = {
743         .open = hvc_open,
744         .close = hvc_close,
745         .write = hvc_write,
746         .hangup = hvc_hangup,
747         .unthrottle = hvc_unthrottle,
748         .write_room = hvc_write_room,
749         .chars_in_buffer = hvc_chars_in_buffer,
750 };
751
752 struct hvc_struct __devinit *hvc_alloc(uint32_t vtermno, int data,
753                                         struct hv_ops *ops, int outbuf_size)
754 {
755         struct hvc_struct *hp;
756         int i;
757
758         /* We wait until a driver actually comes along */
759         if (!hvc_driver) {
760                 int err = hvc_init();
761                 if (err)
762                         return ERR_PTR(err);
763         }
764
765         hp = kmalloc(ALIGN(sizeof(*hp), sizeof(long)) + outbuf_size,
766                         GFP_KERNEL);
767         if (!hp)
768                 return ERR_PTR(-ENOMEM);
769
770         memset(hp, 0x00, sizeof(*hp));
771
772         hp->vtermno = vtermno;
773         hp->data = data;
774         hp->ops = ops;
775         hp->outbuf_size = outbuf_size;
776         hp->outbuf = &((char *)hp)[ALIGN(sizeof(*hp), sizeof(long))];
777
778         kref_init(&hp->kref);
779
780         INIT_WORK(&hp->tty_resize, hvc_set_winsz);
781         spin_lock_init(&hp->lock);
782         spin_lock(&hvc_structs_lock);
783
784         /*
785          * find index to use:
786          * see if this vterm id matches one registered for console.
787          */
788         for (i=0; i < MAX_NR_HVC_CONSOLES; i++)
789                 if (vtermnos[i] == hp->vtermno &&
790                     cons_ops[i] == hp->ops)
791                         break;
792
793         /* no matching slot, just use a counter */
794         if (i >= MAX_NR_HVC_CONSOLES)
795                 i = ++last_hvc;
796
797         hp->index = i;
798
799         list_add_tail(&(hp->next), &hvc_structs);
800         spin_unlock(&hvc_structs_lock);
801
802         return hp;
803 }
804 EXPORT_SYMBOL_GPL(hvc_alloc);
805
806 int hvc_remove(struct hvc_struct *hp)
807 {
808         unsigned long flags;
809         struct tty_struct *tty;
810
811         spin_lock_irqsave(&hp->lock, flags);
812         tty = hp->tty;
813
814         if (hp->index < MAX_NR_HVC_CONSOLES)
815                 vtermnos[hp->index] = -1;
816
817         /* Don't whack hp->irq because tty_hangup() will need to free the irq. */
818
819         spin_unlock_irqrestore(&hp->lock, flags);
820
821         /*
822          * We 'put' the instance that was grabbed when the kref instance
823          * was initialized using kref_init().  Let the last holder of this
824          * kref cause it to be removed, which will probably be the tty_hangup
825          * below.
826          */
827         kref_put(&hp->kref, destroy_hvc_struct);
828
829         /*
830          * This function call will auto chain call hvc_hangup.  The tty should
831          * always be valid at this time unless a simultaneous tty close already
832          * cleaned up the hvc_struct.
833          */
834         if (tty)
835                 tty_hangup(tty);
836         return 0;
837 }
838
839 /* Driver initialization: called as soon as someone uses hvc_alloc(). */
840 static int hvc_init(void)
841 {
842         struct tty_driver *drv;
843         int err;
844
845         /* We need more than hvc_count adapters due to hotplug additions. */
846         drv = alloc_tty_driver(HVC_ALLOC_TTY_ADAPTERS);
847         if (!drv) {
848                 err = -ENOMEM;
849                 goto out;
850         }
851
852         drv->owner = THIS_MODULE;
853         drv->driver_name = "hvc";
854         drv->name = "hvc";
855         drv->major = HVC_MAJOR;
856         drv->minor_start = HVC_MINOR;
857         drv->type = TTY_DRIVER_TYPE_SYSTEM;
858         drv->init_termios = tty_std_termios;
859         drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_RESET_TERMIOS;
860         tty_set_operations(drv, &hvc_ops);
861
862         /* Always start the kthread because there can be hotplug vty adapters
863          * added later. */
864         hvc_task = kthread_run(khvcd, NULL, "khvcd");
865         if (IS_ERR(hvc_task)) {
866                 printk(KERN_ERR "Couldn't create kthread for console.\n");
867                 err = PTR_ERR(hvc_task);
868                 goto put_tty;
869         }
870
871         err = tty_register_driver(drv);
872         if (err) {
873                 printk(KERN_ERR "Couldn't register hvc console driver\n");
874                 goto stop_thread;
875         }
876
877         /* FIXME: This mb() seems completely random.  Remove it. */
878         mb();
879         hvc_driver = drv;
880         return 0;
881
882 stop_thread:
883         kthread_stop(hvc_task);
884         hvc_task = NULL;
885 put_tty:
886         put_tty_driver(drv);
887 out:
888         return err;
889 }
890
891 /* This isn't particularly necessary due to this being a console driver
892  * but it is nice to be thorough.
893  */
894 static void __exit hvc_exit(void)
895 {
896         if (hvc_driver) {
897                 kthread_stop(hvc_task);
898
899                 tty_unregister_driver(hvc_driver);
900                 /* return tty_struct instances allocated in hvc_init(). */
901                 put_tty_driver(hvc_driver);
902                 unregister_console(&hvc_con_driver);
903         }
904 }
905 module_exit(hvc_exit);