Clean up Boot Manager module in BdsDxe.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5447 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qwang12 2008-07-10 11:38:22 +00:00
parent 744fc75819
commit 2fbae53e51
2 changed files with 34 additions and 27 deletions

View File

@ -31,7 +31,9 @@ BOOT_MANAGER_CALLBACK_DATA gBootManagerPrivate = {
}; };
/** /**
This function processes the results of changes in configuration. This call back funtion is registered with Boot Manager formset.
When user selects a boot option, this call back function will
be triggered. The boot option is saved for later processing.
@param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
@ -43,9 +45,7 @@ BOOT_MANAGER_CALLBACK_DATA gBootManagerPrivate = {
@param ActionRequest On return, points to the action requested by the callback function. @param ActionRequest On return, points to the action requested by the callback function.
@retval EFI_SUCCESS The callback successfully handled the action. @retval EFI_SUCCESS The callback successfully handled the action.
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data. @retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.
@retval EFI_DEVICE_ERROR The variable could not be saved.
@retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
**/ **/
EFI_STATUS EFI_STATUS
@ -101,11 +101,10 @@ BootManagerCallback (
/** /**
Initialize HII information for the FrontPage Registers HII packages for the Boot Manger to HII Database.
It also registers the browser call back function.
@param VOID EDES_TODO: Add parameter description
@return EDES_TODO: Add description for return value @return EDES_TODO: Add description for return value
**/ **/
@ -154,8 +153,11 @@ InitializeBootManager (
} }
/** /**
Invoke Boot Manager. Hook to enable UI timeout override behavior. This funtion invokees Boot Manager. If all devices have not a chance to be connected,
the connect all will be triggered. It then enumerate all boot options. If
a boot option from the Boot Manager page is selected, Boot Manager will boot
from this boot option.
**/ **/
VOID VOID
CallBootManager ( CallBootManager (

View File

@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/
#ifndef _EFI_BOOT_MANAGER_H #ifndef _EFI_BOOT_MANAGER_H_
#define _EFI_BOOT_MANAGER_H #define _EFI_BOOT_MANAGER_H_
#include "Bds.h" #include "Bds.h"
#include "FrontPage.h" #include "FrontPage.h"
@ -53,16 +53,21 @@ typedef struct {
} BOOT_MANAGER_CALLBACK_DATA; } BOOT_MANAGER_CALLBACK_DATA;
/** /**
EDES_TODO: Add function description. This call back funtion is registered with Boot Manager formset.
When user selects a boot option, this call back function will
be triggered. The boot option is saved for later processing.
@param This EDES_TODO: Add parameter description
@param Action EDES_TODO: Add parameter description
@param QuestionId EDES_TODO: Add parameter description
@param Type EDES_TODO: Add parameter description
@param Value EDES_TODO: Add parameter description
@param ActionRequest EDES_TODO: Add parameter description
@return EDES_TODO: Add description for return value @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
@param Action Specifies the type of action taken by the browser.
@param QuestionId A unique value which is sent to the original exporting driver
so that it can identify the type of data to expect.
@param Type The type of value for the question.
@param Value A pointer to the data being sent to the original exporting driver.
@param ActionRequest On return, points to the action requested by the callback function.
@retval EFI_SUCCESS The callback successfully handled the action.
@retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.
**/ **/
EFI_STATUS EFI_STATUS
@ -78,9 +83,10 @@ BootManagerCallback (
; ;
/** /**
EDES_TODO: Add function description.
@param VOID EDES_TODO: Add parameter description Registers HII packages for the Boot Manger to HII Database.
It also registers the browser call back function.
@return EDES_TODO: Add description for return value @return EDES_TODO: Add description for return value
@ -92,12 +98,11 @@ InitializeBootManager (
; ;
/** /**
EDES_TODO: Add function description. This funtion invokees Boot Manager. If all devices have not a chance to be connected,
the connect all will be triggered. It then enumerate all boot options. If
@param VOID EDES_TODO: Add parameter description a boot option from the Boot Manager page is selected, Boot Manager will boot
from this boot option.
@return EDES_TODO: Add description for return value
**/ **/
VOID VOID
CallBootManager ( CallBootManager (