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 #include "qemu-error.h"
  30
  31 /* debug firmware config */
  32 //#define DEBUG_FW_CFG
  33
  34 #ifdef DEBUG_FW_CFG
  35 #define FW_CFG_DPRINTF(fmt, ...)                        \
  36     do { printf("FW_CFG: " fmt , ## __VA_ARGS__); } while (0)
  37 #else
  38 #define FW_CFG_DPRINTF(fmt, ...)
  39 #endif
  40
  41 #define FW_CFG_SIZE 2
  42
  43 typedef struct FWCfgEntry {
  44     uint32_t len;
  45     uint8_t *data;
  46     void *callback_opaque;
  47     FWCfgCallback callback;
  48 } FWCfgEntry;
  49
  50 struct FWCfgState {
  51     SysBusDevice busdev;
  52     uint32_t ctl_iobase, data_iobase;
  53     FWCfgEntry entries[2][FW_CFG_MAX_ENTRY];
  54     FWCfgFiles *files;
  55     uint16_t cur_entry;
  56     uint32_t cur_offset;
  57     Notifier machine_ready;
  58 };
  59
  60 #define JPG_FILE 0
  61 #define BMP_FILE 1
  62
  63 static FILE *probe_splashfile(char *filename, int *file_sizep, int *file_typep)
  64 {
  65     FILE *fp = NULL;
  66     int fop_ret;
  67     int file_size;
  68     int file_type = -1;
  69     unsigned char buf[2] = {0, 0};
  70     unsigned int filehead_value = 0;
  71     int bmp_bpp;
  72
  73     fp = fopen(filename, "rb");
  74     if (fp == NULL) {
  75         error_report("failed to open file '%s'.", filename);
  76         return fp;
  77     }
  78     /* check file size */
  79     fseek(fp, 0L, SEEK_END);
  80     file_size = ftell(fp);
  81     if (file_size < 2) {
  82         error_report("file size is less than 2 bytes '%s'.", filename);
  83         fclose(fp);
  84         fp = NULL;
  85         return fp;
  86     }
  87     /* check magic ID */
  88     fseek(fp, 0L, SEEK_SET);
  89     fop_ret = fread(buf, 1, 2, fp);
  90     if (fop_ret != 2) {
  91         error_report("Could not read header from '%s': %s",
  92                      filename, strerror(errno));
  93         fclose(fp);
  94         fp = NULL;
  95         return fp;
  96     }
  97     filehead_value = (buf[0] + (buf[1] << 8)) & 0xffff;
  98     if (filehead_value == 0xd8ff) {
  99         file_type = JPG_FILE;
 100     } else {
 101         if (filehead_value == 0x4d42) {
 102             file_type = BMP_FILE;
 103         }
 104     }
 105     if (file_type < 0) {
 106         error_report("'%s' not jpg/bmp file,head:0x%x.",
 107                          filename, filehead_value);
 108         fclose(fp);
 109         fp = NULL;
 110         return fp;
 111     }
 112     /* check BMP bpp */
 113     if (file_type == BMP_FILE) {
 114         fseek(fp, 28, SEEK_SET);
 115         fop_ret = fread(buf, 1, 2, fp);
 116         bmp_bpp = (buf[0] + (buf[1] << 8)) & 0xffff;
 117         if (bmp_bpp != 24) {
 118             error_report("only 24bpp bmp file is supported.");
 119             fclose(fp);
 120             fp = NULL;
 121             return fp;
 122         }
 123     }
 124     /* return values */
 125     *file_sizep = file_size;
 126     *file_typep = file_type;
 127     return fp;
 128 }
 129
 130 static void fw_cfg_bootsplash(FWCfgState *s)
 131 {
 132     int boot_splash_time = -1;
 133     const char *boot_splash_filename = NULL;
 134     char *p;
 135     char *filename;
 136     FILE *fp;
 137     int fop_ret;
 138     int file_size;
 139     int file_type = -1;
 140     const char *temp;
 141
 142     /* get user configuration */
 143     QemuOptsList *plist = qemu_find_opts("boot-opts");
 144     QemuOpts *opts = QTAILQ_FIRST(&plist->head);
 145     if (opts != NULL) {
 146         temp = qemu_opt_get(opts, "splash");
 147         if (temp != NULL) {
 148             boot_splash_filename = temp;
 149         }
 150         temp = qemu_opt_get(opts, "splash-time");
 151         if (temp != NULL) {
 152             p = (char *)temp;
 153             boot_splash_time = strtol(p, (char **)&p, 10);
 154         }
 155     }
 156
 157     /* insert splash time if user configurated */
 158     if (boot_splash_time >= 0) {
 159         /* validate the input */
 160         if (boot_splash_time > 0xffff) {
 161             error_report("splash time is big than 65535, force it to 65535.");
 162             boot_splash_time = 0xffff;
 163         }
 164         /* use little endian format */
 165         qemu_extra_params_fw[0] = (uint8_t)(boot_splash_time & 0xff);
 166         qemu_extra_params_fw[1] = (uint8_t)((boot_splash_time >> 8) & 0xff);
 167         fw_cfg_add_file(s, "etc/boot-menu-wait", qemu_extra_params_fw, 2);
 168     }
 169
 170     /* insert splash file if user configurated */
 171     if (boot_splash_filename != NULL) {
 172         filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, boot_splash_filename);
 173         if (filename == NULL) {
 174             error_report("failed to find file '%s'.", boot_splash_filename);
 175             return;
 176         }
 177         /* probing the file */
 178         fp = probe_splashfile(filename, &file_size, &file_type);
 179         if (fp == NULL) {
 180             g_free(filename);
 181             return;
 182         }
 183         /* loading file data */
 184         if (boot_splash_filedata != NULL) {
 185             g_free(boot_splash_filedata);
 186         }
 187         boot_splash_filedata = g_malloc(file_size);
 188         boot_splash_filedata_size = file_size;
 189         fseek(fp, 0L, SEEK_SET);
 190         fop_ret = fread(boot_splash_filedata, 1, file_size, fp);
 191         if (fop_ret != file_size) {
 192             error_report("failed to read data from '%s'.",
 193                          boot_splash_filename);
 194             fclose(fp);
 195             return;
 196         }
 197         fclose(fp);
 198         /* insert data */
 199         if (file_type == JPG_FILE) {
 200             fw_cfg_add_file(s, "bootsplash.jpg",
 201                     boot_splash_filedata, boot_splash_filedata_size);
 202         } else {
 203             fw_cfg_add_file(s, "bootsplash.bmp",
 204                     boot_splash_filedata, boot_splash_filedata_size);
 205         }
 206         g_free(filename);
 207     }
 208 }
 209
 210 static void fw_cfg_write(FWCfgState *s, uint8_t value)
 211 {
 212     int arch = !!(s->cur_entry & FW_CFG_ARCH_LOCAL);
 213     FWCfgEntry *e = &s->entries[arch][s->cur_entry & FW_CFG_ENTRY_MASK];
 214
 215     FW_CFG_DPRINTF("write %d\n", value);
 216
 217     if (s->cur_entry & FW_CFG_WRITE_CHANNEL && e->callback &&
 218         s->cur_offset < e->len) {
 219         e->data[s->cur_offset++] = value;
 220         if (s->cur_offset == e->len) {
 221             e->callback(e->callback_opaque, e->data);
 222             s->cur_offset = 0;
 223         }
 224     }
 225 }
 226
 227 static int fw_cfg_select(FWCfgState *s, uint16_t key)
 228 {
 229     int ret;
 230
 231     s->cur_offset = 0;
 232     if ((key & FW_CFG_ENTRY_MASK) >= FW_CFG_MAX_ENTRY) {
 233         s->cur_entry = FW_CFG_INVALID;
 234         ret = 0;
 235     } else {
 236         s->cur_entry = key;
 237         ret = 1;
 238     }
 239
 240     FW_CFG_DPRINTF("select key %d (%sfound)\n", key, ret ? "" : "not ");
 241
 242     return ret;
 243 }
 244
 245 static uint8_t fw_cfg_read(FWCfgState *s)
 246 {
 247     int arch = !!(s->cur_entry & FW_CFG_ARCH_LOCAL);
 248     FWCfgEntry *e = &s->entries[arch][s->cur_entry & FW_CFG_ENTRY_MASK];
 249     uint8_t ret;
 250
 251     if (s->cur_entry == FW_CFG_INVALID || !e->data || s->cur_offset >= e->len)
 252         ret = 0;
 253     else
 254         ret = e->data[s->cur_offset++];
 255
 256     FW_CFG_DPRINTF("read %d\n", ret);
 257
 258     return ret;
 259 }
 260
 261 static uint32_t fw_cfg_io_readb(void *opaque, uint32_t addr)
 262 {
 263     return fw_cfg_read(opaque);
 264 }
 265
 266 static void fw_cfg_io_writeb(void *opaque, uint32_t addr, uint32_t value)
 267 {
 268     fw_cfg_write(opaque, (uint8_t)value);
 269 }
 270
 271 static void fw_cfg_io_writew(void *opaque, uint32_t addr, uint32_t value)
 272 {
 273     fw_cfg_select(opaque, (uint16_t)value);
 274 }
 275
 276 static uint32_t fw_cfg_mem_readb(void *opaque, target_phys_addr_t addr)
 277 {
 278     return fw_cfg_read(opaque);
 279 }
 280
 281 static void fw_cfg_mem_writeb(void *opaque, target_phys_addr_t addr,
 282                               uint32_t value)
 283 {
 284     fw_cfg_write(opaque, (uint8_t)value);
 285 }
 286
 287 static void fw_cfg_mem_writew(void *opaque, target_phys_addr_t addr,
 288                               uint32_t value)
 289 {
 290     fw_cfg_select(opaque, (uint16_t)value);
 291 }
 292
 293 static CPUReadMemoryFunc * const fw_cfg_ctl_mem_read[3] = {
 294     NULL,
 295     NULL,
 296     NULL,
 297 };
 298
 299 static CPUWriteMemoryFunc * const fw_cfg_ctl_mem_write[3] = {
 300     NULL,
 301     fw_cfg_mem_writew,
 302     NULL,
 303 };
 304
 305 static CPUReadMemoryFunc * const fw_cfg_data_mem_read[3] = {
 306     fw_cfg_mem_readb,
 307     NULL,
 308     NULL,
 309 };
 310
 311 static CPUWriteMemoryFunc * const fw_cfg_data_mem_write[3] = {
 312     fw_cfg_mem_writeb,
 313     NULL,
 314     NULL,
 315 };
 316
 317 static void fw_cfg_reset(DeviceState *d)
 318 {
 319     FWCfgState *s = DO_UPCAST(FWCfgState, busdev.qdev, d);
 320
 321     fw_cfg_select(s, 0);
 322 }
 323
 324 /* Save restore 32 bit int as uint16_t
 325    This is a Big hack, but it is how the old state did it.
 326    Or we broke compatibility in the state, or we can't use struct tm
 327  */
 328
 329 static int get_uint32_as_uint16(QEMUFile *f, void *pv, size_t size)
 330 {
 331     uint32_t *v = pv;
 332     *v = qemu_get_be16(f);
 333     return 0;
 334 }
 335
 336 static void put_unused(QEMUFile *f, void *pv, size_t size)
 337 {
 338     fprintf(stderr, "uint32_as_uint16 is only used for backward compatibility.\n");
 339     fprintf(stderr, "This functions shouldn't be called.\n");
 340 }
 341
 342 static const VMStateInfo vmstate_hack_uint32_as_uint16 = {
 343     .name = "int32_as_uint16",
 344     .get  = get_uint32_as_uint16,
 345     .put  = put_unused,
 346 };
 347
 348 #define VMSTATE_UINT16_HACK(_f, _s, _t)                                    \
 349     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_hack_uint32_as_uint16, uint32_t)
 350
 351
 352 static bool is_version_1(void *opaque, int version_id)
 353 {
 354     return version_id == 1;
 355 }
 356
 357 static const VMStateDescription vmstate_fw_cfg = {
 358     .name = "fw_cfg",
 359     .version_id = 2,
 360     .minimum_version_id = 1,
 361     .minimum_version_id_old = 1,
 362     .fields      = (VMStateField []) {
 363         VMSTATE_UINT16(cur_entry, FWCfgState),
 364         VMSTATE_UINT16_HACK(cur_offset, FWCfgState, is_version_1),
 365         VMSTATE_UINT32_V(cur_offset, FWCfgState, 2),
 366         VMSTATE_END_OF_LIST()
 367     }
 368 };
 369
 370 int fw_cfg_add_bytes(FWCfgState *s, uint16_t key, uint8_t *data, uint32_t len)
 371 {
 372     int arch = !!(key & FW_CFG_ARCH_LOCAL);
 373
 374     key &= FW_CFG_ENTRY_MASK;
 375
 376     if (key >= FW_CFG_MAX_ENTRY)
 377         return 0;
 378
 379     s->entries[arch][key].data = data;
 380     s->entries[arch][key].len = len;
 381
 382     return 1;
 383 }
 384
 385 int fw_cfg_add_i16(FWCfgState *s, uint16_t key, uint16_t value)
 386 {
 387     uint16_t *copy;
 388
 389     copy = g_malloc(sizeof(value));
 390     *copy = cpu_to_le16(value);
 391     return fw_cfg_add_bytes(s, key, (uint8_t *)copy, sizeof(value));
 392 }
 393
 394 int fw_cfg_add_i32(FWCfgState *s, uint16_t key, uint32_t value)
 395 {
 396     uint32_t *copy;
 397
 398     copy = g_malloc(sizeof(value));
 399     *copy = cpu_to_le32(value);
 400     return fw_cfg_add_bytes(s, key, (uint8_t *)copy, sizeof(value));
 401 }
 402
 403 int fw_cfg_add_i64(FWCfgState *s, uint16_t key, uint64_t value)
 404 {
 405     uint64_t *copy;
 406
 407     copy = g_malloc(sizeof(value));
 408     *copy = cpu_to_le64(value);
 409     return fw_cfg_add_bytes(s, key, (uint8_t *)copy, sizeof(value));
 410 }
 411
 412 int fw_cfg_add_callback(FWCfgState *s, uint16_t key, FWCfgCallback callback,
 413                         void *callback_opaque, uint8_t *data, size_t len)
 414 {
 415     int arch = !!(key & FW_CFG_ARCH_LOCAL);
 416
 417     if (!(key & FW_CFG_WRITE_CHANNEL))
 418         return 0;
 419
 420     key &= FW_CFG_ENTRY_MASK;
 421
 422     if (key >= FW_CFG_MAX_ENTRY || len > 65535)
 423         return 0;
 424
 425     s->entries[arch][key].data = data;
 426     s->entries[arch][key].len = len;
 427     s->entries[arch][key].callback_opaque = callback_opaque;
 428     s->entries[arch][key].callback = callback;
 429
 430     return 1;
 431 }
 432
 433 int fw_cfg_add_file(FWCfgState *s,  const char *filename, uint8_t *data,
 434                     uint32_t len)
 435 {
 436     int i, index;
 437
 438     if (!s->files) {
 439         int dsize = sizeof(uint32_t) + sizeof(FWCfgFile) * FW_CFG_FILE_SLOTS;
 440         s->files = g_malloc0(dsize);
 441         fw_cfg_add_bytes(s, FW_CFG_FILE_DIR, (uint8_t*)s->files, dsize);
 442     }
 443
 444     index = be32_to_cpu(s->files->count);
 445     if (index == FW_CFG_FILE_SLOTS) {
 446         fprintf(stderr, "fw_cfg: out of file slots\n");
 447         return 0;
 448     }
 449
 450     fw_cfg_add_bytes(s, FW_CFG_FILE_FIRST + index, data, len);
 451
 452     pstrcpy(s->files->f[index].name, sizeof(s->files->f[index].name),
 453             filename);
 454     for (i = 0; i < index; i++) {
 455         if (strcmp(s->files->f[index].name, s->files->f[i].name) == 0) {
 456             FW_CFG_DPRINTF("%s: skip duplicate: %s\n", __FUNCTION__,
 457                            s->files->f[index].name);
 458             return 1;
 459         }
 460     }
 461
 462     s->files->f[index].size   = cpu_to_be32(len);
 463     s->files->f[index].select = cpu_to_be16(FW_CFG_FILE_FIRST + index);
 464     FW_CFG_DPRINTF("%s: #%d: %s (%d bytes)\n", __FUNCTION__,
 465                    index, s->files->f[index].name, len);
 466
 467     s->files->count = cpu_to_be32(index+1);
 468     return 1;
 469 }
 470
 471 static void fw_cfg_machine_ready(struct Notifier *n, void *data)
 472 {
 473     uint32_t len;
 474     FWCfgState *s = container_of(n, FWCfgState, machine_ready);
 475     char *bootindex = get_boot_devices_list(&len);
 476
 477     fw_cfg_add_file(s, "bootorder", (uint8_t*)bootindex, len);
 478 }
 479
 480 FWCfgState *fw_cfg_init(uint32_t ctl_port, uint32_t data_port,
 481                         target_phys_addr_t ctl_addr, target_phys_addr_t data_addr)
 482 {
 483     DeviceState *dev;
 484     SysBusDevice *d;
 485     FWCfgState *s;
 486
 487     dev = qdev_create(NULL, "fw_cfg");
 488     qdev_prop_set_uint32(dev, "ctl_iobase", ctl_port);
 489     qdev_prop_set_uint32(dev, "data_iobase", data_port);
 490     qdev_init_nofail(dev);
 491     d = sysbus_from_qdev(dev);
 492
 493     s = DO_UPCAST(FWCfgState, busdev.qdev, dev);
 494
 495     if (ctl_addr) {
 496         sysbus_mmio_map(d, 0, ctl_addr);
 497     }
 498     if (data_addr) {
 499         sysbus_mmio_map(d, 1, data_addr);
 500     }
 501     fw_cfg_add_bytes(s, FW_CFG_SIGNATURE, (uint8_t *)"QEMU", 4);
 502     fw_cfg_add_bytes(s, FW_CFG_UUID, qemu_uuid, 16);
 503     fw_cfg_add_i16(s, FW_CFG_NOGRAPHIC, (uint16_t)(display_type == DT_NOGRAPHIC));
 504     fw_cfg_add_i16(s, FW_CFG_NB_CPUS, (uint16_t)smp_cpus);
 505     fw_cfg_add_i16(s, FW_CFG_MAX_CPUS, (uint16_t)max_cpus);
 506     fw_cfg_add_i16(s, FW_CFG_BOOT_MENU, (uint16_t)boot_menu);
 507     fw_cfg_bootsplash(s);
 508
 509     s->machine_ready.notify = fw_cfg_machine_ready;
 510     qemu_add_machine_init_done_notifier(&s->machine_ready);
 511
 512     return s;
 513 }
 514
 515 static int fw_cfg_init1(SysBusDevice *dev)
 516 {
 517     FWCfgState *s = FROM_SYSBUS(FWCfgState, dev);
 518     int io_ctl_memory, io_data_memory;
 519
 520     io_ctl_memory = cpu_register_io_memory(fw_cfg_ctl_mem_read,
 521                                            fw_cfg_ctl_mem_write, s,
 522                                            DEVICE_NATIVE_ENDIAN);
 523     sysbus_init_mmio(dev, FW_CFG_SIZE, io_ctl_memory);
 524
 525     io_data_memory = cpu_register_io_memory(fw_cfg_data_mem_read,
 526                                             fw_cfg_data_mem_write, s,
 527                                             DEVICE_NATIVE_ENDIAN);
 528     sysbus_init_mmio(dev, FW_CFG_SIZE, io_data_memory);
 529
 530     if (s->ctl_iobase) {
 531         register_ioport_write(s->ctl_iobase, 2, 2, fw_cfg_io_writew, s);
 532     }
 533     if (s->data_iobase) {
 534         register_ioport_read(s->data_iobase, 1, 1, fw_cfg_io_readb, s);
 535         register_ioport_write(s->data_iobase, 1, 1, fw_cfg_io_writeb, s);
 536     }
 537     return 0;
 538 }
 539
 540 static SysBusDeviceInfo fw_cfg_info = {
 541     .init = fw_cfg_init1,
 542     .qdev.name = "fw_cfg",
 543     .qdev.size = sizeof(FWCfgState),
 544     .qdev.vmsd = &vmstate_fw_cfg,
 545     .qdev.reset = fw_cfg_reset,
 546     .qdev.no_user = 1,
 547     .qdev.props = (Property[]) {
 548         DEFINE_PROP_HEX32("ctl_iobase", FWCfgState, ctl_iobase, -1),
 549         DEFINE_PROP_HEX32("data_iobase", FWCfgState, data_iobase, -1),
 550         DEFINE_PROP_END_OF_LIST(),
 551     },
 552 };
 553
 554 static void fw_cfg_register_devices(void)
 555 {
 556     sysbus_register_withprop(&fw_cfg_info);
 557 }
 558
 559 device_init(fw_cfg_register_devices)