xref: /qemu/hw/i386/pc_sysfw.c (revision 98a99ce0840991ed28fd4c570ae549c371e89970)
1cbc5b5f3SJordan Justen /*
2cbc5b5f3SJordan Justen  * QEMU PC System Firmware
3cbc5b5f3SJordan Justen  *
4cbc5b5f3SJordan Justen  * Copyright (c) 2003-2004 Fabrice Bellard
5cbc5b5f3SJordan Justen  * Copyright (c) 2011-2012 Intel Corporation
6cbc5b5f3SJordan Justen  *
7cbc5b5f3SJordan Justen  * Permission is hereby granted, free of charge, to any person obtaining a copy
8cbc5b5f3SJordan Justen  * of this software and associated documentation files (the "Software"), to deal
9cbc5b5f3SJordan Justen  * in the Software without restriction, including without limitation the rights
10cbc5b5f3SJordan Justen  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11cbc5b5f3SJordan Justen  * copies of the Software, and to permit persons to whom the Software is
12cbc5b5f3SJordan Justen  * furnished to do so, subject to the following conditions:
13cbc5b5f3SJordan Justen  *
14cbc5b5f3SJordan Justen  * The above copyright notice and this permission notice shall be included in
15cbc5b5f3SJordan Justen  * all copies or substantial portions of the Software.
16cbc5b5f3SJordan Justen  *
17cbc5b5f3SJordan Justen  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18cbc5b5f3SJordan Justen  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19cbc5b5f3SJordan Justen  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20cbc5b5f3SJordan Justen  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21cbc5b5f3SJordan Justen  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22cbc5b5f3SJordan Justen  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23cbc5b5f3SJordan Justen  * THE SOFTWARE.
24cbc5b5f3SJordan Justen  */
25cbc5b5f3SJordan Justen 
26b6a0aa05SPeter Maydell #include "qemu/osdep.h"
27da34e65cSMarkus Armbruster #include "qapi/error.h"
28fa1d36dfSMarkus Armbruster #include "sysemu/block-backend.h"
29b4a42f81SPaolo Bonzini #include "qemu/error-report.h"
3083c9f4caSPaolo Bonzini #include "hw/sysbus.h"
3183c9f4caSPaolo Bonzini #include "hw/hw.h"
320d09e41aSPaolo Bonzini #include "hw/i386/pc.h"
33bd183c79SJordan Justen #include "hw/boards.h"
3483c9f4caSPaolo Bonzini #include "hw/loader.h"
359c17d615SPaolo Bonzini #include "sysemu/sysemu.h"
360d09e41aSPaolo Bonzini #include "hw/block/flash.h"
379c17d615SPaolo Bonzini #include "sysemu/kvm.h"
38cbc5b5f3SJordan Justen 
39cbc5b5f3SJordan Justen #define BIOS_FILENAME "bios.bin"
40cbc5b5f3SJordan Justen 
4190ccf9f6SJordan Justen typedef struct PcSysFwDevice {
4290ccf9f6SJordan Justen     SysBusDevice busdev;
43dade922fSJordan Justen     uint8_t isapc_ram_fw;
4490ccf9f6SJordan Justen } PcSysFwDevice;
4590ccf9f6SJordan Justen 
46bd183c79SJordan Justen static void pc_isa_bios_init(MemoryRegion *rom_memory,
47bd183c79SJordan Justen                              MemoryRegion *flash_mem,
48bd183c79SJordan Justen                              int ram_size)
49bd183c79SJordan Justen {
50bd183c79SJordan Justen     int isa_bios_size;
51bd183c79SJordan Justen     MemoryRegion *isa_bios;
52bd183c79SJordan Justen     uint64_t flash_size;
53bd183c79SJordan Justen     void *flash_ptr, *isa_bios_ptr;
54bd183c79SJordan Justen 
55bd183c79SJordan Justen     flash_size = memory_region_size(flash_mem);
56bd183c79SJordan Justen 
57bd183c79SJordan Justen     /* map the last 128KB of the BIOS in ISA space */
587f87af39SMarkus Armbruster     isa_bios_size = MIN(flash_size, 128 * 1024);
59bd183c79SJordan Justen     isa_bios = g_malloc(sizeof(*isa_bios));
60*98a99ce0SPeter Maydell     memory_region_init_ram(isa_bios, NULL, "isa-bios", isa_bios_size,
61f8ed85acSMarkus Armbruster                            &error_fatal);
62bd183c79SJordan Justen     memory_region_add_subregion_overlap(rom_memory,
63bd183c79SJordan Justen                                         0x100000 - isa_bios_size,
64bd183c79SJordan Justen                                         isa_bios,
65bd183c79SJordan Justen                                         1);
66bd183c79SJordan Justen 
67bd183c79SJordan Justen     /* copy ISA rom image from top of flash memory */
68bd183c79SJordan Justen     flash_ptr = memory_region_get_ram_ptr(flash_mem);
69bd183c79SJordan Justen     isa_bios_ptr = memory_region_get_ram_ptr(isa_bios);
70bd183c79SJordan Justen     memcpy(isa_bios_ptr,
71bd183c79SJordan Justen            ((uint8_t*)flash_ptr) + (flash_size - isa_bios_size),
72bd183c79SJordan Justen            isa_bios_size);
73bd183c79SJordan Justen 
74bd183c79SJordan Justen     memory_region_set_readonly(isa_bios, true);
75bd183c79SJordan Justen }
76bd183c79SJordan Justen 
77637a5acbSLaszlo Ersek #define FLASH_MAP_UNIT_MAX 2
78637a5acbSLaszlo Ersek 
79637a5acbSLaszlo Ersek /* We don't have a theoretically justifiable exact lower bound on the base
80637a5acbSLaszlo Ersek  * address of any flash mapping. In practice, the IO-APIC MMIO range is
81637a5acbSLaszlo Ersek  * [0xFEE00000..0xFEE01000[ -- see IO_APIC_DEFAULT_ADDRESS --, leaving free
82637a5acbSLaszlo Ersek  * only 18MB-4KB below 4G. For now, restrict the cumulative mapping to 8MB in
83637a5acbSLaszlo Ersek  * size.
84637a5acbSLaszlo Ersek  */
85637a5acbSLaszlo Ersek #define FLASH_MAP_BASE_MIN ((hwaddr)(0x100000000ULL - 8*1024*1024))
86637a5acbSLaszlo Ersek 
87637a5acbSLaszlo Ersek /* This function maps flash drives from 4G downward, in order of their unit
88637a5acbSLaszlo Ersek  * numbers. The mapping starts at unit#0, with unit number increments of 1, and
89637a5acbSLaszlo Ersek  * stops before the first missing flash drive, or before
90637a5acbSLaszlo Ersek  * unit#FLASH_MAP_UNIT_MAX, whichever is reached first.
91637a5acbSLaszlo Ersek  *
92637a5acbSLaszlo Ersek  * Addressing within one flash drive is of course not reversed.
93637a5acbSLaszlo Ersek  *
94637a5acbSLaszlo Ersek  * An error message is printed and the process exits if:
95637a5acbSLaszlo Ersek  * - the size of the backing file for a flash drive is non-positive, or not a
96637a5acbSLaszlo Ersek  *   multiple of the required sector size, or
97637a5acbSLaszlo Ersek  * - the current mapping's base address would fall below FLASH_MAP_BASE_MIN.
98637a5acbSLaszlo Ersek  *
99637a5acbSLaszlo Ersek  * The drive with unit#0 (if available) is mapped at the highest address, and
100637a5acbSLaszlo Ersek  * it is passed to pc_isa_bios_init(). Merging several drives for isa-bios is
101637a5acbSLaszlo Ersek  * not supported.
102637a5acbSLaszlo Ersek  */
103637a5acbSLaszlo Ersek static void pc_system_flash_init(MemoryRegion *rom_memory)
104bd183c79SJordan Justen {
105637a5acbSLaszlo Ersek     int unit;
106637a5acbSLaszlo Ersek     DriveInfo *pflash_drv;
1074be74634SMarkus Armbruster     BlockBackend *blk;
108bd183c79SJordan Justen     int64_t size;
109637a5acbSLaszlo Ersek     char *fatal_errmsg = NULL;
110637a5acbSLaszlo Ersek     hwaddr phys_addr = 0x100000000ULL;
111bd183c79SJordan Justen     int sector_bits, sector_size;
112bd183c79SJordan Justen     pflash_t *system_flash;
113bd183c79SJordan Justen     MemoryRegion *flash_mem;
114637a5acbSLaszlo Ersek     char name[64];
115bd183c79SJordan Justen 
116bd183c79SJordan Justen     sector_bits = 12;
117bd183c79SJordan Justen     sector_size = 1 << sector_bits;
118bd183c79SJordan Justen 
119637a5acbSLaszlo Ersek     for (unit = 0;
120637a5acbSLaszlo Ersek          (unit < FLASH_MAP_UNIT_MAX &&
121637a5acbSLaszlo Ersek           (pflash_drv = drive_get(IF_PFLASH, 0, unit)) != NULL);
122637a5acbSLaszlo Ersek          ++unit) {
1234be74634SMarkus Armbruster         blk = blk_by_legacy_dinfo(pflash_drv);
1244be74634SMarkus Armbruster         size = blk_getlength(blk);
125637a5acbSLaszlo Ersek         if (size < 0) {
126637a5acbSLaszlo Ersek             fatal_errmsg = g_strdup_printf("failed to get backing file size");
127637a5acbSLaszlo Ersek         } else if (size == 0) {
128637a5acbSLaszlo Ersek             fatal_errmsg = g_strdup_printf("PC system firmware (pflash) "
129637a5acbSLaszlo Ersek                                "cannot have zero size");
130637a5acbSLaszlo Ersek         } else if ((size % sector_size) != 0) {
131637a5acbSLaszlo Ersek             fatal_errmsg = g_strdup_printf("PC system firmware (pflash) "
132637a5acbSLaszlo Ersek                                "must be a multiple of 0x%x", sector_size);
133637a5acbSLaszlo Ersek         } else if (phys_addr < size || phys_addr - size < FLASH_MAP_BASE_MIN) {
134637a5acbSLaszlo Ersek             fatal_errmsg = g_strdup_printf("oversized backing file, pflash "
135637a5acbSLaszlo Ersek                                "segments cannot be mapped under "
136637a5acbSLaszlo Ersek                                TARGET_FMT_plx, FLASH_MAP_BASE_MIN);
137637a5acbSLaszlo Ersek         }
138637a5acbSLaszlo Ersek         if (fatal_errmsg != NULL) {
139637a5acbSLaszlo Ersek             Location loc;
140637a5acbSLaszlo Ersek 
141637a5acbSLaszlo Ersek             /* push a new, "none" location on the location stack; overwrite its
142637a5acbSLaszlo Ersek              * contents with the location saved in the option; print the error
143637a5acbSLaszlo Ersek              * (includes location); pop the top
144637a5acbSLaszlo Ersek              */
145637a5acbSLaszlo Ersek             loc_push_none(&loc);
146637a5acbSLaszlo Ersek             if (pflash_drv->opts != NULL) {
147637a5acbSLaszlo Ersek                 qemu_opts_loc_restore(pflash_drv->opts);
148637a5acbSLaszlo Ersek             }
149637a5acbSLaszlo Ersek             error_report("%s", fatal_errmsg);
150637a5acbSLaszlo Ersek             loc_pop(&loc);
151637a5acbSLaszlo Ersek             g_free(fatal_errmsg);
152bd183c79SJordan Justen             exit(1);
153bd183c79SJordan Justen         }
154bd183c79SJordan Justen 
155637a5acbSLaszlo Ersek         phys_addr -= size;
156bd183c79SJordan Justen 
157637a5acbSLaszlo Ersek         /* pflash_cfi01_register() creates a deep copy of the name */
158637a5acbSLaszlo Ersek         snprintf(name, sizeof name, "system.flash%d", unit);
159637a5acbSLaszlo Ersek         system_flash = pflash_cfi01_register(phys_addr, NULL /* qdev */, name,
1604be74634SMarkus Armbruster                                              size, blk, sector_size,
161637a5acbSLaszlo Ersek                                              size >> sector_bits,
162637a5acbSLaszlo Ersek                                              1      /* width */,
163637a5acbSLaszlo Ersek                                              0x0000 /* id0 */,
164637a5acbSLaszlo Ersek                                              0x0000 /* id1 */,
165637a5acbSLaszlo Ersek                                              0x0000 /* id2 */,
166637a5acbSLaszlo Ersek                                              0x0000 /* id3 */,
167637a5acbSLaszlo Ersek                                              0      /* be */);
168637a5acbSLaszlo Ersek         if (unit == 0) {
169637a5acbSLaszlo Ersek             flash_mem = pflash_cfi01_get_memory(system_flash);
170bd183c79SJordan Justen             pc_isa_bios_init(rom_memory, flash_mem, size);
171bd183c79SJordan Justen         }
172637a5acbSLaszlo Ersek     }
173637a5acbSLaszlo Ersek }
174bd183c79SJordan Justen 
175dade922fSJordan Justen static void old_pc_system_rom_init(MemoryRegion *rom_memory, bool isapc_ram_fw)
176cbc5b5f3SJordan Justen {
177cbc5b5f3SJordan Justen     char *filename;
178cbc5b5f3SJordan Justen     MemoryRegion *bios, *isa_bios;
179cbc5b5f3SJordan Justen     int bios_size, isa_bios_size;
180cbc5b5f3SJordan Justen     int ret;
181cbc5b5f3SJordan Justen 
182cbc5b5f3SJordan Justen     /* BIOS load */
183cbc5b5f3SJordan Justen     if (bios_name == NULL) {
184cbc5b5f3SJordan Justen         bios_name = BIOS_FILENAME;
185cbc5b5f3SJordan Justen     }
186cbc5b5f3SJordan Justen     filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, bios_name);
187cbc5b5f3SJordan Justen     if (filename) {
188cbc5b5f3SJordan Justen         bios_size = get_image_size(filename);
189cbc5b5f3SJordan Justen     } else {
190cbc5b5f3SJordan Justen         bios_size = -1;
191cbc5b5f3SJordan Justen     }
192cbc5b5f3SJordan Justen     if (bios_size <= 0 ||
193cbc5b5f3SJordan Justen         (bios_size % 65536) != 0) {
194cbc5b5f3SJordan Justen         goto bios_error;
195cbc5b5f3SJordan Justen     }
196cbc5b5f3SJordan Justen     bios = g_malloc(sizeof(*bios));
197*98a99ce0SPeter Maydell     memory_region_init_ram(bios, NULL, "pc.bios", bios_size, &error_fatal);
198dade922fSJordan Justen     if (!isapc_ram_fw) {
199cbc5b5f3SJordan Justen         memory_region_set_readonly(bios, true);
200dade922fSJordan Justen     }
201cbc5b5f3SJordan Justen     ret = rom_add_file_fixed(bios_name, (uint32_t)(-bios_size), -1);
202cbc5b5f3SJordan Justen     if (ret != 0) {
203cbc5b5f3SJordan Justen     bios_error:
204cbc5b5f3SJordan Justen         fprintf(stderr, "qemu: could not load PC BIOS '%s'\n", bios_name);
205cbc5b5f3SJordan Justen         exit(1);
206cbc5b5f3SJordan Justen     }
207cbc5b5f3SJordan Justen     g_free(filename);
208cbc5b5f3SJordan Justen 
209cbc5b5f3SJordan Justen     /* map the last 128KB of the BIOS in ISA space */
210cbc5b5f3SJordan Justen     isa_bios_size = bios_size;
211cbc5b5f3SJordan Justen     if (isa_bios_size > (128 * 1024)) {
212cbc5b5f3SJordan Justen         isa_bios_size = 128 * 1024;
213cbc5b5f3SJordan Justen     }
214cbc5b5f3SJordan Justen     isa_bios = g_malloc(sizeof(*isa_bios));
2152c9b15caSPaolo Bonzini     memory_region_init_alias(isa_bios, NULL, "isa-bios", bios,
216cbc5b5f3SJordan Justen                              bios_size - isa_bios_size, isa_bios_size);
217cbc5b5f3SJordan Justen     memory_region_add_subregion_overlap(rom_memory,
218cbc5b5f3SJordan Justen                                         0x100000 - isa_bios_size,
219cbc5b5f3SJordan Justen                                         isa_bios,
220cbc5b5f3SJordan Justen                                         1);
221dade922fSJordan Justen     if (!isapc_ram_fw) {
222cbc5b5f3SJordan Justen         memory_region_set_readonly(isa_bios, true);
223dade922fSJordan Justen     }
224cbc5b5f3SJordan Justen 
225cbc5b5f3SJordan Justen     /* map all the bios at the top of memory */
226cbc5b5f3SJordan Justen     memory_region_add_subregion(rom_memory,
227cbc5b5f3SJordan Justen                                 (uint32_t)(-bios_size),
228cbc5b5f3SJordan Justen                                 bios);
229cbc5b5f3SJordan Justen }
230cbc5b5f3SJordan Justen 
2316dd2a5c9SPaolo Bonzini void pc_system_firmware_init(MemoryRegion *rom_memory, bool isapc_ram_fw)
232cbc5b5f3SJordan Justen {
233bd183c79SJordan Justen     DriveInfo *pflash_drv;
2341d38574fSAnthony Liguori 
235bd183c79SJordan Justen     pflash_drv = drive_get(IF_PFLASH, 0, 0);
236bd183c79SJordan Justen 
2376dd2a5c9SPaolo Bonzini     if (isapc_ram_fw || pflash_drv == NULL) {
238dafb82e0SJordan Justen         /* When a pflash drive is not found, use rom-mode */
2396dd2a5c9SPaolo Bonzini         old_pc_system_rom_init(rom_memory, isapc_ram_fw);
240a904410aSPaolo Bonzini         return;
241a904410aSPaolo Bonzini     }
242a904410aSPaolo Bonzini 
243a904410aSPaolo Bonzini     if (kvm_enabled() && !kvm_readonly_mem_enabled()) {
244dafb82e0SJordan Justen         /* Older KVM cannot execute from device memory. So, flash memory
245dafb82e0SJordan Justen          * cannot be used unless the readonly memory kvm capability is present. */
246dafb82e0SJordan Justen         fprintf(stderr, "qemu: pflash with kvm requires KVM readonly memory support\n");
247dafb82e0SJordan Justen         exit(1);
248dafb82e0SJordan Justen     }
249dafb82e0SJordan Justen 
250637a5acbSLaszlo Ersek     pc_system_flash_init(rom_memory);
251cbc5b5f3SJordan Justen }
252