]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Library/BaseLib/DivU64x64Remainder.c
Update copyright for files modified in this year
[mirror_edk2.git] / MdePkg / Library / BaseLib / DivU64x64Remainder.c
CommitLineData
e1f414b6 1/** @file\r
2 Math worker functions.\r
3\r
373ade0e 4 Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
e1f414b6 5 All rights reserved. This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
1efcc4ae 15\r
f734a10a 16\r
e1f414b6 17\r
18#include "BaseLibInternals.h"\r
19\r
20/**\r
21 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates\r
22 a 64-bit unsigned result and an optional 64-bit unsigned remainder.\r
23\r
24 This function divides the 64-bit unsigned value Dividend by the 64-bit\r
25 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder\r
26 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.\r
27 This function returns the 64-bit unsigned quotient.\r
28\r
29 If Divisor is 0, then ASSERT().\r
30\r
31 @param Dividend A 64-bit unsigned value.\r
32 @param Divisor A 64-bit unsigned value.\r
33 @param Remainder A pointer to a 64-bit unsigned value. This parameter is\r
34 optional and may be NULL.\r
35\r
36 @return Dividend / Divisor\r
37\r
38**/\r
39UINT64\r
40EFIAPI\r
41DivU64x64Remainder (\r
42 IN UINT64 Dividend,\r
43 IN UINT64 Divisor,\r
44 OUT UINT64 *Remainder OPTIONAL\r
45 )\r
46{\r
47 ASSERT (Divisor != 0);\r
48 return InternalMathDivRemU64x64 (Dividend, Divisor, Remainder);\r
49}\r