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

Committing changes to the comments, after review with engineers. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8950 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
pkandel 2009-07-15 13:32:34 +00:00
parent e0e51f622a
commit d0bd68b21f
6 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
View File

@ -109,8 +109,7 @@ BdsLibBootNext (
); );
/** /**
Process the boot option follow the UEFI specification and Process the boot option according to the UEFI specification. The legacy boot option device path includes BBS_DEVICE_PATH.
special treat the legacy boot option with BBS_DEVICE_PATH.
@param Option The boot option to be processed @param Option The boot option to be processed
@param DevicePath The device path describing where to load the @param DevicePath The device path describing where to load the
@ -255,7 +254,8 @@ BdsLibLoadDrivers (
/** /**
Process BootOrder, or DriverOrder variables, by calling This function processes BootOrder or DriverOrder variables, by calling
BdsLibVariableToOption () for each UINT16 in the variables. BdsLibVariableToOption () for each UINT16 in the variables.
@param BdsCommonOptionList The header of the option list base on variable @param BdsCommonOptionList The header of the option list base on variable
@ -384,7 +384,7 @@ BdsLibConnectAll (
); );
/** /**
This function creates all handles associated with every device This function creates all handles associated with the given device
path node. If the handle associated with one device path node can not path node. If the handle associated with one device path node can not
be created, then it tries to execute the dispatch to load the missing drivers. be created, then it tries to execute the dispatch to load the missing drivers.
@ -430,7 +430,7 @@ BdsLibDisconnectAllEfi (
// //
/** /**
This function will search every simpletxt device in the current system, This function will search every simpletxt device in the current system,
and make every simpletxt device as pertantial console device. and make every simpletxt device a potential console device.
**/ **/
VOID VOID
@ -671,7 +671,7 @@ BdsUpdateLegacyDevOrder (
); );
/** /**
Set the boot priority for BBS entries based on boot option entry and boot order. Refresh the boot priority for BBS entries based on boot option entry and boot order.
@param Entry The boot option is to be checked for refresh BBS table. @param Entry The boot option is to be checked for refresh BBS table.
@ -686,7 +686,7 @@ BdsRefreshBbsTableForBoot (
); );
/** /**
Deletete the Boot Option from EFI Variable. The Boot Order Arrray Delete the Boot Option from EFI Variable. The Boot Order Arrray
is also updated. is also updated.
@param OptionNumber The number of Boot option want to be deleted. @param OptionNumber The number of Boot option want to be deleted.
@ -849,11 +849,11 @@ MatchPartitionDevicePathNode (
/** /**
Expand a device path that starts with a hard drive media device path node to be a Expand a device path that starts with a hard drive media device path node to be a
full device path that includes the full hardware path to the device. We need full device path that includes the full hardware path to the device. This function enables the device to boot.
to do this so it can be booted. As an optimizaiton the front match (the part point To avoid requiring a connect on every boot, the front match is saved in a variable (the part point
to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ).
so a connect all is not required on every boot. All successful history device path All successful history device paths
which point to partition node (the front part) will be saved. that point to the front part of the partition node will be saved.
@param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
drive media device path. drive media device path.

5
IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
View File

@ -33,14 +33,13 @@ OemHookStatusCodeInitialize (
/** /**
Report status code to OEM device. Report status code to OEM device.
@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below. @param CodeType Indicates the type of status code being reported.
@param Value Describes the current status of a hardware or software entity. @param Value Describes the current status of a hardware or software entity.
This includes both an operation and classification information about the class and subclass. This includes both an operation and classification information about the class and subclass.
For progress codes, the operation is the current activity. For progress codes, the operation is the current activity.
For error codes, it is the exception. For debug codes, it is not defined at this time. For error codes, it is the exception. For debug codes, it is not defined at this time.
Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. Specific values are discussed in the Intel Platform Innovation Framework for EFI Status Code Specification.
Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
@param Instance The enumeration of a hardware or software entity within the system. @param Instance The enumeration of a hardware or software entity within the system.
A system may contain multiple entities that match a class/subclass pairing. A system may contain multiple entities that match a class/subclass pairing.

2
IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
View File

@ -92,7 +92,7 @@ PlatformBdsPolicyBehavior (
); );
/** /**
Hook point after a boot attempt fails. Hook point for a user-provided function, for after a boot attempt fails.
@param Option Pointer to Boot Option that failed to boot. @param Option Pointer to Boot Option that failed to boot.
@param Status Status returned from failed boot. @param Status Status returned from failed boot.

2
IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
View File

@ -271,7 +271,7 @@ EFI_STATUS
@param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance.
@retval EFI_SUCCESS Successfully initialized the ISA interface. @retval EFI_SUCCESS Successfully initialized all required hardware states.
@retval Other The ISA interface could not be initialized. @retval Other The ISA interface could not be initialized.
**/ **/

2
IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h
View File

@ -53,7 +53,7 @@ typedef enum {
@param This Pointer to this protocol instance. @param This Pointer to this protocol instance.
@param Instance The visible image instance is found. @param Instance The visible image instance is found.
@param Format Format of the image. Examples: BMP, JPEG. @param Format Format of the image. Examples: BMP, JPEG.
@param ImageData Image data returned. @param ImageData Image data for the badge file. Currently only supports the .bmp file format.
@param ImageSize Size of the image returned. @param ImageSize Size of the image returned.
@param Attribute Display attributes of the image returned. @param Attribute Display attributes of the image returned.
@param CoordinateX X coordinate of the image. @param CoordinateX X coordinate of the image.

2
IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
View File

@ -61,7 +61,7 @@ struct _EFI_VGA_MINI_PORT_PROTOCOL {
/// ///
UINT64 VgaMemoryOffset; UINT64 VgaMemoryOffset;
/// ///
/// I/O Port address for the VGA CRTC address register Typically set to 0x3D4. /// I/O Port address for the VGA CRTC address register. Typically set to 0x3D4.
/// ///
UINT64 CrtcAddressRegisterOffset; UINT64 CrtcAddressRegisterOffset;
/// ///