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