xref: /openbmc/qemu/hw/misc/unimp.c (revision ea1bb830cb021cca2e361091cf728aaabc8c0654)
1f5095aa3SPeter Maydell /* "Unimplemented" device
2f5095aa3SPeter Maydell  *
3f5095aa3SPeter Maydell  * This is a dummy device which accepts and logs all accesses.
4f5095aa3SPeter Maydell  * It's useful for stubbing out regions of an SoC or board
5f5095aa3SPeter Maydell  * map which correspond to devices that have not yet been
6f5095aa3SPeter Maydell  * implemented. This is often sufficient to placate initial
7f5095aa3SPeter Maydell  * guest device driver probing such that the system will
8f5095aa3SPeter Maydell  * come up.
9f5095aa3SPeter Maydell  *
10f5095aa3SPeter Maydell  * Copyright Linaro Limited, 2017
11f5095aa3SPeter Maydell  * Written by Peter Maydell
12f5095aa3SPeter Maydell  */
13f5095aa3SPeter Maydell 
14f5095aa3SPeter Maydell #include "qemu/osdep.h"
15f5095aa3SPeter Maydell #include "hw/sysbus.h"
16f5095aa3SPeter Maydell #include "hw/misc/unimp.h"
17f5095aa3SPeter Maydell #include "qemu/log.h"
180b8fa32fSMarkus Armbruster #include "qemu/module.h"
19f5095aa3SPeter Maydell #include "qapi/error.h"
20f5095aa3SPeter Maydell 
unimp_read(void * opaque,hwaddr offset,unsigned size)21f5095aa3SPeter Maydell static uint64_t unimp_read(void *opaque, hwaddr offset, unsigned size)
22f5095aa3SPeter Maydell {
23f5095aa3SPeter Maydell     UnimplementedDeviceState *s = UNIMPLEMENTED_DEVICE(opaque);
24f5095aa3SPeter Maydell 
25f5095aa3SPeter Maydell     qemu_log_mask(LOG_UNIMP, "%s: unimplemented device read  "
26*55d35c88SPhilippe Mathieu-Daudé                   "(size %d, offset 0x%0*" HWADDR_PRIx ")\n",
27*55d35c88SPhilippe Mathieu-Daudé                   s->name, size, s->offset_fmt_width, offset);
28f5095aa3SPeter Maydell     return 0;
29f5095aa3SPeter Maydell }
30f5095aa3SPeter Maydell 
unimp_write(void * opaque,hwaddr offset,uint64_t value,unsigned size)31f5095aa3SPeter Maydell static void unimp_write(void *opaque, hwaddr offset,
32f5095aa3SPeter Maydell                         uint64_t value, unsigned size)
33f5095aa3SPeter Maydell {
34f5095aa3SPeter Maydell     UnimplementedDeviceState *s = UNIMPLEMENTED_DEVICE(opaque);
35f5095aa3SPeter Maydell 
36f5095aa3SPeter Maydell     qemu_log_mask(LOG_UNIMP, "%s: unimplemented device write "
37*55d35c88SPhilippe Mathieu-Daudé                   "(size %d, offset 0x%0*" HWADDR_PRIx
38a12b4c53SPhilippe Mathieu-Daudé                   ", value 0x%0*" PRIx64 ")\n",
39*55d35c88SPhilippe Mathieu-Daudé                   s->name, size, s->offset_fmt_width, offset, size << 1, value);
40f5095aa3SPeter Maydell }
41f5095aa3SPeter Maydell 
42f5095aa3SPeter Maydell static const MemoryRegionOps unimp_ops = {
43f5095aa3SPeter Maydell     .read = unimp_read,
44f5095aa3SPeter Maydell     .write = unimp_write,
45f5095aa3SPeter Maydell     .impl.min_access_size = 1,
46f5095aa3SPeter Maydell     .impl.max_access_size = 8,
47f5095aa3SPeter Maydell     .valid.min_access_size = 1,
48f5095aa3SPeter Maydell     .valid.max_access_size = 8,
49f5095aa3SPeter Maydell     .endianness = DEVICE_NATIVE_ENDIAN,
50f5095aa3SPeter Maydell };
51f5095aa3SPeter Maydell 
unimp_realize(DeviceState * dev,Error ** errp)52f5095aa3SPeter Maydell static void unimp_realize(DeviceState *dev, Error **errp)
53f5095aa3SPeter Maydell {
54f5095aa3SPeter Maydell     UnimplementedDeviceState *s = UNIMPLEMENTED_DEVICE(dev);
55f5095aa3SPeter Maydell 
56f5095aa3SPeter Maydell     if (s->size == 0) {
57f5095aa3SPeter Maydell         error_setg(errp, "property 'size' not specified or zero");
58f5095aa3SPeter Maydell         return;
59f5095aa3SPeter Maydell     }
60f5095aa3SPeter Maydell 
61f5095aa3SPeter Maydell     if (s->name == NULL) {
62f5095aa3SPeter Maydell         error_setg(errp, "property 'name' not specified");
63f5095aa3SPeter Maydell         return;
64f5095aa3SPeter Maydell     }
65f5095aa3SPeter Maydell 
66*55d35c88SPhilippe Mathieu-Daudé     s->offset_fmt_width = DIV_ROUND_UP(64 - clz64(s->size - 1), 4);
67*55d35c88SPhilippe Mathieu-Daudé 
68f5095aa3SPeter Maydell     memory_region_init_io(&s->iomem, OBJECT(s), &unimp_ops, s,
69f5095aa3SPeter Maydell                           s->name, s->size);
70f5095aa3SPeter Maydell     sysbus_init_mmio(SYS_BUS_DEVICE(s), &s->iomem);
71f5095aa3SPeter Maydell }
72f5095aa3SPeter Maydell 
73f5095aa3SPeter Maydell static Property unimp_properties[] = {
74f5095aa3SPeter Maydell     DEFINE_PROP_UINT64("size", UnimplementedDeviceState, size, 0),
75f5095aa3SPeter Maydell     DEFINE_PROP_STRING("name", UnimplementedDeviceState, name),
76f5095aa3SPeter Maydell     DEFINE_PROP_END_OF_LIST(),
77f5095aa3SPeter Maydell };
78f5095aa3SPeter Maydell 
unimp_class_init(ObjectClass * klass,void * data)79f5095aa3SPeter Maydell static void unimp_class_init(ObjectClass *klass, void *data)
80f5095aa3SPeter Maydell {
81f5095aa3SPeter Maydell     DeviceClass *dc = DEVICE_CLASS(klass);
82f5095aa3SPeter Maydell 
83f5095aa3SPeter Maydell     dc->realize = unimp_realize;
844f67d30bSMarc-André Lureau     device_class_set_props(dc, unimp_properties);
85f5095aa3SPeter Maydell }
86f5095aa3SPeter Maydell 
87f5095aa3SPeter Maydell static const TypeInfo unimp_info = {
88f5095aa3SPeter Maydell     .name = TYPE_UNIMPLEMENTED_DEVICE,
89f5095aa3SPeter Maydell     .parent = TYPE_SYS_BUS_DEVICE,
90f5095aa3SPeter Maydell     .instance_size = sizeof(UnimplementedDeviceState),
91f5095aa3SPeter Maydell     .class_init = unimp_class_init,
92f5095aa3SPeter Maydell };
93f5095aa3SPeter Maydell 
unimp_register_types(void)94f5095aa3SPeter Maydell static void unimp_register_types(void)
95f5095aa3SPeter Maydell {
96f5095aa3SPeter Maydell     type_register_static(&unimp_info);
97f5095aa3SPeter Maydell }
98f5095aa3SPeter Maydell 
99f5095aa3SPeter Maydell type_init(unimp_register_types)
100