1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/** @file
Utility functions for performing basic math operations constrained within a
modulus.
These functions are intended to simplify small changes to a value which much
remain within a specified modulus. Changes must be less than or equal to
the modulus specified by MaxVal.
Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available
under the terms and conditions of the BSD License which accompanies this
distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _MODULO_UTIL_H
#define _MODULO_UTIL_H
#include <Uefi.h>
#include <sys/EfiCdefs.h>
__BEGIN_DECLS
/** Counter = (Counter + 1) % MaxVal;
Counter is always expected to be LESS THAN MaxVal.
0 <= Counter < MaxVal
@param[in] Counter The value to be incremented.
@param[in] MaxVal Modulus of the operation.
@return Returns the result of incrementing Counter, modulus MaxVal.
If Counter >= MaxVal, returns -1.
**/
INT32
EFIAPI
ModuloIncrement(
UINT32 Counter,
UINT32 MaxVal
);
/** Counter = (Counter - 1) % MaxVal;
Counter is always expected to be LESS THAN MaxVal.
0 <= Counter < MaxVal
@param[in] Counter The value to be decremented.
@param[in] MaxVal Modulus of the operation.
@return Returns the result of decrementing Counter, modulus MaxVal.
If Counter >= MaxVal, returns -1.
**/
INT32
EFIAPI
ModuloDecrement(
UINT32 Counter,
UINT32 MaxVal
);
/** Counter = (Counter + Increment) % MaxVal;
@param[in] Counter The value to be incremented.
@param[in] Increment The value to add to Counter.
@param[in] MaxVal Modulus of the operation.
@return Returns the result of adding Increment to Counter, modulus MaxVal,
or -1 if Increment is larger than MaxVal.
**/
INT32
EFIAPI
ModuloAdd (
UINT32 Counter,
UINT32 Increment,
UINT32 MaxVal
);
/** Increment Counter but don't increment past MaxVal.
@param[in] Counter The value to be decremented.
@param[in] MaxVal The upper bound for Counter. Counter < MaxVal.
@return Returns the result of incrementing Counter.
**/
UINT32
EFIAPI
BoundIncrement(
UINT32 Counter,
UINT32 MaxVal
);
/** Decrement Counter but don't decrement past zero.
@param[in] Counter The value to be decremented.
@return Returns the result of decrementing Counter.
**/
UINT32
EFIAPI
BoundDecrement(
UINT32 Counter
);
__END_DECLS
#endif /* _MODULO_UTIL_H */
|
