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