2 * A bus for connecting virtio serial and console ports
4 * Copyright (C) 2009, 2010 Red Hat, Inc.
7 * Amit Shah <amit.shah@redhat.com>
9 * Some earlier parts are:
10 * Copyright IBM, Corp. 2008
12 * Christian Ehrhardt <ehrhardt@linux.vnet.ibm.com>
14 * This work is licensed under the terms of the GNU GPL, version 2. See
15 * the COPYING file in the top-level directory.
17 * Contributions after 2012-01-13 are licensed under the terms of the
18 * GNU GPL, version 2 or (at your option) any later version.
21 #include "qemu/osdep.h"
22 #include "qapi/error.h"
24 #include "monitor/monitor.h"
25 #include "qemu/error-report.h"
26 #include "qemu/queue.h"
27 #include "hw/sysbus.h"
29 #include "hw/virtio/virtio-serial.h"
30 #include "hw/virtio/virtio-access.h"
32 static struct VirtIOSerialDevices
{
33 QLIST_HEAD(, VirtIOSerial
) devices
;
36 static VirtIOSerialPort
*find_port_by_id(VirtIOSerial
*vser
, uint32_t id
)
38 VirtIOSerialPort
*port
;
40 if (id
== VIRTIO_CONSOLE_BAD_ID
) {
44 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
51 static VirtIOSerialPort
*find_port_by_vq(VirtIOSerial
*vser
, VirtQueue
*vq
)
53 VirtIOSerialPort
*port
;
55 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
56 if (port
->ivq
== vq
|| port
->ovq
== vq
)
62 static VirtIOSerialPort
*find_port_by_name(char *name
)
66 QLIST_FOREACH(vser
, &vserdevices
.devices
, next
) {
67 VirtIOSerialPort
*port
;
69 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
70 if (port
->name
&& !strcmp(port
->name
, name
)) {
78 static VirtIOSerialPort
*find_first_connected_console(VirtIOSerial
*vser
)
80 VirtIOSerialPort
*port
;
82 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
83 VirtIOSerialPortClass
const *vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
84 if (vsc
->is_console
&& port
->host_connected
) {
91 static bool use_multiport(VirtIOSerial
*vser
)
93 VirtIODevice
*vdev
= VIRTIO_DEVICE(vser
);
94 return virtio_vdev_has_feature(vdev
, VIRTIO_CONSOLE_F_MULTIPORT
);
97 static size_t write_to_port(VirtIOSerialPort
*port
,
98 const uint8_t *buf
, size_t size
)
100 VirtQueueElement
*elem
;
105 if (!virtio_queue_ready(vq
)) {
110 while (offset
< size
) {
113 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
118 len
= iov_from_buf(elem
->in_sg
, elem
->in_num
, 0,
119 buf
+ offset
, size
- offset
);
122 virtqueue_push(vq
, elem
, len
);
126 virtio_notify(VIRTIO_DEVICE(port
->vser
), vq
);
130 static void discard_vq_data(VirtQueue
*vq
, VirtIODevice
*vdev
)
132 VirtQueueElement
*elem
;
134 if (!virtio_queue_ready(vq
)) {
138 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
142 virtqueue_push(vq
, elem
, 0);
145 virtio_notify(vdev
, vq
);
148 static void discard_throttle_data(VirtIOSerialPort
*port
)
151 virtqueue_detach_element(port
->ovq
, port
->elem
, 0);
157 static void do_flush_queued_data(VirtIOSerialPort
*port
, VirtQueue
*vq
,
160 VirtIOSerialPortClass
*vsc
;
163 assert(virtio_queue_ready(vq
));
165 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
167 while (!port
->throttled
) {
170 /* Pop an elem only if we haven't left off a previous one mid-way */
172 port
->elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
177 port
->iov_offset
= 0;
180 for (i
= port
->iov_idx
; i
< port
->elem
->out_num
; i
++) {
184 buf_size
= port
->elem
->out_sg
[i
].iov_len
- port
->iov_offset
;
185 ret
= vsc
->have_data(port
,
186 port
->elem
->out_sg
[i
].iov_base
189 if (!port
->elem
) { /* bail if we got disconnected */
192 if (port
->throttled
) {
195 port
->iov_offset
+= ret
;
199 port
->iov_offset
= 0;
201 if (port
->throttled
) {
204 virtqueue_push(vq
, port
->elem
, 0);
208 virtio_notify(vdev
, vq
);
211 static void flush_queued_data(VirtIOSerialPort
*port
)
215 if (!virtio_queue_ready(port
->ovq
)) {
218 do_flush_queued_data(port
, port
->ovq
, VIRTIO_DEVICE(port
->vser
));
221 static size_t send_control_msg(VirtIOSerial
*vser
, void *buf
, size_t len
)
223 VirtQueueElement
*elem
;
227 if (!virtio_queue_ready(vq
)) {
231 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
236 /* TODO: detect a buffer that's too short, set NEEDS_RESET */
237 iov_from_buf(elem
->in_sg
, elem
->in_num
, 0, buf
, len
);
239 virtqueue_push(vq
, elem
, len
);
240 virtio_notify(VIRTIO_DEVICE(vser
), vq
);
246 static size_t send_control_event(VirtIOSerial
*vser
, uint32_t port_id
,
247 uint16_t event
, uint16_t value
)
249 VirtIODevice
*vdev
= VIRTIO_DEVICE(vser
);
250 struct virtio_console_control cpkt
;
252 virtio_stl_p(vdev
, &cpkt
.id
, port_id
);
253 virtio_stw_p(vdev
, &cpkt
.event
, event
);
254 virtio_stw_p(vdev
, &cpkt
.value
, value
);
256 trace_virtio_serial_send_control_event(port_id
, event
, value
);
257 return send_control_msg(vser
, &cpkt
, sizeof(cpkt
));
260 /* Functions for use inside qemu to open and read from/write to ports */
261 int virtio_serial_open(VirtIOSerialPort
*port
)
263 /* Don't allow opening an already-open port */
264 if (port
->host_connected
) {
267 /* Send port open notification to the guest */
268 port
->host_connected
= true;
269 send_control_event(port
->vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 1);
274 int virtio_serial_close(VirtIOSerialPort
*port
)
276 port
->host_connected
= false;
278 * If there's any data the guest sent which the app didn't
279 * consume, reset the throttling flag and discard the data.
281 port
->throttled
= false;
282 discard_throttle_data(port
);
283 discard_vq_data(port
->ovq
, VIRTIO_DEVICE(port
->vser
));
285 send_control_event(port
->vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 0);
290 /* Individual ports/apps call this function to write to the guest. */
291 ssize_t
virtio_serial_write(VirtIOSerialPort
*port
, const uint8_t *buf
,
294 if (!port
|| !port
->host_connected
|| !port
->guest_connected
) {
297 return write_to_port(port
, buf
, size
);
301 * Readiness of the guest to accept data on a port.
302 * Returns max. data the guest can receive
304 size_t virtio_serial_guest_ready(VirtIOSerialPort
*port
)
306 VirtIODevice
*vdev
= VIRTIO_DEVICE(port
->vser
);
307 VirtQueue
*vq
= port
->ivq
;
310 if (!virtio_queue_ready(vq
) ||
311 !(vdev
->status
& VIRTIO_CONFIG_S_DRIVER_OK
) ||
312 virtio_queue_empty(vq
)) {
315 if (use_multiport(port
->vser
) && !port
->guest_connected
) {
318 virtqueue_get_avail_bytes(vq
, &bytes
, NULL
, 4096, 0);
322 static void flush_queued_data_bh(void *opaque
)
324 VirtIOSerialPort
*port
= opaque
;
326 flush_queued_data(port
);
329 void virtio_serial_throttle_port(VirtIOSerialPort
*port
, bool throttle
)
335 trace_virtio_serial_throttle_port(port
->id
, throttle
);
336 port
->throttled
= throttle
;
340 qemu_bh_schedule(port
->bh
);
343 /* Guest wants to notify us of some event */
344 static void handle_control_message(VirtIOSerial
*vser
, void *buf
, size_t len
)
346 VirtIODevice
*vdev
= VIRTIO_DEVICE(vser
);
347 struct VirtIOSerialPort
*port
;
348 VirtIOSerialPortClass
*vsc
;
349 struct virtio_console_control cpkt
, *gcpkt
;
355 if (len
< sizeof(cpkt
)) {
356 /* The guest sent an invalid control packet */
360 cpkt
.event
= virtio_lduw_p(vdev
, &gcpkt
->event
);
361 cpkt
.value
= virtio_lduw_p(vdev
, &gcpkt
->value
);
363 trace_virtio_serial_handle_control_message(cpkt
.event
, cpkt
.value
);
365 if (cpkt
.event
== VIRTIO_CONSOLE_DEVICE_READY
) {
367 error_report("virtio-serial-bus: Guest failure in adding device %s",
368 vser
->bus
.qbus
.name
);
372 * The device is up, we can now tell the device about all the
373 * ports we have here.
375 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
376 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_ADD
, 1);
381 port
= find_port_by_id(vser
, virtio_ldl_p(vdev
, &gcpkt
->id
));
383 error_report("virtio-serial-bus: Unexpected port id %u for device %s",
384 virtio_ldl_p(vdev
, &gcpkt
->id
), vser
->bus
.qbus
.name
);
388 trace_virtio_serial_handle_control_message_port(port
->id
);
390 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
393 case VIRTIO_CONSOLE_PORT_READY
:
395 error_report("virtio-serial-bus: Guest failure in adding port %u for device %s",
396 port
->id
, vser
->bus
.qbus
.name
);
400 * Now that we know the guest asked for the port name, we're
401 * sure the guest has initialised whatever state is necessary
402 * for this port. Now's a good time to let the guest know if
403 * this port is a console port so that the guest can hook it
406 if (vsc
->is_console
) {
407 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_CONSOLE_PORT
, 1);
411 virtio_stl_p(vdev
, &cpkt
.id
, port
->id
);
412 virtio_stw_p(vdev
, &cpkt
.event
, VIRTIO_CONSOLE_PORT_NAME
);
413 virtio_stw_p(vdev
, &cpkt
.value
, 1);
415 buffer_len
= sizeof(cpkt
) + strlen(port
->name
) + 1;
416 buffer
= g_malloc(buffer_len
);
418 memcpy(buffer
, &cpkt
, sizeof(cpkt
));
419 memcpy(buffer
+ sizeof(cpkt
), port
->name
, strlen(port
->name
));
420 buffer
[buffer_len
- 1] = 0;
422 send_control_msg(vser
, buffer
, buffer_len
);
426 if (port
->host_connected
) {
427 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 1);
431 * When the guest has asked us for this information it means
432 * the guest is all setup and has its virtqueues
433 * initialised. If some app is interested in knowing about
434 * this event, let it know.
436 if (vsc
->guest_ready
) {
437 vsc
->guest_ready(port
);
441 case VIRTIO_CONSOLE_PORT_OPEN
:
442 port
->guest_connected
= cpkt
.value
;
443 if (vsc
->set_guest_connected
) {
444 /* Send the guest opened notification if an app is interested */
445 vsc
->set_guest_connected(port
, cpkt
.value
);
451 static void control_in(VirtIODevice
*vdev
, VirtQueue
*vq
)
455 static void control_out(VirtIODevice
*vdev
, VirtQueue
*vq
)
457 VirtQueueElement
*elem
;
462 vser
= VIRTIO_SERIAL(vdev
);
469 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
474 cur_len
= iov_size(elem
->out_sg
, elem
->out_num
);
476 * Allocate a new buf only if we didn't have one previously or
477 * if the size of the buf differs
482 buf
= g_malloc(cur_len
);
485 iov_to_buf(elem
->out_sg
, elem
->out_num
, 0, buf
, cur_len
);
487 handle_control_message(vser
, buf
, cur_len
);
488 virtqueue_push(vq
, elem
, 0);
492 virtio_notify(vdev
, vq
);
495 /* Guest wrote something to some port. */
496 static void handle_output(VirtIODevice
*vdev
, VirtQueue
*vq
)
499 VirtIOSerialPort
*port
;
501 vser
= VIRTIO_SERIAL(vdev
);
502 port
= find_port_by_vq(vser
, vq
);
504 if (!port
|| !port
->host_connected
) {
505 discard_vq_data(vq
, vdev
);
509 if (!port
->throttled
) {
510 do_flush_queued_data(port
, vq
, vdev
);
515 static void handle_input(VirtIODevice
*vdev
, VirtQueue
*vq
)
518 * Users of virtio-serial would like to know when guest becomes
519 * writable again -- i.e. if a vq had stuff queued up and the
520 * guest wasn't reading at all, the host would not be able to
521 * write to the vq anymore. Once the guest reads off something,
522 * we can start queueing things up again. However, this call is
523 * made for each buffer addition by the guest -- even though free
524 * buffers existed prior to the current buffer addition. This is
525 * done so as not to maintain previous state, which will need
526 * additional live-migration-related changes.
529 VirtIOSerialPort
*port
;
530 VirtIOSerialPortClass
*vsc
;
532 vser
= VIRTIO_SERIAL(vdev
);
533 port
= find_port_by_vq(vser
, vq
);
538 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
541 * If guest_connected is false, this call is being made by the
542 * early-boot queueing up of descriptors, which is just noise for
543 * the host apps -- don't disturb them in that case.
545 if (port
->guest_connected
&& port
->host_connected
&& vsc
->guest_writable
) {
546 vsc
->guest_writable(port
);
550 static uint64_t get_features(VirtIODevice
*vdev
, uint64_t features
,
555 vser
= VIRTIO_SERIAL(vdev
);
557 features
|= vser
->host_features
;
558 if (vser
->bus
.max_nr_ports
> 1) {
559 virtio_add_feature(&features
, VIRTIO_CONSOLE_F_MULTIPORT
);
564 /* Guest requested config info */
565 static void get_config(VirtIODevice
*vdev
, uint8_t *config_data
)
567 VirtIOSerial
*vser
= VIRTIO_SERIAL(vdev
);
568 struct virtio_console_config
*config
=
569 (struct virtio_console_config
*)config_data
;
573 config
->max_nr_ports
= virtio_tswap32(vdev
,
574 vser
->serial
.max_virtserial_ports
);
577 /* Guest sent new config info */
578 static void set_config(VirtIODevice
*vdev
, const uint8_t *config_data
)
580 VirtIOSerial
*vser
= VIRTIO_SERIAL(vdev
);
581 struct virtio_console_config
*config
=
582 (struct virtio_console_config
*)config_data
;
583 uint8_t emerg_wr_lo
= le32_to_cpu(config
->emerg_wr
);
584 VirtIOSerialPort
*port
= find_first_connected_console(vser
);
585 VirtIOSerialPortClass
*vsc
;
587 if (!config
->emerg_wr
) {
590 /* Make sure we don't misdetect an emergency write when the guest
591 * does a short config write after an emergency write. */
592 config
->emerg_wr
= 0;
596 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
597 (void)vsc
->have_data(port
, &emerg_wr_lo
, 1);
600 static void guest_reset(VirtIOSerial
*vser
)
602 VirtIOSerialPort
*port
;
603 VirtIOSerialPortClass
*vsc
;
605 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
606 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
608 discard_throttle_data(port
);
610 if (port
->guest_connected
) {
611 port
->guest_connected
= false;
612 if (vsc
->set_guest_connected
) {
613 vsc
->set_guest_connected(port
, false);
619 static void set_status(VirtIODevice
*vdev
, uint8_t status
)
622 VirtIOSerialPort
*port
;
624 vser
= VIRTIO_SERIAL(vdev
);
625 port
= find_port_by_id(vser
, 0);
627 if (port
&& !use_multiport(port
->vser
)
628 && (status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
630 * Non-multiport guests won't be able to tell us guest
631 * open/close status. Such guests can only have a port at id
632 * 0, so set guest_connected for such ports as soon as guest
635 port
->guest_connected
= true;
637 if (!(status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
642 static void vser_reset(VirtIODevice
*vdev
)
646 vser
= VIRTIO_SERIAL(vdev
);
650 static void virtio_serial_save_device(VirtIODevice
*vdev
, QEMUFile
*f
)
652 VirtIOSerial
*s
= VIRTIO_SERIAL(vdev
);
653 VirtIOSerialPort
*port
;
654 uint32_t nr_active_ports
;
655 unsigned int i
, max_nr_ports
;
656 struct virtio_console_config config
;
658 /* The config space (ignored on the far end in current versions) */
659 get_config(vdev
, (uint8_t *)&config
);
660 qemu_put_be16s(f
, &config
.cols
);
661 qemu_put_be16s(f
, &config
.rows
);
662 qemu_put_be32s(f
, &config
.max_nr_ports
);
665 max_nr_ports
= s
->serial
.max_virtserial_ports
;
666 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
667 qemu_put_be32s(f
, &s
->ports_map
[i
]);
673 QTAILQ_FOREACH(port
, &s
->ports
, next
) {
677 qemu_put_be32s(f
, &nr_active_ports
);
680 * Items in struct VirtIOSerialPort.
682 QTAILQ_FOREACH(port
, &s
->ports
, next
) {
683 uint32_t elem_popped
;
685 qemu_put_be32s(f
, &port
->id
);
686 qemu_put_byte(f
, port
->guest_connected
);
687 qemu_put_byte(f
, port
->host_connected
);
693 qemu_put_be32s(f
, &elem_popped
);
695 qemu_put_be32s(f
, &port
->iov_idx
);
696 qemu_put_be64s(f
, &port
->iov_offset
);
697 qemu_put_virtqueue_element(f
, port
->elem
);
702 static void virtio_serial_post_load_timer_cb(void *opaque
)
705 VirtIOSerial
*s
= VIRTIO_SERIAL(opaque
);
706 VirtIOSerialPort
*port
;
707 uint8_t host_connected
;
708 VirtIOSerialPortClass
*vsc
;
713 for (i
= 0 ; i
< s
->post_load
->nr_active_ports
; ++i
) {
714 port
= s
->post_load
->connected
[i
].port
;
715 host_connected
= s
->post_load
->connected
[i
].host_connected
;
716 if (host_connected
!= port
->host_connected
) {
718 * We have to let the guest know of the host connection
721 send_control_event(s
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
,
722 port
->host_connected
);
724 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
725 if (vsc
->set_guest_connected
) {
726 vsc
->set_guest_connected(port
, port
->guest_connected
);
729 g_free(s
->post_load
->connected
);
730 timer_del(s
->post_load
->timer
);
731 timer_free(s
->post_load
->timer
);
732 g_free(s
->post_load
);
736 static int fetch_active_ports_list(QEMUFile
*f
,
737 VirtIOSerial
*s
, uint32_t nr_active_ports
)
739 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
742 s
->post_load
= g_malloc0(sizeof(*s
->post_load
));
743 s
->post_load
->nr_active_ports
= nr_active_ports
;
744 s
->post_load
->connected
=
745 g_malloc0(sizeof(*s
->post_load
->connected
) * nr_active_ports
);
747 s
->post_load
->timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
,
748 virtio_serial_post_load_timer_cb
,
751 /* Items in struct VirtIOSerialPort */
752 for (i
= 0; i
< nr_active_ports
; i
++) {
753 VirtIOSerialPort
*port
;
754 uint32_t elem_popped
;
757 id
= qemu_get_be32(f
);
758 port
= find_port_by_id(s
, id
);
763 port
->guest_connected
= qemu_get_byte(f
);
764 s
->post_load
->connected
[i
].port
= port
;
765 s
->post_load
->connected
[i
].host_connected
= qemu_get_byte(f
);
767 qemu_get_be32s(f
, &elem_popped
);
769 qemu_get_be32s(f
, &port
->iov_idx
);
770 qemu_get_be64s(f
, &port
->iov_offset
);
773 qemu_get_virtqueue_element(vdev
, f
, sizeof(VirtQueueElement
));
776 * Port was throttled on source machine. Let's
777 * unthrottle it here so data starts flowing again.
779 virtio_serial_throttle_port(port
, false);
782 timer_mod(s
->post_load
->timer
, 1);
786 static int virtio_serial_load_device(VirtIODevice
*vdev
, QEMUFile
*f
,
789 VirtIOSerial
*s
= VIRTIO_SERIAL(vdev
);
790 uint32_t max_nr_ports
, nr_active_ports
, ports_map
;
796 qemu_get_be16s(f
, (uint16_t *) &tmp
);
797 qemu_get_be16s(f
, (uint16_t *) &tmp
);
798 qemu_get_be32s(f
, &tmp
);
800 max_nr_ports
= s
->serial
.max_virtserial_ports
;
801 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
802 qemu_get_be32s(f
, &ports_map
);
804 if (ports_map
!= s
->ports_map
[i
]) {
806 * Ports active on source and destination don't
807 * match. Fail migration.
813 qemu_get_be32s(f
, &nr_active_ports
);
815 if (nr_active_ports
) {
816 ret
= fetch_active_ports_list(f
, s
, nr_active_ports
);
824 static void virtser_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
);
826 static Property virtser_props
[] = {
827 DEFINE_PROP_UINT32("nr", VirtIOSerialPort
, id
, VIRTIO_CONSOLE_BAD_ID
),
828 DEFINE_PROP_STRING("name", VirtIOSerialPort
, name
),
829 DEFINE_PROP_END_OF_LIST()
832 #define TYPE_VIRTIO_SERIAL_BUS "virtio-serial-bus"
833 #define VIRTIO_SERIAL_BUS(obj) \
834 OBJECT_CHECK(VirtIOSerialBus, (obj), TYPE_VIRTIO_SERIAL_BUS)
836 static void virtser_bus_class_init(ObjectClass
*klass
, void *data
)
838 BusClass
*k
= BUS_CLASS(klass
);
839 k
->print_dev
= virtser_bus_dev_print
;
842 static const TypeInfo virtser_bus_info
= {
843 .name
= TYPE_VIRTIO_SERIAL_BUS
,
845 .instance_size
= sizeof(VirtIOSerialBus
),
846 .class_init
= virtser_bus_class_init
,
849 static void virtser_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
)
851 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(qdev
);
853 monitor_printf(mon
, "%*sport %d, guest %s, host %s, throttle %s\n",
854 indent
, "", port
->id
,
855 port
->guest_connected
? "on" : "off",
856 port
->host_connected
? "on" : "off",
857 port
->throttled
? "on" : "off");
860 /* This function is only used if a port id is not provided by the user */
861 static uint32_t find_free_port_id(VirtIOSerial
*vser
)
863 unsigned int i
, max_nr_ports
;
865 max_nr_ports
= vser
->serial
.max_virtserial_ports
;
866 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
867 uint32_t map
, zeroes
;
869 map
= vser
->ports_map
[i
];
870 zeroes
= ctz32(~map
);
872 return zeroes
+ i
* 32;
875 return VIRTIO_CONSOLE_BAD_ID
;
878 static void mark_port_added(VirtIOSerial
*vser
, uint32_t port_id
)
883 vser
->ports_map
[i
] |= 1U << (port_id
% 32);
886 static void add_port(VirtIOSerial
*vser
, uint32_t port_id
)
888 mark_port_added(vser
, port_id
);
889 send_control_event(vser
, port_id
, VIRTIO_CONSOLE_PORT_ADD
, 1);
892 static void remove_port(VirtIOSerial
*vser
, uint32_t port_id
)
894 VirtIOSerialPort
*port
;
897 * Don't mark port 0 removed -- we explicitly reserve it for
898 * backward compat with older guests, ensure a virtconsole device
899 * unplug retains the reservation.
905 vser
->ports_map
[i
] &= ~(1U << (port_id
% 32));
908 port
= find_port_by_id(vser
, port_id
);
910 * This function is only called from qdev's unplug callback; if we
911 * get a NULL port here, we're in trouble.
915 /* Flush out any unconsumed buffers first */
916 discard_throttle_data(port
);
917 discard_vq_data(port
->ovq
, VIRTIO_DEVICE(port
->vser
));
919 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_REMOVE
, 1);
922 static void virtser_port_device_realize(DeviceState
*dev
, Error
**errp
)
924 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
925 VirtIOSerialPortClass
*vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
926 VirtIOSerialBus
*bus
= VIRTIO_SERIAL_BUS(qdev_get_parent_bus(dev
));
931 port
->vser
= bus
->vser
;
932 port
->bh
= qemu_bh_new(flush_queued_data_bh
, port
);
934 assert(vsc
->have_data
);
937 * Is the first console port we're seeing? If so, put it up at
938 * location 0. This is done for backward compatibility (old
941 plugging_port0
= vsc
->is_console
&& !find_port_by_id(port
->vser
, 0);
943 if (find_port_by_id(port
->vser
, port
->id
)) {
944 error_setg(errp
, "virtio-serial-bus: A port already exists at id %u",
949 if (port
->name
!= NULL
&& find_port_by_name(port
->name
)) {
950 error_setg(errp
, "virtio-serial-bus: A port already exists by name %s",
955 if (port
->id
== VIRTIO_CONSOLE_BAD_ID
) {
956 if (plugging_port0
) {
959 port
->id
= find_free_port_id(port
->vser
);
960 if (port
->id
== VIRTIO_CONSOLE_BAD_ID
) {
961 error_setg(errp
, "virtio-serial-bus: Maximum port limit for "
962 "this device reached");
968 max_nr_ports
= port
->vser
->serial
.max_virtserial_ports
;
969 if (port
->id
>= max_nr_ports
) {
970 error_setg(errp
, "virtio-serial-bus: Out-of-range port id specified, "
971 "max. allowed: %u", max_nr_ports
- 1);
975 vsc
->realize(dev
, &err
);
977 error_propagate(errp
, err
);
984 static void virtser_port_device_plug(HotplugHandler
*hotplug_dev
,
985 DeviceState
*dev
, Error
**errp
)
987 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
989 QTAILQ_INSERT_TAIL(&port
->vser
->ports
, port
, next
);
990 port
->ivq
= port
->vser
->ivqs
[port
->id
];
991 port
->ovq
= port
->vser
->ovqs
[port
->id
];
993 add_port(port
->vser
, port
->id
);
995 /* Send an update to the guest about this new port added */
996 virtio_notify_config(VIRTIO_DEVICE(hotplug_dev
));
999 static void virtser_port_device_unrealize(DeviceState
*dev
, Error
**errp
)
1001 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
1002 VirtIOSerialPortClass
*vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(dev
);
1003 VirtIOSerial
*vser
= port
->vser
;
1005 qemu_bh_delete(port
->bh
);
1006 remove_port(port
->vser
, port
->id
);
1008 QTAILQ_REMOVE(&vser
->ports
, port
, next
);
1010 if (vsc
->unrealize
) {
1011 vsc
->unrealize(dev
, errp
);
1015 static void virtio_serial_device_realize(DeviceState
*dev
, Error
**errp
)
1017 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
1018 VirtIOSerial
*vser
= VIRTIO_SERIAL(dev
);
1019 uint32_t i
, max_supported_ports
;
1020 size_t config_size
= sizeof(struct virtio_console_config
);
1022 if (!vser
->serial
.max_virtserial_ports
) {
1023 error_setg(errp
, "Maximum number of serial ports not specified");
1027 /* Each port takes 2 queues, and one pair is for the control queue */
1028 max_supported_ports
= VIRTIO_QUEUE_MAX
/ 2 - 1;
1030 if (vser
->serial
.max_virtserial_ports
> max_supported_ports
) {
1031 error_setg(errp
, "maximum ports supported: %u", max_supported_ports
);
1035 if (!virtio_has_feature(vser
->host_features
,
1036 VIRTIO_CONSOLE_F_EMERG_WRITE
)) {
1037 config_size
= offsetof(struct virtio_console_config
, emerg_wr
);
1039 virtio_init(vdev
, "virtio-serial", VIRTIO_ID_CONSOLE
,
1042 /* Spawn a new virtio-serial bus on which the ports will ride as devices */
1043 qbus_create_inplace(&vser
->bus
, sizeof(vser
->bus
), TYPE_VIRTIO_SERIAL_BUS
,
1044 dev
, vdev
->bus_name
);
1045 qbus_set_hotplug_handler(BUS(&vser
->bus
), DEVICE(vser
), errp
);
1046 vser
->bus
.vser
= vser
;
1047 QTAILQ_INIT(&vser
->ports
);
1049 vser
->bus
.max_nr_ports
= vser
->serial
.max_virtserial_ports
;
1050 vser
->ivqs
= g_malloc(vser
->serial
.max_virtserial_ports
1051 * sizeof(VirtQueue
*));
1052 vser
->ovqs
= g_malloc(vser
->serial
.max_virtserial_ports
1053 * sizeof(VirtQueue
*));
1055 /* Add a queue for host to guest transfers for port 0 (backward compat) */
1056 vser
->ivqs
[0] = virtio_add_queue(vdev
, 128, handle_input
);
1057 /* Add a queue for guest to host transfers for port 0 (backward compat) */
1058 vser
->ovqs
[0] = virtio_add_queue(vdev
, 128, handle_output
);
1060 /* TODO: host to guest notifications can get dropped
1061 * if the queue fills up. Implement queueing in host,
1062 * this might also make it possible to reduce the control
1063 * queue size: as guest preposts buffers there,
1064 * this will save 4Kbyte of guest memory per entry. */
1066 /* control queue: host to guest */
1067 vser
->c_ivq
= virtio_add_queue(vdev
, 32, control_in
);
1068 /* control queue: guest to host */
1069 vser
->c_ovq
= virtio_add_queue(vdev
, 32, control_out
);
1071 for (i
= 1; i
< vser
->bus
.max_nr_ports
; i
++) {
1072 /* Add a per-port queue for host to guest transfers */
1073 vser
->ivqs
[i
] = virtio_add_queue(vdev
, 128, handle_input
);
1074 /* Add a per-per queue for guest to host transfers */
1075 vser
->ovqs
[i
] = virtio_add_queue(vdev
, 128, handle_output
);
1078 vser
->ports_map
= g_malloc0(((vser
->serial
.max_virtserial_ports
+ 31) / 32)
1079 * sizeof(vser
->ports_map
[0]));
1081 * Reserve location 0 for a console port for backward compat
1082 * (old kernel, new qemu)
1084 mark_port_added(vser
, 0);
1086 vser
->post_load
= NULL
;
1088 QLIST_INSERT_HEAD(&vserdevices
.devices
, vser
, next
);
1091 static void virtio_serial_port_class_init(ObjectClass
*klass
, void *data
)
1093 DeviceClass
*k
= DEVICE_CLASS(klass
);
1095 set_bit(DEVICE_CATEGORY_INPUT
, k
->categories
);
1096 k
->bus_type
= TYPE_VIRTIO_SERIAL_BUS
;
1097 k
->realize
= virtser_port_device_realize
;
1098 k
->unrealize
= virtser_port_device_unrealize
;
1099 k
->props
= virtser_props
;
1102 static const TypeInfo virtio_serial_port_type_info
= {
1103 .name
= TYPE_VIRTIO_SERIAL_PORT
,
1104 .parent
= TYPE_DEVICE
,
1105 .instance_size
= sizeof(VirtIOSerialPort
),
1107 .class_size
= sizeof(VirtIOSerialPortClass
),
1108 .class_init
= virtio_serial_port_class_init
,
1111 static void virtio_serial_device_unrealize(DeviceState
*dev
, Error
**errp
)
1113 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
1114 VirtIOSerial
*vser
= VIRTIO_SERIAL(dev
);
1116 QLIST_REMOVE(vser
, next
);
1120 g_free(vser
->ports_map
);
1121 if (vser
->post_load
) {
1122 g_free(vser
->post_load
->connected
);
1123 timer_del(vser
->post_load
->timer
);
1124 timer_free(vser
->post_load
->timer
);
1125 g_free(vser
->post_load
);
1128 qbus_set_hotplug_handler(BUS(&vser
->bus
), NULL
, errp
);
1130 virtio_cleanup(vdev
);
1133 /* Note: 'console' is used for backwards compatibility */
1134 static const VMStateDescription vmstate_virtio_console
= {
1135 .name
= "virtio-console",
1136 .minimum_version_id
= 3,
1138 .fields
= (VMStateField
[]) {
1139 VMSTATE_VIRTIO_DEVICE
,
1140 VMSTATE_END_OF_LIST()
1144 static Property virtio_serial_properties
[] = {
1145 DEFINE_PROP_UINT32("max_ports", VirtIOSerial
, serial
.max_virtserial_ports
,
1147 DEFINE_PROP_BIT64("emergency-write", VirtIOSerial
, host_features
,
1148 VIRTIO_CONSOLE_F_EMERG_WRITE
, true),
1149 DEFINE_PROP_END_OF_LIST(),
1152 static void virtio_serial_class_init(ObjectClass
*klass
, void *data
)
1154 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1155 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
1156 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
1158 QLIST_INIT(&vserdevices
.devices
);
1160 dc
->props
= virtio_serial_properties
;
1161 dc
->vmsd
= &vmstate_virtio_console
;
1162 set_bit(DEVICE_CATEGORY_INPUT
, dc
->categories
);
1163 vdc
->realize
= virtio_serial_device_realize
;
1164 vdc
->unrealize
= virtio_serial_device_unrealize
;
1165 vdc
->get_features
= get_features
;
1166 vdc
->get_config
= get_config
;
1167 vdc
->set_config
= set_config
;
1168 vdc
->set_status
= set_status
;
1169 vdc
->reset
= vser_reset
;
1170 vdc
->save
= virtio_serial_save_device
;
1171 vdc
->load
= virtio_serial_load_device
;
1172 hc
->plug
= virtser_port_device_plug
;
1173 hc
->unplug
= qdev_simple_device_unplug_cb
;
1176 static const TypeInfo virtio_device_info
= {
1177 .name
= TYPE_VIRTIO_SERIAL
,
1178 .parent
= TYPE_VIRTIO_DEVICE
,
1179 .instance_size
= sizeof(VirtIOSerial
),
1180 .class_init
= virtio_serial_class_init
,
1181 .interfaces
= (InterfaceInfo
[]) {
1182 { TYPE_HOTPLUG_HANDLER
},
1187 static void virtio_serial_register_types(void)
1189 type_register_static(&virtser_bus_info
);
1190 type_register_static(&virtio_serial_port_type_info
);
1191 type_register_static(&virtio_device_info
);
1194 type_init(virtio_serial_register_types
)