/** @file\r
Bit field functions of BaseLib.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2010, 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
+ 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
#include "BaseLibInternals.h"\r
\r
/**\r
- Worker function that returns a bit field from Operand\r
+ Worker function that returns a bit field from Operand.\r
\r
Returns the bitfield specified by the StartBit and the EndBit from Operand.\r
\r
**/\r
UINTN\r
EFIAPI\r
-BitFieldReadUint (\r
+InternalBaseLibBitFieldReadUint (\r
IN UINTN Operand,\r
IN UINTN StartBit,\r
IN UINTN EndBit\r
}\r
\r
/**\r
- Worker function that reads a bit field from Operand, performs a bitwise OR, \r
+ Worker function that reads a bit field from Operand, performs a bitwise OR,\r
and returns the result.\r
\r
Performs a bitwise OR between the bit field specified by StartBit and EndBit\r
@param Operand Operand on which to perform the bitfield operation.\r
@param StartBit The ordinal of the least significant bit in the bit field.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
- @param OrData The value to OR with the read value from the value\r
+ @param OrData The value to OR with the read value from the value.\r
\r
@return The new value.\r
\r
**/\r
UINTN\r
EFIAPI\r
-BitFieldOrUint (\r
+InternalBaseLibBitFieldOrUint (\r
IN UINTN Operand,\r
IN UINTN StartBit,\r
IN UINTN EndBit,\r
}\r
\r
/**\r
- Worker function that reads a bit field from Operand, performs a bitwise AND, \r
+ Worker function that reads a bit field from Operand, performs a bitwise AND,\r
and returns the result.\r
\r
Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
@param Operand Operand on which to perform the bitfield operation.\r
@param StartBit The ordinal of the least significant bit in the bit field.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
- @param AndData The value to And with the read value from the value\r
+ @param AndData The value to And with the read value from the value.\r
\r
@return The new value.\r
\r
**/\r
UINTN\r
EFIAPI\r
-BitFieldAndUint (\r
+InternalBaseLibBitFieldAndUint (\r
IN UINTN Operand,\r
IN UINTN StartBit,\r
IN UINTN EndBit,\r
{\r
ASSERT (EndBit < 8);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT8)BitFieldReadUint (Operand, StartBit, EndBit);\r
+ return (UINT8)InternalBaseLibBitFieldReadUint (Operand, StartBit, EndBit);\r
}\r
\r
/**\r
Range 0..7.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..7.\r
- @param Value New value of the bit field.\r
+ @param Value The new value of the bit field.\r
\r
@return The new 8-bit value.\r
\r
Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the\r
result.\r
\r
- Performs a bitwise inclusive OR between the bit field specified by StartBit\r
+ Performs a bitwise OR between the bit field specified by StartBit\r
and EndBit in Operand and the value specified by OrData. All other bits in\r
Operand are preserved. The new 8-bit value is returned.\r
\r
Range 0..7.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..7.\r
- @param OrData The value to OR with the read value from the value\r
+ @param OrData The value to OR with the read value from the value.\r
\r
@return The new 8-bit value.\r
\r
{\r
ASSERT (EndBit < 8);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT8)BitFieldOrUint (Operand, StartBit, EndBit, OrData);\r
+ return (UINT8)InternalBaseLibBitFieldOrUint (Operand, StartBit, EndBit, OrData);\r
}\r
\r
/**\r
{\r
ASSERT (EndBit < 8);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT8)BitFieldAndUint (Operand, StartBit, EndBit, AndData);\r
+ return (UINT8)InternalBaseLibBitFieldAndUint (Operand, StartBit, EndBit, AndData);\r
}\r
\r
/**\r
bitwise OR, and returns the result.\r
\r
Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
- in Operand and the value specified by AndData, followed by a bitwise\r
- inclusive OR with value specified by OrData. All other bits in Operand are\r
+ in Operand and the value specified by AndData, followed by a bitwise \r
+ OR with value specified by OrData. All other bits in Operand are\r
preserved. The new 8-bit value is returned.\r
\r
If 8-bit operations are not supported, then ASSERT().\r
{\r
ASSERT (EndBit < 16);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT16)BitFieldReadUint (Operand, StartBit, EndBit);\r
+ return (UINT16)InternalBaseLibBitFieldReadUint (Operand, StartBit, EndBit);\r
}\r
\r
/**\r
Range 0..15.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..15.\r
- @param Value New value of the bit field.\r
+ @param Value The new value of the bit field.\r
\r
@return The new 16-bit value.\r
\r
Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the\r
result.\r
\r
- Performs a bitwise inclusive OR between the bit field specified by StartBit\r
+ Performs a bitwise OR between the bit field specified by StartBit\r
and EndBit in Operand and the value specified by OrData. All other bits in\r
Operand are preserved. The new 16-bit value is returned.\r
\r
Range 0..15.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..15.\r
- @param OrData The value to OR with the read value from the value\r
+ @param OrData The value to OR with the read value from the value.\r
\r
@return The new 16-bit value.\r
\r
{\r
ASSERT (EndBit < 16);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT16)BitFieldOrUint (Operand, StartBit, EndBit, OrData);\r
+ return (UINT16)InternalBaseLibBitFieldOrUint (Operand, StartBit, EndBit, OrData);\r
}\r
\r
/**\r
Range 0..15.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..15.\r
- @param AndData The value to AND with the read value from the value\r
+ @param AndData The value to AND with the read value from the value.\r
\r
@return The new 16-bit value.\r
\r
{\r
ASSERT (EndBit < 16);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT16)BitFieldAndUint (Operand, StartBit, EndBit, AndData);\r
+ return (UINT16)InternalBaseLibBitFieldAndUint (Operand, StartBit, EndBit, AndData);\r
}\r
\r
/**\r
bitwise OR, and returns the result.\r
\r
Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
- in Operand and the value specified by AndData, followed by a bitwise\r
- inclusive OR with value specified by OrData. All other bits in Operand are\r
+ in Operand and the value specified by AndData, followed by a bitwise \r
+ OR with value specified by OrData. All other bits in Operand are\r
preserved. The new 16-bit value is returned.\r
\r
If 16-bit operations are not supported, then ASSERT().\r
{\r
ASSERT (EndBit < 32);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT32)BitFieldReadUint (Operand, StartBit, EndBit);\r
+ return (UINT32)InternalBaseLibBitFieldReadUint (Operand, StartBit, EndBit);\r
}\r
\r
/**\r
Range 0..31.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..31.\r
- @param Value New value of the bit field.\r
+ @param Value The new value of the bit field.\r
\r
@return The new 32-bit value.\r
\r
Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the\r
result.\r
\r
- Performs a bitwise inclusive OR between the bit field specified by StartBit\r
+ Performs a bitwise OR between the bit field specified by StartBit\r
and EndBit in Operand and the value specified by OrData. All other bits in\r
Operand are preserved. The new 32-bit value is returned.\r
\r
Range 0..31.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..31.\r
- @param OrData The value to OR with the read value from the value\r
+ @param OrData The value to OR with the read value from the value.\r
\r
@return The new 32-bit value.\r
\r
{\r
ASSERT (EndBit < 32);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT32)BitFieldOrUint (Operand, StartBit, EndBit, OrData);\r
+ return (UINT32)InternalBaseLibBitFieldOrUint (Operand, StartBit, EndBit, OrData);\r
}\r
\r
/**\r
Range 0..31.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..31.\r
- @param AndData The value to AND with the read value from the value\r
+ @param AndData The value to AND with the read value from the value.\r
\r
@return The new 32-bit value.\r
\r
{\r
ASSERT (EndBit < 32);\r
ASSERT (StartBit <= EndBit);\r
- return (UINT32)BitFieldAndUint (Operand, StartBit, EndBit, AndData);\r
+ return (UINT32)InternalBaseLibBitFieldAndUint (Operand, StartBit, EndBit, AndData);\r
}\r
\r
/**\r
bitwise OR, and returns the result.\r
\r
Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
- in Operand and the value specified by AndData, followed by a bitwise\r
- inclusive OR with value specified by OrData. All other bits in Operand are\r
+ in Operand and the value specified by AndData, followed by a bitwise \r
+ OR with value specified by OrData. All other bits in Operand are\r
preserved. The new 32-bit value is returned.\r
\r
If 32-bit operations are not supported, then ASSERT().\r
Range 0..63.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..63.\r
- @param Value New value of the bit field.\r
+ @param Value The new value of the bit field.\r
\r
@return The new 64-bit value.\r
\r
Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the\r
result.\r
\r
- Performs a bitwise inclusive OR between the bit field specified by StartBit\r
+ Performs a bitwise OR between the bit field specified by StartBit\r
and EndBit in Operand and the value specified by OrData. All other bits in\r
Operand are preserved. The new 64-bit value is returned.\r
\r
Range 0..63.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..63.\r
- @param AndData The value to AND with the read value from the value\r
+ @param AndData The value to AND with the read value from the value.\r
\r
@return The new 64-bit value.\r
\r
bitwise OR, and returns the result.\r
\r
Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
- in Operand and the value specified by AndData, followed by a bitwise\r
- inclusive OR with value specified by OrData. All other bits in Operand are\r
+ in Operand and the value specified by AndData, followed by a bitwise \r
+ OR with value specified by OrData. All other bits in Operand are\r
preserved. The new 64-bit value is returned.\r
\r
If 64-bit operations are not supported, then ASSERT().\r
projects / mirror_edk2.git / blobdiff