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
->throttled
) {
192 port
->iov_offset
+= ret
;
196 port
->iov_offset
= 0;
198 if (port
->throttled
) {
201 virtqueue_push(vq
, port
->elem
, 0);
205 virtio_notify(vdev
, vq
);
208 static void flush_queued_data(VirtIOSerialPort
*port
)
212 if (!virtio_queue_ready(port
->ovq
)) {
215 do_flush_queued_data(port
, port
->ovq
, VIRTIO_DEVICE(port
->vser
));
218 static size_t send_control_msg(VirtIOSerial
*vser
, void *buf
, size_t len
)
220 VirtQueueElement
*elem
;
224 if (!virtio_queue_ready(vq
)) {
228 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
233 /* TODO: detect a buffer that's too short, set NEEDS_RESET */
234 iov_from_buf(elem
->in_sg
, elem
->in_num
, 0, buf
, len
);
236 virtqueue_push(vq
, elem
, len
);
237 virtio_notify(VIRTIO_DEVICE(vser
), vq
);
243 static size_t send_control_event(VirtIOSerial
*vser
, uint32_t port_id
,
244 uint16_t event
, uint16_t value
)
246 VirtIODevice
*vdev
= VIRTIO_DEVICE(vser
);
247 struct virtio_console_control cpkt
;
249 virtio_stl_p(vdev
, &cpkt
.id
, port_id
);
250 virtio_stw_p(vdev
, &cpkt
.event
, event
);
251 virtio_stw_p(vdev
, &cpkt
.value
, value
);
253 trace_virtio_serial_send_control_event(port_id
, event
, value
);
254 return send_control_msg(vser
, &cpkt
, sizeof(cpkt
));
257 /* Functions for use inside qemu to open and read from/write to ports */
258 int virtio_serial_open(VirtIOSerialPort
*port
)
260 /* Don't allow opening an already-open port */
261 if (port
->host_connected
) {
264 /* Send port open notification to the guest */
265 port
->host_connected
= true;
266 send_control_event(port
->vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 1);
271 int virtio_serial_close(VirtIOSerialPort
*port
)
273 port
->host_connected
= false;
275 * If there's any data the guest sent which the app didn't
276 * consume, reset the throttling flag and discard the data.
278 port
->throttled
= false;
279 discard_throttle_data(port
);
280 discard_vq_data(port
->ovq
, VIRTIO_DEVICE(port
->vser
));
282 send_control_event(port
->vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 0);
287 /* Individual ports/apps call this function to write to the guest. */
288 ssize_t
virtio_serial_write(VirtIOSerialPort
*port
, const uint8_t *buf
,
291 if (!port
|| !port
->host_connected
|| !port
->guest_connected
) {
294 return write_to_port(port
, buf
, size
);
298 * Readiness of the guest to accept data on a port.
299 * Returns max. data the guest can receive
301 size_t virtio_serial_guest_ready(VirtIOSerialPort
*port
)
303 VirtIODevice
*vdev
= VIRTIO_DEVICE(port
->vser
);
304 VirtQueue
*vq
= port
->ivq
;
307 if (!virtio_queue_ready(vq
) ||
308 !(vdev
->status
& VIRTIO_CONFIG_S_DRIVER_OK
) ||
309 virtio_queue_empty(vq
)) {
312 if (use_multiport(port
->vser
) && !port
->guest_connected
) {
315 virtqueue_get_avail_bytes(vq
, &bytes
, NULL
, 4096, 0);
319 static void flush_queued_data_bh(void *opaque
)
321 VirtIOSerialPort
*port
= opaque
;
323 flush_queued_data(port
);
326 void virtio_serial_throttle_port(VirtIOSerialPort
*port
, bool throttle
)
332 trace_virtio_serial_throttle_port(port
->id
, throttle
);
333 port
->throttled
= throttle
;
337 qemu_bh_schedule(port
->bh
);
340 /* Guest wants to notify us of some event */
341 static void handle_control_message(VirtIOSerial
*vser
, void *buf
, size_t len
)
343 VirtIODevice
*vdev
= VIRTIO_DEVICE(vser
);
344 struct VirtIOSerialPort
*port
;
345 VirtIOSerialPortClass
*vsc
;
346 struct virtio_console_control cpkt
, *gcpkt
;
352 if (len
< sizeof(cpkt
)) {
353 /* The guest sent an invalid control packet */
357 cpkt
.event
= virtio_lduw_p(vdev
, &gcpkt
->event
);
358 cpkt
.value
= virtio_lduw_p(vdev
, &gcpkt
->value
);
360 trace_virtio_serial_handle_control_message(cpkt
.event
, cpkt
.value
);
362 if (cpkt
.event
== VIRTIO_CONSOLE_DEVICE_READY
) {
364 error_report("virtio-serial-bus: Guest failure in adding device %s",
365 vser
->bus
.qbus
.name
);
369 * The device is up, we can now tell the device about all the
370 * ports we have here.
372 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
373 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_ADD
, 1);
378 port
= find_port_by_id(vser
, virtio_ldl_p(vdev
, &gcpkt
->id
));
380 error_report("virtio-serial-bus: Unexpected port id %u for device %s",
381 virtio_ldl_p(vdev
, &gcpkt
->id
), vser
->bus
.qbus
.name
);
385 trace_virtio_serial_handle_control_message_port(port
->id
);
387 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
390 case VIRTIO_CONSOLE_PORT_READY
:
392 error_report("virtio-serial-bus: Guest failure in adding port %u for device %s",
393 port
->id
, vser
->bus
.qbus
.name
);
397 * Now that we know the guest asked for the port name, we're
398 * sure the guest has initialised whatever state is necessary
399 * for this port. Now's a good time to let the guest know if
400 * this port is a console port so that the guest can hook it
403 if (vsc
->is_console
) {
404 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_CONSOLE_PORT
, 1);
408 virtio_stl_p(vdev
, &cpkt
.id
, port
->id
);
409 virtio_stw_p(vdev
, &cpkt
.event
, VIRTIO_CONSOLE_PORT_NAME
);
410 virtio_stw_p(vdev
, &cpkt
.value
, 1);
412 buffer_len
= sizeof(cpkt
) + strlen(port
->name
) + 1;
413 buffer
= g_malloc(buffer_len
);
415 memcpy(buffer
, &cpkt
, sizeof(cpkt
));
416 memcpy(buffer
+ sizeof(cpkt
), port
->name
, strlen(port
->name
));
417 buffer
[buffer_len
- 1] = 0;
419 send_control_msg(vser
, buffer
, buffer_len
);
423 if (port
->host_connected
) {
424 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 1);
428 * When the guest has asked us for this information it means
429 * the guest is all setup and has its virtqueues
430 * initialised. If some app is interested in knowing about
431 * this event, let it know.
433 if (vsc
->guest_ready
) {
434 vsc
->guest_ready(port
);
438 case VIRTIO_CONSOLE_PORT_OPEN
:
439 port
->guest_connected
= cpkt
.value
;
440 if (vsc
->set_guest_connected
) {
441 /* Send the guest opened notification if an app is interested */
442 vsc
->set_guest_connected(port
, cpkt
.value
);
448 static void control_in(VirtIODevice
*vdev
, VirtQueue
*vq
)
452 static void control_out(VirtIODevice
*vdev
, VirtQueue
*vq
)
454 VirtQueueElement
*elem
;
459 vser
= VIRTIO_SERIAL(vdev
);
466 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
471 cur_len
= iov_size(elem
->out_sg
, elem
->out_num
);
473 * Allocate a new buf only if we didn't have one previously or
474 * if the size of the buf differs
479 buf
= g_malloc(cur_len
);
482 iov_to_buf(elem
->out_sg
, elem
->out_num
, 0, buf
, cur_len
);
484 handle_control_message(vser
, buf
, cur_len
);
485 virtqueue_push(vq
, elem
, 0);
489 virtio_notify(vdev
, vq
);
492 /* Guest wrote something to some port. */
493 static void handle_output(VirtIODevice
*vdev
, VirtQueue
*vq
)
496 VirtIOSerialPort
*port
;
498 vser
= VIRTIO_SERIAL(vdev
);
499 port
= find_port_by_vq(vser
, vq
);
501 if (!port
|| !port
->host_connected
) {
502 discard_vq_data(vq
, vdev
);
506 if (!port
->throttled
) {
507 do_flush_queued_data(port
, vq
, vdev
);
512 static void handle_input(VirtIODevice
*vdev
, VirtQueue
*vq
)
515 * Users of virtio-serial would like to know when guest becomes
516 * writable again -- i.e. if a vq had stuff queued up and the
517 * guest wasn't reading at all, the host would not be able to
518 * write to the vq anymore. Once the guest reads off something,
519 * we can start queueing things up again. However, this call is
520 * made for each buffer addition by the guest -- even though free
521 * buffers existed prior to the current buffer addition. This is
522 * done so as not to maintain previous state, which will need
523 * additional live-migration-related changes.
526 VirtIOSerialPort
*port
;
527 VirtIOSerialPortClass
*vsc
;
529 vser
= VIRTIO_SERIAL(vdev
);
530 port
= find_port_by_vq(vser
, vq
);
535 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
538 * If guest_connected is false, this call is being made by the
539 * early-boot queueing up of descriptors, which is just noise for
540 * the host apps -- don't disturb them in that case.
542 if (port
->guest_connected
&& port
->host_connected
&& vsc
->guest_writable
) {
543 vsc
->guest_writable(port
);
547 static uint64_t get_features(VirtIODevice
*vdev
, uint64_t features
,
552 vser
= VIRTIO_SERIAL(vdev
);
554 features
|= vser
->host_features
;
555 if (vser
->bus
.max_nr_ports
> 1) {
556 virtio_add_feature(&features
, VIRTIO_CONSOLE_F_MULTIPORT
);
561 /* Guest requested config info */
562 static void get_config(VirtIODevice
*vdev
, uint8_t *config_data
)
564 VirtIOSerial
*vser
= VIRTIO_SERIAL(vdev
);
565 struct virtio_console_config
*config
=
566 (struct virtio_console_config
*)config_data
;
570 config
->max_nr_ports
= virtio_tswap32(vdev
,
571 vser
->serial
.max_virtserial_ports
);
574 /* Guest sent new config info */
575 static void set_config(VirtIODevice
*vdev
, const uint8_t *config_data
)
577 VirtIOSerial
*vser
= VIRTIO_SERIAL(vdev
);
578 struct virtio_console_config
*config
=
579 (struct virtio_console_config
*)config_data
;
580 uint8_t emerg_wr_lo
= le32_to_cpu(config
->emerg_wr
);
581 VirtIOSerialPort
*port
= find_first_connected_console(vser
);
582 VirtIOSerialPortClass
*vsc
;
584 if (!config
->emerg_wr
) {
587 /* Make sure we don't misdetect an emergency write when the guest
588 * does a short config write after an emergency write. */
589 config
->emerg_wr
= 0;
593 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
594 (void)vsc
->have_data(port
, &emerg_wr_lo
, 1);
597 static void guest_reset(VirtIOSerial
*vser
)
599 VirtIOSerialPort
*port
;
600 VirtIOSerialPortClass
*vsc
;
602 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
603 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
605 discard_throttle_data(port
);
607 if (port
->guest_connected
) {
608 port
->guest_connected
= false;
609 if (vsc
->set_guest_connected
) {
610 vsc
->set_guest_connected(port
, false);
616 static void set_status(VirtIODevice
*vdev
, uint8_t status
)
619 VirtIOSerialPort
*port
;
621 vser
= VIRTIO_SERIAL(vdev
);
622 port
= find_port_by_id(vser
, 0);
624 if (port
&& !use_multiport(port
->vser
)
625 && (status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
627 * Non-multiport guests won't be able to tell us guest
628 * open/close status. Such guests can only have a port at id
629 * 0, so set guest_connected for such ports as soon as guest
632 port
->guest_connected
= true;
634 if (!(status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
639 static void vser_reset(VirtIODevice
*vdev
)
643 vser
= VIRTIO_SERIAL(vdev
);
647 static void virtio_serial_save_device(VirtIODevice
*vdev
, QEMUFile
*f
)
649 VirtIOSerial
*s
= VIRTIO_SERIAL(vdev
);
650 VirtIOSerialPort
*port
;
651 uint32_t nr_active_ports
;
652 unsigned int i
, max_nr_ports
;
653 struct virtio_console_config config
;
655 /* The config space (ignored on the far end in current versions) */
656 get_config(vdev
, (uint8_t *)&config
);
657 qemu_put_be16s(f
, &config
.cols
);
658 qemu_put_be16s(f
, &config
.rows
);
659 qemu_put_be32s(f
, &config
.max_nr_ports
);
662 max_nr_ports
= s
->serial
.max_virtserial_ports
;
663 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
664 qemu_put_be32s(f
, &s
->ports_map
[i
]);
670 QTAILQ_FOREACH(port
, &s
->ports
, next
) {
674 qemu_put_be32s(f
, &nr_active_ports
);
677 * Items in struct VirtIOSerialPort.
679 QTAILQ_FOREACH(port
, &s
->ports
, next
) {
680 uint32_t elem_popped
;
682 qemu_put_be32s(f
, &port
->id
);
683 qemu_put_byte(f
, port
->guest_connected
);
684 qemu_put_byte(f
, port
->host_connected
);
690 qemu_put_be32s(f
, &elem_popped
);
692 qemu_put_be32s(f
, &port
->iov_idx
);
693 qemu_put_be64s(f
, &port
->iov_offset
);
694 qemu_put_virtqueue_element(f
, port
->elem
);
699 static void virtio_serial_post_load_timer_cb(void *opaque
)
702 VirtIOSerial
*s
= VIRTIO_SERIAL(opaque
);
703 VirtIOSerialPort
*port
;
704 uint8_t host_connected
;
705 VirtIOSerialPortClass
*vsc
;
710 for (i
= 0 ; i
< s
->post_load
->nr_active_ports
; ++i
) {
711 port
= s
->post_load
->connected
[i
].port
;
712 host_connected
= s
->post_load
->connected
[i
].host_connected
;
713 if (host_connected
!= port
->host_connected
) {
715 * We have to let the guest know of the host connection
718 send_control_event(s
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
,
719 port
->host_connected
);
721 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
722 if (vsc
->set_guest_connected
) {
723 vsc
->set_guest_connected(port
, port
->guest_connected
);
726 g_free(s
->post_load
->connected
);
727 timer_free(s
->post_load
->timer
);
728 g_free(s
->post_load
);
732 static int fetch_active_ports_list(QEMUFile
*f
,
733 VirtIOSerial
*s
, uint32_t nr_active_ports
)
737 s
->post_load
= g_malloc0(sizeof(*s
->post_load
));
738 s
->post_load
->nr_active_ports
= nr_active_ports
;
739 s
->post_load
->connected
=
740 g_malloc0(sizeof(*s
->post_load
->connected
) * nr_active_ports
);
742 s
->post_load
->timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
,
743 virtio_serial_post_load_timer_cb
,
746 /* Items in struct VirtIOSerialPort */
747 for (i
= 0; i
< nr_active_ports
; i
++) {
748 VirtIOSerialPort
*port
;
749 uint32_t elem_popped
;
752 id
= qemu_get_be32(f
);
753 port
= find_port_by_id(s
, id
);
758 port
->guest_connected
= qemu_get_byte(f
);
759 s
->post_load
->connected
[i
].port
= port
;
760 s
->post_load
->connected
[i
].host_connected
= qemu_get_byte(f
);
762 qemu_get_be32s(f
, &elem_popped
);
764 qemu_get_be32s(f
, &port
->iov_idx
);
765 qemu_get_be64s(f
, &port
->iov_offset
);
768 qemu_get_virtqueue_element(f
, sizeof(VirtQueueElement
));
771 * Port was throttled on source machine. Let's
772 * unthrottle it here so data starts flowing again.
774 virtio_serial_throttle_port(port
, false);
777 timer_mod(s
->post_load
->timer
, 1);
781 static int virtio_serial_load(QEMUFile
*f
, void *opaque
, size_t size
)
783 /* The virtio device */
784 return virtio_load(VIRTIO_DEVICE(opaque
), f
, 3);
787 static int virtio_serial_load_device(VirtIODevice
*vdev
, QEMUFile
*f
,
790 VirtIOSerial
*s
= VIRTIO_SERIAL(vdev
);
791 uint32_t max_nr_ports
, nr_active_ports
, ports_map
;
797 qemu_get_be16s(f
, (uint16_t *) &tmp
);
798 qemu_get_be16s(f
, (uint16_t *) &tmp
);
799 qemu_get_be32s(f
, &tmp
);
801 max_nr_ports
= s
->serial
.max_virtserial_ports
;
802 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
803 qemu_get_be32s(f
, &ports_map
);
805 if (ports_map
!= s
->ports_map
[i
]) {
807 * Ports active on source and destination don't
808 * match. Fail migration.
814 qemu_get_be32s(f
, &nr_active_ports
);
816 if (nr_active_ports
) {
817 ret
= fetch_active_ports_list(f
, s
, nr_active_ports
);
825 static void virtser_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
);
827 static Property virtser_props
[] = {
828 DEFINE_PROP_UINT32("nr", VirtIOSerialPort
, id
, VIRTIO_CONSOLE_BAD_ID
),
829 DEFINE_PROP_STRING("name", VirtIOSerialPort
, name
),
830 DEFINE_PROP_END_OF_LIST()
833 #define TYPE_VIRTIO_SERIAL_BUS "virtio-serial-bus"
834 #define VIRTIO_SERIAL_BUS(obj) \
835 OBJECT_CHECK(VirtIOSerialBus, (obj), TYPE_VIRTIO_SERIAL_BUS)
837 static void virtser_bus_class_init(ObjectClass
*klass
, void *data
)
839 BusClass
*k
= BUS_CLASS(klass
);
840 k
->print_dev
= virtser_bus_dev_print
;
843 static const TypeInfo virtser_bus_info
= {
844 .name
= TYPE_VIRTIO_SERIAL_BUS
,
846 .instance_size
= sizeof(VirtIOSerialBus
),
847 .class_init
= virtser_bus_class_init
,
850 static void virtser_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
)
852 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(qdev
);
854 monitor_printf(mon
, "%*sport %d, guest %s, host %s, throttle %s\n",
855 indent
, "", port
->id
,
856 port
->guest_connected
? "on" : "off",
857 port
->host_connected
? "on" : "off",
858 port
->throttled
? "on" : "off");
861 /* This function is only used if a port id is not provided by the user */
862 static uint32_t find_free_port_id(VirtIOSerial
*vser
)
864 unsigned int i
, max_nr_ports
;
866 max_nr_ports
= vser
->serial
.max_virtserial_ports
;
867 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
868 uint32_t map
, zeroes
;
870 map
= vser
->ports_map
[i
];
871 zeroes
= ctz32(~map
);
873 return zeroes
+ i
* 32;
876 return VIRTIO_CONSOLE_BAD_ID
;
879 static void mark_port_added(VirtIOSerial
*vser
, uint32_t port_id
)
884 vser
->ports_map
[i
] |= 1U << (port_id
% 32);
887 static void add_port(VirtIOSerial
*vser
, uint32_t port_id
)
889 mark_port_added(vser
, port_id
);
890 send_control_event(vser
, port_id
, VIRTIO_CONSOLE_PORT_ADD
, 1);
893 static void remove_port(VirtIOSerial
*vser
, uint32_t port_id
)
895 VirtIOSerialPort
*port
;
898 * Don't mark port 0 removed -- we explicitly reserve it for
899 * backward compat with older guests, ensure a virtconsole device
900 * unplug retains the reservation.
906 vser
->ports_map
[i
] &= ~(1U << (port_id
% 32));
909 port
= find_port_by_id(vser
, port_id
);
911 * This function is only called from qdev's unplug callback; if we
912 * get a NULL port here, we're in trouble.
916 /* Flush out any unconsumed buffers first */
917 discard_throttle_data(port
);
918 discard_vq_data(port
->ovq
, VIRTIO_DEVICE(port
->vser
));
920 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_REMOVE
, 1);
923 static void virtser_port_device_realize(DeviceState
*dev
, Error
**errp
)
925 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
926 VirtIOSerialPortClass
*vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
927 VirtIOSerialBus
*bus
= VIRTIO_SERIAL_BUS(qdev_get_parent_bus(dev
));
932 port
->vser
= bus
->vser
;
933 port
->bh
= qemu_bh_new(flush_queued_data_bh
, port
);
935 assert(vsc
->have_data
);
938 * Is the first console port we're seeing? If so, put it up at
939 * location 0. This is done for backward compatibility (old
942 plugging_port0
= vsc
->is_console
&& !find_port_by_id(port
->vser
, 0);
944 if (find_port_by_id(port
->vser
, port
->id
)) {
945 error_setg(errp
, "virtio-serial-bus: A port already exists at id %u",
950 if (port
->name
!= NULL
&& find_port_by_name(port
->name
)) {
951 error_setg(errp
, "virtio-serial-bus: A port already exists by name %s",
956 if (port
->id
== VIRTIO_CONSOLE_BAD_ID
) {
957 if (plugging_port0
) {
960 port
->id
= find_free_port_id(port
->vser
);
961 if (port
->id
== VIRTIO_CONSOLE_BAD_ID
) {
962 error_setg(errp
, "virtio-serial-bus: Maximum port limit for "
963 "this device reached");
969 max_nr_ports
= port
->vser
->serial
.max_virtserial_ports
;
970 if (port
->id
>= max_nr_ports
) {
971 error_setg(errp
, "virtio-serial-bus: Out-of-range port id specified, "
972 "max. allowed: %u", max_nr_ports
- 1);
976 vsc
->realize(dev
, &err
);
978 error_propagate(errp
, err
);
985 static void virtser_port_device_plug(HotplugHandler
*hotplug_dev
,
986 DeviceState
*dev
, Error
**errp
)
988 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
990 QTAILQ_INSERT_TAIL(&port
->vser
->ports
, port
, next
);
991 port
->ivq
= port
->vser
->ivqs
[port
->id
];
992 port
->ovq
= port
->vser
->ovqs
[port
->id
];
994 add_port(port
->vser
, port
->id
);
996 /* Send an update to the guest about this new port added */
997 virtio_notify_config(VIRTIO_DEVICE(hotplug_dev
));
1000 static void virtser_port_device_unrealize(DeviceState
*dev
, Error
**errp
)
1002 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
1003 VirtIOSerialPortClass
*vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(dev
);
1004 VirtIOSerial
*vser
= port
->vser
;
1006 qemu_bh_delete(port
->bh
);
1007 remove_port(port
->vser
, port
->id
);
1009 QTAILQ_REMOVE(&vser
->ports
, port
, next
);
1011 if (vsc
->unrealize
) {
1012 vsc
->unrealize(dev
, errp
);
1016 static void virtio_serial_device_realize(DeviceState
*dev
, Error
**errp
)
1018 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
1019 VirtIOSerial
*vser
= VIRTIO_SERIAL(dev
);
1020 uint32_t i
, max_supported_ports
;
1021 size_t config_size
= sizeof(struct virtio_console_config
);
1023 if (!vser
->serial
.max_virtserial_ports
) {
1024 error_setg(errp
, "Maximum number of serial ports not specified");
1028 /* Each port takes 2 queues, and one pair is for the control queue */
1029 max_supported_ports
= VIRTIO_QUEUE_MAX
/ 2 - 1;
1031 if (vser
->serial
.max_virtserial_ports
> max_supported_ports
) {
1032 error_setg(errp
, "maximum ports supported: %u", max_supported_ports
);
1036 if (!virtio_has_feature(vser
->host_features
,
1037 VIRTIO_CONSOLE_F_EMERG_WRITE
)) {
1038 config_size
= offsetof(struct virtio_console_config
, emerg_wr
);
1040 virtio_init(vdev
, "virtio-serial", VIRTIO_ID_CONSOLE
,
1043 /* Spawn a new virtio-serial bus on which the ports will ride as devices */
1044 qbus_create_inplace(&vser
->bus
, sizeof(vser
->bus
), TYPE_VIRTIO_SERIAL_BUS
,
1045 dev
, vdev
->bus_name
);
1046 qbus_set_hotplug_handler(BUS(&vser
->bus
), DEVICE(vser
), errp
);
1047 vser
->bus
.vser
= vser
;
1048 QTAILQ_INIT(&vser
->ports
);
1050 vser
->bus
.max_nr_ports
= vser
->serial
.max_virtserial_ports
;
1051 vser
->ivqs
= g_malloc(vser
->serial
.max_virtserial_ports
1052 * sizeof(VirtQueue
*));
1053 vser
->ovqs
= g_malloc(vser
->serial
.max_virtserial_ports
1054 * sizeof(VirtQueue
*));
1056 /* Add a queue for host to guest transfers for port 0 (backward compat) */
1057 vser
->ivqs
[0] = virtio_add_queue(vdev
, 128, handle_input
);
1058 /* Add a queue for guest to host transfers for port 0 (backward compat) */
1059 vser
->ovqs
[0] = virtio_add_queue(vdev
, 128, handle_output
);
1061 /* TODO: host to guest notifications can get dropped
1062 * if the queue fills up. Implement queueing in host,
1063 * this might also make it possible to reduce the control
1064 * queue size: as guest preposts buffers there,
1065 * this will save 4Kbyte of guest memory per entry. */
1067 /* control queue: host to guest */
1068 vser
->c_ivq
= virtio_add_queue(vdev
, 32, control_in
);
1069 /* control queue: guest to host */
1070 vser
->c_ovq
= virtio_add_queue(vdev
, 32, control_out
);
1072 for (i
= 1; i
< vser
->bus
.max_nr_ports
; i
++) {
1073 /* Add a per-port queue for host to guest transfers */
1074 vser
->ivqs
[i
] = virtio_add_queue(vdev
, 128, handle_input
);
1075 /* Add a per-per queue for guest to host transfers */
1076 vser
->ovqs
[i
] = virtio_add_queue(vdev
, 128, handle_output
);
1079 vser
->ports_map
= g_malloc0(((vser
->serial
.max_virtserial_ports
+ 31) / 32)
1080 * sizeof(vser
->ports_map
[0]));
1082 * Reserve location 0 for a console port for backward compat
1083 * (old kernel, new qemu)
1085 mark_port_added(vser
, 0);
1087 vser
->post_load
= NULL
;
1089 QLIST_INSERT_HEAD(&vserdevices
.devices
, vser
, next
);
1092 static void virtio_serial_port_class_init(ObjectClass
*klass
, void *data
)
1094 DeviceClass
*k
= DEVICE_CLASS(klass
);
1096 set_bit(DEVICE_CATEGORY_INPUT
, k
->categories
);
1097 k
->bus_type
= TYPE_VIRTIO_SERIAL_BUS
;
1098 k
->realize
= virtser_port_device_realize
;
1099 k
->unrealize
= virtser_port_device_unrealize
;
1100 k
->props
= virtser_props
;
1103 static const TypeInfo virtio_serial_port_type_info
= {
1104 .name
= TYPE_VIRTIO_SERIAL_PORT
,
1105 .parent
= TYPE_DEVICE
,
1106 .instance_size
= sizeof(VirtIOSerialPort
),
1108 .class_size
= sizeof(VirtIOSerialPortClass
),
1109 .class_init
= virtio_serial_port_class_init
,
1112 static void virtio_serial_device_unrealize(DeviceState
*dev
, Error
**errp
)
1114 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
1115 VirtIOSerial
*vser
= VIRTIO_SERIAL(dev
);
1117 QLIST_REMOVE(vser
, next
);
1121 g_free(vser
->ports_map
);
1122 if (vser
->post_load
) {
1123 g_free(vser
->post_load
->connected
);
1124 timer_del(vser
->post_load
->timer
);
1125 timer_free(vser
->post_load
->timer
);
1126 g_free(vser
->post_load
);
1128 virtio_cleanup(vdev
);
1131 /* Note: 'console' is used for backwards compatibility */
1132 VMSTATE_VIRTIO_DEVICE(console
, 3, virtio_serial_load
, virtio_vmstate_save
);
1134 static Property virtio_serial_properties
[] = {
1135 DEFINE_PROP_UINT32("max_ports", VirtIOSerial
, serial
.max_virtserial_ports
,
1137 DEFINE_PROP_BIT64("emergency-write", VirtIOSerial
, host_features
,
1138 VIRTIO_CONSOLE_F_EMERG_WRITE
, true),
1139 DEFINE_PROP_END_OF_LIST(),
1142 static void virtio_serial_class_init(ObjectClass
*klass
, void *data
)
1144 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1145 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
1146 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
1148 QLIST_INIT(&vserdevices
.devices
);
1150 dc
->props
= virtio_serial_properties
;
1151 dc
->vmsd
= &vmstate_virtio_console
;
1152 set_bit(DEVICE_CATEGORY_INPUT
, dc
->categories
);
1153 vdc
->realize
= virtio_serial_device_realize
;
1154 vdc
->unrealize
= virtio_serial_device_unrealize
;
1155 vdc
->get_features
= get_features
;
1156 vdc
->get_config
= get_config
;
1157 vdc
->set_config
= set_config
;
1158 vdc
->set_status
= set_status
;
1159 vdc
->reset
= vser_reset
;
1160 vdc
->save
= virtio_serial_save_device
;
1161 vdc
->load
= virtio_serial_load_device
;
1162 hc
->plug
= virtser_port_device_plug
;
1163 hc
->unplug
= qdev_simple_device_unplug_cb
;
1166 static const TypeInfo virtio_device_info
= {
1167 .name
= TYPE_VIRTIO_SERIAL
,
1168 .parent
= TYPE_VIRTIO_DEVICE
,
1169 .instance_size
= sizeof(VirtIOSerial
),
1170 .class_init
= virtio_serial_class_init
,
1171 .interfaces
= (InterfaceInfo
[]) {
1172 { TYPE_HOTPLUG_HANDLER
},
1177 static void virtio_serial_register_types(void)
1179 type_register_static(&virtser_bus_info
);
1180 type_register_static(&virtio_serial_port_type_info
);
1181 type_register_static(&virtio_device_info
);
1184 type_init(virtio_serial_register_types
)