docs/interop/firmware.json

14 # = Firmware
25 # Lists the firmware-OS interface types provided by various firmware
28 # @bios: Traditional x86 BIOS interface. For example, firmware built
32 #                1275-1994 standard. Examples for firmware projects that
35 # @uboot: Firmware interface defined by the U-Boot project.
37 # @uefi: Firmware interface defined by the UEFI specification. For
38 #        example, firmware built from the edk2 (EFI Development Kit II)
49 # Defines the device types that firmware can be mapped into.
51 # @flash: The firmware executable and its accompanying NVRAM file are to
54 # @kernel: The firmware is to be loaded like a Linux kernel. This is
58 # @memory: The firmware is to be mapped into memory.
69 # firmware files.
89 # Defines the machine types that firmware may execute on.
92 #                emulator) that can execute the firmware.
96 #            firmware. Elements of @machines are supposed to be concrete
113 # Defines the features that firmware may support, and the platform
114 # requirements that firmware may present.
116 # @acpi-s3: The firmware supports S3 sleep (suspend to RAM), as defined
125 # @acpi-s4: The firmware supports S4 hibernation (suspend to disk), as
135 # @amd-sev: The firmware supports running under AMD Secure Encrypted
141 # @amd-sev-es: The firmware supports running under AMD Secure Encrypted
147 # @amd-sev-snp: The firmware supports running under AMD Secure Encrypted
153 # @intel-tdx: The firmware supports running under Intel Trust Domain
157 #                 the firmware binary has the UEFI Secure Boot
161 # @requires-smm: The firmware requires the platform to emulate SMM
170 #                is "-cpu coreduo,nx=off".) If the firmware is marked as
179 #                present high SMRAM requirements from the firmware. On
190 # @secure-boot: The firmware implements the software interfaces for UEFI
196 # @verbose-dynamic: When firmware log capture is enabled, the firmware
201 #                   @i386 and @x86_64 emulation targets, firmware log
208 # @verbose-static: The firmware unconditionally produces a large amount
211 #                  firmware for the "virt-*" machine types of the @arm
229 # Formats that are supported for firmware images.
243 # Defines common properties that are necessary for loading a firmware
250 #            firmware file can be found.
265 # Describes how the firmware build handles code versus variable
293 # Describes loading and mapping properties for the firmware executable
296 # @mode: Describes how the firmware build handles code versus variable
300 # @executable: Identifies the firmware executable. The @mode
341 # Describes loading and mapping properties for the firmware executable,
344 # @filename: Identifies the firmware executable. The firmware executable
357 # Describes loading and mapping properties for the firmware executable,
360 # @filename: Identifies the firmware executable. The firmware executable
373 # Provides a discriminated structure for firmware to describe its
376 # @device: Selects the device type that the firmware must be mapped
389 # @Firmware:
391 # Describes a firmware (or a firmware use case) to management software.
393 # It is possible for multiple @Firmware elements to match the search
398 # It is recommended to create firmware JSON files (each containing a
399 # single @Firmware root element) with a double-digit prefix, for example
401 # predictable order. The firmware JSON files should be searched for in
404 #   - /usr/share/qemu/firmware -- populated by distro-provided firmware
408 #   - /etc/qemu/firmware -- exclusively for sysadmins' local additions,
410 #   - $XDG_CONFIG_HOME/qemu/firmware -- exclusively for per-user local
426 #   - /usr/share/qemu/firmware/50-ovmf.json
428 #   - /usr/share/qemu/firmware/50-seabios-256k.json
432 #   $ touch /etc/qemu/firmware/50-ovmf.json
436 #   $ vim /etc/qemu/firmware/50-ovmf.json
440 #   $ vim /etc/qemu/firmware/10-ovmf.json
444 #   $ vim /etc/qemu/firmware/99-ovmf.json
446 # @description: Provides a human-readable description of the firmware.
449 # @interface-types: Lists the types of interfaces that the firmware can
452 #                   are considered more native to the firmware, and/or
454 #                   firmware, than entries near the end of
457 # @mapping: Describes the loading / mapping properties of the firmware.
460 #           and their machine types that may execute the firmware.
462 # @features: Lists the features that the firmware supports, and the
465 # @tags: A list of auxiliary strings associated with the firmware for
638 #         "description": "UEFI firmware for ARM64 virtual machines",
673 { 'struct' : 'Firmware',