]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Library/BaseLib/DivS64x64Remainder.c
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Library / BaseLib / DivS64x64Remainder.c
CommitLineData
e1f414b6 1/** @file\r
2 Math worker functions.\r
3\r
9095d37b 4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
9344f092 5 SPDX-License-Identifier: BSD-2-Clause-Patent\r
e1f414b6 6\r
7**/\r
8\r
e1f414b6 9#include "BaseLibInternals.h"\r
10\r
11/**\r
12 Divides a 64-bit signed integer by a 64-bit signed integer and generates a\r
13 64-bit signed result and a optional 64-bit signed remainder.\r
14\r
15 This function divides the 64-bit signed value Dividend by the 64-bit signed\r
16 value Divisor and generates a 64-bit signed quotient. If Remainder is not\r
17 NULL, then the 64-bit signed remainder is returned in Remainder. This\r
18 function returns the 64-bit signed quotient.\r
19\r
cd2ed84a 20 It is the caller's responsibility to not call this function with a Divisor of 0.\r
9095d37b 21 If Divisor is 0, then the quotient and remainder should be assumed to be\r
9aa049d9 22 the largest negative integer.\r
23\r
e1f414b6 24 If Divisor is 0, then ASSERT().\r
25\r
26 @param Dividend A 64-bit signed value.\r
27 @param Divisor A 64-bit signed value.\r
28 @param Remainder A pointer to a 64-bit signed value. This parameter is\r
29 optional and may be NULL.\r
30\r
31 @return Dividend / Divisor\r
32\r
33**/\r
34INT64\r
35EFIAPI\r
36DivS64x64Remainder (\r
2f88bd3a
MK
37 IN INT64 Dividend,\r
38 IN INT64 Divisor,\r
39 OUT INT64 *Remainder OPTIONAL\r
e1f414b6 40 )\r
41{\r
42 ASSERT (Divisor != 0);\r
43 return InternalMathDivRemS64x64 (Dividend, Divisor, Remainder);\r
44}\r