xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/Bits_fp.h (revision 5c591343844d1f9da7da26467c4bf7efc8a7a413)
1 /* Microsoft Reference Implementation for TPM 2.0
2  *
3  *  The copyright in this software is being made available under the BSD License,
4  *  included below. This software may be subject to other third party and
5  *  contributor rights, including patent rights, and no such rights are granted
6  *  under this license.
7  *
8  *  Copyright (c) Microsoft Corporation
9  *
10  *  All rights reserved.
11  *
12  *  BSD License
13  *
14  *  Redistribution and use in source and binary forms, with or without modification,
15  *  are permitted provided that the following conditions are met:
16  *
17  *  Redistributions of source code must retain the above copyright notice, this list
18  *  of conditions and the following disclaimer.
19  *
20  *  Redistributions in binary form must reproduce the above copyright notice, this
21  *  list of conditions and the following disclaimer in the documentation and/or
22  *  other materials provided with the distribution.
23  *
24  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ""AS IS""
25  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
28  *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29  *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
31  *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 /*(Auto-generated)
36  *  Created by TpmPrototypes; Version 3.0 July 18, 2017
37  *  Date: Mar 28, 2019  Time: 08:25:19PM
38  */
39 
40 #ifndef    _BITS_FP_H_
41 #define    _BITS_FP_H_
42 
43 //*** TestBit()
44 // This function is used to check the setting of a bit in an array of bits.
45 //  Return Type: BOOL
46 //      TRUE(1)         bit is set
47 //      FALSE(0)        bit is not set
48 BOOL
49 TestBit(
50     unsigned int     bitNum,        // IN: number of the bit in 'bArray'
51     BYTE            *bArray,        // IN: array containing the bits
52     unsigned int     bytesInArray   // IN: size in bytes of 'bArray'
53 );
54 
55 //*** SetBit()
56 // This function will set the indicated bit in 'bArray'.
57 void
58 SetBit(
59     unsigned int     bitNum,        // IN: number of the bit in 'bArray'
60     BYTE            *bArray,        // IN: array containing the bits
61     unsigned int     bytesInArray   // IN: size in bytes of 'bArray'
62 );
63 
64 //*** ClearBit()
65 // This function will clear the indicated bit in 'bArray'.
66 void
67 ClearBit(
68     unsigned int     bitNum,        // IN: number of the bit in 'bArray'.
69     BYTE            *bArray,        // IN: array containing the bits
70     unsigned int     bytesInArray   // IN: size in bytes of 'bArray'
71 );
72 
73 #endif  // _BITS_FP_H_
74