]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BaseLib/BaseLibInternals.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdePkg / Library / BaseLib / BaseLibInternals.h
index 8855231c1a422e97bbf00691337cfed736f991a6..d61e60438531664bb3d197603ba81794140f567c 100644 (file)
@@ -1,14 +1,8 @@
 /** @file\r
   Declaration of internal functions in BaseLib.\r
 \r
-  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
-  This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php.\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -41,8 +35,8 @@
 UINT64\r
 EFIAPI\r
 InternalMathLShiftU64 (\r
-  IN      UINT64                    Operand,\r
-  IN      UINTN                     Count\r
+  IN      UINT64  Operand,\r
+  IN      UINTN   Count\r
   );\r
 \r
 /**\r
@@ -61,8 +55,8 @@ InternalMathLShiftU64 (
 UINT64\r
 EFIAPI\r
 InternalMathRShiftU64 (\r
-  IN      UINT64                    Operand,\r
-  IN      UINTN                     Count\r
+  IN      UINT64  Operand,\r
+  IN      UINTN   Count\r
   );\r
 \r
 /**\r
@@ -81,8 +75,8 @@ InternalMathRShiftU64 (
 UINT64\r
 EFIAPI\r
 InternalMathARShiftU64 (\r
-  IN      UINT64                    Operand,\r
-  IN      UINTN                     Count\r
+  IN      UINT64  Operand,\r
+  IN      UINTN   Count\r
   );\r
 \r
 /**\r
@@ -102,8 +96,8 @@ InternalMathARShiftU64 (
 UINT64\r
 EFIAPI\r
 InternalMathLRotU64 (\r
-  IN      UINT64                    Operand,\r
-  IN      UINTN                     Count\r
+  IN      UINT64  Operand,\r
+  IN      UINTN   Count\r
   );\r
 \r
 /**\r
@@ -123,8 +117,8 @@ InternalMathLRotU64 (
 UINT64\r
 EFIAPI\r
 InternalMathRRotU64 (\r
-  IN      UINT64                    Operand,\r
-  IN      UINTN                     Count\r
+  IN      UINT64  Operand,\r
+  IN      UINTN   Count\r
   );\r
 \r
 /**\r
@@ -142,7 +136,7 @@ InternalMathRRotU64 (
 UINT64\r
 EFIAPI\r
 InternalMathSwapBytes64 (\r
-  IN      UINT64                    Operand\r
+  IN      UINT64  Operand\r
   );\r
 \r
 /**\r
@@ -162,8 +156,8 @@ InternalMathSwapBytes64 (
 UINT64\r
 EFIAPI\r
 InternalMathMultU64x32 (\r
-  IN      UINT64                    Multiplicand,\r
-  IN      UINT32                    Multiplier\r
+  IN      UINT64  Multiplicand,\r
+  IN      UINT32  Multiplier\r
   );\r
 \r
 /**\r
@@ -183,8 +177,8 @@ InternalMathMultU64x32 (
 UINT64\r
 EFIAPI\r
 InternalMathMultU64x64 (\r
-  IN      UINT64                    Multiplicand,\r
-  IN      UINT64                    Multiplier\r
+  IN      UINT64  Multiplicand,\r
+  IN      UINT64  Multiplier\r
   );\r
 \r
 /**\r
@@ -204,8 +198,8 @@ InternalMathMultU64x64 (
 UINT64\r
 EFIAPI\r
 InternalMathDivU64x32 (\r
-  IN      UINT64                    Dividend,\r
-  IN      UINT32                    Divisor\r
+  IN      UINT64  Dividend,\r
+  IN      UINT32  Divisor\r
   );\r
 \r
 /**\r
@@ -225,8 +219,8 @@ InternalMathDivU64x32 (
 UINT32\r
 EFIAPI\r
 InternalMathModU64x32 (\r
-  IN      UINT64                    Dividend,\r
-  IN      UINT32                    Divisor\r
+  IN      UINT64  Dividend,\r
+  IN      UINT32  Divisor\r
   );\r
 \r
 /**\r
@@ -249,9 +243,9 @@ InternalMathModU64x32 (
 UINT64\r
 EFIAPI\r
 InternalMathDivRemU64x32 (\r
-  IN      UINT64                    Dividend,\r
-  IN      UINT32                    Divisor,\r
-  OUT     UINT32                    *Remainder OPTIONAL\r
+  IN      UINT64  Dividend,\r
+  IN      UINT32  Divisor,\r
+  OUT     UINT32  *Remainder OPTIONAL\r
   );\r
 \r
 /**\r
@@ -274,9 +268,9 @@ InternalMathDivRemU64x32 (
 UINT64\r
 EFIAPI\r
 InternalMathDivRemU64x64 (\r
-  IN      UINT64                    Dividend,\r
-  IN      UINT64                    Divisor,\r
-  OUT     UINT64                    *Remainder OPTIONAL\r
+  IN      UINT64  Dividend,\r
+  IN      UINT64  Divisor,\r
+  OUT     UINT64  *Remainder OPTIONAL\r
   );\r
 \r
 /**\r
@@ -299,9 +293,9 @@ InternalMathDivRemU64x64 (
 INT64\r
 EFIAPI\r
 InternalMathDivRemS64x64 (\r
-  IN      INT64                     Dividend,\r
-  IN      INT64                     Divisor,\r
-  OUT     INT64                     *Remainder  OPTIONAL\r
+  IN      INT64  Dividend,\r
+  IN      INT64  Divisor,\r
+  OUT     INT64  *Remainder  OPTIONAL\r
   );\r
 \r
 /**\r
@@ -332,13 +326,12 @@ VOID
 EFIAPI\r
 InternalSwitchStack (\r
   IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,\r
-  IN      VOID                      *Context1,   OPTIONAL\r
-  IN      VOID                      *Context2,   OPTIONAL\r
+  IN      VOID                      *Context1    OPTIONAL,\r
+  IN      VOID                      *Context2    OPTIONAL,\r
   IN      VOID                      *NewStack,\r
   IN      VA_LIST                   Marker\r
   );\r
 \r
-\r
 /**\r
   Worker function that returns a bit field from Operand.\r
 \r
@@ -354,12 +347,11 @@ InternalSwitchStack (
 UINTN\r
 EFIAPI\r
 BitFieldReadUint (\r
-  IN      UINTN                     Operand,\r
-  IN      UINTN                     StartBit,\r
-  IN      UINTN                     EndBit\r
+  IN      UINTN  Operand,\r
+  IN      UINTN  StartBit,\r
+  IN      UINTN  EndBit\r
   );\r
 \r
-\r
 /**\r
   Worker function that reads a bit field from Operand, performs a bitwise OR,\r
   and returns the result.\r
@@ -379,13 +371,12 @@ BitFieldReadUint (
 UINTN\r
 EFIAPI\r
 BitFieldOrUint (\r
-  IN      UINTN                     Operand,\r
-  IN      UINTN                     StartBit,\r
-  IN      UINTN                     EndBit,\r
-  IN      UINTN                     OrData\r
+  IN      UINTN  Operand,\r
+  IN      UINTN  StartBit,\r
+  IN      UINTN  EndBit,\r
+  IN      UINTN  OrData\r
   );\r
 \r
-\r
 /**\r
   Worker function that reads a bit field from Operand, performs a bitwise AND,\r
   and returns the result.\r
@@ -405,13 +396,12 @@ BitFieldOrUint (
 UINTN\r
 EFIAPI\r
 BitFieldAndUint (\r
-  IN      UINTN                     Operand,\r
-  IN      UINTN                     StartBit,\r
-  IN      UINTN                     EndBit,\r
-  IN      UINTN                     AndData\r
+  IN      UINTN  Operand,\r
+  IN      UINTN  StartBit,\r
+  IN      UINTN  EndBit,\r
+  IN      UINTN  AndData\r
   );\r
 \r
-\r
 /**\r
   Worker function that checks ASSERT condition for JumpBuffer\r
 \r
@@ -429,7 +419,6 @@ InternalAssertJumpBuffer (
   IN      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer\r
   );\r
 \r
-\r
 /**\r
   Restores the CPU context that was saved with SetJump().\r
 \r
@@ -448,7 +437,6 @@ InternalLongJump (
   IN      UINTN                     Value\r
   );\r
 \r
-\r
 /**\r
   Check if a Unicode character is a decimal character.\r
 \r
@@ -465,32 +453,9 @@ InternalLongJump (
 BOOLEAN\r
 EFIAPI\r
 InternalIsDecimalDigitCharacter (\r
-  IN      CHAR16                    Char\r
-  );\r
-\r
-\r
-/**\r
-  Convert a Unicode character to upper case only if\r
-  it maps to a valid small-case ASCII character.\r
-\r
-  This internal function only deal with Unicode character\r
-  which maps to a valid small-case ASCII character, i.e.\r
-  L'a' to L'z'. For other Unicode character, the input character\r
-  is returned directly.\r
-\r
-  @param  Char  The character to convert.\r
-\r
-  @retval LowerCharacter   If the Char is with range L'a' to L'z'.\r
-  @retval Unchanged        Otherwise.\r
-\r
-**/\r
-CHAR16\r
-EFIAPI\r
-InternalCharToUpper (\r
-  IN      CHAR16                    Char\r
+  IN      CHAR16  Char\r
   );\r
 \r
-\r
 /**\r
   Convert a Unicode character to numerical value.\r
 \r
@@ -507,10 +472,9 @@ InternalCharToUpper (
 UINTN\r
 EFIAPI\r
 InternalHexCharToUintn (\r
-  IN      CHAR16                    Char\r
+  IN      CHAR16  Char\r
   );\r
 \r
-\r
 /**\r
   Check if a Unicode character is a hexadecimal character.\r
 \r
@@ -528,10 +492,9 @@ InternalHexCharToUintn (
 BOOLEAN\r
 EFIAPI\r
 InternalIsHexaDecimalDigitCharacter (\r
-  IN      CHAR16                    Char\r
+  IN      CHAR16  Char\r
   );\r
 \r
-\r
 /**\r
   Check if a ASCII character is a decimal character.\r
 \r
@@ -548,30 +511,9 @@ InternalIsHexaDecimalDigitCharacter (
 BOOLEAN\r
 EFIAPI\r
 InternalAsciiIsDecimalDigitCharacter (\r
-  IN      CHAR8                     Char\r
-  );\r
-\r
-\r
-/**\r
-  Converts a lowercase Ascii character to upper one.\r
-\r
-  If Chr is lowercase Ascii character, then converts it to upper one.\r
-\r
-  If Value >= 0xA0, then ASSERT().\r
-  If (Value & 0x0F) >= 0x0A, then ASSERT().\r
-\r
-  @param  Chr   one Ascii character\r
-\r
-  @return The uppercase value of Ascii character\r
-\r
-**/\r
-CHAR8\r
-EFIAPI\r
-InternalBaseLibAsciiToUpper (\r
-  IN      CHAR8                     Chr\r
+  IN      CHAR8  Char\r
   );\r
 \r
-\r
 /**\r
   Check if a ASCII character is a hexadecimal character.\r
 \r
@@ -589,10 +531,9 @@ InternalBaseLibAsciiToUpper (
 BOOLEAN\r
 EFIAPI\r
 InternalAsciiIsHexaDecimalDigitCharacter (\r
-  IN      CHAR8                    Char\r
+  IN      CHAR8  Char\r
   );\r
 \r
-\r
 /**\r
   Convert a ASCII character to numerical value.\r
 \r
@@ -609,10 +550,9 @@ InternalAsciiIsHexaDecimalDigitCharacter (
 UINTN\r
 EFIAPI\r
 InternalAsciiHexCharToUintn (\r
-  IN      CHAR8                    Char\r
+  IN      CHAR8  Char\r
   );\r
 \r
-\r
 //\r
 // Ia32 and x64 specific functions\r
 //\r
@@ -630,7 +570,7 @@ InternalAsciiHexCharToUintn (
 VOID\r
 EFIAPI\r
 InternalX86ReadGdtr (\r
-  OUT     IA32_DESCRIPTOR           *Gdtr\r
+  OUT     IA32_DESCRIPTOR  *Gdtr\r
   );\r
 \r
 /**\r
@@ -645,7 +585,7 @@ InternalX86ReadGdtr (
 VOID\r
 EFIAPI\r
 InternalX86WriteGdtr (\r
-  IN      CONST IA32_DESCRIPTOR     *Gdtr\r
+  IN      CONST IA32_DESCRIPTOR  *Gdtr\r
   );\r
 \r
 /**\r
@@ -660,7 +600,7 @@ InternalX86WriteGdtr (
 VOID\r
 EFIAPI\r
 InternalX86ReadIdtr (\r
-  OUT     IA32_DESCRIPTOR           *Idtr\r
+  OUT     IA32_DESCRIPTOR  *Idtr\r
   );\r
 \r
 /**\r
@@ -675,7 +615,7 @@ InternalX86ReadIdtr (
 VOID\r
 EFIAPI\r
 InternalX86WriteIdtr (\r
-  IN      CONST IA32_DESCRIPTOR     *Idtr\r
+  IN      CONST IA32_DESCRIPTOR  *Idtr\r
   );\r
 \r
 /**\r
@@ -691,7 +631,7 @@ InternalX86WriteIdtr (
 VOID\r
 EFIAPI\r
 InternalX86FxSave (\r
-  OUT     IA32_FX_BUFFER            *Buffer\r
+  OUT     IA32_FX_BUFFER  *Buffer\r
   );\r
 \r
 /**\r
@@ -707,7 +647,7 @@ InternalX86FxSave (
 VOID\r
 EFIAPI\r
 InternalX86FxRestore (\r
-  IN      CONST IA32_FX_BUFFER      *Buffer\r
+  IN      CONST IA32_FX_BUFFER  *Buffer\r
   );\r
 \r
 /**\r
@@ -747,8 +687,8 @@ VOID
 EFIAPI\r
 InternalX86EnablePaging32 (\r
   IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,\r
-  IN      VOID                      *Context1,  OPTIONAL\r
-  IN      VOID                      *Context2,  OPTIONAL\r
+  IN      VOID                      *Context1   OPTIONAL,\r
+  IN      VOID                      *Context2   OPTIONAL,\r
   IN      VOID                      *NewStack\r
   );\r
 \r
@@ -786,8 +726,8 @@ VOID
 EFIAPI\r
 InternalX86DisablePaging32 (\r
   IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,\r
-  IN      VOID                      *Context1,  OPTIONAL\r
-  IN      VOID                      *Context2,  OPTIONAL\r
+  IN      VOID                      *Context1   OPTIONAL,\r
+  IN      VOID                      *Context2   OPTIONAL,\r
   IN      VOID                      *NewStack\r
   );\r
 \r
@@ -821,11 +761,11 @@ InternalX86DisablePaging32 (
 VOID\r
 EFIAPI\r
 InternalX86EnablePaging64 (\r
-  IN      UINT16                    Cs,\r
-  IN      UINT64                    EntryPoint,\r
-  IN      UINT64                    Context1,  OPTIONAL\r
-  IN      UINT64                    Context2,  OPTIONAL\r
-  IN      UINT64                    NewStack\r
+  IN      UINT16  Cs,\r
+  IN      UINT64  EntryPoint,\r
+  IN      UINT64  Context1   OPTIONAL,\r
+  IN      UINT64  Context2   OPTIONAL,\r
+  IN      UINT64  NewStack\r
   );\r
 \r
 /**\r
@@ -857,11 +797,11 @@ InternalX86EnablePaging64 (
 VOID\r
 EFIAPI\r
 InternalX86DisablePaging64 (\r
-  IN      UINT16                    Cs,\r
-  IN      UINT32                    EntryPoint,\r
-  IN      UINT32                    Context1,  OPTIONAL\r
-  IN      UINT32                    Context2,  OPTIONAL\r
-  IN      UINT32                    NewStack\r
+  IN      UINT16  Cs,\r
+  IN      UINT32  EntryPoint,\r
+  IN      UINT32  Context1   OPTIONAL,\r
+  IN      UINT32  Context2   OPTIONAL,\r
+  IN      UINT32  NewStack\r
   );\r
 \r
 /**\r
@@ -876,7 +816,7 @@ InternalX86DisablePaging64 (
 BOOLEAN\r
 EFIAPI\r
 InternalX86RdRand16 (\r
-  OUT     UINT16                    *Rand\r
+  OUT     UINT16  *Rand\r
   );\r
 \r
 /**\r
@@ -891,7 +831,7 @@ InternalX86RdRand16 (
 BOOLEAN\r
 EFIAPI\r
 InternalX86RdRand32 (\r
-  OUT     UINT32                    *Rand\r
+  OUT     UINT32  *Rand\r
   );\r
 \r
 /**\r
@@ -907,7 +847,7 @@ InternalX86RdRand32 (
 BOOLEAN\r
 EFIAPI\r
 InternalX86RdRand64  (\r
-  OUT     UINT64                    *Rand\r
+  OUT     UINT64  *Rand\r
   );\r
 \r
 #else\r