xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/PP_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    _PP_FP_H_
41 #define    _PP_FP_H_
42 
43 //*** PhysicalPresencePreInstall_Init()
44 // This function is used to initialize the array of commands that always require
45 // confirmation with physical presence. The array is an array of bits that
46 // has a correspondence with the command code.
47 //
48 // This command should only ever be executable in a manufacturing setting or in
49 // a simulation.
50 //
51 // When set, these cannot be cleared.
52 //
53 void
54 PhysicalPresencePreInstall_Init(
55     void
56 );
57 
58 //*** PhysicalPresenceCommandSet()
59 // This function is used to set the indicator that a command requires
60 // PP confirmation.
61 void
62 PhysicalPresenceCommandSet(
63     TPM_CC           commandCode    // IN: command code
64 );
65 
66 //*** PhysicalPresenceCommandClear()
67 // This function is used to clear the indicator that a command requires PP
68 // confirmation.
69 void
70 PhysicalPresenceCommandClear(
71     TPM_CC           commandCode    // IN: command code
72 );
73 
74 //*** PhysicalPresenceIsRequired()
75 // This function indicates if PP confirmation is required for a command.
76 //  Return Type: BOOL
77 //      TRUE(1)         physical presence is required
78 //      FALSE(0)        physical presence is not required
79 BOOL
80 PhysicalPresenceIsRequired(
81     COMMAND_INDEX    commandIndex   // IN: command index
82 );
83 
84 //*** PhysicalPresenceCapGetCCList()
85 // This function returns a list of commands that require PP confirmation. The
86 // list starts from the first implemented command that has a command code that
87 // the same or greater than 'commandCode'.
88 //  Return Type: TPMI_YES_NO
89 //      YES         if there are more command codes available
90 //      NO          all the available command codes have been returned
91 TPMI_YES_NO
92 PhysicalPresenceCapGetCCList(
93     TPM_CC           commandCode,   // IN: start command code
94     UINT32           count,         // IN: count of returned TPM_CC
95     TPML_CC         *commandList    // OUT: list of TPM_CC
96 );
97 
98 #endif  // _PP_FP_H_
99