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