]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BaseLib/Math64.c
MdePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdePkg / Library / BaseLib / Math64.c
index a8756967befaf73f6d2a4978ff4e0943393e05e7..154b97ae79f2d205a7762b4eaf31148e21d2d311 100644 (file)
@@ -2,21 +2,15 @@
   Leaf math worker functions that require 64-bit arithmetic support from the\r
   compiler.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
-  All rights reserved. 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
-\r
-  Module Name:  Math64.c\r
+  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
+#include "BaseLibInternals.h"\r
+\r
 /**\r
-  Worker functons that shifts a 64-bit integer left between 0 and 63 bits. The low bits\r
+  Shifts a 64-bit integer left between 0 and 63 bits. The low bits\r
   are filled with zeros. The shifted value is returned.\r
 \r
   This function shifts the 64-bit value Operand to the left by Count bits. The\r
   @param  Operand The 64-bit operand to shift left.\r
   @param  Count   The number of bits to shift left.\r
 \r
-  @return Operand << Count\r
+  @return Operand << Count.\r
 \r
 **/\r
 UINT64\r
+EFIAPI\r
 InternalMathLShiftU64 (\r
   IN      UINT64                    Operand,\r
   IN      UINTN                     Count\r
@@ -38,7 +33,7 @@ InternalMathLShiftU64 (
 }\r
 \r
 /**\r
-  Worker functon that shifts a 64-bit integer right between 0 and 63 bits. This high bits\r
+  Shifts a 64-bit integer right between 0 and 63 bits. This high bits\r
   are filled with zeros. The shifted value is returned.\r
 \r
   This function shifts the 64-bit value Operand to the right by Count bits. The\r
@@ -47,7 +42,7 @@ InternalMathLShiftU64 (
   @param  Operand The 64-bit operand to shift right.\r
   @param  Count   The number of bits to shift right.\r
 \r
-  @return Operand >> Count\r
+  @return Operand >> Count.\r
 \r
 **/\r
 UINT64\r
@@ -61,18 +56,16 @@ InternalMathRShiftU64 (
 }\r
 \r
 /**\r
-  Worker function that shifts a 64-bit integer right between 0 and 63 bits. The high bits\r
+  Shifts a 64-bit integer right between 0 and 63 bits. The high bits\r
   are filled with original integer's bit 63. The shifted value is returned.\r
 \r
   This function shifts the 64-bit value Operand to the right by Count bits. The\r
   high Count bits are set to bit 63 of Operand.  The shifted value is returned.\r
 \r
-  If Count is greater than 63, then ASSERT().\r
-\r
   @param  Operand The 64-bit operand to shift right.\r
   @param  Count   The number of bits to shift right.\r
 \r
-  @return Operand arithmetically shifted right by Count\r
+  @return Operand arithmetically shifted right by Count.\r
 \r
 **/\r
 UINT64\r
@@ -82,10 +75,13 @@ InternalMathARShiftU64 (
   IN      UINTN                     Count\r
   )\r
 {\r
+  INTN  TestValue;\r
+\r
   //\r
   // Test if this compiler supports arithmetic shift\r
   //\r
-  if ((((-1) << (sizeof (-1) * 8 - 1)) >> (sizeof (-1) * 8 - 1)) == -1) {\r
+  TestValue = (INTN)((INT64)(1ULL << 63) >> 63);\r
+  if (TestValue == -1) {\r
     //\r
     // Arithmetic shift is supported\r
     //\r
@@ -101,7 +97,7 @@ InternalMathARShiftU64 (
 \r
 \r
 /**\r
-  Worker function that rotates a 64-bit integer left between 0 and 63 bits, filling \r
+  Rotates a 64-bit integer left between 0 and 63 bits, filling\r
   the low bits with the high bits that were rotated.\r
 \r
   This function rotates the 64-bit value Operand to the left by Count bits. The\r
@@ -111,7 +107,7 @@ InternalMathARShiftU64 (
   @param  Operand The 64-bit operand to rotate left.\r
   @param  Count   The number of bits to rotate left.\r
 \r
-  @return Operand <<< Count\r
+  @return Operand <<< Count.\r
 \r
 **/\r
 UINT64\r
@@ -125,7 +121,7 @@ InternalMathLRotU64 (
 }\r
 \r
 /**\r
-  Worker function that rotates a 64-bit integer right between 0 and 63 bits, filling\r
+  Rotates a 64-bit integer right between 0 and 63 bits, filling\r
   the high bits with the high low bits that were rotated.\r
 \r
   This function rotates the 64-bit value Operand to the right by Count bits.\r
@@ -135,7 +131,7 @@ InternalMathLRotU64 (
   @param  Operand The 64-bit operand to rotate right.\r
   @param  Count   The number of bits to rotate right.\r
 \r
-  @return Operand >>> Count\r
+  @return Operand >>> Count.\r
 \r
 **/\r
 UINT64\r
@@ -149,7 +145,7 @@ InternalMathRRotU64 (
 }\r
 \r
 /**\r
-  Worker function that switches the endianess of a 64-bit integer.\r
+  Switches the endianess of a 64-bit integer.\r
 \r
   This function swaps the bytes in a 64-bit unsigned value to switch the value\r
   from little endian to big endian or vice versa. The byte swapped value is\r
@@ -157,7 +153,7 @@ InternalMathRRotU64 (
 \r
   @param  Operand A 64-bit unsigned value.\r
 \r
-  @return The byte swaped Operand.\r
+  @return The byte swapped Operand.\r
 \r
 **/\r
 UINT64\r
@@ -166,17 +162,20 @@ InternalMathSwapBytes64 (
   IN      UINT64                    Operand\r
   )\r
 {\r
-  return (UINT64)(\r
-           ((UINT64)SwapBytes32 ((UINT32)Operand) << 32) |\r
-           ((UINT64)SwapBytes32 ((UINT32)(Operand >> 32)))\r
-           );\r
+  UINT64  LowerBytes;\r
+  UINT64  HigherBytes;\r
+\r
+  LowerBytes  = (UINT64) SwapBytes32 ((UINT32) Operand);\r
+  HigherBytes = (UINT64) SwapBytes32 ((UINT32) (Operand >> 32));\r
+\r
+  return (LowerBytes << 32 | HigherBytes);\r
 }\r
 \r
 /**\r
-  Worker function that multiples a 64-bit unsigned integer by a 32-bit unsigned integer\r
+  Multiplies a 64-bit unsigned integer by a 32-bit unsigned integer\r
   and generates a 64-bit unsigned result.\r
 \r
-  This function multiples the 64-bit unsigned value Multiplicand by the 32-bit\r
+  This function multiplies the 64-bit unsigned value Multiplicand by the 32-bit\r
   unsigned value Multiplier and generates a 64-bit unsigned result. This 64-\r
   bit unsigned result is returned.\r
 \r
@@ -198,17 +197,17 @@ InternalMathMultU64x32 (
 \r
 \r
 /**\r
-  Worker function that multiples a 64-bit unsigned integer by a 64-bit unsigned integer\r
+  Multiplies a 64-bit unsigned integer by a 64-bit unsigned integer\r
   and generates a 64-bit unsigned result.\r
 \r
-  This function multiples the 64-bit unsigned value Multiplicand by the 64-bit\r
+  This function multiplies the 64-bit unsigned value Multiplicand by the 64-bit\r
   unsigned value Multiplier and generates a 64-bit unsigned result. This 64-\r
   bit unsigned result is returned.\r
 \r
   @param  Multiplicand  A 64-bit unsigned value.\r
   @param  Multiplier    A 64-bit unsigned value.\r
 \r
-  @return Multiplicand * Multiplier\r
+  @return Multiplicand * Multiplier.\r
 \r
 **/\r
 UINT64\r
@@ -222,17 +221,17 @@ InternalMathMultU64x64 (
 }\r
 \r
 /**\r
-  Worker function that divides a 64-bit unsigned integer by a 32-bit unsigned integer and\r
+  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and\r
   generates a 64-bit unsigned result.\r
\r
+\r
   This function divides the 64-bit unsigned value Dividend by the 32-bit\r
   unsigned value Divisor and generates a 64-bit unsigned quotient. This\r
   function returns the 64-bit unsigned quotient.\r
 \r
-   @param  Dividend  A 64-bit unsigned value.\r
+  @param  Dividend  A 64-bit unsigned value.\r
   @param  Divisor   A 32-bit unsigned value.\r
 \r
-  @return Dividend / Divisor\r
+  @return Dividend / Divisor.\r
 \r
 **/\r
 UINT64\r
@@ -246,8 +245,8 @@ InternalMathDivU64x32 (
 }\r
 \r
 /**\r
-  Worker function that divides a 64-bit unsigned integer by a 32-bit unsigned integer\r
-  and generates a 32-bit unsigned remainder.\r
+  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and\r
+  generates a 32-bit unsigned remainder.\r
 \r
   This function divides the 64-bit unsigned value Dividend by the 32-bit\r
   unsigned value Divisor and generates a 32-bit remainder. This function\r
@@ -256,10 +255,11 @@ InternalMathDivU64x32 (
   @param  Dividend  A 64-bit unsigned value.\r
   @param  Divisor   A 32-bit unsigned value.\r
 \r
-  @return Dividend % Divisor\r
+  @return Dividend % Divisor.\r
 \r
 **/\r
 UINT32\r
+EFIAPI\r
 InternalMathModU64x32 (\r
   IN      UINT64                    Dividend,\r
   IN      UINT32                    Divisor\r
@@ -269,7 +269,7 @@ InternalMathModU64x32 (
 }\r
 \r
 /**\r
-  Worker function that divides a 64-bit unsigned integer by a 32-bit unsigned integer and\r
+  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and\r
   generates a 64-bit unsigned result and an optional 32-bit unsigned remainder.\r
 \r
   This function divides the 64-bit unsigned value Dividend by the 32-bit\r
@@ -282,14 +282,15 @@ InternalMathModU64x32 (
   @param  Remainder A pointer to a 32-bit unsigned value. This parameter is\r
                     optional and may be NULL.\r
 \r
-  @return Dividend / Divisor\r
+  @return Dividend / Divisor.\r
 \r
 **/\r
 UINT64\r
+EFIAPI\r
 InternalMathDivRemU64x32 (\r
   IN      UINT64                    Dividend,\r
   IN      UINT32                    Divisor,\r
-  OUT     UINT32                    *Remainder  OPTIONAL\r
+  OUT     UINT32                    *Remainder OPTIONAL\r
   )\r
 {\r
   if (Remainder != NULL) {\r
@@ -299,7 +300,7 @@ InternalMathDivRemU64x32 (
 }\r
 \r
 /**\r
-  Worker function that divides a 64-bit unsigned integer by a 64-bit unsigned integer and \r
+  Divides a 64-bit unsigned integer by a 64-bit unsigned integer and\r
   generates a 64-bit unsigned result and an optional 64-bit unsigned remainder.\r
 \r
   This function divides the 64-bit unsigned value Dividend by the 64-bit\r
@@ -316,10 +317,11 @@ InternalMathDivRemU64x32 (
 \r
 **/\r
 UINT64\r
+EFIAPI\r
 InternalMathDivRemU64x64 (\r
   IN      UINT64                    Dividend,\r
   IN      UINT64                    Divisor,\r
-  OUT     UINT64                    *Remainder  OPTIONAL\r
+  OUT     UINT64                    *Remainder OPTIONAL\r
   )\r
 {\r
   if (Remainder != NULL) {\r
@@ -329,23 +331,24 @@ InternalMathDivRemU64x64 (
 }\r
 \r
 /**\r
-  Worker function that divides a 64-bit signed integer by a 64-bit signed integer and \r
-  generates a  64-bit signed result and a optional 64-bit signed remainder.\r
+  Divides a 64-bit signed integer by a 64-bit signed integer and\r
+  generates a 64-bit signed result and an optional 64-bit signed remainder.\r
 \r
-  This function divides the 64-bit unsigned value Dividend by the 64-bit\r
-  unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder\r
-  is not NULL, then the 64-bit unsigned remainder is returned in Remainder.\r
-  This function returns the 64-bit unsigned quotient.\r
+  This function divides the 64-bit signed value Dividend by the 64-bit\r
+  signed value Divisor and generates a 64-bit signed quotient. If Remainder\r
+  is not NULL, then the 64-bit signed remainder is returned in Remainder.\r
+  This function returns the 64-bit signed quotient.\r
 \r
   @param  Dividend  A 64-bit signed value.\r
   @param  Divisor   A 64-bit signed value.\r
   @param  Remainder A pointer to a 64-bit signed value. This parameter is\r
                     optional and may be NULL.\r
 \r
-  @return Dividend / Divisor\r
+  @return Dividend / Divisor.\r
 \r
 **/\r
 INT64\r
+EFIAPI\r
 InternalMathDivRemS64x64 (\r
   IN      INT64                     Dividend,\r
   IN      INT64                     Divisor,\r