]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/char/virtio_console.c
virtio: console: Send SIGIO on new data arrival on ports
[mirror_ubuntu-artful-kernel.git] / drivers / char / virtio_console.c
CommitLineData
a23ea924
RR
1/*
2 * Copyright (C) 2006, 2007, 2009 Rusty Russell, IBM Corporation
17634ba2 3 * Copyright (C) 2009, 2010 Red Hat, Inc.
31610434
RR
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
fb08bd27 19#include <linux/cdev.h>
d99393ef 20#include <linux/debugfs.h>
fb08bd27 21#include <linux/device.h>
31610434 22#include <linux/err.h>
2030fa49 23#include <linux/fs.h>
31610434 24#include <linux/init.h>
38edf58d 25#include <linux/list.h>
2030fa49
AS
26#include <linux/poll.h>
27#include <linux/sched.h>
5a0e3ad6 28#include <linux/slab.h>
38edf58d 29#include <linux/spinlock.h>
31610434
RR
30#include <linux/virtio.h>
31#include <linux/virtio_console.h>
2030fa49 32#include <linux/wait.h>
17634ba2 33#include <linux/workqueue.h>
31610434
RR
34#include "hvc_console.h"
35
38edf58d
AS
36/*
37 * This is a global struct for storing common data for all the devices
38 * this driver handles.
39 *
40 * Mainly, it has a linked list for all the consoles in one place so
41 * that callbacks from hvc for get_chars(), put_chars() work properly
42 * across multiple devices and multiple ports per device.
43 */
44struct ports_driver_data {
fb08bd27
AS
45 /* Used for registering chardevs */
46 struct class *class;
47
d99393ef
AS
48 /* Used for exporting per-port information to debugfs */
49 struct dentry *debugfs_dir;
50
6bdf2afd
AS
51 /* List of all the devices we're handling */
52 struct list_head portdevs;
53
fb08bd27
AS
54 /* Number of devices this driver is handling */
55 unsigned int index;
56
d8a02bd5
RR
57 /*
58 * This is used to keep track of the number of hvc consoles
59 * spawned by this driver. This number is given as the first
60 * argument to hvc_alloc(). To correctly map an initial
61 * console spawned via hvc_instantiate to the console being
62 * hooked up via hvc_alloc, we need to pass the same vtermno.
63 *
64 * We also just assume the first console being initialised was
65 * the first one that got used as the initial console.
66 */
67 unsigned int next_vtermno;
68
38edf58d
AS
69 /* All the console devices handled by this driver */
70 struct list_head consoles;
71};
72static struct ports_driver_data pdrvdata;
73
74DEFINE_SPINLOCK(pdrvdata_lock);
75
4f23c573
AS
76/* This struct holds information that's relevant only for console ports */
77struct console {
78 /* We'll place all consoles in a list in the pdrvdata struct */
79 struct list_head list;
80
81 /* The hvc device associated with this console port */
82 struct hvc_struct *hvc;
83
9778829c
AS
84 /* The size of the console */
85 struct winsize ws;
86
4f23c573
AS
87 /*
88 * This number identifies the number that we used to register
89 * with hvc in hvc_instantiate() and hvc_alloc(); this is the
90 * number passed on by the hvc callbacks to us to
91 * differentiate between the other console ports handled by
92 * this driver
93 */
94 u32 vtermno;
95};
96
fdb9a054
AS
97struct port_buffer {
98 char *buf;
99
100 /* size of the buffer in *buf above */
101 size_t size;
102
103 /* used length of the buffer */
104 size_t len;
105 /* offset in the buf from which to consume data */
106 size_t offset;
107};
108
17634ba2
AS
109/*
110 * This is a per-device struct that stores data common to all the
111 * ports for that device (vdev->priv).
112 */
113struct ports_device {
6bdf2afd
AS
114 /* Next portdev in the list, head is in the pdrvdata struct */
115 struct list_head list;
116
17634ba2
AS
117 /*
118 * Workqueue handlers where we process deferred work after
119 * notification
120 */
121 struct work_struct control_work;
122
123 struct list_head ports;
124
125 /* To protect the list of ports */
126 spinlock_t ports_lock;
127
128 /* To protect the vq operations for the control channel */
129 spinlock_t cvq_lock;
130
131 /* The current config space is stored here */
b99fa815 132 struct virtio_console_config config;
17634ba2
AS
133
134 /* The virtio device we're associated with */
135 struct virtio_device *vdev;
136
137 /*
138 * A couple of virtqueues for the control channel: one for
139 * guest->host transfers, one for host->guest transfers
140 */
141 struct virtqueue *c_ivq, *c_ovq;
142
143 /* Array of per-port IO virtqueues */
144 struct virtqueue **in_vqs, **out_vqs;
fb08bd27
AS
145
146 /* Used for numbering devices for sysfs and debugfs */
147 unsigned int drv_index;
148
149 /* Major number for this device. Ports will be created as minors. */
150 int chr_major;
17634ba2
AS
151};
152
1c85bf35 153/* This struct holds the per-port data */
21206ede 154struct port {
17634ba2
AS
155 /* Next port in the list, head is in the ports_device */
156 struct list_head list;
157
1c85bf35
AS
158 /* Pointer to the parent virtio_console device */
159 struct ports_device *portdev;
fdb9a054
AS
160
161 /* The current buffer from which data has to be fed to readers */
162 struct port_buffer *inbuf;
21206ede 163
203baab8
AS
164 /*
165 * To protect the operations on the in_vq associated with this
166 * port. Has to be a spinlock because it can be called from
167 * interrupt context (get_char()).
168 */
169 spinlock_t inbuf_lock;
170
cdfadfc1
AS
171 /* Protect the operations on the out_vq. */
172 spinlock_t outvq_lock;
173
1c85bf35
AS
174 /* The IO vqs for this port */
175 struct virtqueue *in_vq, *out_vq;
176
d99393ef
AS
177 /* File in the debugfs directory that exposes this port's information */
178 struct dentry *debugfs_file;
179
4f23c573
AS
180 /*
181 * The entries in this struct will be valid if this port is
182 * hooked up to an hvc console
183 */
184 struct console cons;
17634ba2 185
fb08bd27 186 /* Each port associates with a separate char device */
d22a6989 187 struct cdev *cdev;
fb08bd27
AS
188 struct device *dev;
189
b353a6b8
AS
190 /* Reference-counting to handle port hot-unplugs and file operations */
191 struct kref kref;
192
2030fa49
AS
193 /* A waitqueue for poll() or blocking read operations */
194 wait_queue_head_t waitqueue;
195
431edb8a
AS
196 /* The 'name' of the port that we expose via sysfs properties */
197 char *name;
198
3eae0ade
AS
199 /* We can notify apps of host connect / disconnect events via SIGIO */
200 struct fasync_struct *async_queue;
201
17634ba2
AS
202 /* The 'id' to identify the port with the Host */
203 u32 id;
2030fa49 204
cdfadfc1
AS
205 bool outvq_full;
206
2030fa49
AS
207 /* Is the host device open */
208 bool host_connected;
3c7969cc
AS
209
210 /* We should allow only one process to open a port */
211 bool guest_connected;
21206ede 212};
31610434 213
971f3390
RR
214/* This is the very early arch-specified put chars function. */
215static int (*early_put_chars)(u32, const char *, int);
216
38edf58d
AS
217static struct port *find_port_by_vtermno(u32 vtermno)
218{
219 struct port *port;
4f23c573 220 struct console *cons;
38edf58d
AS
221 unsigned long flags;
222
223 spin_lock_irqsave(&pdrvdata_lock, flags);
4f23c573
AS
224 list_for_each_entry(cons, &pdrvdata.consoles, list) {
225 if (cons->vtermno == vtermno) {
226 port = container_of(cons, struct port, cons);
38edf58d 227 goto out;
4f23c573 228 }
38edf58d
AS
229 }
230 port = NULL;
231out:
232 spin_unlock_irqrestore(&pdrvdata_lock, flags);
233 return port;
234}
235
04950cdf
AS
236static struct port *find_port_by_devt_in_portdev(struct ports_device *portdev,
237 dev_t dev)
238{
239 struct port *port;
240 unsigned long flags;
241
242 spin_lock_irqsave(&portdev->ports_lock, flags);
243 list_for_each_entry(port, &portdev->ports, list)
d22a6989 244 if (port->cdev->dev == dev)
04950cdf
AS
245 goto out;
246 port = NULL;
247out:
248 spin_unlock_irqrestore(&portdev->ports_lock, flags);
249
250 return port;
251}
252
253static struct port *find_port_by_devt(dev_t dev)
254{
255 struct ports_device *portdev;
256 struct port *port;
257 unsigned long flags;
258
259 spin_lock_irqsave(&pdrvdata_lock, flags);
260 list_for_each_entry(portdev, &pdrvdata.portdevs, list) {
261 port = find_port_by_devt_in_portdev(portdev, dev);
262 if (port)
263 goto out;
264 }
265 port = NULL;
266out:
267 spin_unlock_irqrestore(&pdrvdata_lock, flags);
268 return port;
269}
270
17634ba2
AS
271static struct port *find_port_by_id(struct ports_device *portdev, u32 id)
272{
273 struct port *port;
274 unsigned long flags;
275
276 spin_lock_irqsave(&portdev->ports_lock, flags);
277 list_for_each_entry(port, &portdev->ports, list)
278 if (port->id == id)
279 goto out;
280 port = NULL;
281out:
282 spin_unlock_irqrestore(&portdev->ports_lock, flags);
283
284 return port;
285}
286
203baab8
AS
287static struct port *find_port_by_vq(struct ports_device *portdev,
288 struct virtqueue *vq)
289{
290 struct port *port;
203baab8
AS
291 unsigned long flags;
292
17634ba2
AS
293 spin_lock_irqsave(&portdev->ports_lock, flags);
294 list_for_each_entry(port, &portdev->ports, list)
203baab8
AS
295 if (port->in_vq == vq || port->out_vq == vq)
296 goto out;
203baab8
AS
297 port = NULL;
298out:
17634ba2 299 spin_unlock_irqrestore(&portdev->ports_lock, flags);
203baab8
AS
300 return port;
301}
302
17634ba2
AS
303static bool is_console_port(struct port *port)
304{
305 if (port->cons.hvc)
306 return true;
307 return false;
308}
309
310static inline bool use_multiport(struct ports_device *portdev)
311{
312 /*
313 * This condition can be true when put_chars is called from
314 * early_init
315 */
316 if (!portdev->vdev)
317 return 0;
318 return portdev->vdev->features[0] & (1 << VIRTIO_CONSOLE_F_MULTIPORT);
319}
320
fdb9a054
AS
321static void free_buf(struct port_buffer *buf)
322{
323 kfree(buf->buf);
324 kfree(buf);
325}
326
327static struct port_buffer *alloc_buf(size_t buf_size)
328{
329 struct port_buffer *buf;
330
331 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
332 if (!buf)
333 goto fail;
334 buf->buf = kzalloc(buf_size, GFP_KERNEL);
335 if (!buf->buf)
336 goto free_buf;
337 buf->len = 0;
338 buf->offset = 0;
339 buf->size = buf_size;
340 return buf;
341
342free_buf:
343 kfree(buf);
344fail:
345 return NULL;
346}
347
a3cde449
AS
348/* Callers should take appropriate locks */
349static void *get_inbuf(struct port *port)
350{
351 struct port_buffer *buf;
352 struct virtqueue *vq;
353 unsigned int len;
354
355 vq = port->in_vq;
505b0451 356 buf = virtqueue_get_buf(vq, &len);
a3cde449
AS
357 if (buf) {
358 buf->len = len;
359 buf->offset = 0;
360 }
361 return buf;
362}
363
e27b5198
AS
364/*
365 * Create a scatter-gather list representing our input buffer and put
366 * it in the queue.
367 *
368 * Callers should take appropriate locks.
369 */
203baab8 370static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
e27b5198
AS
371{
372 struct scatterlist sg[1];
203baab8 373 int ret;
1c85bf35 374
e27b5198
AS
375 sg_init_one(sg, buf->buf, buf->size);
376
505b0451
MT
377 ret = virtqueue_add_buf(vq, sg, 0, 1, buf);
378 virtqueue_kick(vq);
203baab8
AS
379 return ret;
380}
381
88f251ac
AS
382/* Discard any unread data this port has. Callers lockers. */
383static void discard_port_data(struct port *port)
384{
385 struct port_buffer *buf;
386 struct virtqueue *vq;
387 unsigned int len;
d6933561 388 int ret;
88f251ac
AS
389
390 vq = port->in_vq;
391 if (port->inbuf)
392 buf = port->inbuf;
393 else
505b0451 394 buf = virtqueue_get_buf(vq, &len);
88f251ac 395
d6933561
AS
396 ret = 0;
397 while (buf) {
398 if (add_inbuf(vq, buf) < 0) {
399 ret++;
400 free_buf(buf);
401 }
505b0451 402 buf = virtqueue_get_buf(vq, &len);
88f251ac 403 }
88f251ac 404 port->inbuf = NULL;
d6933561
AS
405 if (ret)
406 dev_warn(port->dev, "Errors adding %d buffers back to vq\n",
407 ret);
88f251ac
AS
408}
409
203baab8
AS
410static bool port_has_data(struct port *port)
411{
412 unsigned long flags;
413 bool ret;
414
203baab8 415 spin_lock_irqsave(&port->inbuf_lock, flags);
d6933561 416 if (port->inbuf) {
203baab8 417 ret = true;
d6933561
AS
418 goto out;
419 }
420 port->inbuf = get_inbuf(port);
421 if (port->inbuf) {
422 ret = true;
423 goto out;
424 }
425 ret = false;
426out:
203baab8 427 spin_unlock_irqrestore(&port->inbuf_lock, flags);
203baab8
AS
428 return ret;
429}
430
3425e706
AS
431static ssize_t __send_control_msg(struct ports_device *portdev, u32 port_id,
432 unsigned int event, unsigned int value)
17634ba2
AS
433{
434 struct scatterlist sg[1];
435 struct virtio_console_control cpkt;
436 struct virtqueue *vq;
604b2ad7 437 unsigned int len;
17634ba2 438
3425e706 439 if (!use_multiport(portdev))
17634ba2
AS
440 return 0;
441
3425e706 442 cpkt.id = port_id;
17634ba2
AS
443 cpkt.event = event;
444 cpkt.value = value;
445
3425e706 446 vq = portdev->c_ovq;
17634ba2
AS
447
448 sg_init_one(sg, &cpkt, sizeof(cpkt));
505b0451
MT
449 if (virtqueue_add_buf(vq, sg, 1, 0, &cpkt) >= 0) {
450 virtqueue_kick(vq);
451 while (!virtqueue_get_buf(vq, &len))
17634ba2
AS
452 cpu_relax();
453 }
454 return 0;
455}
456
3425e706
AS
457static ssize_t send_control_msg(struct port *port, unsigned int event,
458 unsigned int value)
459{
84ec06c5
AS
460 /* Did the port get unplugged before userspace closed it? */
461 if (port->portdev)
462 return __send_control_msg(port->portdev, port->id, event, value);
463 return 0;
3425e706
AS
464}
465
cdfadfc1
AS
466/* Callers must take the port->outvq_lock */
467static void reclaim_consumed_buffers(struct port *port)
468{
469 void *buf;
470 unsigned int len;
471
472 while ((buf = virtqueue_get_buf(port->out_vq, &len))) {
473 kfree(buf);
474 port->outvq_full = false;
475 }
476}
477
478static ssize_t send_buf(struct port *port, void *in_buf, size_t in_count,
479 bool nonblock)
f997f00b
AS
480{
481 struct scatterlist sg[1];
482 struct virtqueue *out_vq;
483 ssize_t ret;
cdfadfc1 484 unsigned long flags;
f997f00b
AS
485 unsigned int len;
486
487 out_vq = port->out_vq;
488
cdfadfc1
AS
489 spin_lock_irqsave(&port->outvq_lock, flags);
490
491 reclaim_consumed_buffers(port);
492
f997f00b 493 sg_init_one(sg, in_buf, in_count);
505b0451 494 ret = virtqueue_add_buf(out_vq, sg, 1, 0, in_buf);
f997f00b
AS
495
496 /* Tell Host to go! */
505b0451 497 virtqueue_kick(out_vq);
f997f00b
AS
498
499 if (ret < 0) {
9ff4cfab 500 in_count = 0;
cdfadfc1 501 goto done;
f997f00b
AS
502 }
503
cdfadfc1
AS
504 if (ret == 0)
505 port->outvq_full = true;
506
507 if (nonblock)
508 goto done;
509
510 /*
511 * Wait till the host acknowledges it pushed out the data we
531295e6
AS
512 * sent. This is done for data from the hvc_console; the tty
513 * operations are performed with spinlocks held so we can't
514 * sleep here. An alternative would be to copy the data to a
515 * buffer and relax the spinning requirement. The downside is
516 * we need to kmalloc a GFP_ATOMIC buffer each time the
517 * console driver writes something out.
cdfadfc1 518 */
505b0451 519 while (!virtqueue_get_buf(out_vq, &len))
f997f00b 520 cpu_relax();
cdfadfc1
AS
521done:
522 spin_unlock_irqrestore(&port->outvq_lock, flags);
523 /*
524 * We're expected to return the amount of data we wrote -- all
525 * of it
526 */
9ff4cfab 527 return in_count;
f997f00b
AS
528}
529
203baab8
AS
530/*
531 * Give out the data that's requested from the buffer that we have
532 * queued up.
533 */
b766ceed
AS
534static ssize_t fill_readbuf(struct port *port, char *out_buf, size_t out_count,
535 bool to_user)
203baab8
AS
536{
537 struct port_buffer *buf;
538 unsigned long flags;
539
540 if (!out_count || !port_has_data(port))
541 return 0;
542
543 buf = port->inbuf;
b766ceed 544 out_count = min(out_count, buf->len - buf->offset);
203baab8 545
b766ceed
AS
546 if (to_user) {
547 ssize_t ret;
548
549 ret = copy_to_user(out_buf, buf->buf + buf->offset, out_count);
550 if (ret)
551 return -EFAULT;
552 } else {
553 memcpy(out_buf, buf->buf + buf->offset, out_count);
554 }
203baab8 555
203baab8
AS
556 buf->offset += out_count;
557
558 if (buf->offset == buf->len) {
559 /*
560 * We're done using all the data in this buffer.
561 * Re-queue so that the Host can send us more data.
562 */
563 spin_lock_irqsave(&port->inbuf_lock, flags);
564 port->inbuf = NULL;
565
566 if (add_inbuf(port->in_vq, buf) < 0)
fb08bd27 567 dev_warn(port->dev, "failed add_buf\n");
203baab8
AS
568
569 spin_unlock_irqrestore(&port->inbuf_lock, flags);
570 }
b766ceed 571 /* Return the number of bytes actually copied */
203baab8 572 return out_count;
e27b5198
AS
573}
574
2030fa49 575/* The condition that must be true for polling to end */
60caacd3 576static bool will_read_block(struct port *port)
2030fa49 577{
3709ea7a
AS
578 if (!port->guest_connected) {
579 /* Port got hot-unplugged. Let's exit. */
580 return false;
581 }
60caacd3 582 return !port_has_data(port) && port->host_connected;
2030fa49
AS
583}
584
cdfadfc1
AS
585static bool will_write_block(struct port *port)
586{
587 bool ret;
588
60e5e0b8
AS
589 if (!port->guest_connected) {
590 /* Port got hot-unplugged. Let's exit. */
591 return false;
592 }
cdfadfc1
AS
593 if (!port->host_connected)
594 return true;
595
596 spin_lock_irq(&port->outvq_lock);
597 /*
598 * Check if the Host has consumed any buffers since we last
599 * sent data (this is only applicable for nonblocking ports).
600 */
601 reclaim_consumed_buffers(port);
602 ret = port->outvq_full;
603 spin_unlock_irq(&port->outvq_lock);
604
605 return ret;
606}
607
2030fa49
AS
608static ssize_t port_fops_read(struct file *filp, char __user *ubuf,
609 size_t count, loff_t *offp)
610{
611 struct port *port;
612 ssize_t ret;
613
614 port = filp->private_data;
615
616 if (!port_has_data(port)) {
617 /*
618 * If nothing's connected on the host just return 0 in
619 * case of list_empty; this tells the userspace app
620 * that there's no connection
621 */
622 if (!port->host_connected)
623 return 0;
624 if (filp->f_flags & O_NONBLOCK)
625 return -EAGAIN;
626
627 ret = wait_event_interruptible(port->waitqueue,
60caacd3 628 !will_read_block(port));
2030fa49
AS
629 if (ret < 0)
630 return ret;
631 }
b3dddb9e
AS
632 /* Port got hot-unplugged. */
633 if (!port->guest_connected)
634 return -ENODEV;
2030fa49
AS
635 /*
636 * We could've received a disconnection message while we were
637 * waiting for more data.
638 *
639 * This check is not clubbed in the if() statement above as we
640 * might receive some data as well as the host could get
641 * disconnected after we got woken up from our wait. So we
642 * really want to give off whatever data we have and only then
643 * check for host_connected.
644 */
645 if (!port_has_data(port) && !port->host_connected)
646 return 0;
647
648 return fill_readbuf(port, ubuf, count, true);
649}
650
651static ssize_t port_fops_write(struct file *filp, const char __user *ubuf,
652 size_t count, loff_t *offp)
653{
654 struct port *port;
655 char *buf;
656 ssize_t ret;
cdfadfc1 657 bool nonblock;
2030fa49 658
65745422
AS
659 /* Userspace could be out to fool us */
660 if (!count)
661 return 0;
662
2030fa49
AS
663 port = filp->private_data;
664
cdfadfc1
AS
665 nonblock = filp->f_flags & O_NONBLOCK;
666
667 if (will_write_block(port)) {
668 if (nonblock)
669 return -EAGAIN;
670
671 ret = wait_event_interruptible(port->waitqueue,
672 !will_write_block(port));
673 if (ret < 0)
674 return ret;
675 }
f4028119
AS
676 /* Port got hot-unplugged. */
677 if (!port->guest_connected)
678 return -ENODEV;
cdfadfc1 679
2030fa49
AS
680 count = min((size_t)(32 * 1024), count);
681
682 buf = kmalloc(count, GFP_KERNEL);
683 if (!buf)
684 return -ENOMEM;
685
686 ret = copy_from_user(buf, ubuf, count);
687 if (ret) {
688 ret = -EFAULT;
689 goto free_buf;
690 }
691
531295e6
AS
692 /*
693 * We now ask send_buf() to not spin for generic ports -- we
694 * can re-use the same code path that non-blocking file
695 * descriptors take for blocking file descriptors since the
696 * wait is already done and we're certain the write will go
697 * through to the host.
698 */
699 nonblock = true;
cdfadfc1
AS
700 ret = send_buf(port, buf, count, nonblock);
701
702 if (nonblock && ret > 0)
703 goto out;
704
2030fa49
AS
705free_buf:
706 kfree(buf);
cdfadfc1 707out:
2030fa49
AS
708 return ret;
709}
710
711static unsigned int port_fops_poll(struct file *filp, poll_table *wait)
712{
713 struct port *port;
714 unsigned int ret;
715
716 port = filp->private_data;
717 poll_wait(filp, &port->waitqueue, wait);
718
8529a504
AS
719 if (!port->guest_connected) {
720 /* Port got unplugged */
721 return POLLHUP;
722 }
2030fa49 723 ret = 0;
6df7aadc 724 if (!will_read_block(port))
2030fa49 725 ret |= POLLIN | POLLRDNORM;
cdfadfc1 726 if (!will_write_block(port))
2030fa49
AS
727 ret |= POLLOUT;
728 if (!port->host_connected)
729 ret |= POLLHUP;
730
731 return ret;
732}
733
b353a6b8
AS
734static void remove_port(struct kref *kref);
735
2030fa49
AS
736static int port_fops_release(struct inode *inode, struct file *filp)
737{
738 struct port *port;
739
740 port = filp->private_data;
741
742 /* Notify host of port being closed */
743 send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
744
88f251ac 745 spin_lock_irq(&port->inbuf_lock);
3c7969cc
AS
746 port->guest_connected = false;
747
88f251ac
AS
748 discard_port_data(port);
749
750 spin_unlock_irq(&port->inbuf_lock);
751
cdfadfc1
AS
752 spin_lock_irq(&port->outvq_lock);
753 reclaim_consumed_buffers(port);
754 spin_unlock_irq(&port->outvq_lock);
755
b353a6b8
AS
756 /*
757 * Locks aren't necessary here as a port can't be opened after
758 * unplug, and if a port isn't unplugged, a kref would already
759 * exist for the port. Plus, taking ports_lock here would
760 * create a dependency on other locks taken by functions
761 * inside remove_port if we're the last holder of the port,
762 * creating many problems.
763 */
764 kref_put(&port->kref, remove_port);
765
2030fa49
AS
766 return 0;
767}
768
769static int port_fops_open(struct inode *inode, struct file *filp)
770{
771 struct cdev *cdev = inode->i_cdev;
772 struct port *port;
8ad37e83 773 int ret;
2030fa49 774
04950cdf 775 port = find_port_by_devt(cdev->dev);
2030fa49
AS
776 filp->private_data = port;
777
b353a6b8
AS
778 /* Prevent against a port getting hot-unplugged at the same time */
779 spin_lock_irq(&port->portdev->ports_lock);
780 kref_get(&port->kref);
781 spin_unlock_irq(&port->portdev->ports_lock);
782
2030fa49
AS
783 /*
784 * Don't allow opening of console port devices -- that's done
785 * via /dev/hvc
786 */
8ad37e83
AS
787 if (is_console_port(port)) {
788 ret = -ENXIO;
789 goto out;
790 }
2030fa49 791
3c7969cc
AS
792 /* Allow only one process to open a particular port at a time */
793 spin_lock_irq(&port->inbuf_lock);
794 if (port->guest_connected) {
795 spin_unlock_irq(&port->inbuf_lock);
8ad37e83
AS
796 ret = -EMFILE;
797 goto out;
3c7969cc
AS
798 }
799
800 port->guest_connected = true;
801 spin_unlock_irq(&port->inbuf_lock);
802
cdfadfc1
AS
803 spin_lock_irq(&port->outvq_lock);
804 /*
805 * There might be a chance that we missed reclaiming a few
806 * buffers in the window of the port getting previously closed
807 * and opening now.
808 */
809 reclaim_consumed_buffers(port);
810 spin_unlock_irq(&port->outvq_lock);
811
2030fa49
AS
812 /* Notify host of port being opened */
813 send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
814
815 return 0;
8ad37e83 816out:
b353a6b8 817 kref_put(&port->kref, remove_port);
8ad37e83 818 return ret;
2030fa49
AS
819}
820
3eae0ade
AS
821static int port_fops_fasync(int fd, struct file *filp, int mode)
822{
823 struct port *port;
824
825 port = filp->private_data;
826 return fasync_helper(fd, filp, mode, &port->async_queue);
827}
828
2030fa49
AS
829/*
830 * The file operations that we support: programs in the guest can open
831 * a console device, read from it, write to it, poll for data and
832 * close it. The devices are at
833 * /dev/vport<device number>p<port number>
834 */
835static const struct file_operations port_fops = {
836 .owner = THIS_MODULE,
837 .open = port_fops_open,
838 .read = port_fops_read,
839 .write = port_fops_write,
840 .poll = port_fops_poll,
841 .release = port_fops_release,
3eae0ade 842 .fasync = port_fops_fasync,
2030fa49
AS
843};
844
a23ea924
RR
845/*
846 * The put_chars() callback is pretty straightforward.
31610434 847 *
a23ea924
RR
848 * We turn the characters into a scatter-gather list, add it to the
849 * output queue and then kick the Host. Then we sit here waiting for
850 * it to finish: inefficient in theory, but in practice
851 * implementations will do it immediately (lguest's Launcher does).
852 */
31610434
RR
853static int put_chars(u32 vtermno, const char *buf, int count)
854{
21206ede 855 struct port *port;
38edf58d 856
162a689a
FD
857 if (unlikely(early_put_chars))
858 return early_put_chars(vtermno, buf, count);
859
38edf58d
AS
860 port = find_port_by_vtermno(vtermno);
861 if (!port)
6dc69f97 862 return -EPIPE;
31610434 863
cdfadfc1 864 return send_buf(port, (void *)buf, count, false);
31610434
RR
865}
866
a23ea924
RR
867/*
868 * get_chars() is the callback from the hvc_console infrastructure
869 * when an interrupt is received.
31610434 870 *
203baab8
AS
871 * We call out to fill_readbuf that gets us the required data from the
872 * buffers that are queued up.
a23ea924 873 */
31610434
RR
874static int get_chars(u32 vtermno, char *buf, int count)
875{
21206ede
RR
876 struct port *port;
877
6dc69f97
AS
878 /* If we've not set up the port yet, we have no input to give. */
879 if (unlikely(early_put_chars))
880 return 0;
881
38edf58d
AS
882 port = find_port_by_vtermno(vtermno);
883 if (!port)
6dc69f97 884 return -EPIPE;
21206ede 885
31610434 886 /* If we don't have an input queue yet, we can't get input. */
21206ede 887 BUG_ON(!port->in_vq);
31610434 888
b766ceed 889 return fill_readbuf(port, buf, count, false);
31610434 890}
31610434 891
cb06e367 892static void resize_console(struct port *port)
c2983458 893{
cb06e367 894 struct virtio_device *vdev;
c2983458 895
2de16a49 896 /* The port could have been hot-unplugged */
9778829c 897 if (!port || !is_console_port(port))
2de16a49
AS
898 return;
899
cb06e367 900 vdev = port->portdev->vdev;
9778829c
AS
901 if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE))
902 hvc_resize(port->cons.hvc, port->cons.ws);
c2983458
CB
903}
904
38edf58d 905/* We set the configuration at this point, since we now have a tty */
91fcad19
CB
906static int notifier_add_vio(struct hvc_struct *hp, int data)
907{
38edf58d
AS
908 struct port *port;
909
910 port = find_port_by_vtermno(hp->vtermno);
911 if (!port)
912 return -EINVAL;
913
91fcad19 914 hp->irq_requested = 1;
cb06e367 915 resize_console(port);
c2983458 916
91fcad19
CB
917 return 0;
918}
919
920static void notifier_del_vio(struct hvc_struct *hp, int data)
921{
922 hp->irq_requested = 0;
923}
924
17634ba2 925/* The operations for console ports. */
1dff3996 926static const struct hv_ops hv_ops = {
971f3390
RR
927 .get_chars = get_chars,
928 .put_chars = put_chars,
929 .notifier_add = notifier_add_vio,
930 .notifier_del = notifier_del_vio,
931 .notifier_hangup = notifier_del_vio,
932};
933
934/*
935 * Console drivers are initialized very early so boot messages can go
936 * out, so we do things slightly differently from the generic virtio
937 * initialization of the net and block drivers.
938 *
939 * At this stage, the console is output-only. It's too early to set
940 * up a virtqueue, so we let the drivers do some boutique early-output
941 * thing.
942 */
943int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
944{
945 early_put_chars = put_chars;
946 return hvc_instantiate(0, 0, &hv_ops);
947}
948
17634ba2 949int init_port_console(struct port *port)
cfa6d379
AS
950{
951 int ret;
952
953 /*
954 * The Host's telling us this port is a console port. Hook it
955 * up with an hvc console.
956 *
957 * To set up and manage our virtual console, we call
958 * hvc_alloc().
959 *
960 * The first argument of hvc_alloc() is the virtual console
961 * number. The second argument is the parameter for the
962 * notification mechanism (like irq number). We currently
963 * leave this as zero, virtqueues have implicit notifications.
964 *
965 * The third argument is a "struct hv_ops" containing the
966 * put_chars() get_chars(), notifier_add() and notifier_del()
967 * pointers. The final argument is the output buffer size: we
968 * can do any size, so we put PAGE_SIZE here.
969 */
970 port->cons.vtermno = pdrvdata.next_vtermno;
971
972 port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
973 if (IS_ERR(port->cons.hvc)) {
974 ret = PTR_ERR(port->cons.hvc);
298add72
AS
975 dev_err(port->dev,
976 "error %d allocating hvc for port\n", ret);
cfa6d379
AS
977 port->cons.hvc = NULL;
978 return ret;
979 }
980 spin_lock_irq(&pdrvdata_lock);
981 pdrvdata.next_vtermno++;
982 list_add_tail(&port->cons.list, &pdrvdata.consoles);
983 spin_unlock_irq(&pdrvdata_lock);
3c7969cc 984 port->guest_connected = true;
cfa6d379 985
1d05160b
AS
986 /*
987 * Start using the new console output if this is the first
988 * console to come up.
989 */
990 if (early_put_chars)
991 early_put_chars = NULL;
992
2030fa49
AS
993 /* Notify host of port being opened */
994 send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
995
cfa6d379
AS
996 return 0;
997}
998
431edb8a
AS
999static ssize_t show_port_name(struct device *dev,
1000 struct device_attribute *attr, char *buffer)
1001{
1002 struct port *port;
1003
1004 port = dev_get_drvdata(dev);
1005
1006 return sprintf(buffer, "%s\n", port->name);
1007}
1008
1009static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
1010
1011static struct attribute *port_sysfs_entries[] = {
1012 &dev_attr_name.attr,
1013 NULL
1014};
1015
1016static struct attribute_group port_attribute_group = {
1017 .name = NULL, /* put in device directory */
1018 .attrs = port_sysfs_entries,
1019};
1020
d99393ef
AS
1021static int debugfs_open(struct inode *inode, struct file *filp)
1022{
1023 filp->private_data = inode->i_private;
1024 return 0;
1025}
1026
1027static ssize_t debugfs_read(struct file *filp, char __user *ubuf,
1028 size_t count, loff_t *offp)
1029{
1030 struct port *port;
1031 char *buf;
1032 ssize_t ret, out_offset, out_count;
1033
1034 out_count = 1024;
1035 buf = kmalloc(out_count, GFP_KERNEL);
1036 if (!buf)
1037 return -ENOMEM;
1038
1039 port = filp->private_data;
1040 out_offset = 0;
1041 out_offset += snprintf(buf + out_offset, out_count,
1042 "name: %s\n", port->name ? port->name : "");
1043 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1044 "guest_connected: %d\n", port->guest_connected);
1045 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1046 "host_connected: %d\n", port->host_connected);
cdfadfc1
AS
1047 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1048 "outvq_full: %d\n", port->outvq_full);
d99393ef
AS
1049 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1050 "is_console: %s\n",
1051 is_console_port(port) ? "yes" : "no");
1052 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1053 "console_vtermno: %u\n", port->cons.vtermno);
1054
1055 ret = simple_read_from_buffer(ubuf, count, offp, buf, out_offset);
1056 kfree(buf);
1057 return ret;
1058}
1059
1060static const struct file_operations port_debugfs_ops = {
1061 .owner = THIS_MODULE,
1062 .open = debugfs_open,
1063 .read = debugfs_read,
1064};
1065
9778829c
AS
1066static void set_console_size(struct port *port, u16 rows, u16 cols)
1067{
1068 if (!port || !is_console_port(port))
1069 return;
1070
1071 port->cons.ws.ws_row = rows;
1072 port->cons.ws.ws_col = cols;
1073}
1074
c446f8fc
AS
1075static unsigned int fill_queue(struct virtqueue *vq, spinlock_t *lock)
1076{
1077 struct port_buffer *buf;
1078 unsigned int nr_added_bufs;
1079 int ret;
1080
1081 nr_added_bufs = 0;
1082 do {
1083 buf = alloc_buf(PAGE_SIZE);
1084 if (!buf)
1085 break;
1086
1087 spin_lock_irq(lock);
1088 ret = add_inbuf(vq, buf);
1089 if (ret < 0) {
1090 spin_unlock_irq(lock);
1091 free_buf(buf);
1092 break;
1093 }
1094 nr_added_bufs++;
1095 spin_unlock_irq(lock);
1096 } while (ret > 0);
1097
1098 return nr_added_bufs;
1099}
1100
3eae0ade
AS
1101static void send_sigio_to_port(struct port *port)
1102{
1103 if (port->async_queue && port->guest_connected)
1104 kill_fasync(&port->async_queue, SIGIO, POLL_OUT);
1105}
1106
c446f8fc
AS
1107static int add_port(struct ports_device *portdev, u32 id)
1108{
1109 char debugfs_name[16];
1110 struct port *port;
1111 struct port_buffer *buf;
1112 dev_t devt;
1113 unsigned int nr_added_bufs;
1114 int err;
1115
1116 port = kmalloc(sizeof(*port), GFP_KERNEL);
1117 if (!port) {
1118 err = -ENOMEM;
1119 goto fail;
1120 }
b353a6b8 1121 kref_init(&port->kref);
c446f8fc
AS
1122
1123 port->portdev = portdev;
1124 port->id = id;
1125
1126 port->name = NULL;
1127 port->inbuf = NULL;
1128 port->cons.hvc = NULL;
3eae0ade 1129 port->async_queue = NULL;
c446f8fc 1130
9778829c
AS
1131 port->cons.ws.ws_row = port->cons.ws.ws_col = 0;
1132
c446f8fc
AS
1133 port->host_connected = port->guest_connected = false;
1134
cdfadfc1
AS
1135 port->outvq_full = false;
1136
c446f8fc
AS
1137 port->in_vq = portdev->in_vqs[port->id];
1138 port->out_vq = portdev->out_vqs[port->id];
1139
d22a6989
AS
1140 port->cdev = cdev_alloc();
1141 if (!port->cdev) {
1142 dev_err(&port->portdev->vdev->dev, "Error allocating cdev\n");
1143 err = -ENOMEM;
1144 goto free_port;
1145 }
1146 port->cdev->ops = &port_fops;
c446f8fc
AS
1147
1148 devt = MKDEV(portdev->chr_major, id);
d22a6989 1149 err = cdev_add(port->cdev, devt, 1);
c446f8fc
AS
1150 if (err < 0) {
1151 dev_err(&port->portdev->vdev->dev,
1152 "Error %d adding cdev for port %u\n", err, id);
d22a6989 1153 goto free_cdev;
c446f8fc
AS
1154 }
1155 port->dev = device_create(pdrvdata.class, &port->portdev->vdev->dev,
1156 devt, port, "vport%up%u",
1157 port->portdev->drv_index, id);
1158 if (IS_ERR(port->dev)) {
1159 err = PTR_ERR(port->dev);
1160 dev_err(&port->portdev->vdev->dev,
1161 "Error %d creating device for port %u\n",
1162 err, id);
1163 goto free_cdev;
1164 }
1165
1166 spin_lock_init(&port->inbuf_lock);
cdfadfc1 1167 spin_lock_init(&port->outvq_lock);
c446f8fc
AS
1168 init_waitqueue_head(&port->waitqueue);
1169
1170 /* Fill the in_vq with buffers so the host can send us data. */
1171 nr_added_bufs = fill_queue(port->in_vq, &port->inbuf_lock);
1172 if (!nr_added_bufs) {
1173 dev_err(port->dev, "Error allocating inbufs\n");
1174 err = -ENOMEM;
1175 goto free_device;
1176 }
1177
1178 /*
1179 * If we're not using multiport support, this has to be a console port
1180 */
1181 if (!use_multiport(port->portdev)) {
1182 err = init_port_console(port);
1183 if (err)
1184 goto free_inbufs;
1185 }
1186
1187 spin_lock_irq(&portdev->ports_lock);
1188 list_add_tail(&port->list, &port->portdev->ports);
1189 spin_unlock_irq(&portdev->ports_lock);
1190
1191 /*
1192 * Tell the Host we're set so that it can send us various
1193 * configuration parameters for this port (eg, port name,
1194 * caching, whether this is a console port, etc.)
1195 */
1196 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1197
1198 if (pdrvdata.debugfs_dir) {
1199 /*
1200 * Finally, create the debugfs file that we can use to
1201 * inspect a port's state at any time
1202 */
1203 sprintf(debugfs_name, "vport%up%u",
1204 port->portdev->drv_index, id);
1205 port->debugfs_file = debugfs_create_file(debugfs_name, 0444,
1206 pdrvdata.debugfs_dir,
1207 port,
1208 &port_debugfs_ops);
1209 }
1210 return 0;
1211
1212free_inbufs:
1213 while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1214 free_buf(buf);
1215free_device:
1216 device_destroy(pdrvdata.class, port->dev->devt);
1217free_cdev:
d22a6989 1218 cdev_del(port->cdev);
c446f8fc
AS
1219free_port:
1220 kfree(port);
1221fail:
1222 /* The host might want to notify management sw about port add failure */
0643e4c6 1223 __send_control_msg(portdev, id, VIRTIO_CONSOLE_PORT_READY, 0);
c446f8fc
AS
1224 return err;
1225}
1226
b353a6b8
AS
1227/* No users remain, remove all port-specific data. */
1228static void remove_port(struct kref *kref)
1229{
1230 struct port *port;
1231
1232 port = container_of(kref, struct port, kref);
1233
1234 sysfs_remove_group(&port->dev->kobj, &port_attribute_group);
1235 device_destroy(pdrvdata.class, port->dev->devt);
1236 cdev_del(port->cdev);
1237
1238 kfree(port->name);
1239
1240 debugfs_remove(port->debugfs_file);
1241
1242 kfree(port);
1243}
1244
1245/*
1246 * Port got unplugged. Remove port from portdev's list and drop the
1247 * kref reference. If no userspace has this port opened, it will
1248 * result in immediate removal the port.
1249 */
1250static void unplug_port(struct port *port)
1f7aa42d 1251{
a9cdd485
AS
1252 struct port_buffer *buf;
1253
b353a6b8
AS
1254 spin_lock_irq(&port->portdev->ports_lock);
1255 list_del(&port->list);
1256 spin_unlock_irq(&port->portdev->ports_lock);
1257
0047634d
AS
1258 if (port->guest_connected) {
1259 port->guest_connected = false;
1260 port->host_connected = false;
1261 wake_up_interruptible(&port->waitqueue);
0047634d
AS
1262 }
1263
1f7aa42d
AS
1264 if (is_console_port(port)) {
1265 spin_lock_irq(&pdrvdata_lock);
1266 list_del(&port->cons.list);
1267 spin_unlock_irq(&pdrvdata_lock);
69eb9a9f
AS
1268#if 0
1269 /*
1270 * hvc_remove() not called as removing one hvc port
1271 * results in other hvc ports getting frozen.
1272 *
1273 * Once this is resolved in hvc, this functionality
1274 * will be enabled. Till that is done, the -EPIPE
1275 * return from get_chars() above will help
1276 * hvc_console.c to clean up on ports we remove here.
1277 */
1f7aa42d 1278 hvc_remove(port->cons.hvc);
69eb9a9f 1279#endif
1f7aa42d 1280 }
1f7aa42d 1281
a9cdd485 1282 /* Remove unused data this port might have received. */
1f7aa42d 1283 discard_port_data(port);
a9cdd485 1284
cdfadfc1
AS
1285 reclaim_consumed_buffers(port);
1286
a9cdd485 1287 /* Remove buffers we queued up for the Host to send us data in. */
505b0451 1288 while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
a9cdd485
AS
1289 free_buf(buf);
1290
b353a6b8
AS
1291 /*
1292 * We should just assume the device itself has gone off --
1293 * else a close on an open port later will try to send out a
1294 * control message.
1295 */
1296 port->portdev = NULL;
d99393ef 1297
b353a6b8
AS
1298 /*
1299 * Locks around here are not necessary - a port can't be
1300 * opened after we removed the port struct from ports_list
1301 * above.
1302 */
1303 kref_put(&port->kref, remove_port);
1f7aa42d
AS
1304}
1305
17634ba2
AS
1306/* Any private messages that the Host and Guest want to share */
1307static void handle_control_message(struct ports_device *portdev,
1308 struct port_buffer *buf)
1309{
1310 struct virtio_console_control *cpkt;
1311 struct port *port;
431edb8a
AS
1312 size_t name_size;
1313 int err;
17634ba2
AS
1314
1315 cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
1316
1317 port = find_port_by_id(portdev, cpkt->id);
f909f850 1318 if (!port && cpkt->event != VIRTIO_CONSOLE_PORT_ADD) {
17634ba2
AS
1319 /* No valid header at start of buffer. Drop it. */
1320 dev_dbg(&portdev->vdev->dev,
1321 "Invalid index %u in control packet\n", cpkt->id);
1322 return;
1323 }
1324
1325 switch (cpkt->event) {
f909f850
AS
1326 case VIRTIO_CONSOLE_PORT_ADD:
1327 if (port) {
1d05160b
AS
1328 dev_dbg(&portdev->vdev->dev,
1329 "Port %u already added\n", port->id);
f909f850
AS
1330 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1331 break;
1332 }
1333 if (cpkt->id >= portdev->config.max_nr_ports) {
1334 dev_warn(&portdev->vdev->dev,
1335 "Request for adding port with out-of-bound id %u, max. supported id: %u\n",
1336 cpkt->id, portdev->config.max_nr_ports - 1);
1337 break;
1338 }
1339 add_port(portdev, cpkt->id);
1340 break;
1341 case VIRTIO_CONSOLE_PORT_REMOVE:
b353a6b8 1342 unplug_port(port);
f909f850 1343 break;
17634ba2
AS
1344 case VIRTIO_CONSOLE_CONSOLE_PORT:
1345 if (!cpkt->value)
1346 break;
1347 if (is_console_port(port))
1348 break;
1349
1350 init_port_console(port);
1351 /*
1352 * Could remove the port here in case init fails - but
1353 * have to notify the host first.
1354 */
1355 break;
8345adbf
AS
1356 case VIRTIO_CONSOLE_RESIZE: {
1357 struct {
1358 __u16 rows;
1359 __u16 cols;
1360 } size;
1361
17634ba2
AS
1362 if (!is_console_port(port))
1363 break;
8345adbf
AS
1364
1365 memcpy(&size, buf->buf + buf->offset + sizeof(*cpkt),
1366 sizeof(size));
1367 set_console_size(port, size.rows, size.cols);
1368
17634ba2
AS
1369 port->cons.hvc->irq_requested = 1;
1370 resize_console(port);
1371 break;
8345adbf 1372 }
2030fa49
AS
1373 case VIRTIO_CONSOLE_PORT_OPEN:
1374 port->host_connected = cpkt->value;
1375 wake_up_interruptible(&port->waitqueue);
cdfadfc1
AS
1376 /*
1377 * If the host port got closed and the host had any
1378 * unconsumed buffers, we'll be able to reclaim them
1379 * now.
1380 */
1381 spin_lock_irq(&port->outvq_lock);
1382 reclaim_consumed_buffers(port);
1383 spin_unlock_irq(&port->outvq_lock);
3eae0ade
AS
1384
1385 /*
1386 * If the guest is connected, it'll be interested in
1387 * knowing the host connection state changed.
1388 */
1389 send_sigio_to_port(port);
2030fa49 1390 break;
431edb8a
AS
1391 case VIRTIO_CONSOLE_PORT_NAME:
1392 /*
1393 * Skip the size of the header and the cpkt to get the size
1394 * of the name that was sent
1395 */
1396 name_size = buf->len - buf->offset - sizeof(*cpkt) + 1;
1397
1398 port->name = kmalloc(name_size, GFP_KERNEL);
1399 if (!port->name) {
1400 dev_err(port->dev,
1401 "Not enough space to store port name\n");
1402 break;
1403 }
1404 strncpy(port->name, buf->buf + buf->offset + sizeof(*cpkt),
1405 name_size - 1);
1406 port->name[name_size - 1] = 0;
1407
1408 /*
1409 * Since we only have one sysfs attribute, 'name',
1410 * create it only if we have a name for the port.
1411 */
1412 err = sysfs_create_group(&port->dev->kobj,
1413 &port_attribute_group);
ec64213c 1414 if (err) {
431edb8a
AS
1415 dev_err(port->dev,
1416 "Error %d creating sysfs device attributes\n",
1417 err);
ec64213c
AS
1418 } else {
1419 /*
1420 * Generate a udev event so that appropriate
1421 * symlinks can be created based on udev
1422 * rules.
1423 */
1424 kobject_uevent(&port->dev->kobj, KOBJ_CHANGE);
1425 }
431edb8a 1426 break;
17634ba2
AS
1427 }
1428}
1429
1430static void control_work_handler(struct work_struct *work)
1431{
1432 struct ports_device *portdev;
1433 struct virtqueue *vq;
1434 struct port_buffer *buf;
1435 unsigned int len;
1436
1437 portdev = container_of(work, struct ports_device, control_work);
1438 vq = portdev->c_ivq;
1439
1440 spin_lock(&portdev->cvq_lock);
505b0451 1441 while ((buf = virtqueue_get_buf(vq, &len))) {
17634ba2
AS
1442 spin_unlock(&portdev->cvq_lock);
1443
1444 buf->len = len;
1445 buf->offset = 0;
1446
1447 handle_control_message(portdev, buf);
1448
1449 spin_lock(&portdev->cvq_lock);
1450 if (add_inbuf(portdev->c_ivq, buf) < 0) {
1451 dev_warn(&portdev->vdev->dev,
1452 "Error adding buffer to queue\n");
1453 free_buf(buf);
1454 }
1455 }
1456 spin_unlock(&portdev->cvq_lock);
1457}
1458
1459static void in_intr(struct virtqueue *vq)
1460{
1461 struct port *port;
1462 unsigned long flags;
1463
1464 port = find_port_by_vq(vq->vdev->priv, vq);
1465 if (!port)
1466 return;
1467
1468 spin_lock_irqsave(&port->inbuf_lock, flags);
d6933561
AS
1469 if (!port->inbuf)
1470 port->inbuf = get_inbuf(port);
17634ba2 1471
88f251ac
AS
1472 /*
1473 * Don't queue up data when port is closed. This condition
1474 * can be reached when a console port is not yet connected (no
1475 * tty is spawned) and the host sends out data to console
1476 * ports. For generic serial ports, the host won't
1477 * (shouldn't) send data till the guest is connected.
1478 */
1479 if (!port->guest_connected)
1480 discard_port_data(port);
1481
17634ba2
AS
1482 spin_unlock_irqrestore(&port->inbuf_lock, flags);
1483
2030fa49
AS
1484 wake_up_interruptible(&port->waitqueue);
1485
55f6bcce
AS
1486 /* Send a SIGIO indicating new data in case the process asked for it */
1487 send_sigio_to_port(port);
1488
17634ba2
AS
1489 if (is_console_port(port) && hvc_poll(port->cons.hvc))
1490 hvc_kick();
1491}
1492
1493static void control_intr(struct virtqueue *vq)
1494{
1495 struct ports_device *portdev;
1496
1497 portdev = vq->vdev->priv;
1498 schedule_work(&portdev->control_work);
1499}
1500
7f5d810d
AS
1501static void config_intr(struct virtio_device *vdev)
1502{
1503 struct ports_device *portdev;
1504
1505 portdev = vdev->priv;
99f905f8 1506
4038f5b7 1507 if (!use_multiport(portdev)) {
9778829c
AS
1508 struct port *port;
1509 u16 rows, cols;
1510
1511 vdev->config->get(vdev,
1512 offsetof(struct virtio_console_config, cols),
1513 &cols, sizeof(u16));
1514 vdev->config->get(vdev,
1515 offsetof(struct virtio_console_config, rows),
1516 &rows, sizeof(u16));
1517
1518 port = find_port_by_id(portdev, 0);
1519 set_console_size(port, rows, cols);
1520
4038f5b7
AS
1521 /*
1522 * We'll use this way of resizing only for legacy
1523 * support. For newer userspace
1524 * (VIRTIO_CONSOLE_F_MULTPORT+), use control messages
1525 * to indicate console size changes so that it can be
1526 * done per-port.
1527 */
9778829c 1528 resize_console(port);
4038f5b7 1529 }
7f5d810d
AS
1530}
1531
2658a79a
AS
1532static int init_vqs(struct ports_device *portdev)
1533{
1534 vq_callback_t **io_callbacks;
1535 char **io_names;
1536 struct virtqueue **vqs;
17634ba2 1537 u32 i, j, nr_ports, nr_queues;
2658a79a
AS
1538 int err;
1539
17634ba2
AS
1540 nr_ports = portdev->config.max_nr_ports;
1541 nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
2658a79a
AS
1542
1543 vqs = kmalloc(nr_queues * sizeof(struct virtqueue *), GFP_KERNEL);
1544 if (!vqs) {
1545 err = -ENOMEM;
1546 goto fail;
1547 }
1548 io_callbacks = kmalloc(nr_queues * sizeof(vq_callback_t *), GFP_KERNEL);
1549 if (!io_callbacks) {
1550 err = -ENOMEM;
1551 goto free_vqs;
1552 }
1553 io_names = kmalloc(nr_queues * sizeof(char *), GFP_KERNEL);
1554 if (!io_names) {
1555 err = -ENOMEM;
1556 goto free_callbacks;
1557 }
1558 portdev->in_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1559 GFP_KERNEL);
1560 if (!portdev->in_vqs) {
1561 err = -ENOMEM;
1562 goto free_names;
1563 }
1564 portdev->out_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1565 GFP_KERNEL);
1566 if (!portdev->out_vqs) {
1567 err = -ENOMEM;
1568 goto free_invqs;
1569 }
1570
17634ba2
AS
1571 /*
1572 * For backward compat (newer host but older guest), the host
1573 * spawns a console port first and also inits the vqs for port
1574 * 0 before others.
1575 */
1576 j = 0;
1577 io_callbacks[j] = in_intr;
1578 io_callbacks[j + 1] = NULL;
1579 io_names[j] = "input";
1580 io_names[j + 1] = "output";
1581 j += 2;
1582
1583 if (use_multiport(portdev)) {
1584 io_callbacks[j] = control_intr;
1585 io_callbacks[j + 1] = NULL;
1586 io_names[j] = "control-i";
1587 io_names[j + 1] = "control-o";
1588
1589 for (i = 1; i < nr_ports; i++) {
1590 j += 2;
1591 io_callbacks[j] = in_intr;
1592 io_callbacks[j + 1] = NULL;
1593 io_names[j] = "input";
1594 io_names[j + 1] = "output";
1595 }
1596 }
2658a79a
AS
1597 /* Find the queues. */
1598 err = portdev->vdev->config->find_vqs(portdev->vdev, nr_queues, vqs,
1599 io_callbacks,
1600 (const char **)io_names);
1601 if (err)
1602 goto free_outvqs;
1603
17634ba2 1604 j = 0;
2658a79a
AS
1605 portdev->in_vqs[0] = vqs[0];
1606 portdev->out_vqs[0] = vqs[1];
17634ba2
AS
1607 j += 2;
1608 if (use_multiport(portdev)) {
1609 portdev->c_ivq = vqs[j];
1610 portdev->c_ovq = vqs[j + 1];
1611
1612 for (i = 1; i < nr_ports; i++) {
1613 j += 2;
1614 portdev->in_vqs[i] = vqs[j];
1615 portdev->out_vqs[i] = vqs[j + 1];
1616 }
1617 }
2658a79a
AS
1618 kfree(io_callbacks);
1619 kfree(io_names);
1620 kfree(vqs);
1621
1622 return 0;
1623
1624free_names:
1625 kfree(io_names);
1626free_callbacks:
1627 kfree(io_callbacks);
1628free_outvqs:
1629 kfree(portdev->out_vqs);
1630free_invqs:
1631 kfree(portdev->in_vqs);
1632free_vqs:
1633 kfree(vqs);
1634fail:
1635 return err;
1636}
1637
fb08bd27
AS
1638static const struct file_operations portdev_fops = {
1639 .owner = THIS_MODULE,
1640};
1641
1c85bf35
AS
1642/*
1643 * Once we're further in boot, we get probed like any other virtio
1644 * device.
17634ba2
AS
1645 *
1646 * If the host also supports multiple console ports, we check the
1647 * config space to see how many ports the host has spawned. We
1648 * initialize each port found.
1c85bf35
AS
1649 */
1650static int __devinit virtcons_probe(struct virtio_device *vdev)
1651{
1c85bf35
AS
1652 struct ports_device *portdev;
1653 int err;
17634ba2 1654 bool multiport;
1c85bf35
AS
1655
1656 portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
1657 if (!portdev) {
1658 err = -ENOMEM;
1659 goto fail;
1660 }
1661
1662 /* Attach this portdev to this virtio_device, and vice-versa. */
1663 portdev->vdev = vdev;
1664 vdev->priv = portdev;
1665
fb08bd27
AS
1666 spin_lock_irq(&pdrvdata_lock);
1667 portdev->drv_index = pdrvdata.index++;
1668 spin_unlock_irq(&pdrvdata_lock);
1669
1670 portdev->chr_major = register_chrdev(0, "virtio-portsdev",
1671 &portdev_fops);
1672 if (portdev->chr_major < 0) {
1673 dev_err(&vdev->dev,
1674 "Error %d registering chrdev for device %u\n",
1675 portdev->chr_major, portdev->drv_index);
1676 err = portdev->chr_major;
1677 goto free;
1678 }
1679
17634ba2 1680 multiport = false;
17634ba2
AS
1681 portdev->config.max_nr_ports = 1;
1682 if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT)) {
1683 multiport = true;
1684 vdev->features[0] |= 1 << VIRTIO_CONSOLE_F_MULTIPORT;
1685
b99fa815
AS
1686 vdev->config->get(vdev, offsetof(struct virtio_console_config,
1687 max_nr_ports),
17634ba2
AS
1688 &portdev->config.max_nr_ports,
1689 sizeof(portdev->config.max_nr_ports));
17634ba2
AS
1690 }
1691
1692 /* Let the Host know we support multiple ports.*/
1693 vdev->config->finalize_features(vdev);
1694
2658a79a
AS
1695 err = init_vqs(portdev);
1696 if (err < 0) {
1697 dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
fb08bd27 1698 goto free_chrdev;
2658a79a 1699 }
1c85bf35 1700
17634ba2
AS
1701 spin_lock_init(&portdev->ports_lock);
1702 INIT_LIST_HEAD(&portdev->ports);
1703
1704 if (multiport) {
335a64a5
AS
1705 unsigned int nr_added_bufs;
1706
17634ba2
AS
1707 spin_lock_init(&portdev->cvq_lock);
1708 INIT_WORK(&portdev->control_work, &control_work_handler);
1709
335a64a5
AS
1710 nr_added_bufs = fill_queue(portdev->c_ivq, &portdev->cvq_lock);
1711 if (!nr_added_bufs) {
22a29eac
AS
1712 dev_err(&vdev->dev,
1713 "Error allocating buffers for control queue\n");
1714 err = -ENOMEM;
1715 goto free_vqs;
1716 }
1d05160b
AS
1717 } else {
1718 /*
1719 * For backward compatibility: Create a console port
1720 * if we're running on older host.
1721 */
1722 add_port(portdev, 0);
17634ba2
AS
1723 }
1724
6bdf2afd
AS
1725 spin_lock_irq(&pdrvdata_lock);
1726 list_add_tail(&portdev->list, &pdrvdata.portdevs);
1727 spin_unlock_irq(&pdrvdata_lock);
1728
f909f850
AS
1729 __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1730 VIRTIO_CONSOLE_DEVICE_READY, 1);
31610434
RR
1731 return 0;
1732
22a29eac 1733free_vqs:
0643e4c6
JL
1734 /* The host might want to notify mgmt sw about device add failure */
1735 __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1736 VIRTIO_CONSOLE_DEVICE_READY, 0);
22a29eac
AS
1737 vdev->config->del_vqs(vdev);
1738 kfree(portdev->in_vqs);
1739 kfree(portdev->out_vqs);
fb08bd27
AS
1740free_chrdev:
1741 unregister_chrdev(portdev->chr_major, "virtio-portsdev");
31610434 1742free:
1c85bf35 1743 kfree(portdev);
31610434
RR
1744fail:
1745 return err;
1746}
1747
7177876f
AS
1748static void virtcons_remove(struct virtio_device *vdev)
1749{
1750 struct ports_device *portdev;
1751 struct port *port, *port2;
7177876f
AS
1752
1753 portdev = vdev->priv;
1754
6bdf2afd
AS
1755 spin_lock_irq(&pdrvdata_lock);
1756 list_del(&portdev->list);
1757 spin_unlock_irq(&pdrvdata_lock);
1758
02238959
AS
1759 /* Disable interrupts for vqs */
1760 vdev->config->reset(vdev);
1761 /* Finish up work that's lined up */
7177876f 1762 cancel_work_sync(&portdev->control_work);
7177876f
AS
1763
1764 list_for_each_entry_safe(port, port2, &portdev->ports, list)
b353a6b8 1765 unplug_port(port);
7177876f
AS
1766
1767 unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1768
e062013c
AS
1769 /*
1770 * When yanking out a device, we immediately lose the
1771 * (device-side) queues. So there's no point in keeping the
1772 * guest side around till we drop our final reference. This
1773 * also means that any ports which are in an open state will
1774 * have to just stop using the port, as the vqs are going
1775 * away.
1776 */
96eb872b
AS
1777 if (use_multiport(portdev)) {
1778 struct port_buffer *buf;
1779 unsigned int len;
7177876f 1780
96eb872b
AS
1781 while ((buf = virtqueue_get_buf(portdev->c_ivq, &len)))
1782 free_buf(buf);
1783
1784 while ((buf = virtqueue_detach_unused_buf(portdev->c_ivq)))
1785 free_buf(buf);
1786 }
7177876f
AS
1787
1788 vdev->config->del_vqs(vdev);
1789 kfree(portdev->in_vqs);
1790 kfree(portdev->out_vqs);
1791
1792 kfree(portdev);
1793}
1794
31610434
RR
1795static struct virtio_device_id id_table[] = {
1796 { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
1797 { 0 },
1798};
1799
c2983458
CB
1800static unsigned int features[] = {
1801 VIRTIO_CONSOLE_F_SIZE,
b99fa815 1802 VIRTIO_CONSOLE_F_MULTIPORT,
c2983458
CB
1803};
1804
31610434 1805static struct virtio_driver virtio_console = {
c2983458
CB
1806 .feature_table = features,
1807 .feature_table_size = ARRAY_SIZE(features),
31610434
RR
1808 .driver.name = KBUILD_MODNAME,
1809 .driver.owner = THIS_MODULE,
1810 .id_table = id_table,
1811 .probe = virtcons_probe,
7177876f 1812 .remove = virtcons_remove,
7f5d810d 1813 .config_changed = config_intr,
31610434
RR
1814};
1815
1816static int __init init(void)
1817{
fb08bd27
AS
1818 int err;
1819
1820 pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
1821 if (IS_ERR(pdrvdata.class)) {
1822 err = PTR_ERR(pdrvdata.class);
1823 pr_err("Error %d creating virtio-ports class\n", err);
1824 return err;
1825 }
d99393ef
AS
1826
1827 pdrvdata.debugfs_dir = debugfs_create_dir("virtio-ports", NULL);
1828 if (!pdrvdata.debugfs_dir) {
1829 pr_warning("Error %ld creating debugfs dir for virtio-ports\n",
1830 PTR_ERR(pdrvdata.debugfs_dir));
1831 }
38edf58d 1832 INIT_LIST_HEAD(&pdrvdata.consoles);
6bdf2afd 1833 INIT_LIST_HEAD(&pdrvdata.portdevs);
38edf58d 1834
31610434
RR
1835 return register_virtio_driver(&virtio_console);
1836}
7177876f
AS
1837
1838static void __exit fini(void)
1839{
1840 unregister_virtio_driver(&virtio_console);
1841
1842 class_destroy(pdrvdata.class);
1843 if (pdrvdata.debugfs_dir)
1844 debugfs_remove_recursive(pdrvdata.debugfs_dir);
1845}
31610434 1846module_init(init);
7177876f 1847module_exit(fini);
31610434
RR
1848
1849MODULE_DEVICE_TABLE(virtio, id_table);
1850MODULE_DESCRIPTION("Virtio console driver");
1851MODULE_LICENSE("GPL");