2 Declaration of internal functions in BaseLib.
4 Copyright (c) 2006, 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__
25 Shifts a 64-bit integer left between 0 and 63 bits. The low bits
26 are filled with zeros. The shifted value is returned.
28 This function shifts the 64-bit value Operand to the left by Count bits. The
29 low Count bits are set to zero. The shifted value is returned.
31 @param Operand The 64-bit operand to shift left.
32 @param Count The number of bits to shift left.
34 @return Operand << Count
39 InternalMathLShiftU64 (
45 Shifts a 64-bit integer right between 0 and 63 bits. This high bits
46 are filled with zeros. The shifted value is returned.
48 This function shifts the 64-bit value Operand to the right by Count bits. The
49 high Count bits are set to zero. The shifted value is returned.
51 @param Operand The 64-bit operand to shift right.
52 @param Count The number of bits to shift right.
54 @return Operand >> Count
59 InternalMathRShiftU64 (
65 Shifts a 64-bit integer right between 0 and 63 bits. The high bits
66 are filled with original integer's bit 63. The shifted value is returned.
68 This function shifts the 64-bit value Operand to the right by Count bits. The
69 high Count bits are set to bit 63 of Operand. The shifted value is returned.
71 @param Operand The 64-bit operand to shift right.
72 @param Count The number of bits to shift right.
74 @return Operand arithmetically shifted right by Count
79 InternalMathARShiftU64 (
85 Rotates a 64-bit integer left between 0 and 63 bits, filling
86 the low bits with the high bits that were rotated.
88 This function rotates the 64-bit value Operand to the left by Count bits. The
89 low Count bits are fill with the high Count bits of Operand. The rotated
92 @param Operand The 64-bit operand to rotate left.
93 @param Count The number of bits to rotate left.
95 @return Operand <<< Count
100 InternalMathLRotU64 (
106 Rotates a 64-bit integer right between 0 and 63 bits, filling
107 the high bits with the high low bits that were rotated.
109 This function rotates the 64-bit value Operand to the right by Count bits.
110 The high Count bits are fill with the low Count bits of Operand. The rotated
113 @param Operand The 64-bit operand to rotate right.
114 @param Count The number of bits to rotate right.
116 @return Operand >>> Count
121 InternalMathRRotU64 (
127 Switches the endianess of a 64-bit integer.
129 This function swaps the bytes in a 64-bit unsigned value to switch the value
130 from little endian to big endian or vice versa. The byte swapped value is
133 @param Operand A 64-bit unsigned value.
135 @return The byte swaped Operand.
140 InternalMathSwapBytes64 (
145 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer
146 and generates a 64-bit unsigned result.
148 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
149 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
150 bit unsigned result is returned.
152 @param Multiplicand A 64-bit unsigned value.
153 @param Multiplier A 32-bit unsigned value.
155 @return Multiplicand * Multiplier
160 InternalMathMultU64x32 (
161 IN UINT64 Multiplicand
,
166 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer
167 and generates a 64-bit unsigned result.
169 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
170 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
171 bit unsigned result is returned.
173 @param Multiplicand A 64-bit unsigned value.
174 @param Multiplier A 64-bit unsigned value.
176 @return Multiplicand * Multiplier
181 InternalMathMultU64x64 (
182 IN UINT64 Multiplicand
,
187 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and
188 generates a 64-bit unsigned result.
190 This function divides the 64-bit unsigned value Dividend by the 32-bit
191 unsigned value Divisor and generates a 64-bit unsigned quotient. This
192 function returns the 64-bit unsigned quotient.
194 @param Dividend A 64-bit unsigned value.
195 @param Divisor A 32-bit unsigned value.
197 @return Dividend / Divisor
202 InternalMathDivU64x32 (
208 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and
209 generates a 32-bit unsigned remainder.
211 This function divides the 64-bit unsigned value Dividend by the 32-bit
212 unsigned value Divisor and generates a 32-bit remainder. This function
213 returns the 32-bit unsigned remainder.
215 @param Dividend A 64-bit unsigned value.
216 @param Divisor A 32-bit unsigned value.
218 @return Dividend % Divisor
223 InternalMathModU64x32 (
229 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and
230 generates a 64-bit unsigned result and an optional 32-bit unsigned remainder.
232 This function divides the 64-bit unsigned value Dividend by the 32-bit
233 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
234 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
235 This function returns the 64-bit unsigned quotient.
237 @param Dividend A 64-bit unsigned value.
238 @param Divisor A 32-bit unsigned value.
239 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
240 optional and may be NULL.
242 @return Dividend / Divisor
247 InternalMathDivRemU64x32 (
250 OUT UINT32
*Remainder
254 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and
255 generates a 64-bit unsigned result and an optional 64-bit unsigned remainder.
257 This function divides the 64-bit unsigned value Dividend by the 64-bit
258 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
259 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
260 This function returns the 64-bit unsigned quotient.
262 @param Dividend A 64-bit unsigned value.
263 @param Divisor A 64-bit unsigned value.
264 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
265 optional and may be NULL.
267 @return Dividend / Divisor
272 InternalMathDivRemU64x64 (
275 OUT UINT64
*Remainder
279 Divides a 64-bit signed integer by a 64-bit signed integer and
280 generates a 64-bit signed result and a optional 64-bit signed remainder.
282 This function divides the 64-bit unsigned value Dividend by the 64-bit
283 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
284 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
285 This function returns the 64-bit unsigned quotient.
287 @param Dividend A 64-bit signed value.
288 @param Divisor A 64-bit signed value.
289 @param Remainder A pointer to a 64-bit signed value. This parameter is
290 optional and may be NULL.
292 @return Dividend / Divisor
296 InternalMathDivRemS64x64 (
299 OUT INT64
*Remainder OPTIONAL
303 Transfers control to a function starting with a new stack.
305 Transfers control to the function specified by EntryPoint using the new stack
306 specified by NewStack and passing in the parameters specified by Context1 and
307 Context2. Context1 and Context2 are optional and may be NULL. The function
308 EntryPoint must never return.
310 @param EntryPoint A pointer to function to call with the new stack.
311 @param Context1 A pointer to the context to pass into the EntryPoint
313 @param Context2 A pointer to the context to pass into the EntryPoint
315 @param NewStack A pointer to the new stack to use for the EntryPoint
321 InternalSwitchStack (
322 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
329 // Ia32 and x64 specific functions
333 Reads the current Global Descriptor Table Register(GDTR) descriptor.
335 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
336 function is only available on IA-32 and X64.
338 @param Gdtr Pointer to a GDTR descriptor.
343 InternalX86ReadGdtr (
344 OUT IA32_DESCRIPTOR
*Gdtr
348 Writes the current Global Descriptor Table Register (GDTR) descriptor.
350 Writes and the current GDTR descriptor specified by Gdtr. This function is
351 only available on IA-32 and X64.
353 @param Gdtr Pointer to a GDTR descriptor.
358 InternalX86WriteGdtr (
359 IN CONST IA32_DESCRIPTOR
*Gdtr
363 Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
365 Reads and returns the current IDTR descriptor and returns it in Idtr. This
366 function is only available on IA-32 and X64.
368 @param Idtr Pointer to a IDTR descriptor.
373 InternalX86ReadIdtr (
374 OUT IA32_DESCRIPTOR
*Idtr
378 Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
380 Writes the current IDTR descriptor and returns it in Idtr. This function is
381 only available on IA-32 and X64.
383 @param Idtr Pointer to a IDTR descriptor.
388 InternalX86WriteIdtr (
389 IN CONST IA32_DESCRIPTOR
*Idtr
393 Save the current floating point/SSE/SSE2 context to a buffer.
395 Saves the current floating point/SSE/SSE2 state to the buffer specified by
396 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
397 available on IA-32 and X64.
399 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
405 OUT IA32_FX_BUFFER
*Buffer
409 Restores the current floating point/SSE/SSE2 context from a buffer.
411 Restores the current floating point/SSE/SSE2 state from the buffer specified
412 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
413 only available on IA-32 and X64.
415 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
420 InternalX86FxRestore (
421 IN CONST IA32_FX_BUFFER
*Buffer
425 Enables the 32-bit paging mode on the CPU.
427 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
428 must be properly initialized prior to calling this service. This function
429 assumes the current execution mode is 32-bit protected mode. This function is
430 only available on IA-32. After the 32-bit paging mode is enabled, control is
431 transferred to the function specified by EntryPoint using the new stack
432 specified by NewStack and passing in the parameters specified by Context1 and
433 Context2. Context1 and Context2 are optional and may be NULL. The function
434 EntryPoint must never return.
436 There are a number of constraints that must be followed before calling this
438 1) Interrupts must be disabled.
439 2) The caller must be in 32-bit protected mode with flat descriptors. This
440 means all descriptors must have a base of 0 and a limit of 4GB.
441 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
443 4) CR3 must point to valid page tables that will be used once the transition
444 is complete, and those page tables must guarantee that the pages for this
445 function and the stack are identity mapped.
447 @param EntryPoint A pointer to function to call with the new stack after
449 @param Context1 A pointer to the context to pass into the EntryPoint
450 function as the first parameter after paging is enabled.
451 @param Context2 A pointer to the context to pass into the EntryPoint
452 function as the second parameter after paging is enabled.
453 @param NewStack A pointer to the new stack to use for the EntryPoint
454 function after paging is enabled.
459 InternalX86EnablePaging32 (
460 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
461 IN VOID
*Context1
, OPTIONAL
462 IN VOID
*Context2
, OPTIONAL
467 Disables the 32-bit paging mode on the CPU.
469 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
470 mode. This function assumes the current execution mode is 32-paged protected
471 mode. This function is only available on IA-32. After the 32-bit paging mode
472 is disabled, control is transferred to the function specified by EntryPoint
473 using the new stack specified by NewStack and passing in the parameters
474 specified by Context1 and Context2. Context1 and Context2 are optional and
475 may be NULL. The function EntryPoint must never return.
477 There are a number of constraints that must be followed before calling this
479 1) Interrupts must be disabled.
480 2) The caller must be in 32-bit paged mode.
481 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
482 4) CR3 must point to valid page tables that guarantee that the pages for
483 this function and the stack are identity mapped.
485 @param EntryPoint A pointer to function to call with the new stack after
487 @param Context1 A pointer to the context to pass into the EntryPoint
488 function as the first parameter after paging is disabled.
489 @param Context2 A pointer to the context to pass into the EntryPoint
490 function as the second parameter after paging is
492 @param NewStack A pointer to the new stack to use for the EntryPoint
493 function after paging is disabled.
498 InternalX86DisablePaging32 (
499 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
500 IN VOID
*Context1
, OPTIONAL
501 IN VOID
*Context2
, OPTIONAL
506 Enables the 64-bit paging mode on the CPU.
508 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
509 must be properly initialized prior to calling this service. This function
510 assumes the current execution mode is 32-bit protected mode with flat
511 descriptors. This function is only available on IA-32. After the 64-bit
512 paging mode is enabled, control is transferred to the function specified by
513 EntryPoint using the new stack specified by NewStack and passing in the
514 parameters specified by Context1 and Context2. Context1 and Context2 are
515 optional and may be 0. The function EntryPoint must never return.
517 @param Cs The 16-bit selector to load in the CS before EntryPoint
518 is called. The descriptor in the GDT that this selector
519 references must be setup for long mode.
520 @param EntryPoint The 64-bit virtual address of the function to call with
521 the new stack after paging is enabled.
522 @param Context1 The 64-bit virtual address of the context to pass into
523 the EntryPoint function as the first parameter after
525 @param Context2 The 64-bit virtual address of the context to pass into
526 the EntryPoint function as the second parameter after
528 @param NewStack The 64-bit virtual address of the new stack to use for
529 the EntryPoint function after paging is enabled.
534 InternalX86EnablePaging64 (
536 IN UINT64 EntryPoint
,
537 IN UINT64 Context1
, OPTIONAL
538 IN UINT64 Context2
, OPTIONAL
543 Disables the 64-bit paging mode on the CPU.
545 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
546 mode. This function assumes the current execution mode is 64-paging mode.
547 This function is only available on X64. After the 64-bit paging mode is
548 disabled, control is transferred to the function specified by EntryPoint
549 using the new stack specified by NewStack and passing in the parameters
550 specified by Context1 and Context2. Context1 and Context2 are optional and
551 may be 0. The function EntryPoint must never return.
553 @param Cs The 16-bit selector to load in the CS before EntryPoint
554 is called. The descriptor in the GDT that this selector
555 references must be setup for 32-bit protected mode.
556 @param EntryPoint The 64-bit virtual address of the function to call with
557 the new stack after paging is disabled.
558 @param Context1 The 64-bit virtual address of the context to pass into
559 the EntryPoint function as the first parameter after
561 @param Context2 The 64-bit virtual address of the context to pass into
562 the EntryPoint function as the second parameter after
564 @param NewStack The 64-bit virtual address of the new stack to use for
565 the EntryPoint function after paging is disabled.
570 InternalX86DisablePaging64 (
572 IN UINT32 EntryPoint
,
573 IN UINT32 Context1
, OPTIONAL
574 IN UINT32 Context2
, OPTIONAL
579 Worker function that locates the Node in the List
581 By searching the List, finds the location of the Node in List. At the same time,
582 verifies the validity of this list.
584 If List is NULL, then ASSERT().
585 If List->ForwardLink is NULL, then ASSERT().
586 If List->backLink is NULL, then ASSERT().
587 If Node is NULL, then ASSERT();
588 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
589 of nodes in ListHead, including the ListHead node, is greater than or
590 equal to PcdMaximumLinkedListLength, then ASSERT().
592 @param List A pointer to a node in a linked list.
593 @param Node A pointer to one nod.
595 @retval TRUE Node is in List
596 @retval FALSE Node isn't in List, or List is invalid
601 IN CONST LIST_ENTRY
*List
,
602 IN CONST LIST_ENTRY
*Node
606 Performs an atomic increment of an 32-bit unsigned integer.
608 Performs an atomic increment of the 32-bit unsigned integer specified by
609 Value and returns the incremented value. The increment operation must be
610 performed using MP safe mechanisms. The state of the return value is not
611 guaranteed to be MP safe.
613 @param Value A pointer to the 32-bit value to increment.
615 @return The incremented value.
620 InternalSyncIncrement (
621 IN
volatile UINT32
*Value
625 Performs an atomic decrement of an 32-bit unsigned integer.
627 Performs an atomic decrement of the 32-bit unsigned integer specified by
628 Value and returns the decrement value. The decrement operation must be
629 performed using MP safe mechanisms. The state of the return value is not
630 guaranteed to be MP safe.
632 @param Value A pointer to the 32-bit value to decrement.
634 @return The decrement value.
639 InternalSyncDecrement (
640 IN
volatile UINT32
*Value
644 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
646 Performs an atomic compare exchange operation on the 32-bit unsigned integer
647 specified by Value. If Value is equal to CompareValue, then Value is set to
648 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
649 then Value is returned. The compare exchange operation must be performed using
652 @param Value A pointer to the 32-bit value for the compare exchange
654 @param CompareValue 32-bit value used in compare operation.
655 @param ExchangeValue 32-bit value used in exchange operation.
657 @return The original *Value before exchange.
662 InternalSyncCompareExchange32 (
663 IN
volatile UINT32
*Value
,
664 IN UINT32 CompareValue
,
665 IN UINT32 ExchangeValue
669 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
671 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
672 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
673 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
674 The compare exchange operation must be performed using MP safe mechanisms.
676 @param Value A pointer to the 64-bit value for the compare exchange
678 @param CompareValue 64-bit value used in compare operation.
679 @param ExchangeValue 64-bit value used in exchange operation.
681 @return The original *Value before exchange.
686 InternalSyncCompareExchange64 (
687 IN
volatile UINT64
*Value
,
688 IN UINT64 CompareValue
,
689 IN UINT64 ExchangeValue
693 Worker function that returns a bit field from Operand
695 Returns the bitfield specified by the StartBit and the EndBit from Operand.
697 @param Operand Operand on which to perform the bitfield operation.
698 @param StartBit The ordinal of the least significant bit in the bit field.
699 @param EndBit The ordinal of the most significant bit in the bit field.
701 @return The bit field read.
706 IN
unsigned int Operand
,
712 Worker function that reads a bit field from Operand, performs a bitwise OR,
713 and returns the result.
715 Performs a bitwise OR between the bit field specified by StartBit and EndBit
716 in Operand and the value specified by AndData. All other bits in Operand are
717 preserved. The new value is returned.
719 @param Operand Operand on which to perform the bitfield operation.
720 @param StartBit The ordinal of the least significant bit in the bit field.
721 @param EndBit The ordinal of the most significant bit in the bit field.
722 @param OrData The value to OR with the read value from the value
724 @return The new value.
729 IN
unsigned int Operand
,
732 IN
unsigned int OrData
736 Worker function that reads a bit field from Operand, performs a bitwise AND,
737 and returns the result.
739 Performs a bitwise AND between the bit field specified by StartBit and EndBit
740 in Operand and the value specified by AndData. All other bits in Operand are
741 preserved. The new value is returned.
743 @param Operand Operand on which to perform the bitfield operation.
744 @param StartBit The ordinal of the least significant bit in the bit field.
745 @param EndBit The ordinal of the most significant bit in the bit field.
746 @param AndData The value to And with the read value from the value
748 @return The new value.
753 IN
unsigned int Operand
,
756 IN
unsigned int AndData
760 Worker function that checks ASSERT condition for JumpBuffer
762 Checks ASSERT condition for JumpBuffer.
764 If JumpBuffer is NULL, then ASSERT().
765 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
767 @param JumpBuffer A pointer to CPU context buffer.
771 InternalAssertJumpBuffer (
772 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
776 Restores the CPU context that was saved with SetJump().
778 Restores the CPU context from the buffer specified by JumpBuffer.
779 This function never returns to the caller.
780 Instead is resumes execution based on the state of JumpBuffer.
782 @param JumpBuffer A pointer to CPU context buffer.
783 @param Value The value to return when the SetJump() context is restored.
789 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,