MdePkg/Library/BaseLib/ModU64x32.c

   1 /** @file
   2   Math worker functions.
   3
   4   Copyright (c) 2006 - 2008, 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
  17
  18 #include "BaseLibInternals.h"
  19
  20 /**
  21   Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
  22   a 32-bit unsigned remainder.
  23
  24   This function divides the 64-bit unsigned value Dividend by the 32-bit
  25   unsigned value Divisor and generates a 32-bit remainder. This function
  26   returns the 32-bit unsigned remainder.
  27
  28   If Divisor is 0, then ASSERT().
  29
  30   @param  Dividend  A 64-bit unsigned value.
  31   @param  Divisor   A 32-bit unsigned value.
  32
  33   @return Dividend % Divisor
  34
  35 **/
  36 UINT32
  37 EFIAPI
  38 ModU64x32 (
  39   IN      UINT64                    Dividend,
  40   IN      UINT32                    Divisor
  41   )
  42 {
  43   ASSERT (Divisor != 0);
  44   return InternalMathModU64x32 (Dividend, Divisor);
  45 }