hw/fw_cfg.c

   1 /*
   2  * QEMU Firmware configuration device emulation
   3  *
   4  * Copyright (c) 2008 Gleb Natapov
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "hw.h"
  25 #include "sysemu.h"
  26 #include "isa.h"
  27 #include "fw_cfg.h"
  28 #include "sysbus.h"
  29
  30 /* debug firmware config */
  31 //#define DEBUG_FW_CFG
  32
  33 #ifdef DEBUG_FW_CFG
  34 #define FW_CFG_DPRINTF(fmt, ...)                        \
  35     do { printf("FW_CFG: " fmt , ## __VA_ARGS__); } while (0)
  36 #else
  37 #define FW_CFG_DPRINTF(fmt, ...)
  38 #endif
  39
  40 #define FW_CFG_SIZE 2
  41
  42 typedef struct FWCfgEntry {
  43     uint32_t len;
  44     uint8_t *data;
  45     void *callback_opaque;
  46     FWCfgCallback callback;
  47 } FWCfgEntry;
  48
  49 struct FWCfgState {
  50     SysBusDevice busdev;
  51     uint32_t ctl_iobase, data_iobase;
  52     FWCfgEntry entries[2][FW_CFG_MAX_ENTRY];
  53     FWCfgFiles *files;
  54     uint16_t cur_entry;
  55     uint32_t cur_offset;
  56     Notifier machine_ready;
  57 };
  58
  59 static void fw_cfg_write(FWCfgState *s, uint8_t value)
  60 {
  61     int arch = !!(s->cur_entry & FW_CFG_ARCH_LOCAL);
  62     FWCfgEntry *e = &s->entries[arch][s->cur_entry & FW_CFG_ENTRY_MASK];
  63
  64     FW_CFG_DPRINTF("write %d\n", value);
  65
  66     if (s->cur_entry & FW_CFG_WRITE_CHANNEL && s->cur_offset < e->len) {
  67         e->data[s->cur_offset++] = value;
  68         if (s->cur_offset == e->len) {
  69             e->callback(e->callback_opaque, e->data);
  70             s->cur_offset = 0;
  71         }
  72     }
  73 }
  74
  75 static int fw_cfg_select(FWCfgState *s, uint16_t key)
  76 {
  77     int ret;
  78
  79     s->cur_offset = 0;
  80     if ((key & FW_CFG_ENTRY_MASK) >= FW_CFG_MAX_ENTRY) {
  81         s->cur_entry = FW_CFG_INVALID;
  82         ret = 0;
  83     } else {
  84         s->cur_entry = key;
  85         ret = 1;
  86     }
  87
  88     FW_CFG_DPRINTF("select key %d (%sfound)\n", key, ret ? "" : "not ");
  89
  90     return ret;
  91 }
  92
  93 static uint8_t fw_cfg_read(FWCfgState *s)
  94 {
  95     int arch = !!(s->cur_entry & FW_CFG_ARCH_LOCAL);
  96     FWCfgEntry *e = &s->entries[arch][s->cur_entry & FW_CFG_ENTRY_MASK];
  97     uint8_t ret;
  98
  99     if (s->cur_entry == FW_CFG_INVALID || !e->data || s->cur_offset >= e->len)
 100         ret = 0;
 101     else
 102         ret = e->data[s->cur_offset++];
 103
 104     FW_CFG_DPRINTF("read %d\n", ret);
 105
 106     return ret;
 107 }
 108
 109 static uint32_t fw_cfg_io_readb(void *opaque, uint32_t addr)
 110 {
 111     return fw_cfg_read(opaque);
 112 }
 113
 114 static void fw_cfg_io_writeb(void *opaque, uint32_t addr, uint32_t value)
 115 {
 116     fw_cfg_write(opaque, (uint8_t)value);
 117 }
 118
 119 static void fw_cfg_io_writew(void *opaque, uint32_t addr, uint32_t value)
 120 {
 121     fw_cfg_select(opaque, (uint16_t)value);
 122 }
 123
 124 static uint32_t fw_cfg_mem_readb(void *opaque, target_phys_addr_t addr)
 125 {
 126     return fw_cfg_read(opaque);
 127 }
 128
 129 static void fw_cfg_mem_writeb(void *opaque, target_phys_addr_t addr,
 130                               uint32_t value)
 131 {
 132     fw_cfg_write(opaque, (uint8_t)value);
 133 }
 134
 135 static void fw_cfg_mem_writew(void *opaque, target_phys_addr_t addr,
 136                               uint32_t value)
 137 {
 138     fw_cfg_select(opaque, (uint16_t)value);
 139 }
 140
 141 static CPUReadMemoryFunc * const fw_cfg_ctl_mem_read[3] = {
 142     NULL,
 143     NULL,
 144     NULL,
 145 };
 146
 147 static CPUWriteMemoryFunc * const fw_cfg_ctl_mem_write[3] = {
 148     NULL,
 149     fw_cfg_mem_writew,
 150     NULL,
 151 };
 152
 153 static CPUReadMemoryFunc * const fw_cfg_data_mem_read[3] = {
 154     fw_cfg_mem_readb,
 155     NULL,
 156     NULL,
 157 };
 158
 159 static CPUWriteMemoryFunc * const fw_cfg_data_mem_write[3] = {
 160     fw_cfg_mem_writeb,
 161     NULL,
 162     NULL,
 163 };
 164
 165 static void fw_cfg_reset(DeviceState *d)
 166 {
 167     FWCfgState *s = DO_UPCAST(FWCfgState, busdev.qdev, d);
 168
 169     fw_cfg_select(s, 0);
 170 }
 171
 172 /* Save restore 32 bit int as uint16_t
 173    This is a Big hack, but it is how the old state did it.
 174    Or we broke compatibility in the state, or we can't use struct tm
 175  */
 176
 177 static int get_uint32_as_uint16(QEMUFile *f, void *pv, size_t size)
 178 {
 179     uint32_t *v = pv;
 180     *v = qemu_get_be16(f);
 181     return 0;
 182 }
 183
 184 static void put_unused(QEMUFile *f, void *pv, size_t size)
 185 {
 186     fprintf(stderr, "uint32_as_uint16 is only used for backward compatibility.\n");
 187     fprintf(stderr, "This functions shouldn't be called.\n");
 188 }
 189
 190 static const VMStateInfo vmstate_hack_uint32_as_uint16 = {
 191     .name = "int32_as_uint16",
 192     .get  = get_uint32_as_uint16,
 193     .put  = put_unused,
 194 };
 195
 196 #define VMSTATE_UINT16_HACK(_f, _s, _t)                                    \
 197     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_hack_uint32_as_uint16, uint32_t)
 198
 199
 200 static bool is_version_1(void *opaque, int version_id)
 201 {
 202     return version_id == 1;
 203 }
 204
 205 static const VMStateDescription vmstate_fw_cfg = {
 206     .name = "fw_cfg",
 207     .version_id = 2,
 208     .minimum_version_id = 1,
 209     .minimum_version_id_old = 1,
 210     .fields      = (VMStateField []) {
 211         VMSTATE_UINT16(cur_entry, FWCfgState),
 212         VMSTATE_UINT16_HACK(cur_offset, FWCfgState, is_version_1),
 213         VMSTATE_UINT32_V(cur_offset, FWCfgState, 2),
 214         VMSTATE_END_OF_LIST()
 215     }
 216 };
 217
 218 int fw_cfg_add_bytes(FWCfgState *s, uint16_t key, uint8_t *data, uint32_t len)
 219 {
 220     int arch = !!(key & FW_CFG_ARCH_LOCAL);
 221
 222     key &= FW_CFG_ENTRY_MASK;
 223
 224     if (key >= FW_CFG_MAX_ENTRY)
 225         return 0;
 226
 227     s->entries[arch][key].data = data;
 228     s->entries[arch][key].len = len;
 229
 230     return 1;
 231 }
 232
 233 int fw_cfg_add_i16(FWCfgState *s, uint16_t key, uint16_t value)
 234 {
 235     uint16_t *copy;
 236
 237     copy = qemu_malloc(sizeof(value));
 238     *copy = cpu_to_le16(value);
 239     return fw_cfg_add_bytes(s, key, (uint8_t *)copy, sizeof(value));
 240 }
 241
 242 int fw_cfg_add_i32(FWCfgState *s, uint16_t key, uint32_t value)
 243 {
 244     uint32_t *copy;
 245
 246     copy = qemu_malloc(sizeof(value));
 247     *copy = cpu_to_le32(value);
 248     return fw_cfg_add_bytes(s, key, (uint8_t *)copy, sizeof(value));
 249 }
 250
 251 int fw_cfg_add_i64(FWCfgState *s, uint16_t key, uint64_t value)
 252 {
 253     uint64_t *copy;
 254
 255     copy = qemu_malloc(sizeof(value));
 256     *copy = cpu_to_le64(value);
 257     return fw_cfg_add_bytes(s, key, (uint8_t *)copy, sizeof(value));
 258 }
 259
 260 int fw_cfg_add_callback(FWCfgState *s, uint16_t key, FWCfgCallback callback,
 261                         void *callback_opaque, uint8_t *data, size_t len)
 262 {
 263     int arch = !!(key & FW_CFG_ARCH_LOCAL);
 264
 265     if (!(key & FW_CFG_WRITE_CHANNEL))
 266         return 0;
 267
 268     key &= FW_CFG_ENTRY_MASK;
 269
 270     if (key >= FW_CFG_MAX_ENTRY || len > 65535)
 271         return 0;
 272
 273     s->entries[arch][key].data = data;
 274     s->entries[arch][key].len = len;
 275     s->entries[arch][key].callback_opaque = callback_opaque;
 276     s->entries[arch][key].callback = callback;
 277
 278     return 1;
 279 }
 280
 281 int fw_cfg_add_file(FWCfgState *s,  const char *filename, uint8_t *data,
 282                     uint32_t len)
 283 {
 284     int i, index;
 285
 286     if (!s->files) {
 287         int dsize = sizeof(uint32_t) + sizeof(FWCfgFile) * FW_CFG_FILE_SLOTS;
 288         s->files = qemu_mallocz(dsize);
 289         fw_cfg_add_bytes(s, FW_CFG_FILE_DIR, (uint8_t*)s->files, dsize);
 290     }
 291
 292     index = be32_to_cpu(s->files->count);
 293     if (index == FW_CFG_FILE_SLOTS) {
 294         fprintf(stderr, "fw_cfg: out of file slots\n");
 295         return 0;
 296     }
 297
 298     fw_cfg_add_bytes(s, FW_CFG_FILE_FIRST + index, data, len);
 299
 300     pstrcpy(s->files->f[index].name, sizeof(s->files->f[index].name),
 301             filename);
 302     for (i = 0; i < index; i++) {
 303         if (strcmp(s->files->f[index].name, s->files->f[i].name) == 0) {
 304             FW_CFG_DPRINTF("%s: skip duplicate: %s\n", __FUNCTION__,
 305                            s->files->f[index].name);
 306             return 1;
 307         }
 308     }
 309
 310     s->files->f[index].size   = cpu_to_be32(len);
 311     s->files->f[index].select = cpu_to_be16(FW_CFG_FILE_FIRST + index);
 312     FW_CFG_DPRINTF("%s: #%d: %s (%d bytes)\n", __FUNCTION__,
 313                    index, s->files->f[index].name, len);
 314
 315     s->files->count = cpu_to_be32(index+1);
 316     return 1;
 317 }
 318
 319 static void fw_cfg_machine_ready(struct Notifier *n, void *data)
 320 {
 321     uint32_t len;
 322     FWCfgState *s = container_of(n, FWCfgState, machine_ready);
 323     char *bootindex = get_boot_devices_list(&len);
 324
 325     fw_cfg_add_file(s, "bootorder", (uint8_t*)bootindex, len);
 326 }
 327
 328 FWCfgState *fw_cfg_init(uint32_t ctl_port, uint32_t data_port,
 329                         target_phys_addr_t ctl_addr, target_phys_addr_t data_addr)
 330 {
 331     DeviceState *dev;
 332     SysBusDevice *d;
 333     FWCfgState *s;
 334
 335     dev = qdev_create(NULL, "fw_cfg");
 336     qdev_prop_set_uint32(dev, "ctl_iobase", ctl_port);
 337     qdev_prop_set_uint32(dev, "data_iobase", data_port);
 338     qdev_init_nofail(dev);
 339     d = sysbus_from_qdev(dev);
 340
 341     s = DO_UPCAST(FWCfgState, busdev.qdev, dev);
 342
 343     if (ctl_addr) {
 344         sysbus_mmio_map(d, 0, ctl_addr);
 345     }
 346     if (data_addr) {
 347         sysbus_mmio_map(d, 1, data_addr);
 348     }
 349     fw_cfg_add_bytes(s, FW_CFG_SIGNATURE, (uint8_t *)"QEMU", 4);
 350     fw_cfg_add_bytes(s, FW_CFG_UUID, qemu_uuid, 16);
 351     fw_cfg_add_i16(s, FW_CFG_NOGRAPHIC, (uint16_t)(display_type == DT_NOGRAPHIC));
 352     fw_cfg_add_i16(s, FW_CFG_NB_CPUS, (uint16_t)smp_cpus);
 353     fw_cfg_add_i16(s, FW_CFG_MAX_CPUS, (uint16_t)max_cpus);
 354     fw_cfg_add_i16(s, FW_CFG_BOOT_MENU, (uint16_t)boot_menu);
 355
 356
 357     s->machine_ready.notify = fw_cfg_machine_ready;
 358     qemu_add_machine_init_done_notifier(&s->machine_ready);
 359
 360     return s;
 361 }
 362
 363 static int fw_cfg_init1(SysBusDevice *dev)
 364 {
 365     FWCfgState *s = FROM_SYSBUS(FWCfgState, dev);
 366     int io_ctl_memory, io_data_memory;
 367
 368     io_ctl_memory = cpu_register_io_memory(fw_cfg_ctl_mem_read,
 369                                            fw_cfg_ctl_mem_write, s,
 370                                            DEVICE_NATIVE_ENDIAN);
 371     sysbus_init_mmio(dev, FW_CFG_SIZE, io_ctl_memory);
 372
 373     io_data_memory = cpu_register_io_memory(fw_cfg_data_mem_read,
 374                                             fw_cfg_data_mem_write, s,
 375                                             DEVICE_NATIVE_ENDIAN);
 376     sysbus_init_mmio(dev, FW_CFG_SIZE, io_data_memory);
 377
 378     if (s->ctl_iobase) {
 379         register_ioport_write(s->ctl_iobase, 2, 2, fw_cfg_io_writew, s);
 380     }
 381     if (s->data_iobase) {
 382         register_ioport_read(s->data_iobase, 1, 1, fw_cfg_io_readb, s);
 383         register_ioport_write(s->data_iobase, 1, 1, fw_cfg_io_writeb, s);
 384     }
 385     return 0;
 386 }
 387
 388 static SysBusDeviceInfo fw_cfg_info = {
 389     .init = fw_cfg_init1,
 390     .qdev.name = "fw_cfg",
 391     .qdev.size = sizeof(FWCfgState),
 392     .qdev.vmsd = &vmstate_fw_cfg,
 393     .qdev.reset = fw_cfg_reset,
 394     .qdev.no_user = 1,
 395     .qdev.props = (Property[]) {
 396         DEFINE_PROP_HEX32("ctl_iobase", FWCfgState, ctl_iobase, -1),
 397         DEFINE_PROP_HEX32("data_iobase", FWCfgState, data_iobase, -1),
 398         DEFINE_PROP_END_OF_LIST(),
 399     },
 400 };
 401
 402 static void fw_cfg_register_devices(void)
 403 {
 404     sysbus_register_withprop(&fw_cfg_info);
 405 }
 406
 407 device_init(fw_cfg_register_devices)