blob: 0538425e9a71f52d1f7c749a174308b0b1893a47 [file] [log] [blame]
Rusty Russella23ea922010-01-18 19:14:55 +05301/*
2 * Copyright (C) 2006, 2007, 2009 Rusty Russell, IBM Corporation
Amit Shah5084f892011-01-31 13:06:37 +05303 * Copyright (C) 2009, 2010, 2011 Red Hat, Inc.
4 * Copyright (C) 2009, 2010, 2011 Amit Shah <amit.shah@redhat.com>
Rusty Russell31610432007-10-22 11:03:39 +10005 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
Amit Shahfb08bd22009-12-21 21:36:04 +053020#include <linux/cdev.h>
Amit Shahd99393e2009-12-21 22:36:21 +053021#include <linux/debugfs.h>
Amit Shahfb08bd22009-12-21 21:36:04 +053022#include <linux/device.h>
Rusty Russell31610432007-10-22 11:03:39 +100023#include <linux/err.h>
Amit Shaha08fa922011-09-14 13:06:41 +053024#include <linux/freezer.h>
Amit Shah2030fa42009-12-21 21:49:30 +053025#include <linux/fs.h>
Rusty Russell31610432007-10-22 11:03:39 +100026#include <linux/init.h>
Amit Shah38edf582010-01-18 19:15:05 +053027#include <linux/list.h>
Amit Shah2030fa42009-12-21 21:49:30 +053028#include <linux/poll.h>
29#include <linux/sched.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090030#include <linux/slab.h>
Amit Shah38edf582010-01-18 19:15:05 +053031#include <linux/spinlock.h>
Rusty Russell31610432007-10-22 11:03:39 +100032#include <linux/virtio.h>
33#include <linux/virtio_console.h>
Amit Shah2030fa42009-12-21 21:49:30 +053034#include <linux/wait.h>
Amit Shah17634ba2009-12-21 21:03:25 +053035#include <linux/workqueue.h>
Amit Shah51df0ac2011-02-01 09:31:25 +053036#include "../tty/hvc/hvc_console.h"
Rusty Russell31610432007-10-22 11:03:39 +100037
Amit Shah38edf582010-01-18 19:15:05 +053038/*
39 * This is a global struct for storing common data for all the devices
40 * this driver handles.
41 *
42 * Mainly, it has a linked list for all the consoles in one place so
43 * that callbacks from hvc for get_chars(), put_chars() work properly
44 * across multiple devices and multiple ports per device.
45 */
46struct ports_driver_data {
Amit Shahfb08bd22009-12-21 21:36:04 +053047 /* Used for registering chardevs */
48 struct class *class;
49
Amit Shahd99393e2009-12-21 22:36:21 +053050 /* Used for exporting per-port information to debugfs */
51 struct dentry *debugfs_dir;
52
Amit Shah6bdf2af2010-09-02 18:11:49 +053053 /* List of all the devices we're handling */
54 struct list_head portdevs;
55
Amit Shahfb08bd22009-12-21 21:36:04 +053056 /* Number of devices this driver is handling */
57 unsigned int index;
58
Rusty Russelld8a02bd2010-01-18 19:15:06 +053059 /*
60 * This is used to keep track of the number of hvc consoles
61 * spawned by this driver. This number is given as the first
62 * argument to hvc_alloc(). To correctly map an initial
63 * console spawned via hvc_instantiate to the console being
64 * hooked up via hvc_alloc, we need to pass the same vtermno.
65 *
66 * We also just assume the first console being initialised was
67 * the first one that got used as the initial console.
68 */
69 unsigned int next_vtermno;
70
Amit Shah38edf582010-01-18 19:15:05 +053071 /* All the console devices handled by this driver */
72 struct list_head consoles;
73};
74static struct ports_driver_data pdrvdata;
75
76DEFINE_SPINLOCK(pdrvdata_lock);
77
Amit Shah4f23c572010-01-18 19:15:09 +053078/* This struct holds information that's relevant only for console ports */
79struct console {
80 /* We'll place all consoles in a list in the pdrvdata struct */
81 struct list_head list;
82
83 /* The hvc device associated with this console port */
84 struct hvc_struct *hvc;
85
Amit Shah97788292010-05-06 02:05:08 +053086 /* The size of the console */
87 struct winsize ws;
88
Amit Shah4f23c572010-01-18 19:15:09 +053089 /*
90 * This number identifies the number that we used to register
91 * with hvc in hvc_instantiate() and hvc_alloc(); this is the
92 * number passed on by the hvc callbacks to us to
93 * differentiate between the other console ports handled by
94 * this driver
95 */
96 u32 vtermno;
97};
98
Amit Shahfdb9a052010-01-18 19:15:01 +053099struct port_buffer {
100 char *buf;
101
102 /* size of the buffer in *buf above */
103 size_t size;
104
105 /* used length of the buffer */
106 size_t len;
107 /* offset in the buf from which to consume data */
108 size_t offset;
109};
110
Amit Shah17634ba2009-12-21 21:03:25 +0530111/*
112 * This is a per-device struct that stores data common to all the
113 * ports for that device (vdev->priv).
114 */
115struct ports_device {
Amit Shah6bdf2af2010-09-02 18:11:49 +0530116 /* Next portdev in the list, head is in the pdrvdata struct */
117 struct list_head list;
118
Amit Shah17634ba2009-12-21 21:03:25 +0530119 /*
120 * Workqueue handlers where we process deferred work after
121 * notification
122 */
123 struct work_struct control_work;
124
125 struct list_head ports;
126
127 /* To protect the list of ports */
128 spinlock_t ports_lock;
129
130 /* To protect the vq operations for the control channel */
131 spinlock_t cvq_lock;
132
133 /* The current config space is stored here */
Amit Shahb99fa812010-05-19 22:15:46 -0600134 struct virtio_console_config config;
Amit Shah17634ba2009-12-21 21:03:25 +0530135
136 /* The virtio device we're associated with */
137 struct virtio_device *vdev;
138
139 /*
140 * A couple of virtqueues for the control channel: one for
141 * guest->host transfers, one for host->guest transfers
142 */
143 struct virtqueue *c_ivq, *c_ovq;
144
145 /* Array of per-port IO virtqueues */
146 struct virtqueue **in_vqs, **out_vqs;
Amit Shahfb08bd22009-12-21 21:36:04 +0530147
148 /* Used for numbering devices for sysfs and debugfs */
149 unsigned int drv_index;
150
151 /* Major number for this device. Ports will be created as minors. */
152 int chr_major;
Amit Shah17634ba2009-12-21 21:03:25 +0530153};
154
Amit Shah1c85bf32010-01-18 19:15:07 +0530155/* This struct holds the per-port data */
Rusty Russell21206ed2010-01-18 19:15:00 +0530156struct port {
Amit Shah17634ba2009-12-21 21:03:25 +0530157 /* Next port in the list, head is in the ports_device */
158 struct list_head list;
159
Amit Shah1c85bf32010-01-18 19:15:07 +0530160 /* Pointer to the parent virtio_console device */
161 struct ports_device *portdev;
Amit Shahfdb9a052010-01-18 19:15:01 +0530162
163 /* The current buffer from which data has to be fed to readers */
164 struct port_buffer *inbuf;
Rusty Russell31610432007-10-22 11:03:39 +1000165
Amit Shah203baab2010-01-18 19:15:12 +0530166 /*
167 * To protect the operations on the in_vq associated with this
168 * port. Has to be a spinlock because it can be called from
169 * interrupt context (get_char()).
170 */
171 spinlock_t inbuf_lock;
172
Amit Shahcdfadfc2010-05-19 22:15:50 -0600173 /* Protect the operations on the out_vq. */
174 spinlock_t outvq_lock;
175
Amit Shah1c85bf32010-01-18 19:15:07 +0530176 /* The IO vqs for this port */
177 struct virtqueue *in_vq, *out_vq;
178
Amit Shahd99393e2009-12-21 22:36:21 +0530179 /* File in the debugfs directory that exposes this port's information */
180 struct dentry *debugfs_file;
181
Amit Shah4f23c572010-01-18 19:15:09 +0530182 /*
183 * The entries in this struct will be valid if this port is
184 * hooked up to an hvc console
185 */
186 struct console cons;
Amit Shah17634ba2009-12-21 21:03:25 +0530187
Amit Shahfb08bd22009-12-21 21:36:04 +0530188 /* Each port associates with a separate char device */
Amit Shahd22a6982010-09-02 18:20:59 +0530189 struct cdev *cdev;
Amit Shahfb08bd22009-12-21 21:36:04 +0530190 struct device *dev;
191
Amit Shahb353a6b2010-09-02 18:38:29 +0530192 /* Reference-counting to handle port hot-unplugs and file operations */
193 struct kref kref;
194
Amit Shah2030fa42009-12-21 21:49:30 +0530195 /* A waitqueue for poll() or blocking read operations */
196 wait_queue_head_t waitqueue;
197
Amit Shah431edb82009-12-21 21:57:40 +0530198 /* The 'name' of the port that we expose via sysfs properties */
199 char *name;
200
Amit Shah3eae0ad2010-09-02 18:47:52 +0530201 /* We can notify apps of host connect / disconnect events via SIGIO */
202 struct fasync_struct *async_queue;
203
Amit Shah17634ba2009-12-21 21:03:25 +0530204 /* The 'id' to identify the port with the Host */
205 u32 id;
Amit Shah2030fa42009-12-21 21:49:30 +0530206
Amit Shahcdfadfc2010-05-19 22:15:50 -0600207 bool outvq_full;
208
Amit Shah2030fa42009-12-21 21:49:30 +0530209 /* Is the host device open */
210 bool host_connected;
Amit Shah3c7969c2009-11-26 11:25:38 +0530211
212 /* We should allow only one process to open a port */
213 bool guest_connected;
Rusty Russell21206ed2010-01-18 19:15:00 +0530214};
Rusty Russell31610432007-10-22 11:03:39 +1000215
Rusty Russell971f3392010-01-18 19:14:56 +0530216/* This is the very early arch-specified put chars function. */
217static int (*early_put_chars)(u32, const char *, int);
218
Amit Shah38edf582010-01-18 19:15:05 +0530219static struct port *find_port_by_vtermno(u32 vtermno)
220{
221 struct port *port;
Amit Shah4f23c572010-01-18 19:15:09 +0530222 struct console *cons;
Amit Shah38edf582010-01-18 19:15:05 +0530223 unsigned long flags;
224
225 spin_lock_irqsave(&pdrvdata_lock, flags);
Amit Shah4f23c572010-01-18 19:15:09 +0530226 list_for_each_entry(cons, &pdrvdata.consoles, list) {
227 if (cons->vtermno == vtermno) {
228 port = container_of(cons, struct port, cons);
Amit Shah38edf582010-01-18 19:15:05 +0530229 goto out;
Amit Shah4f23c572010-01-18 19:15:09 +0530230 }
Amit Shah38edf582010-01-18 19:15:05 +0530231 }
232 port = NULL;
233out:
234 spin_unlock_irqrestore(&pdrvdata_lock, flags);
235 return port;
236}
237
Amit Shah04950cd2010-09-02 18:20:58 +0530238static struct port *find_port_by_devt_in_portdev(struct ports_device *portdev,
239 dev_t dev)
240{
241 struct port *port;
242 unsigned long flags;
243
244 spin_lock_irqsave(&portdev->ports_lock, flags);
245 list_for_each_entry(port, &portdev->ports, list)
Amit Shahd22a6982010-09-02 18:20:59 +0530246 if (port->cdev->dev == dev)
Amit Shah04950cd2010-09-02 18:20:58 +0530247 goto out;
248 port = NULL;
249out:
250 spin_unlock_irqrestore(&portdev->ports_lock, flags);
251
252 return port;
253}
254
255static struct port *find_port_by_devt(dev_t dev)
256{
257 struct ports_device *portdev;
258 struct port *port;
259 unsigned long flags;
260
261 spin_lock_irqsave(&pdrvdata_lock, flags);
262 list_for_each_entry(portdev, &pdrvdata.portdevs, list) {
263 port = find_port_by_devt_in_portdev(portdev, dev);
264 if (port)
265 goto out;
266 }
267 port = NULL;
268out:
269 spin_unlock_irqrestore(&pdrvdata_lock, flags);
270 return port;
271}
272
Amit Shah17634ba2009-12-21 21:03:25 +0530273static struct port *find_port_by_id(struct ports_device *portdev, u32 id)
274{
275 struct port *port;
276 unsigned long flags;
277
278 spin_lock_irqsave(&portdev->ports_lock, flags);
279 list_for_each_entry(port, &portdev->ports, list)
280 if (port->id == id)
281 goto out;
282 port = NULL;
283out:
284 spin_unlock_irqrestore(&portdev->ports_lock, flags);
285
286 return port;
287}
288
Amit Shah203baab2010-01-18 19:15:12 +0530289static struct port *find_port_by_vq(struct ports_device *portdev,
290 struct virtqueue *vq)
291{
292 struct port *port;
Amit Shah203baab2010-01-18 19:15:12 +0530293 unsigned long flags;
294
Amit Shah17634ba2009-12-21 21:03:25 +0530295 spin_lock_irqsave(&portdev->ports_lock, flags);
296 list_for_each_entry(port, &portdev->ports, list)
Amit Shah203baab2010-01-18 19:15:12 +0530297 if (port->in_vq == vq || port->out_vq == vq)
298 goto out;
Amit Shah203baab2010-01-18 19:15:12 +0530299 port = NULL;
300out:
Amit Shah17634ba2009-12-21 21:03:25 +0530301 spin_unlock_irqrestore(&portdev->ports_lock, flags);
Amit Shah203baab2010-01-18 19:15:12 +0530302 return port;
303}
304
Amit Shah17634ba2009-12-21 21:03:25 +0530305static bool is_console_port(struct port *port)
306{
307 if (port->cons.hvc)
308 return true;
309 return false;
310}
311
312static inline bool use_multiport(struct ports_device *portdev)
313{
314 /*
315 * This condition can be true when put_chars is called from
316 * early_init
317 */
318 if (!portdev->vdev)
319 return 0;
320 return portdev->vdev->features[0] & (1 << VIRTIO_CONSOLE_F_MULTIPORT);
321}
322
Amit Shahfdb9a052010-01-18 19:15:01 +0530323static void free_buf(struct port_buffer *buf)
324{
325 kfree(buf->buf);
326 kfree(buf);
327}
328
329static struct port_buffer *alloc_buf(size_t buf_size)
330{
331 struct port_buffer *buf;
332
333 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
334 if (!buf)
335 goto fail;
336 buf->buf = kzalloc(buf_size, GFP_KERNEL);
337 if (!buf->buf)
338 goto free_buf;
339 buf->len = 0;
340 buf->offset = 0;
341 buf->size = buf_size;
342 return buf;
343
344free_buf:
345 kfree(buf);
346fail:
347 return NULL;
348}
349
Amit Shaha3cde442010-01-18 19:15:03 +0530350/* Callers should take appropriate locks */
Amit Shahdefde662011-09-14 13:06:42 +0530351static struct port_buffer *get_inbuf(struct port *port)
Amit Shaha3cde442010-01-18 19:15:03 +0530352{
353 struct port_buffer *buf;
Amit Shaha3cde442010-01-18 19:15:03 +0530354 unsigned int len;
355
Amit Shahd25a9dd2011-09-14 13:06:43 +0530356 if (port->inbuf)
357 return port->inbuf;
358
359 buf = virtqueue_get_buf(port->in_vq, &len);
Amit Shaha3cde442010-01-18 19:15:03 +0530360 if (buf) {
361 buf->len = len;
362 buf->offset = 0;
363 }
364 return buf;
365}
366
Rusty Russella23ea922010-01-18 19:14:55 +0530367/*
Amit Shahe27b5192010-01-18 19:15:02 +0530368 * Create a scatter-gather list representing our input buffer and put
369 * it in the queue.
370 *
371 * Callers should take appropriate locks.
372 */
Amit Shah203baab2010-01-18 19:15:12 +0530373static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
Amit Shahe27b5192010-01-18 19:15:02 +0530374{
375 struct scatterlist sg[1];
Amit Shah203baab2010-01-18 19:15:12 +0530376 int ret;
Amit Shah1c85bf32010-01-18 19:15:07 +0530377
Amit Shahe27b5192010-01-18 19:15:02 +0530378 sg_init_one(sg, buf->buf, buf->size);
379
Michael S. Tsirkin505b0452010-04-12 16:18:32 +0300380 ret = virtqueue_add_buf(vq, sg, 0, 1, buf);
381 virtqueue_kick(vq);
Amit Shah203baab2010-01-18 19:15:12 +0530382 return ret;
383}
384
Amit Shah88f251a2009-12-21 22:15:30 +0530385/* Discard any unread data this port has. Callers lockers. */
386static void discard_port_data(struct port *port)
387{
388 struct port_buffer *buf;
389 struct virtqueue *vq;
Amit Shahce072a02011-09-14 13:06:44 +0530390 unsigned int len, err;
Amit Shah88f251a2009-12-21 22:15:30 +0530391
Amit Shahd7a62cd2011-03-04 14:04:33 +1030392 if (!port->portdev) {
393 /* Device has been unplugged. vqs are already gone. */
394 return;
395 }
Amit Shah88f251a2009-12-21 22:15:30 +0530396 vq = port->in_vq;
397 if (port->inbuf)
398 buf = port->inbuf;
399 else
Michael S. Tsirkin505b0452010-04-12 16:18:32 +0300400 buf = virtqueue_get_buf(vq, &len);
Amit Shah88f251a2009-12-21 22:15:30 +0530401
Amit Shahce072a02011-09-14 13:06:44 +0530402 err = 0;
Amit Shahd6933562010-02-12 10:32:18 +0530403 while (buf) {
404 if (add_inbuf(vq, buf) < 0) {
Amit Shahce072a02011-09-14 13:06:44 +0530405 err++;
Amit Shahd6933562010-02-12 10:32:18 +0530406 free_buf(buf);
407 }
Michael S. Tsirkin505b0452010-04-12 16:18:32 +0300408 buf = virtqueue_get_buf(vq, &len);
Amit Shah88f251a2009-12-21 22:15:30 +0530409 }
Amit Shah88f251a2009-12-21 22:15:30 +0530410 port->inbuf = NULL;
Amit Shahce072a02011-09-14 13:06:44 +0530411 if (err)
Amit Shahd6933562010-02-12 10:32:18 +0530412 dev_warn(port->dev, "Errors adding %d buffers back to vq\n",
Amit Shahce072a02011-09-14 13:06:44 +0530413 err);
Amit Shah88f251a2009-12-21 22:15:30 +0530414}
415
Amit Shah203baab2010-01-18 19:15:12 +0530416static bool port_has_data(struct port *port)
417{
418 unsigned long flags;
419 bool ret;
420
Amit Shahd6933562010-02-12 10:32:18 +0530421 ret = false;
Amit Shahd25a9dd2011-09-14 13:06:43 +0530422 spin_lock_irqsave(&port->inbuf_lock, flags);
423 port->inbuf = get_inbuf(port);
424 if (port->inbuf)
425 ret = true;
426
Amit Shah203baab2010-01-18 19:15:12 +0530427 spin_unlock_irqrestore(&port->inbuf_lock, flags);
Amit Shah203baab2010-01-18 19:15:12 +0530428 return ret;
429}
430
Amit Shah3425e702010-05-19 22:15:46 -0600431static ssize_t __send_control_msg(struct ports_device *portdev, u32 port_id,
432 unsigned int event, unsigned int value)
Amit Shah17634ba2009-12-21 21:03:25 +0530433{
434 struct scatterlist sg[1];
435 struct virtio_console_control cpkt;
436 struct virtqueue *vq;
Amit Shah604b2ad2010-02-24 10:36:51 +0530437 unsigned int len;
Amit Shah17634ba2009-12-21 21:03:25 +0530438
Amit Shah3425e702010-05-19 22:15:46 -0600439 if (!use_multiport(portdev))
Amit Shah17634ba2009-12-21 21:03:25 +0530440 return 0;
441
Amit Shah3425e702010-05-19 22:15:46 -0600442 cpkt.id = port_id;
Amit Shah17634ba2009-12-21 21:03:25 +0530443 cpkt.event = event;
444 cpkt.value = value;
445
Amit Shah3425e702010-05-19 22:15:46 -0600446 vq = portdev->c_ovq;
Amit Shah17634ba2009-12-21 21:03:25 +0530447
448 sg_init_one(sg, &cpkt, sizeof(cpkt));
Michael S. Tsirkin505b0452010-04-12 16:18:32 +0300449 if (virtqueue_add_buf(vq, sg, 1, 0, &cpkt) >= 0) {
450 virtqueue_kick(vq);
451 while (!virtqueue_get_buf(vq, &len))
Amit Shah17634ba2009-12-21 21:03:25 +0530452 cpu_relax();
453 }
454 return 0;
455}
456
Amit Shah3425e702010-05-19 22:15:46 -0600457static ssize_t send_control_msg(struct port *port, unsigned int event,
458 unsigned int value)
459{
Amit Shah84ec06c2010-09-02 18:11:42 +0530460 /* 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;
Amit Shah3425e702010-05-19 22:15:46 -0600464}
465
Amit Shahcdfadfc2010-05-19 22:15:50 -0600466/* Callers must take the port->outvq_lock */
467static void reclaim_consumed_buffers(struct port *port)
468{
469 void *buf;
470 unsigned int len;
471
Amit Shahd7a62cd2011-03-04 14:04:33 +1030472 if (!port->portdev) {
473 /* Device has been unplugged. vqs are already gone. */
474 return;
475 }
Amit Shahcdfadfc2010-05-19 22:15:50 -0600476 while ((buf = virtqueue_get_buf(port->out_vq, &len))) {
477 kfree(buf);
478 port->outvq_full = false;
479 }
480}
481
482static ssize_t send_buf(struct port *port, void *in_buf, size_t in_count,
483 bool nonblock)
Amit Shahf997f00b2009-12-21 17:28:51 +0530484{
485 struct scatterlist sg[1];
486 struct virtqueue *out_vq;
487 ssize_t ret;
Amit Shahcdfadfc2010-05-19 22:15:50 -0600488 unsigned long flags;
Amit Shahf997f00b2009-12-21 17:28:51 +0530489 unsigned int len;
490
491 out_vq = port->out_vq;
492
Amit Shahcdfadfc2010-05-19 22:15:50 -0600493 spin_lock_irqsave(&port->outvq_lock, flags);
494
495 reclaim_consumed_buffers(port);
496
Amit Shahf997f00b2009-12-21 17:28:51 +0530497 sg_init_one(sg, in_buf, in_count);
Michael S. Tsirkin505b0452010-04-12 16:18:32 +0300498 ret = virtqueue_add_buf(out_vq, sg, 1, 0, in_buf);
Amit Shahf997f00b2009-12-21 17:28:51 +0530499
500 /* Tell Host to go! */
Michael S. Tsirkin505b0452010-04-12 16:18:32 +0300501 virtqueue_kick(out_vq);
Amit Shahf997f00b2009-12-21 17:28:51 +0530502
503 if (ret < 0) {
Rusty Russell9ff4cfa2010-04-08 09:46:16 -0600504 in_count = 0;
Amit Shahcdfadfc2010-05-19 22:15:50 -0600505 goto done;
Amit Shahf997f00b2009-12-21 17:28:51 +0530506 }
507
Amit Shahcdfadfc2010-05-19 22:15:50 -0600508 if (ret == 0)
509 port->outvq_full = true;
510
511 if (nonblock)
512 goto done;
513
514 /*
515 * Wait till the host acknowledges it pushed out the data we
Amit Shah531295e2010-10-20 13:45:43 +1030516 * sent. This is done for data from the hvc_console; the tty
517 * operations are performed with spinlocks held so we can't
518 * sleep here. An alternative would be to copy the data to a
519 * buffer and relax the spinning requirement. The downside is
520 * we need to kmalloc a GFP_ATOMIC buffer each time the
521 * console driver writes something out.
Amit Shahcdfadfc2010-05-19 22:15:50 -0600522 */
Michael S. Tsirkin505b0452010-04-12 16:18:32 +0300523 while (!virtqueue_get_buf(out_vq, &len))
Amit Shahf997f00b2009-12-21 17:28:51 +0530524 cpu_relax();
Amit Shahcdfadfc2010-05-19 22:15:50 -0600525done:
526 spin_unlock_irqrestore(&port->outvq_lock, flags);
527 /*
528 * We're expected to return the amount of data we wrote -- all
529 * of it
530 */
Rusty Russell9ff4cfa2010-04-08 09:46:16 -0600531 return in_count;
Amit Shahf997f00b2009-12-21 17:28:51 +0530532}
533
Amit Shah203baab2010-01-18 19:15:12 +0530534/*
535 * Give out the data that's requested from the buffer that we have
536 * queued up.
537 */
Amit Shahb766cee2009-12-21 21:26:45 +0530538static ssize_t fill_readbuf(struct port *port, char *out_buf, size_t out_count,
539 bool to_user)
Amit Shah203baab2010-01-18 19:15:12 +0530540{
541 struct port_buffer *buf;
542 unsigned long flags;
543
544 if (!out_count || !port_has_data(port))
545 return 0;
546
547 buf = port->inbuf;
Amit Shahb766cee2009-12-21 21:26:45 +0530548 out_count = min(out_count, buf->len - buf->offset);
Amit Shah203baab2010-01-18 19:15:12 +0530549
Amit Shahb766cee2009-12-21 21:26:45 +0530550 if (to_user) {
551 ssize_t ret;
Amit Shah203baab2010-01-18 19:15:12 +0530552
Amit Shahb766cee2009-12-21 21:26:45 +0530553 ret = copy_to_user(out_buf, buf->buf + buf->offset, out_count);
554 if (ret)
555 return -EFAULT;
556 } else {
557 memcpy(out_buf, buf->buf + buf->offset, out_count);
558 }
559
Amit Shah203baab2010-01-18 19:15:12 +0530560 buf->offset += out_count;
561
562 if (buf->offset == buf->len) {
563 /*
564 * We're done using all the data in this buffer.
565 * Re-queue so that the Host can send us more data.
566 */
567 spin_lock_irqsave(&port->inbuf_lock, flags);
568 port->inbuf = NULL;
569
570 if (add_inbuf(port->in_vq, buf) < 0)
Amit Shahfb08bd22009-12-21 21:36:04 +0530571 dev_warn(port->dev, "failed add_buf\n");
Amit Shah203baab2010-01-18 19:15:12 +0530572
573 spin_unlock_irqrestore(&port->inbuf_lock, flags);
574 }
Amit Shahb766cee2009-12-21 21:26:45 +0530575 /* Return the number of bytes actually copied */
Amit Shah203baab2010-01-18 19:15:12 +0530576 return out_count;
Amit Shahe27b5192010-01-18 19:15:02 +0530577}
578
Amit Shah2030fa42009-12-21 21:49:30 +0530579/* The condition that must be true for polling to end */
Amit Shah60caacd2010-05-19 22:15:49 -0600580static bool will_read_block(struct port *port)
Amit Shah2030fa42009-12-21 21:49:30 +0530581{
Amit Shah3709ea72010-09-02 18:11:43 +0530582 if (!port->guest_connected) {
583 /* Port got hot-unplugged. Let's exit. */
584 return false;
585 }
Amit Shah60caacd2010-05-19 22:15:49 -0600586 return !port_has_data(port) && port->host_connected;
Amit Shah2030fa42009-12-21 21:49:30 +0530587}
588
Amit Shahcdfadfc2010-05-19 22:15:50 -0600589static bool will_write_block(struct port *port)
590{
591 bool ret;
592
Amit Shah60e5e0b2010-05-27 13:24:40 +0530593 if (!port->guest_connected) {
594 /* Port got hot-unplugged. Let's exit. */
595 return false;
596 }
Amit Shahcdfadfc2010-05-19 22:15:50 -0600597 if (!port->host_connected)
598 return true;
599
600 spin_lock_irq(&port->outvq_lock);
601 /*
602 * Check if the Host has consumed any buffers since we last
603 * sent data (this is only applicable for nonblocking ports).
604 */
605 reclaim_consumed_buffers(port);
606 ret = port->outvq_full;
607 spin_unlock_irq(&port->outvq_lock);
608
609 return ret;
610}
611
Amit Shah2030fa42009-12-21 21:49:30 +0530612static ssize_t port_fops_read(struct file *filp, char __user *ubuf,
613 size_t count, loff_t *offp)
614{
615 struct port *port;
616 ssize_t ret;
617
618 port = filp->private_data;
619
620 if (!port_has_data(port)) {
621 /*
622 * If nothing's connected on the host just return 0 in
623 * case of list_empty; this tells the userspace app
624 * that there's no connection
625 */
626 if (!port->host_connected)
627 return 0;
628 if (filp->f_flags & O_NONBLOCK)
629 return -EAGAIN;
630
Amit Shaha08fa922011-09-14 13:06:41 +0530631 ret = wait_event_freezable(port->waitqueue,
632 !will_read_block(port));
Amit Shah2030fa42009-12-21 21:49:30 +0530633 if (ret < 0)
634 return ret;
635 }
Amit Shahb3dddb92010-09-02 18:11:45 +0530636 /* Port got hot-unplugged. */
637 if (!port->guest_connected)
638 return -ENODEV;
Amit Shah2030fa42009-12-21 21:49:30 +0530639 /*
640 * We could've received a disconnection message while we were
641 * waiting for more data.
642 *
643 * This check is not clubbed in the if() statement above as we
644 * might receive some data as well as the host could get
645 * disconnected after we got woken up from our wait. So we
646 * really want to give off whatever data we have and only then
647 * check for host_connected.
648 */
649 if (!port_has_data(port) && !port->host_connected)
650 return 0;
651
652 return fill_readbuf(port, ubuf, count, true);
653}
654
655static ssize_t port_fops_write(struct file *filp, const char __user *ubuf,
656 size_t count, loff_t *offp)
657{
658 struct port *port;
659 char *buf;
660 ssize_t ret;
Amit Shahcdfadfc2010-05-19 22:15:50 -0600661 bool nonblock;
Amit Shah2030fa42009-12-21 21:49:30 +0530662
Amit Shah65745422010-09-14 13:26:16 +0530663 /* Userspace could be out to fool us */
664 if (!count)
665 return 0;
666
Amit Shah2030fa42009-12-21 21:49:30 +0530667 port = filp->private_data;
668
Amit Shahcdfadfc2010-05-19 22:15:50 -0600669 nonblock = filp->f_flags & O_NONBLOCK;
670
671 if (will_write_block(port)) {
672 if (nonblock)
673 return -EAGAIN;
674
Amit Shaha08fa922011-09-14 13:06:41 +0530675 ret = wait_event_freezable(port->waitqueue,
676 !will_write_block(port));
Amit Shahcdfadfc2010-05-19 22:15:50 -0600677 if (ret < 0)
678 return ret;
679 }
Amit Shahf4028112010-09-02 18:11:46 +0530680 /* Port got hot-unplugged. */
681 if (!port->guest_connected)
682 return -ENODEV;
Amit Shahcdfadfc2010-05-19 22:15:50 -0600683
Amit Shah2030fa42009-12-21 21:49:30 +0530684 count = min((size_t)(32 * 1024), count);
685
686 buf = kmalloc(count, GFP_KERNEL);
687 if (!buf)
688 return -ENOMEM;
689
690 ret = copy_from_user(buf, ubuf, count);
691 if (ret) {
692 ret = -EFAULT;
693 goto free_buf;
694 }
695
Amit Shah531295e2010-10-20 13:45:43 +1030696 /*
697 * We now ask send_buf() to not spin for generic ports -- we
698 * can re-use the same code path that non-blocking file
699 * descriptors take for blocking file descriptors since the
700 * wait is already done and we're certain the write will go
701 * through to the host.
702 */
703 nonblock = true;
Amit Shahcdfadfc2010-05-19 22:15:50 -0600704 ret = send_buf(port, buf, count, nonblock);
705
706 if (nonblock && ret > 0)
707 goto out;
708
Amit Shah2030fa42009-12-21 21:49:30 +0530709free_buf:
710 kfree(buf);
Amit Shahcdfadfc2010-05-19 22:15:50 -0600711out:
Amit Shah2030fa42009-12-21 21:49:30 +0530712 return ret;
713}
714
715static unsigned int port_fops_poll(struct file *filp, poll_table *wait)
716{
717 struct port *port;
718 unsigned int ret;
719
720 port = filp->private_data;
721 poll_wait(filp, &port->waitqueue, wait);
722
Amit Shah8529a502010-09-02 18:11:44 +0530723 if (!port->guest_connected) {
724 /* Port got unplugged */
725 return POLLHUP;
726 }
Amit Shah2030fa42009-12-21 21:49:30 +0530727 ret = 0;
Hans de Goede6df7aad2010-09-16 14:43:08 +0530728 if (!will_read_block(port))
Amit Shah2030fa42009-12-21 21:49:30 +0530729 ret |= POLLIN | POLLRDNORM;
Amit Shahcdfadfc2010-05-19 22:15:50 -0600730 if (!will_write_block(port))
Amit Shah2030fa42009-12-21 21:49:30 +0530731 ret |= POLLOUT;
732 if (!port->host_connected)
733 ret |= POLLHUP;
734
735 return ret;
736}
737
Amit Shahb353a6b2010-09-02 18:38:29 +0530738static void remove_port(struct kref *kref);
739
Amit Shah2030fa42009-12-21 21:49:30 +0530740static int port_fops_release(struct inode *inode, struct file *filp)
741{
742 struct port *port;
743
744 port = filp->private_data;
745
746 /* Notify host of port being closed */
747 send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
748
Amit Shah88f251a2009-12-21 22:15:30 +0530749 spin_lock_irq(&port->inbuf_lock);
Amit Shah3c7969c2009-11-26 11:25:38 +0530750 port->guest_connected = false;
751
Amit Shah88f251a2009-12-21 22:15:30 +0530752 discard_port_data(port);
753
754 spin_unlock_irq(&port->inbuf_lock);
755
Amit Shahcdfadfc2010-05-19 22:15:50 -0600756 spin_lock_irq(&port->outvq_lock);
757 reclaim_consumed_buffers(port);
758 spin_unlock_irq(&port->outvq_lock);
759
Amit Shahb353a6b2010-09-02 18:38:29 +0530760 /*
761 * Locks aren't necessary here as a port can't be opened after
762 * unplug, and if a port isn't unplugged, a kref would already
763 * exist for the port. Plus, taking ports_lock here would
764 * create a dependency on other locks taken by functions
765 * inside remove_port if we're the last holder of the port,
766 * creating many problems.
767 */
768 kref_put(&port->kref, remove_port);
769
Amit Shah2030fa42009-12-21 21:49:30 +0530770 return 0;
771}
772
773static int port_fops_open(struct inode *inode, struct file *filp)
774{
775 struct cdev *cdev = inode->i_cdev;
776 struct port *port;
Amit Shah8ad37e82010-09-02 18:11:48 +0530777 int ret;
Amit Shah2030fa42009-12-21 21:49:30 +0530778
Amit Shah04950cd2010-09-02 18:20:58 +0530779 port = find_port_by_devt(cdev->dev);
Amit Shah2030fa42009-12-21 21:49:30 +0530780 filp->private_data = port;
781
Amit Shahb353a6b2010-09-02 18:38:29 +0530782 /* Prevent against a port getting hot-unplugged at the same time */
783 spin_lock_irq(&port->portdev->ports_lock);
784 kref_get(&port->kref);
785 spin_unlock_irq(&port->portdev->ports_lock);
786
Amit Shah2030fa42009-12-21 21:49:30 +0530787 /*
788 * Don't allow opening of console port devices -- that's done
789 * via /dev/hvc
790 */
Amit Shah8ad37e82010-09-02 18:11:48 +0530791 if (is_console_port(port)) {
792 ret = -ENXIO;
793 goto out;
794 }
Amit Shah2030fa42009-12-21 21:49:30 +0530795
Amit Shah3c7969c2009-11-26 11:25:38 +0530796 /* Allow only one process to open a particular port at a time */
797 spin_lock_irq(&port->inbuf_lock);
798 if (port->guest_connected) {
799 spin_unlock_irq(&port->inbuf_lock);
Amit Shah8ad37e82010-09-02 18:11:48 +0530800 ret = -EMFILE;
801 goto out;
Amit Shah3c7969c2009-11-26 11:25:38 +0530802 }
803
804 port->guest_connected = true;
805 spin_unlock_irq(&port->inbuf_lock);
806
Amit Shahcdfadfc2010-05-19 22:15:50 -0600807 spin_lock_irq(&port->outvq_lock);
808 /*
809 * There might be a chance that we missed reclaiming a few
810 * buffers in the window of the port getting previously closed
811 * and opening now.
812 */
813 reclaim_consumed_buffers(port);
814 spin_unlock_irq(&port->outvq_lock);
815
Amit Shah299fb612010-09-16 14:43:09 +0530816 nonseekable_open(inode, filp);
817
Amit Shah2030fa42009-12-21 21:49:30 +0530818 /* Notify host of port being opened */
819 send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
820
821 return 0;
Amit Shah8ad37e82010-09-02 18:11:48 +0530822out:
Amit Shahb353a6b2010-09-02 18:38:29 +0530823 kref_put(&port->kref, remove_port);
Amit Shah8ad37e82010-09-02 18:11:48 +0530824 return ret;
Amit Shah2030fa42009-12-21 21:49:30 +0530825}
826
Amit Shah3eae0ad2010-09-02 18:47:52 +0530827static int port_fops_fasync(int fd, struct file *filp, int mode)
828{
829 struct port *port;
830
831 port = filp->private_data;
832 return fasync_helper(fd, filp, mode, &port->async_queue);
833}
834
Amit Shah2030fa42009-12-21 21:49:30 +0530835/*
836 * The file operations that we support: programs in the guest can open
837 * a console device, read from it, write to it, poll for data and
838 * close it. The devices are at
839 * /dev/vport<device number>p<port number>
840 */
841static const struct file_operations port_fops = {
842 .owner = THIS_MODULE,
843 .open = port_fops_open,
844 .read = port_fops_read,
845 .write = port_fops_write,
846 .poll = port_fops_poll,
847 .release = port_fops_release,
Amit Shah3eae0ad2010-09-02 18:47:52 +0530848 .fasync = port_fops_fasync,
Amit Shah299fb612010-09-16 14:43:09 +0530849 .llseek = no_llseek,
Amit Shah2030fa42009-12-21 21:49:30 +0530850};
851
Amit Shahe27b5192010-01-18 19:15:02 +0530852/*
Rusty Russella23ea922010-01-18 19:14:55 +0530853 * The put_chars() callback is pretty straightforward.
Rusty Russell31610432007-10-22 11:03:39 +1000854 *
Rusty Russella23ea922010-01-18 19:14:55 +0530855 * We turn the characters into a scatter-gather list, add it to the
856 * output queue and then kick the Host. Then we sit here waiting for
857 * it to finish: inefficient in theory, but in practice
858 * implementations will do it immediately (lguest's Launcher does).
859 */
Rusty Russell31610432007-10-22 11:03:39 +1000860static int put_chars(u32 vtermno, const char *buf, int count)
861{
Rusty Russell21206ed2010-01-18 19:15:00 +0530862 struct port *port;
Amit Shah38edf582010-01-18 19:15:05 +0530863
François Diakhaté162a6892010-03-23 18:23:15 +0530864 if (unlikely(early_put_chars))
865 return early_put_chars(vtermno, buf, count);
866
Amit Shah38edf582010-01-18 19:15:05 +0530867 port = find_port_by_vtermno(vtermno);
868 if (!port)
Amit Shah6dc69f972010-05-19 22:15:47 -0600869 return -EPIPE;
Rusty Russell31610432007-10-22 11:03:39 +1000870
Amit Shahcdfadfc2010-05-19 22:15:50 -0600871 return send_buf(port, (void *)buf, count, false);
Rusty Russell31610432007-10-22 11:03:39 +1000872}
873
Rusty Russella23ea922010-01-18 19:14:55 +0530874/*
Rusty Russella23ea922010-01-18 19:14:55 +0530875 * get_chars() is the callback from the hvc_console infrastructure
876 * when an interrupt is received.
Rusty Russell31610432007-10-22 11:03:39 +1000877 *
Amit Shah203baab2010-01-18 19:15:12 +0530878 * We call out to fill_readbuf that gets us the required data from the
879 * buffers that are queued up.
Rusty Russella23ea922010-01-18 19:14:55 +0530880 */
Rusty Russell31610432007-10-22 11:03:39 +1000881static int get_chars(u32 vtermno, char *buf, int count)
882{
Rusty Russell21206ed2010-01-18 19:15:00 +0530883 struct port *port;
Rusty Russell31610432007-10-22 11:03:39 +1000884
Amit Shah6dc69f972010-05-19 22:15:47 -0600885 /* If we've not set up the port yet, we have no input to give. */
886 if (unlikely(early_put_chars))
887 return 0;
888
Amit Shah38edf582010-01-18 19:15:05 +0530889 port = find_port_by_vtermno(vtermno);
890 if (!port)
Amit Shah6dc69f972010-05-19 22:15:47 -0600891 return -EPIPE;
Rusty Russell21206ed2010-01-18 19:15:00 +0530892
893 /* If we don't have an input queue yet, we can't get input. */
894 BUG_ON(!port->in_vq);
895
Amit Shahb766cee2009-12-21 21:26:45 +0530896 return fill_readbuf(port, buf, count, false);
Rusty Russell31610432007-10-22 11:03:39 +1000897}
Rusty Russell31610432007-10-22 11:03:39 +1000898
Amit Shahcb06e362010-01-18 19:15:08 +0530899static void resize_console(struct port *port)
Christian Borntraegerc2983452008-11-25 13:36:26 +0100900{
Amit Shahcb06e362010-01-18 19:15:08 +0530901 struct virtio_device *vdev;
Christian Borntraegerc2983452008-11-25 13:36:26 +0100902
Amit Shah2de16a42010-03-19 17:36:44 +0530903 /* The port could have been hot-unplugged */
Amit Shah97788292010-05-06 02:05:08 +0530904 if (!port || !is_console_port(port))
Amit Shah2de16a42010-03-19 17:36:44 +0530905 return;
906
Amit Shahcb06e362010-01-18 19:15:08 +0530907 vdev = port->portdev->vdev;
Amit Shah97788292010-05-06 02:05:08 +0530908 if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE))
909 hvc_resize(port->cons.hvc, port->cons.ws);
Christian Borntraegerc2983452008-11-25 13:36:26 +0100910}
911
Amit Shah38edf582010-01-18 19:15:05 +0530912/* We set the configuration at this point, since we now have a tty */
Christian Borntraeger91fcad12008-06-20 15:24:15 +0200913static int notifier_add_vio(struct hvc_struct *hp, int data)
914{
Amit Shah38edf582010-01-18 19:15:05 +0530915 struct port *port;
916
917 port = find_port_by_vtermno(hp->vtermno);
918 if (!port)
919 return -EINVAL;
920
Christian Borntraeger91fcad12008-06-20 15:24:15 +0200921 hp->irq_requested = 1;
Amit Shahcb06e362010-01-18 19:15:08 +0530922 resize_console(port);
Christian Borntraegerc2983452008-11-25 13:36:26 +0100923
Christian Borntraeger91fcad12008-06-20 15:24:15 +0200924 return 0;
925}
926
927static void notifier_del_vio(struct hvc_struct *hp, int data)
928{
929 hp->irq_requested = 0;
930}
931
Amit Shah17634ba2009-12-21 21:03:25 +0530932/* The operations for console ports. */
Rusty Russell1dff3992009-11-28 12:20:26 +0530933static const struct hv_ops hv_ops = {
Rusty Russell971f3392010-01-18 19:14:56 +0530934 .get_chars = get_chars,
935 .put_chars = put_chars,
936 .notifier_add = notifier_add_vio,
937 .notifier_del = notifier_del_vio,
938 .notifier_hangup = notifier_del_vio,
939};
940
941/*
942 * Console drivers are initialized very early so boot messages can go
943 * out, so we do things slightly differently from the generic virtio
944 * initialization of the net and block drivers.
945 *
946 * At this stage, the console is output-only. It's too early to set
947 * up a virtqueue, so we let the drivers do some boutique early-output
948 * thing.
949 */
950int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
951{
952 early_put_chars = put_chars;
953 return hvc_instantiate(0, 0, &hv_ops);
954}
955
Amit Shah17634ba2009-12-21 21:03:25 +0530956int init_port_console(struct port *port)
Amit Shahcfa6d372010-01-18 19:15:10 +0530957{
958 int ret;
959
960 /*
961 * The Host's telling us this port is a console port. Hook it
962 * up with an hvc console.
963 *
964 * To set up and manage our virtual console, we call
965 * hvc_alloc().
966 *
967 * The first argument of hvc_alloc() is the virtual console
968 * number. The second argument is the parameter for the
969 * notification mechanism (like irq number). We currently
970 * leave this as zero, virtqueues have implicit notifications.
971 *
972 * The third argument is a "struct hv_ops" containing the
973 * put_chars() get_chars(), notifier_add() and notifier_del()
974 * pointers. The final argument is the output buffer size: we
975 * can do any size, so we put PAGE_SIZE here.
976 */
977 port->cons.vtermno = pdrvdata.next_vtermno;
978
979 port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
980 if (IS_ERR(port->cons.hvc)) {
981 ret = PTR_ERR(port->cons.hvc);
Amit Shah298add72010-01-18 16:35:23 +0530982 dev_err(port->dev,
983 "error %d allocating hvc for port\n", ret);
Amit Shahcfa6d372010-01-18 19:15:10 +0530984 port->cons.hvc = NULL;
985 return ret;
986 }
987 spin_lock_irq(&pdrvdata_lock);
988 pdrvdata.next_vtermno++;
989 list_add_tail(&port->cons.list, &pdrvdata.consoles);
990 spin_unlock_irq(&pdrvdata_lock);
Amit Shah3c7969c2009-11-26 11:25:38 +0530991 port->guest_connected = true;
Amit Shahcfa6d372010-01-18 19:15:10 +0530992
Amit Shah1d051602010-05-19 22:15:49 -0600993 /*
994 * Start using the new console output if this is the first
995 * console to come up.
996 */
997 if (early_put_chars)
998 early_put_chars = NULL;
999
Amit Shah2030fa42009-12-21 21:49:30 +05301000 /* Notify host of port being opened */
1001 send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
1002
Amit Shahcfa6d372010-01-18 19:15:10 +05301003 return 0;
1004}
1005
Amit Shah431edb82009-12-21 21:57:40 +05301006static ssize_t show_port_name(struct device *dev,
1007 struct device_attribute *attr, char *buffer)
1008{
1009 struct port *port;
1010
1011 port = dev_get_drvdata(dev);
1012
1013 return sprintf(buffer, "%s\n", port->name);
1014}
1015
1016static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
1017
1018static struct attribute *port_sysfs_entries[] = {
1019 &dev_attr_name.attr,
1020 NULL
1021};
1022
1023static struct attribute_group port_attribute_group = {
1024 .name = NULL, /* put in device directory */
1025 .attrs = port_sysfs_entries,
1026};
1027
Amit Shahd99393e2009-12-21 22:36:21 +05301028static int debugfs_open(struct inode *inode, struct file *filp)
1029{
1030 filp->private_data = inode->i_private;
1031 return 0;
1032}
1033
1034static ssize_t debugfs_read(struct file *filp, char __user *ubuf,
1035 size_t count, loff_t *offp)
1036{
1037 struct port *port;
1038 char *buf;
1039 ssize_t ret, out_offset, out_count;
1040
1041 out_count = 1024;
1042 buf = kmalloc(out_count, GFP_KERNEL);
1043 if (!buf)
1044 return -ENOMEM;
1045
1046 port = filp->private_data;
1047 out_offset = 0;
1048 out_offset += snprintf(buf + out_offset, out_count,
1049 "name: %s\n", port->name ? port->name : "");
1050 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1051 "guest_connected: %d\n", port->guest_connected);
1052 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1053 "host_connected: %d\n", port->host_connected);
1054 out_offset += snprintf(buf + out_offset, out_count - out_offset,
Amit Shahcdfadfc2010-05-19 22:15:50 -06001055 "outvq_full: %d\n", port->outvq_full);
1056 out_offset += snprintf(buf + out_offset, out_count - out_offset,
Amit Shahd99393e2009-12-21 22:36:21 +05301057 "is_console: %s\n",
1058 is_console_port(port) ? "yes" : "no");
1059 out_offset += snprintf(buf + out_offset, out_count - out_offset,
1060 "console_vtermno: %u\n", port->cons.vtermno);
1061
1062 ret = simple_read_from_buffer(ubuf, count, offp, buf, out_offset);
1063 kfree(buf);
1064 return ret;
1065}
1066
1067static const struct file_operations port_debugfs_ops = {
1068 .owner = THIS_MODULE,
1069 .open = debugfs_open,
1070 .read = debugfs_read,
1071};
1072
Amit Shah97788292010-05-06 02:05:08 +05301073static void set_console_size(struct port *port, u16 rows, u16 cols)
1074{
1075 if (!port || !is_console_port(port))
1076 return;
1077
1078 port->cons.ws.ws_row = rows;
1079 port->cons.ws.ws_col = cols;
1080}
1081
Amit Shahc446f8f2010-05-19 22:15:48 -06001082static unsigned int fill_queue(struct virtqueue *vq, spinlock_t *lock)
1083{
1084 struct port_buffer *buf;
1085 unsigned int nr_added_bufs;
1086 int ret;
1087
1088 nr_added_bufs = 0;
1089 do {
1090 buf = alloc_buf(PAGE_SIZE);
1091 if (!buf)
1092 break;
1093
1094 spin_lock_irq(lock);
1095 ret = add_inbuf(vq, buf);
1096 if (ret < 0) {
1097 spin_unlock_irq(lock);
1098 free_buf(buf);
1099 break;
1100 }
1101 nr_added_bufs++;
1102 spin_unlock_irq(lock);
1103 } while (ret > 0);
1104
1105 return nr_added_bufs;
1106}
1107
Amit Shah3eae0ad2010-09-02 18:47:52 +05301108static void send_sigio_to_port(struct port *port)
1109{
1110 if (port->async_queue && port->guest_connected)
1111 kill_fasync(&port->async_queue, SIGIO, POLL_OUT);
1112}
1113
Amit Shahc446f8f2010-05-19 22:15:48 -06001114static int add_port(struct ports_device *portdev, u32 id)
1115{
1116 char debugfs_name[16];
1117 struct port *port;
1118 struct port_buffer *buf;
1119 dev_t devt;
1120 unsigned int nr_added_bufs;
1121 int err;
1122
1123 port = kmalloc(sizeof(*port), GFP_KERNEL);
1124 if (!port) {
1125 err = -ENOMEM;
1126 goto fail;
1127 }
Amit Shahb353a6b2010-09-02 18:38:29 +05301128 kref_init(&port->kref);
Amit Shahc446f8f2010-05-19 22:15:48 -06001129
1130 port->portdev = portdev;
1131 port->id = id;
1132
1133 port->name = NULL;
1134 port->inbuf = NULL;
1135 port->cons.hvc = NULL;
Amit Shah3eae0ad2010-09-02 18:47:52 +05301136 port->async_queue = NULL;
Amit Shahc446f8f2010-05-19 22:15:48 -06001137
Amit Shah97788292010-05-06 02:05:08 +05301138 port->cons.ws.ws_row = port->cons.ws.ws_col = 0;
1139
Amit Shahc446f8f2010-05-19 22:15:48 -06001140 port->host_connected = port->guest_connected = false;
1141
Amit Shahcdfadfc2010-05-19 22:15:50 -06001142 port->outvq_full = false;
1143
Amit Shahc446f8f2010-05-19 22:15:48 -06001144 port->in_vq = portdev->in_vqs[port->id];
1145 port->out_vq = portdev->out_vqs[port->id];
1146
Amit Shahd22a6982010-09-02 18:20:59 +05301147 port->cdev = cdev_alloc();
1148 if (!port->cdev) {
1149 dev_err(&port->portdev->vdev->dev, "Error allocating cdev\n");
1150 err = -ENOMEM;
1151 goto free_port;
1152 }
1153 port->cdev->ops = &port_fops;
Amit Shahc446f8f2010-05-19 22:15:48 -06001154
1155 devt = MKDEV(portdev->chr_major, id);
Amit Shahd22a6982010-09-02 18:20:59 +05301156 err = cdev_add(port->cdev, devt, 1);
Amit Shahc446f8f2010-05-19 22:15:48 -06001157 if (err < 0) {
1158 dev_err(&port->portdev->vdev->dev,
1159 "Error %d adding cdev for port %u\n", err, id);
Amit Shahd22a6982010-09-02 18:20:59 +05301160 goto free_cdev;
Amit Shahc446f8f2010-05-19 22:15:48 -06001161 }
1162 port->dev = device_create(pdrvdata.class, &port->portdev->vdev->dev,
1163 devt, port, "vport%up%u",
1164 port->portdev->drv_index, id);
1165 if (IS_ERR(port->dev)) {
1166 err = PTR_ERR(port->dev);
1167 dev_err(&port->portdev->vdev->dev,
1168 "Error %d creating device for port %u\n",
1169 err, id);
1170 goto free_cdev;
1171 }
1172
1173 spin_lock_init(&port->inbuf_lock);
Amit Shahcdfadfc2010-05-19 22:15:50 -06001174 spin_lock_init(&port->outvq_lock);
Amit Shahc446f8f2010-05-19 22:15:48 -06001175 init_waitqueue_head(&port->waitqueue);
1176
1177 /* Fill the in_vq with buffers so the host can send us data. */
1178 nr_added_bufs = fill_queue(port->in_vq, &port->inbuf_lock);
1179 if (!nr_added_bufs) {
1180 dev_err(port->dev, "Error allocating inbufs\n");
1181 err = -ENOMEM;
1182 goto free_device;
1183 }
1184
1185 /*
1186 * If we're not using multiport support, this has to be a console port
1187 */
1188 if (!use_multiport(port->portdev)) {
1189 err = init_port_console(port);
1190 if (err)
1191 goto free_inbufs;
1192 }
1193
1194 spin_lock_irq(&portdev->ports_lock);
1195 list_add_tail(&port->list, &port->portdev->ports);
1196 spin_unlock_irq(&portdev->ports_lock);
1197
1198 /*
1199 * Tell the Host we're set so that it can send us various
1200 * configuration parameters for this port (eg, port name,
1201 * caching, whether this is a console port, etc.)
1202 */
1203 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1204
1205 if (pdrvdata.debugfs_dir) {
1206 /*
1207 * Finally, create the debugfs file that we can use to
1208 * inspect a port's state at any time
1209 */
1210 sprintf(debugfs_name, "vport%up%u",
1211 port->portdev->drv_index, id);
1212 port->debugfs_file = debugfs_create_file(debugfs_name, 0444,
1213 pdrvdata.debugfs_dir,
1214 port,
1215 &port_debugfs_ops);
1216 }
1217 return 0;
1218
1219free_inbufs:
1220 while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1221 free_buf(buf);
1222free_device:
1223 device_destroy(pdrvdata.class, port->dev->devt);
1224free_cdev:
Amit Shahd22a6982010-09-02 18:20:59 +05301225 cdev_del(port->cdev);
Amit Shahc446f8f2010-05-19 22:15:48 -06001226free_port:
1227 kfree(port);
1228fail:
1229 /* The host might want to notify management sw about port add failure */
Julia Lawall0643e4c2010-05-15 11:45:53 +02001230 __send_control_msg(portdev, id, VIRTIO_CONSOLE_PORT_READY, 0);
Amit Shahc446f8f2010-05-19 22:15:48 -06001231 return err;
1232}
1233
Amit Shahb353a6b2010-09-02 18:38:29 +05301234/* No users remain, remove all port-specific data. */
1235static void remove_port(struct kref *kref)
1236{
1237 struct port *port;
1238
1239 port = container_of(kref, struct port, kref);
1240
1241 sysfs_remove_group(&port->dev->kobj, &port_attribute_group);
1242 device_destroy(pdrvdata.class, port->dev->devt);
1243 cdev_del(port->cdev);
1244
1245 kfree(port->name);
1246
1247 debugfs_remove(port->debugfs_file);
1248
1249 kfree(port);
1250}
1251
1252/*
1253 * Port got unplugged. Remove port from portdev's list and drop the
1254 * kref reference. If no userspace has this port opened, it will
1255 * result in immediate removal the port.
1256 */
1257static void unplug_port(struct port *port)
Amit Shah1f7aa422009-12-21 22:27:31 +05301258{
Amit Shaha9cdd482010-02-12 10:32:15 +05301259 struct port_buffer *buf;
1260
Amit Shahb353a6b2010-09-02 18:38:29 +05301261 spin_lock_irq(&port->portdev->ports_lock);
1262 list_del(&port->list);
1263 spin_unlock_irq(&port->portdev->ports_lock);
1264
Amit Shah00476342010-05-27 13:24:39 +05301265 if (port->guest_connected) {
1266 port->guest_connected = false;
1267 port->host_connected = false;
1268 wake_up_interruptible(&port->waitqueue);
Amit Shaha461e112010-09-02 18:47:54 +05301269
1270 /* Let the app know the port is going down. */
1271 send_sigio_to_port(port);
Amit Shah00476342010-05-27 13:24:39 +05301272 }
1273
Amit Shah1f7aa422009-12-21 22:27:31 +05301274 if (is_console_port(port)) {
1275 spin_lock_irq(&pdrvdata_lock);
1276 list_del(&port->cons.list);
1277 spin_unlock_irq(&pdrvdata_lock);
1278 hvc_remove(port->cons.hvc);
1279 }
Amit Shah1f7aa422009-12-21 22:27:31 +05301280
Amit Shaha9cdd482010-02-12 10:32:15 +05301281 /* Remove unused data this port might have received. */
Amit Shah1f7aa422009-12-21 22:27:31 +05301282 discard_port_data(port);
Amit Shaha9cdd482010-02-12 10:32:15 +05301283
Amit Shahcdfadfc2010-05-19 22:15:50 -06001284 reclaim_consumed_buffers(port);
1285
Amit Shaha9cdd482010-02-12 10:32:15 +05301286 /* Remove buffers we queued up for the Host to send us data in. */
Michael S. Tsirkin505b0452010-04-12 16:18:32 +03001287 while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
Amit Shaha9cdd482010-02-12 10:32:15 +05301288 free_buf(buf);
1289
Amit Shahb353a6b2010-09-02 18:38:29 +05301290 /*
1291 * We should just assume the device itself has gone off --
1292 * else a close on an open port later will try to send out a
1293 * control message.
1294 */
1295 port->portdev = NULL;
Amit Shah1f7aa422009-12-21 22:27:31 +05301296
Amit Shahb353a6b2010-09-02 18:38:29 +05301297 /*
1298 * Locks around here are not necessary - a port can't be
1299 * opened after we removed the port struct from ports_list
1300 * above.
1301 */
1302 kref_put(&port->kref, remove_port);
Amit Shah1f7aa422009-12-21 22:27:31 +05301303}
1304
Amit Shah17634ba2009-12-21 21:03:25 +05301305/* Any private messages that the Host and Guest want to share */
1306static void handle_control_message(struct ports_device *portdev,
1307 struct port_buffer *buf)
1308{
1309 struct virtio_console_control *cpkt;
1310 struct port *port;
Amit Shah431edb82009-12-21 21:57:40 +05301311 size_t name_size;
1312 int err;
Amit Shah17634ba2009-12-21 21:03:25 +05301313
1314 cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
1315
1316 port = find_port_by_id(portdev, cpkt->id);
Amit Shahf909f852010-05-19 22:15:48 -06001317 if (!port && cpkt->event != VIRTIO_CONSOLE_PORT_ADD) {
Amit Shah17634ba2009-12-21 21:03:25 +05301318 /* No valid header at start of buffer. Drop it. */
1319 dev_dbg(&portdev->vdev->dev,
1320 "Invalid index %u in control packet\n", cpkt->id);
1321 return;
1322 }
1323
1324 switch (cpkt->event) {
Amit Shahf909f852010-05-19 22:15:48 -06001325 case VIRTIO_CONSOLE_PORT_ADD:
1326 if (port) {
Amit Shah1d051602010-05-19 22:15:49 -06001327 dev_dbg(&portdev->vdev->dev,
1328 "Port %u already added\n", port->id);
Amit Shahf909f852010-05-19 22:15:48 -06001329 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1330 break;
1331 }
1332 if (cpkt->id >= portdev->config.max_nr_ports) {
1333 dev_warn(&portdev->vdev->dev,
1334 "Request for adding port with out-of-bound id %u, max. supported id: %u\n",
1335 cpkt->id, portdev->config.max_nr_ports - 1);
1336 break;
1337 }
1338 add_port(portdev, cpkt->id);
1339 break;
1340 case VIRTIO_CONSOLE_PORT_REMOVE:
Amit Shahb353a6b2010-09-02 18:38:29 +05301341 unplug_port(port);
Amit Shahf909f852010-05-19 22:15:48 -06001342 break;
Amit Shah17634ba2009-12-21 21:03:25 +05301343 case VIRTIO_CONSOLE_CONSOLE_PORT:
1344 if (!cpkt->value)
1345 break;
1346 if (is_console_port(port))
1347 break;
1348
1349 init_port_console(port);
1350 /*
1351 * Could remove the port here in case init fails - but
1352 * have to notify the host first.
1353 */
1354 break;
Amit Shah8345adb2010-05-06 02:05:09 +05301355 case VIRTIO_CONSOLE_RESIZE: {
1356 struct {
1357 __u16 rows;
1358 __u16 cols;
1359 } size;
1360
Amit Shah17634ba2009-12-21 21:03:25 +05301361 if (!is_console_port(port))
1362 break;
Amit Shah8345adb2010-05-06 02:05:09 +05301363
1364 memcpy(&size, buf->buf + buf->offset + sizeof(*cpkt),
1365 sizeof(size));
1366 set_console_size(port, size.rows, size.cols);
1367
Amit Shah17634ba2009-12-21 21:03:25 +05301368 port->cons.hvc->irq_requested = 1;
1369 resize_console(port);
1370 break;
Amit Shah8345adb2010-05-06 02:05:09 +05301371 }
Amit Shah2030fa42009-12-21 21:49:30 +05301372 case VIRTIO_CONSOLE_PORT_OPEN:
1373 port->host_connected = cpkt->value;
1374 wake_up_interruptible(&port->waitqueue);
Amit Shahcdfadfc2010-05-19 22:15:50 -06001375 /*
1376 * If the host port got closed and the host had any
1377 * unconsumed buffers, we'll be able to reclaim them
1378 * now.
1379 */
1380 spin_lock_irq(&port->outvq_lock);
1381 reclaim_consumed_buffers(port);
1382 spin_unlock_irq(&port->outvq_lock);
Amit Shah3eae0ad2010-09-02 18:47:52 +05301383
1384 /*
1385 * If the guest is connected, it'll be interested in
1386 * knowing the host connection state changed.
1387 */
1388 send_sigio_to_port(port);
Amit Shah2030fa42009-12-21 21:49:30 +05301389 break;
Amit Shah431edb82009-12-21 21:57:40 +05301390 case VIRTIO_CONSOLE_PORT_NAME:
1391 /*
Amit Shah291024e2011-09-14 13:06:40 +05301392 * If we woke up after hibernation, we can get this
1393 * again. Skip it in that case.
1394 */
1395 if (port->name)
1396 break;
1397
1398 /*
Amit Shah431edb82009-12-21 21:57:40 +05301399 * Skip the size of the header and the cpkt to get the size
1400 * of the name that was sent
1401 */
1402 name_size = buf->len - buf->offset - sizeof(*cpkt) + 1;
1403
1404 port->name = kmalloc(name_size, GFP_KERNEL);
1405 if (!port->name) {
1406 dev_err(port->dev,
1407 "Not enough space to store port name\n");
1408 break;
1409 }
1410 strncpy(port->name, buf->buf + buf->offset + sizeof(*cpkt),
1411 name_size - 1);
1412 port->name[name_size - 1] = 0;
1413
1414 /*
1415 * Since we only have one sysfs attribute, 'name',
1416 * create it only if we have a name for the port.
1417 */
1418 err = sysfs_create_group(&port->dev->kobj,
1419 &port_attribute_group);
Amit Shahec642132010-03-19 17:36:43 +05301420 if (err) {
Amit Shah431edb82009-12-21 21:57:40 +05301421 dev_err(port->dev,
1422 "Error %d creating sysfs device attributes\n",
1423 err);
Amit Shahec642132010-03-19 17:36:43 +05301424 } else {
1425 /*
1426 * Generate a udev event so that appropriate
1427 * symlinks can be created based on udev
1428 * rules.
1429 */
1430 kobject_uevent(&port->dev->kobj, KOBJ_CHANGE);
1431 }
Amit Shah431edb82009-12-21 21:57:40 +05301432 break;
Amit Shah17634ba2009-12-21 21:03:25 +05301433 }
1434}
1435
1436static void control_work_handler(struct work_struct *work)
1437{
1438 struct ports_device *portdev;
1439 struct virtqueue *vq;
1440 struct port_buffer *buf;
1441 unsigned int len;
1442
1443 portdev = container_of(work, struct ports_device, control_work);
1444 vq = portdev->c_ivq;
1445
1446 spin_lock(&portdev->cvq_lock);
Michael S. Tsirkin505b0452010-04-12 16:18:32 +03001447 while ((buf = virtqueue_get_buf(vq, &len))) {
Amit Shah17634ba2009-12-21 21:03:25 +05301448 spin_unlock(&portdev->cvq_lock);
1449
1450 buf->len = len;
1451 buf->offset = 0;
1452
1453 handle_control_message(portdev, buf);
1454
1455 spin_lock(&portdev->cvq_lock);
1456 if (add_inbuf(portdev->c_ivq, buf) < 0) {
1457 dev_warn(&portdev->vdev->dev,
1458 "Error adding buffer to queue\n");
1459 free_buf(buf);
1460 }
1461 }
1462 spin_unlock(&portdev->cvq_lock);
1463}
1464
Amit Shah2770c5e2011-01-31 13:06:36 +05301465static void out_intr(struct virtqueue *vq)
1466{
1467 struct port *port;
1468
1469 port = find_port_by_vq(vq->vdev->priv, vq);
1470 if (!port)
1471 return;
1472
1473 wake_up_interruptible(&port->waitqueue);
1474}
1475
Amit Shah17634ba2009-12-21 21:03:25 +05301476static void in_intr(struct virtqueue *vq)
1477{
1478 struct port *port;
1479 unsigned long flags;
1480
1481 port = find_port_by_vq(vq->vdev->priv, vq);
1482 if (!port)
1483 return;
1484
1485 spin_lock_irqsave(&port->inbuf_lock, flags);
Amit Shahd25a9dd2011-09-14 13:06:43 +05301486 port->inbuf = get_inbuf(port);
Amit Shah17634ba2009-12-21 21:03:25 +05301487
Amit Shah88f251a2009-12-21 22:15:30 +05301488 /*
1489 * Don't queue up data when port is closed. This condition
1490 * can be reached when a console port is not yet connected (no
1491 * tty is spawned) and the host sends out data to console
1492 * ports. For generic serial ports, the host won't
1493 * (shouldn't) send data till the guest is connected.
1494 */
1495 if (!port->guest_connected)
1496 discard_port_data(port);
1497
Amit Shah17634ba2009-12-21 21:03:25 +05301498 spin_unlock_irqrestore(&port->inbuf_lock, flags);
1499
Amit Shah2030fa42009-12-21 21:49:30 +05301500 wake_up_interruptible(&port->waitqueue);
1501
Amit Shah55f6bcc2010-09-02 18:47:53 +05301502 /* Send a SIGIO indicating new data in case the process asked for it */
1503 send_sigio_to_port(port);
1504
Amit Shah17634ba2009-12-21 21:03:25 +05301505 if (is_console_port(port) && hvc_poll(port->cons.hvc))
1506 hvc_kick();
1507}
1508
1509static void control_intr(struct virtqueue *vq)
1510{
1511 struct ports_device *portdev;
1512
1513 portdev = vq->vdev->priv;
1514 schedule_work(&portdev->control_work);
1515}
1516
Amit Shah7f5d8102009-12-21 22:22:08 +05301517static void config_intr(struct virtio_device *vdev)
1518{
1519 struct ports_device *portdev;
1520
1521 portdev = vdev->priv;
Amit Shah99f905f2010-05-19 22:15:48 -06001522
Amit Shah4038f5b72010-05-06 02:05:07 +05301523 if (!use_multiport(portdev)) {
Amit Shah97788292010-05-06 02:05:08 +05301524 struct port *port;
1525 u16 rows, cols;
1526
1527 vdev->config->get(vdev,
1528 offsetof(struct virtio_console_config, cols),
1529 &cols, sizeof(u16));
1530 vdev->config->get(vdev,
1531 offsetof(struct virtio_console_config, rows),
1532 &rows, sizeof(u16));
1533
1534 port = find_port_by_id(portdev, 0);
1535 set_console_size(port, rows, cols);
1536
Amit Shah4038f5b72010-05-06 02:05:07 +05301537 /*
1538 * We'll use this way of resizing only for legacy
1539 * support. For newer userspace
1540 * (VIRTIO_CONSOLE_F_MULTPORT+), use control messages
1541 * to indicate console size changes so that it can be
1542 * done per-port.
1543 */
Amit Shah97788292010-05-06 02:05:08 +05301544 resize_console(port);
Amit Shah4038f5b72010-05-06 02:05:07 +05301545 }
Amit Shah7f5d8102009-12-21 22:22:08 +05301546}
1547
Amit Shah2658a792010-01-18 19:15:11 +05301548static int init_vqs(struct ports_device *portdev)
1549{
1550 vq_callback_t **io_callbacks;
1551 char **io_names;
1552 struct virtqueue **vqs;
Amit Shah17634ba2009-12-21 21:03:25 +05301553 u32 i, j, nr_ports, nr_queues;
Amit Shah2658a792010-01-18 19:15:11 +05301554 int err;
1555
Amit Shah17634ba2009-12-21 21:03:25 +05301556 nr_ports = portdev->config.max_nr_ports;
1557 nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
Amit Shah2658a792010-01-18 19:15:11 +05301558
1559 vqs = kmalloc(nr_queues * sizeof(struct virtqueue *), GFP_KERNEL);
Amit Shah2658a792010-01-18 19:15:11 +05301560 io_callbacks = kmalloc(nr_queues * sizeof(vq_callback_t *), GFP_KERNEL);
Amit Shah2658a792010-01-18 19:15:11 +05301561 io_names = kmalloc(nr_queues * sizeof(char *), GFP_KERNEL);
Amit Shah2658a792010-01-18 19:15:11 +05301562 portdev->in_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1563 GFP_KERNEL);
Amit Shah2658a792010-01-18 19:15:11 +05301564 portdev->out_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1565 GFP_KERNEL);
Jiri Slaby22e132f2010-11-06 10:06:50 +01001566 if (!vqs || !io_callbacks || !io_names || !portdev->in_vqs ||
Amit Shah286f9a22011-09-14 13:06:39 +05301567 !portdev->out_vqs) {
Amit Shah2658a792010-01-18 19:15:11 +05301568 err = -ENOMEM;
Jiri Slaby22e132f2010-11-06 10:06:50 +01001569 goto free;
Amit Shah2658a792010-01-18 19:15:11 +05301570 }
1571
Amit Shah17634ba2009-12-21 21:03:25 +05301572 /*
1573 * For backward compat (newer host but older guest), the host
1574 * spawns a console port first and also inits the vqs for port
1575 * 0 before others.
1576 */
1577 j = 0;
1578 io_callbacks[j] = in_intr;
Amit Shah2770c5e2011-01-31 13:06:36 +05301579 io_callbacks[j + 1] = out_intr;
Amit Shah17634ba2009-12-21 21:03:25 +05301580 io_names[j] = "input";
1581 io_names[j + 1] = "output";
1582 j += 2;
Amit Shah2658a792010-01-18 19:15:11 +05301583
Amit Shah17634ba2009-12-21 21:03:25 +05301584 if (use_multiport(portdev)) {
1585 io_callbacks[j] = control_intr;
1586 io_callbacks[j + 1] = NULL;
1587 io_names[j] = "control-i";
1588 io_names[j + 1] = "control-o";
1589
1590 for (i = 1; i < nr_ports; i++) {
1591 j += 2;
1592 io_callbacks[j] = in_intr;
Amit Shah2770c5e2011-01-31 13:06:36 +05301593 io_callbacks[j + 1] = out_intr;
Amit Shah17634ba2009-12-21 21:03:25 +05301594 io_names[j] = "input";
1595 io_names[j + 1] = "output";
1596 }
1597 }
Amit Shah2658a792010-01-18 19:15:11 +05301598 /* Find the queues. */
1599 err = portdev->vdev->config->find_vqs(portdev->vdev, nr_queues, vqs,
1600 io_callbacks,
1601 (const char **)io_names);
1602 if (err)
Jiri Slaby22e132f2010-11-06 10:06:50 +01001603 goto free;
Amit Shah2658a792010-01-18 19:15:11 +05301604
Amit Shah17634ba2009-12-21 21:03:25 +05301605 j = 0;
Amit Shah2658a792010-01-18 19:15:11 +05301606 portdev->in_vqs[0] = vqs[0];
1607 portdev->out_vqs[0] = vqs[1];
Amit Shah17634ba2009-12-21 21:03:25 +05301608 j += 2;
1609 if (use_multiport(portdev)) {
1610 portdev->c_ivq = vqs[j];
1611 portdev->c_ovq = vqs[j + 1];
Amit Shah2658a792010-01-18 19:15:11 +05301612
Amit Shah17634ba2009-12-21 21:03:25 +05301613 for (i = 1; i < nr_ports; i++) {
1614 j += 2;
1615 portdev->in_vqs[i] = vqs[j];
1616 portdev->out_vqs[i] = vqs[j + 1];
1617 }
1618 }
Amit Shah2658a792010-01-18 19:15:11 +05301619 kfree(io_names);
Jiri Slaby22e132f2010-11-06 10:06:50 +01001620 kfree(io_callbacks);
Amit Shah2658a792010-01-18 19:15:11 +05301621 kfree(vqs);
1622
1623 return 0;
1624
Jiri Slaby22e132f2010-11-06 10:06:50 +01001625free:
Amit Shah2658a792010-01-18 19:15:11 +05301626 kfree(portdev->out_vqs);
Amit Shah2658a792010-01-18 19:15:11 +05301627 kfree(portdev->in_vqs);
Jiri Slaby22e132f2010-11-06 10:06:50 +01001628 kfree(io_names);
1629 kfree(io_callbacks);
Amit Shah2658a792010-01-18 19:15:11 +05301630 kfree(vqs);
Jiri Slaby22e132f2010-11-06 10:06:50 +01001631
Amit Shah2658a792010-01-18 19:15:11 +05301632 return err;
1633}
1634
Amit Shahfb08bd22009-12-21 21:36:04 +05301635static const struct file_operations portdev_fops = {
1636 .owner = THIS_MODULE,
1637};
1638
Amit Shah1c85bf32010-01-18 19:15:07 +05301639/*
1640 * Once we're further in boot, we get probed like any other virtio
1641 * device.
Amit Shah17634ba2009-12-21 21:03:25 +05301642 *
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.
Amit Shah1c85bf32010-01-18 19:15:07 +05301646 */
1647static int __devinit virtcons_probe(struct virtio_device *vdev)
1648{
Amit Shah1c85bf32010-01-18 19:15:07 +05301649 struct ports_device *portdev;
1650 int err;
Amit Shah17634ba2009-12-21 21:03:25 +05301651 bool multiport;
Amit Shah1c85bf32010-01-18 19:15:07 +05301652
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
Amit Shahfb08bd22009-12-21 21:36:04 +05301663 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
Amit Shah17634ba2009-12-21 21:03:25 +05301677 multiport = false;
Amit Shah17634ba2009-12-21 21:03:25 +05301678 portdev->config.max_nr_ports = 1;
Sasha Levin51c6d612011-08-14 17:52:31 +03001679 if (virtio_config_val(vdev, VIRTIO_CONSOLE_F_MULTIPORT,
1680 offsetof(struct virtio_console_config,
1681 max_nr_ports),
1682 &portdev->config.max_nr_ports) == 0)
Amit Shah17634ba2009-12-21 21:03:25 +05301683 multiport = true;
Amit Shah17634ba2009-12-21 21:03:25 +05301684
Amit Shah2658a792010-01-18 19:15:11 +05301685 err = init_vqs(portdev);
1686 if (err < 0) {
1687 dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
Amit Shahfb08bd22009-12-21 21:36:04 +05301688 goto free_chrdev;
Amit Shah2658a792010-01-18 19:15:11 +05301689 }
Amit Shah1c85bf32010-01-18 19:15:07 +05301690
Amit Shah17634ba2009-12-21 21:03:25 +05301691 spin_lock_init(&portdev->ports_lock);
1692 INIT_LIST_HEAD(&portdev->ports);
1693
1694 if (multiport) {
Amit Shah335a64a5c2010-02-24 10:37:44 +05301695 unsigned int nr_added_bufs;
1696
Amit Shah17634ba2009-12-21 21:03:25 +05301697 spin_lock_init(&portdev->cvq_lock);
1698 INIT_WORK(&portdev->control_work, &control_work_handler);
1699
Amit Shah335a64a5c2010-02-24 10:37:44 +05301700 nr_added_bufs = fill_queue(portdev->c_ivq, &portdev->cvq_lock);
1701 if (!nr_added_bufs) {
Amit Shah22a29ea2010-02-12 10:32:17 +05301702 dev_err(&vdev->dev,
1703 "Error allocating buffers for control queue\n");
1704 err = -ENOMEM;
1705 goto free_vqs;
1706 }
Amit Shah1d051602010-05-19 22:15:49 -06001707 } else {
1708 /*
1709 * For backward compatibility: Create a console port
1710 * if we're running on older host.
1711 */
1712 add_port(portdev, 0);
Amit Shah17634ba2009-12-21 21:03:25 +05301713 }
1714
Amit Shah6bdf2af2010-09-02 18:11:49 +05301715 spin_lock_irq(&pdrvdata_lock);
1716 list_add_tail(&portdev->list, &pdrvdata.portdevs);
1717 spin_unlock_irq(&pdrvdata_lock);
1718
Amit Shahf909f852010-05-19 22:15:48 -06001719 __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1720 VIRTIO_CONSOLE_DEVICE_READY, 1);
Rusty Russell31610432007-10-22 11:03:39 +10001721 return 0;
1722
Amit Shah22a29ea2010-02-12 10:32:17 +05301723free_vqs:
Julia Lawall0643e4c2010-05-15 11:45:53 +02001724 /* The host might want to notify mgmt sw about device add failure */
1725 __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1726 VIRTIO_CONSOLE_DEVICE_READY, 0);
Amit Shah22a29ea2010-02-12 10:32:17 +05301727 vdev->config->del_vqs(vdev);
1728 kfree(portdev->in_vqs);
1729 kfree(portdev->out_vqs);
Amit Shahfb08bd22009-12-21 21:36:04 +05301730free_chrdev:
1731 unregister_chrdev(portdev->chr_major, "virtio-portsdev");
Rusty Russell31610432007-10-22 11:03:39 +10001732free:
Amit Shah1c85bf32010-01-18 19:15:07 +05301733 kfree(portdev);
Rusty Russell31610432007-10-22 11:03:39 +10001734fail:
1735 return err;
1736}
1737
Amit Shah71778762010-02-12 10:32:16 +05301738static void virtcons_remove(struct virtio_device *vdev)
1739{
1740 struct ports_device *portdev;
1741 struct port *port, *port2;
Amit Shah71778762010-02-12 10:32:16 +05301742
1743 portdev = vdev->priv;
1744
Amit Shah6bdf2af2010-09-02 18:11:49 +05301745 spin_lock_irq(&pdrvdata_lock);
1746 list_del(&portdev->list);
1747 spin_unlock_irq(&pdrvdata_lock);
1748
Amit Shah02238952010-09-02 18:11:40 +05301749 /* Disable interrupts for vqs */
1750 vdev->config->reset(vdev);
1751 /* Finish up work that's lined up */
Amit Shah71778762010-02-12 10:32:16 +05301752 cancel_work_sync(&portdev->control_work);
Amit Shah71778762010-02-12 10:32:16 +05301753
1754 list_for_each_entry_safe(port, port2, &portdev->ports, list)
Amit Shahb353a6b2010-09-02 18:38:29 +05301755 unplug_port(port);
Amit Shah71778762010-02-12 10:32:16 +05301756
1757 unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1758
Amit Shahe0620132010-09-02 18:38:30 +05301759 /*
1760 * When yanking out a device, we immediately lose the
1761 * (device-side) queues. So there's no point in keeping the
1762 * guest side around till we drop our final reference. This
1763 * also means that any ports which are in an open state will
1764 * have to just stop using the port, as the vqs are going
1765 * away.
1766 */
Amit Shah96eb8722010-09-02 18:11:41 +05301767 if (use_multiport(portdev)) {
1768 struct port_buffer *buf;
1769 unsigned int len;
Amit Shah71778762010-02-12 10:32:16 +05301770
Amit Shah96eb8722010-09-02 18:11:41 +05301771 while ((buf = virtqueue_get_buf(portdev->c_ivq, &len)))
1772 free_buf(buf);
1773
1774 while ((buf = virtqueue_detach_unused_buf(portdev->c_ivq)))
1775 free_buf(buf);
1776 }
Amit Shah71778762010-02-12 10:32:16 +05301777
1778 vdev->config->del_vqs(vdev);
1779 kfree(portdev->in_vqs);
1780 kfree(portdev->out_vqs);
1781
1782 kfree(portdev);
1783}
1784
Rusty Russell31610432007-10-22 11:03:39 +10001785static struct virtio_device_id id_table[] = {
1786 { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
1787 { 0 },
1788};
1789
Christian Borntraegerc2983452008-11-25 13:36:26 +01001790static unsigned int features[] = {
1791 VIRTIO_CONSOLE_F_SIZE,
Amit Shahb99fa812010-05-19 22:15:46 -06001792 VIRTIO_CONSOLE_F_MULTIPORT,
Christian Borntraegerc2983452008-11-25 13:36:26 +01001793};
1794
Rusty Russell31610432007-10-22 11:03:39 +10001795static struct virtio_driver virtio_console = {
Christian Borntraegerc2983452008-11-25 13:36:26 +01001796 .feature_table = features,
1797 .feature_table_size = ARRAY_SIZE(features),
Rusty Russell31610432007-10-22 11:03:39 +10001798 .driver.name = KBUILD_MODNAME,
1799 .driver.owner = THIS_MODULE,
1800 .id_table = id_table,
1801 .probe = virtcons_probe,
Amit Shah71778762010-02-12 10:32:16 +05301802 .remove = virtcons_remove,
Amit Shah7f5d8102009-12-21 22:22:08 +05301803 .config_changed = config_intr,
Rusty Russell31610432007-10-22 11:03:39 +10001804};
1805
1806static int __init init(void)
1807{
Amit Shahfb08bd22009-12-21 21:36:04 +05301808 int err;
1809
1810 pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
1811 if (IS_ERR(pdrvdata.class)) {
1812 err = PTR_ERR(pdrvdata.class);
1813 pr_err("Error %d creating virtio-ports class\n", err);
1814 return err;
1815 }
Amit Shahd99393e2009-12-21 22:36:21 +05301816
1817 pdrvdata.debugfs_dir = debugfs_create_dir("virtio-ports", NULL);
1818 if (!pdrvdata.debugfs_dir) {
1819 pr_warning("Error %ld creating debugfs dir for virtio-ports\n",
1820 PTR_ERR(pdrvdata.debugfs_dir));
1821 }
Amit Shah38edf582010-01-18 19:15:05 +05301822 INIT_LIST_HEAD(&pdrvdata.consoles);
Amit Shah6bdf2af2010-09-02 18:11:49 +05301823 INIT_LIST_HEAD(&pdrvdata.portdevs);
Amit Shah38edf582010-01-18 19:15:05 +05301824
Rusty Russell31610432007-10-22 11:03:39 +10001825 return register_virtio_driver(&virtio_console);
1826}
Amit Shah71778762010-02-12 10:32:16 +05301827
1828static void __exit fini(void)
1829{
1830 unregister_virtio_driver(&virtio_console);
1831
1832 class_destroy(pdrvdata.class);
1833 if (pdrvdata.debugfs_dir)
1834 debugfs_remove_recursive(pdrvdata.debugfs_dir);
1835}
Rusty Russell31610432007-10-22 11:03:39 +10001836module_init(init);
Amit Shah71778762010-02-12 10:32:16 +05301837module_exit(fini);
Rusty Russell31610432007-10-22 11:03:39 +10001838
1839MODULE_DEVICE_TABLE(virtio, id_table);
1840MODULE_DESCRIPTION("Virtio console driver");
1841MODULE_LICENSE("GPL");