]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Library/BaseLib/DivU64x32Remainder.c
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Library / BaseLib / DivU64x32Remainder.c
CommitLineData
e1f414b6 1/** @file\r
2 Math worker functions.\r
3\r
bb817c56 4 Copyright (c) 2006 - 2008, 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 unsigned integer by a 32-bit unsigned integer and generates\r
13 a 64-bit unsigned result and an optional 32-bit unsigned remainder.\r
14\r
15 This function divides the 64-bit unsigned value Dividend by the 32-bit\r
16 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder\r
17 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.\r
18 This function returns the 64-bit unsigned quotient.\r
19\r
20 If Divisor is 0, then ASSERT().\r
21\r
22 @param Dividend A 64-bit unsigned value.\r
23 @param Divisor A 32-bit unsigned value.\r
24 @param Remainder A pointer to a 32-bit unsigned value. This parameter is\r
25 optional and may be NULL.\r
26\r
27 @return Dividend / Divisor\r
28\r
29**/\r
30UINT64\r
31EFIAPI\r
32DivU64x32Remainder (\r
2f88bd3a
MK
33 IN UINT64 Dividend,\r
34 IN UINT32 Divisor,\r
35 OUT UINT32 *Remainder OPTIONAL\r
e1f414b6 36 )\r
37{\r
38 ASSERT (Divisor != 0);\r
39 return InternalMathDivRemU64x32 (Dividend, Divisor, Remainder);\r
40}\r