2 Declaration of internal functions in BaseLib.
4 Copyright (c) 2006 - 2007, Intel Corporation<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: BaseLibInternals.h
17 #ifndef __BASE_LIB_INTERNALS__
18 #define __BASE_LIB_INTERNALS__
20 #define QUIENT_MAX_UINTN_DIVIDED_BY_10 ((UINTN) -1 / 10)
21 #define REMINDER_MAX_UINTN_DIVIDED_BY_10 ((UINTN) -1 % 10)
23 #define QUIENT_MAX_UINTN_DIVIDED_BY_16 ((UINTN) -1 / 16)
24 #define REMINDER_MAX_UINTN_DIVIDED_BY_16 ((UINTN) -1 % 16)
26 #define QUIENT_MAX_UINT64_DIVIDED_BY_10 ((UINT64) -1 / 10)
27 #define REMINDER_MAX_UINT64_DIVIDED_BY_10 ((UINT64) -1 % 10)
29 #define QUIENT_MAX_UINT64_DIVIDED_BY_16 ((UINT64) -1 / 16)
30 #define REMINDER_MAX_UINT64_DIVIDED_BY_16 ((UINT64) -1 % 16)
37 Shifts a 64-bit integer left between 0 and 63 bits. The low bits
38 are filled with zeros. The shifted value is returned.
40 This function shifts the 64-bit value Operand to the left by Count bits. The
41 low Count bits are set to zero. The shifted value is returned.
43 @param Operand The 64-bit operand to shift left.
44 @param Count The number of bits to shift left.
46 @return Operand << Count
51 InternalMathLShiftU64 (
57 Shifts a 64-bit integer right between 0 and 63 bits. This high bits
58 are filled with zeros. The shifted value is returned.
60 This function shifts the 64-bit value Operand to the right by Count bits. The
61 high Count bits are set to zero. The shifted value is returned.
63 @param Operand The 64-bit operand to shift right.
64 @param Count The number of bits to shift right.
66 @return Operand >> Count
71 InternalMathRShiftU64 (
77 Shifts a 64-bit integer right between 0 and 63 bits. The high bits
78 are filled with original integer's bit 63. The shifted value is returned.
80 This function shifts the 64-bit value Operand to the right by Count bits. The
81 high Count bits are set to bit 63 of Operand. The shifted value is returned.
83 @param Operand The 64-bit operand to shift right.
84 @param Count The number of bits to shift right.
86 @return Operand arithmetically shifted right by Count
91 InternalMathARShiftU64 (
97 Rotates a 64-bit integer left between 0 and 63 bits, filling
98 the low bits with the high bits that were rotated.
100 This function rotates the 64-bit value Operand to the left by Count bits. The
101 low Count bits are fill with the high Count bits of Operand. The rotated
104 @param Operand The 64-bit operand to rotate left.
105 @param Count The number of bits to rotate left.
107 @return Operand <<< Count
112 InternalMathLRotU64 (
118 Rotates a 64-bit integer right between 0 and 63 bits, filling
119 the high bits with the high low bits that were rotated.
121 This function rotates the 64-bit value Operand to the right by Count bits.
122 The high Count bits are fill with the low Count bits of Operand. The rotated
125 @param Operand The 64-bit operand to rotate right.
126 @param Count The number of bits to rotate right.
128 @return Operand >>> Count
133 InternalMathRRotU64 (
139 Switches the endianess of a 64-bit integer.
141 This function swaps the bytes in a 64-bit unsigned value to switch the value
142 from little endian to big endian or vice versa. The byte swapped value is
145 @param Operand A 64-bit unsigned value.
147 @return The byte swaped Operand.
152 InternalMathSwapBytes64 (
157 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer
158 and generates a 64-bit unsigned result.
160 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
161 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
162 bit unsigned result is returned.
164 @param Multiplicand A 64-bit unsigned value.
165 @param Multiplier A 32-bit unsigned value.
167 @return Multiplicand * Multiplier
172 InternalMathMultU64x32 (
173 IN UINT64 Multiplicand
,
178 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer
179 and generates a 64-bit unsigned result.
181 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
182 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
183 bit unsigned result is returned.
185 @param Multiplicand A 64-bit unsigned value.
186 @param Multiplier A 64-bit unsigned value.
188 @return Multiplicand * Multiplier
193 InternalMathMultU64x64 (
194 IN UINT64 Multiplicand
,
199 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and
200 generates a 64-bit unsigned result.
202 This function divides the 64-bit unsigned value Dividend by the 32-bit
203 unsigned value Divisor and generates a 64-bit unsigned quotient. This
204 function returns the 64-bit unsigned quotient.
206 @param Dividend A 64-bit unsigned value.
207 @param Divisor A 32-bit unsigned value.
209 @return Dividend / Divisor
214 InternalMathDivU64x32 (
220 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and
221 generates a 32-bit unsigned remainder.
223 This function divides the 64-bit unsigned value Dividend by the 32-bit
224 unsigned value Divisor and generates a 32-bit remainder. This function
225 returns the 32-bit unsigned remainder.
227 @param Dividend A 64-bit unsigned value.
228 @param Divisor A 32-bit unsigned value.
230 @return Dividend % Divisor
235 InternalMathModU64x32 (
241 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and
242 generates a 64-bit unsigned result and an optional 32-bit unsigned remainder.
244 This function divides the 64-bit unsigned value Dividend by the 32-bit
245 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
246 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
247 This function returns the 64-bit unsigned quotient.
249 @param Dividend A 64-bit unsigned value.
250 @param Divisor A 32-bit unsigned value.
251 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
252 optional and may be NULL.
254 @return Dividend / Divisor
259 InternalMathDivRemU64x32 (
262 OUT UINT32
*Remainder
266 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and
267 generates a 64-bit unsigned result and an optional 64-bit unsigned remainder.
269 This function divides the 64-bit unsigned value Dividend by the 64-bit
270 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
271 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
272 This function returns the 64-bit unsigned quotient.
274 @param Dividend A 64-bit unsigned value.
275 @param Divisor A 64-bit unsigned value.
276 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
277 optional and may be NULL.
279 @return Dividend / Divisor
284 InternalMathDivRemU64x64 (
287 OUT UINT64
*Remainder
291 Divides a 64-bit signed integer by a 64-bit signed integer and
292 generates a 64-bit signed result and a optional 64-bit signed remainder.
294 This function divides the 64-bit unsigned value Dividend by the 64-bit
295 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
296 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
297 This function returns the 64-bit unsigned quotient.
299 @param Dividend A 64-bit signed value.
300 @param Divisor A 64-bit signed value.
301 @param Remainder A pointer to a 64-bit signed value. This parameter is
302 optional and may be NULL.
304 @return Dividend / Divisor
308 InternalMathDivRemS64x64 (
311 OUT INT64
*Remainder OPTIONAL
315 Transfers control to a function starting with a new stack.
317 Transfers control to the function specified by EntryPoint using the
318 new stack specified by NewStack and passing in the parameters specified
319 by Context1 and Context2. Context1 and Context2 are optional and may
320 be NULL. The function EntryPoint must never return.
321 Marker will be ignored on IA-32, x64, and EBC.
322 IPF CPUs expect one additional parameter of type VOID * that specifies
323 the new backing store pointer.
325 If EntryPoint is NULL, then ASSERT().
326 If NewStack is NULL, then ASSERT().
328 @param EntryPoint A pointer to function to call with the new stack.
329 @param Context1 A pointer to the context to pass into the EntryPoint
331 @param Context2 A pointer to the context to pass into the EntryPoint
333 @param NewStack A pointer to the new stack to use for the EntryPoint
335 @param Marker VA_LIST marker for the variable argument list.
340 InternalSwitchStack (
341 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
342 IN VOID
*Context1
, OPTIONAL
343 IN VOID
*Context2
, OPTIONAL
350 Worker function that locates the Node in the List
352 By searching the List, finds the location of the Node in List. At the same time,
353 verifies the validity of this list.
355 If List is NULL, then ASSERT().
356 If List->ForwardLink is NULL, then ASSERT().
357 If List->backLink is NULL, then ASSERT().
358 If Node is NULL, then ASSERT();
359 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
360 of nodes in ListHead, including the ListHead node, is greater than or
361 equal to PcdMaximumLinkedListLength, then ASSERT().
363 @param List A pointer to a node in a linked list.
364 @param Node A pointer to one nod.
366 @retval TRUE Node is in List
367 @retval FALSE Node isn't in List, or List is invalid
372 IN CONST LIST_ENTRY
*List
,
373 IN CONST LIST_ENTRY
*Node
378 Performs an atomic increment of an 32-bit unsigned integer.
380 Performs an atomic increment of the 32-bit unsigned integer specified by
381 Value and returns the incremented value. The increment operation must be
382 performed using MP safe mechanisms. The state of the return value is not
383 guaranteed to be MP safe.
385 @param Value A pointer to the 32-bit value to increment.
387 @return The incremented value.
392 InternalSyncIncrement (
393 IN
volatile UINT32
*Value
398 Performs an atomic decrement of an 32-bit unsigned integer.
400 Performs an atomic decrement of the 32-bit unsigned integer specified by
401 Value and returns the decrement value. The decrement operation must be
402 performed using MP safe mechanisms. The state of the return value is not
403 guaranteed to be MP safe.
405 @param Value A pointer to the 32-bit value to decrement.
407 @return The decrement value.
412 InternalSyncDecrement (
413 IN
volatile UINT32
*Value
418 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
420 Performs an atomic compare exchange operation on the 32-bit unsigned integer
421 specified by Value. If Value is equal to CompareValue, then Value is set to
422 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
423 then Value is returned. The compare exchange operation must be performed using
426 @param Value A pointer to the 32-bit value for the compare exchange
428 @param CompareValue 32-bit value used in compare operation.
429 @param ExchangeValue 32-bit value used in exchange operation.
431 @return The original *Value before exchange.
436 InternalSyncCompareExchange32 (
437 IN
volatile UINT32
*Value
,
438 IN UINT32 CompareValue
,
439 IN UINT32 ExchangeValue
444 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
446 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
447 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
448 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
449 The compare exchange operation must be performed using MP safe mechanisms.
451 @param Value A pointer to the 64-bit value for the compare exchange
453 @param CompareValue 64-bit value used in compare operation.
454 @param ExchangeValue 64-bit value used in exchange operation.
456 @return The original *Value before exchange.
461 InternalSyncCompareExchange64 (
462 IN
volatile UINT64
*Value
,
463 IN UINT64 CompareValue
,
464 IN UINT64 ExchangeValue
469 Worker function that returns a bit field from Operand
471 Returns the bitfield specified by the StartBit and the EndBit from Operand.
473 @param Operand Operand on which to perform the bitfield operation.
474 @param StartBit The ordinal of the least significant bit in the bit field.
475 @param EndBit The ordinal of the most significant bit in the bit field.
477 @return The bit field read.
482 IN
unsigned int Operand
,
489 Worker function that reads a bit field from Operand, performs a bitwise OR,
490 and returns the result.
492 Performs a bitwise OR between the bit field specified by StartBit and EndBit
493 in Operand and the value specified by AndData. All other bits in Operand are
494 preserved. The new value is returned.
496 @param Operand Operand on which to perform the bitfield operation.
497 @param StartBit The ordinal of the least significant bit in the bit field.
498 @param EndBit The ordinal of the most significant bit in the bit field.
499 @param OrData The value to OR with the read value from the value
501 @return The new value.
506 IN
unsigned int Operand
,
509 IN
unsigned int OrData
514 Worker function that reads a bit field from Operand, performs a bitwise AND,
515 and returns the result.
517 Performs a bitwise AND between the bit field specified by StartBit and EndBit
518 in Operand and the value specified by AndData. All other bits in Operand are
519 preserved. The new value is returned.
521 @param Operand Operand on which to perform the bitfield operation.
522 @param StartBit The ordinal of the least significant bit in the bit field.
523 @param EndBit The ordinal of the most significant bit in the bit field.
524 @param AndData The value to And with the read value from the value
526 @return The new value.
531 IN
unsigned int Operand
,
534 IN
unsigned int AndData
539 Worker function that checks ASSERT condition for JumpBuffer
541 Checks ASSERT condition for JumpBuffer.
543 If JumpBuffer is NULL, then ASSERT().
544 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
546 @param JumpBuffer A pointer to CPU context buffer.
550 InternalAssertJumpBuffer (
551 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
556 Restores the CPU context that was saved with SetJump().
558 Restores the CPU context from the buffer specified by JumpBuffer.
559 This function never returns to the caller.
560 Instead is resumes execution based on the state of JumpBuffer.
562 @param JumpBuffer A pointer to CPU context buffer.
563 @param Value The value to return when the SetJump() context is restored.
569 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
575 // Ia32 and x64 specific functions
577 #if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
580 Reads the current Global Descriptor Table Register(GDTR) descriptor.
582 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
583 function is only available on IA-32 and X64.
585 @param Gdtr Pointer to a GDTR descriptor.
590 InternalX86ReadGdtr (
591 OUT IA32_DESCRIPTOR
*Gdtr
595 Writes the current Global Descriptor Table Register (GDTR) descriptor.
597 Writes and the current GDTR descriptor specified by Gdtr. This function is
598 only available on IA-32 and X64.
600 @param Gdtr Pointer to a GDTR descriptor.
605 InternalX86WriteGdtr (
606 IN CONST IA32_DESCRIPTOR
*Gdtr
610 Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
612 Reads and returns the current IDTR descriptor and returns it in Idtr. This
613 function is only available on IA-32 and X64.
615 @param Idtr Pointer to a IDTR descriptor.
620 InternalX86ReadIdtr (
621 OUT IA32_DESCRIPTOR
*Idtr
625 Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
627 Writes the current IDTR descriptor and returns it in Idtr. This function is
628 only available on IA-32 and X64.
630 @param Idtr Pointer to a IDTR descriptor.
635 InternalX86WriteIdtr (
636 IN CONST IA32_DESCRIPTOR
*Idtr
640 Save the current floating point/SSE/SSE2 context to a buffer.
642 Saves the current floating point/SSE/SSE2 state to the buffer specified by
643 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
644 available on IA-32 and X64.
646 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
652 OUT IA32_FX_BUFFER
*Buffer
656 Restores the current floating point/SSE/SSE2 context from a buffer.
658 Restores the current floating point/SSE/SSE2 state from the buffer specified
659 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
660 only available on IA-32 and X64.
662 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
667 InternalX86FxRestore (
668 IN CONST IA32_FX_BUFFER
*Buffer
672 Enables the 32-bit paging mode on the CPU.
674 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
675 must be properly initialized prior to calling this service. This function
676 assumes the current execution mode is 32-bit protected mode. This function is
677 only available on IA-32. After the 32-bit paging mode is enabled, control is
678 transferred to the function specified by EntryPoint using the new stack
679 specified by NewStack and passing in the parameters specified by Context1 and
680 Context2. Context1 and Context2 are optional and may be NULL. The function
681 EntryPoint must never return.
683 There are a number of constraints that must be followed before calling this
685 1) Interrupts must be disabled.
686 2) The caller must be in 32-bit protected mode with flat descriptors. This
687 means all descriptors must have a base of 0 and a limit of 4GB.
688 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
690 4) CR3 must point to valid page tables that will be used once the transition
691 is complete, and those page tables must guarantee that the pages for this
692 function and the stack are identity mapped.
694 @param EntryPoint A pointer to function to call with the new stack after
696 @param Context1 A pointer to the context to pass into the EntryPoint
697 function as the first parameter after paging is enabled.
698 @param Context2 A pointer to the context to pass into the EntryPoint
699 function as the second parameter after paging is enabled.
700 @param NewStack A pointer to the new stack to use for the EntryPoint
701 function after paging is enabled.
706 InternalX86EnablePaging32 (
707 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
708 IN VOID
*Context1
, OPTIONAL
709 IN VOID
*Context2
, OPTIONAL
714 Disables the 32-bit paging mode on the CPU.
716 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
717 mode. This function assumes the current execution mode is 32-paged protected
718 mode. This function is only available on IA-32. After the 32-bit paging mode
719 is disabled, control is transferred to the function specified by EntryPoint
720 using the new stack specified by NewStack and passing in the parameters
721 specified by Context1 and Context2. Context1 and Context2 are optional and
722 may be NULL. The function EntryPoint must never return.
724 There are a number of constraints that must be followed before calling this
726 1) Interrupts must be disabled.
727 2) The caller must be in 32-bit paged mode.
728 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
729 4) CR3 must point to valid page tables that guarantee that the pages for
730 this function and the stack are identity mapped.
732 @param EntryPoint A pointer to function to call with the new stack after
734 @param Context1 A pointer to the context to pass into the EntryPoint
735 function as the first parameter after paging is disabled.
736 @param Context2 A pointer to the context to pass into the EntryPoint
737 function as the second parameter after paging is
739 @param NewStack A pointer to the new stack to use for the EntryPoint
740 function after paging is disabled.
745 InternalX86DisablePaging32 (
746 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
747 IN VOID
*Context1
, OPTIONAL
748 IN VOID
*Context2
, OPTIONAL
753 Enables the 64-bit paging mode on the CPU.
755 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
756 must be properly initialized prior to calling this service. This function
757 assumes the current execution mode is 32-bit protected mode with flat
758 descriptors. This function is only available on IA-32. After the 64-bit
759 paging mode is enabled, control is transferred to the function specified by
760 EntryPoint using the new stack specified by NewStack and passing in the
761 parameters specified by Context1 and Context2. Context1 and Context2 are
762 optional and may be 0. The function EntryPoint must never return.
764 @param Cs The 16-bit selector to load in the CS before EntryPoint
765 is called. The descriptor in the GDT that this selector
766 references must be setup for long mode.
767 @param EntryPoint The 64-bit virtual address of the function to call with
768 the new stack after paging is enabled.
769 @param Context1 The 64-bit virtual address of the context to pass into
770 the EntryPoint function as the first parameter after
772 @param Context2 The 64-bit virtual address of the context to pass into
773 the EntryPoint function as the second parameter after
775 @param NewStack The 64-bit virtual address of the new stack to use for
776 the EntryPoint function after paging is enabled.
781 InternalX86EnablePaging64 (
783 IN UINT64 EntryPoint
,
784 IN UINT64 Context1
, OPTIONAL
785 IN UINT64 Context2
, OPTIONAL
790 Disables the 64-bit paging mode on the CPU.
792 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
793 mode. This function assumes the current execution mode is 64-paging mode.
794 This function is only available on X64. After the 64-bit paging mode is
795 disabled, control is transferred to the function specified by EntryPoint
796 using the new stack specified by NewStack and passing in the parameters
797 specified by Context1 and Context2. Context1 and Context2 are optional and
798 may be 0. The function EntryPoint must never return.
800 @param Cs The 16-bit selector to load in the CS before EntryPoint
801 is called. The descriptor in the GDT that this selector
802 references must be setup for 32-bit protected mode.
803 @param EntryPoint The 64-bit virtual address of the function to call with
804 the new stack after paging is disabled.
805 @param Context1 The 64-bit virtual address of the context to pass into
806 the EntryPoint function as the first parameter after
808 @param Context2 The 64-bit virtual address of the context to pass into
809 the EntryPoint function as the second parameter after
811 @param NewStack The 64-bit virtual address of the new stack to use for
812 the EntryPoint function after paging is disabled.
817 InternalX86DisablePaging64 (
819 IN UINT32 EntryPoint
,
820 IN UINT32 Context1
, OPTIONAL
821 IN UINT32 Context2
, OPTIONAL
826 #elif defined (MDE_CPU_IPF)
829 // IPF specific functions
833 Transfers control to a function starting with a new stack.
835 Transfers control to the function specified by EntryPoint using the new stack
836 specified by NewStack and passing in the parameters specified by Context1 and
837 Context2. Context1 and Context2 are optional and may be NULL. The function
838 EntryPoint must never return.
840 If EntryPoint is NULL, then ASSERT().
841 If NewStack is NULL, then ASSERT().
843 @param EntryPoint A pointer to function to call with the new stack.
844 @param Context1 A pointer to the context to pass into the EntryPoint
846 @param Context2 A pointer to the context to pass into the EntryPoint
848 @param NewStack A pointer to the new stack to use for the EntryPoint
850 @param NewBsp A pointer to the new memory location for RSE backing
856 AsmSwitchStackAndBackingStore (
857 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
858 IN VOID
*Context1
, OPTIONAL
859 IN VOID
*Context2
, OPTIONAL