xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/Hierarchy_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: Apr  2, 2019  Time: 04:23:27PM
38  */
39 
40 #ifndef    _HIERARCHY_FP_H_
41 #define    _HIERARCHY_FP_H_
42 
43 //*** HierarchyPreInstall()
44 // This function performs the initialization functions for the hierarchy
45 // when the TPM is simulated. This function should not be called if the
46 // TPM is not in a manufacturing mode at the manufacturer, or in a simulated
47 // environment.
48 void
49 HierarchyPreInstall_Init(
50     void
51 );
52 
53 //*** HierarchyStartup()
54 // This function is called at TPM2_Startup() to initialize the hierarchy
55 // related values.
56 BOOL
57 HierarchyStartup(
58     STARTUP_TYPE     type           // IN: start up type
59 );
60 
61 //*** HierarchyGetProof()
62 // This function finds the proof value associated with a hierarchy.It returns a
63 // pointer to the proof value.
64 TPM2B_PROOF *
65 HierarchyGetProof(
66     TPMI_RH_HIERARCHY    hierarchy      // IN: hierarchy constant
67 );
68 
69 //*** HierarchyGetPrimarySeed()
70 // This function returns the primary seed of a hierarchy.
71 TPM2B_SEED *
72 HierarchyGetPrimarySeed(
73     TPMI_RH_HIERARCHY    hierarchy      // IN: hierarchy
74 );
75 
76 //*** HierarchyIsEnabled()
77 // This function checks to see if a hierarchy is enabled.
78 // NOTE: The TPM_RH_NULL hierarchy is always enabled.
79 //  Return Type: BOOL
80 //      TRUE(1)         hierarchy is enabled
81 //      FALSE(0)        hierarchy is disabled
82 BOOL
83 HierarchyIsEnabled(
84     TPMI_RH_HIERARCHY    hierarchy      // IN: hierarchy
85 );
86 
87 #endif  // _HIERARCHY_FP_H_
88