drivers/tty/hvc/hvc_xen.c

   1 /*
   2  * xen console driver interface to hvc_console.c
   3  *
   4  * (c) 2007 Gerd Hoffmann <kraxel@suse.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19  */
  20
  21 #include <linux/console.h>
  22 #include <linux/delay.h>
  23 #include <linux/err.h>
  24 #include <linux/irq.h>
  25 #include <linux/init.h>
  26 #include <linux/types.h>
  27 #include <linux/list.h>
  28
  29 #include <asm/io.h>
  30 #include <asm/xen/hypervisor.h>
  31
  32 #include <xen/xen.h>
  33 #include <xen/interface/xen.h>
  34 #include <xen/hvm.h>
  35 #include <xen/grant_table.h>
  36 #include <xen/page.h>
  37 #include <xen/events.h>
  38 #include <xen/interface/io/console.h>
  39 #include <xen/interface/sched.h>
  40 #include <xen/hvc-console.h>
  41 #include <xen/xenbus.h>
  42
  43 #include "hvc_console.h"
  44
  45 #define HVC_COOKIE   0x58656e /* "Xen" in hex */
  46
  47 struct xencons_info {
  48         struct list_head list;
  49         struct xenbus_device *xbdev;
  50         struct xencons_interface *intf;
  51         unsigned int evtchn;
  52         struct hvc_struct *hvc;
  53         int irq;
  54         int vtermno;
  55         grant_ref_t gntref;
  56 };
  57
  58 static LIST_HEAD(xenconsoles);
  59 static DEFINE_SPINLOCK(xencons_lock);
  60
  61 /* ------------------------------------------------------------------ */
  62
  63 static struct xencons_info *vtermno_to_xencons(int vtermno)
  64 {
  65         struct xencons_info *entry, *n, *ret = NULL;
  66
  67         if (list_empty(&xenconsoles))
  68                         return NULL;
  69
  70         list_for_each_entry_safe(entry, n, &xenconsoles, list) {
  71                 if (entry->vtermno == vtermno) {
  72                         ret  = entry;
  73                         break;
  74                 }
  75         }
  76
  77         return ret;
  78 }
  79
  80 static inline int xenbus_devid_to_vtermno(int devid)
  81 {
  82         return devid + HVC_COOKIE;
  83 }
  84
  85 static inline void notify_daemon(struct xencons_info *cons)
  86 {
  87         /* Use evtchn: this is called early, before irq is set up. */
  88         notify_remote_via_evtchn(cons->evtchn);
  89 }
  90
  91 static int __write_console(struct xencons_info *xencons,
  92                 const char *data, int len)
  93 {
  94         XENCONS_RING_IDX cons, prod;
  95         struct xencons_interface *intf = xencons->intf;
  96         int sent = 0;
  97
  98         cons = intf->out_cons;
  99         prod = intf->out_prod;
 100         mb();                   /* update queue values before going on */
 101         BUG_ON((prod - cons) > sizeof(intf->out));
 102
 103         while ((sent < len) && ((prod - cons) < sizeof(intf->out)))
 104                 intf->out[MASK_XENCONS_IDX(prod++, intf->out)] = data[sent++];
 105
 106         wmb();                  /* write ring before updating pointer */
 107         intf->out_prod = prod;
 108
 109         if (sent)
 110                 notify_daemon(xencons);
 111         return sent;
 112 }
 113
 114 static int domU_write_console(uint32_t vtermno, const char *data, int len)
 115 {
 116         int ret = len;
 117         struct xencons_info *cons = vtermno_to_xencons(vtermno);
 118         if (cons == NULL)
 119                 return -EINVAL;
 120
 121         /*
 122          * Make sure the whole buffer is emitted, polling if
 123          * necessary.  We don't ever want to rely on the hvc daemon
 124          * because the most interesting console output is when the
 125          * kernel is crippled.
 126          */
 127         while (len) {
 128                 int sent = __write_console(cons, data, len);
 129
 130                 data += sent;
 131                 len -= sent;
 132
 133                 if (unlikely(len))
 134                         HYPERVISOR_sched_op(SCHEDOP_yield, NULL);
 135         }
 136
 137         return ret;
 138 }
 139
 140 static int domU_read_console(uint32_t vtermno, char *buf, int len)
 141 {
 142         struct xencons_interface *intf;
 143         XENCONS_RING_IDX cons, prod;
 144         int recv = 0;
 145         struct xencons_info *xencons = vtermno_to_xencons(vtermno);
 146         if (xencons == NULL)
 147                 return -EINVAL;
 148         intf = xencons->intf;
 149
 150         cons = intf->in_cons;
 151         prod = intf->in_prod;
 152         mb();                   /* get pointers before reading ring */
 153         BUG_ON((prod - cons) > sizeof(intf->in));
 154
 155         while (cons != prod && recv < len)
 156                 buf[recv++] = intf->in[MASK_XENCONS_IDX(cons++, intf->in)];
 157
 158         mb();                   /* read ring before consuming */
 159         intf->in_cons = cons;
 160
 161         notify_daemon(xencons);
 162         return recv;
 163 }
 164
 165 static struct hv_ops domU_hvc_ops = {
 166         .get_chars = domU_read_console,
 167         .put_chars = domU_write_console,
 168         .notifier_add = notifier_add_irq,
 169         .notifier_del = notifier_del_irq,
 170         .notifier_hangup = notifier_hangup_irq,
 171 };
 172
 173 static int dom0_read_console(uint32_t vtermno, char *buf, int len)
 174 {
 175         return HYPERVISOR_console_io(CONSOLEIO_read, len, buf);
 176 }
 177
 178 /*
 179  * Either for a dom0 to write to the system console, or a domU with a
 180  * debug version of Xen
 181  */
 182 static int dom0_write_console(uint32_t vtermno, const char *str, int len)
 183 {
 184         int rc = HYPERVISOR_console_io(CONSOLEIO_write, len, (char *)str);
 185         if (rc < 0)
 186                 return 0;
 187
 188         return len;
 189 }
 190
 191 static struct hv_ops dom0_hvc_ops = {
 192         .get_chars = dom0_read_console,
 193         .put_chars = dom0_write_console,
 194         .notifier_add = notifier_add_irq,
 195         .notifier_del = notifier_del_irq,
 196         .notifier_hangup = notifier_hangup_irq,
 197 };
 198
 199 static int xen_hvm_console_init(void)
 200 {
 201         int r;
 202         uint64_t v = 0;
 203         unsigned long mfn;
 204         struct xencons_info *info;
 205
 206         if (!xen_hvm_domain())
 207                 return -ENODEV;
 208
 209         info = vtermno_to_xencons(HVC_COOKIE);
 210         if (!info) {
 211                 info = kzalloc(sizeof(struct xencons_info), GFP_KERNEL | __GFP_ZERO);
 212                 if (!info)
 213                         return -ENOMEM;
 214         } else if (info->intf != NULL) {
 215                 /* already configured */
 216                 return 0;
 217         }
 218         /*
 219          * If the toolstack (or the hypervisor) hasn't set these values, the
 220          * default value is 0. Even though mfn = 0 and evtchn = 0 are
 221          * theoretically correct values, in practice they never are and they
 222          * mean that a legacy toolstack hasn't initialized the pv console correctly.
 223          */
 224         r = hvm_get_parameter(HVM_PARAM_CONSOLE_EVTCHN, &v);
 225         if (r < 0 || v == 0)
 226                 goto err;
 227         info->evtchn = v;
 228         v = 0;
 229         r = hvm_get_parameter(HVM_PARAM_CONSOLE_PFN, &v);
 230         if (r < 0 || v == 0)
 231                 goto err;
 232         mfn = v;
 233         info->intf = xen_remap(mfn << PAGE_SHIFT, PAGE_SIZE);
 234         if (info->intf == NULL)
 235                 goto err;
 236         info->vtermno = HVC_COOKIE;
 237
 238         spin_lock(&xencons_lock);
 239         list_add_tail(&info->list, &xenconsoles);
 240         spin_unlock(&xencons_lock);
 241
 242         return 0;
 243 err:
 244         kfree(info);
 245         return -ENODEV;
 246 }
 247
 248 static int xen_pv_console_init(void)
 249 {
 250         struct xencons_info *info;
 251
 252         if (!xen_pv_domain())
 253                 return -ENODEV;
 254
 255         if (!xen_start_info->console.domU.evtchn)
 256                 return -ENODEV;
 257
 258         info = vtermno_to_xencons(HVC_COOKIE);
 259         if (!info) {
 260                 info = kzalloc(sizeof(struct xencons_info), GFP_KERNEL | __GFP_ZERO);
 261                 if (!info)
 262                         return -ENOMEM;
 263         } else if (info->intf != NULL) {
 264                 /* already configured */
 265                 return 0;
 266         }
 267         info->evtchn = xen_start_info->console.domU.evtchn;
 268         info->intf = mfn_to_virt(xen_start_info->console.domU.mfn);
 269         info->vtermno = HVC_COOKIE;
 270
 271         spin_lock(&xencons_lock);
 272         list_add_tail(&info->list, &xenconsoles);
 273         spin_unlock(&xencons_lock);
 274
 275         return 0;
 276 }
 277
 278 static int xen_initial_domain_console_init(void)
 279 {
 280         struct xencons_info *info;
 281
 282         if (!xen_initial_domain())
 283                 return -ENODEV;
 284
 285         info = vtermno_to_xencons(HVC_COOKIE);
 286         if (!info) {
 287                 info = kzalloc(sizeof(struct xencons_info), GFP_KERNEL | __GFP_ZERO);
 288                 if (!info)
 289                         return -ENOMEM;
 290         }
 291
 292         info->irq = bind_virq_to_irq(VIRQ_CONSOLE, 0);
 293         info->vtermno = HVC_COOKIE;
 294
 295         spin_lock(&xencons_lock);
 296         list_add_tail(&info->list, &xenconsoles);
 297         spin_unlock(&xencons_lock);
 298
 299         return 0;
 300 }
 301
 302 static void xen_console_update_evtchn(struct xencons_info *info)
 303 {
 304         if (xen_hvm_domain()) {
 305                 uint64_t v;
 306                 int err;
 307
 308                 err = hvm_get_parameter(HVM_PARAM_CONSOLE_EVTCHN, &v);
 309                 if (!err && v)
 310                         info->evtchn = v;
 311         } else
 312                 info->evtchn = xen_start_info->console.domU.evtchn;
 313 }
 314
 315 void xen_console_resume(void)
 316 {
 317         struct xencons_info *info = vtermno_to_xencons(HVC_COOKIE);
 318         if (info != NULL && info->irq) {
 319                 if (!xen_initial_domain())
 320                         xen_console_update_evtchn(info);
 321                 rebind_evtchn_irq(info->evtchn, info->irq);
 322         }
 323 }
 324
 325 static void xencons_disconnect_backend(struct xencons_info *info)
 326 {
 327         if (info->irq > 0)
 328                 unbind_from_irqhandler(info->irq, NULL);
 329         info->irq = 0;
 330         if (info->evtchn > 0)
 331                 xenbus_free_evtchn(info->xbdev, info->evtchn);
 332         info->evtchn = 0;
 333         if (info->gntref > 0)
 334                 gnttab_free_grant_references(info->gntref);
 335         info->gntref = 0;
 336         if (info->hvc != NULL)
 337                 hvc_remove(info->hvc);
 338         info->hvc = NULL;
 339 }
 340
 341 static void xencons_free(struct xencons_info *info)
 342 {
 343         free_page((unsigned long)info->intf);
 344         info->intf = NULL;
 345         info->vtermno = 0;
 346         kfree(info);
 347 }
 348
 349 static int xen_console_remove(struct xencons_info *info)
 350 {
 351         xencons_disconnect_backend(info);
 352         spin_lock(&xencons_lock);
 353         list_del(&info->list);
 354         spin_unlock(&xencons_lock);
 355         if (info->xbdev != NULL)
 356                 xencons_free(info);
 357         else {
 358                 if (xen_hvm_domain())
 359                         iounmap(info->intf);
 360                 kfree(info);
 361         }
 362         return 0;
 363 }
 364
 365 #ifdef CONFIG_HVC_XEN_FRONTEND
 366 static struct xenbus_driver xencons_driver;
 367
 368 static int xencons_remove(struct xenbus_device *dev)
 369 {
 370         return xen_console_remove(dev_get_drvdata(&dev->dev));
 371 }
 372
 373 static int xencons_connect_backend(struct xenbus_device *dev,
 374                                   struct xencons_info *info)
 375 {
 376         int ret, evtchn, devid, ref, irq;
 377         struct xenbus_transaction xbt;
 378         grant_ref_t gref_head;
 379         unsigned long mfn;
 380
 381         ret = xenbus_alloc_evtchn(dev, &evtchn);
 382         if (ret)
 383                 return ret;
 384         info->evtchn = evtchn;
 385         irq = bind_evtchn_to_irq(evtchn);
 386         if (irq < 0)
 387                 return irq;
 388         info->irq = irq;
 389         devid = dev->nodename[strlen(dev->nodename) - 1] - '0';
 390         info->hvc = hvc_alloc(xenbus_devid_to_vtermno(devid),
 391                         irq, &domU_hvc_ops, 256);
 392         if (IS_ERR(info->hvc))
 393                 return PTR_ERR(info->hvc);
 394         if (xen_pv_domain())
 395                 mfn = virt_to_mfn(info->intf);
 396         else
 397                 mfn = __pa(info->intf) >> PAGE_SHIFT;
 398         ret = gnttab_alloc_grant_references(1, &gref_head);
 399         if (ret < 0)
 400                 return ret;
 401         info->gntref = gref_head;
 402         ref = gnttab_claim_grant_reference(&gref_head);
 403         if (ref < 0)
 404                 return ref;
 405         gnttab_grant_foreign_access_ref(ref, info->xbdev->otherend_id,
 406                         mfn, 0);
 407
 408  again:
 409         ret = xenbus_transaction_start(&xbt);
 410         if (ret) {
 411                 xenbus_dev_fatal(dev, ret, "starting transaction");
 412                 return ret;
 413         }
 414         ret = xenbus_printf(xbt, dev->nodename, "ring-ref", "%d", ref);
 415         if (ret)
 416                 goto error_xenbus;
 417         ret = xenbus_printf(xbt, dev->nodename, "port", "%u",
 418                             evtchn);
 419         if (ret)
 420                 goto error_xenbus;
 421         ret = xenbus_printf(xbt, dev->nodename, "type", "ioemu");
 422         if (ret)
 423                 goto error_xenbus;
 424         ret = xenbus_transaction_end(xbt, 0);
 425         if (ret) {
 426                 if (ret == -EAGAIN)
 427                         goto again;
 428                 xenbus_dev_fatal(dev, ret, "completing transaction");
 429                 return ret;
 430         }
 431
 432         xenbus_switch_state(dev, XenbusStateInitialised);
 433         return 0;
 434
 435  error_xenbus:
 436         xenbus_transaction_end(xbt, 1);
 437         xenbus_dev_fatal(dev, ret, "writing xenstore");
 438         return ret;
 439 }
 440
 441 static int xencons_probe(struct xenbus_device *dev,
 442                                   const struct xenbus_device_id *id)
 443 {
 444         int ret, devid;
 445         struct xencons_info *info;
 446
 447         devid = dev->nodename[strlen(dev->nodename) - 1] - '0';
 448         if (devid == 0)
 449                 return -ENODEV;
 450
 451         info = kzalloc(sizeof(struct xencons_info), GFP_KERNEL);
 452         if (!info)
 453                 return -ENOMEM;
 454         dev_set_drvdata(&dev->dev, info);
 455         info->xbdev = dev;
 456         info->vtermno = xenbus_devid_to_vtermno(devid);
 457         info->intf = (void *)__get_free_page(GFP_KERNEL | __GFP_ZERO);
 458         if (!info->intf)
 459                 goto error_nomem;
 460
 461         ret = xencons_connect_backend(dev, info);
 462         if (ret < 0)
 463                 goto error;
 464         spin_lock(&xencons_lock);
 465         list_add_tail(&info->list, &xenconsoles);
 466         spin_unlock(&xencons_lock);
 467
 468         return 0;
 469
 470  error_nomem:
 471         ret = -ENOMEM;
 472         xenbus_dev_fatal(dev, ret, "allocating device memory");
 473  error:
 474         xencons_disconnect_backend(info);
 475         xencons_free(info);
 476         return ret;
 477 }
 478
 479 static int xencons_resume(struct xenbus_device *dev)
 480 {
 481         struct xencons_info *info = dev_get_drvdata(&dev->dev);
 482
 483         xencons_disconnect_backend(info);
 484         memset(info->intf, 0, PAGE_SIZE);
 485         return xencons_connect_backend(dev, info);
 486 }
 487
 488 static void xencons_backend_changed(struct xenbus_device *dev,
 489                                    enum xenbus_state backend_state)
 490 {
 491         switch (backend_state) {
 492         case XenbusStateReconfiguring:
 493         case XenbusStateReconfigured:
 494         case XenbusStateInitialising:
 495         case XenbusStateInitialised:
 496         case XenbusStateUnknown:
 497                 break;
 498
 499         case XenbusStateInitWait:
 500                 break;
 501
 502         case XenbusStateConnected:
 503                 xenbus_switch_state(dev, XenbusStateConnected);
 504                 break;
 505
 506         case XenbusStateClosed:
 507                 if (dev->state == XenbusStateClosed)
 508                         break;
 509                 /* Missed the backend's CLOSING state -- fallthrough */
 510         case XenbusStateClosing:
 511                 xenbus_frontend_closed(dev);
 512                 break;
 513         }
 514 }
 515
 516 static const struct xenbus_device_id xencons_ids[] = {
 517         { "console" },
 518         { "" }
 519 };
 520
 521
 522 static DEFINE_XENBUS_DRIVER(xencons, "xenconsole",
 523         .probe = xencons_probe,
 524         .remove = xencons_remove,
 525         .resume = xencons_resume,
 526         .otherend_changed = xencons_backend_changed,
 527 );
 528 #endif /* CONFIG_HVC_XEN_FRONTEND */
 529
 530 static int __init xen_hvc_init(void)
 531 {
 532         int r;
 533         struct xencons_info *info;
 534         const struct hv_ops *ops;
 535
 536         if (!xen_domain())
 537                 return -ENODEV;
 538
 539         if (xen_initial_domain()) {
 540                 ops = &dom0_hvc_ops;
 541                 r = xen_initial_domain_console_init();
 542                 if (r < 0)
 543                         return r;
 544                 info = vtermno_to_xencons(HVC_COOKIE);
 545         } else {
 546                 ops = &domU_hvc_ops;
 547                 if (xen_hvm_domain())
 548                         r = xen_hvm_console_init();
 549                 else
 550                         r = xen_pv_console_init();
 551                 if (r < 0)
 552                         return r;
 553
 554                 info = vtermno_to_xencons(HVC_COOKIE);
 555                 info->irq = bind_evtchn_to_irq(info->evtchn);
 556         }
 557         if (info->irq < 0)
 558                 info->irq = 0; /* NO_IRQ */
 559         else
 560                 irq_set_noprobe(info->irq);
 561
 562         info->hvc = hvc_alloc(HVC_COOKIE, info->irq, ops, 256);
 563         if (IS_ERR(info->hvc)) {
 564                 r = PTR_ERR(info->hvc);
 565                 spin_lock(&xencons_lock);
 566                 list_del(&info->list);
 567                 spin_unlock(&xencons_lock);
 568                 if (info->irq)
 569                         unbind_from_irqhandler(info->irq, NULL);
 570                 kfree(info);
 571                 return r;
 572         }
 573
 574         r = 0;
 575 #ifdef CONFIG_HVC_XEN_FRONTEND
 576         r = xenbus_register_frontend(&xencons_driver);
 577 #endif
 578         return r;
 579 }
 580
 581 static void __exit xen_hvc_fini(void)
 582 {
 583         struct xencons_info *entry, *next;
 584
 585         if (list_empty(&xenconsoles))
 586                         return;
 587
 588         list_for_each_entry_safe(entry, next, &xenconsoles, list) {
 589                 xen_console_remove(entry);
 590         }
 591 }
 592
 593 static int xen_cons_init(void)
 594 {
 595         const struct hv_ops *ops;
 596
 597         if (!xen_domain())
 598                 return 0;
 599
 600         if (xen_initial_domain())
 601                 ops = &dom0_hvc_ops;
 602         else {
 603                 int r;
 604                 ops = &domU_hvc_ops;
 605
 606                 if (xen_hvm_domain())
 607                         r = xen_hvm_console_init();
 608                 else
 609                         r = xen_pv_console_init();
 610                 if (r < 0)
 611                         return r;
 612         }
 613
 614         hvc_instantiate(HVC_COOKIE, 0, ops);
 615         return 0;
 616 }
 617
 618
 619 module_init(xen_hvc_init);
 620 module_exit(xen_hvc_fini);
 621 console_initcall(xen_cons_init);
 622
 623 #ifdef CONFIG_EARLY_PRINTK
 624 static void xenboot_write_console(struct console *console, const char *string,
 625                                   unsigned len)
 626 {
 627         unsigned int linelen, off = 0;
 628         const char *pos;
 629
 630         if (!xen_pv_domain())
 631                 return;
 632
 633         dom0_write_console(0, string, len);
 634
 635         if (xen_initial_domain())
 636                 return;
 637
 638         domU_write_console(0, "(early) ", 8);
 639         while (off < len && NULL != (pos = strchr(string+off, '\n'))) {
 640                 linelen = pos-string+off;
 641                 if (off + linelen > len)
 642                         break;
 643                 domU_write_console(0, string+off, linelen);
 644                 domU_write_console(0, "\r\n", 2);
 645                 off += linelen + 1;
 646         }
 647         if (off < len)
 648                 domU_write_console(0, string+off, len-off);
 649 }
 650
 651 struct console xenboot_console = {
 652         .name           = "xenboot",
 653         .write          = xenboot_write_console,
 654         .flags          = CON_PRINTBUFFER | CON_BOOT | CON_ANYTIME,
 655         .index          = -1,
 656 };
 657 #endif  /* CONFIG_EARLY_PRINTK */
 658
 659 void xen_raw_console_write(const char *str)
 660 {
 661         dom0_write_console(0, str, strlen(str));
 662 }
 663
 664 void xen_raw_printk(const char *fmt, ...)
 665 {
 666         static char buf[512];
 667         va_list ap;
 668
 669         va_start(ap, fmt);
 670         vsnprintf(buf, sizeof(buf), fmt, ap);
 671         va_end(ap);
 672
 673         xen_raw_console_write(buf);
 674 }