Clean up Runtime for Doxygen comments requirement.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5460 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 56 insertions, 84 deletions

diff --git a/MdeModulePkg/Core/RuntimeDxe/Runtime.h b/MdeModulePkg/Core/RuntimeDxe/Runtime.h
index 4ff21ea5b6..e85c47d9b1 100644
--- a/MdeModulePkg/Core/RuntimeDxe/Runtime.h
+++ b/MdeModulePkg/Core/RuntimeDxe/Runtime.h
@@ -42,6 +42,20 @@ Abstract:
 //

 // Function Prototypes

 //

+/**

+

+  Calculate CRC32 for target data

+

+

+  @param Data            The target data.

+  @param DataSize        The target data size.

+  @param CrcOut          The CRC32 for target data.

+

+  @retval  EFI_SUCCESS            The CRC32 for target data is calculated successfully.

+  @retval  EFI_INVALID_PARAMETER  Some parameter is not valid, so the CRC32 is not

+                                  calculated.

+

+**/

 EFI_STATUS

 EFIAPI

 RuntimeDriverCalculateCrc32 (

@@ -49,55 +63,52 @@ RuntimeDriverCalculateCrc32 (
   IN  UINTN   DataSize,

   OUT UINT32  *CrcOut

   )

-/*++

-

-Routine Description:

-

-  Calculate CRC32 for target data

+;

 

-Arguments:

+/**

 

-  Data     - The target data.

-  DataSize - The target data size.

-  CrcOut   - The CRC32 for target data.

+  Determines the new virtual address that is to be used on subsequent memory accesses.

 

-Returns:

 

-  EFI_SUCCESS           - The CRC32 for target data is calculated successfully.

-  EFI_INVALID_PARAMETER - Some parameter is not valid, so the CRC32 is not

-                          calculated.

+  @param DebugDisposition Supplies type information for the pointer being converted.

+  @param ConvertAddress  A pointer to a pointer that is to be fixed to be the value needed

+                         for the new virtual address mappings being applied.

 

---*/

-;

+  @retval  EFI_SUCCESS              The pointer pointed to by Address was modified.

+  @retval  EFI_NOT_FOUND            The pointer pointed to by Address was not found to be part

+                                    of the current memory map. This is normally fatal.

+  @retval  EFI_INVALID_PARAMETER    One of the parameters has an invalid value.

 

+**/

 EFI_STATUS

 EFIAPI

 RuntimeDriverConvertPointer (

   IN     UINTN  DebugDisposition,

   IN OUT VOID   **ConvertAddress

   )

-/*++

-

-Routine Description:

-

-  Determines the new virtual address that is to be used on subsequent memory accesses.

+;

 

-Arguments:

+/**

 

-  DebugDisposition    - Supplies type information for the pointer being converted.

-  ConvertAddress      - A pointer to a pointer that is to be fixed to be the value needed

-                        for the new virtual address mappings being applied.

+  Changes the runtime addressing mode of EFI firmware from physical to virtual.

 

-Returns:

 

-  EFI_SUCCESS             - The pointer pointed to by Address was modified.

-  EFI_NOT_FOUND           - The pointer pointed to by Address was not found to be part

-                            of the current memory map. This is normally fatal.

-  EFI_INVALID_PARAMETER   - One of the parameters has an invalid value.

+  @param MemoryMapSize   The size in bytes of VirtualMap.

+  @param DescriptorSize  The size in bytes of an entry in the VirtualMap.

+  @param DescriptorVersion The version of the structure entries in VirtualMap.

+  @param VirtualMap      An array of memory descriptors which contain new virtual

+                         address mapping information for all runtime ranges.

 

---*/

-;

+  @retval  EFI_SUCCESS            The virtual address map has been applied.

+  @retval  EFI_UNSUPPORTED        EFI firmware is not at runtime, or the EFI firmware is already in

+                                  virtual address mapped mode.

+  @retval  EFI_INVALID_PARAMETER  DescriptorSize or DescriptorVersion is invalid.

+  @retval  EFI_NO_MAPPING         A virtual address was not supplied for a range in the memory

+                                  map that requires a mapping.

+  @retval  EFI_NOT_FOUND          A virtual address was supplied for an address that is not found

+                                  in the memory map.

 

+**/

 EFI_STATUS

 EFIAPI

 RuntimeDriverSetVirtualAddressMap (

@@ -106,78 +117,39 @@ RuntimeDriverSetVirtualAddressMap (
   IN UINT32                 DescriptorVersion,

   IN EFI_MEMORY_DESCRIPTOR  *VirtualMap

   )

-/*++

-

-Routine Description:

-

-  Changes the runtime addressing mode of EFI firmware from physical to virtual.

-

-Arguments:

-

-  MemoryMapSize     - The size in bytes of VirtualMap.

-  DescriptorSize    - The size in bytes of an entry in the VirtualMap.

-  DescriptorVersion - The version of the structure entries in VirtualMap.

-  VirtualMap        - An array of memory descriptors which contain new virtual

-                      address mapping information for all runtime ranges.

-

-Returns:

+;

 

-  EFI_SUCCESS           - The virtual address map has been applied.

-  EFI_UNSUPPORTED       - EFI firmware is not at runtime, or the EFI firmware is already in

-                          virtual address mapped mode.

-  EFI_INVALID_PARAMETER - DescriptorSize or DescriptorVersion is invalid.

-  EFI_NO_MAPPING        - A virtual address was not supplied for a range in the memory

-                          map that requires a mapping.

-  EFI_NOT_FOUND         - A virtual address was supplied for an address that is not found

-                          in the memory map.

+/**

 

---*/

-;

+  Initialize CRC32 table.

 

+**/

 VOID

 RuntimeDriverInitializeCrc32Table (

   VOID

   )

-/*++

-

-Routine Description:

-

-  Initialize CRC32 table.

+;

 

-Arguments:

+/**

 

-  None.

+  Install Runtime AP. This code includes the EfiRuntimeLib, but it only

+  functions at RT in physical mode.

 

-Returns:

 

-  None.

+  @param ImageHandle     Image handle of this driver.

+  @param SystemTable     Pointer to the EFI System Table.

 

---*/

-;

+  @retval  EFI_SUCEESS  Runtime Driver Architectural Protocol Installed

+  @return  Other value if gBS->InstallMultipleProtocolInterfaces fails. Check

+           gBS->InstallMultipleProtocolInterfaces for details.

 

+**/

 EFI_STATUS

 EFIAPI

 RuntimeDriverInitialize (

   IN EFI_HANDLE                            ImageHandle,

   IN EFI_SYSTEM_TABLE                      *SystemTable

   )

-/*++

-

-Routine Description:

-

-  Install Runtime AP. This code includes the EfiRuntimeLib, but it only

-  functions at RT in physical mode.

-

-Arguments:

-

-  ImageHandle   - Image handle of this driver.

-  SystemTable   - Pointer to the EFI System Table.

-

-Returns:

-

-  EFI_SUCEESS - Runtime Driver Architectural Protocol installed.

-

---*/

 ;

 

 #endif