MdePkg/Library/BaseLib/ModU64x32.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 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 32-bit remainder. This function
  23   returns the 32-bit unsigned remainder.
  24
  25   If Divisor is 0, then ASSERT().
  26
  27   @param  Dividend  A 64-bit unsigned value.
  28   @param  Divisor   A 32-bit unsigned value.
  29
  30   @return Dividend % Divisor
  31
  32 **/
  33 UINT32
  34 EFIAPI
  35 ModU64x32 (
  36   IN      UINT64                    Dividend,
  37   IN      UINT32                    Divisor
  38   )
  39 {
  40   ASSERT (Divisor != 0);
  41   return InternalMathModU64x32 (Dividend, Divisor);
  42 }