MdePkg/Library/BaseLib/MultU64x64.c

   1 /** @file
   2   Math worker functions.
   3
   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
   9
  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.
  12
  13 **/
  14
  15 #include "BaseLibInternals.h"
  16
  17 /**
  18   Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
  19   generates a 64-bit unsigned result.
  20
  21   This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
  22   unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
  23   bit unsigned result is returned.
  24
  25   If the result overflows, then ASSERT().
  26
  27   @param  Multiplicand  A 64-bit unsigned value.
  28   @param  Multiplier    A 64-bit unsigned value.
  29
  30   @return Multiplicand * Multiplier
  31
  32 **/
  33 UINT64
  34 EFIAPI
  35 MultU64x64 (
  36   IN      UINT64                    Multiplicand,
  37   IN      UINT64                    Multiplier
  38   )
  39 {
  40   UINT64                            Result;
  41
  42   Result = InternalMathMultU64x64 (Multiplicand, Multiplier);
  43   // TODO: ASSERT (Result not overflow);
  44   return Result;
  45 }