xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/Handle_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    _HANDLE_FP_H_
41 #define    _HANDLE_FP_H_
42 
43 //*** HandleGetType()
44 // This function returns the type of a handle which is the MSO of the handle.
45 TPM_HT
46 HandleGetType(
47     TPM_HANDLE       handle         // IN: a handle to be checked
48 );
49 
50 //*** NextPermanentHandle()
51 // This function returns the permanent handle that is equal to the input value or
52 // is the next higher value. If there is no handle with the input value and there
53 // is no next higher value, it returns 0:
54 TPM_HANDLE
55 NextPermanentHandle(
56     TPM_HANDLE       inHandle       // IN: the handle to check
57 );
58 
59 //*** PermanentCapGetHandles()
60 // This function returns a list of the permanent handles of PCR, started from
61 // 'handle'. If 'handle' is larger than the largest permanent handle, an empty list
62 // will be returned with 'more' set to NO.
63 //  Return Type: TPMI_YES_NO
64 //      YES         if there are more handles available
65 //      NO          all the available handles has been returned
66 TPMI_YES_NO
67 PermanentCapGetHandles(
68     TPM_HANDLE       handle,        // IN: start handle
69     UINT32           count,         // IN: count of returned handles
70     TPML_HANDLE     *handleList     // OUT: list of handle
71 );
72 
73 //*** PermanentHandleGetPolicy()
74 // This function returns a list of the permanent handles of PCR, started from
75 // 'handle'. If 'handle' is larger than the largest permanent handle, an empty list
76 // will be returned with 'more' set to NO.
77 //  Return Type: TPMI_YES_NO
78 //      YES         if there are more handles available
79 //      NO          all the available handles has been returned
80 TPMI_YES_NO
81 PermanentHandleGetPolicy(
82     TPM_HANDLE           handle,        // IN: start handle
83     UINT32               count,         // IN: max count of returned handles
84     TPML_TAGGED_POLICY  *policyList     // OUT: list of handle
85 );
86 
87 #endif  // _HANDLE_FP_H_
88