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    _NV_SPT_FP_H_
41 #define    _NV_SPT_FP_H_
42 
43 //*** NvReadAccessChecks()
44 // Common routine for validating a read
45 // Used by TPM2_NV_Read, TPM2_NV_ReadLock and TPM2_PolicyNV
46 //  Return Type: TPM_RC
47 //      TPM_RC_NV_AUTHORIZATION     autHandle is not allowed to authorize read
48 //                                  of the index
49 //      TPM_RC_NV_LOCKED            Read locked
50 //      TPM_RC_NV_UNINITIALIZED     Try to read an uninitialized index
51 //
52 TPM_RC
53 NvReadAccessChecks(
54     TPM_HANDLE       authHandle,    // IN: the handle that provided the
55                                     //     authorization
56     TPM_HANDLE       nvHandle,      // IN: the handle of the NV index to be read
57     TPMA_NV          attributes     // IN: the attributes of 'nvHandle'
58 );
59 
60 //*** NvWriteAccessChecks()
61 // Common routine for validating a write
62 // Used by TPM2_NV_Write, TPM2_NV_Increment, TPM2_SetBits, and TPM2_NV_WriteLock
63 //  Return Type: TPM_RC
64 //      TPM_RC_NV_AUTHORIZATION     Authorization fails
65 //      TPM_RC_NV_LOCKED            Write locked
66 //
67 TPM_RC
68 NvWriteAccessChecks(
69     TPM_HANDLE       authHandle,    // IN: the handle that provided the
70                                     //     authorization
71     TPM_HANDLE       nvHandle,      // IN: the handle of the NV index to be written
72     TPMA_NV          attributes     // IN: the attributes of 'nvHandle'
73 );
74 
75 //*** NvClearOrderly()
76 // This function is used to cause gp.orderlyState to be cleared to the
77 // non-orderly state.
78 TPM_RC
79 NvClearOrderly(
80     void
81 );
82 
83 //*** NvIsPinPassIndex()
84 // Function to check to see if an NV index is a PIN Pass Index
85 //  Return Type: BOOL
86 //      TRUE(1)         is pin pass
87 //      FALSE(0)        is not pin pass
88 BOOL
89 NvIsPinPassIndex(
90     TPM_HANDLE          index       // IN: Handle to check
91 );
92 
93 #endif  // _NV_SPT_FP_H_
94