virtio: console: Send SIGIO to processes that request it for host events
[linux-2.6.git] / drivers / char / virtio_console.c
1 /*
2  * Copyright (C) 2006, 2007, 2009 Rusty Russell, IBM Corporation
3  * Copyright (C) 2009, 2010 Red Hat, Inc.
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  */
19 #include <linux/cdev.h>
20 #include <linux/debugfs.h>
21 #include <linux/device.h>
22 #include <linux/err.h>
23 #include <linux/fs.h>
24 #include <linux/init.h>
25 #include <linux/list.h>
26 #include <linux/poll.h>
27 #include <linux/sched.h>
28 #include <linux/slab.h>
29 #include <linux/spinlock.h>
30 #include <linux/virtio.h>
31 #include <linux/virtio_console.h>
32 #include <linux/wait.h>
33 #include <linux/workqueue.h>
34 #include "hvc_console.h"
35
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  */
44 struct ports_driver_data {
45         /* Used for registering chardevs */
46         struct class *class;
47
48         /* Used for exporting per-port information to debugfs */
49         struct dentry *debugfs_dir;
50
51         /* List of all the devices we're handling */
52         struct list_head portdevs;
53
54         /* Number of devices this driver is handling */
55         unsigned int index;
56
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
69         /* All the console devices handled by this driver */
70         struct list_head consoles;
71 };
72 static struct ports_driver_data pdrvdata;
73
74 DEFINE_SPINLOCK(pdrvdata_lock);
75
76 /* This struct holds information that's relevant only for console ports */
77 struct 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
84         /* The size of the console */
85         struct winsize ws;
86
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
97 struct 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
109 /*
110  * This is a per-device struct that stores data common to all the
111  * ports for that device (vdev->priv).
112  */
113 struct ports_device {
114         /* Next portdev in the list, head is in the pdrvdata struct */
115         struct list_head list;
116
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 */
132         struct virtio_console_config config;
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;
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;
151 };
152
153 /* This struct holds the per-port data */
154 struct port {
155         /* Next port in the list, head is in the ports_device */
156         struct list_head list;
157
158         /* Pointer to the parent virtio_console device */
159         struct ports_device *portdev;
160
161         /* The current buffer from which data has to be fed to readers */
162         struct port_buffer *inbuf;
163
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
171         /* Protect the operations on the out_vq. */
172         spinlock_t outvq_lock;
173
174         /* The IO vqs for this port */
175         struct virtqueue *in_vq, *out_vq;
176
177         /* File in the debugfs directory that exposes this port's information */
178         struct dentry *debugfs_file;
179
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;
185
186         /* Each port associates with a separate char device */
187         struct cdev *cdev;
188         struct device *dev;
189
190         /* Reference-counting to handle port hot-unplugs and file operations */
191         struct kref kref;
192
193         /* A waitqueue for poll() or blocking read operations */
194         wait_queue_head_t waitqueue;
195
196         /* The 'name' of the port that we expose via sysfs properties */
197         char *name;
198
199         /* We can notify apps of host connect / disconnect events via SIGIO */
200         struct fasync_struct *async_queue;
201
202         /* The 'id' to identify the port with the Host */
203         u32 id;
204
205         bool outvq_full;
206
207         /* Is the host device open */
208         bool host_connected;
209
210         /* We should allow only one process to open a port */
211         bool guest_connected;
212 };
213
214 /* This is the very early arch-specified put chars function. */
215 static int (*early_put_chars)(u32, const char *, int);
216
217 static struct port *find_port_by_vtermno(u32 vtermno)
218 {
219         struct port *port;
220         struct console *cons;
221         unsigned long flags;
222
223         spin_lock_irqsave(&pdrvdata_lock, flags);
224         list_for_each_entry(cons, &pdrvdata.consoles, list) {
225                 if (cons->vtermno == vtermno) {
226                         port = container_of(cons, struct port, cons);
227                         goto out;
228                 }
229         }
230         port = NULL;
231 out:
232         spin_unlock_irqrestore(&pdrvdata_lock, flags);
233         return port;
234 }
235
236 static 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)
244                 if (port->cdev->dev == dev)
245                         goto out;
246         port = NULL;
247 out:
248         spin_unlock_irqrestore(&portdev->ports_lock, flags);
249
250         return port;
251 }
252
253 static 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;
266 out:
267         spin_unlock_irqrestore(&pdrvdata_lock, flags);
268         return port;
269 }
270
271 static 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;
281 out:
282         spin_unlock_irqrestore(&portdev->ports_lock, flags);
283
284         return port;
285 }
286
287 static struct port *find_port_by_vq(struct ports_device *portdev,
288                                     struct virtqueue *vq)
289 {
290         struct port *port;
291         unsigned long flags;
292
293         spin_lock_irqsave(&portdev->ports_lock, flags);
294         list_for_each_entry(port, &portdev->ports, list)
295                 if (port->in_vq == vq || port->out_vq == vq)
296                         goto out;
297         port = NULL;
298 out:
299         spin_unlock_irqrestore(&portdev->ports_lock, flags);
300         return port;
301 }
302
303 static bool is_console_port(struct port *port)
304 {
305         if (port->cons.hvc)
306                 return true;
307         return false;
308 }
309
310 static 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
321 static void free_buf(struct port_buffer *buf)
322 {
323         kfree(buf->buf);
324         kfree(buf);
325 }
326
327 static 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
342 free_buf:
343         kfree(buf);
344 fail:
345         return NULL;
346 }
347
348 /* Callers should take appropriate locks */
349 static 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;
356         buf = virtqueue_get_buf(vq, &len);
357         if (buf) {
358                 buf->len = len;
359                 buf->offset = 0;
360         }
361         return buf;
362 }
363
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  */
370 static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
371 {
372         struct scatterlist sg[1];
373         int ret;
374
375         sg_init_one(sg, buf->buf, buf->size);
376
377         ret = virtqueue_add_buf(vq, sg, 0, 1, buf);
378         virtqueue_kick(vq);
379         return ret;
380 }
381
382 /* Discard any unread data this port has. Callers lockers. */
383 static void discard_port_data(struct port *port)
384 {
385         struct port_buffer *buf;
386         struct virtqueue *vq;
387         unsigned int len;
388         int ret;
389
390         vq = port->in_vq;
391         if (port->inbuf)
392                 buf = port->inbuf;
393         else
394                 buf = virtqueue_get_buf(vq, &len);
395
396         ret = 0;
397         while (buf) {
398                 if (add_inbuf(vq, buf) < 0) {
399                         ret++;
400                         free_buf(buf);
401                 }
402                 buf = virtqueue_get_buf(vq, &len);
403         }
404         port->inbuf = NULL;
405         if (ret)
406                 dev_warn(port->dev, "Errors adding %d buffers back to vq\n",
407                          ret);
408 }
409
410 static bool port_has_data(struct port *port)
411 {
412         unsigned long flags;
413         bool ret;
414
415         spin_lock_irqsave(&port->inbuf_lock, flags);
416         if (port->inbuf) {
417                 ret = true;
418                 goto out;
419         }
420         port->inbuf = get_inbuf(port);
421         if (port->inbuf) {
422                 ret = true;
423                 goto out;
424         }
425         ret = false;
426 out:
427         spin_unlock_irqrestore(&port->inbuf_lock, flags);
428         return ret;
429 }
430
431 static ssize_t __send_control_msg(struct ports_device *portdev, u32 port_id,
432                                   unsigned int event, unsigned int value)
433 {
434         struct scatterlist sg[1];
435         struct virtio_console_control cpkt;
436         struct virtqueue *vq;
437         unsigned int len;
438
439         if (!use_multiport(portdev))
440                 return 0;
441
442         cpkt.id = port_id;
443         cpkt.event = event;
444         cpkt.value = value;
445
446         vq = portdev->c_ovq;
447
448         sg_init_one(sg, &cpkt, sizeof(cpkt));
449         if (virtqueue_add_buf(vq, sg, 1, 0, &cpkt) >= 0) {
450                 virtqueue_kick(vq);
451                 while (!virtqueue_get_buf(vq, &len))
452                         cpu_relax();
453         }
454         return 0;
455 }
456
457 static ssize_t send_control_msg(struct port *port, unsigned int event,
458                                 unsigned int value)
459 {
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;
464 }
465
466 /* Callers must take the port->outvq_lock */
467 static 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
478 static ssize_t send_buf(struct port *port, void *in_buf, size_t in_count,
479                         bool nonblock)
480 {
481         struct scatterlist sg[1];
482         struct virtqueue *out_vq;
483         ssize_t ret;
484         unsigned long flags;
485         unsigned int len;
486
487         out_vq = port->out_vq;
488
489         spin_lock_irqsave(&port->outvq_lock, flags);
490
491         reclaim_consumed_buffers(port);
492
493         sg_init_one(sg, in_buf, in_count);
494         ret = virtqueue_add_buf(out_vq, sg, 1, 0, in_buf);
495
496         /* Tell Host to go! */
497         virtqueue_kick(out_vq);
498
499         if (ret < 0) {
500                 in_count = 0;
501                 goto done;
502         }
503
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
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.
518          */
519         while (!virtqueue_get_buf(out_vq, &len))
520                 cpu_relax();
521 done:
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          */
527         return in_count;
528 }
529
530 /*
531  * Give out the data that's requested from the buffer that we have
532  * queued up.
533  */
534 static ssize_t fill_readbuf(struct port *port, char *out_buf, size_t out_count,
535                             bool to_user)
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;
544         out_count = min(out_count, buf->len - buf->offset);
545
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         }
555
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)
567                         dev_warn(port->dev, "failed add_buf\n");
568
569                 spin_unlock_irqrestore(&port->inbuf_lock, flags);
570         }
571         /* Return the number of bytes actually copied */
572         return out_count;
573 }
574
575 /* The condition that must be true for polling to end */
576 static bool will_read_block(struct port *port)
577 {
578         if (!port->guest_connected) {
579                 /* Port got hot-unplugged. Let's exit. */
580                 return false;
581         }
582         return !port_has_data(port) && port->host_connected;
583 }
584
585 static bool will_write_block(struct port *port)
586 {
587         bool ret;
588
589         if (!port->guest_connected) {
590                 /* Port got hot-unplugged. Let's exit. */
591                 return false;
592         }
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
608 static 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,
628                                                !will_read_block(port));
629                 if (ret < 0)
630                         return ret;
631         }
632         /* Port got hot-unplugged. */
633         if (!port->guest_connected)
634                 return -ENODEV;
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
651 static 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;
657         bool nonblock;
658
659         /* Userspace could be out to fool us */
660         if (!count)
661                 return 0;
662
663         port = filp->private_data;
664
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         }
676         /* Port got hot-unplugged. */
677         if (!port->guest_connected)
678                 return -ENODEV;
679
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
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;
700         ret = send_buf(port, buf, count, nonblock);
701
702         if (nonblock && ret > 0)
703                 goto out;
704
705 free_buf:
706         kfree(buf);
707 out:
708         return ret;
709 }
710
711 static 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
719         if (!port->guest_connected) {
720                 /* Port got unplugged */
721                 return POLLHUP;
722         }
723         ret = 0;
724         if (!will_read_block(port))
725                 ret |= POLLIN | POLLRDNORM;
726         if (!will_write_block(port))
727                 ret |= POLLOUT;
728         if (!port->host_connected)
729                 ret |= POLLHUP;
730
731         return ret;
732 }
733
734 static void remove_port(struct kref *kref);
735
736 static 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
745         spin_lock_irq(&port->inbuf_lock);
746         port->guest_connected = false;
747
748         discard_port_data(port);
749
750         spin_unlock_irq(&port->inbuf_lock);
751
752         spin_lock_irq(&port->outvq_lock);
753         reclaim_consumed_buffers(port);
754         spin_unlock_irq(&port->outvq_lock);
755
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
766         return 0;
767 }
768
769 static int port_fops_open(struct inode *inode, struct file *filp)
770 {
771         struct cdev *cdev = inode->i_cdev;
772         struct port *port;
773         int ret;
774
775         port = find_port_by_devt(cdev->dev);
776         filp->private_data = port;
777
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
783         /*
784          * Don't allow opening of console port devices -- that's done
785          * via /dev/hvc
786          */
787         if (is_console_port(port)) {
788                 ret = -ENXIO;
789                 goto out;
790         }
791
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);
796                 ret = -EMFILE;
797                 goto out;
798         }
799
800         port->guest_connected = true;
801         spin_unlock_irq(&port->inbuf_lock);
802
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
812         /* Notify host of port being opened */
813         send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
814
815         return 0;
816 out:
817         kref_put(&port->kref, remove_port);
818         return ret;
819 }
820
821 static 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
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  */
835 static 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,
842         .fasync = port_fops_fasync,
843 };
844
845 /*
846  * The put_chars() callback is pretty straightforward.
847  *
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  */
853 static int put_chars(u32 vtermno, const char *buf, int count)
854 {
855         struct port *port;
856
857         if (unlikely(early_put_chars))
858                 return early_put_chars(vtermno, buf, count);
859
860         port = find_port_by_vtermno(vtermno);
861         if (!port)
862                 return -EPIPE;
863
864         return send_buf(port, (void *)buf, count, false);
865 }
866
867 /*
868  * get_chars() is the callback from the hvc_console infrastructure
869  * when an interrupt is received.
870  *
871  * We call out to fill_readbuf that gets us the required data from the
872  * buffers that are queued up.
873  */
874 static int get_chars(u32 vtermno, char *buf, int count)
875 {
876         struct port *port;
877
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
882         port = find_port_by_vtermno(vtermno);
883         if (!port)
884                 return -EPIPE;
885
886         /* If we don't have an input queue yet, we can't get input. */
887         BUG_ON(!port->in_vq);
888
889         return fill_readbuf(port, buf, count, false);
890 }
891
892 static void resize_console(struct port *port)
893 {
894         struct virtio_device *vdev;
895
896         /* The port could have been hot-unplugged */
897         if (!port || !is_console_port(port))
898                 return;
899
900         vdev = port->portdev->vdev;
901         if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE))
902                 hvc_resize(port->cons.hvc, port->cons.ws);
903 }
904
905 /* We set the configuration at this point, since we now have a tty */
906 static int notifier_add_vio(struct hvc_struct *hp, int data)
907 {
908         struct port *port;
909
910         port = find_port_by_vtermno(hp->vtermno);
911         if (!port)
912                 return -EINVAL;
913
914         hp->irq_requested = 1;
915         resize_console(port);
916
917         return 0;
918 }
919
920 static void notifier_del_vio(struct hvc_struct *hp, int data)
921 {
922         hp->irq_requested = 0;
923 }
924
925 /* The operations for console ports. */
926 static const struct hv_ops hv_ops = {
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  */
943 int __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
949 int init_port_console(struct port *port)
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);
975                 dev_err(port->dev,
976                         "error %d allocating hvc for port\n", ret);
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);
984         port->guest_connected = true;
985
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
993         /* Notify host of port being opened */
994         send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
995
996         return 0;
997 }
998
999 static 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
1009 static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
1010
1011 static struct attribute *port_sysfs_entries[] = {
1012         &dev_attr_name.attr,
1013         NULL
1014 };
1015
1016 static struct attribute_group port_attribute_group = {
1017         .name = NULL,           /* put in device directory */
1018         .attrs = port_sysfs_entries,
1019 };
1020
1021 static int debugfs_open(struct inode *inode, struct file *filp)
1022 {
1023         filp->private_data = inode->i_private;
1024         return 0;
1025 }
1026
1027 static 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);
1047         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1048                                "outvq_full: %d\n", port->outvq_full);
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
1060 static const struct file_operations port_debugfs_ops = {
1061         .owner = THIS_MODULE,
1062         .open  = debugfs_open,
1063         .read  = debugfs_read,
1064 };
1065
1066 static 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
1075 static 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
1101 static 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
1107 static 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         }
1121         kref_init(&port->kref);
1122
1123         port->portdev = portdev;
1124         port->id = id;
1125
1126         port->name = NULL;
1127         port->inbuf = NULL;
1128         port->cons.hvc = NULL;
1129         port->async_queue = NULL;
1130
1131         port->cons.ws.ws_row = port->cons.ws.ws_col = 0;
1132
1133         port->host_connected = port->guest_connected = false;
1134
1135         port->outvq_full = false;
1136
1137         port->in_vq = portdev->in_vqs[port->id];
1138         port->out_vq = portdev->out_vqs[port->id];
1139
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;
1147
1148         devt = MKDEV(portdev->chr_major, id);
1149         err = cdev_add(port->cdev, devt, 1);
1150         if (err < 0) {
1151                 dev_err(&port->portdev->vdev->dev,
1152                         "Error %d adding cdev for port %u\n", err, id);
1153                 goto free_cdev;
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);
1167         spin_lock_init(&port->outvq_lock);
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
1212 free_inbufs:
1213         while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1214                 free_buf(buf);
1215 free_device:
1216         device_destroy(pdrvdata.class, port->dev->devt);
1217 free_cdev:
1218         cdev_del(port->cdev);
1219 free_port:
1220         kfree(port);
1221 fail:
1222         /* The host might want to notify management sw about port add failure */
1223         __send_control_msg(portdev, id, VIRTIO_CONSOLE_PORT_READY, 0);
1224         return err;
1225 }
1226
1227 /* No users remain, remove all port-specific data. */
1228 static 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  */
1250 static void unplug_port(struct port *port)
1251 {
1252         struct port_buffer *buf;
1253
1254         spin_lock_irq(&port->portdev->ports_lock);
1255         list_del(&port->list);
1256         spin_unlock_irq(&port->portdev->ports_lock);
1257
1258         if (port->guest_connected) {
1259                 port->guest_connected = false;
1260                 port->host_connected = false;
1261                 wake_up_interruptible(&port->waitqueue);
1262         }
1263
1264         if (is_console_port(port)) {
1265                 spin_lock_irq(&pdrvdata_lock);
1266                 list_del(&port->cons.list);
1267                 spin_unlock_irq(&pdrvdata_lock);
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                  */
1278                 hvc_remove(port->cons.hvc);
1279 #endif
1280         }
1281
1282         /* Remove unused data this port might have received. */
1283         discard_port_data(port);
1284
1285         reclaim_consumed_buffers(port);
1286
1287         /* Remove buffers we queued up for the Host to send us data in. */
1288         while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1289                 free_buf(buf);
1290
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;
1297
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);
1304 }
1305
1306 /* Any private messages that the Host and Guest want to share */
1307 static void handle_control_message(struct ports_device *portdev,
1308                                    struct port_buffer *buf)
1309 {
1310         struct virtio_console_control *cpkt;
1311         struct port *port;
1312         size_t name_size;
1313         int err;
1314
1315         cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
1316
1317         port = find_port_by_id(portdev, cpkt->id);
1318         if (!port && cpkt->event != VIRTIO_CONSOLE_PORT_ADD) {
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) {
1326         case VIRTIO_CONSOLE_PORT_ADD:
1327                 if (port) {
1328                         dev_dbg(&portdev->vdev->dev,
1329                                 "Port %u already added\n", port->id);
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:
1342                 unplug_port(port);
1343                 break;
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;
1356         case VIRTIO_CONSOLE_RESIZE: {
1357                 struct {
1358                         __u16 rows;
1359                         __u16 cols;
1360                 } size;
1361
1362                 if (!is_console_port(port))
1363                         break;
1364
1365                 memcpy(&size, buf->buf + buf->offset + sizeof(*cpkt),
1366                        sizeof(size));
1367                 set_console_size(port, size.rows, size.cols);
1368
1369                 port->cons.hvc->irq_requested = 1;
1370                 resize_console(port);
1371                 break;
1372         }
1373         case VIRTIO_CONSOLE_PORT_OPEN:
1374                 port->host_connected = cpkt->value;
1375                 wake_up_interruptible(&port->waitqueue);
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);
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);
1390                 break;
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);
1414                 if (err) {
1415                         dev_err(port->dev,
1416                                 "Error %d creating sysfs device attributes\n",
1417                                 err);
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                 }
1426                 break;
1427         }
1428 }
1429
1430 static 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);
1441         while ((buf = virtqueue_get_buf(vq, &len))) {
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
1459 static 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);
1469         if (!port->inbuf)
1470                 port->inbuf = get_inbuf(port);
1471
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
1482         spin_unlock_irqrestore(&port->inbuf_lock, flags);
1483
1484         wake_up_interruptible(&port->waitqueue);
1485
1486         if (is_console_port(port) && hvc_poll(port->cons.hvc))
1487                 hvc_kick();
1488 }
1489
1490 static void control_intr(struct virtqueue *vq)
1491 {
1492         struct ports_device *portdev;
1493
1494         portdev = vq->vdev->priv;
1495         schedule_work(&portdev->control_work);
1496 }
1497
1498 static void config_intr(struct virtio_device *vdev)
1499 {
1500         struct ports_device *portdev;
1501
1502         portdev = vdev->priv;
1503
1504         if (!use_multiport(portdev)) {
1505                 struct port *port;
1506                 u16 rows, cols;
1507
1508                 vdev->config->get(vdev,
1509                                   offsetof(struct virtio_console_config, cols),
1510                                   &cols, sizeof(u16));
1511                 vdev->config->get(vdev,
1512                                   offsetof(struct virtio_console_config, rows),
1513                                   &rows, sizeof(u16));
1514
1515                 port = find_port_by_id(portdev, 0);
1516                 set_console_size(port, rows, cols);
1517
1518                 /*
1519                  * We'll use this way of resizing only for legacy
1520                  * support.  For newer userspace
1521                  * (VIRTIO_CONSOLE_F_MULTPORT+), use control messages
1522                  * to indicate console size changes so that it can be
1523                  * done per-port.
1524                  */
1525                 resize_console(port);
1526         }
1527 }
1528
1529 static int init_vqs(struct ports_device *portdev)
1530 {
1531         vq_callback_t **io_callbacks;
1532         char **io_names;
1533         struct virtqueue **vqs;
1534         u32 i, j, nr_ports, nr_queues;
1535         int err;
1536
1537         nr_ports = portdev->config.max_nr_ports;
1538         nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
1539
1540         vqs = kmalloc(nr_queues * sizeof(struct virtqueue *), GFP_KERNEL);
1541         if (!vqs) {
1542                 err = -ENOMEM;
1543                 goto fail;
1544         }
1545         io_callbacks = kmalloc(nr_queues * sizeof(vq_callback_t *), GFP_KERNEL);
1546         if (!io_callbacks) {
1547                 err = -ENOMEM;
1548                 goto free_vqs;
1549         }
1550         io_names = kmalloc(nr_queues * sizeof(char *), GFP_KERNEL);
1551         if (!io_names) {
1552                 err = -ENOMEM;
1553                 goto free_callbacks;
1554         }
1555         portdev->in_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1556                                   GFP_KERNEL);
1557         if (!portdev->in_vqs) {
1558                 err = -ENOMEM;
1559                 goto free_names;
1560         }
1561         portdev->out_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1562                                    GFP_KERNEL);
1563         if (!portdev->out_vqs) {
1564                 err = -ENOMEM;
1565                 goto free_invqs;
1566         }
1567
1568         /*
1569          * For backward compat (newer host but older guest), the host
1570          * spawns a console port first and also inits the vqs for port
1571          * 0 before others.
1572          */
1573         j = 0;
1574         io_callbacks[j] = in_intr;
1575         io_callbacks[j + 1] = NULL;
1576         io_names[j] = "input";
1577         io_names[j + 1] = "output";
1578         j += 2;
1579
1580         if (use_multiport(portdev)) {
1581                 io_callbacks[j] = control_intr;
1582                 io_callbacks[j + 1] = NULL;
1583                 io_names[j] = "control-i";
1584                 io_names[j + 1] = "control-o";
1585
1586                 for (i = 1; i < nr_ports; i++) {
1587                         j += 2;
1588                         io_callbacks[j] = in_intr;
1589                         io_callbacks[j + 1] = NULL;
1590                         io_names[j] = "input";
1591                         io_names[j + 1] = "output";
1592                 }
1593         }
1594         /* Find the queues. */
1595         err = portdev->vdev->config->find_vqs(portdev->vdev, nr_queues, vqs,
1596                                               io_callbacks,
1597                                               (const char **)io_names);
1598         if (err)
1599                 goto free_outvqs;
1600
1601         j = 0;
1602         portdev->in_vqs[0] = vqs[0];
1603         portdev->out_vqs[0] = vqs[1];
1604         j += 2;
1605         if (use_multiport(portdev)) {
1606                 portdev->c_ivq = vqs[j];
1607                 portdev->c_ovq = vqs[j + 1];
1608
1609                 for (i = 1; i < nr_ports; i++) {
1610                         j += 2;
1611                         portdev->in_vqs[i] = vqs[j];
1612                         portdev->out_vqs[i] = vqs[j + 1];
1613                 }
1614         }
1615         kfree(io_callbacks);
1616         kfree(io_names);
1617         kfree(vqs);
1618
1619         return 0;
1620
1621 free_names:
1622         kfree(io_names);
1623 free_callbacks:
1624         kfree(io_callbacks);
1625 free_outvqs:
1626         kfree(portdev->out_vqs);
1627 free_invqs:
1628         kfree(portdev->in_vqs);
1629 free_vqs:
1630         kfree(vqs);
1631 fail:
1632         return err;
1633 }
1634
1635 static const struct file_operations portdev_fops = {
1636         .owner = THIS_MODULE,
1637 };
1638
1639 /*
1640  * Once we're further in boot, we get probed like any other virtio
1641  * device.
1642  *
1643  * If the host also supports multiple console ports, we check the
1644  * config space to see how many ports the host has spawned.  We
1645  * initialize each port found.
1646  */
1647 static int __devinit virtcons_probe(struct virtio_device *vdev)
1648 {
1649         struct ports_device *portdev;
1650         int err;
1651         bool multiport;
1652
1653         portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
1654         if (!portdev) {
1655                 err = -ENOMEM;
1656                 goto fail;
1657         }
1658
1659         /* Attach this portdev to this virtio_device, and vice-versa. */
1660         portdev->vdev = vdev;
1661         vdev->priv = portdev;
1662
1663         spin_lock_irq(&pdrvdata_lock);
1664         portdev->drv_index = pdrvdata.index++;
1665         spin_unlock_irq(&pdrvdata_lock);
1666
1667         portdev->chr_major = register_chrdev(0, "virtio-portsdev",
1668                                              &portdev_fops);
1669         if (portdev->chr_major < 0) {
1670                 dev_err(&vdev->dev,
1671                         "Error %d registering chrdev for device %u\n",
1672                         portdev->chr_major, portdev->drv_index);
1673                 err = portdev->chr_major;
1674                 goto free;
1675         }
1676
1677         multiport = false;
1678         portdev->config.max_nr_ports = 1;
1679         if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT)) {
1680                 multiport = true;
1681                 vdev->features[0] |= 1 << VIRTIO_CONSOLE_F_MULTIPORT;
1682
1683                 vdev->config->get(vdev, offsetof(struct virtio_console_config,
1684                                                  max_nr_ports),
1685                                   &portdev->config.max_nr_ports,
1686                                   sizeof(portdev->config.max_nr_ports));
1687         }
1688
1689         /* Let the Host know we support multiple ports.*/
1690         vdev->config->finalize_features(vdev);
1691
1692         err = init_vqs(portdev);
1693         if (err < 0) {
1694                 dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
1695                 goto free_chrdev;
1696         }
1697
1698         spin_lock_init(&portdev->ports_lock);
1699         INIT_LIST_HEAD(&portdev->ports);
1700
1701         if (multiport) {
1702                 unsigned int nr_added_bufs;
1703
1704                 spin_lock_init(&portdev->cvq_lock);
1705                 INIT_WORK(&portdev->control_work, &control_work_handler);
1706
1707                 nr_added_bufs = fill_queue(portdev->c_ivq, &portdev->cvq_lock);
1708                 if (!nr_added_bufs) {
1709                         dev_err(&vdev->dev,
1710                                 "Error allocating buffers for control queue\n");
1711                         err = -ENOMEM;
1712                         goto free_vqs;
1713                 }
1714         } else {
1715                 /*
1716                  * For backward compatibility: Create a console port
1717                  * if we're running on older host.
1718                  */
1719                 add_port(portdev, 0);
1720         }
1721
1722         spin_lock_irq(&pdrvdata_lock);
1723         list_add_tail(&portdev->list, &pdrvdata.portdevs);
1724         spin_unlock_irq(&pdrvdata_lock);
1725
1726         __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1727                            VIRTIO_CONSOLE_DEVICE_READY, 1);
1728         return 0;
1729
1730 free_vqs:
1731         /* The host might want to notify mgmt sw about device add failure */
1732         __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1733                            VIRTIO_CONSOLE_DEVICE_READY, 0);
1734         vdev->config->del_vqs(vdev);
1735         kfree(portdev->in_vqs);
1736         kfree(portdev->out_vqs);
1737 free_chrdev:
1738         unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1739 free:
1740         kfree(portdev);
1741 fail:
1742         return err;
1743 }
1744
1745 static void virtcons_remove(struct virtio_device *vdev)
1746 {
1747         struct ports_device *portdev;
1748         struct port *port, *port2;
1749
1750         portdev = vdev->priv;
1751
1752         spin_lock_irq(&pdrvdata_lock);
1753         list_del(&portdev->list);
1754         spin_unlock_irq(&pdrvdata_lock);
1755
1756         /* Disable interrupts for vqs */
1757         vdev->config->reset(vdev);
1758         /* Finish up work that's lined up */
1759         cancel_work_sync(&portdev->control_work);
1760
1761         list_for_each_entry_safe(port, port2, &portdev->ports, list)
1762                 unplug_port(port);
1763
1764         unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1765
1766         /*
1767          * When yanking out a device, we immediately lose the
1768          * (device-side) queues.  So there's no point in keeping the
1769          * guest side around till we drop our final reference.  This
1770          * also means that any ports which are in an open state will
1771          * have to just stop using the port, as the vqs are going
1772          * away.
1773          */
1774         if (use_multiport(portdev)) {
1775                 struct port_buffer *buf;
1776                 unsigned int len;
1777
1778                 while ((buf = virtqueue_get_buf(portdev->c_ivq, &len)))
1779                         free_buf(buf);
1780
1781                 while ((buf = virtqueue_detach_unused_buf(portdev->c_ivq)))
1782                         free_buf(buf);
1783         }
1784
1785         vdev->config->del_vqs(vdev);
1786         kfree(portdev->in_vqs);
1787         kfree(portdev->out_vqs);
1788
1789         kfree(portdev);
1790 }
1791
1792 static struct virtio_device_id id_table[] = {
1793         { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
1794         { 0 },
1795 };
1796
1797 static unsigned int features[] = {
1798         VIRTIO_CONSOLE_F_SIZE,
1799         VIRTIO_CONSOLE_F_MULTIPORT,
1800 };
1801
1802 static struct virtio_driver virtio_console = {
1803         .feature_table = features,
1804         .feature_table_size = ARRAY_SIZE(features),
1805         .driver.name =  KBUILD_MODNAME,
1806         .driver.owner = THIS_MODULE,
1807         .id_table =     id_table,
1808         .probe =        virtcons_probe,
1809         .remove =       virtcons_remove,
1810         .config_changed = config_intr,
1811 };
1812
1813 static int __init init(void)
1814 {
1815         int err;
1816
1817         pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
1818         if (IS_ERR(pdrvdata.class)) {
1819                 err = PTR_ERR(pdrvdata.class);
1820                 pr_err("Error %d creating virtio-ports class\n", err);
1821                 return err;
1822         }
1823
1824         pdrvdata.debugfs_dir = debugfs_create_dir("virtio-ports", NULL);
1825         if (!pdrvdata.debugfs_dir) {
1826                 pr_warning("Error %ld creating debugfs dir for virtio-ports\n",
1827                            PTR_ERR(pdrvdata.debugfs_dir));
1828         }
1829         INIT_LIST_HEAD(&pdrvdata.consoles);
1830         INIT_LIST_HEAD(&pdrvdata.portdevs);
1831
1832         return register_virtio_driver(&virtio_console);
1833 }
1834
1835 static void __exit fini(void)
1836 {
1837         unregister_virtio_driver(&virtio_console);
1838
1839         class_destroy(pdrvdata.class);
1840         if (pdrvdata.debugfs_dir)
1841                 debugfs_remove_recursive(pdrvdata.debugfs_dir);
1842 }
1843 module_init(init);
1844 module_exit(fini);
1845
1846 MODULE_DEVICE_TABLE(virtio, id_table);
1847 MODULE_DESCRIPTION("Virtio console driver");
1848 MODULE_LICENSE("GPL");