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>
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.
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.
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
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>
27 #include <linux/splice.h>
28 #include <linux/pagemap.h>
29 #include <linux/init.h>
30 #include <linux/list.h>
31 #include <linux/poll.h>
32 #include <linux/sched.h>
33 #include <linux/slab.h>
34 #include <linux/spinlock.h>
35 #include <linux/virtio.h>
36 #include <linux/virtio_console.h>
37 #include <linux/wait.h>
38 #include <linux/workqueue.h>
39 #include <linux/module.h>
40 #include <linux/dma-mapping.h>
41 #include <linux/kconfig.h>
42 #include "../tty/hvc/hvc_console.h"
44 #define is_rproc_enabled IS_ENABLED(CONFIG_REMOTEPROC)
47 * This is a global struct for storing common data for all the devices
48 * this driver handles.
50 * Mainly, it has a linked list for all the consoles in one place so
51 * that callbacks from hvc for get_chars(), put_chars() work properly
52 * across multiple devices and multiple ports per device.
54 struct ports_driver_data {
55 /* Used for registering chardevs */
58 /* Used for exporting per-port information to debugfs */
59 struct dentry *debugfs_dir;
61 /* List of all the devices we're handling */
62 struct list_head portdevs;
65 * This is used to keep track of the number of hvc consoles
66 * spawned by this driver. This number is given as the first
67 * argument to hvc_alloc(). To correctly map an initial
68 * console spawned via hvc_instantiate to the console being
69 * hooked up via hvc_alloc, we need to pass the same vtermno.
71 * We also just assume the first console being initialised was
72 * the first one that got used as the initial console.
74 unsigned int next_vtermno;
76 /* All the console devices handled by this driver */
77 struct list_head consoles;
79 static struct ports_driver_data pdrvdata;
81 static DEFINE_SPINLOCK(pdrvdata_lock);
82 static DECLARE_COMPLETION(early_console_added);
84 /* This struct holds information that's relevant only for console ports */
86 /* We'll place all consoles in a list in the pdrvdata struct */
87 struct list_head list;
89 /* The hvc device associated with this console port */
90 struct hvc_struct *hvc;
92 /* The size of the console */
96 * This number identifies the number that we used to register
97 * with hvc in hvc_instantiate() and hvc_alloc(); this is the
98 * number passed on by the hvc callbacks to us to
99 * differentiate between the other console ports handled by
108 /* size of the buffer in *buf above */
111 /* used length of the buffer */
113 /* offset in the buf from which to consume data */
116 /* DMA address of buffer */
119 /* Device we got DMA memory from */
122 /* List of pending dma buffers to free */
123 struct list_head list;
125 /* If sgpages == 0 then buf is used */
126 unsigned int sgpages;
128 /* sg is used if spages > 0. sg must be the last in is struct */
129 struct scatterlist sg[0];
133 * This is a per-device struct that stores data common to all the
134 * ports for that device (vdev->priv).
136 struct ports_device {
137 /* Next portdev in the list, head is in the pdrvdata struct */
138 struct list_head list;
141 * Workqueue handlers where we process deferred work after
144 struct work_struct control_work;
145 struct work_struct config_work;
147 struct list_head ports;
149 /* To protect the list of ports */
150 spinlock_t ports_lock;
152 /* To protect the vq operations for the control channel */
153 spinlock_t c_ivq_lock;
154 spinlock_t c_ovq_lock;
156 /* The current config space is stored here */
157 struct virtio_console_config config;
159 /* The virtio device we're associated with */
160 struct virtio_device *vdev;
163 * A couple of virtqueues for the control channel: one for
164 * guest->host transfers, one for host->guest transfers
166 struct virtqueue *c_ivq, *c_ovq;
168 /* Array of per-port IO virtqueues */
169 struct virtqueue **in_vqs, **out_vqs;
171 /* Major number for this device. Ports will be created as minors. */
176 unsigned long bytes_sent, bytes_received, bytes_discarded;
179 /* This struct holds the per-port data */
181 /* Next port in the list, head is in the ports_device */
182 struct list_head list;
184 /* Pointer to the parent virtio_console device */
185 struct ports_device *portdev;
187 /* The current buffer from which data has to be fed to readers */
188 struct port_buffer *inbuf;
191 * To protect the operations on the in_vq associated with this
192 * port. Has to be a spinlock because it can be called from
193 * interrupt context (get_char()).
195 spinlock_t inbuf_lock;
197 /* Protect the operations on the out_vq. */
198 spinlock_t outvq_lock;
200 /* The IO vqs for this port */
201 struct virtqueue *in_vq, *out_vq;
203 /* File in the debugfs directory that exposes this port's information */
204 struct dentry *debugfs_file;
207 * Keep count of the bytes sent, received and discarded for
208 * this port for accounting and debugging purposes. These
209 * counts are not reset across port open / close events.
211 struct port_stats stats;
214 * The entries in this struct will be valid if this port is
215 * hooked up to an hvc console
219 /* Each port associates with a separate char device */
223 /* Reference-counting to handle port hot-unplugs and file operations */
226 /* A waitqueue for poll() or blocking read operations */
227 wait_queue_head_t waitqueue;
229 /* The 'name' of the port that we expose via sysfs properties */
232 /* We can notify apps of host connect / disconnect events via SIGIO */
233 struct fasync_struct *async_queue;
235 /* The 'id' to identify the port with the Host */
240 /* Is the host device open */
243 /* We should allow only one process to open a port */
244 bool guest_connected;
247 /* This is the very early arch-specified put chars function. */
248 static int (*early_put_chars)(u32, const char *, int);
250 static struct port *find_port_by_vtermno(u32 vtermno)
253 struct console *cons;
256 spin_lock_irqsave(&pdrvdata_lock, flags);
257 list_for_each_entry(cons, &pdrvdata.consoles, list) {
258 if (cons->vtermno == vtermno) {
259 port = container_of(cons, struct port, cons);
265 spin_unlock_irqrestore(&pdrvdata_lock, flags);
269 static struct port *find_port_by_devt_in_portdev(struct ports_device *portdev,
275 spin_lock_irqsave(&portdev->ports_lock, flags);
276 list_for_each_entry(port, &portdev->ports, list) {
277 if (port->cdev->dev == dev) {
278 kref_get(&port->kref);
284 spin_unlock_irqrestore(&portdev->ports_lock, flags);
289 static struct port *find_port_by_devt(dev_t dev)
291 struct ports_device *portdev;
295 spin_lock_irqsave(&pdrvdata_lock, flags);
296 list_for_each_entry(portdev, &pdrvdata.portdevs, list) {
297 port = find_port_by_devt_in_portdev(portdev, dev);
303 spin_unlock_irqrestore(&pdrvdata_lock, flags);
307 static struct port *find_port_by_id(struct ports_device *portdev, u32 id)
312 spin_lock_irqsave(&portdev->ports_lock, flags);
313 list_for_each_entry(port, &portdev->ports, list)
318 spin_unlock_irqrestore(&portdev->ports_lock, flags);
323 static struct port *find_port_by_vq(struct ports_device *portdev,
324 struct virtqueue *vq)
329 spin_lock_irqsave(&portdev->ports_lock, flags);
330 list_for_each_entry(port, &portdev->ports, list)
331 if (port->in_vq == vq || port->out_vq == vq)
335 spin_unlock_irqrestore(&portdev->ports_lock, flags);
339 static bool is_console_port(struct port *port)
346 static bool is_rproc_serial(const struct virtio_device *vdev)
348 return is_rproc_enabled && vdev->id.device == VIRTIO_ID_RPROC_SERIAL;
351 static inline bool use_multiport(struct ports_device *portdev)
354 * This condition can be true when put_chars is called from
359 return __virtio_test_bit(portdev->vdev, VIRTIO_CONSOLE_F_MULTIPORT);
362 static DEFINE_SPINLOCK(dma_bufs_lock);
363 static LIST_HEAD(pending_free_dma_bufs);
365 static void free_buf(struct port_buffer *buf, bool can_sleep)
369 for (i = 0; i < buf->sgpages; i++) {
370 struct page *page = sg_page(&buf->sg[i]);
378 } else if (is_rproc_enabled) {
381 /* dma_free_coherent requires interrupts to be enabled. */
383 /* queue up dma-buffers to be freed later */
384 spin_lock_irqsave(&dma_bufs_lock, flags);
385 list_add_tail(&buf->list, &pending_free_dma_bufs);
386 spin_unlock_irqrestore(&dma_bufs_lock, flags);
389 dma_free_coherent(buf->dev, buf->size, buf->buf, buf->dma);
391 /* Release device refcnt and allow it to be freed */
392 put_device(buf->dev);
398 static void reclaim_dma_bufs(void)
401 struct port_buffer *buf, *tmp;
404 if (list_empty(&pending_free_dma_bufs))
407 /* Create a copy of the pending_free_dma_bufs while holding the lock */
408 spin_lock_irqsave(&dma_bufs_lock, flags);
409 list_cut_position(&tmp_list, &pending_free_dma_bufs,
410 pending_free_dma_bufs.prev);
411 spin_unlock_irqrestore(&dma_bufs_lock, flags);
413 /* Release the dma buffers, without irqs enabled */
414 list_for_each_entry_safe(buf, tmp, &tmp_list, list) {
415 list_del(&buf->list);
420 static struct port_buffer *alloc_buf(struct virtqueue *vq, size_t buf_size,
423 struct port_buffer *buf;
428 * Allocate buffer and the sg list. The sg list array is allocated
429 * directly after the port_buffer struct.
431 buf = kmalloc(sizeof(*buf) + sizeof(struct scatterlist) * pages,
436 buf->sgpages = pages;
443 if (is_rproc_serial(vq->vdev)) {
445 * Allocate DMA memory from ancestor. When a virtio
446 * device is created by remoteproc, the DMA memory is
447 * associated with the grandparent device:
448 * vdev => rproc => platform-dev.
449 * The code here would have been less quirky if
450 * DMA_MEMORY_INCLUDES_CHILDREN had been supported
453 if (!vq->vdev->dev.parent || !vq->vdev->dev.parent->parent)
455 buf->dev = vq->vdev->dev.parent->parent;
457 /* Increase device refcnt to avoid freeing it */
458 get_device(buf->dev);
459 buf->buf = dma_alloc_coherent(buf->dev, buf_size, &buf->dma,
463 buf->buf = kmalloc(buf_size, GFP_KERNEL);
470 buf->size = buf_size;
479 /* Callers should take appropriate locks */
480 static struct port_buffer *get_inbuf(struct port *port)
482 struct port_buffer *buf;
488 buf = virtqueue_get_buf(port->in_vq, &len);
492 port->stats.bytes_received += len;
498 * Create a scatter-gather list representing our input buffer and put
501 * Callers should take appropriate locks.
503 static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
505 struct scatterlist sg[1];
508 sg_init_one(sg, buf->buf, buf->size);
510 ret = virtqueue_add_inbuf(vq, sg, 1, buf, GFP_ATOMIC);
517 /* Discard any unread data this port has. Callers lockers. */
518 static void discard_port_data(struct port *port)
520 struct port_buffer *buf;
523 if (!port->portdev) {
524 /* Device has been unplugged. vqs are already gone. */
527 buf = get_inbuf(port);
531 port->stats.bytes_discarded += buf->len - buf->offset;
532 if (add_inbuf(port->in_vq, buf) < 0) {
534 free_buf(buf, false);
537 buf = get_inbuf(port);
540 dev_warn(port->dev, "Errors adding %d buffers back to vq\n",
544 static bool port_has_data(struct port *port)
550 spin_lock_irqsave(&port->inbuf_lock, flags);
551 port->inbuf = get_inbuf(port);
555 spin_unlock_irqrestore(&port->inbuf_lock, flags);
559 static ssize_t __send_control_msg(struct ports_device *portdev, u32 port_id,
560 unsigned int event, unsigned int value)
562 struct scatterlist sg[1];
563 struct virtio_console_control cpkt;
564 struct virtqueue *vq;
567 if (!use_multiport(portdev))
570 cpkt.id = cpu_to_virtio32(portdev->vdev, port_id);
571 cpkt.event = cpu_to_virtio16(portdev->vdev, event);
572 cpkt.value = cpu_to_virtio16(portdev->vdev, value);
576 sg_init_one(sg, &cpkt, sizeof(cpkt));
578 spin_lock(&portdev->c_ovq_lock);
579 if (virtqueue_add_outbuf(vq, sg, 1, &cpkt, GFP_ATOMIC) == 0) {
581 while (!virtqueue_get_buf(vq, &len)
582 && !virtqueue_is_broken(vq))
585 spin_unlock(&portdev->c_ovq_lock);
589 static ssize_t send_control_msg(struct port *port, unsigned int event,
592 /* Did the port get unplugged before userspace closed it? */
594 return __send_control_msg(port->portdev, port->id, event, value);
599 /* Callers must take the port->outvq_lock */
600 static void reclaim_consumed_buffers(struct port *port)
602 struct port_buffer *buf;
605 if (!port->portdev) {
606 /* Device has been unplugged. vqs are already gone. */
609 while ((buf = virtqueue_get_buf(port->out_vq, &len))) {
610 free_buf(buf, false);
611 port->outvq_full = false;
615 static ssize_t __send_to_port(struct port *port, struct scatterlist *sg,
616 int nents, size_t in_count,
617 void *data, bool nonblock)
619 struct virtqueue *out_vq;
624 out_vq = port->out_vq;
626 spin_lock_irqsave(&port->outvq_lock, flags);
628 reclaim_consumed_buffers(port);
630 err = virtqueue_add_outbuf(out_vq, sg, nents, data, GFP_ATOMIC);
632 /* Tell Host to go! */
633 virtqueue_kick(out_vq);
640 if (out_vq->num_free == 0)
641 port->outvq_full = true;
647 * Wait till the host acknowledges it pushed out the data we
648 * sent. This is done for data from the hvc_console; the tty
649 * operations are performed with spinlocks held so we can't
650 * sleep here. An alternative would be to copy the data to a
651 * buffer and relax the spinning requirement. The downside is
652 * we need to kmalloc a GFP_ATOMIC buffer each time the
653 * console driver writes something out.
655 while (!virtqueue_get_buf(out_vq, &len)
656 && !virtqueue_is_broken(out_vq))
659 spin_unlock_irqrestore(&port->outvq_lock, flags);
661 port->stats.bytes_sent += in_count;
663 * We're expected to return the amount of data we wrote -- all
670 * Give out the data that's requested from the buffer that we have
673 static ssize_t fill_readbuf(struct port *port, char __user *out_buf,
674 size_t out_count, bool to_user)
676 struct port_buffer *buf;
679 if (!out_count || !port_has_data(port))
683 out_count = min(out_count, buf->len - buf->offset);
688 ret = copy_to_user(out_buf, buf->buf + buf->offset, out_count);
692 memcpy((__force char *)out_buf, buf->buf + buf->offset,
696 buf->offset += out_count;
698 if (buf->offset == buf->len) {
700 * We're done using all the data in this buffer.
701 * Re-queue so that the Host can send us more data.
703 spin_lock_irqsave(&port->inbuf_lock, flags);
706 if (add_inbuf(port->in_vq, buf) < 0)
707 dev_warn(port->dev, "failed add_buf\n");
709 spin_unlock_irqrestore(&port->inbuf_lock, flags);
711 /* Return the number of bytes actually copied */
715 /* The condition that must be true for polling to end */
716 static bool will_read_block(struct port *port)
718 if (!port->guest_connected) {
719 /* Port got hot-unplugged. Let's exit. */
722 return !port_has_data(port) && port->host_connected;
725 static bool will_write_block(struct port *port)
729 if (!port->guest_connected) {
730 /* Port got hot-unplugged. Let's exit. */
733 if (!port->host_connected)
736 spin_lock_irq(&port->outvq_lock);
738 * Check if the Host has consumed any buffers since we last
739 * sent data (this is only applicable for nonblocking ports).
741 reclaim_consumed_buffers(port);
742 ret = port->outvq_full;
743 spin_unlock_irq(&port->outvq_lock);
748 static ssize_t port_fops_read(struct file *filp, char __user *ubuf,
749 size_t count, loff_t *offp)
754 port = filp->private_data;
756 /* Port is hot-unplugged. */
757 if (!port->guest_connected)
760 if (!port_has_data(port)) {
762 * If nothing's connected on the host just return 0 in
763 * case of list_empty; this tells the userspace app
764 * that there's no connection
766 if (!port->host_connected)
768 if (filp->f_flags & O_NONBLOCK)
771 ret = wait_event_freezable(port->waitqueue,
772 !will_read_block(port));
776 /* Port got hot-unplugged while we were waiting above. */
777 if (!port->guest_connected)
780 * We could've received a disconnection message while we were
781 * waiting for more data.
783 * This check is not clubbed in the if() statement above as we
784 * might receive some data as well as the host could get
785 * disconnected after we got woken up from our wait. So we
786 * really want to give off whatever data we have and only then
787 * check for host_connected.
789 if (!port_has_data(port) && !port->host_connected)
792 return fill_readbuf(port, ubuf, count, true);
795 static int wait_port_writable(struct port *port, bool nonblock)
799 if (will_write_block(port)) {
803 ret = wait_event_freezable(port->waitqueue,
804 !will_write_block(port));
808 /* Port got hot-unplugged. */
809 if (!port->guest_connected)
815 static ssize_t port_fops_write(struct file *filp, const char __user *ubuf,
816 size_t count, loff_t *offp)
819 struct port_buffer *buf;
822 struct scatterlist sg[1];
824 /* Userspace could be out to fool us */
828 port = filp->private_data;
830 nonblock = filp->f_flags & O_NONBLOCK;
832 ret = wait_port_writable(port, nonblock);
836 count = min((size_t)(32 * 1024), count);
838 buf = alloc_buf(port->out_vq, count, 0);
842 ret = copy_from_user(buf->buf, ubuf, count);
849 * We now ask send_buf() to not spin for generic ports -- we
850 * can re-use the same code path that non-blocking file
851 * descriptors take for blocking file descriptors since the
852 * wait is already done and we're certain the write will go
853 * through to the host.
856 sg_init_one(sg, buf->buf, count);
857 ret = __send_to_port(port, sg, 1, count, buf, nonblock);
859 if (nonblock && ret > 0)
872 struct scatterlist *sg;
875 static int pipe_to_sg(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
876 struct splice_desc *sd)
878 struct sg_list *sgl = sd->u.data;
879 unsigned int offset, len;
881 if (sgl->n == sgl->size)
884 /* Try lock this page */
885 if (buf->ops->steal(pipe, buf) == 0) {
886 /* Get reference and unlock page for moving */
888 unlock_page(buf->page);
890 len = min(buf->len, sd->len);
891 sg_set_page(&(sgl->sg[sgl->n]), buf->page, len, buf->offset);
893 /* Failback to copying a page */
894 struct page *page = alloc_page(GFP_KERNEL);
900 offset = sd->pos & ~PAGE_MASK;
903 if (len + offset > PAGE_SIZE)
904 len = PAGE_SIZE - offset;
906 src = kmap_atomic(buf->page);
907 memcpy(page_address(page) + offset, src + buf->offset, len);
910 sg_set_page(&(sgl->sg[sgl->n]), page, len, offset);
918 /* Faster zero-copy write by splicing */
919 static ssize_t port_fops_splice_write(struct pipe_inode_info *pipe,
920 struct file *filp, loff_t *ppos,
921 size_t len, unsigned int flags)
923 struct port *port = filp->private_data;
926 struct port_buffer *buf;
927 struct splice_desc sd = {
935 * Rproc_serial does not yet support splice. To support splice
936 * pipe_to_sg() must allocate dma-buffers and copy content from
937 * regular pages to dma pages. And alloc_buf and free_buf must
938 * support allocating and freeing such a list of dma-buffers.
940 if (is_rproc_serial(port->out_vq->vdev))
944 * pipe->nrbufs == 0 means there are no data to transfer,
945 * so this returns just 0 for no data.
953 ret = wait_port_writable(port, filp->f_flags & O_NONBLOCK);
957 buf = alloc_buf(port->out_vq, 0, pipe->nrbufs);
965 sgl.size = pipe->nrbufs;
967 sg_init_table(sgl.sg, sgl.size);
968 ret = __splice_from_pipe(pipe, &sd, pipe_to_sg);
971 ret = __send_to_port(port, buf->sg, sgl.n, sgl.len, buf, true);
973 if (unlikely(ret <= 0))
982 static unsigned int port_fops_poll(struct file *filp, poll_table *wait)
987 port = filp->private_data;
988 poll_wait(filp, &port->waitqueue, wait);
990 if (!port->guest_connected) {
991 /* Port got unplugged */
995 if (!will_read_block(port))
996 ret |= POLLIN | POLLRDNORM;
997 if (!will_write_block(port))
999 if (!port->host_connected)
1005 static void remove_port(struct kref *kref);
1007 static int port_fops_release(struct inode *inode, struct file *filp)
1011 port = filp->private_data;
1013 /* Notify host of port being closed */
1014 send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
1016 spin_lock_irq(&port->inbuf_lock);
1017 port->guest_connected = false;
1019 discard_port_data(port);
1021 spin_unlock_irq(&port->inbuf_lock);
1023 spin_lock_irq(&port->outvq_lock);
1024 reclaim_consumed_buffers(port);
1025 spin_unlock_irq(&port->outvq_lock);
1029 * Locks aren't necessary here as a port can't be opened after
1030 * unplug, and if a port isn't unplugged, a kref would already
1031 * exist for the port. Plus, taking ports_lock here would
1032 * create a dependency on other locks taken by functions
1033 * inside remove_port if we're the last holder of the port,
1034 * creating many problems.
1036 kref_put(&port->kref, remove_port);
1041 static int port_fops_open(struct inode *inode, struct file *filp)
1043 struct cdev *cdev = inode->i_cdev;
1047 /* We get the port with a kref here */
1048 port = find_port_by_devt(cdev->dev);
1050 /* Port was unplugged before we could proceed */
1053 filp->private_data = port;
1056 * Don't allow opening of console port devices -- that's done
1059 if (is_console_port(port)) {
1064 /* Allow only one process to open a particular port at a time */
1065 spin_lock_irq(&port->inbuf_lock);
1066 if (port->guest_connected) {
1067 spin_unlock_irq(&port->inbuf_lock);
1072 port->guest_connected = true;
1073 spin_unlock_irq(&port->inbuf_lock);
1075 spin_lock_irq(&port->outvq_lock);
1077 * There might be a chance that we missed reclaiming a few
1078 * buffers in the window of the port getting previously closed
1081 reclaim_consumed_buffers(port);
1082 spin_unlock_irq(&port->outvq_lock);
1084 nonseekable_open(inode, filp);
1086 /* Notify host of port being opened */
1087 send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
1091 kref_put(&port->kref, remove_port);
1095 static int port_fops_fasync(int fd, struct file *filp, int mode)
1099 port = filp->private_data;
1100 return fasync_helper(fd, filp, mode, &port->async_queue);
1104 * The file operations that we support: programs in the guest can open
1105 * a console device, read from it, write to it, poll for data and
1106 * close it. The devices are at
1107 * /dev/vport<device number>p<port number>
1109 static const struct file_operations port_fops = {
1110 .owner = THIS_MODULE,
1111 .open = port_fops_open,
1112 .read = port_fops_read,
1113 .write = port_fops_write,
1114 .splice_write = port_fops_splice_write,
1115 .poll = port_fops_poll,
1116 .release = port_fops_release,
1117 .fasync = port_fops_fasync,
1118 .llseek = no_llseek,
1122 * The put_chars() callback is pretty straightforward.
1124 * We turn the characters into a scatter-gather list, add it to the
1125 * output queue and then kick the Host. Then we sit here waiting for
1126 * it to finish: inefficient in theory, but in practice
1127 * implementations will do it immediately (lguest's Launcher does).
1129 static int put_chars(u32 vtermno, const char *buf, int count)
1132 struct scatterlist sg[1];
1136 if (unlikely(early_put_chars))
1137 return early_put_chars(vtermno, buf, count);
1139 port = find_port_by_vtermno(vtermno);
1143 data = kmemdup(buf, count, GFP_ATOMIC);
1147 sg_init_one(sg, data, count);
1148 ret = __send_to_port(port, sg, 1, count, data, false);
1154 * get_chars() is the callback from the hvc_console infrastructure
1155 * when an interrupt is received.
1157 * We call out to fill_readbuf that gets us the required data from the
1158 * buffers that are queued up.
1160 static int get_chars(u32 vtermno, char *buf, int count)
1164 /* If we've not set up the port yet, we have no input to give. */
1165 if (unlikely(early_put_chars))
1168 port = find_port_by_vtermno(vtermno);
1172 /* If we don't have an input queue yet, we can't get input. */
1173 BUG_ON(!port->in_vq);
1175 return fill_readbuf(port, (__force char __user *)buf, count, false);
1178 static void resize_console(struct port *port)
1180 struct virtio_device *vdev;
1182 /* The port could have been hot-unplugged */
1183 if (!port || !is_console_port(port))
1186 vdev = port->portdev->vdev;
1188 /* Don't test F_SIZE at all if we're rproc: not a valid feature! */
1189 if (!is_rproc_serial(vdev) &&
1190 virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE))
1191 hvc_resize(port->cons.hvc, port->cons.ws);
1194 /* We set the configuration at this point, since we now have a tty */
1195 static int notifier_add_vio(struct hvc_struct *hp, int data)
1199 port = find_port_by_vtermno(hp->vtermno);
1203 hp->irq_requested = 1;
1204 resize_console(port);
1209 static void notifier_del_vio(struct hvc_struct *hp, int data)
1211 hp->irq_requested = 0;
1214 /* The operations for console ports. */
1215 static const struct hv_ops hv_ops = {
1216 .get_chars = get_chars,
1217 .put_chars = put_chars,
1218 .notifier_add = notifier_add_vio,
1219 .notifier_del = notifier_del_vio,
1220 .notifier_hangup = notifier_del_vio,
1224 * Console drivers are initialized very early so boot messages can go
1225 * out, so we do things slightly differently from the generic virtio
1226 * initialization of the net and block drivers.
1228 * At this stage, the console is output-only. It's too early to set
1229 * up a virtqueue, so we let the drivers do some boutique early-output
1232 int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
1234 early_put_chars = put_chars;
1235 return hvc_instantiate(0, 0, &hv_ops);
1238 static int init_port_console(struct port *port)
1243 * The Host's telling us this port is a console port. Hook it
1244 * up with an hvc console.
1246 * To set up and manage our virtual console, we call
1249 * The first argument of hvc_alloc() is the virtual console
1250 * number. The second argument is the parameter for the
1251 * notification mechanism (like irq number). We currently
1252 * leave this as zero, virtqueues have implicit notifications.
1254 * The third argument is a "struct hv_ops" containing the
1255 * put_chars() get_chars(), notifier_add() and notifier_del()
1256 * pointers. The final argument is the output buffer size: we
1257 * can do any size, so we put PAGE_SIZE here.
1259 port->cons.vtermno = pdrvdata.next_vtermno;
1261 port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
1262 if (IS_ERR(port->cons.hvc)) {
1263 ret = PTR_ERR(port->cons.hvc);
1265 "error %d allocating hvc for port\n", ret);
1266 port->cons.hvc = NULL;
1269 spin_lock_irq(&pdrvdata_lock);
1270 pdrvdata.next_vtermno++;
1271 list_add_tail(&port->cons.list, &pdrvdata.consoles);
1272 spin_unlock_irq(&pdrvdata_lock);
1273 port->guest_connected = true;
1276 * Start using the new console output if this is the first
1277 * console to come up.
1279 if (early_put_chars)
1280 early_put_chars = NULL;
1282 /* Notify host of port being opened */
1283 send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
1288 static ssize_t show_port_name(struct device *dev,
1289 struct device_attribute *attr, char *buffer)
1293 port = dev_get_drvdata(dev);
1295 return sprintf(buffer, "%s\n", port->name);
1298 static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
1300 static struct attribute *port_sysfs_entries[] = {
1301 &dev_attr_name.attr,
1305 static struct attribute_group port_attribute_group = {
1306 .name = NULL, /* put in device directory */
1307 .attrs = port_sysfs_entries,
1310 static ssize_t debugfs_read(struct file *filp, char __user *ubuf,
1311 size_t count, loff_t *offp)
1315 ssize_t ret, out_offset, out_count;
1318 buf = kmalloc(out_count, GFP_KERNEL);
1322 port = filp->private_data;
1324 out_offset += snprintf(buf + out_offset, out_count,
1325 "name: %s\n", port->name ? port->name : "");
1326 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1327 "guest_connected: %d\n", port->guest_connected);
1328 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1329 "host_connected: %d\n", port->host_connected);
1330 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1331 "outvq_full: %d\n", port->outvq_full);
1332 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1333 "bytes_sent: %lu\n", port->stats.bytes_sent);
1334 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1335 "bytes_received: %lu\n",
1336 port->stats.bytes_received);
1337 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1338 "bytes_discarded: %lu\n",
1339 port->stats.bytes_discarded);
1340 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1342 is_console_port(port) ? "yes" : "no");
1343 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1344 "console_vtermno: %u\n", port->cons.vtermno);
1346 ret = simple_read_from_buffer(ubuf, count, offp, buf, out_offset);
1351 static const struct file_operations port_debugfs_ops = {
1352 .owner = THIS_MODULE,
1353 .open = simple_open,
1354 .read = debugfs_read,
1357 static void set_console_size(struct port *port, u16 rows, u16 cols)
1359 if (!port || !is_console_port(port))
1362 port->cons.ws.ws_row = rows;
1363 port->cons.ws.ws_col = cols;
1366 static unsigned int fill_queue(struct virtqueue *vq, spinlock_t *lock)
1368 struct port_buffer *buf;
1369 unsigned int nr_added_bufs;
1374 buf = alloc_buf(vq, PAGE_SIZE, 0);
1378 spin_lock_irq(lock);
1379 ret = add_inbuf(vq, buf);
1381 spin_unlock_irq(lock);
1382 free_buf(buf, true);
1386 spin_unlock_irq(lock);
1389 return nr_added_bufs;
1392 static void send_sigio_to_port(struct port *port)
1394 if (port->async_queue && port->guest_connected)
1395 kill_fasync(&port->async_queue, SIGIO, POLL_OUT);
1398 static int add_port(struct ports_device *portdev, u32 id)
1400 char debugfs_name[16];
1403 unsigned int nr_added_bufs;
1406 port = kmalloc(sizeof(*port), GFP_KERNEL);
1411 kref_init(&port->kref);
1413 port->portdev = portdev;
1418 port->cons.hvc = NULL;
1419 port->async_queue = NULL;
1421 port->cons.ws.ws_row = port->cons.ws.ws_col = 0;
1423 port->host_connected = port->guest_connected = false;
1424 port->stats = (struct port_stats) { 0 };
1426 port->outvq_full = false;
1428 port->in_vq = portdev->in_vqs[port->id];
1429 port->out_vq = portdev->out_vqs[port->id];
1431 port->cdev = cdev_alloc();
1433 dev_err(&port->portdev->vdev->dev, "Error allocating cdev\n");
1437 port->cdev->ops = &port_fops;
1439 devt = MKDEV(portdev->chr_major, id);
1440 err = cdev_add(port->cdev, devt, 1);
1442 dev_err(&port->portdev->vdev->dev,
1443 "Error %d adding cdev for port %u\n", err, id);
1446 port->dev = device_create(pdrvdata.class, &port->portdev->vdev->dev,
1447 devt, port, "vport%up%u",
1448 port->portdev->vdev->index, id);
1449 if (IS_ERR(port->dev)) {
1450 err = PTR_ERR(port->dev);
1451 dev_err(&port->portdev->vdev->dev,
1452 "Error %d creating device for port %u\n",
1457 spin_lock_init(&port->inbuf_lock);
1458 spin_lock_init(&port->outvq_lock);
1459 init_waitqueue_head(&port->waitqueue);
1461 /* Fill the in_vq with buffers so the host can send us data. */
1462 nr_added_bufs = fill_queue(port->in_vq, &port->inbuf_lock);
1463 if (!nr_added_bufs) {
1464 dev_err(port->dev, "Error allocating inbufs\n");
1469 if (is_rproc_serial(port->portdev->vdev))
1471 * For rproc_serial assume remote processor is connected.
1472 * rproc_serial does not want the console port, only
1473 * the generic port implementation.
1475 port->host_connected = true;
1476 else if (!use_multiport(port->portdev)) {
1478 * If we're not using multiport support,
1479 * this has to be a console port.
1481 err = init_port_console(port);
1486 spin_lock_irq(&portdev->ports_lock);
1487 list_add_tail(&port->list, &port->portdev->ports);
1488 spin_unlock_irq(&portdev->ports_lock);
1491 * Tell the Host we're set so that it can send us various
1492 * configuration parameters for this port (eg, port name,
1493 * caching, whether this is a console port, etc.)
1495 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1497 if (pdrvdata.debugfs_dir) {
1499 * Finally, create the debugfs file that we can use to
1500 * inspect a port's state at any time
1502 snprintf(debugfs_name, sizeof(debugfs_name), "vport%up%u",
1503 port->portdev->vdev->index, id);
1504 port->debugfs_file = debugfs_create_file(debugfs_name, 0444,
1505 pdrvdata.debugfs_dir,
1513 device_destroy(pdrvdata.class, port->dev->devt);
1515 cdev_del(port->cdev);
1519 /* The host might want to notify management sw about port add failure */
1520 __send_control_msg(portdev, id, VIRTIO_CONSOLE_PORT_READY, 0);
1524 /* No users remain, remove all port-specific data. */
1525 static void remove_port(struct kref *kref)
1529 port = container_of(kref, struct port, kref);
1534 static void remove_port_data(struct port *port)
1536 spin_lock_irq(&port->inbuf_lock);
1537 /* Remove unused data this port might have received. */
1538 discard_port_data(port);
1539 spin_unlock_irq(&port->inbuf_lock);
1541 spin_lock_irq(&port->outvq_lock);
1542 reclaim_consumed_buffers(port);
1543 spin_unlock_irq(&port->outvq_lock);
1547 * Port got unplugged. Remove port from portdev's list and drop the
1548 * kref reference. If no userspace has this port opened, it will
1549 * result in immediate removal the port.
1551 static void unplug_port(struct port *port)
1553 spin_lock_irq(&port->portdev->ports_lock);
1554 list_del(&port->list);
1555 spin_unlock_irq(&port->portdev->ports_lock);
1557 spin_lock_irq(&port->inbuf_lock);
1558 if (port->guest_connected) {
1559 /* Let the app know the port is going down. */
1560 send_sigio_to_port(port);
1562 /* Do this after sigio is actually sent */
1563 port->guest_connected = false;
1564 port->host_connected = false;
1566 wake_up_interruptible(&port->waitqueue);
1568 spin_unlock_irq(&port->inbuf_lock);
1570 if (is_console_port(port)) {
1571 spin_lock_irq(&pdrvdata_lock);
1572 list_del(&port->cons.list);
1573 spin_unlock_irq(&pdrvdata_lock);
1574 hvc_remove(port->cons.hvc);
1577 remove_port_data(port);
1580 * We should just assume the device itself has gone off --
1581 * else a close on an open port later will try to send out a
1584 port->portdev = NULL;
1586 sysfs_remove_group(&port->dev->kobj, &port_attribute_group);
1587 device_destroy(pdrvdata.class, port->dev->devt);
1588 cdev_del(port->cdev);
1590 debugfs_remove(port->debugfs_file);
1594 * Locks around here are not necessary - a port can't be
1595 * opened after we removed the port struct from ports_list
1598 kref_put(&port->kref, remove_port);
1601 /* Any private messages that the Host and Guest want to share */
1602 static void handle_control_message(struct virtio_device *vdev,
1603 struct ports_device *portdev,
1604 struct port_buffer *buf)
1606 struct virtio_console_control *cpkt;
1611 cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
1613 port = find_port_by_id(portdev, virtio32_to_cpu(vdev, cpkt->id));
1615 cpkt->event != cpu_to_virtio16(vdev, VIRTIO_CONSOLE_PORT_ADD)) {
1616 /* No valid header at start of buffer. Drop it. */
1617 dev_dbg(&portdev->vdev->dev,
1618 "Invalid index %u in control packet\n", cpkt->id);
1622 switch (virtio16_to_cpu(vdev, cpkt->event)) {
1623 case VIRTIO_CONSOLE_PORT_ADD:
1625 dev_dbg(&portdev->vdev->dev,
1626 "Port %u already added\n", port->id);
1627 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1630 if (virtio32_to_cpu(vdev, cpkt->id) >=
1631 portdev->config.max_nr_ports) {
1632 dev_warn(&portdev->vdev->dev,
1633 "Request for adding port with "
1634 "out-of-bound id %u, max. supported id: %u\n",
1635 cpkt->id, portdev->config.max_nr_ports - 1);
1638 add_port(portdev, virtio32_to_cpu(vdev, cpkt->id));
1640 case VIRTIO_CONSOLE_PORT_REMOVE:
1643 case VIRTIO_CONSOLE_CONSOLE_PORT:
1646 if (is_console_port(port))
1649 init_port_console(port);
1650 complete(&early_console_added);
1652 * Could remove the port here in case init fails - but
1653 * have to notify the host first.
1656 case VIRTIO_CONSOLE_RESIZE: {
1662 if (!is_console_port(port))
1665 memcpy(&size, buf->buf + buf->offset + sizeof(*cpkt),
1667 set_console_size(port, size.rows, size.cols);
1669 port->cons.hvc->irq_requested = 1;
1670 resize_console(port);
1673 case VIRTIO_CONSOLE_PORT_OPEN:
1674 port->host_connected = virtio16_to_cpu(vdev, cpkt->value);
1675 wake_up_interruptible(&port->waitqueue);
1677 * If the host port got closed and the host had any
1678 * unconsumed buffers, we'll be able to reclaim them
1681 spin_lock_irq(&port->outvq_lock);
1682 reclaim_consumed_buffers(port);
1683 spin_unlock_irq(&port->outvq_lock);
1686 * If the guest is connected, it'll be interested in
1687 * knowing the host connection state changed.
1689 spin_lock_irq(&port->inbuf_lock);
1690 send_sigio_to_port(port);
1691 spin_unlock_irq(&port->inbuf_lock);
1693 case VIRTIO_CONSOLE_PORT_NAME:
1695 * If we woke up after hibernation, we can get this
1696 * again. Skip it in that case.
1702 * Skip the size of the header and the cpkt to get the size
1703 * of the name that was sent
1705 name_size = buf->len - buf->offset - sizeof(*cpkt) + 1;
1707 port->name = kmalloc(name_size, GFP_KERNEL);
1710 "Not enough space to store port name\n");
1713 strncpy(port->name, buf->buf + buf->offset + sizeof(*cpkt),
1715 port->name[name_size - 1] = 0;
1718 * Since we only have one sysfs attribute, 'name',
1719 * create it only if we have a name for the port.
1721 err = sysfs_create_group(&port->dev->kobj,
1722 &port_attribute_group);
1725 "Error %d creating sysfs device attributes\n",
1729 * Generate a udev event so that appropriate
1730 * symlinks can be created based on udev
1733 kobject_uevent(&port->dev->kobj, KOBJ_CHANGE);
1739 static void control_work_handler(struct work_struct *work)
1741 struct ports_device *portdev;
1742 struct virtqueue *vq;
1743 struct port_buffer *buf;
1746 portdev = container_of(work, struct ports_device, control_work);
1747 vq = portdev->c_ivq;
1749 spin_lock(&portdev->c_ivq_lock);
1750 while ((buf = virtqueue_get_buf(vq, &len))) {
1751 spin_unlock(&portdev->c_ivq_lock);
1756 handle_control_message(vq->vdev, portdev, buf);
1758 spin_lock(&portdev->c_ivq_lock);
1759 if (add_inbuf(portdev->c_ivq, buf) < 0) {
1760 dev_warn(&portdev->vdev->dev,
1761 "Error adding buffer to queue\n");
1762 free_buf(buf, false);
1765 spin_unlock(&portdev->c_ivq_lock);
1768 static void flush_bufs(struct virtqueue *vq, bool can_sleep)
1770 struct port_buffer *buf;
1773 while ((buf = virtqueue_get_buf(vq, &len)))
1774 free_buf(buf, can_sleep);
1777 static void out_intr(struct virtqueue *vq)
1781 port = find_port_by_vq(vq->vdev->priv, vq);
1783 flush_bufs(vq, false);
1787 wake_up_interruptible(&port->waitqueue);
1790 static void in_intr(struct virtqueue *vq)
1793 unsigned long flags;
1795 port = find_port_by_vq(vq->vdev->priv, vq);
1797 flush_bufs(vq, false);
1801 spin_lock_irqsave(&port->inbuf_lock, flags);
1802 port->inbuf = get_inbuf(port);
1805 * Normally the port should not accept data when the port is
1806 * closed. For generic serial ports, the host won't (shouldn't)
1807 * send data till the guest is connected. But this condition
1808 * can be reached when a console port is not yet connected (no
1809 * tty is spawned) and the other side sends out data over the
1810 * vring, or when a remote devices start sending data before
1811 * the ports are opened.
1813 * A generic serial port will discard data if not connected,
1814 * while console ports and rproc-serial ports accepts data at
1815 * any time. rproc-serial is initiated with guest_connected to
1816 * false because port_fops_open expects this. Console ports are
1817 * hooked up with an HVC console and is initialized with
1818 * guest_connected to true.
1821 if (!port->guest_connected && !is_rproc_serial(port->portdev->vdev))
1822 discard_port_data(port);
1824 /* Send a SIGIO indicating new data in case the process asked for it */
1825 send_sigio_to_port(port);
1827 spin_unlock_irqrestore(&port->inbuf_lock, flags);
1829 wake_up_interruptible(&port->waitqueue);
1831 if (is_console_port(port) && hvc_poll(port->cons.hvc))
1835 static void control_intr(struct virtqueue *vq)
1837 struct ports_device *portdev;
1839 portdev = vq->vdev->priv;
1840 schedule_work(&portdev->control_work);
1843 static void config_intr(struct virtio_device *vdev)
1845 struct ports_device *portdev;
1847 portdev = vdev->priv;
1849 if (!use_multiport(portdev))
1850 schedule_work(&portdev->config_work);
1853 static void config_work_handler(struct work_struct *work)
1855 struct ports_device *portdev;
1857 portdev = container_of(work, struct ports_device, config_work);
1858 if (!use_multiport(portdev)) {
1859 struct virtio_device *vdev;
1863 vdev = portdev->vdev;
1864 virtio_cread(vdev, struct virtio_console_config, cols, &cols);
1865 virtio_cread(vdev, struct virtio_console_config, rows, &rows);
1867 port = find_port_by_id(portdev, 0);
1868 set_console_size(port, rows, cols);
1871 * We'll use this way of resizing only for legacy
1872 * support. For newer userspace
1873 * (VIRTIO_CONSOLE_F_MULTPORT+), use control messages
1874 * to indicate console size changes so that it can be
1877 resize_console(port);
1881 static int init_vqs(struct ports_device *portdev)
1883 vq_callback_t **io_callbacks;
1885 struct virtqueue **vqs;
1886 u32 i, j, nr_ports, nr_queues;
1889 nr_ports = portdev->config.max_nr_ports;
1890 nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
1892 vqs = kmalloc(nr_queues * sizeof(struct virtqueue *), GFP_KERNEL);
1893 io_callbacks = kmalloc(nr_queues * sizeof(vq_callback_t *), GFP_KERNEL);
1894 io_names = kmalloc(nr_queues * sizeof(char *), GFP_KERNEL);
1895 portdev->in_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1897 portdev->out_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1899 if (!vqs || !io_callbacks || !io_names || !portdev->in_vqs ||
1900 !portdev->out_vqs) {
1906 * For backward compat (newer host but older guest), the host
1907 * spawns a console port first and also inits the vqs for port
1911 io_callbacks[j] = in_intr;
1912 io_callbacks[j + 1] = out_intr;
1913 io_names[j] = "input";
1914 io_names[j + 1] = "output";
1917 if (use_multiport(portdev)) {
1918 io_callbacks[j] = control_intr;
1919 io_callbacks[j + 1] = NULL;
1920 io_names[j] = "control-i";
1921 io_names[j + 1] = "control-o";
1923 for (i = 1; i < nr_ports; i++) {
1925 io_callbacks[j] = in_intr;
1926 io_callbacks[j + 1] = out_intr;
1927 io_names[j] = "input";
1928 io_names[j + 1] = "output";
1931 /* Find the queues. */
1932 err = portdev->vdev->config->find_vqs(portdev->vdev, nr_queues, vqs,
1934 (const char **)io_names);
1939 portdev->in_vqs[0] = vqs[0];
1940 portdev->out_vqs[0] = vqs[1];
1942 if (use_multiport(portdev)) {
1943 portdev->c_ivq = vqs[j];
1944 portdev->c_ovq = vqs[j + 1];
1946 for (i = 1; i < nr_ports; i++) {
1948 portdev->in_vqs[i] = vqs[j];
1949 portdev->out_vqs[i] = vqs[j + 1];
1953 kfree(io_callbacks);
1959 kfree(portdev->out_vqs);
1960 kfree(portdev->in_vqs);
1962 kfree(io_callbacks);
1968 static const struct file_operations portdev_fops = {
1969 .owner = THIS_MODULE,
1972 static void remove_vqs(struct ports_device *portdev)
1974 struct virtqueue *vq;
1976 virtio_device_for_each_vq(portdev->vdev, vq) {
1977 struct port_buffer *buf;
1979 flush_bufs(vq, true);
1980 while ((buf = virtqueue_detach_unused_buf(vq)))
1981 free_buf(buf, true);
1983 portdev->vdev->config->del_vqs(portdev->vdev);
1984 kfree(portdev->in_vqs);
1985 kfree(portdev->out_vqs);
1988 static void remove_controlq_data(struct ports_device *portdev)
1990 struct port_buffer *buf;
1993 if (!use_multiport(portdev))
1996 while ((buf = virtqueue_get_buf(portdev->c_ivq, &len)))
1997 free_buf(buf, true);
1999 while ((buf = virtqueue_detach_unused_buf(portdev->c_ivq)))
2000 free_buf(buf, true);
2004 * Once we're further in boot, we get probed like any other virtio
2007 * If the host also supports multiple console ports, we check the
2008 * config space to see how many ports the host has spawned. We
2009 * initialize each port found.
2011 static int virtcons_probe(struct virtio_device *vdev)
2013 struct ports_device *portdev;
2016 bool early = early_put_chars != NULL;
2018 /* We only need a config space if features are offered */
2019 if (!vdev->config->get &&
2020 (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE)
2021 || virtio_has_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT))) {
2022 dev_err(&vdev->dev, "%s failure: config access disabled\n",
2027 /* Ensure to read early_put_chars now */
2030 portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
2036 /* Attach this portdev to this virtio_device, and vice-versa. */
2037 portdev->vdev = vdev;
2038 vdev->priv = portdev;
2040 portdev->chr_major = register_chrdev(0, "virtio-portsdev",
2042 if (portdev->chr_major < 0) {
2044 "Error %d registering chrdev for device %u\n",
2045 portdev->chr_major, vdev->index);
2046 err = portdev->chr_major;
2051 portdev->config.max_nr_ports = 1;
2053 /* Don't test MULTIPORT at all if we're rproc: not a valid feature! */
2054 if (!is_rproc_serial(vdev) &&
2055 virtio_cread_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT,
2056 struct virtio_console_config, max_nr_ports,
2057 &portdev->config.max_nr_ports) == 0) {
2061 err = init_vqs(portdev);
2063 dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
2067 spin_lock_init(&portdev->ports_lock);
2068 INIT_LIST_HEAD(&portdev->ports);
2070 virtio_device_ready(portdev->vdev);
2072 INIT_WORK(&portdev->config_work, &config_work_handler);
2073 INIT_WORK(&portdev->control_work, &control_work_handler);
2076 unsigned int nr_added_bufs;
2078 spin_lock_init(&portdev->c_ivq_lock);
2079 spin_lock_init(&portdev->c_ovq_lock);
2081 nr_added_bufs = fill_queue(portdev->c_ivq,
2082 &portdev->c_ivq_lock);
2083 if (!nr_added_bufs) {
2085 "Error allocating buffers for control queue\n");
2091 * For backward compatibility: Create a console port
2092 * if we're running on older host.
2094 add_port(portdev, 0);
2097 spin_lock_irq(&pdrvdata_lock);
2098 list_add_tail(&portdev->list, &pdrvdata.portdevs);
2099 spin_unlock_irq(&pdrvdata_lock);
2101 __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
2102 VIRTIO_CONSOLE_DEVICE_READY, 1);
2105 * If there was an early virtio console, assume that there are no
2106 * other consoles. We need to wait until the hvc_alloc matches the
2107 * hvc_instantiate, otherwise tty_open will complain, resulting in
2108 * a "Warning: unable to open an initial console" boot failure.
2109 * Without multiport this is done in add_port above. With multiport
2110 * this might take some host<->guest communication - thus we have to
2113 if (multiport && early)
2114 wait_for_completion(&early_console_added);
2119 /* The host might want to notify mgmt sw about device add failure */
2120 __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
2121 VIRTIO_CONSOLE_DEVICE_READY, 0);
2122 remove_vqs(portdev);
2124 unregister_chrdev(portdev->chr_major, "virtio-portsdev");
2131 static void virtcons_remove(struct virtio_device *vdev)
2133 struct ports_device *portdev;
2134 struct port *port, *port2;
2136 portdev = vdev->priv;
2138 spin_lock_irq(&pdrvdata_lock);
2139 list_del(&portdev->list);
2140 spin_unlock_irq(&pdrvdata_lock);
2142 /* Disable interrupts for vqs */
2143 vdev->config->reset(vdev);
2144 /* Finish up work that's lined up */
2145 if (use_multiport(portdev))
2146 cancel_work_sync(&portdev->control_work);
2148 cancel_work_sync(&portdev->config_work);
2150 list_for_each_entry_safe(port, port2, &portdev->ports, list)
2153 unregister_chrdev(portdev->chr_major, "virtio-portsdev");
2156 * When yanking out a device, we immediately lose the
2157 * (device-side) queues. So there's no point in keeping the
2158 * guest side around till we drop our final reference. This
2159 * also means that any ports which are in an open state will
2160 * have to just stop using the port, as the vqs are going
2163 remove_controlq_data(portdev);
2164 remove_vqs(portdev);
2168 static struct virtio_device_id id_table[] = {
2169 { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
2173 static unsigned int features[] = {
2174 VIRTIO_CONSOLE_F_SIZE,
2175 VIRTIO_CONSOLE_F_MULTIPORT,
2178 static struct virtio_device_id rproc_serial_id_table[] = {
2179 #if IS_ENABLED(CONFIG_REMOTEPROC)
2180 { VIRTIO_ID_RPROC_SERIAL, VIRTIO_DEV_ANY_ID },
2185 static unsigned int rproc_serial_features[] = {
2188 #ifdef CONFIG_PM_SLEEP
2189 static int virtcons_freeze(struct virtio_device *vdev)
2191 struct ports_device *portdev;
2194 portdev = vdev->priv;
2196 vdev->config->reset(vdev);
2198 virtqueue_disable_cb(portdev->c_ivq);
2199 cancel_work_sync(&portdev->control_work);
2200 cancel_work_sync(&portdev->config_work);
2202 * Once more: if control_work_handler() was running, it would
2203 * enable the cb as the last step.
2205 virtqueue_disable_cb(portdev->c_ivq);
2206 remove_controlq_data(portdev);
2208 list_for_each_entry(port, &portdev->ports, list) {
2209 virtqueue_disable_cb(port->in_vq);
2210 virtqueue_disable_cb(port->out_vq);
2212 * We'll ask the host later if the new invocation has
2213 * the port opened or closed.
2215 port->host_connected = false;
2216 remove_port_data(port);
2218 remove_vqs(portdev);
2223 static int virtcons_restore(struct virtio_device *vdev)
2225 struct ports_device *portdev;
2229 portdev = vdev->priv;
2231 ret = init_vqs(portdev);
2235 virtio_device_ready(portdev->vdev);
2237 if (use_multiport(portdev))
2238 fill_queue(portdev->c_ivq, &portdev->c_ivq_lock);
2240 list_for_each_entry(port, &portdev->ports, list) {
2241 port->in_vq = portdev->in_vqs[port->id];
2242 port->out_vq = portdev->out_vqs[port->id];
2244 fill_queue(port->in_vq, &port->inbuf_lock);
2246 /* Get port open/close status on the host */
2247 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
2250 * If a port was open at the time of suspending, we
2251 * have to let the host know that it's still open.
2253 if (port->guest_connected)
2254 send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
2260 static struct virtio_driver virtio_console = {
2261 .feature_table = features,
2262 .feature_table_size = ARRAY_SIZE(features),
2263 .driver.name = KBUILD_MODNAME,
2264 .driver.owner = THIS_MODULE,
2265 .id_table = id_table,
2266 .probe = virtcons_probe,
2267 .remove = virtcons_remove,
2268 .config_changed = config_intr,
2269 #ifdef CONFIG_PM_SLEEP
2270 .freeze = virtcons_freeze,
2271 .restore = virtcons_restore,
2275 static struct virtio_driver virtio_rproc_serial = {
2276 .feature_table = rproc_serial_features,
2277 .feature_table_size = ARRAY_SIZE(rproc_serial_features),
2278 .driver.name = "virtio_rproc_serial",
2279 .driver.owner = THIS_MODULE,
2280 .id_table = rproc_serial_id_table,
2281 .probe = virtcons_probe,
2282 .remove = virtcons_remove,
2285 static int __init init(void)
2289 pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
2290 if (IS_ERR(pdrvdata.class)) {
2291 err = PTR_ERR(pdrvdata.class);
2292 pr_err("Error %d creating virtio-ports class\n", err);
2296 pdrvdata.debugfs_dir = debugfs_create_dir("virtio-ports", NULL);
2297 if (!pdrvdata.debugfs_dir)
2298 pr_warning("Error creating debugfs dir for virtio-ports\n");
2299 INIT_LIST_HEAD(&pdrvdata.consoles);
2300 INIT_LIST_HEAD(&pdrvdata.portdevs);
2302 err = register_virtio_driver(&virtio_console);
2304 pr_err("Error %d registering virtio driver\n", err);
2307 err = register_virtio_driver(&virtio_rproc_serial);
2309 pr_err("Error %d registering virtio rproc serial driver\n",
2315 unregister_virtio_driver(&virtio_console);
2317 debugfs_remove_recursive(pdrvdata.debugfs_dir);
2318 class_destroy(pdrvdata.class);
2322 static void __exit fini(void)
2326 unregister_virtio_driver(&virtio_console);
2327 unregister_virtio_driver(&virtio_rproc_serial);
2329 class_destroy(pdrvdata.class);
2330 debugfs_remove_recursive(pdrvdata.debugfs_dir);
2335 MODULE_DEVICE_TABLE(virtio, id_table);
2336 MODULE_DESCRIPTION("Virtio console driver");
2337 MODULE_LICENSE("GPL");