xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/BnMemory_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:18PM
38  */
39 
40 #ifndef    _BN_MEMORY_FP_H_
41 #define    _BN_MEMORY_FP_H_
42 
43 //*** BnSetTop()
44 // This function is used when the size of a bignum_t is changed. It
45 // makes sure that the unused words are set to zero and that any significant
46 // words of zeros are eliminated from the used size indicator.
47 LIB_EXPORT bigNum
48 BnSetTop(
49     bigNum           bn,        // IN/OUT: number to clean
50     crypt_uword_t    top        // IN: the new top
51 );
52 
53 //*** BnClearTop()
54 // This function will make sure that all unused words are zero.
55 LIB_EXPORT bigNum
56 BnClearTop(
57     bigNum          bn
58 );
59 
60 //*** BnInitializeWord()
61 // This function is used to initialize an allocated bigNum with a word value. The
62 // bigNum does not have to be allocated with a single word.
63 LIB_EXPORT bigNum
64 BnInitializeWord(
65     bigNum          bn,         // IN:
66     crypt_uword_t   allocated,  // IN:
67     crypt_uword_t   word        // IN:
68 );
69 
70 //*** BnInit()
71 // This function initializes a stack allocated bignum_t. It initializes
72 // 'allocated' and 'size' and zeros the words of 'd'.
73 LIB_EXPORT bigNum
74 BnInit(
75     bigNum               bn,
76     crypt_uword_t        allocated
77 );
78 
79 //*** BnCopy()
80 // Function to copy a bignum_t. If the output is NULL, then
81 // nothing happens. If the input is NULL, the output is set
82 // to zero.
83 LIB_EXPORT BOOL
84 BnCopy(
85     bigNum           out,
86     bigConst         in
87 );
88 #if ALG_ECC
89 
90 //*** BnPointCopy()
91 // Function to copy a bn point.
92 LIB_EXPORT BOOL
93 BnPointCopy(
94     bigPoint                 pOut,
95     pointConst               pIn
96 );
97 
98 //*** BnInitializePoint()
99 // This function is used to initialize a point structure with the addresses
100 // of the coordinates.
101 LIB_EXPORT bn_point_t *
102 BnInitializePoint(
103     bigPoint             p,     // OUT: structure to receive pointers
104     bigNum               x,     // IN: x coordinate
105     bigNum               y,     // IN: y coordinate
106     bigNum               z      // IN: x coordinate
107 );
108 #endif // ALG_ECC
109 
110 #endif  // _BN_MEMORY_FP_H_
111