mirror of
https://github.com/acidanthera/audk.git
synced 2025-07-21 04:34:27 +02:00
MdePkg/Library/Dxe: Fix various typos
Fix various typos in documentation, comments and strings, and remove the duplicated 'the'. Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <liming.gao@intel.com> Signed-off-by: Antoine Coeur <coeur@gmx.fr> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com> Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com> Message-Id: <20200207010831.9046-25-philmd@redhat.com>
This commit is contained in:
parent
b219e2cd4c
commit
c1d8b697cf
@ -171,7 +171,7 @@ GetSectionFromFv (
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Searches the FFS file the the currently executing module was loaded from and returns the first matching FFS section.
|
Searches the FFS file the currently executing module was loaded from and returns the first matching FFS section.
|
||||||
|
|
||||||
This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType.
|
This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType.
|
||||||
If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType,
|
If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType,
|
||||||
|
@ -150,7 +150,7 @@ ExtractGuidedSectionGetGuidList (
|
|||||||
If GetInfoHandler is NULL, then ASSERT().
|
If GetInfoHandler is NULL, then ASSERT().
|
||||||
If DecodeHandler is NULL, then ASSERT().
|
If DecodeHandler is NULL, then ASSERT().
|
||||||
|
|
||||||
@param[in] SectionGuid A pointer to the GUID associated with the the handlers
|
@param[in] SectionGuid A pointer to the GUID associated with the handlers
|
||||||
of the GUIDed section type being registered.
|
of the GUIDed section type being registered.
|
||||||
@param[in] GetInfoHandler The pointer to a function that examines a GUIDed section and returns the
|
@param[in] GetInfoHandler The pointer to a function that examines a GUIDed section and returns the
|
||||||
size of the decoded buffer and the size of an optional scratch buffer
|
size of the decoded buffer and the size of an optional scratch buffer
|
||||||
@ -231,9 +231,9 @@ ExtractGuidedSectionRegisterHandlers (
|
|||||||
Examines a GUIDed section specified by InputSection.
|
Examines a GUIDed section specified by InputSection.
|
||||||
If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
|
If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
|
||||||
then RETURN_UNSUPPORTED is returned.
|
then RETURN_UNSUPPORTED is returned.
|
||||||
If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler
|
If the GUID of InputSection does match the GUID that this handler supports, then the associated handler
|
||||||
of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
|
of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
|
||||||
is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of
|
is used to retrieve the OutputBufferSize, ScratchSize, and Attributes values. The return status from the handler of
|
||||||
type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.
|
type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.
|
||||||
|
|
||||||
If InputSection is NULL, then ASSERT().
|
If InputSection is NULL, then ASSERT().
|
||||||
@ -311,7 +311,7 @@ ExtractGuidedSectionGetInfo (
|
|||||||
Decodes the GUIDed section specified by InputSection.
|
Decodes the GUIDed section specified by InputSection.
|
||||||
If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
|
If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
|
||||||
then RETURN_UNSUPPORTED is returned.
|
then RETURN_UNSUPPORTED is returned.
|
||||||
If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler
|
If the GUID of InputSection does match the GUID that this handler supports, then the associated handler
|
||||||
of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
|
of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
|
||||||
is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this
|
is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this
|
||||||
decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,
|
decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,
|
||||||
@ -397,7 +397,7 @@ ExtractGuidedSectionDecode (
|
|||||||
|
|
||||||
If SectionGuid is NULL, then ASSERT().
|
If SectionGuid is NULL, then ASSERT().
|
||||||
|
|
||||||
@param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed
|
@param[in] SectionGuid A pointer to the GUID associated with the handlers of the GUIDed
|
||||||
section type being retrieved.
|
section type being retrieved.
|
||||||
@param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns
|
@param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns
|
||||||
the size of the decoded buffer and the size of an optional scratch
|
the size of the decoded buffer and the size of an optional scratch
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/** @file
|
/** @file
|
||||||
HOB Library implemenation for Dxe Phase.
|
HOB Library implementation for Dxe Phase.
|
||||||
|
|
||||||
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||||
SPDX-License-Identifier: BSD-2-Clause-Patent
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||||
|
@ -11,7 +11,7 @@
|
|||||||
#include "DxeCpuIo2LibInternal.h"
|
#include "DxeCpuIo2LibInternal.h"
|
||||||
|
|
||||||
//
|
//
|
||||||
// Globle varible to cache pointer to CpuIo2 protocol.
|
// Global variable to cache pointer to CpuIo2 protocol.
|
||||||
//
|
//
|
||||||
EFI_CPU_IO2_PROTOCOL *mCpuIo = NULL;
|
EFI_CPU_IO2_PROTOCOL *mCpuIo = NULL;
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@
|
|||||||
# Note: A driver of type DXE_RUNTIME_DRIVER and DXE_SMM_DRIVER can only use this DxePcdLib
|
# Note: A driver of type DXE_RUNTIME_DRIVER and DXE_SMM_DRIVER can only use this DxePcdLib
|
||||||
# in their initialization without any issues to access Dynamic and DynamicEx PCD. They can't
|
# in their initialization without any issues to access Dynamic and DynamicEx PCD. They can't
|
||||||
# access Dynamic and DynamicEx PCD in the implementation of runtime services and SMI handlers.
|
# access Dynamic and DynamicEx PCD in the implementation of runtime services and SMI handlers.
|
||||||
# Because EFI_PCD_PROTOCOL is DXE protocol that is not aviable in OS runtime phase.
|
# Because EFI_PCD_PROTOCOL is DXE protocol that is not available in OS runtime phase.
|
||||||
#
|
#
|
||||||
# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
|
# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||||
#
|
#
|
||||||
|
@ -22,5 +22,5 @@
|
|||||||
|
|
||||||
#string STR_MODULE_ABSTRACT #language en-US "PCD Library using PCD Protocol"
|
#string STR_MODULE_ABSTRACT #language en-US "PCD Library using PCD Protocol"
|
||||||
|
|
||||||
#string STR_MODULE_DESCRIPTION #language en-US "There are two PCD protocols: 1) PCD_PROTOCOL It is an EDKII implementation that supporst Dynamic/DynamicEx PCDs. 2) EFI_PCD_PROTOCOL It is defined by PI Specification 1.2, Vol 3, which only support dynamicEx type PCD. For dynamicEx type PCDs, it is compatible between PCD_PROTOCOL and EFI_PCD_PROTOCOL. This library instance uses the PCD_PROTOCOL to handle dynamic PCD requests and uses EFI_PCD_PROTOCOL to handle DynamicEx type PCDs."
|
#string STR_MODULE_DESCRIPTION #language en-US "There are two PCD protocols: 1) PCD_PROTOCOL It is an EDKII implementation that supports Dynamic/DynamicEx PCDs. 2) EFI_PCD_PROTOCOL It is defined by PI Specification 1.2, Vol 3, which only support dynamicEx type PCD. For dynamicEx type PCDs, it is compatible between PCD_PROTOCOL and EFI_PCD_PROTOCOL. This library instance uses the PCD_PROTOCOL to handle dynamic PCD requests and uses EFI_PCD_PROTOCOL to handle DynamicEx type PCDs."
|
||||||
|
|
||||||
|
@ -298,7 +298,7 @@ PciExpressRegisterForRuntimeAccess (
|
|||||||
Address = GetPciExpressAddress (Address & 0x0ffff000);
|
Address = GetPciExpressAddress (Address & 0x0ffff000);
|
||||||
|
|
||||||
//
|
//
|
||||||
// See if Address has already been registerd for runtime access
|
// See if Address has already been registered for runtime access
|
||||||
//
|
//
|
||||||
for (Index = 0; Index < mDxeRuntimePciExpressLibNumberOfRuntimeRanges; Index++) {
|
for (Index = 0; Index < mDxeRuntimePciExpressLibNumberOfRuntimeRanges; Index++) {
|
||||||
if (mDxeRuntimePciExpressLibRegistrationTable[Index].PhysicalAddress == Address) {
|
if (mDxeRuntimePciExpressLibRegistrationTable[Index].PhysicalAddress == Address) {
|
||||||
@ -1456,7 +1456,7 @@ PciExpressBitFieldAndThenOr32 (
|
|||||||
Size into the buffer specified by Buffer. This function only allows the PCI
|
Size into the buffer specified by Buffer. This function only allows the PCI
|
||||||
configuration registers from a single PCI function to be read. Size is
|
configuration registers from a single PCI function to be read. Size is
|
||||||
returned. When possible 32-bit PCI configuration read cycles are used to read
|
returned. When possible 32-bit PCI configuration read cycles are used to read
|
||||||
from StartAdress to StartAddress + Size. Due to alignment restrictions, 8-bit
|
from StartAddress to StartAddress + Size. Due to alignment restrictions, 8-bit
|
||||||
and 16-bit PCI configuration read cycles may be used at the beginning and the
|
and 16-bit PCI configuration read cycles may be used at the beginning and the
|
||||||
end of the range.
|
end of the range.
|
||||||
|
|
||||||
@ -1559,7 +1559,7 @@ PciExpressReadBuffer (
|
|||||||
Size from the buffer specified by Buffer. This function only allows the PCI
|
Size from the buffer specified by Buffer. This function only allows the PCI
|
||||||
configuration registers from a single PCI function to be written. Size is
|
configuration registers from a single PCI function to be written. Size is
|
||||||
returned. When possible 32-bit PCI configuration write cycles are used to
|
returned. When possible 32-bit PCI configuration write cycles are used to
|
||||||
write from StartAdress to StartAddress + Size. Due to alignment restrictions,
|
write from StartAddress to StartAddress + Size. Due to alignment restrictions,
|
||||||
8-bit and 16-bit PCI configuration write cycles may be used at the beginning
|
8-bit and 16-bit PCI configuration write cycles may be used at the beginning
|
||||||
and the end of the range.
|
and the end of the range.
|
||||||
|
|
||||||
|
@ -25,7 +25,7 @@
|
|||||||
/**
|
/**
|
||||||
Identify the device handle from which the Image is loaded from. As this device handle is passed to
|
Identify the device handle from which the Image is loaded from. As this device handle is passed to
|
||||||
GetSectionFromFv as the identifier for a Firmware Volume, an EFI_FIRMWARE_VOLUME2_PROTOCOL
|
GetSectionFromFv as the identifier for a Firmware Volume, an EFI_FIRMWARE_VOLUME2_PROTOCOL
|
||||||
protocol instance should be located succesfully by calling gBS->HandleProtocol ().
|
protocol instance should be located successfully by calling gBS->HandleProtocol ().
|
||||||
|
|
||||||
This function locates the EFI_LOADED_IMAGE_PROTOCOL instance installed
|
This function locates the EFI_LOADED_IMAGE_PROTOCOL instance installed
|
||||||
on ImageHandle. It then returns EFI_LOADED_IMAGE_PROTOCOL.DeviceHandle.
|
on ImageHandle. It then returns EFI_LOADED_IMAGE_PROTOCOL.DeviceHandle.
|
||||||
@ -71,7 +71,7 @@ InternalImageHandleToFvHandle (
|
|||||||
Section type and instance number from the specified Firmware Volume.
|
Section type and instance number from the specified Firmware Volume.
|
||||||
|
|
||||||
This functions first locate the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance on FvHandle in order to
|
This functions first locate the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance on FvHandle in order to
|
||||||
carry out the Firmware Volume read operation. The function then reads the Firmware Section found sepcifed
|
carry out the Firmware Volume read operation. The function then reads the Firmware Section found specified
|
||||||
by NameGuid, SectionType and SectionInstance.
|
by NameGuid, SectionType and SectionInstance.
|
||||||
|
|
||||||
The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection ()
|
The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection ()
|
||||||
@ -94,7 +94,7 @@ InternalImageHandleToFvHandle (
|
|||||||
@param SectionType The Firmware Section type.
|
@param SectionType The Firmware Section type.
|
||||||
@param SectionInstance The instance number of Firmware Section to
|
@param SectionInstance The instance number of Firmware Section to
|
||||||
read from starting from 0.
|
read from starting from 0.
|
||||||
@param Buffer On output, Buffer contains the the data read
|
@param Buffer On output, Buffer contains the data read
|
||||||
from the section in the Firmware File found.
|
from the section in the Firmware File found.
|
||||||
@param Size On output, the size of Buffer.
|
@param Size On output, the size of Buffer.
|
||||||
|
|
||||||
@ -517,7 +517,7 @@ GetSectionFromFv (
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Searches the FFS file the the currently executing module was loaded from and returns the first matching FFS section.
|
Searches the FFS file the currently executing module was loaded from and returns the first matching FFS section.
|
||||||
|
|
||||||
This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType.
|
This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType.
|
||||||
If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType,
|
If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType,
|
||||||
@ -597,7 +597,7 @@ GetSectionFromFfs (
|
|||||||
selection. If FALSE, then FilePath must
|
selection. If FALSE, then FilePath must
|
||||||
match an exact file to be loaded.
|
match an exact file to be loaded.
|
||||||
@param[in] FilePath The pointer to the device path of the file
|
@param[in] FilePath The pointer to the device path of the file
|
||||||
that is absracted to the file buffer.
|
that is abstracted to the file buffer.
|
||||||
@param[out] FileSize The pointer to the size of the abstracted
|
@param[out] FileSize The pointer to the size of the abstracted
|
||||||
file buffer.
|
file buffer.
|
||||||
@param[out] AuthenticationStatus Pointer to the authentication status.
|
@param[out] AuthenticationStatus Pointer to the authentication status.
|
||||||
@ -745,7 +745,7 @@ GetFileBufferByFilePath (
|
|||||||
}
|
}
|
||||||
//
|
//
|
||||||
// Parse each MEDIA_FILEPATH_DP node. There may be more than one, since the
|
// Parse each MEDIA_FILEPATH_DP node. There may be more than one, since the
|
||||||
// directory information and filename can be seperate. The goal is to inch
|
// directory information and filename can be separate. The goal is to inch
|
||||||
// our way down each device path node and close the previous node
|
// our way down each device path node and close the previous node
|
||||||
//
|
//
|
||||||
DevicePathNode = TempDevicePathNode;
|
DevicePathNode = TempDevicePathNode;
|
||||||
|
@ -9,7 +9,7 @@
|
|||||||
Please attention this library instance can not be used util EFI_SYSTEM_TABLE was
|
Please attention this library instance can not be used util EFI_SYSTEM_TABLE was
|
||||||
initialized.
|
initialized.
|
||||||
|
|
||||||
This library contains contruct function to retrieve EFI_DXE_SERIVCE, this construct
|
This library contains construct function to retrieve EFI_DXE_SERVICE, this construct
|
||||||
function will be invoked in DXE driver's autogen file.
|
function will be invoked in DXE driver's autogen file.
|
||||||
|
|
||||||
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||||
|
@ -12,7 +12,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
|
|||||||
|
|
||||||
|
|
||||||
//
|
//
|
||||||
// Globle varible to cache pointer to Smbus protocol.
|
// Global variable to cache pointer to Smbus protocol.
|
||||||
//
|
//
|
||||||
EFI_SMBUS_HC_PROTOCOL *mSmbus = NULL;
|
EFI_SMBUS_HC_PROTOCOL *mSmbus = NULL;
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user