MdePkg/Library/BaseLib/DivU64x32Remainder.c

   1 /** @file
   2   Math worker functions.
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9
  10
  11
  12 #include "BaseLibInternals.h"
  13
  14 /**
  15   Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
  16   a 64-bit unsigned result and an optional 32-bit unsigned remainder.
  17
  18   This function divides the 64-bit unsigned value Dividend by the 32-bit
  19   unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
  20   is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
  21   This function returns the 64-bit unsigned quotient.
  22
  23   If Divisor is 0, then ASSERT().
  24
  25   @param  Dividend  A 64-bit unsigned value.
  26   @param  Divisor   A 32-bit unsigned value.
  27   @param  Remainder A pointer to a 32-bit unsigned value. This parameter is
  28                     optional and may be NULL.
  29
  30   @return Dividend / Divisor
  31
  32 **/
  33 UINT64
  34 EFIAPI
  35 DivU64x32Remainder (
  36   IN      UINT64                    Dividend,
  37   IN      UINT32                    Divisor,
  38   OUT     UINT32                    *Remainder  OPTIONAL
  39   )
  40 {
  41   ASSERT (Divisor != 0);
  42   return InternalMathDivRemU64x32 (Dividend, Divisor, Remainder);
  43 }