X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FBaseLib.h;h=0c16c4813058fb11e688e115ea0a97c27aa20c0f;hb=fc30687f39436f5b5e00396a5161b30b70db8277;hp=6961c0a229a70f8cf70a27d52082d2bd9b7c608e;hpb=ac644614683362804223844048c5be1a2adfa6b7;p=mirror_edk2.git diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index 6961c0a229..0c16c48130 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -20,15 +20,15 @@ // These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER // -// -// SPIN_LOCK -// +/// +/// SPIN_LOCK +/// typedef volatile UINTN SPIN_LOCK; #if defined (MDE_CPU_IA32) -// -// IA32 context buffer used by SetJump() and LongJump() -// +/// +/// IA32 context buffer used by SetJump() and LongJump() +/// typedef struct { UINT32 Ebx; UINT32 Esi; @@ -42,9 +42,9 @@ typedef struct { #elif defined (MDE_CPU_IPF) -// -// IPF context buffer used by SetJump() and LongJump() -// +/// +/// IPF context buffer used by SetJump() and LongJump() +/// typedef struct { UINT64 F2[2]; UINT64 F3[2]; @@ -89,9 +89,9 @@ typedef struct { #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10 #elif defined (MDE_CPU_X64) -// -// X64 context buffer used by SetJump() and LongJump() -// +/// +/// X64 context buffer used by SetJump() and LongJump() +/// typedef struct { UINT64 Rbx; UINT64 Rsp; @@ -108,9 +108,9 @@ typedef struct { #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8 #elif defined (MDE_CPU_EBC) -// -// EBC context buffer used by SetJump() and LongJump() -// +/// +/// EBC context buffer used by SetJump() and LongJump() +/// typedef struct { UINT64 R0; UINT64 R1; @@ -471,7 +471,7 @@ StrStr ( @param String Pointer to a Null-terminated Unicode string. - @retval UINTN + @retval Value translated from String. **/ UINTN @@ -511,7 +511,7 @@ StrDecimalToUintn ( @param String Pointer to a Null-terminated Unicode string. - @retval UINT64 + @retval Value translated from String. **/ UINT64 @@ -553,7 +553,7 @@ StrDecimalToUint64 ( @param String Pointer to a Null-terminated Unicode string. - @retval UINTN + @retval Value translated from String. **/ UINTN @@ -595,7 +595,7 @@ StrHexToUintn ( @param String Pointer to a Null-terminated Unicode string. - @retval UINT64 + @retval Value translated from String. **/ UINT64 @@ -1127,7 +1127,7 @@ AsciiStrStr ( @param String Pointer to a Null-terminated ASCII string. - @retval UINTN + @retval Value translated from String. **/ UINTN @@ -1164,7 +1164,7 @@ AsciiStrDecimalToUintn ( @param String Pointer to a Null-terminated ASCII string. - @retval UINT64 + @retval Value translated from String. **/ UINT64 @@ -1205,7 +1205,7 @@ AsciiStrDecimalToUint64 ( @param String Pointer to a Null-terminated ASCII string. - @retval UINTN + @retval Value translated from String. **/ UINTN @@ -1246,7 +1246,7 @@ AsciiStrHexToUintn ( @param String Pointer to a Null-terminated ASCII string. - @retval UINT64 + @retval Value translated from String. **/ UINT64 @@ -1595,6 +1595,8 @@ IsNodeAtEnd ( @param FirstEntry A pointer to a node in a linked list. @param SecondEntry A pointer to another node in the same linked list. + + @return SecondEntry **/ LIST_ENTRY * @@ -2237,7 +2239,7 @@ WriteUnaligned16 ( @param Buffer Pointer to a 24-bit value that may be unaligned. - @return The value read. + @return The value read from Buffer. **/ UINT32 @@ -2259,7 +2261,7 @@ ReadUnaligned24 ( @param Buffer Pointer to a 24-bit value that may be unaligned. @param Value 24-bit value to write to Buffer. - @return The value written. + @return The value written to Buffer. **/ UINT32 @@ -2280,7 +2282,7 @@ WriteUnaligned24 ( @param Uint32 Pointer to a 32-bit value that may be unaligned. - @return *Uint32 + @return Value read from Uint32 **/ UINT32 @@ -2302,7 +2304,7 @@ ReadUnaligned32 ( @param Uint32 Pointer to a 32-bit value that may be unaligned. @param Value 32-bit value to write to Buffer. - @return Value + @return Value written to Uint32. **/ UINT32 @@ -2323,7 +2325,7 @@ WriteUnaligned32 ( @param Uint64 Pointer to a 64-bit value that may be unaligned. - @return *Uint64 + @return Value read from Uint64. **/ UINT64 @@ -2345,7 +2347,7 @@ ReadUnaligned64 ( @param Uint64 Pointer to a 64-bit value that may be unaligned. @param Value 64-bit value to write to Buffer. - @return Value + @return Value written to Uint64. **/ UINT64 @@ -3048,7 +3050,7 @@ GetSpinLockProperties ( @param SpinLock A pointer to the spin lock to initialize to the released state. - @return SpinLock + @return SpinLock in release state. **/ SPIN_LOCK * @@ -3075,7 +3077,7 @@ InitializeSpinLock ( @param SpinLock A pointer to the spin lock to place in the acquired state. - @return SpinLock + @return SpinLock accquired lock. **/ SPIN_LOCK * @@ -3120,7 +3122,7 @@ AcquireSpinLockOrFail ( @param SpinLock A pointer to the spin lock to release. - @return SpinLock + @return SpinLock released lock. **/ SPIN_LOCK * @@ -3245,6 +3247,7 @@ InterlockedCompareExchange64 ( @param CompareValue Pointer value used in compare operation. @param ExchangeValue Pointer value used in exchange operation. + @return The original *Value before exchange. **/ VOID * EFIAPI @@ -3482,7 +3485,7 @@ CalculateCheckSum64 ( // typedef VOID -(EFIAPI *SWITCH_STACK_ENTRY_POINT) ( +(EFIAPI *SWITCH_STACK_ENTRY_POINT)( IN VOID *Context1, OPTIONAL IN VOID *Context2 OPTIONAL ); @@ -3552,8 +3555,6 @@ LongJump ( /** Enables CPU interrupts. - Enables CPU interrupts. - **/ VOID EFIAPI @@ -3565,8 +3566,6 @@ EnableInterrupts ( /** Disables CPU interrupts. - Disables CPU interrupts. - **/ VOID EFIAPI @@ -3579,9 +3578,6 @@ DisableInterrupts ( Disables CPU interrupts and returns the interrupt state prior to the disable operation. - Disables CPU interrupts and returns the interrupt state prior to the disable - operation. - @retval TRUE CPU interrupts were enabled on entry to this call. @retval FALSE CPU interrupts were disabled on entry to this call. @@ -3597,9 +3593,6 @@ SaveAndDisableInterrupts ( Enables CPU interrupts for the smallest window required to capture any pending interrupts. - Enables CPU interrupts for the smallest window required to capture any - pending interrupts. - **/ VOID EFIAPI @@ -3611,8 +3604,8 @@ EnableDisableInterrupts ( /** Retrieves the current CPU interrupt state. - Retrieves the current CPU interrupt state. Returns TRUE is interrupts are - currently enabled. Otherwise returns FALSE. + Returns TRUE is interrupts are currently enabled. Otherwise + returns FALSE. @retval TRUE CPU interrupts are enabled. @retval FALSE CPU interrupts are disabled. @@ -3682,6 +3675,8 @@ CpuPause ( function. @param NewStack A pointer to the new stack to use for the EntryPoint function. + @param ... Extended parameters. + **/ VOID @@ -4937,9 +4932,9 @@ AsmSwitchStackAndBackingStore ( @param PalEntryPoint The entry point address of PAL. The address in ar.kr5 would be used if this parameter were NULL on input. @param Arg1 The first argument of a PAL call. - @param Arg1 The second argument of a PAL call. - @param Arg1 The third argument of a PAL call. - @param Arg1 The fourth argument of a PAL call. + @param Arg2 The second argument of a PAL call. + @param Arg3 The third argument of a PAL call. + @param Arg4 The fourth argument of a PAL call. @return The values returned in r8, r9, r10 and r11. @@ -7068,7 +7063,7 @@ AsmDisablePaging32 ( If EntryPoint is 0, then ASSERT(). If NewStack is 0, then ASSERT(). - @param Cs The 16-bit selector to load in the CS before EntryPoint + @param CodeSelector The 16-bit selector to load in the CS before EntryPoint is called. The descriptor in the GDT that this selector references must be setup for long mode. @param EntryPoint The 64-bit virtual address of the function to call with @@ -7109,7 +7104,7 @@ AsmEnablePaging64 ( If EntryPoint is 0, then ASSERT(). If NewStack is 0, then ASSERT(). - @param Cs The 16-bit selector to load in the CS before EntryPoint + @param CodeSelector The 16-bit selector to load in the CS before EntryPoint is called. The descriptor in the GDT that this selector references must be setup for 32-bit protected mode. @param EntryPoint The 64-bit virtual address of the function to call with