/src/ibmswtpm2/src/RunCommand.c

Source (jump to first uncovered line)
/********************************************************************************/
/*                    */
/*    Platform specific entry and fail processing       */
/*           Written by Ken Goldman       */
/*           IBM Thomas J. Watson Research Center     */
/*            $Id: RunCommand.c 953 2017-03-06 20:31:40Z kgoldman $   */
/*                    */
/*  Licenses and Notices              */
/*                    */
/*  1. Copyright Licenses:              */
/*                    */
/*  - Trusted Computing Group (TCG) grants to the user of the source code in  */
/*    this specification (the "Source Code") a worldwide, irrevocable,    */
/*    nonexclusive, royalty free, copyright license to reproduce, create  */
/*    derivative works, distribute, display and perform the Source Code and */
/*    derivative works thereof, and to grant others the rights granted herein.  */
/*                    */
/*  - The TCG grants to the user of the other parts of the specification  */
/*    (other than the Source Code) the rights to reproduce, distribute,   */
/*    display, and perform the specification solely for the purpose of    */
/*    developing products based on such documents.        */
/*                    */
/*  2. Source Code Distribution Conditions:         */
/*                    */
/*  - Redistributions of Source Code must retain the above copyright licenses,  */
/*    this list of conditions and the following disclaimers.      */
/*                    */
/*  - Redistributions in binary form must reproduce the above copyright   */
/*    licenses, this list of conditions and the following disclaimers in the  */
/*    documentation and/or other materials provided with the distribution.  */
/*                    */
/*  3. Disclaimers:               */
/*                    */
/*  - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF */
/*  LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH */
/*  RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES) */
/*  THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE.   */
/*  Contact TCG Administration (admin@trustedcomputinggroup.org) for    */
/*  information on specification licensing rights available through TCG   */
/*  membership agreements.              */
/*                    */
/*  - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED   */
/*    WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR   */
/*    FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR    */
/*    NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY    */
/*    OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE.   */
/*                    */
/*  - Without limitation, TCG and its members and licensors disclaim all  */
/*    liability, including liability for infringement of any proprietary  */
/*    rights, relating to use of information in this specification and to the */
/*    implementation of this specification, and TCG disclaims all liability for */
/*    cost of procurement of substitute goods or services, lost profits, loss   */
/*    of use, loss of data or any incidental, consequential, direct, indirect,  */
/*    or special damages, whether under contract, tort, warranty or otherwise,  */
/*    arising in any way out of use or reliance upon this specification or any  */
/*    information herein.             */
/*                    */
/*  (c) Copyright IBM Corp. and others, 2016, 2017        */
/*                    */
/********************************************************************************/

/* C.11 RunCommand.c */
/* C.11.1. Introduction */
/* This module provides the platform specific entry and fail processing. The _plat__RunCommand()
   function is used to call to ExecuteCommand() in the TPM code. This function does whatever
   processing is necessary to set up the platform in anticipation of the call to the TPM including
   settup for error processing. */
/* The _plat__Fail() function is called when there is a failure in the TPM. The TPM code will have
   set the flag to indicate that the TPM is in failure mode. This call will then recursively call
   ExecuteCommand() in order to build the failure mode response. When ExecuteCommand() returns to
   _plat__Fail(), the platform will do some platform specif operation to return to the environment
   in which the TPM is executing. For a simulator, setjmp/longjmp is used. For an OS, a system exit
   to the OS would be appropriate. */
/* C.11.2. Includes and locals */
#include "PlatformData.h"
#include "Platform_fp.h"
#include <setjmp.h>
#include "ExecCommand_fp.h"
jmp_buf              s_jumpBuffer;
/* C.11.3. Functions */
/* C.11.3.1. _plat__RunCommand() */
/* This version of RunCommand() will set up a jum_buf and call ExecuteCommand(). If the command
   executes without failing, it will return and RunCommand() will return. If there is a failure in
   the command, then _plat__Fail() is called and it will longjump back to RunCommand() which will
   call ExecuteCommand() again. However, this time, the TPM will be in failure mode so
   ExecuteCommand() will simply build a failure response and return. */
LIB_EXPORT void
_plat__RunCommand(
      uint32_t         requestSize,   // IN: command buffer size
      unsigned char   *request,       // IN: command buffer
      uint32_t        *responseSize,  // IN/OUT: response buffer size
      unsigned char   **response      // IN/OUT: response buffer
      )
{
    setjmp(s_jumpBuffer);
    ExecuteCommand(requestSize, request, responseSize, response);
}
/* C.11.3.2. _plat__Fail() */
/* This is the platform depended failure exit for the TPM. */
LIB_EXPORT NORETURN void
_plat__Fail(
      void
      )
{
    longjmp(&s_jumpBuffer[0], 1);
}

Coverage Report

Created: 2023-09-25 06:15

Line	Count	Source (jump to first uncovered line)
1		/********************************************************************************/
2		/* */
3		/* Platform specific entry and fail processing */
4		/* Written by Ken Goldman */
5		/* IBM Thomas J. Watson Research Center */
6		/* $Id: RunCommand.c 953 2017-03-06 20:31:40Z kgoldman $ */
7		/* */
8		/* Licenses and Notices */
9		/* */
10		/* 1. Copyright Licenses: */
11		/* */
12		/* - Trusted Computing Group (TCG) grants to the user of the source code in */
13		/* this specification (the "Source Code") a worldwide, irrevocable, */
14		/* nonexclusive, royalty free, copyright license to reproduce, create */
15		/* derivative works, distribute, display and perform the Source Code and */
16		/* derivative works thereof, and to grant others the rights granted herein. */
17		/* */
18		/* - The TCG grants to the user of the other parts of the specification */
19		/* (other than the Source Code) the rights to reproduce, distribute, */
20		/* display, and perform the specification solely for the purpose of */
21		/* developing products based on such documents. */
22		/* */
23		/* 2. Source Code Distribution Conditions: */
24		/* */
25		/* - Redistributions of Source Code must retain the above copyright licenses, */
26		/* this list of conditions and the following disclaimers. */
27		/* */
28		/* - Redistributions in binary form must reproduce the above copyright */
29		/* licenses, this list of conditions and the following disclaimers in the */
30		/* documentation and/or other materials provided with the distribution. */
31		/* */
32		/* 3. Disclaimers: */
33		/* */
34		/* - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF */
35		/* LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH */
36		/* RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES) */
37		/* THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE. */
38		/* Contact TCG Administration (admin@trustedcomputinggroup.org) for */
39		/* information on specification licensing rights available through TCG */
40		/* membership agreements. */
41		/* */
42		/* - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED */
43		/* WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR */
44		/* FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR */
45		/* NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY */
46		/* OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. */
47		/* */
48		/* - Without limitation, TCG and its members and licensors disclaim all */
49		/* liability, including liability for infringement of any proprietary */
50		/* rights, relating to use of information in this specification and to the */
51		/* implementation of this specification, and TCG disclaims all liability for */
52		/* cost of procurement of substitute goods or services, lost profits, loss */
53		/* of use, loss of data or any incidental, consequential, direct, indirect, */
54		/* or special damages, whether under contract, tort, warranty or otherwise, */
55		/* arising in any way out of use or reliance upon this specification or any */
56		/* information herein. */
57		/* */
58		/* (c) Copyright IBM Corp. and others, 2016, 2017 */
59		/* */
60		/********************************************************************************/
61
62		/* C.11 RunCommand.c */
63		/* C.11.1. Introduction */
64		/* This module provides the platform specific entry and fail processing. The _plat__RunCommand()
65		function is used to call to ExecuteCommand() in the TPM code. This function does whatever
66		processing is necessary to set up the platform in anticipation of the call to the TPM including
67		settup for error processing. */
68		/* The _plat__Fail() function is called when there is a failure in the TPM. The TPM code will have
69		set the flag to indicate that the TPM is in failure mode. This call will then recursively call
70		ExecuteCommand() in order to build the failure mode response. When ExecuteCommand() returns to
71		_plat__Fail(), the platform will do some platform specif operation to return to the environment
72		in which the TPM is executing. For a simulator, setjmp/longjmp is used. For an OS, a system exit
73		to the OS would be appropriate. */
74		/* C.11.2. Includes and locals */
75		#include "PlatformData.h"
76		#include "Platform_fp.h"
77		#include <setjmp.h>
78		#include "ExecCommand_fp.h"
79		jmp_buf s_jumpBuffer;
80		/* C.11.3. Functions */
81		/* C.11.3.1. _plat__RunCommand() */
82		/* This version of RunCommand() will set up a jum_buf and call ExecuteCommand(). If the command
83		executes without failing, it will return and RunCommand() will return. If there is a failure in
84		the command, then _plat__Fail() is called and it will longjump back to RunCommand() which will
85		call ExecuteCommand() again. However, this time, the TPM will be in failure mode so
86		ExecuteCommand() will simply build a failure response and return. */
87		LIB_EXPORT void
88		_plat__RunCommand(
89		uint32_t requestSize, // IN: command buffer size
90		unsigned char *request, // IN: command buffer
91		uint32_t *responseSize, // IN/OUT: response buffer size
92		unsigned char **response // IN/OUT: response buffer
93		)
94	9.04k	{
95	9.04k	setjmp(s_jumpBuffer);
96	9.04k	ExecuteCommand(requestSize, request, responseSize, response);
97	9.04k	}
98		/* C.11.3.2. _plat__Fail() */
99		/* This is the platform depended failure exit for the TPM. */
100		LIB_EXPORT NORETURN void
101		_plat__Fail(
102		void
103		)
104	0	{
105	0	longjmp(&s_jumpBuffer[0], 1);
106	0	}