xref: /kvmtool/virtio/console.c (revision 20f0438a954fa459d6d98b5b0a262c9f51af7d45)
1416b2c2dSAsias He #include "kvm/virtio-console.h"
2416b2c2dSAsias He #include "kvm/virtio-pci.h"
331638bcaSCyrill Gorcunov #include "kvm/virtio-pci-dev.h"
49bd8ac5cSAsias He #include "kvm/disk-image.h"
539d6af07SAsias He #include "kvm/virtio.h"
69bd8ac5cSAsias He #include "kvm/ioport.h"
79bd8ac5cSAsias He #include "kvm/util.h"
89bd8ac5cSAsias He #include "kvm/term.h"
97512639bSAsias He #include "kvm/mutex.h"
109bd8ac5cSAsias He #include "kvm/kvm.h"
119bd8ac5cSAsias He #include "kvm/pci.h"
12b6638c22SSasha Levin #include "kvm/threadpool.h"
132449f6e3SSasha Levin #include "kvm/irq.h"
149bd8ac5cSAsias He 
159bd8ac5cSAsias He #include <linux/virtio_console.h>
169bd8ac5cSAsias He #include <linux/virtio_ring.h>
179bd8ac5cSAsias He #include <linux/virtio_blk.h>
189bd8ac5cSAsias He 
199bd8ac5cSAsias He #include <sys/uio.h>
209bd8ac5cSAsias He #include <sys/types.h>
219bd8ac5cSAsias He #include <sys/stat.h>
229bd8ac5cSAsias He #include <termios.h>
239bd8ac5cSAsias He #include <assert.h>
249bd8ac5cSAsias He #include <unistd.h>
259bd8ac5cSAsias He #include <fcntl.h>
269bd8ac5cSAsias He 
279bd8ac5cSAsias He #define VIRTIO_CONSOLE_QUEUE_SIZE	128
289bd8ac5cSAsias He #define VIRTIO_CONSOLE_NUM_QUEUES	2
299bd8ac5cSAsias He #define VIRTIO_CONSOLE_RX_QUEUE		0
309bd8ac5cSAsias He #define VIRTIO_CONSOLE_TX_QUEUE		1
319bd8ac5cSAsias He 
322449f6e3SSasha Levin static struct pci_device_header virtio_console_pci_device = {
332449f6e3SSasha Levin 	.vendor_id		= PCI_VENDOR_ID_REDHAT_QUMRANET,
342449f6e3SSasha Levin 	.device_id		= PCI_DEVICE_ID_VIRTIO_CONSOLE,
352449f6e3SSasha Levin 	.header_type		= PCI_HEADER_TYPE_NORMAL,
362449f6e3SSasha Levin 	.revision_id		= 0,
372449f6e3SSasha Levin 	.class			= 0x078000,
382449f6e3SSasha Levin 	.subsys_vendor_id	= PCI_SUBSYSTEM_VENDOR_ID_REDHAT_QUMRANET,
392449f6e3SSasha Levin 	.subsys_id		= PCI_SUBSYSTEM_ID_VIRTIO_CONSOLE,
402449f6e3SSasha Levin 	.bar[0]			= IOPORT_VIRTIO_CONSOLE | PCI_BASE_ADDRESS_SPACE_IO,
412449f6e3SSasha Levin };
422449f6e3SSasha Levin 
43a643306eSSasha Levin struct con_dev {
447512639bSAsias He 	pthread_mutex_t			mutex;
457512639bSAsias He 
469bd8ac5cSAsias He 	struct virt_queue		vqs[VIRTIO_CONSOLE_NUM_QUEUES];
479bd8ac5cSAsias He 	struct virtio_console_config	console_config;
483fdf659dSSasha Levin 	u32				host_features;
493fdf659dSSasha Levin 	u32				guest_features;
503fdf659dSSasha Levin 	u16				config_vector;
513fdf659dSSasha Levin 	u8				status;
520ba84a57SAsias He 	u8				isr;
533fdf659dSSasha Levin 	u16				queue_selector;
54b6638c22SSasha Levin 
55b6638c22SSasha Levin 	void				*jobs[VIRTIO_CONSOLE_NUM_QUEUES];
569bd8ac5cSAsias He };
579bd8ac5cSAsias He 
58a643306eSSasha Levin static struct con_dev cdev = {
597512639bSAsias He 	.mutex				= PTHREAD_MUTEX_INITIALIZER,
607512639bSAsias He 
619bd8ac5cSAsias He 	.console_config = {
629bd8ac5cSAsias He 		.cols			= 80,
639bd8ac5cSAsias He 		.rows			= 24,
649bd8ac5cSAsias He 		.max_nr_ports		= 1,
659bd8ac5cSAsias He 	},
669bd8ac5cSAsias He 
679bd8ac5cSAsias He 	.host_features			= 0,
689bd8ac5cSAsias He };
699bd8ac5cSAsias He 
709bd8ac5cSAsias He /*
719bd8ac5cSAsias He  * Interrupts are injected for hvc0 only.
729bd8ac5cSAsias He  */
73b6638c22SSasha Levin static void virtio_console__inject_interrupt_callback(struct kvm *self, void *param)
749bd8ac5cSAsias He {
759bd8ac5cSAsias He 	struct iovec iov[VIRTIO_CONSOLE_QUEUE_SIZE];
769bd8ac5cSAsias He 	struct virt_queue *vq;
773fdf659dSSasha Levin 	u16 out, in;
783fdf659dSSasha Levin 	u16 head;
799bd8ac5cSAsias He 	int len;
809bd8ac5cSAsias He 
81a643306eSSasha Levin 	mutex_lock(&cdev.mutex);
827512639bSAsias He 
83b6638c22SSasha Levin 	vq = param;
849bd8ac5cSAsias He 
859bd8ac5cSAsias He 	if (term_readable(CONSOLE_VIRTIO) && virt_queue__available(vq)) {
869bd8ac5cSAsias He 		head = virt_queue__get_iov(vq, iov, &out, &in, self);
879bd8ac5cSAsias He 		len = term_getc_iov(CONSOLE_VIRTIO, iov, in);
889bd8ac5cSAsias He 		virt_queue__set_used_elem(vq, head, len);
890ba84a57SAsias He 		virt_queue__trigger_irq(vq, virtio_console_pci_device.irq_line, &cdev.isr, self);
909bd8ac5cSAsias He 	}
917512639bSAsias He 
92a643306eSSasha Levin 	mutex_unlock(&cdev.mutex);
939bd8ac5cSAsias He }
949bd8ac5cSAsias He 
95b6638c22SSasha Levin void virtio_console__inject_interrupt(struct kvm *self)
96b6638c22SSasha Levin {
97a643306eSSasha Levin 	thread_pool__do_job(cdev.jobs[VIRTIO_CONSOLE_RX_QUEUE]);
98b6638c22SSasha Levin }
99b6638c22SSasha Levin 
1003fdf659dSSasha Levin static bool virtio_console_pci_io_device_specific_in(void *data, unsigned long offset, int size, u32 count)
1019bd8ac5cSAsias He {
102a643306eSSasha Levin 	u8 *config_space = (u8 *) &cdev.console_config;
1039bd8ac5cSAsias He 
1049bd8ac5cSAsias He 	if (size != 1 || count != 1)
1059bd8ac5cSAsias He 		return false;
1069bd8ac5cSAsias He 
1079bd8ac5cSAsias He 	if ((offset - VIRTIO_PCI_CONFIG_NOMSI) > sizeof(struct virtio_console_config))
1089bd8ac5cSAsias He 		error("config offset is too big: %li", offset - VIRTIO_PCI_CONFIG_NOMSI);
1099bd8ac5cSAsias He 
1109bd8ac5cSAsias He 	ioport__write8(data, config_space[offset - VIRTIO_PCI_CONFIG_NOMSI]);
1119bd8ac5cSAsias He 
1129bd8ac5cSAsias He 	return true;
1139bd8ac5cSAsias He }
1149bd8ac5cSAsias He 
1153fdf659dSSasha Levin static bool virtio_console_pci_io_in(struct kvm *self, u16 port, void *data, int size, u32 count)
1169bd8ac5cSAsias He {
1179bd8ac5cSAsias He 	unsigned long offset = port - IOPORT_VIRTIO_CONSOLE;
1187512639bSAsias He 	bool ret = true;
1197512639bSAsias He 
120a643306eSSasha Levin 	mutex_lock(&cdev.mutex);
1219bd8ac5cSAsias He 
1229bd8ac5cSAsias He 	switch (offset) {
1239bd8ac5cSAsias He 	case VIRTIO_PCI_HOST_FEATURES:
124a643306eSSasha Levin 		ioport__write32(data, cdev.host_features);
1259bd8ac5cSAsias He 		break;
1269bd8ac5cSAsias He 	case VIRTIO_PCI_GUEST_FEATURES:
1277512639bSAsias He 		ret = false;
1287512639bSAsias He 		break;
1299bd8ac5cSAsias He 	case VIRTIO_PCI_QUEUE_PFN:
130a643306eSSasha Levin 		ioport__write32(data, cdev.vqs[cdev.queue_selector].pfn);
1319bd8ac5cSAsias He 		break;
1329bd8ac5cSAsias He 	case VIRTIO_PCI_QUEUE_NUM:
1339bd8ac5cSAsias He 		ioport__write16(data, VIRTIO_CONSOLE_QUEUE_SIZE);
1349bd8ac5cSAsias He 		break;
1359bd8ac5cSAsias He 	case VIRTIO_PCI_QUEUE_SEL:
1369bd8ac5cSAsias He 	case VIRTIO_PCI_QUEUE_NOTIFY:
1377512639bSAsias He 		ret = false;
1387512639bSAsias He 		break;
1399bd8ac5cSAsias He 	case VIRTIO_PCI_STATUS:
140a643306eSSasha Levin 		ioport__write8(data, cdev.status);
1419bd8ac5cSAsias He 		break;
1429bd8ac5cSAsias He 	case VIRTIO_PCI_ISR:
1430ba84a57SAsias He 		ioport__write8(data, cdev.isr);
1440ba84a57SAsias He 		kvm__irq_line(self, virtio_console_pci_device.irq_line, VIRTIO_IRQ_LOW);
1450ba84a57SAsias He 		cdev.isr = VIRTIO_IRQ_LOW;
1469bd8ac5cSAsias He 		break;
1479bd8ac5cSAsias He 	case VIRTIO_MSI_CONFIG_VECTOR:
148a643306eSSasha Levin 		ioport__write16(data, cdev.config_vector);
1499bd8ac5cSAsias He 		break;
1509bd8ac5cSAsias He 	default:
1517512639bSAsias He 		ret = virtio_console_pci_io_device_specific_in(data, offset, size, count);
1529bd8ac5cSAsias He 	};
1539bd8ac5cSAsias He 
154a643306eSSasha Levin 	mutex_unlock(&cdev.mutex);
1557512639bSAsias He 
1567512639bSAsias He 	return ret;
1579bd8ac5cSAsias He }
1589bd8ac5cSAsias He 
159b6638c22SSasha Levin static void virtio_console_handle_callback(struct kvm *self, void *param)
1609bd8ac5cSAsias He {
1619bd8ac5cSAsias He 	struct iovec iov[VIRTIO_CONSOLE_QUEUE_SIZE];
1629bd8ac5cSAsias He 	struct virt_queue *vq;
1633fdf659dSSasha Levin 	u16 out, in;
1643fdf659dSSasha Levin 	u16 head;
1653fdf659dSSasha Levin 	u32 len;
1669bd8ac5cSAsias He 
167b6638c22SSasha Levin 	vq = param;
1689bd8ac5cSAsias He 
169*20f0438aSAsias He 	/*
170*20f0438aSAsias He 	 * The current Linux implementation polls for the buffer
171*20f0438aSAsias He 	 * to be used, rather than waiting for an interrupt.
172*20f0438aSAsias He 	 * So there is no need to inject an interrupt for the tx path.
173*20f0438aSAsias He 	 */
174*20f0438aSAsias He 
1759bd8ac5cSAsias He 	while (virt_queue__available(vq)) {
1769bd8ac5cSAsias He 		head = virt_queue__get_iov(vq, iov, &out, &in, self);
1779bd8ac5cSAsias He 		len = term_putc_iov(CONSOLE_VIRTIO, iov, out);
1789bd8ac5cSAsias He 		virt_queue__set_used_elem(vq, head, len);
1799bd8ac5cSAsias He 	}
1809bd8ac5cSAsias He 
1819bd8ac5cSAsias He }
1829bd8ac5cSAsias He 
1833fdf659dSSasha Levin static bool virtio_console_pci_io_out(struct kvm *self, u16 port, void *data, int size, u32 count)
1849bd8ac5cSAsias He {
1859bd8ac5cSAsias He 	unsigned long offset = port - IOPORT_VIRTIO_CONSOLE;
1867512639bSAsias He 	bool ret = true;
1879bd8ac5cSAsias He 
188a643306eSSasha Levin 	mutex_lock(&cdev.mutex);
189e147d838SAsias He 
1909bd8ac5cSAsias He 	switch (offset) {
1919bd8ac5cSAsias He 	case VIRTIO_PCI_GUEST_FEATURES:
192a643306eSSasha Levin 		cdev.guest_features	= ioport__read32(data);
1939bd8ac5cSAsias He 		break;
1949bd8ac5cSAsias He 	case VIRTIO_PCI_QUEUE_PFN: {
1959bd8ac5cSAsias He 		struct virt_queue *queue;
1969bd8ac5cSAsias He 		void *p;
1979bd8ac5cSAsias He 
198a643306eSSasha Levin 		assert(cdev.queue_selector < VIRTIO_CONSOLE_NUM_QUEUES);
1999bd8ac5cSAsias He 
200a643306eSSasha Levin 		queue			= &cdev.vqs[cdev.queue_selector];
2019bd8ac5cSAsias He 		queue->pfn		= ioport__read32(data);
2029bd8ac5cSAsias He 		p			= guest_flat_to_host(self, queue->pfn << 12);
2039bd8ac5cSAsias He 
2049bd8ac5cSAsias He 		vring_init(&queue->vring, VIRTIO_CONSOLE_QUEUE_SIZE, p, 4096);
2059bd8ac5cSAsias He 
206a643306eSSasha Levin 		if (cdev.queue_selector == VIRTIO_CONSOLE_TX_QUEUE)
207407475bfSPekka Enberg 			cdev.jobs[cdev.queue_selector] = thread_pool__add_job(self, virtio_console_handle_callback, queue);
208a643306eSSasha Levin 		else if (cdev.queue_selector == VIRTIO_CONSOLE_RX_QUEUE)
209407475bfSPekka Enberg 			cdev.jobs[cdev.queue_selector] = thread_pool__add_job(self, virtio_console__inject_interrupt_callback, queue);
210b6638c22SSasha Levin 
2119bd8ac5cSAsias He 		break;
2129bd8ac5cSAsias He 	}
2139bd8ac5cSAsias He 	case VIRTIO_PCI_QUEUE_SEL:
214a643306eSSasha Levin 		cdev.queue_selector	= ioport__read16(data);
2159bd8ac5cSAsias He 		break;
2169bd8ac5cSAsias He 	case VIRTIO_PCI_QUEUE_NOTIFY: {
217a643306eSSasha Levin 		u16 queue_index		= ioport__read16(data);
218a643306eSSasha Levin 		thread_pool__do_job(cdev.jobs[queue_index]);
2199bd8ac5cSAsias He 		break;
2209bd8ac5cSAsias He 	}
2219bd8ac5cSAsias He 	case VIRTIO_PCI_STATUS:
222a643306eSSasha Levin 		cdev.status		= ioport__read8(data);
2239bd8ac5cSAsias He 		break;
2249bd8ac5cSAsias He 	case VIRTIO_MSI_CONFIG_VECTOR:
225a643306eSSasha Levin 		cdev.config_vector	= VIRTIO_MSI_NO_VECTOR;
2269bd8ac5cSAsias He 		break;
2279bd8ac5cSAsias He 	case VIRTIO_MSI_QUEUE_VECTOR:
2289bd8ac5cSAsias He 		break;
2299bd8ac5cSAsias He 	default:
2307512639bSAsias He 		ret			= false;
231407475bfSPekka Enberg 		break;
2329bd8ac5cSAsias He 	};
2339bd8ac5cSAsias He 
234a643306eSSasha Levin 	mutex_unlock(&cdev.mutex);
235407475bfSPekka Enberg 
2367512639bSAsias He 	return ret;
2379bd8ac5cSAsias He }
2389bd8ac5cSAsias He 
2399bd8ac5cSAsias He static struct ioport_operations virtio_console_io_ops = {
2409bd8ac5cSAsias He 	.io_in			= virtio_console_pci_io_in,
2419bd8ac5cSAsias He 	.io_out			= virtio_console_pci_io_out,
2429bd8ac5cSAsias He };
2439bd8ac5cSAsias He 
2449bd8ac5cSAsias He void virtio_console__init(struct kvm *self)
2459bd8ac5cSAsias He {
2462449f6e3SSasha Levin 	u8 dev, line, pin;
2472449f6e3SSasha Levin 
2482449f6e3SSasha Levin 	if (irq__register_device(PCI_DEVICE_ID_VIRTIO_CONSOLE, &dev, &pin, &line) < 0)
2492449f6e3SSasha Levin 		return;
2502449f6e3SSasha Levin 
2512449f6e3SSasha Levin 	virtio_console_pci_device.irq_pin	= pin;
2522449f6e3SSasha Levin 	virtio_console_pci_device.irq_line	= line;
2532449f6e3SSasha Levin 	pci__register(&virtio_console_pci_device, dev);
2549bd8ac5cSAsias He 	ioport__register(IOPORT_VIRTIO_CONSOLE, &virtio_console_io_ops, IOPORT_VIRTIO_CONSOLE_SIZE);
2559bd8ac5cSAsias He }
256