Code Scrub for Dxe Core.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5560 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8
2008-07-24 02:54:45 +00:00
parent 11c11e4ecf
commit 022c6d45ef
38 changed files with 2499 additions and 2504 deletions

View File

@ -135,7 +135,7 @@ CoreFwVolEventProtocolNotify (
); );
/** /**
Convert FvHandle and DriverName into an EFI device path. Convert FvHandle and DriverName into an EFI device path
@param Fv Fv protocol, needed to read Depex info out of @param Fv Fv protocol, needed to read Depex info out of
FLASH. FLASH.

View File

@ -22,7 +22,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Protocol/LoadedImage.h> #include <Protocol/LoadedImage.h>
#include <Protocol/GuidedSectionExtraction.h> #include <Protocol/GuidedSectionExtraction.h>
#include <Guid/DebugImageInfoTable.h>
#include <Protocol/DevicePath.h> #include <Protocol/DevicePath.h>
#include <Protocol/Runtime.h> #include <Protocol/Runtime.h>
#include <Protocol/LoadFile.h> #include <Protocol/LoadFile.h>
@ -30,37 +29,39 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Protocol/VariableWrite.h> #include <Protocol/VariableWrite.h>
#include <Protocol/PlatformDriverOverride.h> #include <Protocol/PlatformDriverOverride.h>
#include <Protocol/Variable.h> #include <Protocol/Variable.h>
#include <Guid/MemoryTypeInformation.h>
#include <Guid/FirmwareFileSystem2.h>
#include <Guid/HobList.h>
#include <Protocol/Timer.h> #include <Protocol/Timer.h>
#include <Protocol/SimpleFileSystem.h> #include <Protocol/SimpleFileSystem.h>
#include <Protocol/Bds.h> #include <Protocol/Bds.h>
#include <Guid/FileInfo.h>
#include <Protocol/RealTimeClock.h> #include <Protocol/RealTimeClock.h>
#include <Guid/Apriori.h>
#include <Protocol/WatchdogTimer.h> #include <Protocol/WatchdogTimer.h>
#include <Protocol/FirmwareVolume2.h> #include <Protocol/FirmwareVolume2.h>
#include <Protocol/MonotonicCounter.h> #include <Protocol/MonotonicCounter.h>
#include <Guid/DxeServices.h>
#include <Guid/MemoryAllocationHob.h>
#include <Protocol/StatusCode.h> #include <Protocol/StatusCode.h>
#include <Protocol/Decompress.h> #include <Protocol/Decompress.h>
#include <Protocol/LoadPe32Image.h> #include <Protocol/LoadPe32Image.h>
#include <Protocol/FirmwareVolumeDispatch.h> #include <Protocol/FirmwareVolumeDispatch.h>
#include <Protocol/Security.h> #include <Protocol/Security.h>
#include <Protocol/Ebc.h> #include <Protocol/Ebc.h>
#include <Guid/EventLegacyBios.h>
#include <Protocol/Reset.h> #include <Protocol/Reset.h>
#include <Protocol/Cpu.h> #include <Protocol/Cpu.h>
#include <Guid/EventGroup.h>
#include <Protocol/Metronome.h> #include <Protocol/Metronome.h>
#include <Protocol/FirmwareVolumeBlock.h> #include <Protocol/FirmwareVolumeBlock.h>
#include <Protocol/Capsule.h> #include <Protocol/Capsule.h>
#include <Protocol/BusSpecificDriverOverride.h> #include <Protocol/BusSpecificDriverOverride.h>
#include <Protocol/Performance.h> #include <Protocol/Performance.h>
#include <Uefi/UefiTcgPlatform.h> #include <Protocol/TcgService.h>
#include <Protocol/TcgPlatform.h> #include <Protocol/TcgPlatform.h>
#include <Guid/MemoryTypeInformation.h>
#include <Guid/FirmwareFileSystem2.h>
#include <Guid/HobList.h>
#include <Guid/DebugImageInfoTable.h>
#include <Guid/FileInfo.h>
#include <Guid/Apriori.h>
#include <Guid/DxeServices.h>
#include <Guid/MemoryAllocationHob.h>
#include <Guid/EventLegacyBios.h>
#include <Guid/EventGroup.h>
#include <Library/DxeCoreEntryPoint.h> #include <Library/DxeCoreEntryPoint.h>
#include <Library/DebugLib.h> #include <Library/DebugLib.h>
@ -335,7 +336,6 @@ CoreInitializeGcdServices (
/** /**
Initializes "event" support and populates parts of the System and Runtime Table. Initializes "event" support and populates parts of the System and Runtime Table.
@retval EFI_SUCCESS Always return success @retval EFI_SUCCESS Always return success
**/ **/
@ -373,7 +373,6 @@ CoreNotifyOnArchProtocolInstallation (
/** /**
Return TRUE if all AP services are availible. Return TRUE if all AP services are availible.
@retval EFI_SUCCESS All AP services are available @retval EFI_SUCCESS All AP services are available
@retval EFI_NOT_FOUND At least one AP service is not available @retval EFI_NOT_FOUND At least one AP service is not available
@ -413,7 +412,7 @@ CoreTimerTick (
/** /**
Initialize the dispatcher. Initialize the notification function that runs when Initialize the dispatcher. Initialize the notification function that runs when
a FV protocol is added to the system. an FV2 protocol is added to the system.
**/ **/
VOID VOID
@ -428,7 +427,7 @@ CoreInitializeDispatcher (
routine in this case. The SOR is just ignored and is a nop in the grammer. routine in this case. The SOR is just ignored and is a nop in the grammer.
POSTFIX means all the math is done on top of the stack. POSTFIX means all the math is done on top of the stack.
@param DriverEntry DriverEntry element to update @param DriverEntry DriverEntry element to update.
@retval TRUE If driver is ready to run. @retval TRUE If driver is ready to run.
@retval FALSE If driver is not ready to run or some fatal error @retval FALSE If driver is not ready to run or some fatal error
@ -448,7 +447,7 @@ CoreIsSchedulable (
it will be cleared by CoreSchedule(), and then the driver can be it will be cleared by CoreSchedule(), and then the driver can be
dispatched. dispatched.
@param DriverEntry DriverEntry element to update @param DriverEntry DriverEntry element to update .
@retval EFI_SUCCESS It always works. @retval EFI_SUCCESS It always works.
@ -1006,7 +1005,7 @@ CoreLocateDevicePath (
@retval EFI_NOT_FOUND No handles match the search. @retval EFI_NOT_FOUND No handles match the search.
@retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the
matching results. matching results.
@retval EFI_INVALID_PARAMETER Invalid parameter @retval EFI_INVALID_PARAMETER One or more paramters are not valid.
**/ **/
EFI_STATUS EFI_STATUS
@ -1486,9 +1485,9 @@ CoreSetTimer (
/** /**
Signals the event. Queues the event to be notified if needed Signals the event. Queues the event to be notified if needed.
@param UserEvent The event to signal @param UserEvent The event to signal .
@retval EFI_INVALID_PARAMETER Parameters are not valid. @retval EFI_INVALID_PARAMETER Parameters are not valid.
@retval EFI_SUCCESS The event was signaled. @retval EFI_SUCCESS The event was signaled.
@ -1847,8 +1846,8 @@ CoreDispatcher (
@retval EFI_SUCCESS The DriverName was found and it's SOR bit was @retval EFI_SUCCESS The DriverName was found and it's SOR bit was
cleared cleared
@retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was
was not set. not set.
**/ **/
EFI_STATUS EFI_STATUS
@ -1860,14 +1859,14 @@ CoreSchedule (
/** /**
Convert a driver from the Untrused back to the Scheduled state Convert a driver from the Untrused back to the Scheduled state.
@param FirmwareVolumeHandle The handle of the Firmware Volume that contains @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
the firmware file specified by DriverName. the firmware file specified by DriverName.
@param DriverName The Driver name to put in the Scheduled state @param DriverName The Driver name to put in the Scheduled state
@retval EFI_SUCCESS The file was found in the untrusted state, and @retval EFI_SUCCESS The file was found in the untrusted state, and it
it was promoted to the trusted state. was promoted to the trusted state.
@retval EFI_NOT_FOUND The file was not found in the untrusted state. @retval EFI_NOT_FOUND The file was not found in the untrusted state.
**/ **/

View File

@ -26,7 +26,7 @@
ENTRY_POINT = DxeMain ENTRY_POINT = DxeMain
# VALID_ARCHITECTURES = IA32 X64 IPF EBC # VALID_ARCHITECTURES = IA32 X64 IPF
[Sources.common] [Sources.common]
Library.h Library.h

View File

@ -452,9 +452,9 @@ GetFwVolHeader (
/** /**
Check if a FV is consistent and allocate cache Check if an FV is consistent and allocate cache for it.
@param FvDevice pointer to the FvDevice to be checked. @param FvDevice A pointer to the FvDevice to be checked.
@retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated. @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.
@retval EFI_SUCCESS FV is consistent and cache is allocated. @retval EFI_SUCCESS FV is consistent and cache is allocated.

View File

@ -44,9 +44,8 @@ IHANDLE *
@param Interface Return the interface structure for the matching @param Interface Return the interface structure for the matching
protocol. protocol.
@retval IHANDLE An IHANDLE is returned if the next Position is @return An pointer to IHANDLE if the next Position is not the end of the list.
not the end of the list. A NULL_HANDLE is Otherwise,NULL_HANDLE is returned.
returned if it's the end of the list.
**/ **/
IHANDLE * IHANDLE *
@ -63,9 +62,8 @@ CoreGetNextLocateAllHandles (
@param Interface Return the interface structure for the matching @param Interface Return the interface structure for the matching
protocol. protocol.
@retval IHANDLE An IHANDLE is returned if the next Position is @return An pointer to IHANDLE if the next Position is not the end of the list.
not the end of the list. A NULL_HANDLE is Otherwise,NULL_HANDLE is returned.
returned if it's the end of the list.
**/ **/
IHANDLE * IHANDLE *
@ -81,9 +79,8 @@ CoreGetNextLocateByRegisterNotify (
@param Interface Return the interface structure for the matching @param Interface Return the interface structure for the matching
protocol. protocol.
@retval IHANDLE An IHANDLE is returned if the next Position is @return An pointer to IHANDLE if the next Position is not the end of the list.
not the end of the list. A NULL_HANDLE is Otherwise,NULL_HANDLE is returned.
returned if it's the end of the list.
**/ **/
IHANDLE * IHANDLE *

View File

@ -160,7 +160,7 @@ CoreConvertPages (
**/ **/
VOID VOID
RemoveMemoryMapEntry ( RemoveMemoryMapEntry (
MEMORY_MAP *Entry IN OUT MEMORY_MAP *Entry
); );
/** /**
@ -436,8 +436,6 @@ CoreAddMemoryDescriptor (
byte of a page byte of a page
@param Attribute The attributes of the memory range to add @param Attribute The attributes of the memory range to add
@return None. The range is added to the memory map
**/ **/
VOID VOID
CoreAddRange ( CoreAddRange (

View File

@ -323,6 +323,7 @@ IsValidSectionStream (
is stored. If the function returns is stored. If the function returns
anything other than EFI_SUCCESS, the value anything other than EFI_SUCCESS, the value
of OutputSize is undefined. of OutputSize is undefined.
@param AuthenticationStatus A pointer to a caller-allocated @param AuthenticationStatus A pointer to a caller-allocated
UINT32 that indicates the UINT32 that indicates the
authentication status of the authentication status of the