summaryrefslogtreecommitdiffstats
path: root/src/tpm2/IoBuffers.c
blob: 03739ede279d3a45955b48c8e57ff712104adce1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/********************************************************************************/
/*										*/
/*			    I/O Buffers		 				*/
/*			     Written by Ken Goldman				*/
/*		       IBM Thomas J. Watson Research Center			*/
/*            $Id: IoBuffers.c 1311 2018-08-23 21:39:29Z 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 - 2018				*/
/*										*/
/********************************************************************************/

/* 9.7	IoBuffers.c */
/* 9.7.1	Includes and Data Definitions */
/* This definition allows this module to see the values that are private to this module but kept in
   Global.c for ease of state migration. */
#define IO_BUFFER_C
#include "Tpm.h"
#include "IoBuffers_fp.h"
/* 9.7.2	Buffers and Functions */
/* These buffers are set aside to hold command and response values. In this implementation, it is
   not guaranteed that the code will stop accessing the s_actionInputBuffer before starting to put
   values in the s_actionOutputBuffer so different buffers are required. */
/*     9.7.2.1 MemoryIoBufferAllocationReset() */
/*     This function is used to reset the allocation of buffers. */
void
MemoryIoBufferAllocationReset(
			      void
			      )
{
    s_actionIoAllocation = 0;
}
/* 9.7.2.2	MemoryIoBufferZero() */
/* Function zeros the action I/O buffer at the end of a command. Calling this is not mandatory for
   proper functionality. */
void
MemoryIoBufferZero(
		   void
		   )
{
    memset(s_actionIoBuffer, 0, s_actionIoAllocation);
}
/* 9.7.2.3	MemoryGetInBuffer() */
/* This function returns the address of the buffer into which the command parameters will be
   unmarshaled in preparation for calling the command actions. */
BYTE *
MemoryGetInBuffer(
		  UINT32           size           // Size, in bytes, required for the input
		  // unmarshaling
		  )
{
    pAssert(size <= sizeof(s_actionIoBuffer));
    // In this implementation, a static buffer is set aside for the command action
    // buffers. The buffer is shared between input and output. This is because
    // there is no need to allocate for the worst case input and worst case output
    // at the same time.
    // Round size up
#define UoM  (sizeof(s_actionIoBuffer[0]))
    size = (size + (UoM - 1)) & (UINT32_MAX - (UoM - 1));
    memset(s_actionIoBuffer, 0, size);
    s_actionIoAllocation = size;
    return (BYTE *)&s_actionIoBuffer[0];
}
/* 9.7.2.4	MemoryGetOutBuffer() */
/* This function returns the address of the buffer into which the command action code places its
   output values. */
BYTE *
MemoryGetOutBuffer(
		   UINT32           size           // required size of the buffer
		   )
{
    BYTE        *retVal = (BYTE *)(&s_actionIoBuffer[s_actionIoAllocation / UoM]);
    pAssert((size + s_actionIoAllocation) < (sizeof(s_actionIoBuffer)));
    // In this implementation, a static buffer is set aside for the command action
    // output buffer.
    memset(retVal, 0, size);
    s_actionIoAllocation += size;
    return retVal;
}
/* 9.7.2.5	IsLabelProperlyFormatted() */
/* This function checks that a label is a null-terminated string. */
/* NOTE:	this function is here because there was no better place for it. */
/* Return Value	Meaning */
/* FALSE	string is not null terminated */
/* TRUE	string is null terminated */

BOOL
IsLabelProperlyFormatted(
			 TPM2B           *x
			 )
{
    return (((x)->size == 0) || ((x)->buffer[(x)->size - 1] == 0));
}