diff options
author | qhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-05-07 06:58:06 +0000 |
---|---|---|
committer | qhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-05-07 06:58:06 +0000 |
commit | 91d92e25647e9a26392b454499d309330710a076 (patch) | |
tree | 4ccc1303e5ebea05cdbf8f9851ed9ad82e350b41 /MdeModulePkg/Core/DxeIplPeim/Ia32 | |
parent | 6d3f77236cc0d894bc35117d43cc859e37e83d01 (diff) | |
download | edk2-platforms-91d92e25647e9a26392b454499d309330710a076.tar.xz |
Add doxygen style comments for functions in DxeIpl.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5174 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Core/DxeIplPeim/Ia32')
-rw-r--r-- | MdeModulePkg/Core/DxeIplPeim/Ia32/DxeLoadFunc.c | 16 | ||||
-rw-r--r-- | MdeModulePkg/Core/DxeIplPeim/Ia32/ImageRead.c | 66 | ||||
-rw-r--r-- | MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c | 30 | ||||
-rw-r--r-- | MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h | 24 |
4 files changed, 83 insertions, 53 deletions
diff --git a/MdeModulePkg/Core/DxeIplPeim/Ia32/DxeLoadFunc.c b/MdeModulePkg/Core/DxeIplPeim/Ia32/DxeLoadFunc.c index e42b8acc36..7dfb3407b4 100644 --- a/MdeModulePkg/Core/DxeIplPeim/Ia32/DxeLoadFunc.c +++ b/MdeModulePkg/Core/DxeIplPeim/Ia32/DxeLoadFunc.c @@ -44,6 +44,22 @@ GLOBAL_REMOVE_IF_UNREFERENCED IA32_DESCRIPTOR gLidtDescriptor = { 0
};
+
+
+
+
+/**
+ Transfers control to DxeCore.
+
+ This function performs a CPU architecture specific operations to execute
+ the entry point of DxeCore with the parameters of HobList.
+ It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.
+
+ @param DxeCoreEntryPoint The entrypoint of DxeCore.
+ @param HobList The start of HobList passed to DxeCore.
+ @param EndOfPeiSignal The PPI descriptor for EFI_END_OF_PEI_PPI.
+
+**/
VOID
HandOffToDxeCore (
IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint,
diff --git a/MdeModulePkg/Core/DxeIplPeim/Ia32/ImageRead.c b/MdeModulePkg/Core/DxeIplPeim/Ia32/ImageRead.c index b6278154d1..1a5135c4dc 100644 --- a/MdeModulePkg/Core/DxeIplPeim/Ia32/ImageRead.c +++ b/MdeModulePkg/Core/DxeIplPeim/Ia32/ImageRead.c @@ -14,6 +14,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "DxeIpl.h"
+
+
+
+
+/**
+ Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
+
+ @param FileHandle The handle to the PE/COFF file
+ @param FileOffset The offset, in bytes, into the file to read
+ @param ReadSize The number of bytes to read from the file starting at
+ FileOffset
+ @param Buffer A pointer to the buffer to read the data into.
+
+ @retval EFI_SUCCESS ReadSize bytes of data were read into Buffer from the
+ PE/COFF file starting at FileOffset
+
+**/
EFI_STATUS
EFIAPI
PeiImageRead (
@@ -22,27 +39,6 @@ PeiImageRead ( IN OUT UINTN *ReadSize,
OUT VOID *Buffer
)
-/*++
-
-Routine Description:
-
- Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
-
-Arguments:
-
- FileHandle - The handle to the PE/COFF file
-
- FileOffset - The offset, in bytes, into the file to read
-
- ReadSize - The number of bytes to read from the file starting at FileOffset
-
- Buffer - A pointer to the buffer to read the data into.
-
-Returns:
-
- EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
-
---*/
{
UINT8 *Destination32;
UINT8 *Source32;
@@ -66,24 +62,24 @@ Returns: return EFI_SUCCESS;
}
-EFI_STATUS
-GetImageReadFunction (
- IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
- )
-/*++
-Routine Description:
- Support routine to return the PE32 Image Reader.
- If the PeiImageRead() function is less than a page
- in legnth. If the function is more than a page the DXE IPL will crash!!!!
-Arguments:
- ImageContext - The context of the image being loaded
-Returns:
- EFI_SUCCESS - If Image function location is found
---*/
+/**
+ This function simply retrieves the function pointer of ImageRead in
+ ImageContext structure.
+
+ @param ImageContext A pointer to the structure of
+ PE_COFF_LOADER_IMAGE_CONTEXT
+
+ @retval EFI_SUCCESS This function always return EFI_SUCCESS.
+
+**/
+EFI_STATUS
+GetImageReadFunction (
+ IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
+ )
{
VOID *MemoryBuffer;
diff --git a/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c b/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c index 38b242c269..25fb37ea8e 100644 --- a/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c +++ b/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c @@ -30,28 +30,26 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "VirtualMemory.h"
-UINTN
-CreateIdentityMappingPageTables (
- VOID
- )
-/*++
-Routine Description:
- Allocates and fills in the Page Directory and Page Table Entries to
- establish a 1:1 Virtual to Physical mapping.
-Arguments:
- NumberOfProcessorPhysicalAddressBits - Number of processor address bits to use.
- Limits the number of page table entries
- to the physical address space.
+/**
+ Allocates and fills in the Page Directory and Page Table Entries to
+ establish a 1:1 Virtual to Physical mapping.
-Returns:
+ @param NumberOfProcessorPhysicalAddressBits Number of processor address bits
+ to use. Limits the number of page
+ table entries to the physical
+ address space.
- EFI_SUCCESS The 1:1 Virtual to Physical identity mapping was created
+ @return EFI_SUCCESS The 1:1 Virtual to Physical identity mapping was created
---*/
+**/
+UINTN
+CreateIdentityMappingPageTables (
+ VOID
+ )
{
UINT8 PhysicalAddressBits;
EFI_PHYSICAL_ADDRESS PageAddress;
@@ -159,6 +157,6 @@ Returns: );
}
- return (UINTN)PageMap; // FIXME
+ return (UINTN)PageMap;
}
diff --git a/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h b/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h index 9e824ed280..5bb3e43786 100644 --- a/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h +++ b/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h @@ -99,6 +99,20 @@ typedef union { #pragma pack()
+
+
+/**
+ Allocates and fills in the Page Directory and Page Table Entries to
+ establish a 1:1 Virtual to Physical mapping.
+
+ @param NumberOfProcessorPhysicalAddressBits Number of processor address bits
+ to use. Limits the number of page
+ table entries to the physical
+ address space.
+
+ @return EFI_SUCCESS The 1:1 Virtual to Physical identity mapping was created
+
+**/
UINTN
CreateIdentityMappingPageTables (
VOID
@@ -106,6 +120,9 @@ CreateIdentityMappingPageTables ( ;
+
+
+
/**
Fix up the vector number in the vector code.
@@ -113,7 +130,7 @@ CreateIdentityMappingPageTables ( @param VectorBase Base address of the vector handler.
@param VectorNum Index of vector.
-
+
**/
VOID
EFIAPI
@@ -123,6 +140,9 @@ AsmVectorFixup ( );
+
+
+
/**
Get the information of vector template.
@@ -130,7 +150,7 @@ AsmVectorFixup ( @param TemplateBase Base address of the template code.
@return Size of the Template code.
-
+
**/
UINTN
EFIAPI
|