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