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: 03:18:00PM
38  */
39 
40 #ifndef    _TPM_FAIL_FP_H_
41 #define    _TPM_FAIL_FP_H_
42 
43 //*** SetForceFailureMode()
44 // This function is called by the simulator to enable failure mode testing.
45 #if SIMULATION
46 LIB_EXPORT void
47 SetForceFailureMode(
48     void
49 );
50 #endif
51 
52 //*** TpmLogFailure()
53 // This function saves the failure values when the code will continue to operate. It
54 // if similar to TpmFail() but returns to the caller. The assumption is that the
55 // caller will propagate a failure back up the stack.
56 void
57 TpmLogFailure(
58 #if FAIL_TRACE
59     const char      *function,
60     int              line,
61 #endif
62     int              code
63 );
64 
65 //*** TpmFail()
66 // This function is called by TPM.lib when a failure occurs. It will set up the
67 // failure values to be returned on TPM2_GetTestResult().
68 NORETURN void
69 TpmFail(
70 #if FAIL_TRACE
71     const char      *function,
72     int              line,
73 #endif
74     int              code
75 );
76 
77 //*** TpmFailureMode(
78 // This function is called by the interface code when the platform is in failure
79 // mode.
80 void
81 TpmFailureMode(
82     unsigned int     inRequestSize,     // IN: command buffer size
83     unsigned char   *inRequest,         // IN: command buffer
84     unsigned int    *outResponseSize,   // OUT: response buffer size
85     unsigned char   **outResponse       // OUT: response buffer
86 );
87 
88 //*** UnmarshalFail()
89 // This is a stub that is used to catch an attempt to unmarshal an entry
90 // that is not defined. Don't ever expect this to be called but...
91 void
92 UnmarshalFail(
93     void            *type,
94     BYTE            **buffer,
95     INT32           *size
96 );
97 
98 #endif  // _TPM_FAIL_FP_H_
99