ba55bba151b91b0259b93fd60bee2efc8c1409a9
[linux-3.10.git] / 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 const 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] == -1)
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, const 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                 tty_kref_get(tty);
316                 spin_unlock_irqrestore(&hp->lock, flags);
317                 hvc_kick();
318                 return 0;
319         } /* else count == 0 */
320
321         tty->driver_data = hp;
322
323         hp->tty = tty_kref_get(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_kref_put(tty);
341                 tty->driver_data = NULL;
342                 kref_put(&hp->kref, destroy_hvc_struct);
343                 printk(KERN_ERR "hvc_open: request_irq failed with rc %d.\n", rc);
344         }
345         /* Force wakeup of the polling thread */
346         hvc_kick();
347
348         return rc;
349 }
350
351 static void hvc_close(struct tty_struct *tty, struct file * filp)
352 {
353         struct hvc_struct *hp;
354         unsigned long flags;
355
356         if (tty_hung_up_p(filp))
357                 return;
358
359         /*
360          * No driver_data means that this close was issued after a failed
361          * hvc_open by the tty layer's release_dev() function and we can just
362          * exit cleanly because the kref reference wasn't made.
363          */
364         if (!tty->driver_data)
365                 return;
366
367         hp = tty->driver_data;
368
369         spin_lock_irqsave(&hp->lock, flags);
370         tty_kref_get(tty);
371
372         if (--hp->count == 0) {
373                 /* We are done with the tty pointer now. */
374                 hp->tty = NULL;
375                 spin_unlock_irqrestore(&hp->lock, flags);
376
377                 /* Put the ref obtained in hvc_open() */
378                 tty_kref_put(tty);
379
380                 if (hp->ops->notifier_del)
381                         hp->ops->notifier_del(hp, hp->data);
382
383                 /* cancel pending tty resize work */
384                 cancel_work_sync(&hp->tty_resize);
385
386                 /*
387                  * Chain calls chars_in_buffer() and returns immediately if
388                  * there is no buffered data otherwise sleeps on a wait queue
389                  * waking periodically to check chars_in_buffer().
390                  */
391                 tty_wait_until_sent(tty, HVC_CLOSE_WAIT);
392         } else {
393                 if (hp->count < 0)
394                         printk(KERN_ERR "hvc_close %X: oops, count is %d\n",
395                                 hp->vtermno, hp->count);
396                 spin_unlock_irqrestore(&hp->lock, flags);
397         }
398
399         tty_kref_put(tty);
400         kref_put(&hp->kref, destroy_hvc_struct);
401 }
402
403 static void hvc_hangup(struct tty_struct *tty)
404 {
405         struct hvc_struct *hp = tty->driver_data;
406         unsigned long flags;
407         int temp_open_count;
408
409         if (!hp)
410                 return;
411
412         /* cancel pending tty resize work */
413         cancel_work_sync(&hp->tty_resize);
414
415         spin_lock_irqsave(&hp->lock, flags);
416
417         /*
418          * The N_TTY line discipline has problems such that in a close vs
419          * open->hangup case this can be called after the final close so prevent
420          * that from happening for now.
421          */
422         if (hp->count <= 0) {
423                 spin_unlock_irqrestore(&hp->lock, flags);
424                 return;
425         }
426
427         temp_open_count = hp->count;
428         hp->count = 0;
429         hp->n_outbuf = 0;
430         hp->tty = NULL;
431
432         spin_unlock_irqrestore(&hp->lock, flags);
433
434         if (hp->ops->notifier_hangup)
435                 hp->ops->notifier_hangup(hp, hp->data);
436
437         while(temp_open_count) {
438                 --temp_open_count;
439                 tty_kref_put(tty);
440                 kref_put(&hp->kref, destroy_hvc_struct);
441         }
442 }
443
444 /*
445  * Push buffered characters whether they were just recently buffered or waiting
446  * on a blocked hypervisor.  Call this function with hp->lock held.
447  */
448 static int hvc_push(struct hvc_struct *hp)
449 {
450         int n;
451
452         n = hp->ops->put_chars(hp->vtermno, hp->outbuf, hp->n_outbuf);
453         if (n <= 0) {
454                 if (n == 0) {
455                         hp->do_wakeup = 1;
456                         return 0;
457                 }
458                 /* throw away output on error; this happens when
459                    there is no session connected to the vterm. */
460                 hp->n_outbuf = 0;
461         } else
462                 hp->n_outbuf -= n;
463         if (hp->n_outbuf > 0)
464                 memmove(hp->outbuf, hp->outbuf + n, hp->n_outbuf);
465         else
466                 hp->do_wakeup = 1;
467
468         return n;
469 }
470
471 static int hvc_write(struct tty_struct *tty, const unsigned char *buf, int count)
472 {
473         struct hvc_struct *hp = tty->driver_data;
474         unsigned long flags;
475         int rsize, written = 0;
476
477         /* This write was probably executed during a tty close. */
478         if (!hp)
479                 return -EPIPE;
480
481         if (hp->count <= 0)
482                 return -EIO;
483
484         spin_lock_irqsave(&hp->lock, flags);
485
486         /* Push pending writes */
487         if (hp->n_outbuf > 0)
488                 hvc_push(hp);
489
490         while (count > 0 && (rsize = hp->outbuf_size - hp->n_outbuf) > 0) {
491                 if (rsize > count)
492                         rsize = count;
493                 memcpy(hp->outbuf + hp->n_outbuf, buf, rsize);
494                 count -= rsize;
495                 buf += rsize;
496                 hp->n_outbuf += rsize;
497                 written += rsize;
498                 hvc_push(hp);
499         }
500         spin_unlock_irqrestore(&hp->lock, flags);
501
502         /*
503          * Racy, but harmless, kick thread if there is still pending data.
504          */
505         if (hp->n_outbuf)
506                 hvc_kick();
507
508         return written;
509 }
510
511 /**
512  * hvc_set_winsz() - Resize the hvc tty terminal window.
513  * @work:       work structure.
514  *
515  * The routine shall not be called within an atomic context because it
516  * might sleep.
517  *
518  * Locking:     hp->lock
519  */
520 static void hvc_set_winsz(struct work_struct *work)
521 {
522         struct hvc_struct *hp;
523         unsigned long hvc_flags;
524         struct tty_struct *tty;
525         struct winsize ws;
526
527         hp = container_of(work, struct hvc_struct, tty_resize);
528
529         spin_lock_irqsave(&hp->lock, hvc_flags);
530         if (!hp->tty) {
531                 spin_unlock_irqrestore(&hp->lock, hvc_flags);
532                 return;
533         }
534         ws  = hp->ws;
535         tty = tty_kref_get(hp->tty);
536         spin_unlock_irqrestore(&hp->lock, hvc_flags);
537
538         tty_do_resize(tty, &ws);
539         tty_kref_put(tty);
540 }
541
542 /*
543  * This is actually a contract between the driver and the tty layer outlining
544  * how much write room the driver can guarantee will be sent OR BUFFERED.  This
545  * driver MUST honor the return value.
546  */
547 static int hvc_write_room(struct tty_struct *tty)
548 {
549         struct hvc_struct *hp = tty->driver_data;
550
551         if (!hp)
552                 return -1;
553
554         return hp->outbuf_size - hp->n_outbuf;
555 }
556
557 static int hvc_chars_in_buffer(struct tty_struct *tty)
558 {
559         struct hvc_struct *hp = tty->driver_data;
560
561         if (!hp)
562                 return 0;
563         return hp->n_outbuf;
564 }
565
566 /*
567  * timeout will vary between the MIN and MAX values defined here.  By default
568  * and during console activity we will use a default MIN_TIMEOUT of 10.  When
569  * the console is idle, we increase the timeout value on each pass through
570  * msleep until we reach the max.  This may be noticeable as a brief (average
571  * one second) delay on the console before the console responds to input when
572  * there has been no input for some time.
573  */
574 #define MIN_TIMEOUT             (10)
575 #define MAX_TIMEOUT             (2000)
576 static u32 timeout = MIN_TIMEOUT;
577
578 #define HVC_POLL_READ   0x00000001
579 #define HVC_POLL_WRITE  0x00000002
580
581 int hvc_poll(struct hvc_struct *hp)
582 {
583         struct tty_struct *tty;
584         int i, n, poll_mask = 0;
585         char buf[N_INBUF] __ALIGNED__;
586         unsigned long flags;
587         int read_total = 0;
588         int written_total = 0;
589
590         spin_lock_irqsave(&hp->lock, flags);
591
592         /* Push pending writes */
593         if (hp->n_outbuf > 0)
594                 written_total = hvc_push(hp);
595
596         /* Reschedule us if still some write pending */
597         if (hp->n_outbuf > 0) {
598                 poll_mask |= HVC_POLL_WRITE;
599                 /* If hvc_push() was not able to write, sleep a few msecs */
600                 timeout = (written_total) ? 0 : MIN_TIMEOUT;
601         }
602
603         /* No tty attached, just skip */
604         tty = tty_kref_get(hp->tty);
605         if (tty == NULL)
606                 goto bail;
607
608         /* Now check if we can get data (are we throttled ?) */
609         if (test_bit(TTY_THROTTLED, &tty->flags))
610                 goto throttled;
611
612         /* If we aren't notifier driven and aren't throttled, we always
613          * request a reschedule
614          */
615         if (!hp->irq_requested)
616                 poll_mask |= HVC_POLL_READ;
617
618         /* Read data if any */
619         for (;;) {
620                 int count = tty_buffer_request_room(tty, N_INBUF);
621
622                 /* If flip is full, just reschedule a later read */
623                 if (count == 0) {
624                         poll_mask |= HVC_POLL_READ;
625                         break;
626                 }
627
628                 n = hp->ops->get_chars(hp->vtermno, buf, count);
629                 if (n <= 0) {
630                         /* Hangup the tty when disconnected from host */
631                         if (n == -EPIPE) {
632                                 spin_unlock_irqrestore(&hp->lock, flags);
633                                 tty_hangup(tty);
634                                 spin_lock_irqsave(&hp->lock, flags);
635                         } else if ( n == -EAGAIN ) {
636                                 /*
637                                  * Some back-ends can only ensure a certain min
638                                  * num of bytes read, which may be > 'count'.
639                                  * Let the tty clear the flip buff to make room.
640                                  */
641                                 poll_mask |= HVC_POLL_READ;
642                         }
643                         break;
644                 }
645                 for (i = 0; i < n; ++i) {
646 #ifdef CONFIG_MAGIC_SYSRQ
647                         if (hp->index == hvc_con_driver.index) {
648                                 /* Handle the SysRq Hack */
649                                 /* XXX should support a sequence */
650                                 if (buf[i] == '\x0f') { /* ^O */
651                                         /* if ^O is pressed again, reset
652                                          * sysrq_pressed and flip ^O char */
653                                         sysrq_pressed = !sysrq_pressed;
654                                         if (sysrq_pressed)
655                                                 continue;
656                                 } else if (sysrq_pressed) {
657                                         handle_sysrq(buf[i], tty);
658                                         sysrq_pressed = 0;
659                                         continue;
660                                 }
661                         }
662 #endif /* CONFIG_MAGIC_SYSRQ */
663                         tty_insert_flip_char(tty, buf[i], 0);
664                 }
665
666                 read_total += n;
667         }
668  throttled:
669         /* Wakeup write queue if necessary */
670         if (hp->do_wakeup) {
671                 hp->do_wakeup = 0;
672                 tty_wakeup(tty);
673         }
674  bail:
675         spin_unlock_irqrestore(&hp->lock, flags);
676
677         if (read_total) {
678                 /* Activity is occurring, so reset the polling backoff value to
679                    a minimum for performance. */
680                 timeout = MIN_TIMEOUT;
681
682                 tty_flip_buffer_push(tty);
683         }
684         if (tty)
685                 tty_kref_put(tty);
686
687         return poll_mask;
688 }
689 EXPORT_SYMBOL_GPL(hvc_poll);
690
691 /**
692  * __hvc_resize() - Update terminal window size information.
693  * @hp:         HVC console pointer
694  * @ws:         Terminal window size structure
695  *
696  * Stores the specified window size information in the hvc structure of @hp.
697  * The function schedule the tty resize update.
698  *
699  * Locking:     Locking free; the function MUST be called holding hp->lock
700  */
701 void __hvc_resize(struct hvc_struct *hp, struct winsize ws)
702 {
703         hp->ws = ws;
704         schedule_work(&hp->tty_resize);
705 }
706 EXPORT_SYMBOL_GPL(__hvc_resize);
707
708 /*
709  * This kthread is either polling or interrupt driven.  This is determined by
710  * calling hvc_poll() who determines whether a console adapter support
711  * interrupts.
712  */
713 static int khvcd(void *unused)
714 {
715         int poll_mask;
716         struct hvc_struct *hp;
717
718         set_freezable();
719         __set_current_state(TASK_RUNNING);
720         do {
721                 poll_mask = 0;
722                 hvc_kicked = 0;
723                 try_to_freeze();
724                 wmb();
725                 if (!cpus_are_in_xmon()) {
726                         spin_lock(&hvc_structs_lock);
727                         list_for_each_entry(hp, &hvc_structs, next) {
728                                 poll_mask |= hvc_poll(hp);
729                         }
730                         spin_unlock(&hvc_structs_lock);
731                 } else
732                         poll_mask |= HVC_POLL_READ;
733                 if (hvc_kicked)
734                         continue;
735                 set_current_state(TASK_INTERRUPTIBLE);
736                 if (!hvc_kicked) {
737                         if (poll_mask == 0)
738                                 schedule();
739                         else {
740                                 if (timeout < MAX_TIMEOUT)
741                                         timeout += (timeout >> 6) + 1;
742
743                                 msleep_interruptible(timeout);
744                         }
745                 }
746                 __set_current_state(TASK_RUNNING);
747         } while (!kthread_should_stop());
748
749         return 0;
750 }
751
752 static const struct tty_operations hvc_ops = {
753         .open = hvc_open,
754         .close = hvc_close,
755         .write = hvc_write,
756         .hangup = hvc_hangup,
757         .unthrottle = hvc_unthrottle,
758         .write_room = hvc_write_room,
759         .chars_in_buffer = hvc_chars_in_buffer,
760 };
761
762 struct hvc_struct *hvc_alloc(uint32_t vtermno, int data,
763                              const struct hv_ops *ops,
764                              int outbuf_size)
765 {
766         struct hvc_struct *hp;
767         int i;
768
769         /* We wait until a driver actually comes along */
770         if (!hvc_driver) {
771                 int err = hvc_init();
772                 if (err)
773                         return ERR_PTR(err);
774         }
775
776         hp = kzalloc(ALIGN(sizeof(*hp), sizeof(long)) + outbuf_size,
777                         GFP_KERNEL);
778         if (!hp)
779                 return ERR_PTR(-ENOMEM);
780
781         hp->vtermno = vtermno;
782         hp->data = data;
783         hp->ops = ops;
784         hp->outbuf_size = outbuf_size;
785         hp->outbuf = &((char *)hp)[ALIGN(sizeof(*hp), sizeof(long))];
786
787         kref_init(&hp->kref);
788
789         INIT_WORK(&hp->tty_resize, hvc_set_winsz);
790         spin_lock_init(&hp->lock);
791         spin_lock(&hvc_structs_lock);
792
793         /*
794          * find index to use:
795          * see if this vterm id matches one registered for console.
796          */
797         for (i=0; i < MAX_NR_HVC_CONSOLES; i++)
798                 if (vtermnos[i] == hp->vtermno &&
799                     cons_ops[i] == hp->ops)
800                         break;
801
802         /* no matching slot, just use a counter */
803         if (i >= MAX_NR_HVC_CONSOLES)
804                 i = ++last_hvc;
805
806         hp->index = i;
807
808         list_add_tail(&(hp->next), &hvc_structs);
809         spin_unlock(&hvc_structs_lock);
810
811         return hp;
812 }
813 EXPORT_SYMBOL_GPL(hvc_alloc);
814
815 int hvc_remove(struct hvc_struct *hp)
816 {
817         unsigned long flags;
818         struct tty_struct *tty;
819
820         spin_lock_irqsave(&hp->lock, flags);
821         tty = tty_kref_get(hp->tty);
822
823         if (hp->index < MAX_NR_HVC_CONSOLES)
824                 vtermnos[hp->index] = -1;
825
826         /* Don't whack hp->irq because tty_hangup() will need to free the irq. */
827
828         spin_unlock_irqrestore(&hp->lock, flags);
829
830         /*
831          * We 'put' the instance that was grabbed when the kref instance
832          * was initialized using kref_init().  Let the last holder of this
833          * kref cause it to be removed, which will probably be the tty_vhangup
834          * below.
835          */
836         kref_put(&hp->kref, destroy_hvc_struct);
837
838         /*
839          * This function call will auto chain call hvc_hangup.
840          */
841         if (tty) {
842                 tty_vhangup(tty);
843                 tty_kref_put(tty);
844         }
845         return 0;
846 }
847 EXPORT_SYMBOL_GPL(hvc_remove);
848
849 /* Driver initialization: called as soon as someone uses hvc_alloc(). */
850 static int hvc_init(void)
851 {
852         struct tty_driver *drv;
853         int err;
854
855         /* We need more than hvc_count adapters due to hotplug additions. */
856         drv = alloc_tty_driver(HVC_ALLOC_TTY_ADAPTERS);
857         if (!drv) {
858                 err = -ENOMEM;
859                 goto out;
860         }
861
862         drv->owner = THIS_MODULE;
863         drv->driver_name = "hvc";
864         drv->name = "hvc";
865         drv->major = HVC_MAJOR;
866         drv->minor_start = HVC_MINOR;
867         drv->type = TTY_DRIVER_TYPE_SYSTEM;
868         drv->init_termios = tty_std_termios;
869         drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_RESET_TERMIOS;
870         tty_set_operations(drv, &hvc_ops);
871
872         /* Always start the kthread because there can be hotplug vty adapters
873          * added later. */
874         hvc_task = kthread_run(khvcd, NULL, "khvcd");
875         if (IS_ERR(hvc_task)) {
876                 printk(KERN_ERR "Couldn't create kthread for console.\n");
877                 err = PTR_ERR(hvc_task);
878                 goto put_tty;
879         }
880
881         err = tty_register_driver(drv);
882         if (err) {
883                 printk(KERN_ERR "Couldn't register hvc console driver\n");
884                 goto stop_thread;
885         }
886
887         /*
888          * Make sure tty is fully registered before allowing it to be
889          * found by hvc_console_device.
890          */
891         smp_mb();
892         hvc_driver = drv;
893         return 0;
894
895 stop_thread:
896         kthread_stop(hvc_task);
897         hvc_task = NULL;
898 put_tty:
899         put_tty_driver(drv);
900 out:
901         return err;
902 }
903
904 /* This isn't particularly necessary due to this being a console driver
905  * but it is nice to be thorough.
906  */
907 static void __exit hvc_exit(void)
908 {
909         if (hvc_driver) {
910                 kthread_stop(hvc_task);
911
912                 tty_unregister_driver(hvc_driver);
913                 /* return tty_struct instances allocated in hvc_init(). */
914                 put_tty_driver(hvc_driver);
915                 unregister_console(&hvc_con_driver);
916         }
917 }
918 module_exit(hvc_exit);