efi_loader: describe term_get_char()

Add a function description.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>

diff --git a/lib/efi_loader/efi_console.c b/lib/efi_loader/efi_console.c
index 43176309077caa78d6158f463a4a98f29f4f146f..a2d137d7a9e15408facd6bdfdd8061df1e5118e8 100644 (file)
--- a/lib/efi_loader/efi_console.c
+++ b/lib/efi_loader/efi_console.c
@@ -77,6 +77,14 @@ static struct simple_text_output_mode efi_con_mode = {
        .cursor_visible = 1,
 };
 
+/**
+ * term_get_char() - read a character from the console
+ *
+ * Wait for up to 100 ms to read a character from the console.
+ *
+ * @c:         pointer to the buffer to receive the character
+ * Return:     0 on success, 1 otherwise
+ */
 static int term_get_char(s32 *c)
 {
        u64 timeout;