MdePkg/Library/BaseLib/DivU64x32Remainder.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   Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
  19   a 64-bit unsigned result and an optional 32-bit unsigned remainder.
  20
  21   This function divides the 64-bit unsigned value Dividend by the 32-bit
  22   unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
  23   is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
  24   This function returns the 64-bit unsigned quotient.
  25
  26   If Divisor is 0, then ASSERT().
  27
  28   @param  Dividend  A 64-bit unsigned value.
  29   @param  Divisor   A 32-bit unsigned value.
  30   @param  Remainder A pointer to a 32-bit unsigned value. This parameter is
  31                     optional and may be NULL.
  32
  33   @return Dividend / Divisor
  34
  35 **/
  36 UINT64
  37 EFIAPI
  38 DivU64x32Remainder (
  39   IN      UINT64                    Dividend,
  40   IN      UINT32                    Divisor,
  41   OUT     UINT32                    *Remainder
  42   )
  43 {
  44   ASSERT (Divisor != 0);
  45   return InternalMathDivRemU64x32 (Dividend, Divisor, Remainder);
  46 }