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