From: Michal Privoznik Date: Mon, 5 Aug 2019 10:02:50 +0000 (+0200) Subject: qemu_firmware: Document qemuFirmwareGetSupported X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=bc7fe2f56ddd0a50b1e40086c586f3a395b65099;p=libvirt.git qemu_firmware: Document qemuFirmwareGetSupported This function is going to get some new arguments. Document the current ones for clarity. Signed-off-by: Michal Privoznik Reviewed-by: Cole Robinson --- diff --git a/src/qemu/qemu_firmware.c b/src/qemu/qemu_firmware.c index 983a7c83b2..1676a9c3d0 100644 --- a/src/qemu/qemu_firmware.c +++ b/src/qemu/qemu_firmware.c @@ -1413,6 +1413,25 @@ qemuFirmwareFillDomain(virQEMUDriverPtr driver, } +/** + * qemuFirmwareGetSupported: + * @machine: machine type + * @arch: architecture + * @privileged: whether running as privileged user + * @supported: returned bitmap of supported interfaces + * @secure: true if at least one secure boot enabled FW was found + * + * Parse all FW descriptors (depending whether running as @privileged this may + * or may not include user's $HOME) and for given combination of @machine and + * @arch extract information to be later reported in domain capabilities. + * The @supported contains a bitmap of found interfaces (and ORed values of 1 + * << VIR_DOMAIN_OS_DEF_FIRMWARE_*). Then, @supported is true if at least one + * FW descriptor signalizes secure boot (although, this is checked against SMM + * rather than SECURE_BOOT because reasons). + * + * Returns: 0 on success, + * -1 otherwise. + */ int qemuFirmwareGetSupported(const char *machine, virArch arch,