efi_loader: describe returning of control
authorHeinrich Schuchardt <xypron.glpk@gmx.de>
Fri, 10 Jan 2020 21:06:54 +0000 (22:06 +0100)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Tue, 14 Jan 2020 23:51:51 +0000 (00:51 +0100)
Provide a sober description of how control can be returned by a UEFI
binary.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
lib/efi_loader/efi_boottime.c

index 3103a50158ad6bed852b7ed67aecdde7f4556302..1f598b357a5c97e4b0dfa134ad9b7190231008b7 100644 (file)
@@ -2933,10 +2933,10 @@ efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
        ret = EFI_CALL(image_obj->entry(image_handle, &systab));
 
        /*
-        * Usually UEFI applications call Exit() instead of returning.
-        * But because the world doesn't consist of ponies and unicorns,
-        * we're happy to emulate that behavior on behalf of a payload
-        * that forgot.
+        * Control is returned from a started UEFI image either by calling
+        * Exit() (where exit data can be provided) or by simply returning from
+        * the entry point. In the latter case call Exit() on behalf of the
+        * image.
         */
        return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
 }