tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Synchronize GenericBdsLib library class's header file to library instance. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6925 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-12-09 05:14:54 +00:00
parent 9319d2c206
commit 262b066848
4 changed files with 37 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
View File

@ -72,17 +72,17 @@ BdsLibDoLegacyBoot (
/** /**
Process the boot option follow the EFI 1.1 specification and Process the boot option follow the UEFI specification and
special treat the legacy boot option with BBS_DEVICE_PATH. special treat the legacy boot option with BBS_DEVICE_PATH.
@param Option The boot option need to be processed @param Option The boot option need to be processed
@param DevicePath The device path which describe where to load the @param DevicePath The device path which describe where to load the
boot image or the legcy BBS device path to boot boot image or the legcy BBS device path to boot
the legacy OS the legacy OS
@param ExitDataSize Returned directly from gBS->StartImage () @param ExitDataSize The size of exit data.
@param ExitData Returned directly from gBS->StartImage () @param ExitData Data returned when Boot image failed.
@retval EFI_SUCCESS Status from gBS->StartImage () @retval EFI_SUCCESS Boot from the input boot option successfully.
@retval EFI_NOT_FOUND If the Device Path is not found in the system @retval EFI_NOT_FOUND If the Device Path is not found in the system
**/ **/
@ -510,8 +510,8 @@ BdsExpandPartitionPartialDevicePathToFull (
@param HardDriveDevicePath A device path which starts with a hard drive media @param HardDriveDevicePath A device path which starts with a hard drive media
device path. device path.
@retval TRUE There is a matched device path instance FALSE @retval TRUE There is a matched device path instance.
@retval FALSE There is no matched device path instance @retval FALSE There is no matched device path instance.
**/ **/
BOOLEAN BOOLEAN
@ -1114,13 +1114,13 @@ BdsLibEnumerateAllBootOption (
} }
/** /**
Build the boot option with the handle parsed in. Build the boot option with the handle parsed in
@param Handle The handle which present the device path to create @param Handle The handle which present the device path to create
boot option boot option
@param BdsBootOptionList The header of the link list which indexed all @param BdsBootOptionList The header of the link list which indexed all
current boot options current boot options
@param String Boot option name. @param String The description of the boot option.
**/ **/
VOID VOID
@ -1178,7 +1178,7 @@ BdsLibBuildOptionFromShell (
} }
/** /**
Boot from the EFI1.1 spec defined "BootNext" variable Boot from the UEFI spec defined "BootNext" variable.
**/ **/
VOID VOID
@ -1238,7 +1238,6 @@ BdsLibBootNext (
@param DevicePath Device Path to a bootable device @param DevicePath Device Path to a bootable device
@retval NULL The device path points to an EFI bootable Media
@retval NULL The media on the DevicePath is not bootable @retval NULL The media on the DevicePath is not bootable
**/ **/
@ -1558,11 +1557,11 @@ BdsGetBootTypeFromDevicePath (
Check whether the Device path in a boot option point to a valide bootable device, Check whether the Device path in a boot option point to a valide bootable device,
And if CheckMedia is true, check the device is ready to boot now. And if CheckMedia is true, check the device is ready to boot now.
@param DevPath the Device path in a boot option @param DevPath the Device path in a boot option
@param CheckMedia if true, check the device is ready to boot now. @param CheckMedia if true, check the device is ready to boot now.
@retval TRUE the Device path is valide @retval TRUE the Device path is valide
@retval FALSE the Device path is invalide . @retval FALSE the Device path is invalide .
**/ **/
BOOLEAN BOOLEAN
@ -1729,7 +1728,7 @@ EFI_STATUS
EFIAPI EFIAPI
BdsLibUpdateFvFileDevicePath ( BdsLibUpdateFvFileDevicePath (
IN OUT EFI_DEVICE_PATH_PROTOCOL ** DevicePath, IN OUT EFI_DEVICE_PATH_PROTOCOL ** DevicePath,
IN EFI_GUID *FileGuid IN EFI_GUID *FileGuid
) )
{ {
EFI_DEVICE_PATH_PROTOCOL *TempDevicePath; EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;

22
MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
View File

@ -60,7 +60,7 @@ IsNvNeed (
from the console variable ConVarName, this from the console variable ConVarName, this
parameter can not be multi-instance. parameter can not be multi-instance.
@retval EFI_UNSUPPORTED Add or remove the same device path. @retval EFI_UNSUPPORTED The added device path is same to the removed one.
@retval EFI_SUCCESS Success add or remove the device path from the @retval EFI_SUCCESS Success add or remove the device path from the
console variable. console variable.
@ -184,7 +184,6 @@ BdsLibUpdateConsoleVariable (
@param ConVarName Console related variable name, ConIn, ConOut, @param ConVarName Console related variable name, ConIn, ConOut,
ErrOut. ErrOut.
@retval EFI_UNSUPPORTED Request console variable does not exist.
@retval EFI_NOT_FOUND There is not any console devices connected @retval EFI_NOT_FOUND There is not any console devices connected
success success
@retval EFI_SUCCESS Success connect any one instance of the console @retval EFI_SUCCESS Success connect any one instance of the console
@ -359,8 +358,7 @@ BdsLibConnectAllConsoles (
@retval EFI_SUCCESS At least one of the ConIn and ConOut device have @retval EFI_SUCCESS At least one of the ConIn and ConOut device have
been connected success. been connected success.
@retval EFI_STATUS Return the status of @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().
BdsLibConnectConsoleVariable ().
**/ **/
EFI_STATUS EFI_STATUS
@ -597,7 +595,7 @@ ConvertBmpToGopBlt (
@param Password Password used to lock ConIn device. @param Password Password used to lock ConIn device.
@retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully. @retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.
@retval EFI_UNSUPPORTED Password not found. @retval EFI_UNSUPPORTED Password not found
**/ **/
EFI_STATUS EFI_STATUS
@ -621,21 +619,18 @@ LockKeyboards (
/** /**
Use Console Control to turn off UGA based Simple Text Out consoles from going Use Console Control to turn off UGA based Simple Text Out consoles from going
to the UGA device. Put up LogoFile on every UGA device that is a console. to the UGA device. Put up LogoFile on every UGA device that is a console
@param LogoFile File name of logo to display on the center of the screen. @param[in] LogoFile File name of logo to display on the center of the screen.
@retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed. @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
@retval EFI_UNSUPPORTED Logo not found. @retval EFI_UNSUPPORTED Logo not found
Fail to locate ConsoleControl protocol.
Fail to get UgaDraw or Gop handle.
Fail to switch grahic mode.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
EnableQuietBoot ( EnableQuietBoot (
IN EFI_GUID *LogoFile OPTIONAL IN EFI_GUID *LogoFile
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
@ -877,8 +872,7 @@ EnableQuietBoot (
Use Console Control to turn on UGA based Simple Text Out consoles. The UGA Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
Simple Text Out screens will now be synced up with all non UGA output devices Simple Text Out screens will now be synced up with all non UGA output devices
@retval EFI_SUCCESS UGA devices are back in text mode and synced up. @retval EFI_SUCCESS UGA devices are back in text mode and synced up.
@retval EFI_UNSUPPORTED Fail to locate ConsoleControl Protocol.
**/ **/
EFI_STATUS EFI_STATUS

16
MdeModulePkg/Library/GenericBdsLib/BdsMisc.c
View File

@ -631,8 +631,8 @@ BdsLibGetBootMode (
@param VendorGuid GUID part of EFI variable name @param VendorGuid GUID part of EFI variable name
@param VariableSize Returns the size of the EFI variable that was read @param VariableSize Returns the size of the EFI variable that was read
@return Dynamically allocated memory that contains a copy of the EFI variable. @return Dynamically allocated memory that contains a copy of the EFI variable
@return Caller is responsible freeing the buffer. Caller is responsible freeing the buffer.
@retval NULL Variable was not read @retval NULL Variable was not read
**/ **/
@ -745,8 +745,8 @@ BdsLibDelPartMatchInstance (
@param Single A pointer to a single-instance device path data @param Single A pointer to a single-instance device path data
structure. structure.
@retval TRUE If the Single is contained within Multi @retval TRUE If the Single device path is contained within Multi device path.
@retval FALSE The Single is not match within Multi @retval FALSE The Single device path is not match within Multi device path.
**/ **/
BOOLEAN BOOLEAN
@ -976,12 +976,12 @@ SetupResetReminder (
} }
/** /**
Get the headers (dos, image, optional header) from an image. Get the headers (dos, image, optional header) from an image
@param Device SimpleFileSystem device handle @param Device SimpleFileSystem device handle
@param FileName File name for the image @param FileName File name for the image
@param DosHeader Pointer to dos header @param DosHeader Pointer to dos header
@param Hdr Pointer to optional header @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
@retval EFI_SUCCESS Successfully get the machine type. @retval EFI_SUCCESS Successfully get the machine type.
@retval EFI_NOT_FOUND The file is not found. @retval EFI_NOT_FOUND The file is not found.
@ -1229,8 +1229,8 @@ BdsSetMemoryTypeInformationVariable (
} }
/** /**
This routine register a function to adjust the different type memory page number just before booting This routine register a function to adjust the different type memory page number
and save the updated info into the variable for next boot to use. just before booting and save the updated info into the variable for next boot to use.
**/ **/
VOID VOID

19
MdeModulePkg/Library/GenericBdsLib/DevicePath.c
View File

@ -19,15 +19,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Concatenates a formatted unicode string to allocated pool. Concatenates a formatted unicode string to allocated pool.
The caller must free the resulting buffer. The caller must free the resulting buffer.
@param Str Tracks the allocated pool, size in use, and amount of pool @param Str Tracks the allocated pool, size in use, and amount of pool allocated.
allocated.
@param fmt The format string @param fmt The format string
@param ... The data will be printed.
@param ... Variable argument list.
@return Allocated buffer with the formatted string printed in it. @return Allocated buffer with the formatted string printed in it.
The caller must free the allocated buffer. The buffer The caller must free the allocated buffer.
allocation is not packed. The buffer allocation is not packed.
**/ **/
CHAR16 * CHAR16 *
@ -172,13 +170,10 @@ DevPathController (
/** /**
Convert Device Path to a Unicode string for printing. Convert Vendor device path to device name.
@param Str The buffer holding the output string. @param Str The buffer store device name
This buffer contains the length of the @param DevPath Pointer to vendor device path
string and the maixmum length reserved
for the string buffer.
@param DevPath The device path.
**/ **/
VOID VOID