remove unnecessary comments introduced by tools from MdePkg. The regular express...

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ia32 / DivS64x64Remainder.c

/** @file\r
  Integer division worker functions for Ia32.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
\r
\r
#include "../BaseLibInternals.h"\r
\r
/**\r
  Worker function that Divides a 64-bit signed integer by a 64-bit signed integer and\r
  generates a  64-bit signed result and a optional 64-bit signed remainder.\r
\r
  This function divides the 64-bit unsigned value Dividend by the 64-bit\r
  unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder\r
  is not NULL, then the 64-bit unsigned remainder is returned in Remainder.\r
  This function returns the 64-bit unsigned quotient.\r
\r
  @param  Dividend  A 64-bit signed value.\r
  @param  Divisor   A 64-bit signed value.\r
  @param  Remainder A pointer to a 64-bit signed value. This parameter is\r
                    optional and may be NULL.\r
\r
  @return Dividend / Divisor\r
\r
**/\r
INT64\r
EFIAPI\r
InternalMathDivRemS64x64 (\r
  IN      INT64                     Dividend,\r
  IN      INT64                     Divisor,\r
  OUT     INT64                     *Remainder  OPTIONAL\r
  )\r
{\r
  INT64                             Quot;\r
\r
  Quot = InternalMathDivRemU64x64 (\r
           Dividend >= 0 ? Dividend : -Dividend,\r
           Divisor >= 0 ? Divisor : -Divisor,\r
           (UINT64 *) Remainder\r
           );\r
  if (Remainder != NULL && Dividend < 0) {\r
    *Remainder = -*Remainder;\r
  }\r
  return (Dividend ^ Divisor) >= 0 ? Quot : -Quot;\r
}\r