Linux Audio

Check our new training course

Loading...
v6.2
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * Copyright (C) 2006, 2007, 2009 Rusty Russell, IBM Corporation
   4 * Copyright (C) 2009, 2010, 2011 Red Hat, Inc.
   5 * Copyright (C) 2009, 2010, 2011 Amit Shah <amit.shah@redhat.com>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
   6 */
   7#include <linux/cdev.h>
   8#include <linux/debugfs.h>
   9#include <linux/completion.h>
  10#include <linux/device.h>
  11#include <linux/err.h>
  12#include <linux/freezer.h>
  13#include <linux/fs.h>
  14#include <linux/splice.h>
  15#include <linux/pagemap.h>
  16#include <linux/idr.h>
  17#include <linux/init.h>
  18#include <linux/list.h>
  19#include <linux/poll.h>
  20#include <linux/sched.h>
  21#include <linux/slab.h>
  22#include <linux/spinlock.h>
  23#include <linux/virtio.h>
  24#include <linux/virtio_console.h>
  25#include <linux/wait.h>
  26#include <linux/workqueue.h>
  27#include <linux/module.h>
  28#include <linux/dma-mapping.h>
  29#include "../tty/hvc/hvc_console.h"
  30
  31#define is_rproc_enabled IS_ENABLED(CONFIG_REMOTEPROC)
  32#define VIRTCONS_MAX_PORTS 0x8000
  33
  34/*
  35 * This is a global struct for storing common data for all the devices
  36 * this driver handles.
  37 *
  38 * Mainly, it has a linked list for all the consoles in one place so
  39 * that callbacks from hvc for get_chars(), put_chars() work properly
  40 * across multiple devices and multiple ports per device.
  41 */
  42struct ports_driver_data {
  43	/* Used for registering chardevs */
  44	struct class *class;
  45
  46	/* Used for exporting per-port information to debugfs */
  47	struct dentry *debugfs_dir;
  48
  49	/* List of all the devices we're handling */
  50	struct list_head portdevs;
  51
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  52	/* All the console devices handled by this driver */
  53	struct list_head consoles;
  54};
  55
  56static struct ports_driver_data pdrvdata;
  57
  58static DEFINE_SPINLOCK(pdrvdata_lock);
  59static DECLARE_COMPLETION(early_console_added);
  60
  61/* This struct holds information that's relevant only for console ports */
  62struct console {
  63	/* We'll place all consoles in a list in the pdrvdata struct */
  64	struct list_head list;
  65
  66	/* The hvc device associated with this console port */
  67	struct hvc_struct *hvc;
  68
  69	/* The size of the console */
  70	struct winsize ws;
  71
  72	/*
  73	 * This number identifies the number that we used to register
  74	 * with hvc in hvc_instantiate() and hvc_alloc(); this is the
  75	 * number passed on by the hvc callbacks to us to
  76	 * differentiate between the other console ports handled by
  77	 * this driver
  78	 */
  79	u32 vtermno;
  80};
  81
  82static DEFINE_IDA(vtermno_ida);
  83
  84struct port_buffer {
  85	char *buf;
  86
  87	/* size of the buffer in *buf above */
  88	size_t size;
  89
  90	/* used length of the buffer */
  91	size_t len;
  92	/* offset in the buf from which to consume data */
  93	size_t offset;
  94
  95	/* DMA address of buffer */
  96	dma_addr_t dma;
  97
  98	/* Device we got DMA memory from */
  99	struct device *dev;
 100
 101	/* List of pending dma buffers to free */
 102	struct list_head list;
 103
 104	/* If sgpages == 0 then buf is used */
 105	unsigned int sgpages;
 106
 107	/* sg is used if spages > 0. sg must be the last in is struct */
 108	struct scatterlist sg[];
 109};
 110
 111/*
 112 * This is a per-device struct that stores data common to all the
 113 * ports for that device (vdev->priv).
 114 */
 115struct ports_device {
 116	/* Next portdev in the list, head is in the pdrvdata struct */
 117	struct list_head list;
 118
 119	/*
 120	 * Workqueue handlers where we process deferred work after
 121	 * notification
 122	 */
 123	struct work_struct control_work;
 124	struct work_struct config_work;
 125
 126	struct list_head ports;
 127
 128	/* To protect the list of ports */
 129	spinlock_t ports_lock;
 130
 131	/* To protect the vq operations for the control channel */
 132	spinlock_t c_ivq_lock;
 133	spinlock_t c_ovq_lock;
 134
 135	/* max. number of ports this device can hold */
 136	u32 max_nr_ports;
 137
 138	/* The virtio device we're associated with */
 139	struct virtio_device *vdev;
 140
 141	/*
 142	 * A couple of virtqueues for the control channel: one for
 143	 * guest->host transfers, one for host->guest transfers
 144	 */
 145	struct virtqueue *c_ivq, *c_ovq;
 146
 147	/*
 148	 * A control packet buffer for guest->host requests, protected
 149	 * by c_ovq_lock.
 150	 */
 151	struct virtio_console_control cpkt;
 152
 153	/* Array of per-port IO virtqueues */
 154	struct virtqueue **in_vqs, **out_vqs;
 155
 
 
 
 156	/* Major number for this device.  Ports will be created as minors. */
 157	int chr_major;
 158};
 159
 160struct port_stats {
 161	unsigned long bytes_sent, bytes_received, bytes_discarded;
 162};
 163
 164/* This struct holds the per-port data */
 165struct port {
 166	/* Next port in the list, head is in the ports_device */
 167	struct list_head list;
 168
 169	/* Pointer to the parent virtio_console device */
 170	struct ports_device *portdev;
 171
 172	/* The current buffer from which data has to be fed to readers */
 173	struct port_buffer *inbuf;
 174
 175	/*
 176	 * To protect the operations on the in_vq associated with this
 177	 * port.  Has to be a spinlock because it can be called from
 178	 * interrupt context (get_char()).
 179	 */
 180	spinlock_t inbuf_lock;
 181
 182	/* Protect the operations on the out_vq. */
 183	spinlock_t outvq_lock;
 184
 185	/* The IO vqs for this port */
 186	struct virtqueue *in_vq, *out_vq;
 187
 188	/* File in the debugfs directory that exposes this port's information */
 189	struct dentry *debugfs_file;
 190
 191	/*
 192	 * Keep count of the bytes sent, received and discarded for
 193	 * this port for accounting and debugging purposes.  These
 194	 * counts are not reset across port open / close events.
 195	 */
 196	struct port_stats stats;
 197
 198	/*
 199	 * The entries in this struct will be valid if this port is
 200	 * hooked up to an hvc console
 201	 */
 202	struct console cons;
 203
 204	/* Each port associates with a separate char device */
 205	struct cdev *cdev;
 206	struct device *dev;
 207
 208	/* Reference-counting to handle port hot-unplugs and file operations */
 209	struct kref kref;
 210
 211	/* A waitqueue for poll() or blocking read operations */
 212	wait_queue_head_t waitqueue;
 213
 214	/* The 'name' of the port that we expose via sysfs properties */
 215	char *name;
 216
 217	/* We can notify apps of host connect / disconnect events via SIGIO */
 218	struct fasync_struct *async_queue;
 219
 220	/* The 'id' to identify the port with the Host */
 221	u32 id;
 222
 223	bool outvq_full;
 224
 225	/* Is the host device open */
 226	bool host_connected;
 227
 228	/* We should allow only one process to open a port */
 229	bool guest_connected;
 230};
 231
 232/* This is the very early arch-specified put chars function. */
 233static int (*early_put_chars)(u32, const char *, int);
 234
 235static struct port *find_port_by_vtermno(u32 vtermno)
 236{
 237	struct port *port;
 238	struct console *cons;
 239	unsigned long flags;
 240
 241	spin_lock_irqsave(&pdrvdata_lock, flags);
 242	list_for_each_entry(cons, &pdrvdata.consoles, list) {
 243		if (cons->vtermno == vtermno) {
 244			port = container_of(cons, struct port, cons);
 245			goto out;
 246		}
 247	}
 248	port = NULL;
 249out:
 250	spin_unlock_irqrestore(&pdrvdata_lock, flags);
 251	return port;
 252}
 253
 254static struct port *find_port_by_devt_in_portdev(struct ports_device *portdev,
 255						 dev_t dev)
 256{
 257	struct port *port;
 258	unsigned long flags;
 259
 260	spin_lock_irqsave(&portdev->ports_lock, flags);
 261	list_for_each_entry(port, &portdev->ports, list) {
 262		if (port->cdev->dev == dev) {
 263			kref_get(&port->kref);
 264			goto out;
 265		}
 266	}
 267	port = NULL;
 268out:
 269	spin_unlock_irqrestore(&portdev->ports_lock, flags);
 270
 271	return port;
 272}
 273
 274static struct port *find_port_by_devt(dev_t dev)
 275{
 276	struct ports_device *portdev;
 277	struct port *port;
 278	unsigned long flags;
 279
 280	spin_lock_irqsave(&pdrvdata_lock, flags);
 281	list_for_each_entry(portdev, &pdrvdata.portdevs, list) {
 282		port = find_port_by_devt_in_portdev(portdev, dev);
 283		if (port)
 284			goto out;
 285	}
 286	port = NULL;
 287out:
 288	spin_unlock_irqrestore(&pdrvdata_lock, flags);
 289	return port;
 290}
 291
 292static struct port *find_port_by_id(struct ports_device *portdev, u32 id)
 293{
 294	struct port *port;
 295	unsigned long flags;
 296
 297	spin_lock_irqsave(&portdev->ports_lock, flags);
 298	list_for_each_entry(port, &portdev->ports, list)
 299		if (port->id == id)
 300			goto out;
 301	port = NULL;
 302out:
 303	spin_unlock_irqrestore(&portdev->ports_lock, flags);
 304
 305	return port;
 306}
 307
 308static struct port *find_port_by_vq(struct ports_device *portdev,
 309				    struct virtqueue *vq)
 310{
 311	struct port *port;
 312	unsigned long flags;
 313
 314	spin_lock_irqsave(&portdev->ports_lock, flags);
 315	list_for_each_entry(port, &portdev->ports, list)
 316		if (port->in_vq == vq || port->out_vq == vq)
 317			goto out;
 318	port = NULL;
 319out:
 320	spin_unlock_irqrestore(&portdev->ports_lock, flags);
 321	return port;
 322}
 323
 324static bool is_console_port(struct port *port)
 325{
 326	if (port->cons.hvc)
 327		return true;
 328	return false;
 329}
 330
 331static bool is_rproc_serial(const struct virtio_device *vdev)
 332{
 333	return is_rproc_enabled && vdev->id.device == VIRTIO_ID_RPROC_SERIAL;
 334}
 335
 336static inline bool use_multiport(struct ports_device *portdev)
 337{
 338	/*
 339	 * This condition can be true when put_chars is called from
 340	 * early_init
 341	 */
 342	if (!portdev->vdev)
 343		return false;
 344	return __virtio_test_bit(portdev->vdev, VIRTIO_CONSOLE_F_MULTIPORT);
 345}
 346
 347static DEFINE_SPINLOCK(dma_bufs_lock);
 348static LIST_HEAD(pending_free_dma_bufs);
 349
 350static void free_buf(struct port_buffer *buf, bool can_sleep)
 351{
 352	unsigned int i;
 353
 354	for (i = 0; i < buf->sgpages; i++) {
 355		struct page *page = sg_page(&buf->sg[i]);
 356		if (!page)
 357			break;
 358		put_page(page);
 359	}
 360
 361	if (!buf->dev) {
 362		kfree(buf->buf);
 363	} else if (is_rproc_enabled) {
 364		unsigned long flags;
 365
 366		/* dma_free_coherent requires interrupts to be enabled. */
 367		if (!can_sleep) {
 368			/* queue up dma-buffers to be freed later */
 369			spin_lock_irqsave(&dma_bufs_lock, flags);
 370			list_add_tail(&buf->list, &pending_free_dma_bufs);
 371			spin_unlock_irqrestore(&dma_bufs_lock, flags);
 372			return;
 373		}
 374		dma_free_coherent(buf->dev, buf->size, buf->buf, buf->dma);
 375
 376		/* Release device refcnt and allow it to be freed */
 377		put_device(buf->dev);
 378	}
 379
 380	kfree(buf);
 381}
 382
 383static void reclaim_dma_bufs(void)
 384{
 385	unsigned long flags;
 386	struct port_buffer *buf, *tmp;
 387	LIST_HEAD(tmp_list);
 388
 389	if (list_empty(&pending_free_dma_bufs))
 390		return;
 391
 392	/* Create a copy of the pending_free_dma_bufs while holding the lock */
 393	spin_lock_irqsave(&dma_bufs_lock, flags);
 394	list_cut_position(&tmp_list, &pending_free_dma_bufs,
 395			  pending_free_dma_bufs.prev);
 396	spin_unlock_irqrestore(&dma_bufs_lock, flags);
 397
 398	/* Release the dma buffers, without irqs enabled */
 399	list_for_each_entry_safe(buf, tmp, &tmp_list, list) {
 400		list_del(&buf->list);
 401		free_buf(buf, true);
 402	}
 403}
 404
 405static struct port_buffer *alloc_buf(struct virtio_device *vdev, size_t buf_size,
 406				     int pages)
 407{
 408	struct port_buffer *buf;
 409
 410	reclaim_dma_bufs();
 411
 412	/*
 413	 * Allocate buffer and the sg list. The sg list array is allocated
 414	 * directly after the port_buffer struct.
 415	 */
 416	buf = kmalloc(struct_size(buf, sg, pages), GFP_KERNEL);
 417	if (!buf)
 418		goto fail;
 419
 420	buf->sgpages = pages;
 421	if (pages > 0) {
 422		buf->dev = NULL;
 423		buf->buf = NULL;
 424		return buf;
 425	}
 426
 427	if (is_rproc_serial(vdev)) {
 428		/*
 429		 * Allocate DMA memory from ancestor. When a virtio
 430		 * device is created by remoteproc, the DMA memory is
 431		 * associated with the parent device:
 432		 * virtioY => remoteprocX#vdevYbuffer.
 433		 */
 434		buf->dev = vdev->dev.parent;
 435		if (!buf->dev)
 436			goto free_buf;
 437
 438		/* Increase device refcnt to avoid freeing it */
 439		get_device(buf->dev);
 440		buf->buf = dma_alloc_coherent(buf->dev, buf_size, &buf->dma,
 441					      GFP_KERNEL);
 442	} else {
 443		buf->dev = NULL;
 444		buf->buf = kmalloc(buf_size, GFP_KERNEL);
 445	}
 446
 447	if (!buf->buf)
 448		goto free_buf;
 449	buf->len = 0;
 450	buf->offset = 0;
 451	buf->size = buf_size;
 452	return buf;
 453
 454free_buf:
 455	kfree(buf);
 456fail:
 457	return NULL;
 458}
 459
 460/* Callers should take appropriate locks */
 461static struct port_buffer *get_inbuf(struct port *port)
 462{
 463	struct port_buffer *buf;
 464	unsigned int len;
 465
 466	if (port->inbuf)
 467		return port->inbuf;
 468
 469	buf = virtqueue_get_buf(port->in_vq, &len);
 470	if (buf) {
 471		buf->len = min_t(size_t, len, buf->size);
 472		buf->offset = 0;
 473		port->stats.bytes_received += len;
 474	}
 475	return buf;
 476}
 477
 478/*
 479 * Create a scatter-gather list representing our input buffer and put
 480 * it in the queue.
 481 *
 482 * Callers should take appropriate locks.
 483 */
 484static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
 485{
 486	struct scatterlist sg[1];
 487	int ret;
 488
 489	sg_init_one(sg, buf->buf, buf->size);
 490
 491	ret = virtqueue_add_inbuf(vq, sg, 1, buf, GFP_ATOMIC);
 492	virtqueue_kick(vq);
 493	if (!ret)
 494		ret = vq->num_free;
 495	return ret;
 496}
 497
 498/* Discard any unread data this port has. Callers lockers. */
 499static void discard_port_data(struct port *port)
 500{
 501	struct port_buffer *buf;
 502	unsigned int err;
 503
 504	if (!port->portdev) {
 505		/* Device has been unplugged.  vqs are already gone. */
 506		return;
 507	}
 508	buf = get_inbuf(port);
 509
 510	err = 0;
 511	while (buf) {
 512		port->stats.bytes_discarded += buf->len - buf->offset;
 513		if (add_inbuf(port->in_vq, buf) < 0) {
 514			err++;
 515			free_buf(buf, false);
 516		}
 517		port->inbuf = NULL;
 518		buf = get_inbuf(port);
 519	}
 520	if (err)
 521		dev_warn(port->dev, "Errors adding %d buffers back to vq\n",
 522			 err);
 523}
 524
 525static bool port_has_data(struct port *port)
 526{
 527	unsigned long flags;
 528	bool ret;
 529
 530	ret = false;
 531	spin_lock_irqsave(&port->inbuf_lock, flags);
 532	port->inbuf = get_inbuf(port);
 533	if (port->inbuf)
 534		ret = true;
 535
 536	spin_unlock_irqrestore(&port->inbuf_lock, flags);
 537	return ret;
 538}
 539
 540static ssize_t __send_control_msg(struct ports_device *portdev, u32 port_id,
 541				  unsigned int event, unsigned int value)
 542{
 543	struct scatterlist sg[1];
 
 544	struct virtqueue *vq;
 545	unsigned int len;
 546
 547	if (!use_multiport(portdev))
 548		return 0;
 549
 550	vq = portdev->c_ovq;
 
 
 551
 552	spin_lock(&portdev->c_ovq_lock);
 553
 554	portdev->cpkt.id = cpu_to_virtio32(portdev->vdev, port_id);
 555	portdev->cpkt.event = cpu_to_virtio16(portdev->vdev, event);
 556	portdev->cpkt.value = cpu_to_virtio16(portdev->vdev, value);
 557
 558	sg_init_one(sg, &portdev->cpkt, sizeof(struct virtio_console_control));
 559
 560	if (virtqueue_add_outbuf(vq, sg, 1, &portdev->cpkt, GFP_ATOMIC) == 0) {
 
 561		virtqueue_kick(vq);
 562		while (!virtqueue_get_buf(vq, &len)
 563			&& !virtqueue_is_broken(vq))
 564			cpu_relax();
 565	}
 566
 567	spin_unlock(&portdev->c_ovq_lock);
 568	return 0;
 569}
 570
 571static ssize_t send_control_msg(struct port *port, unsigned int event,
 572				unsigned int value)
 573{
 574	/* Did the port get unplugged before userspace closed it? */
 575	if (port->portdev)
 576		return __send_control_msg(port->portdev, port->id, event, value);
 577	return 0;
 578}
 579
 580
 581/* Callers must take the port->outvq_lock */
 582static void reclaim_consumed_buffers(struct port *port)
 583{
 584	struct port_buffer *buf;
 585	unsigned int len;
 586
 587	if (!port->portdev) {
 588		/* Device has been unplugged.  vqs are already gone. */
 589		return;
 590	}
 591	while ((buf = virtqueue_get_buf(port->out_vq, &len))) {
 592		free_buf(buf, false);
 593		port->outvq_full = false;
 594	}
 595}
 596
 597static ssize_t __send_to_port(struct port *port, struct scatterlist *sg,
 598			      int nents, size_t in_count,
 599			      void *data, bool nonblock)
 600{
 
 601	struct virtqueue *out_vq;
 602	int err;
 603	unsigned long flags;
 604	unsigned int len;
 605
 606	out_vq = port->out_vq;
 607
 608	spin_lock_irqsave(&port->outvq_lock, flags);
 609
 610	reclaim_consumed_buffers(port);
 611
 612	err = virtqueue_add_outbuf(out_vq, sg, nents, data, GFP_ATOMIC);
 
 613
 614	/* Tell Host to go! */
 615	virtqueue_kick(out_vq);
 616
 617	if (err) {
 618		in_count = 0;
 619		goto done;
 620	}
 621
 622	if (out_vq->num_free == 0)
 623		port->outvq_full = true;
 624
 625	if (nonblock)
 626		goto done;
 627
 628	/*
 629	 * Wait till the host acknowledges it pushed out the data we
 630	 * sent.  This is done for data from the hvc_console; the tty
 631	 * operations are performed with spinlocks held so we can't
 632	 * sleep here.  An alternative would be to copy the data to a
 633	 * buffer and relax the spinning requirement.  The downside is
 634	 * we need to kmalloc a GFP_ATOMIC buffer each time the
 635	 * console driver writes something out.
 636	 */
 637	while (!virtqueue_get_buf(out_vq, &len)
 638		&& !virtqueue_is_broken(out_vq))
 639		cpu_relax();
 640done:
 641	spin_unlock_irqrestore(&port->outvq_lock, flags);
 642
 643	port->stats.bytes_sent += in_count;
 644	/*
 645	 * We're expected to return the amount of data we wrote -- all
 646	 * of it
 647	 */
 648	return in_count;
 649}
 650
 651/*
 652 * Give out the data that's requested from the buffer that we have
 653 * queued up.
 654 */
 655static ssize_t fill_readbuf(struct port *port, char __user *out_buf,
 656			    size_t out_count, bool to_user)
 657{
 658	struct port_buffer *buf;
 659	unsigned long flags;
 660
 661	if (!out_count || !port_has_data(port))
 662		return 0;
 663
 664	buf = port->inbuf;
 665	out_count = min(out_count, buf->len - buf->offset);
 666
 667	if (to_user) {
 668		ssize_t ret;
 669
 670		ret = copy_to_user(out_buf, buf->buf + buf->offset, out_count);
 671		if (ret)
 672			return -EFAULT;
 673	} else {
 674		memcpy((__force char *)out_buf, buf->buf + buf->offset,
 675		       out_count);
 676	}
 677
 678	buf->offset += out_count;
 679
 680	if (buf->offset == buf->len) {
 681		/*
 682		 * We're done using all the data in this buffer.
 683		 * Re-queue so that the Host can send us more data.
 684		 */
 685		spin_lock_irqsave(&port->inbuf_lock, flags);
 686		port->inbuf = NULL;
 687
 688		if (add_inbuf(port->in_vq, buf) < 0)
 689			dev_warn(port->dev, "failed add_buf\n");
 690
 691		spin_unlock_irqrestore(&port->inbuf_lock, flags);
 692	}
 693	/* Return the number of bytes actually copied */
 694	return out_count;
 695}
 696
 697/* The condition that must be true for polling to end */
 698static bool will_read_block(struct port *port)
 699{
 700	if (!port->guest_connected) {
 701		/* Port got hot-unplugged. Let's exit. */
 702		return false;
 703	}
 704	return !port_has_data(port) && port->host_connected;
 705}
 706
 707static bool will_write_block(struct port *port)
 708{
 709	bool ret;
 710
 711	if (!port->guest_connected) {
 712		/* Port got hot-unplugged. Let's exit. */
 713		return false;
 714	}
 715	if (!port->host_connected)
 716		return true;
 717
 718	spin_lock_irq(&port->outvq_lock);
 719	/*
 720	 * Check if the Host has consumed any buffers since we last
 721	 * sent data (this is only applicable for nonblocking ports).
 722	 */
 723	reclaim_consumed_buffers(port);
 724	ret = port->outvq_full;
 725	spin_unlock_irq(&port->outvq_lock);
 726
 727	return ret;
 728}
 729
 730static ssize_t port_fops_read(struct file *filp, char __user *ubuf,
 731			      size_t count, loff_t *offp)
 732{
 733	struct port *port;
 734	ssize_t ret;
 735
 736	port = filp->private_data;
 737
 738	/* Port is hot-unplugged. */
 739	if (!port->guest_connected)
 740		return -ENODEV;
 741
 742	if (!port_has_data(port)) {
 743		/*
 744		 * If nothing's connected on the host just return 0 in
 745		 * case of list_empty; this tells the userspace app
 746		 * that there's no connection
 747		 */
 748		if (!port->host_connected)
 749			return 0;
 750		if (filp->f_flags & O_NONBLOCK)
 751			return -EAGAIN;
 752
 753		ret = wait_event_freezable(port->waitqueue,
 754					   !will_read_block(port));
 755		if (ret < 0)
 756			return ret;
 757	}
 758	/* Port got hot-unplugged while we were waiting above. */
 759	if (!port->guest_connected)
 760		return -ENODEV;
 761	/*
 762	 * We could've received a disconnection message while we were
 763	 * waiting for more data.
 764	 *
 765	 * This check is not clubbed in the if() statement above as we
 766	 * might receive some data as well as the host could get
 767	 * disconnected after we got woken up from our wait.  So we
 768	 * really want to give off whatever data we have and only then
 769	 * check for host_connected.
 770	 */
 771	if (!port_has_data(port) && !port->host_connected)
 772		return 0;
 773
 774	return fill_readbuf(port, ubuf, count, true);
 775}
 776
 777static int wait_port_writable(struct port *port, bool nonblock)
 778{
 779	int ret;
 780
 781	if (will_write_block(port)) {
 782		if (nonblock)
 783			return -EAGAIN;
 784
 785		ret = wait_event_freezable(port->waitqueue,
 786					   !will_write_block(port));
 787		if (ret < 0)
 788			return ret;
 789	}
 790	/* Port got hot-unplugged. */
 791	if (!port->guest_connected)
 792		return -ENODEV;
 793
 794	return 0;
 795}
 796
 797static ssize_t port_fops_write(struct file *filp, const char __user *ubuf,
 798			       size_t count, loff_t *offp)
 799{
 800	struct port *port;
 801	struct port_buffer *buf;
 802	ssize_t ret;
 803	bool nonblock;
 804	struct scatterlist sg[1];
 805
 806	/* Userspace could be out to fool us */
 807	if (!count)
 808		return 0;
 809
 810	port = filp->private_data;
 811
 812	nonblock = filp->f_flags & O_NONBLOCK;
 813
 814	ret = wait_port_writable(port, nonblock);
 815	if (ret < 0)
 816		return ret;
 
 
 
 
 
 
 
 
 
 817
 818	count = min((size_t)(32 * 1024), count);
 819
 820	buf = alloc_buf(port->portdev->vdev, count, 0);
 821	if (!buf)
 822		return -ENOMEM;
 823
 824	ret = copy_from_user(buf->buf, ubuf, count);
 825	if (ret) {
 826		ret = -EFAULT;
 827		goto free_buf;
 828	}
 829
 830	/*
 831	 * We now ask send_buf() to not spin for generic ports -- we
 832	 * can re-use the same code path that non-blocking file
 833	 * descriptors take for blocking file descriptors since the
 834	 * wait is already done and we're certain the write will go
 835	 * through to the host.
 836	 */
 837	nonblock = true;
 838	sg_init_one(sg, buf->buf, count);
 839	ret = __send_to_port(port, sg, 1, count, buf, nonblock);
 840
 841	if (nonblock && ret > 0)
 842		goto out;
 843
 844free_buf:
 845	free_buf(buf, true);
 846out:
 847	return ret;
 848}
 849
 850struct sg_list {
 851	unsigned int n;
 852	unsigned int size;
 853	size_t len;
 854	struct scatterlist *sg;
 855};
 856
 857static int pipe_to_sg(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
 858			struct splice_desc *sd)
 859{
 860	struct sg_list *sgl = sd->u.data;
 861	unsigned int offset, len;
 862
 863	if (sgl->n == sgl->size)
 864		return 0;
 865
 866	/* Try lock this page */
 867	if (pipe_buf_try_steal(pipe, buf)) {
 868		/* Get reference and unlock page for moving */
 869		get_page(buf->page);
 870		unlock_page(buf->page);
 871
 872		len = min(buf->len, sd->len);
 873		sg_set_page(&(sgl->sg[sgl->n]), buf->page, len, buf->offset);
 874	} else {
 875		/* Failback to copying a page */
 876		struct page *page = alloc_page(GFP_KERNEL);
 877		char *src;
 878
 879		if (!page)
 880			return -ENOMEM;
 881
 882		offset = sd->pos & ~PAGE_MASK;
 883
 884		len = sd->len;
 885		if (len + offset > PAGE_SIZE)
 886			len = PAGE_SIZE - offset;
 887
 888		src = kmap_atomic(buf->page);
 889		memcpy(page_address(page) + offset, src + buf->offset, len);
 890		kunmap_atomic(src);
 891
 892		sg_set_page(&(sgl->sg[sgl->n]), page, len, offset);
 893	}
 894	sgl->n++;
 895	sgl->len += len;
 896
 897	return len;
 898}
 899
 900/* Faster zero-copy write by splicing */
 901static ssize_t port_fops_splice_write(struct pipe_inode_info *pipe,
 902				      struct file *filp, loff_t *ppos,
 903				      size_t len, unsigned int flags)
 904{
 905	struct port *port = filp->private_data;
 906	struct sg_list sgl;
 907	ssize_t ret;
 908	struct port_buffer *buf;
 909	struct splice_desc sd = {
 910		.total_len = len,
 911		.flags = flags,
 912		.pos = *ppos,
 913		.u.data = &sgl,
 914	};
 915	unsigned int occupancy;
 916
 917	/*
 918	 * Rproc_serial does not yet support splice. To support splice
 919	 * pipe_to_sg() must allocate dma-buffers and copy content from
 920	 * regular pages to dma pages. And alloc_buf and free_buf must
 921	 * support allocating and freeing such a list of dma-buffers.
 922	 */
 923	if (is_rproc_serial(port->out_vq->vdev))
 924		return -EINVAL;
 925
 926	pipe_lock(pipe);
 927	ret = 0;
 928	if (pipe_empty(pipe->head, pipe->tail))
 929		goto error_out;
 930
 931	ret = wait_port_writable(port, filp->f_flags & O_NONBLOCK);
 932	if (ret < 0)
 933		goto error_out;
 934
 935	occupancy = pipe_occupancy(pipe->head, pipe->tail);
 936	buf = alloc_buf(port->portdev->vdev, 0, occupancy);
 937
 938	if (!buf) {
 939		ret = -ENOMEM;
 940		goto error_out;
 941	}
 942
 943	sgl.n = 0;
 944	sgl.len = 0;
 945	sgl.size = occupancy;
 946	sgl.sg = buf->sg;
 947	sg_init_table(sgl.sg, sgl.size);
 948	ret = __splice_from_pipe(pipe, &sd, pipe_to_sg);
 949	pipe_unlock(pipe);
 950	if (likely(ret > 0))
 951		ret = __send_to_port(port, buf->sg, sgl.n, sgl.len, buf, true);
 952
 953	if (unlikely(ret <= 0))
 954		free_buf(buf, true);
 955	return ret;
 956
 957error_out:
 958	pipe_unlock(pipe);
 959	return ret;
 960}
 961
 962static __poll_t port_fops_poll(struct file *filp, poll_table *wait)
 963{
 964	struct port *port;
 965	__poll_t ret;
 966
 967	port = filp->private_data;
 968	poll_wait(filp, &port->waitqueue, wait);
 969
 970	if (!port->guest_connected) {
 971		/* Port got unplugged */
 972		return EPOLLHUP;
 973	}
 974	ret = 0;
 975	if (!will_read_block(port))
 976		ret |= EPOLLIN | EPOLLRDNORM;
 977	if (!will_write_block(port))
 978		ret |= EPOLLOUT;
 979	if (!port->host_connected)
 980		ret |= EPOLLHUP;
 981
 982	return ret;
 983}
 984
 985static void remove_port(struct kref *kref);
 986
 987static int port_fops_release(struct inode *inode, struct file *filp)
 988{
 989	struct port *port;
 990
 991	port = filp->private_data;
 992
 993	/* Notify host of port being closed */
 994	send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
 995
 996	spin_lock_irq(&port->inbuf_lock);
 997	port->guest_connected = false;
 998
 999	discard_port_data(port);
1000
1001	spin_unlock_irq(&port->inbuf_lock);
1002
1003	spin_lock_irq(&port->outvq_lock);
1004	reclaim_consumed_buffers(port);
1005	spin_unlock_irq(&port->outvq_lock);
1006
1007	reclaim_dma_bufs();
1008	/*
1009	 * Locks aren't necessary here as a port can't be opened after
1010	 * unplug, and if a port isn't unplugged, a kref would already
1011	 * exist for the port.  Plus, taking ports_lock here would
1012	 * create a dependency on other locks taken by functions
1013	 * inside remove_port if we're the last holder of the port,
1014	 * creating many problems.
1015	 */
1016	kref_put(&port->kref, remove_port);
1017
1018	return 0;
1019}
1020
1021static int port_fops_open(struct inode *inode, struct file *filp)
1022{
1023	struct cdev *cdev = inode->i_cdev;
1024	struct port *port;
1025	int ret;
1026
1027	/* We get the port with a kref here */
1028	port = find_port_by_devt(cdev->dev);
1029	if (!port) {
1030		/* Port was unplugged before we could proceed */
1031		return -ENXIO;
1032	}
1033	filp->private_data = port;
1034
 
 
 
 
 
1035	/*
1036	 * Don't allow opening of console port devices -- that's done
1037	 * via /dev/hvc
1038	 */
1039	if (is_console_port(port)) {
1040		ret = -ENXIO;
1041		goto out;
1042	}
1043
1044	/* Allow only one process to open a particular port at a time */
1045	spin_lock_irq(&port->inbuf_lock);
1046	if (port->guest_connected) {
1047		spin_unlock_irq(&port->inbuf_lock);
1048		ret = -EBUSY;
1049		goto out;
1050	}
1051
1052	port->guest_connected = true;
1053	spin_unlock_irq(&port->inbuf_lock);
1054
1055	spin_lock_irq(&port->outvq_lock);
1056	/*
1057	 * There might be a chance that we missed reclaiming a few
1058	 * buffers in the window of the port getting previously closed
1059	 * and opening now.
1060	 */
1061	reclaim_consumed_buffers(port);
1062	spin_unlock_irq(&port->outvq_lock);
1063
1064	nonseekable_open(inode, filp);
1065
1066	/* Notify host of port being opened */
1067	send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
1068
1069	return 0;
1070out:
1071	kref_put(&port->kref, remove_port);
1072	return ret;
1073}
1074
1075static int port_fops_fasync(int fd, struct file *filp, int mode)
1076{
1077	struct port *port;
1078
1079	port = filp->private_data;
1080	return fasync_helper(fd, filp, mode, &port->async_queue);
1081}
1082
1083/*
1084 * The file operations that we support: programs in the guest can open
1085 * a console device, read from it, write to it, poll for data and
1086 * close it.  The devices are at
1087 *   /dev/vport<device number>p<port number>
1088 */
1089static const struct file_operations port_fops = {
1090	.owner = THIS_MODULE,
1091	.open  = port_fops_open,
1092	.read  = port_fops_read,
1093	.write = port_fops_write,
1094	.splice_write = port_fops_splice_write,
1095	.poll  = port_fops_poll,
1096	.release = port_fops_release,
1097	.fasync = port_fops_fasync,
1098	.llseek = no_llseek,
1099};
1100
1101/*
1102 * The put_chars() callback is pretty straightforward.
1103 *
1104 * We turn the characters into a scatter-gather list, add it to the
1105 * output queue and then kick the Host.  Then we sit here waiting for
1106 * it to finish: inefficient in theory, but in practice
1107 * implementations will do it immediately.
1108 */
1109static int put_chars(u32 vtermno, const char *buf, int count)
1110{
1111	struct port *port;
1112	struct scatterlist sg[1];
1113	void *data;
1114	int ret;
1115
1116	if (unlikely(early_put_chars))
1117		return early_put_chars(vtermno, buf, count);
1118
1119	port = find_port_by_vtermno(vtermno);
1120	if (!port)
1121		return -EPIPE;
1122
1123	data = kmemdup(buf, count, GFP_ATOMIC);
1124	if (!data)
1125		return -ENOMEM;
1126
1127	sg_init_one(sg, data, count);
1128	ret = __send_to_port(port, sg, 1, count, data, false);
1129	kfree(data);
1130	return ret;
1131}
1132
1133/*
1134 * get_chars() is the callback from the hvc_console infrastructure
1135 * when an interrupt is received.
1136 *
1137 * We call out to fill_readbuf that gets us the required data from the
1138 * buffers that are queued up.
1139 */
1140static int get_chars(u32 vtermno, char *buf, int count)
1141{
1142	struct port *port;
1143
1144	/* If we've not set up the port yet, we have no input to give. */
1145	if (unlikely(early_put_chars))
1146		return 0;
1147
1148	port = find_port_by_vtermno(vtermno);
1149	if (!port)
1150		return -EPIPE;
1151
1152	/* If we don't have an input queue yet, we can't get input. */
1153	BUG_ON(!port->in_vq);
1154
1155	return fill_readbuf(port, (__force char __user *)buf, count, false);
1156}
1157
1158static void resize_console(struct port *port)
1159{
1160	struct virtio_device *vdev;
1161
1162	/* The port could have been hot-unplugged */
1163	if (!port || !is_console_port(port))
1164		return;
1165
1166	vdev = port->portdev->vdev;
1167
1168	/* Don't test F_SIZE at all if we're rproc: not a valid feature! */
1169	if (!is_rproc_serial(vdev) &&
1170	    virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE))
1171		hvc_resize(port->cons.hvc, port->cons.ws);
1172}
1173
1174/* We set the configuration at this point, since we now have a tty */
1175static int notifier_add_vio(struct hvc_struct *hp, int data)
1176{
1177	struct port *port;
1178
1179	port = find_port_by_vtermno(hp->vtermno);
1180	if (!port)
1181		return -EINVAL;
1182
1183	hp->irq_requested = 1;
1184	resize_console(port);
1185
1186	return 0;
1187}
1188
1189static void notifier_del_vio(struct hvc_struct *hp, int data)
1190{
1191	hp->irq_requested = 0;
1192}
1193
1194/* The operations for console ports. */
1195static const struct hv_ops hv_ops = {
1196	.get_chars = get_chars,
1197	.put_chars = put_chars,
1198	.notifier_add = notifier_add_vio,
1199	.notifier_del = notifier_del_vio,
1200	.notifier_hangup = notifier_del_vio,
1201};
1202
1203/*
1204 * Console drivers are initialized very early so boot messages can go
1205 * out, so we do things slightly differently from the generic virtio
1206 * initialization of the net and block drivers.
1207 *
1208 * At this stage, the console is output-only.  It's too early to set
1209 * up a virtqueue, so we let the drivers do some boutique early-output
1210 * thing.
1211 */
1212int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
1213{
1214	early_put_chars = put_chars;
1215	return hvc_instantiate(0, 0, &hv_ops);
1216}
1217
1218static int init_port_console(struct port *port)
1219{
1220	int ret;
1221
1222	/*
1223	 * The Host's telling us this port is a console port.  Hook it
1224	 * up with an hvc console.
1225	 *
1226	 * To set up and manage our virtual console, we call
1227	 * hvc_alloc().
1228	 *
1229	 * The first argument of hvc_alloc() is the virtual console
1230	 * number.  The second argument is the parameter for the
1231	 * notification mechanism (like irq number).  We currently
1232	 * leave this as zero, virtqueues have implicit notifications.
1233	 *
1234	 * The third argument is a "struct hv_ops" containing the
1235	 * put_chars() get_chars(), notifier_add() and notifier_del()
1236	 * pointers.  The final argument is the output buffer size: we
1237	 * can do any size, so we put PAGE_SIZE here.
1238	 */
1239	ret = ida_alloc_min(&vtermno_ida, 1, GFP_KERNEL);
1240	if (ret < 0)
1241		return ret;
1242
1243	port->cons.vtermno = ret;
1244	port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
1245	if (IS_ERR(port->cons.hvc)) {
1246		ret = PTR_ERR(port->cons.hvc);
1247		dev_err(port->dev,
1248			"error %d allocating hvc for port\n", ret);
1249		port->cons.hvc = NULL;
1250		ida_free(&vtermno_ida, port->cons.vtermno);
1251		return ret;
1252	}
1253	spin_lock_irq(&pdrvdata_lock);
 
1254	list_add_tail(&port->cons.list, &pdrvdata.consoles);
1255	spin_unlock_irq(&pdrvdata_lock);
1256	port->guest_connected = true;
1257
1258	/*
1259	 * Start using the new console output if this is the first
1260	 * console to come up.
1261	 */
1262	if (early_put_chars)
1263		early_put_chars = NULL;
1264
1265	/* Notify host of port being opened */
1266	send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
1267
1268	return 0;
1269}
1270
1271static ssize_t show_port_name(struct device *dev,
1272			      struct device_attribute *attr, char *buffer)
1273{
1274	struct port *port;
1275
1276	port = dev_get_drvdata(dev);
1277
1278	return sprintf(buffer, "%s\n", port->name);
1279}
1280
1281static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
1282
1283static struct attribute *port_sysfs_entries[] = {
1284	&dev_attr_name.attr,
1285	NULL
1286};
1287
1288static const struct attribute_group port_attribute_group = {
1289	.name = NULL,		/* put in device directory */
1290	.attrs = port_sysfs_entries,
1291};
1292
1293static int port_debugfs_show(struct seq_file *s, void *data)
 
1294{
1295	struct port *port = s->private;
 
 
1296
1297	seq_printf(s, "name: %s\n", port->name ? port->name : "");
1298	seq_printf(s, "guest_connected: %d\n", port->guest_connected);
1299	seq_printf(s, "host_connected: %d\n", port->host_connected);
1300	seq_printf(s, "outvq_full: %d\n", port->outvq_full);
1301	seq_printf(s, "bytes_sent: %lu\n", port->stats.bytes_sent);
1302	seq_printf(s, "bytes_received: %lu\n", port->stats.bytes_received);
1303	seq_printf(s, "bytes_discarded: %lu\n", port->stats.bytes_discarded);
1304	seq_printf(s, "is_console: %s\n",
1305		   is_console_port(port) ? "yes" : "no");
1306	seq_printf(s, "console_vtermno: %u\n", port->cons.vtermno);
1307
1308	return 0;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1309}
1310
1311DEFINE_SHOW_ATTRIBUTE(port_debugfs);
 
 
 
 
1312
1313static void set_console_size(struct port *port, u16 rows, u16 cols)
1314{
1315	if (!port || !is_console_port(port))
1316		return;
1317
1318	port->cons.ws.ws_row = rows;
1319	port->cons.ws.ws_col = cols;
1320}
1321
1322static int fill_queue(struct virtqueue *vq, spinlock_t *lock)
1323{
1324	struct port_buffer *buf;
1325	int nr_added_bufs;
1326	int ret;
1327
1328	nr_added_bufs = 0;
1329	do {
1330		buf = alloc_buf(vq->vdev, PAGE_SIZE, 0);
1331		if (!buf)
1332			return -ENOMEM;
1333
1334		spin_lock_irq(lock);
1335		ret = add_inbuf(vq, buf);
1336		if (ret < 0) {
1337			spin_unlock_irq(lock);
1338			free_buf(buf, true);
1339			return ret;
1340		}
1341		nr_added_bufs++;
1342		spin_unlock_irq(lock);
1343	} while (ret > 0);
1344
1345	return nr_added_bufs;
1346}
1347
1348static void send_sigio_to_port(struct port *port)
1349{
1350	if (port->async_queue && port->guest_connected)
1351		kill_fasync(&port->async_queue, SIGIO, POLL_OUT);
1352}
1353
1354static int add_port(struct ports_device *portdev, u32 id)
1355{
1356	char debugfs_name[16];
1357	struct port *port;
 
1358	dev_t devt;
 
1359	int err;
1360
1361	port = kmalloc(sizeof(*port), GFP_KERNEL);
1362	if (!port) {
1363		err = -ENOMEM;
1364		goto fail;
1365	}
1366	kref_init(&port->kref);
1367
1368	port->portdev = portdev;
1369	port->id = id;
1370
1371	port->name = NULL;
1372	port->inbuf = NULL;
1373	port->cons.hvc = NULL;
1374	port->async_queue = NULL;
1375
1376	port->cons.ws.ws_row = port->cons.ws.ws_col = 0;
1377	port->cons.vtermno = 0;
1378
1379	port->host_connected = port->guest_connected = false;
1380	port->stats = (struct port_stats) { 0 };
1381
1382	port->outvq_full = false;
1383
1384	port->in_vq = portdev->in_vqs[port->id];
1385	port->out_vq = portdev->out_vqs[port->id];
1386
1387	port->cdev = cdev_alloc();
1388	if (!port->cdev) {
1389		dev_err(&port->portdev->vdev->dev, "Error allocating cdev\n");
1390		err = -ENOMEM;
1391		goto free_port;
1392	}
1393	port->cdev->ops = &port_fops;
1394
1395	devt = MKDEV(portdev->chr_major, id);
1396	err = cdev_add(port->cdev, devt, 1);
1397	if (err < 0) {
1398		dev_err(&port->portdev->vdev->dev,
1399			"Error %d adding cdev for port %u\n", err, id);
1400		goto free_cdev;
1401	}
1402	port->dev = device_create(pdrvdata.class, &port->portdev->vdev->dev,
1403				  devt, port, "vport%up%u",
1404				  port->portdev->vdev->index, id);
1405	if (IS_ERR(port->dev)) {
1406		err = PTR_ERR(port->dev);
1407		dev_err(&port->portdev->vdev->dev,
1408			"Error %d creating device for port %u\n",
1409			err, id);
1410		goto free_cdev;
1411	}
1412
1413	spin_lock_init(&port->inbuf_lock);
1414	spin_lock_init(&port->outvq_lock);
1415	init_waitqueue_head(&port->waitqueue);
1416
1417	/* We can safely ignore ENOSPC because it means
1418	 * the queue already has buffers. Buffers are removed
1419	 * only by virtcons_remove(), not by unplug_port()
1420	 */
1421	err = fill_queue(port->in_vq, &port->inbuf_lock);
1422	if (err < 0 && err != -ENOSPC) {
1423		dev_err(port->dev, "Error allocating inbufs\n");
 
1424		goto free_device;
1425	}
1426
1427	if (is_rproc_serial(port->portdev->vdev))
1428		/*
1429		 * For rproc_serial assume remote processor is connected.
1430		 * rproc_serial does not want the console port, only
1431		 * the generic port implementation.
1432		 */
1433		port->host_connected = true;
1434	else if (!use_multiport(port->portdev)) {
1435		/*
1436		 * If we're not using multiport support,
1437		 * this has to be a console port.
1438		 */
1439		err = init_port_console(port);
1440		if (err)
1441			goto free_inbufs;
1442	}
1443
1444	spin_lock_irq(&portdev->ports_lock);
1445	list_add_tail(&port->list, &port->portdev->ports);
1446	spin_unlock_irq(&portdev->ports_lock);
1447
1448	/*
1449	 * Tell the Host we're set so that it can send us various
1450	 * configuration parameters for this port (eg, port name,
1451	 * caching, whether this is a console port, etc.)
1452	 */
1453	send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1454
1455	/*
1456	 * Finally, create the debugfs file that we can use to
1457	 * inspect a port's state at any time
1458	 */
1459	snprintf(debugfs_name, sizeof(debugfs_name), "vport%up%u",
1460		 port->portdev->vdev->index, id);
1461	port->debugfs_file = debugfs_create_file(debugfs_name, 0444,
1462						 pdrvdata.debugfs_dir,
1463						 port, &port_debugfs_fops);
 
 
 
1464	return 0;
1465
1466free_inbufs:
 
 
1467free_device:
1468	device_destroy(pdrvdata.class, port->dev->devt);
1469free_cdev:
1470	cdev_del(port->cdev);
1471free_port:
1472	kfree(port);
1473fail:
1474	/* The host might want to notify management sw about port add failure */
1475	__send_control_msg(portdev, id, VIRTIO_CONSOLE_PORT_READY, 0);
1476	return err;
1477}
1478
1479/* No users remain, remove all port-specific data. */
1480static void remove_port(struct kref *kref)
1481{
1482	struct port *port;
1483
1484	port = container_of(kref, struct port, kref);
1485
 
 
 
 
 
 
 
 
1486	kfree(port);
1487}
1488
1489static void remove_port_data(struct port *port)
1490{
1491	spin_lock_irq(&port->inbuf_lock);
 
1492	/* Remove unused data this port might have received. */
1493	discard_port_data(port);
1494	spin_unlock_irq(&port->inbuf_lock);
1495
1496	spin_lock_irq(&port->outvq_lock);
1497	reclaim_consumed_buffers(port);
1498	spin_unlock_irq(&port->outvq_lock);
 
 
 
1499}
1500
1501/*
1502 * Port got unplugged.  Remove port from portdev's list and drop the
1503 * kref reference.  If no userspace has this port opened, it will
1504 * result in immediate removal the port.
1505 */
1506static void unplug_port(struct port *port)
1507{
1508	spin_lock_irq(&port->portdev->ports_lock);
1509	list_del(&port->list);
1510	spin_unlock_irq(&port->portdev->ports_lock);
1511
1512	spin_lock_irq(&port->inbuf_lock);
1513	if (port->guest_connected) {
1514		/* Let the app know the port is going down. */
1515		send_sigio_to_port(port);
1516
1517		/* Do this after sigio is actually sent */
1518		port->guest_connected = false;
1519		port->host_connected = false;
1520
1521		wake_up_interruptible(&port->waitqueue);
 
 
 
1522	}
1523	spin_unlock_irq(&port->inbuf_lock);
1524
1525	if (is_console_port(port)) {
1526		spin_lock_irq(&pdrvdata_lock);
1527		list_del(&port->cons.list);
1528		spin_unlock_irq(&pdrvdata_lock);
1529		hvc_remove(port->cons.hvc);
1530		ida_free(&vtermno_ida, port->cons.vtermno);
1531	}
1532
1533	remove_port_data(port);
1534
1535	/*
1536	 * We should just assume the device itself has gone off --
1537	 * else a close on an open port later will try to send out a
1538	 * control message.
1539	 */
1540	port->portdev = NULL;
1541
1542	sysfs_remove_group(&port->dev->kobj, &port_attribute_group);
1543	device_destroy(pdrvdata.class, port->dev->devt);
1544	cdev_del(port->cdev);
1545
1546	debugfs_remove(port->debugfs_file);
1547	kfree(port->name);
1548
1549	/*
1550	 * Locks around here are not necessary - a port can't be
1551	 * opened after we removed the port struct from ports_list
1552	 * above.
1553	 */
1554	kref_put(&port->kref, remove_port);
1555}
1556
1557/* Any private messages that the Host and Guest want to share */
1558static void handle_control_message(struct virtio_device *vdev,
1559				   struct ports_device *portdev,
1560				   struct port_buffer *buf)
1561{
1562	struct virtio_console_control *cpkt;
1563	struct port *port;
1564	size_t name_size;
1565	int err;
1566
1567	cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
1568
1569	port = find_port_by_id(portdev, virtio32_to_cpu(vdev, cpkt->id));
1570	if (!port &&
1571	    cpkt->event != cpu_to_virtio16(vdev, VIRTIO_CONSOLE_PORT_ADD)) {
1572		/* No valid header at start of buffer.  Drop it. */
1573		dev_dbg(&portdev->vdev->dev,
1574			"Invalid index %u in control packet\n", cpkt->id);
1575		return;
1576	}
1577
1578	switch (virtio16_to_cpu(vdev, cpkt->event)) {
1579	case VIRTIO_CONSOLE_PORT_ADD:
1580		if (port) {
1581			dev_dbg(&portdev->vdev->dev,
1582				"Port %u already added\n", port->id);
1583			send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1584			break;
1585		}
1586		if (virtio32_to_cpu(vdev, cpkt->id) >=
1587		    portdev->max_nr_ports) {
1588			dev_warn(&portdev->vdev->dev,
1589				"Request for adding port with "
1590				"out-of-bound id %u, max. supported id: %u\n",
1591				cpkt->id, portdev->max_nr_ports - 1);
1592			break;
1593		}
1594		add_port(portdev, virtio32_to_cpu(vdev, cpkt->id));
1595		break;
1596	case VIRTIO_CONSOLE_PORT_REMOVE:
1597		unplug_port(port);
1598		break;
1599	case VIRTIO_CONSOLE_CONSOLE_PORT:
1600		if (!cpkt->value)
1601			break;
1602		if (is_console_port(port))
1603			break;
1604
1605		init_port_console(port);
1606		complete(&early_console_added);
1607		/*
1608		 * Could remove the port here in case init fails - but
1609		 * have to notify the host first.
1610		 */
1611		break;
1612	case VIRTIO_CONSOLE_RESIZE: {
1613		struct {
1614			__u16 rows;
1615			__u16 cols;
1616		} size;
1617
1618		if (!is_console_port(port))
1619			break;
1620
1621		memcpy(&size, buf->buf + buf->offset + sizeof(*cpkt),
1622		       sizeof(size));
1623		set_console_size(port, size.rows, size.cols);
1624
1625		port->cons.hvc->irq_requested = 1;
1626		resize_console(port);
1627		break;
1628	}
1629	case VIRTIO_CONSOLE_PORT_OPEN:
1630		port->host_connected = virtio16_to_cpu(vdev, cpkt->value);
1631		wake_up_interruptible(&port->waitqueue);
1632		/*
1633		 * If the host port got closed and the host had any
1634		 * unconsumed buffers, we'll be able to reclaim them
1635		 * now.
1636		 */
1637		spin_lock_irq(&port->outvq_lock);
1638		reclaim_consumed_buffers(port);
1639		spin_unlock_irq(&port->outvq_lock);
1640
1641		/*
1642		 * If the guest is connected, it'll be interested in
1643		 * knowing the host connection state changed.
1644		 */
1645		spin_lock_irq(&port->inbuf_lock);
1646		send_sigio_to_port(port);
1647		spin_unlock_irq(&port->inbuf_lock);
1648		break;
1649	case VIRTIO_CONSOLE_PORT_NAME:
1650		/*
1651		 * If we woke up after hibernation, we can get this
1652		 * again.  Skip it in that case.
1653		 */
1654		if (port->name)
1655			break;
1656
1657		/*
1658		 * Skip the size of the header and the cpkt to get the size
1659		 * of the name that was sent
1660		 */
1661		name_size = buf->len - buf->offset - sizeof(*cpkt) + 1;
1662
1663		port->name = kmalloc(name_size, GFP_KERNEL);
1664		if (!port->name) {
1665			dev_err(port->dev,
1666				"Not enough space to store port name\n");
1667			break;
1668		}
1669		strncpy(port->name, buf->buf + buf->offset + sizeof(*cpkt),
1670			name_size - 1);
1671		port->name[name_size - 1] = 0;
1672
1673		/*
1674		 * Since we only have one sysfs attribute, 'name',
1675		 * create it only if we have a name for the port.
1676		 */
1677		err = sysfs_create_group(&port->dev->kobj,
1678					 &port_attribute_group);
1679		if (err) {
1680			dev_err(port->dev,
1681				"Error %d creating sysfs device attributes\n",
1682				err);
1683		} else {
1684			/*
1685			 * Generate a udev event so that appropriate
1686			 * symlinks can be created based on udev
1687			 * rules.
1688			 */
1689			kobject_uevent(&port->dev->kobj, KOBJ_CHANGE);
1690		}
1691		break;
1692	}
1693}
1694
1695static void control_work_handler(struct work_struct *work)
1696{
1697	struct ports_device *portdev;
1698	struct virtqueue *vq;
1699	struct port_buffer *buf;
1700	unsigned int len;
1701
1702	portdev = container_of(work, struct ports_device, control_work);
1703	vq = portdev->c_ivq;
1704
1705	spin_lock(&portdev->c_ivq_lock);
1706	while ((buf = virtqueue_get_buf(vq, &len))) {
1707		spin_unlock(&portdev->c_ivq_lock);
1708
1709		buf->len = min_t(size_t, len, buf->size);
1710		buf->offset = 0;
1711
1712		handle_control_message(vq->vdev, portdev, buf);
1713
1714		spin_lock(&portdev->c_ivq_lock);
1715		if (add_inbuf(portdev->c_ivq, buf) < 0) {
1716			dev_warn(&portdev->vdev->dev,
1717				 "Error adding buffer to queue\n");
1718			free_buf(buf, false);
1719		}
1720	}
1721	spin_unlock(&portdev->c_ivq_lock);
1722}
1723
1724static void flush_bufs(struct virtqueue *vq, bool can_sleep)
1725{
1726	struct port_buffer *buf;
1727	unsigned int len;
1728
1729	while ((buf = virtqueue_get_buf(vq, &len)))
1730		free_buf(buf, can_sleep);
1731}
1732
1733static void out_intr(struct virtqueue *vq)
1734{
1735	struct port *port;
1736
1737	port = find_port_by_vq(vq->vdev->priv, vq);
1738	if (!port) {
1739		flush_bufs(vq, false);
1740		return;
1741	}
1742
1743	wake_up_interruptible(&port->waitqueue);
1744}
1745
1746static void in_intr(struct virtqueue *vq)
1747{
1748	struct port *port;
1749	unsigned long flags;
1750
1751	port = find_port_by_vq(vq->vdev->priv, vq);
1752	if (!port) {
1753		flush_bufs(vq, false);
1754		return;
1755	}
1756
1757	spin_lock_irqsave(&port->inbuf_lock, flags);
1758	port->inbuf = get_inbuf(port);
1759
1760	/*
1761	 * Normally the port should not accept data when the port is
1762	 * closed. For generic serial ports, the host won't (shouldn't)
1763	 * send data till the guest is connected. But this condition
1764	 * can be reached when a console port is not yet connected (no
1765	 * tty is spawned) and the other side sends out data over the
1766	 * vring, or when a remote devices start sending data before
1767	 * the ports are opened.
1768	 *
1769	 * A generic serial port will discard data if not connected,
1770	 * while console ports and rproc-serial ports accepts data at
1771	 * any time. rproc-serial is initiated with guest_connected to
1772	 * false because port_fops_open expects this. Console ports are
1773	 * hooked up with an HVC console and is initialized with
1774	 * guest_connected to true.
1775	 */
1776
1777	if (!port->guest_connected && !is_rproc_serial(port->portdev->vdev))
1778		discard_port_data(port);
1779
1780	/* Send a SIGIO indicating new data in case the process asked for it */
1781	send_sigio_to_port(port);
1782
1783	spin_unlock_irqrestore(&port->inbuf_lock, flags);
1784
1785	wake_up_interruptible(&port->waitqueue);
1786
 
 
 
1787	if (is_console_port(port) && hvc_poll(port->cons.hvc))
1788		hvc_kick();
1789}
1790
1791static void control_intr(struct virtqueue *vq)
1792{
1793	struct ports_device *portdev;
1794
1795	portdev = vq->vdev->priv;
1796	schedule_work(&portdev->control_work);
1797}
1798
1799static void config_intr(struct virtio_device *vdev)
1800{
1801	struct ports_device *portdev;
1802
1803	portdev = vdev->priv;
1804
1805	if (!use_multiport(portdev))
1806		schedule_work(&portdev->config_work);
1807}
1808
1809static void config_work_handler(struct work_struct *work)
1810{
1811	struct ports_device *portdev;
1812
1813	portdev = container_of(work, struct ports_device, config_work);
1814	if (!use_multiport(portdev)) {
1815		struct virtio_device *vdev;
1816		struct port *port;
1817		u16 rows, cols;
1818
1819		vdev = portdev->vdev;
1820		virtio_cread(vdev, struct virtio_console_config, cols, &cols);
1821		virtio_cread(vdev, struct virtio_console_config, rows, &rows);
 
 
 
1822
1823		port = find_port_by_id(portdev, 0);
1824		set_console_size(port, rows, cols);
1825
1826		/*
1827		 * We'll use this way of resizing only for legacy
1828		 * support.  For newer userspace
1829		 * (VIRTIO_CONSOLE_F_MULTPORT+), use control messages
1830		 * to indicate console size changes so that it can be
1831		 * done per-port.
1832		 */
1833		resize_console(port);
1834	}
1835}
1836
1837static int init_vqs(struct ports_device *portdev)
1838{
1839	vq_callback_t **io_callbacks;
1840	char **io_names;
1841	struct virtqueue **vqs;
1842	u32 i, j, nr_ports, nr_queues;
1843	int err;
1844
1845	nr_ports = portdev->max_nr_ports;
1846	nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
1847
1848	vqs = kmalloc_array(nr_queues, sizeof(struct virtqueue *), GFP_KERNEL);
1849	io_callbacks = kmalloc_array(nr_queues, sizeof(vq_callback_t *),
1850				     GFP_KERNEL);
1851	io_names = kmalloc_array(nr_queues, sizeof(char *), GFP_KERNEL);
1852	portdev->in_vqs = kmalloc_array(nr_ports, sizeof(struct virtqueue *),
1853					GFP_KERNEL);
1854	portdev->out_vqs = kmalloc_array(nr_ports, sizeof(struct virtqueue *),
1855					 GFP_KERNEL);
1856	if (!vqs || !io_callbacks || !io_names || !portdev->in_vqs ||
1857	    !portdev->out_vqs) {
1858		err = -ENOMEM;
1859		goto free;
1860	}
1861
1862	/*
1863	 * For backward compat (newer host but older guest), the host
1864	 * spawns a console port first and also inits the vqs for port
1865	 * 0 before others.
1866	 */
1867	j = 0;
1868	io_callbacks[j] = in_intr;
1869	io_callbacks[j + 1] = out_intr;
1870	io_names[j] = "input";
1871	io_names[j + 1] = "output";
1872	j += 2;
1873
1874	if (use_multiport(portdev)) {
1875		io_callbacks[j] = control_intr;
1876		io_callbacks[j + 1] = NULL;
1877		io_names[j] = "control-i";
1878		io_names[j + 1] = "control-o";
1879
1880		for (i = 1; i < nr_ports; i++) {
1881			j += 2;
1882			io_callbacks[j] = in_intr;
1883			io_callbacks[j + 1] = out_intr;
1884			io_names[j] = "input";
1885			io_names[j + 1] = "output";
1886		}
1887	}
1888	/* Find the queues. */
1889	err = virtio_find_vqs(portdev->vdev, nr_queues, vqs,
1890			      io_callbacks,
1891			      (const char **)io_names, NULL);
1892	if (err)
1893		goto free;
1894
1895	j = 0;
1896	portdev->in_vqs[0] = vqs[0];
1897	portdev->out_vqs[0] = vqs[1];
1898	j += 2;
1899	if (use_multiport(portdev)) {
1900		portdev->c_ivq = vqs[j];
1901		portdev->c_ovq = vqs[j + 1];
1902
1903		for (i = 1; i < nr_ports; i++) {
1904			j += 2;
1905			portdev->in_vqs[i] = vqs[j];
1906			portdev->out_vqs[i] = vqs[j + 1];
1907		}
1908	}
1909	kfree(io_names);
1910	kfree(io_callbacks);
1911	kfree(vqs);
1912
1913	return 0;
1914
1915free:
1916	kfree(portdev->out_vqs);
1917	kfree(portdev->in_vqs);
1918	kfree(io_names);
1919	kfree(io_callbacks);
1920	kfree(vqs);
1921
1922	return err;
1923}
1924
1925static const struct file_operations portdev_fops = {
1926	.owner = THIS_MODULE,
1927};
1928
1929static void remove_vqs(struct ports_device *portdev)
1930{
1931	struct virtqueue *vq;
1932
1933	virtio_device_for_each_vq(portdev->vdev, vq) {
1934		struct port_buffer *buf;
1935
1936		flush_bufs(vq, true);
1937		while ((buf = virtqueue_detach_unused_buf(vq)))
1938			free_buf(buf, true);
1939	}
1940	portdev->vdev->config->del_vqs(portdev->vdev);
1941	kfree(portdev->in_vqs);
1942	kfree(portdev->out_vqs);
1943}
1944
1945static void virtcons_remove(struct virtio_device *vdev)
1946{
1947	struct ports_device *portdev;
1948	struct port *port, *port2;
1949
1950	portdev = vdev->priv;
1951
1952	spin_lock_irq(&pdrvdata_lock);
1953	list_del(&portdev->list);
1954	spin_unlock_irq(&pdrvdata_lock);
1955
1956	/* Device is going away, exit any polling for buffers */
1957	virtio_break_device(vdev);
1958	if (use_multiport(portdev))
1959		flush_work(&portdev->control_work);
1960	else
1961		flush_work(&portdev->config_work);
1962
1963	/* Disable interrupts for vqs */
1964	virtio_reset_device(vdev);
1965	/* Finish up work that's lined up */
1966	if (use_multiport(portdev))
1967		cancel_work_sync(&portdev->control_work);
1968	else
1969		cancel_work_sync(&portdev->config_work);
1970
1971	list_for_each_entry_safe(port, port2, &portdev->ports, list)
1972		unplug_port(port);
1973
1974	unregister_chrdev(portdev->chr_major, "virtio-portsdev");
 
1975
1976	/*
1977	 * When yanking out a device, we immediately lose the
1978	 * (device-side) queues.  So there's no point in keeping the
1979	 * guest side around till we drop our final reference.  This
1980	 * also means that any ports which are in an open state will
1981	 * have to just stop using the port, as the vqs are going
1982	 * away.
1983	 */
1984	remove_vqs(portdev);
1985	kfree(portdev);
1986}
1987
1988/*
1989 * Once we're further in boot, we get probed like any other virtio
1990 * device.
1991 *
1992 * If the host also supports multiple console ports, we check the
1993 * config space to see how many ports the host has spawned.  We
1994 * initialize each port found.
1995 */
1996static int virtcons_probe(struct virtio_device *vdev)
1997{
1998	struct ports_device *portdev;
1999	int err;
2000	bool multiport;
2001	bool early = early_put_chars != NULL;
2002
2003	/* We only need a config space if features are offered */
2004	if (!vdev->config->get &&
2005	    (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE)
2006	     || virtio_has_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT))) {
2007		dev_err(&vdev->dev, "%s failure: config access disabled\n",
2008			__func__);
2009		return -EINVAL;
2010	}
2011
2012	/* Ensure to read early_put_chars now */
2013	barrier();
2014
2015	portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
2016	if (!portdev) {
2017		err = -ENOMEM;
2018		goto fail;
2019	}
2020
2021	/* Attach this portdev to this virtio_device, and vice-versa. */
2022	portdev->vdev = vdev;
2023	vdev->priv = portdev;
2024
 
 
 
 
2025	portdev->chr_major = register_chrdev(0, "virtio-portsdev",
2026					     &portdev_fops);
2027	if (portdev->chr_major < 0) {
2028		dev_err(&vdev->dev,
2029			"Error %d registering chrdev for device %u\n",
2030			portdev->chr_major, vdev->index);
2031		err = portdev->chr_major;
2032		goto free;
2033	}
2034
2035	multiport = false;
2036	portdev->max_nr_ports = 1;
2037
2038	/* Don't test MULTIPORT at all if we're rproc: not a valid feature! */
2039	if (!is_rproc_serial(vdev) &&
2040	    virtio_cread_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT,
2041				 struct virtio_console_config, max_nr_ports,
2042				 &portdev->max_nr_ports) == 0) {
2043		if (portdev->max_nr_ports == 0 ||
2044		    portdev->max_nr_ports > VIRTCONS_MAX_PORTS) {
2045			dev_err(&vdev->dev,
2046				"Invalidate max_nr_ports %d",
2047				portdev->max_nr_ports);
2048			err = -EINVAL;
2049			goto free;
2050		}
2051		multiport = true;
2052	}
2053
2054	err = init_vqs(portdev);
2055	if (err < 0) {
2056		dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
2057		goto free_chrdev;
2058	}
2059
2060	spin_lock_init(&portdev->ports_lock);
2061	INIT_LIST_HEAD(&portdev->ports);
2062	INIT_LIST_HEAD(&portdev->list);
2063
2064	virtio_device_ready(portdev->vdev);
2065
2066	INIT_WORK(&portdev->config_work, &config_work_handler);
2067	INIT_WORK(&portdev->control_work, &control_work_handler);
2068
2069	if (multiport) {
2070		spin_lock_init(&portdev->c_ivq_lock);
2071		spin_lock_init(&portdev->c_ovq_lock);
 
 
2072
2073		err = fill_queue(portdev->c_ivq, &portdev->c_ivq_lock);
2074		if (err < 0) {
2075			dev_err(&vdev->dev,
2076				"Error allocating buffers for control queue\n");
2077			/*
2078			 * The host might want to notify mgmt sw about device
2079			 * add failure.
2080			 */
2081			__send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
2082					   VIRTIO_CONSOLE_DEVICE_READY, 0);
2083			/* Device was functional: we need full cleanup. */
2084			virtcons_remove(vdev);
2085			return err;
2086		}
2087	} else {
2088		/*
2089		 * For backward compatibility: Create a console port
2090		 * if we're running on older host.
2091		 */
2092		add_port(portdev, 0);
2093	}
2094
2095	spin_lock_irq(&pdrvdata_lock);
2096	list_add_tail(&portdev->list, &pdrvdata.portdevs);
2097	spin_unlock_irq(&pdrvdata_lock);
2098
2099	__send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
2100			   VIRTIO_CONSOLE_DEVICE_READY, 1);
2101
2102	/*
2103	 * If there was an early virtio console, assume that there are no
2104	 * other consoles. We need to wait until the hvc_alloc matches the
2105	 * hvc_instantiate, otherwise tty_open will complain, resulting in
2106	 * a "Warning: unable to open an initial console" boot failure.
2107	 * Without multiport this is done in add_port above. With multiport
2108	 * this might take some host<->guest communication - thus we have to
2109	 * wait.
2110	 */
2111	if (multiport && early)
2112		wait_for_completion(&early_console_added);
2113
2114	return 0;
2115
 
 
 
 
 
2116free_chrdev:
2117	unregister_chrdev(portdev->chr_major, "virtio-portsdev");
2118free:
2119	kfree(portdev);
2120fail:
2121	return err;
2122}
2123
2124static const struct virtio_device_id id_table[] = {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2125	{ VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
2126	{ 0 },
2127};
2128MODULE_DEVICE_TABLE(virtio, id_table);
2129
2130static const unsigned int features[] = {
2131	VIRTIO_CONSOLE_F_SIZE,
2132	VIRTIO_CONSOLE_F_MULTIPORT,
2133};
2134
2135static const struct virtio_device_id rproc_serial_id_table[] = {
2136#if IS_ENABLED(CONFIG_REMOTEPROC)
2137	{ VIRTIO_ID_RPROC_SERIAL, VIRTIO_DEV_ANY_ID },
2138#endif
2139	{ 0 },
2140};
2141MODULE_DEVICE_TABLE(virtio, rproc_serial_id_table);
2142
2143static const unsigned int rproc_serial_features[] = {
2144};
2145
2146#ifdef CONFIG_PM_SLEEP
2147static int virtcons_freeze(struct virtio_device *vdev)
2148{
2149	struct ports_device *portdev;
2150	struct port *port;
2151
2152	portdev = vdev->priv;
2153
2154	virtio_reset_device(vdev);
2155
2156	if (use_multiport(portdev))
2157		virtqueue_disable_cb(portdev->c_ivq);
2158	cancel_work_sync(&portdev->control_work);
2159	cancel_work_sync(&portdev->config_work);
2160	/*
2161	 * Once more: if control_work_handler() was running, it would
2162	 * enable the cb as the last step.
2163	 */
2164	if (use_multiport(portdev))
2165		virtqueue_disable_cb(portdev->c_ivq);
2166
2167	list_for_each_entry(port, &portdev->ports, list) {
2168		virtqueue_disable_cb(port->in_vq);
2169		virtqueue_disable_cb(port->out_vq);
2170		/*
2171		 * We'll ask the host later if the new invocation has
2172		 * the port opened or closed.
2173		 */
2174		port->host_connected = false;
2175		remove_port_data(port);
2176	}
2177	remove_vqs(portdev);
2178
2179	return 0;
2180}
2181
2182static int virtcons_restore(struct virtio_device *vdev)
2183{
2184	struct ports_device *portdev;
2185	struct port *port;
2186	int ret;
2187
2188	portdev = vdev->priv;
2189
2190	ret = init_vqs(portdev);
2191	if (ret)
2192		return ret;
2193
2194	virtio_device_ready(portdev->vdev);
2195
2196	if (use_multiport(portdev))
2197		fill_queue(portdev->c_ivq, &portdev->c_ivq_lock);
2198
2199	list_for_each_entry(port, &portdev->ports, list) {
2200		port->in_vq = portdev->in_vqs[port->id];
2201		port->out_vq = portdev->out_vqs[port->id];
2202
2203		fill_queue(port->in_vq, &port->inbuf_lock);
2204
2205		/* Get port open/close status on the host */
2206		send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
2207
2208		/*
2209		 * If a port was open at the time of suspending, we
2210		 * have to let the host know that it's still open.
2211		 */
2212		if (port->guest_connected)
2213			send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
2214	}
2215	return 0;
2216}
2217#endif
2218
2219static struct virtio_driver virtio_console = {
2220	.feature_table = features,
2221	.feature_table_size = ARRAY_SIZE(features),
2222	.driver.name =	KBUILD_MODNAME,
2223	.driver.owner =	THIS_MODULE,
2224	.id_table =	id_table,
2225	.probe =	virtcons_probe,
2226	.remove =	virtcons_remove,
2227	.config_changed = config_intr,
2228#ifdef CONFIG_PM_SLEEP
2229	.freeze =	virtcons_freeze,
2230	.restore =	virtcons_restore,
2231#endif
2232};
2233
2234static struct virtio_driver virtio_rproc_serial = {
2235	.feature_table = rproc_serial_features,
2236	.feature_table_size = ARRAY_SIZE(rproc_serial_features),
2237	.driver.name =	"virtio_rproc_serial",
2238	.driver.owner =	THIS_MODULE,
2239	.id_table =	rproc_serial_id_table,
2240	.probe =	virtcons_probe,
2241	.remove =	virtcons_remove,
2242};
2243
2244static int __init virtio_console_init(void)
2245{
2246	int err;
2247
2248	pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
2249	if (IS_ERR(pdrvdata.class)) {
2250		err = PTR_ERR(pdrvdata.class);
2251		pr_err("Error %d creating virtio-ports class\n", err);
2252		return err;
2253	}
2254
2255	pdrvdata.debugfs_dir = debugfs_create_dir("virtio-ports", NULL);
 
 
 
 
2256	INIT_LIST_HEAD(&pdrvdata.consoles);
2257	INIT_LIST_HEAD(&pdrvdata.portdevs);
2258
2259	err = register_virtio_driver(&virtio_console);
2260	if (err < 0) {
2261		pr_err("Error %d registering virtio driver\n", err);
2262		goto free;
2263	}
2264	err = register_virtio_driver(&virtio_rproc_serial);
2265	if (err < 0) {
2266		pr_err("Error %d registering virtio rproc serial driver\n",
2267		       err);
2268		goto unregister;
2269	}
2270	return 0;
2271unregister:
2272	unregister_virtio_driver(&virtio_console);
2273free:
2274	debugfs_remove_recursive(pdrvdata.debugfs_dir);
2275	class_destroy(pdrvdata.class);
2276	return err;
2277}
2278
2279static void __exit virtio_console_fini(void)
2280{
2281	reclaim_dma_bufs();
2282
2283	unregister_virtio_driver(&virtio_console);
2284	unregister_virtio_driver(&virtio_rproc_serial);
2285
2286	class_destroy(pdrvdata.class);
2287	debugfs_remove_recursive(pdrvdata.debugfs_dir);
 
2288}
2289module_init(virtio_console_init);
2290module_exit(virtio_console_fini);
2291
 
2292MODULE_DESCRIPTION("Virtio console driver");
2293MODULE_LICENSE("GPL");
v3.5.6
 
   1/*
   2 * Copyright (C) 2006, 2007, 2009 Rusty Russell, IBM Corporation
   3 * Copyright (C) 2009, 2010, 2011 Red Hat, Inc.
   4 * Copyright (C) 2009, 2010, 2011 Amit Shah <amit.shah@redhat.com>
   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#include <linux/cdev.h>
  21#include <linux/debugfs.h>
  22#include <linux/completion.h>
  23#include <linux/device.h>
  24#include <linux/err.h>
  25#include <linux/freezer.h>
  26#include <linux/fs.h>
 
 
 
  27#include <linux/init.h>
  28#include <linux/list.h>
  29#include <linux/poll.h>
  30#include <linux/sched.h>
  31#include <linux/slab.h>
  32#include <linux/spinlock.h>
  33#include <linux/virtio.h>
  34#include <linux/virtio_console.h>
  35#include <linux/wait.h>
  36#include <linux/workqueue.h>
  37#include <linux/module.h>
 
  38#include "../tty/hvc/hvc_console.h"
  39
 
 
 
  40/*
  41 * This is a global struct for storing common data for all the devices
  42 * this driver handles.
  43 *
  44 * Mainly, it has a linked list for all the consoles in one place so
  45 * that callbacks from hvc for get_chars(), put_chars() work properly
  46 * across multiple devices and multiple ports per device.
  47 */
  48struct ports_driver_data {
  49	/* Used for registering chardevs */
  50	struct class *class;
  51
  52	/* Used for exporting per-port information to debugfs */
  53	struct dentry *debugfs_dir;
  54
  55	/* List of all the devices we're handling */
  56	struct list_head portdevs;
  57
  58	/* Number of devices this driver is handling */
  59	unsigned int index;
  60
  61	/*
  62	 * This is used to keep track of the number of hvc consoles
  63	 * spawned by this driver.  This number is given as the first
  64	 * argument to hvc_alloc().  To correctly map an initial
  65	 * console spawned via hvc_instantiate to the console being
  66	 * hooked up via hvc_alloc, we need to pass the same vtermno.
  67	 *
  68	 * We also just assume the first console being initialised was
  69	 * the first one that got used as the initial console.
  70	 */
  71	unsigned int next_vtermno;
  72
  73	/* All the console devices handled by this driver */
  74	struct list_head consoles;
  75};
 
  76static struct ports_driver_data pdrvdata;
  77
  78DEFINE_SPINLOCK(pdrvdata_lock);
  79DECLARE_COMPLETION(early_console_added);
  80
  81/* This struct holds information that's relevant only for console ports */
  82struct console {
  83	/* We'll place all consoles in a list in the pdrvdata struct */
  84	struct list_head list;
  85
  86	/* The hvc device associated with this console port */
  87	struct hvc_struct *hvc;
  88
  89	/* The size of the console */
  90	struct winsize ws;
  91
  92	/*
  93	 * This number identifies the number that we used to register
  94	 * with hvc in hvc_instantiate() and hvc_alloc(); this is the
  95	 * number passed on by the hvc callbacks to us to
  96	 * differentiate between the other console ports handled by
  97	 * this driver
  98	 */
  99	u32 vtermno;
 100};
 101
 
 
 102struct port_buffer {
 103	char *buf;
 104
 105	/* size of the buffer in *buf above */
 106	size_t size;
 107
 108	/* used length of the buffer */
 109	size_t len;
 110	/* offset in the buf from which to consume data */
 111	size_t offset;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 112};
 113
 114/*
 115 * This is a per-device struct that stores data common to all the
 116 * ports for that device (vdev->priv).
 117 */
 118struct ports_device {
 119	/* Next portdev in the list, head is in the pdrvdata struct */
 120	struct list_head list;
 121
 122	/*
 123	 * Workqueue handlers where we process deferred work after
 124	 * notification
 125	 */
 126	struct work_struct control_work;
 
 127
 128	struct list_head ports;
 129
 130	/* To protect the list of ports */
 131	spinlock_t ports_lock;
 132
 133	/* To protect the vq operations for the control channel */
 134	spinlock_t cvq_lock;
 
 135
 136	/* The current config space is stored here */
 137	struct virtio_console_config config;
 138
 139	/* The virtio device we're associated with */
 140	struct virtio_device *vdev;
 141
 142	/*
 143	 * A couple of virtqueues for the control channel: one for
 144	 * guest->host transfers, one for host->guest transfers
 145	 */
 146	struct virtqueue *c_ivq, *c_ovq;
 147
 
 
 
 
 
 
 148	/* Array of per-port IO virtqueues */
 149	struct virtqueue **in_vqs, **out_vqs;
 150
 151	/* Used for numbering devices for sysfs and debugfs */
 152	unsigned int drv_index;
 153
 154	/* Major number for this device.  Ports will be created as minors. */
 155	int chr_major;
 156};
 157
 158struct port_stats {
 159	unsigned long bytes_sent, bytes_received, bytes_discarded;
 160};
 161
 162/* This struct holds the per-port data */
 163struct port {
 164	/* Next port in the list, head is in the ports_device */
 165	struct list_head list;
 166
 167	/* Pointer to the parent virtio_console device */
 168	struct ports_device *portdev;
 169
 170	/* The current buffer from which data has to be fed to readers */
 171	struct port_buffer *inbuf;
 172
 173	/*
 174	 * To protect the operations on the in_vq associated with this
 175	 * port.  Has to be a spinlock because it can be called from
 176	 * interrupt context (get_char()).
 177	 */
 178	spinlock_t inbuf_lock;
 179
 180	/* Protect the operations on the out_vq. */
 181	spinlock_t outvq_lock;
 182
 183	/* The IO vqs for this port */
 184	struct virtqueue *in_vq, *out_vq;
 185
 186	/* File in the debugfs directory that exposes this port's information */
 187	struct dentry *debugfs_file;
 188
 189	/*
 190	 * Keep count of the bytes sent, received and discarded for
 191	 * this port for accounting and debugging purposes.  These
 192	 * counts are not reset across port open / close events.
 193	 */
 194	struct port_stats stats;
 195
 196	/*
 197	 * The entries in this struct will be valid if this port is
 198	 * hooked up to an hvc console
 199	 */
 200	struct console cons;
 201
 202	/* Each port associates with a separate char device */
 203	struct cdev *cdev;
 204	struct device *dev;
 205
 206	/* Reference-counting to handle port hot-unplugs and file operations */
 207	struct kref kref;
 208
 209	/* A waitqueue for poll() or blocking read operations */
 210	wait_queue_head_t waitqueue;
 211
 212	/* The 'name' of the port that we expose via sysfs properties */
 213	char *name;
 214
 215	/* We can notify apps of host connect / disconnect events via SIGIO */
 216	struct fasync_struct *async_queue;
 217
 218	/* The 'id' to identify the port with the Host */
 219	u32 id;
 220
 221	bool outvq_full;
 222
 223	/* Is the host device open */
 224	bool host_connected;
 225
 226	/* We should allow only one process to open a port */
 227	bool guest_connected;
 228};
 229
 230/* This is the very early arch-specified put chars function. */
 231static int (*early_put_chars)(u32, const char *, int);
 232
 233static struct port *find_port_by_vtermno(u32 vtermno)
 234{
 235	struct port *port;
 236	struct console *cons;
 237	unsigned long flags;
 238
 239	spin_lock_irqsave(&pdrvdata_lock, flags);
 240	list_for_each_entry(cons, &pdrvdata.consoles, list) {
 241		if (cons->vtermno == vtermno) {
 242			port = container_of(cons, struct port, cons);
 243			goto out;
 244		}
 245	}
 246	port = NULL;
 247out:
 248	spin_unlock_irqrestore(&pdrvdata_lock, flags);
 249	return port;
 250}
 251
 252static struct port *find_port_by_devt_in_portdev(struct ports_device *portdev,
 253						 dev_t dev)
 254{
 255	struct port *port;
 256	unsigned long flags;
 257
 258	spin_lock_irqsave(&portdev->ports_lock, flags);
 259	list_for_each_entry(port, &portdev->ports, list)
 260		if (port->cdev->dev == dev)
 
 261			goto out;
 
 
 262	port = NULL;
 263out:
 264	spin_unlock_irqrestore(&portdev->ports_lock, flags);
 265
 266	return port;
 267}
 268
 269static struct port *find_port_by_devt(dev_t dev)
 270{
 271	struct ports_device *portdev;
 272	struct port *port;
 273	unsigned long flags;
 274
 275	spin_lock_irqsave(&pdrvdata_lock, flags);
 276	list_for_each_entry(portdev, &pdrvdata.portdevs, list) {
 277		port = find_port_by_devt_in_portdev(portdev, dev);
 278		if (port)
 279			goto out;
 280	}
 281	port = NULL;
 282out:
 283	spin_unlock_irqrestore(&pdrvdata_lock, flags);
 284	return port;
 285}
 286
 287static struct port *find_port_by_id(struct ports_device *portdev, u32 id)
 288{
 289	struct port *port;
 290	unsigned long flags;
 291
 292	spin_lock_irqsave(&portdev->ports_lock, flags);
 293	list_for_each_entry(port, &portdev->ports, list)
 294		if (port->id == id)
 295			goto out;
 296	port = NULL;
 297out:
 298	spin_unlock_irqrestore(&portdev->ports_lock, flags);
 299
 300	return port;
 301}
 302
 303static struct port *find_port_by_vq(struct ports_device *portdev,
 304				    struct virtqueue *vq)
 305{
 306	struct port *port;
 307	unsigned long flags;
 308
 309	spin_lock_irqsave(&portdev->ports_lock, flags);
 310	list_for_each_entry(port, &portdev->ports, list)
 311		if (port->in_vq == vq || port->out_vq == vq)
 312			goto out;
 313	port = NULL;
 314out:
 315	spin_unlock_irqrestore(&portdev->ports_lock, flags);
 316	return port;
 317}
 318
 319static bool is_console_port(struct port *port)
 320{
 321	if (port->cons.hvc)
 322		return true;
 323	return false;
 324}
 325
 
 
 
 
 
 326static inline bool use_multiport(struct ports_device *portdev)
 327{
 328	/*
 329	 * This condition can be true when put_chars is called from
 330	 * early_init
 331	 */
 332	if (!portdev->vdev)
 333		return 0;
 334	return portdev->vdev->features[0] & (1 << VIRTIO_CONSOLE_F_MULTIPORT);
 335}
 336
 337static void free_buf(struct port_buffer *buf)
 
 
 
 338{
 339	kfree(buf->buf);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 340	kfree(buf);
 341}
 342
 343static struct port_buffer *alloc_buf(size_t buf_size)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 344{
 345	struct port_buffer *buf;
 346
 347	buf = kmalloc(sizeof(*buf), GFP_KERNEL);
 
 
 
 
 
 
 348	if (!buf)
 349		goto fail;
 350	buf->buf = kzalloc(buf_size, GFP_KERNEL);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 351	if (!buf->buf)
 352		goto free_buf;
 353	buf->len = 0;
 354	buf->offset = 0;
 355	buf->size = buf_size;
 356	return buf;
 357
 358free_buf:
 359	kfree(buf);
 360fail:
 361	return NULL;
 362}
 363
 364/* Callers should take appropriate locks */
 365static struct port_buffer *get_inbuf(struct port *port)
 366{
 367	struct port_buffer *buf;
 368	unsigned int len;
 369
 370	if (port->inbuf)
 371		return port->inbuf;
 372
 373	buf = virtqueue_get_buf(port->in_vq, &len);
 374	if (buf) {
 375		buf->len = len;
 376		buf->offset = 0;
 377		port->stats.bytes_received += len;
 378	}
 379	return buf;
 380}
 381
 382/*
 383 * Create a scatter-gather list representing our input buffer and put
 384 * it in the queue.
 385 *
 386 * Callers should take appropriate locks.
 387 */
 388static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
 389{
 390	struct scatterlist sg[1];
 391	int ret;
 392
 393	sg_init_one(sg, buf->buf, buf->size);
 394
 395	ret = virtqueue_add_buf(vq, sg, 0, 1, buf, GFP_ATOMIC);
 396	virtqueue_kick(vq);
 
 
 397	return ret;
 398}
 399
 400/* Discard any unread data this port has. Callers lockers. */
 401static void discard_port_data(struct port *port)
 402{
 403	struct port_buffer *buf;
 404	unsigned int err;
 405
 406	if (!port->portdev) {
 407		/* Device has been unplugged.  vqs are already gone. */
 408		return;
 409	}
 410	buf = get_inbuf(port);
 411
 412	err = 0;
 413	while (buf) {
 414		port->stats.bytes_discarded += buf->len - buf->offset;
 415		if (add_inbuf(port->in_vq, buf) < 0) {
 416			err++;
 417			free_buf(buf);
 418		}
 419		port->inbuf = NULL;
 420		buf = get_inbuf(port);
 421	}
 422	if (err)
 423		dev_warn(port->dev, "Errors adding %d buffers back to vq\n",
 424			 err);
 425}
 426
 427static bool port_has_data(struct port *port)
 428{
 429	unsigned long flags;
 430	bool ret;
 431
 432	ret = false;
 433	spin_lock_irqsave(&port->inbuf_lock, flags);
 434	port->inbuf = get_inbuf(port);
 435	if (port->inbuf)
 436		ret = true;
 437
 438	spin_unlock_irqrestore(&port->inbuf_lock, flags);
 439	return ret;
 440}
 441
 442static ssize_t __send_control_msg(struct ports_device *portdev, u32 port_id,
 443				  unsigned int event, unsigned int value)
 444{
 445	struct scatterlist sg[1];
 446	struct virtio_console_control cpkt;
 447	struct virtqueue *vq;
 448	unsigned int len;
 449
 450	if (!use_multiport(portdev))
 451		return 0;
 452
 453	cpkt.id = port_id;
 454	cpkt.event = event;
 455	cpkt.value = value;
 456
 457	vq = portdev->c_ovq;
 
 
 
 
 
 
 458
 459	sg_init_one(sg, &cpkt, sizeof(cpkt));
 460	if (virtqueue_add_buf(vq, sg, 1, 0, &cpkt, GFP_ATOMIC) >= 0) {
 461		virtqueue_kick(vq);
 462		while (!virtqueue_get_buf(vq, &len))
 
 463			cpu_relax();
 464	}
 
 
 465	return 0;
 466}
 467
 468static ssize_t send_control_msg(struct port *port, unsigned int event,
 469				unsigned int value)
 470{
 471	/* Did the port get unplugged before userspace closed it? */
 472	if (port->portdev)
 473		return __send_control_msg(port->portdev, port->id, event, value);
 474	return 0;
 475}
 476
 
 477/* Callers must take the port->outvq_lock */
 478static void reclaim_consumed_buffers(struct port *port)
 479{
 480	void *buf;
 481	unsigned int len;
 482
 483	if (!port->portdev) {
 484		/* Device has been unplugged.  vqs are already gone. */
 485		return;
 486	}
 487	while ((buf = virtqueue_get_buf(port->out_vq, &len))) {
 488		kfree(buf);
 489		port->outvq_full = false;
 490	}
 491}
 492
 493static ssize_t send_buf(struct port *port, void *in_buf, size_t in_count,
 494			bool nonblock)
 
 495{
 496	struct scatterlist sg[1];
 497	struct virtqueue *out_vq;
 498	ssize_t ret;
 499	unsigned long flags;
 500	unsigned int len;
 501
 502	out_vq = port->out_vq;
 503
 504	spin_lock_irqsave(&port->outvq_lock, flags);
 505
 506	reclaim_consumed_buffers(port);
 507
 508	sg_init_one(sg, in_buf, in_count);
 509	ret = virtqueue_add_buf(out_vq, sg, 1, 0, in_buf, GFP_ATOMIC);
 510
 511	/* Tell Host to go! */
 512	virtqueue_kick(out_vq);
 513
 514	if (ret < 0) {
 515		in_count = 0;
 516		goto done;
 517	}
 518
 519	if (ret == 0)
 520		port->outvq_full = true;
 521
 522	if (nonblock)
 523		goto done;
 524
 525	/*
 526	 * Wait till the host acknowledges it pushed out the data we
 527	 * sent.  This is done for data from the hvc_console; the tty
 528	 * operations are performed with spinlocks held so we can't
 529	 * sleep here.  An alternative would be to copy the data to a
 530	 * buffer and relax the spinning requirement.  The downside is
 531	 * we need to kmalloc a GFP_ATOMIC buffer each time the
 532	 * console driver writes something out.
 533	 */
 534	while (!virtqueue_get_buf(out_vq, &len))
 
 535		cpu_relax();
 536done:
 537	spin_unlock_irqrestore(&port->outvq_lock, flags);
 538
 539	port->stats.bytes_sent += in_count;
 540	/*
 541	 * We're expected to return the amount of data we wrote -- all
 542	 * of it
 543	 */
 544	return in_count;
 545}
 546
 547/*
 548 * Give out the data that's requested from the buffer that we have
 549 * queued up.
 550 */
 551static ssize_t fill_readbuf(struct port *port, char *out_buf, size_t out_count,
 552			    bool to_user)
 553{
 554	struct port_buffer *buf;
 555	unsigned long flags;
 556
 557	if (!out_count || !port_has_data(port))
 558		return 0;
 559
 560	buf = port->inbuf;
 561	out_count = min(out_count, buf->len - buf->offset);
 562
 563	if (to_user) {
 564		ssize_t ret;
 565
 566		ret = copy_to_user(out_buf, buf->buf + buf->offset, out_count);
 567		if (ret)
 568			return -EFAULT;
 569	} else {
 570		memcpy(out_buf, buf->buf + buf->offset, out_count);
 
 571	}
 572
 573	buf->offset += out_count;
 574
 575	if (buf->offset == buf->len) {
 576		/*
 577		 * We're done using all the data in this buffer.
 578		 * Re-queue so that the Host can send us more data.
 579		 */
 580		spin_lock_irqsave(&port->inbuf_lock, flags);
 581		port->inbuf = NULL;
 582
 583		if (add_inbuf(port->in_vq, buf) < 0)
 584			dev_warn(port->dev, "failed add_buf\n");
 585
 586		spin_unlock_irqrestore(&port->inbuf_lock, flags);
 587	}
 588	/* Return the number of bytes actually copied */
 589	return out_count;
 590}
 591
 592/* The condition that must be true for polling to end */
 593static bool will_read_block(struct port *port)
 594{
 595	if (!port->guest_connected) {
 596		/* Port got hot-unplugged. Let's exit. */
 597		return false;
 598	}
 599	return !port_has_data(port) && port->host_connected;
 600}
 601
 602static bool will_write_block(struct port *port)
 603{
 604	bool ret;
 605
 606	if (!port->guest_connected) {
 607		/* Port got hot-unplugged. Let's exit. */
 608		return false;
 609	}
 610	if (!port->host_connected)
 611		return true;
 612
 613	spin_lock_irq(&port->outvq_lock);
 614	/*
 615	 * Check if the Host has consumed any buffers since we last
 616	 * sent data (this is only applicable for nonblocking ports).
 617	 */
 618	reclaim_consumed_buffers(port);
 619	ret = port->outvq_full;
 620	spin_unlock_irq(&port->outvq_lock);
 621
 622	return ret;
 623}
 624
 625static ssize_t port_fops_read(struct file *filp, char __user *ubuf,
 626			      size_t count, loff_t *offp)
 627{
 628	struct port *port;
 629	ssize_t ret;
 630
 631	port = filp->private_data;
 632
 
 
 
 
 633	if (!port_has_data(port)) {
 634		/*
 635		 * If nothing's connected on the host just return 0 in
 636		 * case of list_empty; this tells the userspace app
 637		 * that there's no connection
 638		 */
 639		if (!port->host_connected)
 640			return 0;
 641		if (filp->f_flags & O_NONBLOCK)
 642			return -EAGAIN;
 643
 644		ret = wait_event_freezable(port->waitqueue,
 645					   !will_read_block(port));
 646		if (ret < 0)
 647			return ret;
 648	}
 649	/* Port got hot-unplugged. */
 650	if (!port->guest_connected)
 651		return -ENODEV;
 652	/*
 653	 * We could've received a disconnection message while we were
 654	 * waiting for more data.
 655	 *
 656	 * This check is not clubbed in the if() statement above as we
 657	 * might receive some data as well as the host could get
 658	 * disconnected after we got woken up from our wait.  So we
 659	 * really want to give off whatever data we have and only then
 660	 * check for host_connected.
 661	 */
 662	if (!port_has_data(port) && !port->host_connected)
 663		return 0;
 664
 665	return fill_readbuf(port, ubuf, count, true);
 666}
 667
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 668static ssize_t port_fops_write(struct file *filp, const char __user *ubuf,
 669			       size_t count, loff_t *offp)
 670{
 671	struct port *port;
 672	char *buf;
 673	ssize_t ret;
 674	bool nonblock;
 
 675
 676	/* Userspace could be out to fool us */
 677	if (!count)
 678		return 0;
 679
 680	port = filp->private_data;
 681
 682	nonblock = filp->f_flags & O_NONBLOCK;
 683
 684	if (will_write_block(port)) {
 685		if (nonblock)
 686			return -EAGAIN;
 687
 688		ret = wait_event_freezable(port->waitqueue,
 689					   !will_write_block(port));
 690		if (ret < 0)
 691			return ret;
 692	}
 693	/* Port got hot-unplugged. */
 694	if (!port->guest_connected)
 695		return -ENODEV;
 696
 697	count = min((size_t)(32 * 1024), count);
 698
 699	buf = kmalloc(count, GFP_KERNEL);
 700	if (!buf)
 701		return -ENOMEM;
 702
 703	ret = copy_from_user(buf, ubuf, count);
 704	if (ret) {
 705		ret = -EFAULT;
 706		goto free_buf;
 707	}
 708
 709	/*
 710	 * We now ask send_buf() to not spin for generic ports -- we
 711	 * can re-use the same code path that non-blocking file
 712	 * descriptors take for blocking file descriptors since the
 713	 * wait is already done and we're certain the write will go
 714	 * through to the host.
 715	 */
 716	nonblock = true;
 717	ret = send_buf(port, buf, count, nonblock);
 
 718
 719	if (nonblock && ret > 0)
 720		goto out;
 721
 722free_buf:
 723	kfree(buf);
 724out:
 725	return ret;
 726}
 727
 728static unsigned int port_fops_poll(struct file *filp, poll_table *wait)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 729{
 730	struct port *port;
 731	unsigned int ret;
 732
 733	port = filp->private_data;
 734	poll_wait(filp, &port->waitqueue, wait);
 735
 736	if (!port->guest_connected) {
 737		/* Port got unplugged */
 738		return POLLHUP;
 739	}
 740	ret = 0;
 741	if (!will_read_block(port))
 742		ret |= POLLIN | POLLRDNORM;
 743	if (!will_write_block(port))
 744		ret |= POLLOUT;
 745	if (!port->host_connected)
 746		ret |= POLLHUP;
 747
 748	return ret;
 749}
 750
 751static void remove_port(struct kref *kref);
 752
 753static int port_fops_release(struct inode *inode, struct file *filp)
 754{
 755	struct port *port;
 756
 757	port = filp->private_data;
 758
 759	/* Notify host of port being closed */
 760	send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
 761
 762	spin_lock_irq(&port->inbuf_lock);
 763	port->guest_connected = false;
 764
 765	discard_port_data(port);
 766
 767	spin_unlock_irq(&port->inbuf_lock);
 768
 769	spin_lock_irq(&port->outvq_lock);
 770	reclaim_consumed_buffers(port);
 771	spin_unlock_irq(&port->outvq_lock);
 772
 
 773	/*
 774	 * Locks aren't necessary here as a port can't be opened after
 775	 * unplug, and if a port isn't unplugged, a kref would already
 776	 * exist for the port.  Plus, taking ports_lock here would
 777	 * create a dependency on other locks taken by functions
 778	 * inside remove_port if we're the last holder of the port,
 779	 * creating many problems.
 780	 */
 781	kref_put(&port->kref, remove_port);
 782
 783	return 0;
 784}
 785
 786static int port_fops_open(struct inode *inode, struct file *filp)
 787{
 788	struct cdev *cdev = inode->i_cdev;
 789	struct port *port;
 790	int ret;
 791
 
 792	port = find_port_by_devt(cdev->dev);
 
 
 
 
 793	filp->private_data = port;
 794
 795	/* Prevent against a port getting hot-unplugged at the same time */
 796	spin_lock_irq(&port->portdev->ports_lock);
 797	kref_get(&port->kref);
 798	spin_unlock_irq(&port->portdev->ports_lock);
 799
 800	/*
 801	 * Don't allow opening of console port devices -- that's done
 802	 * via /dev/hvc
 803	 */
 804	if (is_console_port(port)) {
 805		ret = -ENXIO;
 806		goto out;
 807	}
 808
 809	/* Allow only one process to open a particular port at a time */
 810	spin_lock_irq(&port->inbuf_lock);
 811	if (port->guest_connected) {
 812		spin_unlock_irq(&port->inbuf_lock);
 813		ret = -EMFILE;
 814		goto out;
 815	}
 816
 817	port->guest_connected = true;
 818	spin_unlock_irq(&port->inbuf_lock);
 819
 820	spin_lock_irq(&port->outvq_lock);
 821	/*
 822	 * There might be a chance that we missed reclaiming a few
 823	 * buffers in the window of the port getting previously closed
 824	 * and opening now.
 825	 */
 826	reclaim_consumed_buffers(port);
 827	spin_unlock_irq(&port->outvq_lock);
 828
 829	nonseekable_open(inode, filp);
 830
 831	/* Notify host of port being opened */
 832	send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
 833
 834	return 0;
 835out:
 836	kref_put(&port->kref, remove_port);
 837	return ret;
 838}
 839
 840static int port_fops_fasync(int fd, struct file *filp, int mode)
 841{
 842	struct port *port;
 843
 844	port = filp->private_data;
 845	return fasync_helper(fd, filp, mode, &port->async_queue);
 846}
 847
 848/*
 849 * The file operations that we support: programs in the guest can open
 850 * a console device, read from it, write to it, poll for data and
 851 * close it.  The devices are at
 852 *   /dev/vport<device number>p<port number>
 853 */
 854static const struct file_operations port_fops = {
 855	.owner = THIS_MODULE,
 856	.open  = port_fops_open,
 857	.read  = port_fops_read,
 858	.write = port_fops_write,
 
 859	.poll  = port_fops_poll,
 860	.release = port_fops_release,
 861	.fasync = port_fops_fasync,
 862	.llseek = no_llseek,
 863};
 864
 865/*
 866 * The put_chars() callback is pretty straightforward.
 867 *
 868 * We turn the characters into a scatter-gather list, add it to the
 869 * output queue and then kick the Host.  Then we sit here waiting for
 870 * it to finish: inefficient in theory, but in practice
 871 * implementations will do it immediately (lguest's Launcher does).
 872 */
 873static int put_chars(u32 vtermno, const char *buf, int count)
 874{
 875	struct port *port;
 
 
 
 876
 877	if (unlikely(early_put_chars))
 878		return early_put_chars(vtermno, buf, count);
 879
 880	port = find_port_by_vtermno(vtermno);
 881	if (!port)
 882		return -EPIPE;
 883
 884	return send_buf(port, (void *)buf, count, false);
 
 
 
 
 
 
 
 885}
 886
 887/*
 888 * get_chars() is the callback from the hvc_console infrastructure
 889 * when an interrupt is received.
 890 *
 891 * We call out to fill_readbuf that gets us the required data from the
 892 * buffers that are queued up.
 893 */
 894static int get_chars(u32 vtermno, char *buf, int count)
 895{
 896	struct port *port;
 897
 898	/* If we've not set up the port yet, we have no input to give. */
 899	if (unlikely(early_put_chars))
 900		return 0;
 901
 902	port = find_port_by_vtermno(vtermno);
 903	if (!port)
 904		return -EPIPE;
 905
 906	/* If we don't have an input queue yet, we can't get input. */
 907	BUG_ON(!port->in_vq);
 908
 909	return fill_readbuf(port, buf, count, false);
 910}
 911
 912static void resize_console(struct port *port)
 913{
 914	struct virtio_device *vdev;
 915
 916	/* The port could have been hot-unplugged */
 917	if (!port || !is_console_port(port))
 918		return;
 919
 920	vdev = port->portdev->vdev;
 921	if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE))
 
 
 
 922		hvc_resize(port->cons.hvc, port->cons.ws);
 923}
 924
 925/* We set the configuration at this point, since we now have a tty */
 926static int notifier_add_vio(struct hvc_struct *hp, int data)
 927{
 928	struct port *port;
 929
 930	port = find_port_by_vtermno(hp->vtermno);
 931	if (!port)
 932		return -EINVAL;
 933
 934	hp->irq_requested = 1;
 935	resize_console(port);
 936
 937	return 0;
 938}
 939
 940static void notifier_del_vio(struct hvc_struct *hp, int data)
 941{
 942	hp->irq_requested = 0;
 943}
 944
 945/* The operations for console ports. */
 946static const struct hv_ops hv_ops = {
 947	.get_chars = get_chars,
 948	.put_chars = put_chars,
 949	.notifier_add = notifier_add_vio,
 950	.notifier_del = notifier_del_vio,
 951	.notifier_hangup = notifier_del_vio,
 952};
 953
 954/*
 955 * Console drivers are initialized very early so boot messages can go
 956 * out, so we do things slightly differently from the generic virtio
 957 * initialization of the net and block drivers.
 958 *
 959 * At this stage, the console is output-only.  It's too early to set
 960 * up a virtqueue, so we let the drivers do some boutique early-output
 961 * thing.
 962 */
 963int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
 964{
 965	early_put_chars = put_chars;
 966	return hvc_instantiate(0, 0, &hv_ops);
 967}
 968
 969int init_port_console(struct port *port)
 970{
 971	int ret;
 972
 973	/*
 974	 * The Host's telling us this port is a console port.  Hook it
 975	 * up with an hvc console.
 976	 *
 977	 * To set up and manage our virtual console, we call
 978	 * hvc_alloc().
 979	 *
 980	 * The first argument of hvc_alloc() is the virtual console
 981	 * number.  The second argument is the parameter for the
 982	 * notification mechanism (like irq number).  We currently
 983	 * leave this as zero, virtqueues have implicit notifications.
 984	 *
 985	 * The third argument is a "struct hv_ops" containing the
 986	 * put_chars() get_chars(), notifier_add() and notifier_del()
 987	 * pointers.  The final argument is the output buffer size: we
 988	 * can do any size, so we put PAGE_SIZE here.
 989	 */
 990	port->cons.vtermno = pdrvdata.next_vtermno;
 
 
 991
 
 992	port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
 993	if (IS_ERR(port->cons.hvc)) {
 994		ret = PTR_ERR(port->cons.hvc);
 995		dev_err(port->dev,
 996			"error %d allocating hvc for port\n", ret);
 997		port->cons.hvc = NULL;
 
 998		return ret;
 999	}
1000	spin_lock_irq(&pdrvdata_lock);
1001	pdrvdata.next_vtermno++;
1002	list_add_tail(&port->cons.list, &pdrvdata.consoles);
1003	spin_unlock_irq(&pdrvdata_lock);
1004	port->guest_connected = true;
1005
1006	/*
1007	 * Start using the new console output if this is the first
1008	 * console to come up.
1009	 */
1010	if (early_put_chars)
1011		early_put_chars = NULL;
1012
1013	/* Notify host of port being opened */
1014	send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
1015
1016	return 0;
1017}
1018
1019static ssize_t show_port_name(struct device *dev,
1020			      struct device_attribute *attr, char *buffer)
1021{
1022	struct port *port;
1023
1024	port = dev_get_drvdata(dev);
1025
1026	return sprintf(buffer, "%s\n", port->name);
1027}
1028
1029static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
1030
1031static struct attribute *port_sysfs_entries[] = {
1032	&dev_attr_name.attr,
1033	NULL
1034};
1035
1036static struct attribute_group port_attribute_group = {
1037	.name = NULL,		/* put in device directory */
1038	.attrs = port_sysfs_entries,
1039};
1040
1041static ssize_t debugfs_read(struct file *filp, char __user *ubuf,
1042			    size_t count, loff_t *offp)
1043{
1044	struct port *port;
1045	char *buf;
1046	ssize_t ret, out_offset, out_count;
1047
1048	out_count = 1024;
1049	buf = kmalloc(out_count, GFP_KERNEL);
1050	if (!buf)
1051		return -ENOMEM;
 
 
 
 
 
 
1052
1053	port = filp->private_data;
1054	out_offset = 0;
1055	out_offset += snprintf(buf + out_offset, out_count,
1056			       "name: %s\n", port->name ? port->name : "");
1057	out_offset += snprintf(buf + out_offset, out_count - out_offset,
1058			       "guest_connected: %d\n", port->guest_connected);
1059	out_offset += snprintf(buf + out_offset, out_count - out_offset,
1060			       "host_connected: %d\n", port->host_connected);
1061	out_offset += snprintf(buf + out_offset, out_count - out_offset,
1062			       "outvq_full: %d\n", port->outvq_full);
1063	out_offset += snprintf(buf + out_offset, out_count - out_offset,
1064			       "bytes_sent: %lu\n", port->stats.bytes_sent);
1065	out_offset += snprintf(buf + out_offset, out_count - out_offset,
1066			       "bytes_received: %lu\n",
1067			       port->stats.bytes_received);
1068	out_offset += snprintf(buf + out_offset, out_count - out_offset,
1069			       "bytes_discarded: %lu\n",
1070			       port->stats.bytes_discarded);
1071	out_offset += snprintf(buf + out_offset, out_count - out_offset,
1072			       "is_console: %s\n",
1073			       is_console_port(port) ? "yes" : "no");
1074	out_offset += snprintf(buf + out_offset, out_count - out_offset,
1075			       "console_vtermno: %u\n", port->cons.vtermno);
1076
1077	ret = simple_read_from_buffer(ubuf, count, offp, buf, out_offset);
1078	kfree(buf);
1079	return ret;
1080}
1081
1082static const struct file_operations port_debugfs_ops = {
1083	.owner = THIS_MODULE,
1084	.open  = simple_open,
1085	.read  = debugfs_read,
1086};
1087
1088static void set_console_size(struct port *port, u16 rows, u16 cols)
1089{
1090	if (!port || !is_console_port(port))
1091		return;
1092
1093	port->cons.ws.ws_row = rows;
1094	port->cons.ws.ws_col = cols;
1095}
1096
1097static unsigned int fill_queue(struct virtqueue *vq, spinlock_t *lock)
1098{
1099	struct port_buffer *buf;
1100	unsigned int nr_added_bufs;
1101	int ret;
1102
1103	nr_added_bufs = 0;
1104	do {
1105		buf = alloc_buf(PAGE_SIZE);
1106		if (!buf)
1107			break;
1108
1109		spin_lock_irq(lock);
1110		ret = add_inbuf(vq, buf);
1111		if (ret < 0) {
1112			spin_unlock_irq(lock);
1113			free_buf(buf);
1114			break;
1115		}
1116		nr_added_bufs++;
1117		spin_unlock_irq(lock);
1118	} while (ret > 0);
1119
1120	return nr_added_bufs;
1121}
1122
1123static void send_sigio_to_port(struct port *port)
1124{
1125	if (port->async_queue && port->guest_connected)
1126		kill_fasync(&port->async_queue, SIGIO, POLL_OUT);
1127}
1128
1129static int add_port(struct ports_device *portdev, u32 id)
1130{
1131	char debugfs_name[16];
1132	struct port *port;
1133	struct port_buffer *buf;
1134	dev_t devt;
1135	unsigned int nr_added_bufs;
1136	int err;
1137
1138	port = kmalloc(sizeof(*port), GFP_KERNEL);
1139	if (!port) {
1140		err = -ENOMEM;
1141		goto fail;
1142	}
1143	kref_init(&port->kref);
1144
1145	port->portdev = portdev;
1146	port->id = id;
1147
1148	port->name = NULL;
1149	port->inbuf = NULL;
1150	port->cons.hvc = NULL;
1151	port->async_queue = NULL;
1152
1153	port->cons.ws.ws_row = port->cons.ws.ws_col = 0;
 
1154
1155	port->host_connected = port->guest_connected = false;
1156	port->stats = (struct port_stats) { 0 };
1157
1158	port->outvq_full = false;
1159
1160	port->in_vq = portdev->in_vqs[port->id];
1161	port->out_vq = portdev->out_vqs[port->id];
1162
1163	port->cdev = cdev_alloc();
1164	if (!port->cdev) {
1165		dev_err(&port->portdev->vdev->dev, "Error allocating cdev\n");
1166		err = -ENOMEM;
1167		goto free_port;
1168	}
1169	port->cdev->ops = &port_fops;
1170
1171	devt = MKDEV(portdev->chr_major, id);
1172	err = cdev_add(port->cdev, devt, 1);
1173	if (err < 0) {
1174		dev_err(&port->portdev->vdev->dev,
1175			"Error %d adding cdev for port %u\n", err, id);
1176		goto free_cdev;
1177	}
1178	port->dev = device_create(pdrvdata.class, &port->portdev->vdev->dev,
1179				  devt, port, "vport%up%u",
1180				  port->portdev->drv_index, id);
1181	if (IS_ERR(port->dev)) {
1182		err = PTR_ERR(port->dev);
1183		dev_err(&port->portdev->vdev->dev,
1184			"Error %d creating device for port %u\n",
1185			err, id);
1186		goto free_cdev;
1187	}
1188
1189	spin_lock_init(&port->inbuf_lock);
1190	spin_lock_init(&port->outvq_lock);
1191	init_waitqueue_head(&port->waitqueue);
1192
1193	/* Fill the in_vq with buffers so the host can send us data. */
1194	nr_added_bufs = fill_queue(port->in_vq, &port->inbuf_lock);
1195	if (!nr_added_bufs) {
 
 
 
1196		dev_err(port->dev, "Error allocating inbufs\n");
1197		err = -ENOMEM;
1198		goto free_device;
1199	}
1200
1201	/*
1202	 * If we're not using multiport support, this has to be a console port
1203	 */
1204	if (!use_multiport(port->portdev)) {
 
 
 
 
 
 
 
 
1205		err = init_port_console(port);
1206		if (err)
1207			goto free_inbufs;
1208	}
1209
1210	spin_lock_irq(&portdev->ports_lock);
1211	list_add_tail(&port->list, &port->portdev->ports);
1212	spin_unlock_irq(&portdev->ports_lock);
1213
1214	/*
1215	 * Tell the Host we're set so that it can send us various
1216	 * configuration parameters for this port (eg, port name,
1217	 * caching, whether this is a console port, etc.)
1218	 */
1219	send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1220
1221	if (pdrvdata.debugfs_dir) {
1222		/*
1223		 * Finally, create the debugfs file that we can use to
1224		 * inspect a port's state at any time
1225		 */
1226		sprintf(debugfs_name, "vport%up%u",
1227			port->portdev->drv_index, id);
1228		port->debugfs_file = debugfs_create_file(debugfs_name, 0444,
1229							 pdrvdata.debugfs_dir,
1230							 port,
1231							 &port_debugfs_ops);
1232	}
1233	return 0;
1234
1235free_inbufs:
1236	while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1237		free_buf(buf);
1238free_device:
1239	device_destroy(pdrvdata.class, port->dev->devt);
1240free_cdev:
1241	cdev_del(port->cdev);
1242free_port:
1243	kfree(port);
1244fail:
1245	/* The host might want to notify management sw about port add failure */
1246	__send_control_msg(portdev, id, VIRTIO_CONSOLE_PORT_READY, 0);
1247	return err;
1248}
1249
1250/* No users remain, remove all port-specific data. */
1251static void remove_port(struct kref *kref)
1252{
1253	struct port *port;
1254
1255	port = container_of(kref, struct port, kref);
1256
1257	sysfs_remove_group(&port->dev->kobj, &port_attribute_group);
1258	device_destroy(pdrvdata.class, port->dev->devt);
1259	cdev_del(port->cdev);
1260
1261	kfree(port->name);
1262
1263	debugfs_remove(port->debugfs_file);
1264
1265	kfree(port);
1266}
1267
1268static void remove_port_data(struct port *port)
1269{
1270	struct port_buffer *buf;
1271
1272	/* Remove unused data this port might have received. */
1273	discard_port_data(port);
 
1274
 
1275	reclaim_consumed_buffers(port);
1276
1277	/* Remove buffers we queued up for the Host to send us data in. */
1278	while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1279		free_buf(buf);
1280}
1281
1282/*
1283 * Port got unplugged.  Remove port from portdev's list and drop the
1284 * kref reference.  If no userspace has this port opened, it will
1285 * result in immediate removal the port.
1286 */
1287static void unplug_port(struct port *port)
1288{
1289	spin_lock_irq(&port->portdev->ports_lock);
1290	list_del(&port->list);
1291	spin_unlock_irq(&port->portdev->ports_lock);
1292
 
1293	if (port->guest_connected) {
 
 
 
 
1294		port->guest_connected = false;
1295		port->host_connected = false;
 
1296		wake_up_interruptible(&port->waitqueue);
1297
1298		/* Let the app know the port is going down. */
1299		send_sigio_to_port(port);
1300	}
 
1301
1302	if (is_console_port(port)) {
1303		spin_lock_irq(&pdrvdata_lock);
1304		list_del(&port->cons.list);
1305		spin_unlock_irq(&pdrvdata_lock);
1306		hvc_remove(port->cons.hvc);
 
1307	}
1308
1309	remove_port_data(port);
1310
1311	/*
1312	 * We should just assume the device itself has gone off --
1313	 * else a close on an open port later will try to send out a
1314	 * control message.
1315	 */
1316	port->portdev = NULL;
1317
 
 
 
 
 
 
 
1318	/*
1319	 * Locks around here are not necessary - a port can't be
1320	 * opened after we removed the port struct from ports_list
1321	 * above.
1322	 */
1323	kref_put(&port->kref, remove_port);
1324}
1325
1326/* Any private messages that the Host and Guest want to share */
1327static void handle_control_message(struct ports_device *portdev,
 
1328				   struct port_buffer *buf)
1329{
1330	struct virtio_console_control *cpkt;
1331	struct port *port;
1332	size_t name_size;
1333	int err;
1334
1335	cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
1336
1337	port = find_port_by_id(portdev, cpkt->id);
1338	if (!port && cpkt->event != VIRTIO_CONSOLE_PORT_ADD) {
 
1339		/* No valid header at start of buffer.  Drop it. */
1340		dev_dbg(&portdev->vdev->dev,
1341			"Invalid index %u in control packet\n", cpkt->id);
1342		return;
1343	}
1344
1345	switch (cpkt->event) {
1346	case VIRTIO_CONSOLE_PORT_ADD:
1347		if (port) {
1348			dev_dbg(&portdev->vdev->dev,
1349				"Port %u already added\n", port->id);
1350			send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1351			break;
1352		}
1353		if (cpkt->id >= portdev->config.max_nr_ports) {
 
1354			dev_warn(&portdev->vdev->dev,
1355				"Request for adding port with out-of-bound id %u, max. supported id: %u\n",
1356				cpkt->id, portdev->config.max_nr_ports - 1);
 
1357			break;
1358		}
1359		add_port(portdev, cpkt->id);
1360		break;
1361	case VIRTIO_CONSOLE_PORT_REMOVE:
1362		unplug_port(port);
1363		break;
1364	case VIRTIO_CONSOLE_CONSOLE_PORT:
1365		if (!cpkt->value)
1366			break;
1367		if (is_console_port(port))
1368			break;
1369
1370		init_port_console(port);
1371		complete(&early_console_added);
1372		/*
1373		 * Could remove the port here in case init fails - but
1374		 * have to notify the host first.
1375		 */
1376		break;
1377	case VIRTIO_CONSOLE_RESIZE: {
1378		struct {
1379			__u16 rows;
1380			__u16 cols;
1381		} size;
1382
1383		if (!is_console_port(port))
1384			break;
1385
1386		memcpy(&size, buf->buf + buf->offset + sizeof(*cpkt),
1387		       sizeof(size));
1388		set_console_size(port, size.rows, size.cols);
1389
1390		port->cons.hvc->irq_requested = 1;
1391		resize_console(port);
1392		break;
1393	}
1394	case VIRTIO_CONSOLE_PORT_OPEN:
1395		port->host_connected = cpkt->value;
1396		wake_up_interruptible(&port->waitqueue);
1397		/*
1398		 * If the host port got closed and the host had any
1399		 * unconsumed buffers, we'll be able to reclaim them
1400		 * now.
1401		 */
1402		spin_lock_irq(&port->outvq_lock);
1403		reclaim_consumed_buffers(port);
1404		spin_unlock_irq(&port->outvq_lock);
1405
1406		/*
1407		 * If the guest is connected, it'll be interested in
1408		 * knowing the host connection state changed.
1409		 */
 
1410		send_sigio_to_port(port);
 
1411		break;
1412	case VIRTIO_CONSOLE_PORT_NAME:
1413		/*
1414		 * If we woke up after hibernation, we can get this
1415		 * again.  Skip it in that case.
1416		 */
1417		if (port->name)
1418			break;
1419
1420		/*
1421		 * Skip the size of the header and the cpkt to get the size
1422		 * of the name that was sent
1423		 */
1424		name_size = buf->len - buf->offset - sizeof(*cpkt) + 1;
1425
1426		port->name = kmalloc(name_size, GFP_KERNEL);
1427		if (!port->name) {
1428			dev_err(port->dev,
1429				"Not enough space to store port name\n");
1430			break;
1431		}
1432		strncpy(port->name, buf->buf + buf->offset + sizeof(*cpkt),
1433			name_size - 1);
1434		port->name[name_size - 1] = 0;
1435
1436		/*
1437		 * Since we only have one sysfs attribute, 'name',
1438		 * create it only if we have a name for the port.
1439		 */
1440		err = sysfs_create_group(&port->dev->kobj,
1441					 &port_attribute_group);
1442		if (err) {
1443			dev_err(port->dev,
1444				"Error %d creating sysfs device attributes\n",
1445				err);
1446		} else {
1447			/*
1448			 * Generate a udev event so that appropriate
1449			 * symlinks can be created based on udev
1450			 * rules.
1451			 */
1452			kobject_uevent(&port->dev->kobj, KOBJ_CHANGE);
1453		}
1454		break;
1455	}
1456}
1457
1458static void control_work_handler(struct work_struct *work)
1459{
1460	struct ports_device *portdev;
1461	struct virtqueue *vq;
1462	struct port_buffer *buf;
1463	unsigned int len;
1464
1465	portdev = container_of(work, struct ports_device, control_work);
1466	vq = portdev->c_ivq;
1467
1468	spin_lock(&portdev->cvq_lock);
1469	while ((buf = virtqueue_get_buf(vq, &len))) {
1470		spin_unlock(&portdev->cvq_lock);
1471
1472		buf->len = len;
1473		buf->offset = 0;
1474
1475		handle_control_message(portdev, buf);
1476
1477		spin_lock(&portdev->cvq_lock);
1478		if (add_inbuf(portdev->c_ivq, buf) < 0) {
1479			dev_warn(&portdev->vdev->dev,
1480				 "Error adding buffer to queue\n");
1481			free_buf(buf);
1482		}
1483	}
1484	spin_unlock(&portdev->cvq_lock);
 
 
 
 
 
 
 
 
 
1485}
1486
1487static void out_intr(struct virtqueue *vq)
1488{
1489	struct port *port;
1490
1491	port = find_port_by_vq(vq->vdev->priv, vq);
1492	if (!port)
 
1493		return;
 
1494
1495	wake_up_interruptible(&port->waitqueue);
1496}
1497
1498static void in_intr(struct virtqueue *vq)
1499{
1500	struct port *port;
1501	unsigned long flags;
1502
1503	port = find_port_by_vq(vq->vdev->priv, vq);
1504	if (!port)
 
1505		return;
 
1506
1507	spin_lock_irqsave(&port->inbuf_lock, flags);
1508	port->inbuf = get_inbuf(port);
1509
1510	/*
1511	 * Don't queue up data when port is closed.  This condition
 
 
1512	 * can be reached when a console port is not yet connected (no
1513	 * tty is spawned) and the host sends out data to console
1514	 * ports.  For generic serial ports, the host won't
1515	 * (shouldn't) send data till the guest is connected.
 
 
 
 
 
 
 
1516	 */
1517	if (!port->guest_connected)
 
1518		discard_port_data(port);
1519
 
 
 
1520	spin_unlock_irqrestore(&port->inbuf_lock, flags);
1521
1522	wake_up_interruptible(&port->waitqueue);
1523
1524	/* Send a SIGIO indicating new data in case the process asked for it */
1525	send_sigio_to_port(port);
1526
1527	if (is_console_port(port) && hvc_poll(port->cons.hvc))
1528		hvc_kick();
1529}
1530
1531static void control_intr(struct virtqueue *vq)
1532{
1533	struct ports_device *portdev;
1534
1535	portdev = vq->vdev->priv;
1536	schedule_work(&portdev->control_work);
1537}
1538
1539static void config_intr(struct virtio_device *vdev)
1540{
1541	struct ports_device *portdev;
1542
1543	portdev = vdev->priv;
1544
 
 
 
 
 
 
 
 
 
1545	if (!use_multiport(portdev)) {
 
1546		struct port *port;
1547		u16 rows, cols;
1548
1549		vdev->config->get(vdev,
1550				  offsetof(struct virtio_console_config, cols),
1551				  &cols, sizeof(u16));
1552		vdev->config->get(vdev,
1553				  offsetof(struct virtio_console_config, rows),
1554				  &rows, sizeof(u16));
1555
1556		port = find_port_by_id(portdev, 0);
1557		set_console_size(port, rows, cols);
1558
1559		/*
1560		 * We'll use this way of resizing only for legacy
1561		 * support.  For newer userspace
1562		 * (VIRTIO_CONSOLE_F_MULTPORT+), use control messages
1563		 * to indicate console size changes so that it can be
1564		 * done per-port.
1565		 */
1566		resize_console(port);
1567	}
1568}
1569
1570static int init_vqs(struct ports_device *portdev)
1571{
1572	vq_callback_t **io_callbacks;
1573	char **io_names;
1574	struct virtqueue **vqs;
1575	u32 i, j, nr_ports, nr_queues;
1576	int err;
1577
1578	nr_ports = portdev->config.max_nr_ports;
1579	nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
1580
1581	vqs = kmalloc(nr_queues * sizeof(struct virtqueue *), GFP_KERNEL);
1582	io_callbacks = kmalloc(nr_queues * sizeof(vq_callback_t *), GFP_KERNEL);
1583	io_names = kmalloc(nr_queues * sizeof(char *), GFP_KERNEL);
1584	portdev->in_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1585				  GFP_KERNEL);
1586	portdev->out_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1587				   GFP_KERNEL);
 
1588	if (!vqs || !io_callbacks || !io_names || !portdev->in_vqs ||
1589	    !portdev->out_vqs) {
1590		err = -ENOMEM;
1591		goto free;
1592	}
1593
1594	/*
1595	 * For backward compat (newer host but older guest), the host
1596	 * spawns a console port first and also inits the vqs for port
1597	 * 0 before others.
1598	 */
1599	j = 0;
1600	io_callbacks[j] = in_intr;
1601	io_callbacks[j + 1] = out_intr;
1602	io_names[j] = "input";
1603	io_names[j + 1] = "output";
1604	j += 2;
1605
1606	if (use_multiport(portdev)) {
1607		io_callbacks[j] = control_intr;
1608		io_callbacks[j + 1] = NULL;
1609		io_names[j] = "control-i";
1610		io_names[j + 1] = "control-o";
1611
1612		for (i = 1; i < nr_ports; i++) {
1613			j += 2;
1614			io_callbacks[j] = in_intr;
1615			io_callbacks[j + 1] = out_intr;
1616			io_names[j] = "input";
1617			io_names[j + 1] = "output";
1618		}
1619	}
1620	/* Find the queues. */
1621	err = portdev->vdev->config->find_vqs(portdev->vdev, nr_queues, vqs,
1622					      io_callbacks,
1623					      (const char **)io_names);
1624	if (err)
1625		goto free;
1626
1627	j = 0;
1628	portdev->in_vqs[0] = vqs[0];
1629	portdev->out_vqs[0] = vqs[1];
1630	j += 2;
1631	if (use_multiport(portdev)) {
1632		portdev->c_ivq = vqs[j];
1633		portdev->c_ovq = vqs[j + 1];
1634
1635		for (i = 1; i < nr_ports; i++) {
1636			j += 2;
1637			portdev->in_vqs[i] = vqs[j];
1638			portdev->out_vqs[i] = vqs[j + 1];
1639		}
1640	}
1641	kfree(io_names);
1642	kfree(io_callbacks);
1643	kfree(vqs);
1644
1645	return 0;
1646
1647free:
1648	kfree(portdev->out_vqs);
1649	kfree(portdev->in_vqs);
1650	kfree(io_names);
1651	kfree(io_callbacks);
1652	kfree(vqs);
1653
1654	return err;
1655}
1656
1657static const struct file_operations portdev_fops = {
1658	.owner = THIS_MODULE,
1659};
1660
1661static void remove_vqs(struct ports_device *portdev)
1662{
 
 
 
 
 
 
 
 
 
1663	portdev->vdev->config->del_vqs(portdev->vdev);
1664	kfree(portdev->in_vqs);
1665	kfree(portdev->out_vqs);
1666}
1667
1668static void remove_controlq_data(struct ports_device *portdev)
1669{
1670	struct port_buffer *buf;
1671	unsigned int len;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1672
1673	if (!use_multiport(portdev))
1674		return;
1675
1676	while ((buf = virtqueue_get_buf(portdev->c_ivq, &len)))
1677		free_buf(buf);
1678
1679	while ((buf = virtqueue_detach_unused_buf(portdev->c_ivq)))
1680		free_buf(buf);
 
 
 
 
 
 
 
 
1681}
1682
1683/*
1684 * Once we're further in boot, we get probed like any other virtio
1685 * device.
1686 *
1687 * If the host also supports multiple console ports, we check the
1688 * config space to see how many ports the host has spawned.  We
1689 * initialize each port found.
1690 */
1691static int __devinit virtcons_probe(struct virtio_device *vdev)
1692{
1693	struct ports_device *portdev;
1694	int err;
1695	bool multiport;
1696	bool early = early_put_chars != NULL;
1697
 
 
 
 
 
 
 
 
 
1698	/* Ensure to read early_put_chars now */
1699	barrier();
1700
1701	portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
1702	if (!portdev) {
1703		err = -ENOMEM;
1704		goto fail;
1705	}
1706
1707	/* Attach this portdev to this virtio_device, and vice-versa. */
1708	portdev->vdev = vdev;
1709	vdev->priv = portdev;
1710
1711	spin_lock_irq(&pdrvdata_lock);
1712	portdev->drv_index = pdrvdata.index++;
1713	spin_unlock_irq(&pdrvdata_lock);
1714
1715	portdev->chr_major = register_chrdev(0, "virtio-portsdev",
1716					     &portdev_fops);
1717	if (portdev->chr_major < 0) {
1718		dev_err(&vdev->dev,
1719			"Error %d registering chrdev for device %u\n",
1720			portdev->chr_major, portdev->drv_index);
1721		err = portdev->chr_major;
1722		goto free;
1723	}
1724
1725	multiport = false;
1726	portdev->config.max_nr_ports = 1;
1727	if (virtio_config_val(vdev, VIRTIO_CONSOLE_F_MULTIPORT,
1728			      offsetof(struct virtio_console_config,
1729				       max_nr_ports),
1730			      &portdev->config.max_nr_ports) == 0)
 
 
 
 
 
 
 
 
 
 
1731		multiport = true;
 
1732
1733	err = init_vqs(portdev);
1734	if (err < 0) {
1735		dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
1736		goto free_chrdev;
1737	}
1738
1739	spin_lock_init(&portdev->ports_lock);
1740	INIT_LIST_HEAD(&portdev->ports);
 
 
 
 
 
 
1741
1742	if (multiport) {
1743		unsigned int nr_added_bufs;
1744
1745		spin_lock_init(&portdev->cvq_lock);
1746		INIT_WORK(&portdev->control_work, &control_work_handler);
1747
1748		nr_added_bufs = fill_queue(portdev->c_ivq, &portdev->cvq_lock);
1749		if (!nr_added_bufs) {
1750			dev_err(&vdev->dev,
1751				"Error allocating buffers for control queue\n");
1752			err = -ENOMEM;
1753			goto free_vqs;
 
 
 
 
 
 
 
1754		}
1755	} else {
1756		/*
1757		 * For backward compatibility: Create a console port
1758		 * if we're running on older host.
1759		 */
1760		add_port(portdev, 0);
1761	}
1762
1763	spin_lock_irq(&pdrvdata_lock);
1764	list_add_tail(&portdev->list, &pdrvdata.portdevs);
1765	spin_unlock_irq(&pdrvdata_lock);
1766
1767	__send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1768			   VIRTIO_CONSOLE_DEVICE_READY, 1);
1769
1770	/*
1771	 * If there was an early virtio console, assume that there are no
1772	 * other consoles. We need to wait until the hvc_alloc matches the
1773	 * hvc_instantiate, otherwise tty_open will complain, resulting in
1774	 * a "Warning: unable to open an initial console" boot failure.
1775	 * Without multiport this is done in add_port above. With multiport
1776	 * this might take some host<->guest communication - thus we have to
1777	 * wait.
1778	 */
1779	if (multiport && early)
1780		wait_for_completion(&early_console_added);
1781
1782	return 0;
1783
1784free_vqs:
1785	/* The host might want to notify mgmt sw about device add failure */
1786	__send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1787			   VIRTIO_CONSOLE_DEVICE_READY, 0);
1788	remove_vqs(portdev);
1789free_chrdev:
1790	unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1791free:
1792	kfree(portdev);
1793fail:
1794	return err;
1795}
1796
1797static void virtcons_remove(struct virtio_device *vdev)
1798{
1799	struct ports_device *portdev;
1800	struct port *port, *port2;
1801
1802	portdev = vdev->priv;
1803
1804	spin_lock_irq(&pdrvdata_lock);
1805	list_del(&portdev->list);
1806	spin_unlock_irq(&pdrvdata_lock);
1807
1808	/* Disable interrupts for vqs */
1809	vdev->config->reset(vdev);
1810	/* Finish up work that's lined up */
1811	cancel_work_sync(&portdev->control_work);
1812
1813	list_for_each_entry_safe(port, port2, &portdev->ports, list)
1814		unplug_port(port);
1815
1816	unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1817
1818	/*
1819	 * When yanking out a device, we immediately lose the
1820	 * (device-side) queues.  So there's no point in keeping the
1821	 * guest side around till we drop our final reference.  This
1822	 * also means that any ports which are in an open state will
1823	 * have to just stop using the port, as the vqs are going
1824	 * away.
1825	 */
1826	remove_controlq_data(portdev);
1827	remove_vqs(portdev);
1828	kfree(portdev);
1829}
1830
1831static struct virtio_device_id id_table[] = {
1832	{ VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
1833	{ 0 },
1834};
 
1835
1836static unsigned int features[] = {
1837	VIRTIO_CONSOLE_F_SIZE,
1838	VIRTIO_CONSOLE_F_MULTIPORT,
1839};
1840
1841#ifdef CONFIG_PM
 
 
 
 
 
 
 
 
 
 
 
1842static int virtcons_freeze(struct virtio_device *vdev)
1843{
1844	struct ports_device *portdev;
1845	struct port *port;
1846
1847	portdev = vdev->priv;
1848
1849	vdev->config->reset(vdev);
1850
1851	virtqueue_disable_cb(portdev->c_ivq);
 
1852	cancel_work_sync(&portdev->control_work);
 
1853	/*
1854	 * Once more: if control_work_handler() was running, it would
1855	 * enable the cb as the last step.
1856	 */
1857	virtqueue_disable_cb(portdev->c_ivq);
1858	remove_controlq_data(portdev);
1859
1860	list_for_each_entry(port, &portdev->ports, list) {
1861		virtqueue_disable_cb(port->in_vq);
1862		virtqueue_disable_cb(port->out_vq);
1863		/*
1864		 * We'll ask the host later if the new invocation has
1865		 * the port opened or closed.
1866		 */
1867		port->host_connected = false;
1868		remove_port_data(port);
1869	}
1870	remove_vqs(portdev);
1871
1872	return 0;
1873}
1874
1875static int virtcons_restore(struct virtio_device *vdev)
1876{
1877	struct ports_device *portdev;
1878	struct port *port;
1879	int ret;
1880
1881	portdev = vdev->priv;
1882
1883	ret = init_vqs(portdev);
1884	if (ret)
1885		return ret;
1886
 
 
1887	if (use_multiport(portdev))
1888		fill_queue(portdev->c_ivq, &portdev->cvq_lock);
1889
1890	list_for_each_entry(port, &portdev->ports, list) {
1891		port->in_vq = portdev->in_vqs[port->id];
1892		port->out_vq = portdev->out_vqs[port->id];
1893
1894		fill_queue(port->in_vq, &port->inbuf_lock);
1895
1896		/* Get port open/close status on the host */
1897		send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1898
1899		/*
1900		 * If a port was open at the time of suspending, we
1901		 * have to let the host know that it's still open.
1902		 */
1903		if (port->guest_connected)
1904			send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
1905	}
1906	return 0;
1907}
1908#endif
1909
1910static struct virtio_driver virtio_console = {
1911	.feature_table = features,
1912	.feature_table_size = ARRAY_SIZE(features),
1913	.driver.name =	KBUILD_MODNAME,
1914	.driver.owner =	THIS_MODULE,
1915	.id_table =	id_table,
1916	.probe =	virtcons_probe,
1917	.remove =	virtcons_remove,
1918	.config_changed = config_intr,
1919#ifdef CONFIG_PM
1920	.freeze =	virtcons_freeze,
1921	.restore =	virtcons_restore,
1922#endif
1923};
1924
1925static int __init init(void)
 
 
 
 
 
 
 
 
 
 
1926{
1927	int err;
1928
1929	pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
1930	if (IS_ERR(pdrvdata.class)) {
1931		err = PTR_ERR(pdrvdata.class);
1932		pr_err("Error %d creating virtio-ports class\n", err);
1933		return err;
1934	}
1935
1936	pdrvdata.debugfs_dir = debugfs_create_dir("virtio-ports", NULL);
1937	if (!pdrvdata.debugfs_dir) {
1938		pr_warning("Error %ld creating debugfs dir for virtio-ports\n",
1939			   PTR_ERR(pdrvdata.debugfs_dir));
1940	}
1941	INIT_LIST_HEAD(&pdrvdata.consoles);
1942	INIT_LIST_HEAD(&pdrvdata.portdevs);
1943
1944	return register_virtio_driver(&virtio_console);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1945}
1946
1947static void __exit fini(void)
1948{
 
 
1949	unregister_virtio_driver(&virtio_console);
 
1950
1951	class_destroy(pdrvdata.class);
1952	if (pdrvdata.debugfs_dir)
1953		debugfs_remove_recursive(pdrvdata.debugfs_dir);
1954}
1955module_init(init);
1956module_exit(fini);
1957
1958MODULE_DEVICE_TABLE(virtio, id_table);
1959MODULE_DESCRIPTION("Virtio console driver");
1960MODULE_LICENSE("GPL");