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 //
  16 // Include common header file for this module.
  17 //
  18
  19
  20 #include "BaseLibInternals.h"
  21
  22 /**
  23   Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
  24   a 64-bit unsigned result and an optional 32-bit unsigned remainder.
  25
  26   This function divides the 64-bit unsigned value Dividend by the 32-bit
  27   unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
  28   is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
  29   This function returns the 64-bit unsigned quotient.
  30
  31   If Divisor is 0, then ASSERT().
  32
  33   @param  Dividend  A 64-bit unsigned value.
  34   @param  Divisor   A 32-bit unsigned value.
  35   @param  Remainder A pointer to a 32-bit unsigned value. This parameter is
  36                     optional and may be NULL.
  37
  38   @return Dividend / Divisor
  39
  40 **/
  41 UINT64
  42 EFIAPI
  43 DivU64x32Remainder (
  44   IN      UINT64                    Dividend,
  45   IN      UINT32                    Divisor,
  46   OUT     UINT32                    *Remainder  OPTIONAL
  47   )
  48 {
  49   ASSERT (Divisor != 0);
  50   return InternalMathDivRemU64x32 (Dividend, Divisor, Remainder);
  51 }