EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/BaseLib/DivU64x32Remainder.c

   1 /*++
   2
   3 Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12
  13 Module Name:
  14
  15   DivU64x32Remainder.c
  16
  17 Abstract:
  18
  19   Math worker functions
  20
  21 --*/
  22
  23 #include "BaseLibInternals.h"
  24
  25 /**
  26   Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
  27   a 64-bit unsigned result and an optional 32-bit unsigned remainder.
  28
  29   This function divides the 64-bit unsigned value Dividend by the 32-bit
  30   unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
  31   is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
  32   This function returns the 64-bit unsigned quotient.
  33
  34   If Divisor is 0, then ASSERT().
  35
  36   @param  Dividend  A 64-bit unsigned value.
  37   @param  Divisor   A 32-bit unsigned value.
  38   @param  Remainder A pointer to a 32-bit unsigned value. This parameter is
  39                     optional and may be NULL.
  40
  41   @return Dividend / Divisor
  42
  43 **/
  44 UINT64
  45 EFIAPI
  46 DivU64x32Remainder (
  47   IN      UINT64                    Dividend,
  48   IN      UINT32                    Divisor,
  49   OUT     UINT32                    *Remainder  OPTIONAL
  50   )
  51 {
  52   ASSERT (Divisor != 0);
  53   return InternalMathDivRemU64x32 (Dividend, Divisor, Remainder);
  54 }