qemu_firmware: Document qemuFirmwareGetSupported

This function is going to get some new arguments. Document the
current ones for clarity.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Cole Robinson <crobinso@redhat.com>

diff --git a/src/qemu/qemu_firmware.c b/src/qemu/qemu_firmware.c
index 983a7c83b2564174edf4d940d00f6d79142283b8..1676a9c3d03ca2f616c9c1f99622edd181db5c50 100644 (file)
--- 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,