[qemu.git] / hw / misc / pci-testdev.c

/*
 * QEMU PCI test device
 *
 * Copyright (c) 2012 Red Hat Inc.
 * Author: Michael S. Tsirkin <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see <http://www.gnu.org/licenses/>.
 */
#include "qemu/osdep.h"
#include "hw/hw.h"
#include "hw/pci/pci.h"
#include "qemu/event_notifier.h"

typedef struct PCITestDevHdr {
    uint8_t test;
    uint8_t width;
    uint8_t pad0[2];
    uint32_t offset;
    uint8_t data;
    uint8_t pad1[3];
    uint32_t count;
    uint8_t name[];
} PCITestDevHdr;

typedef struct IOTest {
    MemoryRegion *mr;
    EventNotifier notifier;
    bool hasnotifier;
    unsigned size;
    bool match_data;
    PCITestDevHdr *hdr;
    unsigned bufsize;
} IOTest;

#define IOTEST_DATAMATCH 0xFA
#define IOTEST_NOMATCH   0xCE

#define IOTEST_IOSIZE 128
#define IOTEST_MEMSIZE 2048

static const char *iotest_test[] = {
    "no-eventfd",
    "wildcard-eventfd",
    "datamatch-eventfd"
};

static const char *iotest_type[] = {
    "mmio",
    "portio"
};

#define IOTEST_TEST(i) (iotest_test[((i) % ARRAY_SIZE(iotest_test))])
#define IOTEST_TYPE(i) (iotest_type[((i) / ARRAY_SIZE(iotest_test))])
#define IOTEST_MAX_TEST (ARRAY_SIZE(iotest_test))
#define IOTEST_MAX_TYPE (ARRAY_SIZE(iotest_type))
#define IOTEST_MAX (IOTEST_MAX_TEST * IOTEST_MAX_TYPE)

enum {
    IOTEST_ACCESS_NAME,
    IOTEST_ACCESS_DATA,
    IOTEST_ACCESS_MAX,
};

#define IOTEST_ACCESS_TYPE uint8_t
#define IOTEST_ACCESS_WIDTH (sizeof(uint8_t))

typedef struct PCITestDevState {
    /*< private >*/
    PCIDevice parent_obj;
    /*< public >*/

    MemoryRegion mmio;
    MemoryRegion portio;
    IOTest *tests;
    int current;
} PCITestDevState;

#define TYPE_PCI_TEST_DEV "pci-testdev"

#define PCI_TEST_DEV(obj) \
    OBJECT_CHECK(PCITestDevState, (obj), TYPE_PCI_TEST_DEV)

#define IOTEST_IS_MEM(i) (strcmp(IOTEST_TYPE(i), "portio"))
#define IOTEST_REGION(d, i) (IOTEST_IS_MEM(i) ?  &(d)->mmio : &(d)->portio)
#define IOTEST_SIZE(i) (IOTEST_IS_MEM(i) ? IOTEST_MEMSIZE : IOTEST_IOSIZE)
#define IOTEST_PCI_BAR(i) (IOTEST_IS_MEM(i) ? PCI_BASE_ADDRESS_SPACE_MEMORY : \
                           PCI_BASE_ADDRESS_SPACE_IO)

static int pci_testdev_start(IOTest *test)
{
    test->hdr->count = 0;
    if (!test->hasnotifier) {
        return 0;
    }
    event_notifier_test_and_clear(&test->notifier);
    memory_region_add_eventfd(test->mr,
                              le32_to_cpu(test->hdr->offset),
                              test->size,
                              test->match_data,
                              test->hdr->data,
                              &test->notifier);
    return 0;
}

static void pci_testdev_stop(IOTest *test)
{
    if (!test->hasnotifier) {
        return;
    }
    memory_region_del_eventfd(test->mr,
                              le32_to_cpu(test->hdr->offset),
                              test->size,
                              test->match_data,
                              test->hdr->data,
                              &test->notifier);
}

static void
pci_testdev_reset(PCITestDevState *d)
{
    if (d->current == -1) {
        return;
    }
    pci_testdev_stop(&d->tests[d->current]);
    d->current = -1;
}

static void pci_testdev_inc(IOTest *test, unsigned inc)
{
    uint32_t c = le32_to_cpu(test->hdr->count);
    test->hdr->count = cpu_to_le32(c + inc);
}

static void
pci_testdev_write(void *opaque, hwaddr addr, uint64_t val,
                  unsigned size, int type)
{
    PCITestDevState *d = opaque;
    IOTest *test;
    int t, r;

    if (addr == offsetof(PCITestDevHdr, test)) {
        pci_testdev_reset(d);
        if (val >= IOTEST_MAX_TEST) {
            return;
        }
        t = type * IOTEST_MAX_TEST + val;
        r = pci_testdev_start(&d->tests[t]);
        if (r < 0) {
            return;
        }
        d->current = t;
        return;
    }
    if (d->current < 0) {
        return;
    }
    test = &d->tests[d->current];
    if (addr != le32_to_cpu(test->hdr->offset)) {
        return;
    }
    if (test->match_data && test->size != size) {
        return;
    }
    if (test->match_data && val != test->hdr->data) {
        return;
    }
    pci_testdev_inc(test, 1);
}

static uint64_t
pci_testdev_read(void *opaque, hwaddr addr, unsigned size)
{
    PCITestDevState *d = opaque;
    const char *buf;
    IOTest *test;
    if (d->current < 0) {
        return 0;
    }
    test = &d->tests[d->current];
    buf = (const char *)test->hdr;
    if (addr + size >= test->bufsize) {
        return 0;
    }
    if (test->hasnotifier) {
        event_notifier_test_and_clear(&test->notifier);
    }
    return buf[addr];
}

static void
pci_testdev_mmio_write(void *opaque, hwaddr addr, uint64_t val,
                       unsigned size)
{
    pci_testdev_write(opaque, addr, val, size, 0);
}

static void
pci_testdev_pio_write(void *opaque, hwaddr addr, uint64_t val,
                       unsigned size)
{
    pci_testdev_write(opaque, addr, val, size, 1);
}

static const MemoryRegionOps pci_testdev_mmio_ops = {
    .read = pci_testdev_read,
    .write = pci_testdev_mmio_write,
    .endianness = DEVICE_LITTLE_ENDIAN,
    .impl = {
        .min_access_size = 1,
        .max_access_size = 1,
    },
};

static const MemoryRegionOps pci_testdev_pio_ops = {
    .read = pci_testdev_read,
    .write = pci_testdev_pio_write,
    .endianness = DEVICE_LITTLE_ENDIAN,
    .impl = {
        .min_access_size = 1,
        .max_access_size = 1,
    },
};

static void pci_testdev_realize(PCIDevice *pci_dev, Error **errp)
{
    PCITestDevState *d = PCI_TEST_DEV(pci_dev);
    uint8_t *pci_conf;
    char *name;
    int r, i;
    bool fastmmio = kvm_ioeventfd_any_length_enabled();

    pci_conf = pci_dev->config;

    pci_conf[PCI_INTERRUPT_PIN] = 0; /* no interrupt pin */

    memory_region_init_io(&d->mmio, OBJECT(d), &pci_testdev_mmio_ops, d,
                          "pci-testdev-mmio", IOTEST_MEMSIZE * 2);
    memory_region_init_io(&d->portio, OBJECT(d), &pci_testdev_pio_ops, d,
                          "pci-testdev-portio", IOTEST_IOSIZE * 2);
    pci_register_bar(pci_dev, 0, PCI_BASE_ADDRESS_SPACE_MEMORY, &d->mmio);
    pci_register_bar(pci_dev, 1, PCI_BASE_ADDRESS_SPACE_IO, &d->portio);

    d->current = -1;
    d->tests = g_malloc0(IOTEST_MAX * sizeof *d->tests);
    for (i = 0; i < IOTEST_MAX; ++i) {
        IOTest *test = &d->tests[i];
        name = g_strdup_printf("%s-%s", IOTEST_TYPE(i), IOTEST_TEST(i));
        test->bufsize = sizeof(PCITestDevHdr) + strlen(name) + 1;
        test->hdr = g_malloc0(test->bufsize);
        memcpy(test->hdr->name, name, strlen(name) + 1);
        g_free(name);
        test->hdr->offset = cpu_to_le32(IOTEST_SIZE(i) + i * IOTEST_ACCESS_WIDTH);
        test->match_data = strcmp(IOTEST_TEST(i), "wildcard-eventfd");
        if (fastmmio && IOTEST_IS_MEM(i) && !test->match_data) {
            test->size = 0;
        } else {
            test->size = IOTEST_ACCESS_WIDTH;
        }
        test->hdr->test = i;
        test->hdr->data = test->match_data ? IOTEST_DATAMATCH : IOTEST_NOMATCH;
        test->hdr->width = IOTEST_ACCESS_WIDTH;
        test->mr = IOTEST_REGION(d, i);
        if (!strcmp(IOTEST_TEST(i), "no-eventfd")) {
            test->hasnotifier = false;
            continue;
        }
        r = event_notifier_init(&test->notifier, 0);
        assert(r >= 0);
        test->hasnotifier = true;
    }
}

static void
pci_testdev_uninit(PCIDevice *dev)
{
    PCITestDevState *d = PCI_TEST_DEV(dev);
    int i;

    pci_testdev_reset(d);
    for (i = 0; i < IOTEST_MAX; ++i) {
        if (d->tests[i].hasnotifier) {
            event_notifier_cleanup(&d->tests[i].notifier);
        }
        g_free(d->tests[i].hdr);
    }
    g_free(d->tests);
}

static void qdev_pci_testdev_reset(DeviceState *dev)
{
    PCITestDevState *d = PCI_TEST_DEV(dev);
    pci_testdev_reset(d);
}

static void pci_testdev_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);

    k->realize = pci_testdev_realize;
    k->exit = pci_testdev_uninit;
    k->vendor_id = PCI_VENDOR_ID_REDHAT;
    k->device_id = PCI_DEVICE_ID_REDHAT_TEST;
    k->revision = 0x00;
    k->class_id = PCI_CLASS_OTHERS;
    dc->desc = "PCI Test Device";
    set_bit(DEVICE_CATEGORY_MISC, dc->categories);
    dc->reset = qdev_pci_testdev_reset;
}

static const TypeInfo pci_testdev_info = {
    .name          = TYPE_PCI_TEST_DEV,
    .parent        = TYPE_PCI_DEVICE,
    .instance_size = sizeof(PCITestDevState),
    .class_init    = pci_testdev_class_init,
};

static void pci_testdev_register_types(void)
{
    type_register_static(&pci_testdev_info);
}

type_init(pci_testdev_register_types)
Commit	Line	Data
22773d60 MT	1	/*
	2	* QEMU PCI test device
	3	*
	4	* Copyright (c) 2012 Red Hat Inc.
	5	* Author: Michael S. Tsirkin <[email protected]>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; if not, see <http://www.gnu.org/licenses/>.
	19	*/
97d5408f	20	#include "qemu/osdep.h"
22773d60 MT	21	#include "hw/hw.h"
	22	#include "hw/pci/pci.h"
	23	#include "qemu/event_notifier.h"
22773d60 MT	24
	25	typedef struct PCITestDevHdr {
	26	uint8_t test;
	27	uint8_t width;
	28	uint8_t pad0[2];
	29	uint32_t offset;
	30	uint8_t data;
	31	uint8_t pad1[3];
	32	uint32_t count;
	33	uint8_t name[];
	34	} PCITestDevHdr;
	35
	36	typedef struct IOTest {
	37	MemoryRegion *mr;
	38	EventNotifier notifier;
	39	bool hasnotifier;
	40	unsigned size;
	41	bool match_data;
	42	PCITestDevHdr *hdr;
	43	unsigned bufsize;
	44	} IOTest;
	45
	46	#define IOTEST_DATAMATCH 0xFA
	47	#define IOTEST_NOMATCH 0xCE
	48
	49	#define IOTEST_IOSIZE 128
	50	#define IOTEST_MEMSIZE 2048
	51
	52	static const char *iotest_test[] = {
	53	"no-eventfd",
	54	"wildcard-eventfd",
	55	"datamatch-eventfd"
	56	};
	57
	58	static const char *iotest_type[] = {
	59	"mmio",
	60	"portio"
	61	};
	62
	63	#define IOTEST_TEST(i) (iotest_test[((i) % ARRAY_SIZE(iotest_test))])
	64	#define IOTEST_TYPE(i) (iotest_type[((i) / ARRAY_SIZE(iotest_test))])
	65	#define IOTEST_MAX_TEST (ARRAY_SIZE(iotest_test))
	66	#define IOTEST_MAX_TYPE (ARRAY_SIZE(iotest_type))
	67	#define IOTEST_MAX (IOTEST_MAX_TEST * IOTEST_MAX_TYPE)
	68
	69	enum {
	70	IOTEST_ACCESS_NAME,
	71	IOTEST_ACCESS_DATA,
	72	IOTEST_ACCESS_MAX,
	73	};
	74
	75	#define IOTEST_ACCESS_TYPE uint8_t
	76	#define IOTEST_ACCESS_WIDTH (sizeof(uint8_t))
	77
	78	typedef struct PCITestDevState {
6d27a409 AF	79	/< private >/
	80	PCIDevice parent_obj;
	81	/< public >/
	82
22773d60 MT	83	MemoryRegion mmio;
	84	MemoryRegion portio;
	85	IOTest *tests;
	86	int current;
	87	} PCITestDevState;
	88
40108d0a PC	89	#define TYPE_PCI_TEST_DEV "pci-testdev"
	90
	91	#define PCI_TEST_DEV(obj) \
	92	OBJECT_CHECK(PCITestDevState, (obj), TYPE_PCI_TEST_DEV)
	93
22773d60 MT	94	#define IOTEST_IS_MEM(i) (strcmp(IOTEST_TYPE(i), "portio"))
	95	#define IOTEST_REGION(d, i) (IOTEST_IS_MEM(i) ? &(d)->mmio : &(d)->portio)
	96	#define IOTEST_SIZE(i) (IOTEST_IS_MEM(i) ? IOTEST_MEMSIZE : IOTEST_IOSIZE)
	97	#define IOTEST_PCI_BAR(i) (IOTEST_IS_MEM(i) ? PCI_BASE_ADDRESS_SPACE_MEMORY : \
	98	PCI_BASE_ADDRESS_SPACE_IO)
	99
	100	static int pci_testdev_start(IOTest *test)
	101	{
	102	test->hdr->count = 0;
	103	if (!test->hasnotifier) {
	104	return 0;
	105	}
	106	event_notifier_test_and_clear(&test->notifier);
	107	memory_region_add_eventfd(test->mr,
	108	le32_to_cpu(test->hdr->offset),
	109	test->size,
	110	test->match_data,
	111	test->hdr->data,
	112	&test->notifier);
	113	return 0;
	114	}
	115
	116	static void pci_testdev_stop(IOTest *test)
	117	{
	118	if (!test->hasnotifier) {
	119	return;
	120	}
	121	memory_region_del_eventfd(test->mr,
	122	le32_to_cpu(test->hdr->offset),
	123	test->size,
	124	test->match_data,
	125	test->hdr->data,
	126	&test->notifier);
	127	}
	128
	129	static void
	130	pci_testdev_reset(PCITestDevState *d)
	131	{
	132	if (d->current == -1) {
	133	return;
	134	}
	135	pci_testdev_stop(&d->tests[d->current]);
	136	d->current = -1;
	137	}
	138
	139	static void pci_testdev_inc(IOTest *test, unsigned inc)
	140	{
	141	uint32_t c = le32_to_cpu(test->hdr->count);
	142	test->hdr->count = cpu_to_le32(c + inc);
	143	}
	144
	145	static void
	146	pci_testdev_write(void *opaque, hwaddr addr, uint64_t val,
	147	unsigned size, int type)
	148	{
	149	PCITestDevState *d = opaque;
	150	IOTest *test;
	151	int t, r;
	152
	153	if (addr == offsetof(PCITestDevHdr, test)) {
	154	pci_testdev_reset(d);
	155	if (val >= IOTEST_MAX_TEST) {
	156	return;
	157	}
158	t = type * IOTEST_MAX_TEST + val;
159	r = pci_testdev_start(&d->tests[t]);
160	if (r < 0) {
161	return;
162	}
163	d->current = t;
164	return;
165	}
166	if (d->current < 0) {
167	return;
168	}
169	test = &d->tests[d->current];
170	if (addr != le32_to_cpu(test->hdr->offset)) {
171	return;
172	}
173	if (test->match_data && test->size != size) {
174	return;
175	}
176	if (test->match_data && val != test->hdr->data) {
177	return;
178	}
179	pci_testdev_inc(test, 1);
180	}
181
182	static uint64_t
183	pci_testdev_read(void *opaque, hwaddr addr, unsigned size)
184	{
185	PCITestDevState *d = opaque;
186	const char *buf;
187	IOTest *test;
188	if (d->current < 0) {
189	return 0;
190	}
191	test = &d->tests[d->current];
192	buf = (const char *)test->hdr;
193	if (addr + size >= test->bufsize) {
194	return 0;
195	}
196	if (test->hasnotifier) {
197	event_notifier_test_and_clear(&test->notifier);
198	}
199	return buf[addr];
200	}
201
202	static void
203	pci_testdev_mmio_write(void *opaque, hwaddr addr, uint64_t val,
204	unsigned size)
205	{
206	pci_testdev_write(opaque, addr, val, size, 0);
207	}
208
209	static void
210	pci_testdev_pio_write(void *opaque, hwaddr addr, uint64_t val,
211	unsigned size)
212	{
213	pci_testdev_write(opaque, addr, val, size, 1);
214	}
215
216	static const MemoryRegionOps pci_testdev_mmio_ops = {
217	.read = pci_testdev_read,
218	.write = pci_testdev_mmio_write,
219	.endianness = DEVICE_LITTLE_ENDIAN,
220	.impl = {
221	.min_access_size = 1,
222	.max_access_size = 1,
223	},
224	};
225
226	static const MemoryRegionOps pci_testdev_pio_ops = {
227	.read = pci_testdev_read,
228	.write = pci_testdev_pio_write,
229	.endianness = DEVICE_LITTLE_ENDIAN,
230	.impl = {
231	.min_access_size = 1,
232	.max_access_size = 1,
233	},
234	};
235
9af21dbe	236	static void pci_testdev_realize(PCIDevice pci_dev, Error *errp)
22773d60	237	{
40108d0a	238	PCITestDevState *d = PCI_TEST_DEV(pci_dev);
22773d60 MT	239	uint8_t *pci_conf;
	240	char *name;
	241	int r, i;
45aa4e8e	242	bool fastmmio = kvm_ioeventfd_any_length_enabled();
22773d60	243
6d27a409	244	pci_conf = pci_dev->config;
22773d60 MT	245
	246	pci_conf[PCI_INTERRUPT_PIN] = 0; /* no interrupt pin */
	247
3c161542	248	memory_region_init_io(&d->mmio, OBJECT(d), &pci_testdev_mmio_ops, d,
22773d60	249	"pci-testdev-mmio", IOTEST_MEMSIZE * 2);
3c161542	250	memory_region_init_io(&d->portio, OBJECT(d), &pci_testdev_pio_ops, d,
22773d60	251	"pci-testdev-portio", IOTEST_IOSIZE * 2);
6d27a409 AF	252	pci_register_bar(pci_dev, 0, PCI_BASE_ADDRESS_SPACE_MEMORY, &d->mmio);
6d27a409 AF	253	pci_register_bar(pci_dev, 1, PCI_BASE_ADDRESS_SPACE_IO, &d->portio);
22773d60 MT	254
	255	d->current = -1;
	256	d->tests = g_malloc0(IOTEST_MAX * sizeof *d->tests);
	257	for (i = 0; i < IOTEST_MAX; ++i) {
	258	IOTest *test = &d->tests[i];
	259	name = g_strdup_printf("%s-%s", IOTEST_TYPE(i), IOTEST_TEST(i));
	260	test->bufsize = sizeof(PCITestDevHdr) + strlen(name) + 1;
	261	test->hdr = g_malloc0(test->bufsize);
	262	memcpy(test->hdr->name, name, strlen(name) + 1);
	263	g_free(name);
	264	test->hdr->offset = cpu_to_le32(IOTEST_SIZE(i) + i * IOTEST_ACCESS_WIDTH);
22773d60	265	test->match_data = strcmp(IOTEST_TEST(i), "wildcard-eventfd");
45aa4e8e MT	266	if (fastmmio && IOTEST_IS_MEM(i) && !test->match_data) {
	267	test->size = 0;
	268	} else {
	269	test->size = IOTEST_ACCESS_WIDTH;
	270	}
22773d60 MT	271	test->hdr->test = i;
	272	test->hdr->data = test->match_data ? IOTEST_DATAMATCH : IOTEST_NOMATCH;
	273	test->hdr->width = IOTEST_ACCESS_WIDTH;
	274	test->mr = IOTEST_REGION(d, i);
	275	if (!strcmp(IOTEST_TEST(i), "no-eventfd")) {
	276	test->hasnotifier = false;
	277	continue;
	278	}
	279	r = event_notifier_init(&test->notifier, 0);
	280	assert(r >= 0);
	281	test->hasnotifier = true;
	282	}
22773d60 MT	283	}
	284
	285	static void
	286	pci_testdev_uninit(PCIDevice *dev)
	287	{
40108d0a	288	PCITestDevState *d = PCI_TEST_DEV(dev);
22773d60 MT	289	int i;
	290
	291	pci_testdev_reset(d);
	292	for (i = 0; i < IOTEST_MAX; ++i) {
	293	if (d->tests[i].hasnotifier) {
	294	event_notifier_cleanup(&d->tests[i].notifier);
	295	}
	296	g_free(d->tests[i].hdr);
	297	}
	298	g_free(d->tests);
22773d60 MT	299	}
	300
	301	static void qdev_pci_testdev_reset(DeviceState *dev)
	302	{
40108d0a	303	PCITestDevState *d = PCI_TEST_DEV(dev);
22773d60 MT	304	pci_testdev_reset(d);
	305	}
	306
	307	static void pci_testdev_class_init(ObjectClass klass, void data)
	308	{
	309	DeviceClass *dc = DEVICE_CLASS(klass);
	310	PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
	311
9af21dbe	312	k->realize = pci_testdev_realize;
22773d60 MT	313	k->exit = pci_testdev_uninit;
	314	k->vendor_id = PCI_VENDOR_ID_REDHAT;
	315	k->device_id = PCI_DEVICE_ID_REDHAT_TEST;
	316	k->revision = 0x00;
	317	k->class_id = PCI_CLASS_OTHERS;
	318	dc->desc = "PCI Test Device";
125ee0ed	319	set_bit(DEVICE_CATEGORY_MISC, dc->categories);
22773d60 MT	320	dc->reset = qdev_pci_testdev_reset;
	321	}
	322
	323	static const TypeInfo pci_testdev_info = {
40108d0a	324	.name = TYPE_PCI_TEST_DEV,
22773d60 MT	325	.parent = TYPE_PCI_DEVICE,
	326	.instance_size = sizeof(PCITestDevState),
	327	.class_init = pci_testdev_class_init,
	328	};
	329
	330	static void pci_testdev_register_types(void)
	331	{
	332	type_register_static(&pci_testdev_info);
	333	}
	334
	335	type_init(pci_testdev_register_types)