MdePkg/Library/BaseLib/DivS64x64Remainder.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 signed integer by a 64-bit signed integer and generates a
  22   64-bit signed result and a optional 64-bit signed remainder.
  23
  24   This function divides the 64-bit signed value Dividend by the 64-bit signed
  25   value Divisor and generates a 64-bit signed quotient. If Remainder is not
  26   NULL, then the 64-bit signed remainder is returned in Remainder. This
  27   function returns the 64-bit signed quotient.
  28
  29   It is the caller's responsibility to not call this function with a Divisor of 0.
  30   If Divisor is 0, then the quotient and remainder should be assumed to be
  31   the largest negative integer.
  32
  33   If Divisor is 0, then ASSERT().
  34
  35   @param  Dividend  A 64-bit signed value.
  36   @param  Divisor   A 64-bit signed value.
  37   @param  Remainder A pointer to a 64-bit signed value. This parameter is
  38                     optional and may be NULL.
  39
  40   @return Dividend / Divisor
  41
  42 **/
  43 INT64
  44 EFIAPI
  45 DivS64x64Remainder (
  46   IN      INT64                     Dividend,
  47   IN      INT64                     Divisor,
  48   OUT     INT64                     *Remainder  OPTIONAL
  49   )
  50 {
  51   ASSERT (Divisor != 0);
  52   return InternalMathDivRemS64x64 (Dividend, Divisor, Remainder);
  53 }