efi_loader: improve documentation of enum efi_test_phase

* Avoid a warning: "Incorrect use of kernel-doc format".
* Remove duplicate text.
* Clarify usage of EFI_SETTING_VIRTUAL_ADDRESS_MAP.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Heinrich Schuchardt 2021-03-28 10:41:00 +02:00
parent 02079eb38b
commit b411b62fb4

View file

@ -53,21 +53,25 @@
*/
enum efi_test_phase {
/**
* @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT: - execute before ExitBootServices
* @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT:
*
* Setup, execute, and teardown are executed before ExitBootServices().
*/
EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1,
/**
* @EFI_SETUP_BEFORE_BOOTTIME_EXIT: - setup before ExitBootServices
* @EFI_SETUP_BEFORE_BOOTTIME_EXIT:
*
* Setup is executed before ExitBootServices() while execute, and
* teardown are executed after ExitBootServices().
*/
EFI_SETUP_BEFORE_BOOTTIME_EXIT,
/**
* @EFI_SETTING_VIRTUAL_ADDRESS_MAP - calls SetVirtualAddressMap()
* Execute calls SetVirtualAddressMap().
* @EFI_SETTING_VIRTUAL_ADDRESS_MAP:
*
* Execute calls SetVirtualAddressMap(). Setup is executed before
* ExitBootServices() while execute is executed after
* ExitBootServices(), and after the execute of tests marked as
* @EFI_SETUP_BEFORE_BOOTTIME_EXIT. Teardown is executed thereafter.
*/
EFI_SETTING_VIRTUAL_ADDRESS_MAP,
};