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