xref: /openbmc/qemu/hw/i386/pc_sysfw.c (revision c81219a7)
1 /*
2  * QEMU PC System Firmware
3  *
4  * Copyright (c) 2003-2004 Fabrice Bellard
5  * Copyright (c) 2011-2012 Intel Corporation
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy
8  * of this software and associated documentation files (the "Software"), to deal
9  * in the Software without restriction, including without limitation the rights
10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11  * copies of the Software, and to permit persons to whom the Software is
12  * furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in
15  * all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23  * THE SOFTWARE.
24  */
25 
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "qapi/error.h"
29 #include "sysemu/block-backend.h"
30 #include "qemu/error-report.h"
31 #include "qemu/option.h"
32 #include "qemu/units.h"
33 #include "hw/sysbus.h"
34 #include "hw/i386/x86.h"
35 #include "hw/i386/pc.h"
36 #include "hw/loader.h"
37 #include "hw/qdev-properties.h"
38 #include "sysemu/sysemu.h"
39 #include "hw/block/flash.h"
40 #include "sysemu/kvm.h"
41 #include "sysemu/sev.h"
42 
43 #define FLASH_SECTOR_SIZE 4096
44 
45 static void pc_isa_bios_init(MemoryRegion *rom_memory,
46                              MemoryRegion *flash_mem,
47                              int ram_size)
48 {
49     int isa_bios_size;
50     MemoryRegion *isa_bios;
51     uint64_t flash_size;
52     void *flash_ptr, *isa_bios_ptr;
53 
54     flash_size = memory_region_size(flash_mem);
55 
56     /* map the last 128KB of the BIOS in ISA space */
57     isa_bios_size = MIN(flash_size, 128 * KiB);
58     isa_bios = g_malloc(sizeof(*isa_bios));
59     memory_region_init_ram(isa_bios, NULL, "isa-bios", isa_bios_size,
60                            &error_fatal);
61     memory_region_add_subregion_overlap(rom_memory,
62                                         0x100000 - isa_bios_size,
63                                         isa_bios,
64                                         1);
65 
66     /* copy ISA rom image from top of flash memory */
67     flash_ptr = memory_region_get_ram_ptr(flash_mem);
68     isa_bios_ptr = memory_region_get_ram_ptr(isa_bios);
69     memcpy(isa_bios_ptr,
70            ((uint8_t*)flash_ptr) + (flash_size - isa_bios_size),
71            isa_bios_size);
72 
73     memory_region_set_readonly(isa_bios, true);
74 }
75 
76 static PFlashCFI01 *pc_pflash_create(PCMachineState *pcms,
77                                      const char *name,
78                                      const char *alias_prop_name)
79 {
80     DeviceState *dev = qdev_new(TYPE_PFLASH_CFI01);
81 
82     qdev_prop_set_uint64(dev, "sector-length", FLASH_SECTOR_SIZE);
83     qdev_prop_set_uint8(dev, "width", 1);
84     qdev_prop_set_string(dev, "name", name);
85     object_property_add_child(OBJECT(pcms), name, OBJECT(dev));
86     object_property_add_alias(OBJECT(pcms), alias_prop_name,
87                               OBJECT(dev), "drive");
88     /*
89      * The returned reference is tied to the child property and
90      * will be removed with object_unparent.
91      */
92     object_unref(OBJECT(dev));
93     return PFLASH_CFI01(dev);
94 }
95 
96 void pc_system_flash_create(PCMachineState *pcms)
97 {
98     PCMachineClass *pcmc = PC_MACHINE_GET_CLASS(pcms);
99 
100     if (pcmc->pci_enabled) {
101         pcms->flash[0] = pc_pflash_create(pcms, "system.flash0",
102                                           "pflash0");
103         pcms->flash[1] = pc_pflash_create(pcms, "system.flash1",
104                                           "pflash1");
105     }
106 }
107 
108 void pc_system_flash_cleanup_unused(PCMachineState *pcms)
109 {
110     char *prop_name;
111     int i;
112     Object *dev_obj;
113 
114     assert(PC_MACHINE_GET_CLASS(pcms)->pci_enabled);
115 
116     for (i = 0; i < ARRAY_SIZE(pcms->flash); i++) {
117         dev_obj = OBJECT(pcms->flash[i]);
118         if (!object_property_get_bool(dev_obj, "realized", &error_abort)) {
119             prop_name = g_strdup_printf("pflash%d", i);
120             object_property_del(OBJECT(pcms), prop_name);
121             g_free(prop_name);
122             object_unparent(dev_obj);
123             pcms->flash[i] = NULL;
124         }
125     }
126 }
127 
128 /*
129  * Map the pcms->flash[] from 4GiB downward, and realize.
130  * Map them in descending order, i.e. pcms->flash[0] at the top,
131  * without gaps.
132  * Stop at the first pcms->flash[0] lacking a block backend.
133  * Set each flash's size from its block backend.  Fatal error if the
134  * size isn't a non-zero multiple of 4KiB, or the total size exceeds
135  * pcms->max_fw_size.
136  *
137  * If pcms->flash[0] has a block backend, its memory is passed to
138  * pc_isa_bios_init().  Merging several flash devices for isa-bios is
139  * not supported.
140  */
141 static void pc_system_flash_map(PCMachineState *pcms,
142                                 MemoryRegion *rom_memory)
143 {
144     hwaddr total_size = 0;
145     int i;
146     BlockBackend *blk;
147     int64_t size;
148     PFlashCFI01 *system_flash;
149     MemoryRegion *flash_mem;
150     void *flash_ptr;
151     int flash_size;
152 
153     assert(PC_MACHINE_GET_CLASS(pcms)->pci_enabled);
154 
155     for (i = 0; i < ARRAY_SIZE(pcms->flash); i++) {
156         system_flash = pcms->flash[i];
157         blk = pflash_cfi01_get_blk(system_flash);
158         if (!blk) {
159             break;
160         }
161         size = blk_getlength(blk);
162         if (size < 0) {
163             error_report("can't get size of block device %s: %s",
164                          blk_name(blk), strerror(-size));
165             exit(1);
166         }
167         if (size == 0 || !QEMU_IS_ALIGNED(size, FLASH_SECTOR_SIZE)) {
168             error_report("system firmware block device %s has invalid size "
169                          "%" PRId64,
170                          blk_name(blk), size);
171             info_report("its size must be a non-zero multiple of 0x%x",
172                         FLASH_SECTOR_SIZE);
173             exit(1);
174         }
175         if ((hwaddr)size != size
176             || total_size > HWADDR_MAX - size
177             || total_size + size > pcms->max_fw_size) {
178             error_report("combined size of system firmware exceeds "
179                          "%" PRIu64 " bytes",
180                          pcms->max_fw_size);
181             exit(1);
182         }
183 
184         total_size += size;
185         qdev_prop_set_uint32(DEVICE(system_flash), "num-blocks",
186                              size / FLASH_SECTOR_SIZE);
187         sysbus_realize_and_unref(SYS_BUS_DEVICE(system_flash), &error_fatal);
188         sysbus_mmio_map(SYS_BUS_DEVICE(system_flash), 0,
189                         0x100000000ULL - total_size);
190 
191         if (i == 0) {
192             flash_mem = pflash_cfi01_get_memory(system_flash);
193             pc_isa_bios_init(rom_memory, flash_mem, size);
194 
195             /* Encrypt the pflash boot ROM, if necessary */
196             flash_ptr = memory_region_get_ram_ptr(flash_mem);
197             flash_size = memory_region_size(flash_mem);
198             sev_encrypt_flash(flash_ptr, flash_size, &error_fatal);
199         }
200     }
201 }
202 
203 void pc_system_firmware_init(PCMachineState *pcms,
204                              MemoryRegion *rom_memory)
205 {
206     PCMachineClass *pcmc = PC_MACHINE_GET_CLASS(pcms);
207     int i;
208     BlockBackend *pflash_blk[ARRAY_SIZE(pcms->flash)];
209 
210     if (!pcmc->pci_enabled) {
211         x86_bios_rom_init(MACHINE(pcms), "bios.bin", rom_memory, true);
212         return;
213     }
214 
215     /* Map legacy -drive if=pflash to machine properties */
216     for (i = 0; i < ARRAY_SIZE(pcms->flash); i++) {
217         pflash_cfi01_legacy_drive(pcms->flash[i],
218                                   drive_get(IF_PFLASH, 0, i));
219         pflash_blk[i] = pflash_cfi01_get_blk(pcms->flash[i]);
220     }
221 
222     /* Reject gaps */
223     for (i = 1; i < ARRAY_SIZE(pcms->flash); i++) {
224         if (pflash_blk[i] && !pflash_blk[i - 1]) {
225             error_report("pflash%d requires pflash%d", i, i - 1);
226             exit(1);
227         }
228     }
229 
230     if (!pflash_blk[0]) {
231         /* Machine property pflash0 not set, use ROM mode */
232         x86_bios_rom_init(MACHINE(pcms), "bios.bin", rom_memory, false);
233     } else {
234         if (kvm_enabled() && !kvm_readonly_mem_enabled()) {
235             /*
236              * Older KVM cannot execute from device memory. So, flash
237              * memory cannot be used unless the readonly memory kvm
238              * capability is present.
239              */
240             error_report("pflash with kvm requires KVM readonly memory support");
241             exit(1);
242         }
243 
244         pc_system_flash_map(pcms, rom_memory);
245     }
246 
247     pc_system_flash_cleanup_unused(pcms);
248 }
249