X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FCore%2FRuntimeDxe%2FRuntime.h;h=019a0cb140e5a8737ce91bbe06a78fafe96808c7;hp=f9e4f1d3751e22341732576ba2b7f88317b60efb;hb=9d510e61fceee7b92955ef9a3c20343752d8ce3f;hpb=10e2e070c9f62e884d7b18752ff91ca9d0b74fb2 diff --git a/MdeModulePkg/Core/RuntimeDxe/Runtime.h b/MdeModulePkg/Core/RuntimeDxe/Runtime.h index f9e4f1d375..019a0cb140 100644 --- a/MdeModulePkg/Core/RuntimeDxe/Runtime.h +++ b/MdeModulePkg/Core/RuntimeDxe/Runtime.h @@ -1,104 +1,93 @@ -/*++ - -Copyright (c) 2006, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - -Module Name: - - Runtime.h - -Abstract: - - Runtime Architectural Protocol as defined in the DXE CIS +/** @file + Runtime Architectural Protocol as defined in the DXE CIS. This code is used to produce the EFI runtime architectural protocol. ---*/ +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ #ifndef _RUNTIME_H_ #define _RUNTIME_H_ #include -#include #include #include #include #include #include #include -#include #include #include +#include #include #include -#include // // 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 ( IN VOID *Data, 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. + ); -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. - ---*/ -; +/** + Changes the runtime addressing mode of EFI firmware from physical to virtual. + @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,79 +95,25 @@ RuntimeDriverSetVirtualAddressMap ( IN UINTN DescriptorSize, 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. - ---*/ -; - -VOID -RuntimeDriverInitializeCrc32Table ( - VOID - ) -/*++ - -Routine Description: - - Initialize CRC32 table. - -Arguments: - - None. - -Returns: +/** + Install Runtime AP. This code includes the EfiRuntimeLib, but it only + functions at RT in physical mode. - 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