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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
|
/** @file
Public API for the Tcg Core library to perform the lowest level TCG Data encoding.
(TCG Storage Architecture Core Specification, Version 2.01, Revision 1.00,
https://trustedcomputinggroup.org/tcg-storage-architecture-core-specification/)
Check http://trustedcomputinggroup.org for latest specification updates.
Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _TCG_CORE_H_
#define _TCG_CORE_H_
#include <IndustryStandard/TcgStorageCore.h>
#define ERROR_CHECK(arg) \
{ \
TCG_RESULT ret = (arg); \
if (ret != TcgResultSuccess) { \
DEBUG ((DEBUG_INFO, "ERROR_CHECK failed at %a:%u\n", __FILE__, __LINE__)); \
return ret; \
} \
}
#define METHOD_STATUS_ERROR_CHECK(arg, failRet) \
if ((arg) != TCG_METHOD_STATUS_CODE_SUCCESS) { \
DEBUG ((DEBUG_INFO, "Method Status error: 0x%02X (%a)\n", arg, TcgMethodStatusString(arg))); \
return (failRet); \
}
#define NULL_CHECK(arg) \
do { \
if ((arg) == NULL) { \
DEBUG ((DEBUG_INFO, "NULL_CHECK(%a) failed at %a:%u\n", #arg, __FILE__, __LINE__)); \
return TcgResultFailureNullPointer; \
} \
} while (0)
#pragma pack(1)
/**
Tcg result codes.
The result code indicates if the Tcg function call was successful or not
**/
typedef enum {
//
// This is the return result upon successful completion of a Tcg function call
//
TcgResultSuccess,
//
// This is the return "catchall" result for the failure of a Tcg function call
//
TcgResultFailure,
//
// This is the return result if a required parameter was Null for a Tcg function call
//
TcgResultFailureNullPointer,
//
// This is the return result if a required buffersize was 0 for a Tcg function call
//
TcgResultFailureZeroSize,
//
// This is the return result if a Tcg function call was executed out of order.
// For instance, starting a Tcg subpacket before starting its Tcg packet.
//
TcgResultFailureInvalidAction,
//
// This is the return result if the buffersize provided is not big enough to add a requested Tcg encoded item.
//
TcgResultFailureBufferTooSmall,
//
// This is the return result for a Tcg parse function if the end of the parsed Buffer is reached, yet Data is still attempted to be retrieved.
// For instance, attempting to retrieve another Tcg token from the Buffer after it has reached the end of the Tcg subpacket payload.
//
TcgResultFailureEndBuffer,
//
// This is the return result for a Tcg parse function if the Tcg Token item requested is not the expected type.
// For instance, the caller requested to receive an integer and the Tcg token was a byte sequence.
//
TcgResultFailureInvalidType,
} TCG_RESULT;
//
// Structure that is used to build the Tcg ComPacket. It contains the start Buffer pointer and the current position of the
// Tcg ComPacket, current Tcg Packet and Tcg SubPacket. This structure must be initialized
// by calling tcgInitTcgCreateStruct before it is used as parameter to any other Tcg function.
// This structure should NOT be directly modified by the client of this library.
//
// NOTE: WE MAY MAKE THIS AN ABSTRACT STRUCTURE WITH A DEFINED SIZE AND KEEP THE VARIABLES
// INTERNAL AND ONLY KNOWN TO THE TCG LIBRARY
//
// tcgInitTcgCreateStruct
//
typedef struct {
//
// Buffer allocated and freed by the client of the Tcg library.
// This is the Buffer that shall contain the final Tcg encoded compacket.
//
VOID *Buffer;
//
// Size of the Buffer provided.
//
UINT32 BufferSize;
//
//Pointer to the start of the Tcg ComPacket. It should point to a location within Buffer.
//
TCG_COM_PACKET *ComPacket;
//
// Current Tcg Packet that is being created. It should point to a location within Buffer.
//
TCG_PACKET *CurPacket;
//
// Current Tcg SubPacket that is being created. It should point to a location within Buffer.
//
TCG_SUB_PACKET *CurSubPacket;
//
// Flag used to indicate if the Buffer of the structure should be filled out.
// This is intended to be used to support a use-case where the client of library
// can perform all the desired tcg calls to determine what the actual Size of the final compacket will be.
// Then the client can allocate the required Buffer Size and re-run the tcg calls.
// THIS MAY NOT BE IMPLEMENTED... REQUIRES MORE THOUGHT BECAUSE YOU CANNOT SOLVE ISSUE FOR RECEIVE
//
BOOLEAN DryRun;
} TCG_CREATE_STRUCT;
//
// Structure that is used to parse the Tcg response received. It contains the response Buffer pointer
// and the current position of the Tcg ComPacket, current Tcg Packet and Tcg SubPacket being parsed.
// This structure must be initialized by calling tcgInitTcgParseStruct before it is used as parameter to any other Tcg parse function.
// This structure should NOT be directly modified by the client of this library.
//
// NOTE: WE MAY MAKE THIS AN ABSTRACT STRUCTURE WITH A DEFINED SIZE AND KEEP THE VARIABLES
// INTERNAL AND ONLY KNOWN TO THE TCG LIBRARY
//
// @sa tcgInitTcgParseStruct
//
typedef struct {
//
// Buffer allocated and freed by the client of the Tcg library.
// This is the Buffer that contains the Tcg response to decode/parse.
//
const VOID* Buffer;
//
//Size of the Buffer provided.
//
UINT32 BufferSize;
//
// Pointer to the start of the Tcg ComPacket. It should point to a location within Buffer.
//
TCG_COM_PACKET *ComPacket;
//
// Current Tcg Packet that is being created. It should point to a location within Buffer.
//
TCG_PACKET *CurPacket;
//
// Current Tcg SubPacket that is being created. It should point to a location within Buffer.
//
TCG_SUB_PACKET *CurSubPacket;
//
// Current pointer within the current subpacket payload.
//
UINT8 *CurPtr;
} TCG_PARSE_STRUCT ;
//
// Structure that is used to represent a Tcg Token that is retrieved by Tcg parse functions.
//
typedef struct {
//
// Describes the type of Tcg token the Hdr start points to.
//
TCG_TOKEN_TYPE Type;
//
// Pointer to the beginning of the Header of the Tcg token
//
UINT8 *HdrStart;
} TCG_TOKEN ;
/**
Required to be called before calling any other Tcg functions with the TCG_CREATE_STRUCT.
Initializes the packet variables to NULL. Additionally, the buffer will be memset.
@param[in/out] CreateStruct Structure to initialize
@param[in] Buffer Buffer allocated by client of library. It will contain the Tcg encoded packet. This cannot be null.
@param[in] BufferSize Size of buffer provided. It cannot be 0.
**/
TCG_RESULT
EFIAPI
TcgInitTcgCreateStruct(
TCG_CREATE_STRUCT *CreateStruct,
VOID *Buffer,
UINT32 BufferSize
);
/**
Encodes the ComPacket header to the data structure.
@param[in/out] CreateStruct Structure to initialize
@param[in] ComId ComID of the Tcg ComPacket.
@param[in] ComIdExtension ComID Extension of the Tcg ComPacket.
**/
TCG_RESULT
EFIAPI
TcgStartComPacket(
TCG_CREATE_STRUCT *CreateStruct,
UINT16 ComId,
UINT16 ComIdExtension
);
/**
Starts a new ComPacket in the Data structure.
@param[in/out] CreateStruct Structure used to add Tcg Packet
@param[in] Tsn Packet Tper session number
@param[in] Hsn Packet Host session number
@param[in] SeqNumber Packet Sequence Number
@param[in] AckType Packet Acknowledge Type
@param[in] Ack Packet Acknowledge
**/
TCG_RESULT
EFIAPI
TcgStartPacket(
TCG_CREATE_STRUCT *CreateStruct,
UINT32 Tsn,
UINT32 Hsn,
UINT32 SeqNumber,
UINT16 AckType,
UINT32 Ack
);
/**
Starts a new SubPacket in the Data structure.
@param[in/out] CreateStruct Structure used to start Tcg SubPacket
@param[in] Kind SubPacket kind
**/
TCG_RESULT
EFIAPI
TcgStartSubPacket(
TCG_CREATE_STRUCT *CreateStruct,
UINT16 Kind
);
/**
Ends the current SubPacket in the Data structure. This function will also perform the 4-byte padding
required for Subpackets.
@param[in/out] CreateStruct Structure used to end the current Tcg SubPacket
**/
TCG_RESULT
EFIAPI
TcgEndSubPacket(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Ends the current Packet in the Data structure.
@param[in/out] CreateStruct Structure used to end the current Tcg Packet
**/
TCG_RESULT
EFIAPI
TcgEndPacket(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Ends the ComPacket in the Data structure and ret
@param[in/out] CreateStruct Structure used to end the Tcg ComPacket
@param[in/out] Size Describes the Size of the entire ComPacket (Header and payload). Filled out by function.
**/
TCG_RESULT
EFIAPI
TcgEndComPacket(
TCG_CREATE_STRUCT *CreateStruct,
UINT32 *Size
);
/**
Adds a single raw token byte to the Data structure.
@param[in/out] CreateStruct Structure used to add the byte
@param [in] Byte Byte to add
**/
TCG_RESULT
EFIAPI
TcgAddRawByte(
TCG_CREATE_STRUCT *CreateStruct,
UINT8 Byte
);
/**
Adds the Data parameter as a byte sequence to the Data structure.
@param [in/out] CreateStruct Structure used to add the byte sequence
@param[in] Data Byte sequence that will be encoded and copied into Data structure
@param[in] DataSize Length of Data provided
@param[in] Continued TRUE if byte sequence is continued or
FALSE if the Data contains the entire byte sequence to be encoded
**/
TCG_RESULT
EFIAPI
TcgAddByteSequence(
TCG_CREATE_STRUCT *CreateStruct,
const VOID *Data,
UINT32 DataSize,
BOOLEAN Continued
);
/**
Adds an arbitrary-Length integer to the Data structure.
The integer will be encoded using the shortest possible atom.
@param[in/out] CreateStruct Structure used to add the integer
@param[in] Data Integer in host byte order that will be encoded and copied into Data structure
@param[in] DataSize Length in bytes of the Data provided
@param[in] SignedInteger TRUE if the integer is signed or FALSE if the integer is unsigned
**/
TCG_RESULT
EFIAPI
TcgAddInteger(
TCG_CREATE_STRUCT *CreateStruct,
const VOID *Data,
UINT32 DataSize,
BOOLEAN SignedInteger
);
/**
Adds an 8-bit unsigned integer to the Data structure.
@param[in/out] CreateStruct Structure used to add the integer
@param[in] Value Integer Value to add
**/
TCG_RESULT
EFIAPI
TcgAddUINT8(
TCG_CREATE_STRUCT *CreateStruct,
UINT8 Value
);
/**
Adds a 16-bit unsigned integer to the Data structure.
@param[in/out] CreateStruct Structure used to add the integer
@param[in] Value Integer Value to add
**/
TCG_RESULT
EFIAPI
TcgAddUINT16 (
TCG_CREATE_STRUCT *CreateStruct,
UINT16 Value
);
/**
Adds a 32-bit unsigned integer to the Data structure.
@param[in/out] CreateStruct Structure used to add the integer
@param[in] Value Integer Value to add
**/
TCG_RESULT
EFIAPI
TcgAddUINT32(
TCG_CREATE_STRUCT *CreateStruct,
UINT32 Value
);
/**
Adds a 64-bit unsigned integer to the Data structure.
@param[in/out] CreateStruct Structure used to add the integer
@param[in] Value Integer Value to add
**/
TCG_RESULT
EFIAPI
TcgAddUINT64(
TCG_CREATE_STRUCT *CreateStruct,
UINT64 Value
);
/**
Adds a BOOLEAN to the Data structure.
@param[in/out] CreateStruct Structure used to add the integer
@param[in] Value BOOLEAN Value to add
**/
TCG_RESULT
EFIAPI
TcgAddBOOLEAN(
TCG_CREATE_STRUCT *CreateStruct,
BOOLEAN Value
);
/**
Add tcg uid info.
@param [in/out] CreateStruct Structure used to add the integer
@param Uid Input uid info.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgAddTcgUid(
TCG_CREATE_STRUCT *CreateStruct,
TCG_UID Uid
);
/**
Adds a Start List token to the Data structure.
@param[in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddStartList(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds an End List token to the Data structure.
@param [in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddEndList(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds a Start Name token to the Data structure.
@param[in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddStartName(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds an End Name token to the Data structure.
@param [in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddEndName(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds a Call token to the Data structure.
@param [in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddCall(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds an End of Data token to the Data structure.
@param[in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddEndOfData(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds an End of Session token to the Data structure.
@param [in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddEndOfSession(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds a Start Transaction token to the Data structure.
@param [in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddStartTransaction(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds an End Transaction token to the Data structure.
@param[in/out] CreateStruct Structure used to add the token
**/
TCG_RESULT
EFIAPI
TcgAddEndTransaction(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Initial the tcg parse stucture.
@param ParseStruct Input parse structure.
@param Buffer Input buffer data.
@param BufferSize Input buffer size.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgInitTcgParseStruct(
TCG_PARSE_STRUCT *ParseStruct,
const VOID *Buffer,
UINT32 BufferSize
);
/**
Get next token info.
@param ParseStruct Input parse structure info.
@param TcgToken return the tcg token info.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextToken(
TCG_PARSE_STRUCT *ParseStruct,
TCG_TOKEN *TcgToken
);
/**
Get next token Type.
@param ParseStruct Input parse structure.
@param Type Input the type need to check.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextTokenType(
TCG_PARSE_STRUCT *ParseStruct,
TCG_TOKEN_TYPE Type
);
/**
Get atom info.
@param TcgToken Input token info.
@param HeaderLength return the header length.
@param DataLength return the data length.
@param ByteOrInt return the atom Type.
@param SignOrCont return the sign or count info.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetAtomInfo(
const TCG_TOKEN *TcgToken,
UINT32 *HeaderLength,
UINT32 *DataLength,
UINT8 *ByteOrInt,
UINT8 *SignOrCont
);
/**
Get token byte sequence.
@param TcgToken Input token info.
@param Length Input the length info.
@retval Return the value data.
**/
UINT8*
EFIAPI
TcgGetTokenByteSequence(
const TCG_TOKEN *TcgToken,
UINT32 *Length
);
/**
Get token specified value.
@param TcgToken Input token info.
@param Value return the value.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetTokenUINT64(
const TCG_TOKEN *TcgToken,
UINT64 *Value
);
/**
Get next specify value.
@param ParseStruct Input parse structure.
@param Value Return value.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextUINT8(
TCG_PARSE_STRUCT *ParseStruct,
UINT8 *Value
);
/**
Get next specify value.
@param ParseStruct Input parse structure.
@param Value Return value.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextUINT16(
TCG_PARSE_STRUCT *ParseStruct,
UINT16 *Value
);
/**
Get next specify value.
@param ParseStruct Input parse structure.
@param Value Return value.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextUINT32(
TCG_PARSE_STRUCT *ParseStruct,
UINT32 *Value
);
/**
Get next specify value.
@param ParseStruct Input parse structure.
@param Value Return value.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextUINT64(
TCG_PARSE_STRUCT *ParseStruct,
UINT64 *Value
);
/**
Get next specify value.
@param ParseStruct Input parse structure.
@param Value Return value.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextBOOLEAN(
TCG_PARSE_STRUCT *ParseStruct,
BOOLEAN *Value
);
/**
Get next tcg uid info.
@param ParseStruct Input parse structure.
@param Uid Get the uid info.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextTcgUid(
TCG_PARSE_STRUCT *ParseStruct,
TCG_UID *Uid
);
/**
Get next byte sequence.
@param ParseStruct Input parse structure.
@param Data return the data.
@param Length return the length.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextByteSequence(
TCG_PARSE_STRUCT *ParseStruct,
const VOID **Data,
UINT32 *Length
);
/**
Get next start list.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextStartList(
TCG_PARSE_STRUCT *ParseStruct
);
/**
Get next end list.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextEndList(
TCG_PARSE_STRUCT *ParseStruct
);
/**
Get next start name.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextStartName(
TCG_PARSE_STRUCT *ParseStruct
);
/**
Get next end name.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextEndName(
TCG_PARSE_STRUCT *ParseStruct
);
/**
Get next call.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextCall(
TCG_PARSE_STRUCT *ParseStruct
);
/**
Get next end data.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextEndOfData(
TCG_PARSE_STRUCT *ParseStruct
);
/**
Get next end of session.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextEndOfSession(
TCG_PARSE_STRUCT *ParseStruct
);
/**
Get next start transaction.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextStartTransaction(
TCG_PARSE_STRUCT *ParseStruct
);
/**
Get next end transaction.
@param ParseStruct Input parse structure.
@retval return the action result.
**/
TCG_RESULT
EFIAPI
TcgGetNextEndTransaction(
TCG_PARSE_STRUCT *ParseStruct
);
// end of parse functions
typedef
BOOLEAN
(EFIAPI* TCG_LEVEL0_ENUM_CALLBACK) (
const TCG_LEVEL0_DISCOVERY_HEADER *DiscoveryHeader,
TCG_LEVEL0_FEATURE_DESCRIPTOR_HEADER *Feature,
UINTN FeatureSize, // includes header
VOID *Context
);
/**
Adds call token and method Header (invoking id, and method id).
@param CreateStruct The input create structure.
@param InvokingId Invoking id.
@param MethodId Method id.
**/
TCG_RESULT
EFIAPI
TcgStartMethodCall(
TCG_CREATE_STRUCT *CreateStruct,
TCG_UID InvokingId,
TCG_UID MethodId
);
/**
Adds START LIST token.
@param CreateStruct The input create structure.
**/
TCG_RESULT
EFIAPI
TcgStartParameters(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds END LIST token.
@param CreateStruct The input create structure.
**/
TCG_RESULT
EFIAPI
TcgEndParameters(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds END Data token and method list.
@param CreateStruct The input create structure.
**/
TCG_RESULT
EFIAPI
TcgEndMethodCall(
TCG_CREATE_STRUCT *CreateStruct
);
/**
Adds Start Session call to the data structure. This creates the entire ComPacket structure and
returns the size of the entire compacket in the size parameter.
@param [in/out] CreateStruct Structure used to add the start session call
@param [in/out] Size Describes the size of the entire ComPacket (header and payload). Filled out by function.
@param [in] ComId ComID for the ComPacket
@param [in] ComIdExtension Extended ComID for the ComPacket
@param [in] HostSessionId Host Session ID
@param [in] SpId Security Provider to start session with
@param [in] Write Write option for start session. TRUE = start session requests write access
@param [in] HostChallengeLength Length of the host challenge. Length should be 0 if hostChallenge is NULL
@param [in] HostChallenge Host challenge for Host Signing Authority. If NULL, then no Host Challenge shall be sent.
@param [in] HostSigningAuthority Host Signing Authority used for start session. If NULL, then no Host Signing Authority shall be sent.
**/
TCG_RESULT
EFIAPI
TcgCreateStartSession(
TCG_CREATE_STRUCT *CreateStruct,
UINT32 *Size,
UINT16 ComId,
UINT16 ComIdExtension,
UINT32 HostSessionId,
TCG_UID SpId,
BOOLEAN Write,
UINT32 HostChallengeLength,
const VOID *HostChallenge,
TCG_UID HostSigningAuthority
);
/**
Creates ComPacket with a Method call that sets the PIN column for the row specified.
This assumes a start session has already been opened with the desired SP.
@param [in/out] CreateStruct Structure used to add method call.
@param [in/out] Size Describes the size of the entire ComPacket (header and payload). Filled out by function.
@param [in] ComId ComID for the ComPacket
@param [in] ComIdExtension Extended ComID for the ComPacket
@param [in] TperSession Tper Session ID for the Packet
@param [in] HostSession Host Session ID for the Packet
@param [in] SidRow UID of row of current SP to set PIN column
@param [in] Password value of PIN to set
@param [in] PasswordSize Size of PIN
**/
TCG_RESULT
EFIAPI
TcgCreateSetCPin(
TCG_CREATE_STRUCT *CreateStruct,
UINT32 *Size,
UINT16 ComId,
UINT16 ComIdExtension,
UINT32 TperSession,
UINT32 HostSession,
TCG_UID SidRow,
const VOID *Password,
UINT32 PasswordSize
);
/**
Creates ComPacket with a Method call that sets the "Enabled" column for the row specified using the value specified.
This assumes a start session has already been opened with the desired SP.
@param [in/out] CreateStruct Structure used to add method call
@param [in/out] Size Describes the size of the entire ComPacket (header and payload). Filled out by function.
@param [in] ComId ComID for the ComPacket
@param [in] ComIdExtension Extended ComID for the ComPacket
@param [in] TperSession Tper Session ID for the Packet
@param [in] HostSession Host Session ID for the Packet
@param [in] AuthorityUid Authority UID to modify the "Enabled" column for
@param [in] Enabled Value to set the "Enabled" column to
**/
TCG_RESULT
EFIAPI
TcgSetAuthorityEnabled(
TCG_CREATE_STRUCT *CreateStruct,
UINT32 *Size,
UINT16 ComId,
UINT16 ComIdExtension,
UINT32 TperSession,
UINT32 HostSession,
TCG_UID AuthorityUid,
BOOLEAN Enabled
);
/**
Creates ComPacket with EndSession.
This assumes a start session has already been opened.
@param [in/out] CreateStruct Structure used to add Endsession
@param [in/out] Size Describes the size of the entire ComPacket (header and payload). Filled out by function.
@param [in] ComId ComID for the ComPacket
@param [in] ComIdExtension Extended ComID for the ComPacket
@param [in] HostSessionId Host Session ID for the Packet
@param [in] TpSessionId Tper Session ID for the Packet
**/
TCG_RESULT
EFIAPI
TcgCreateEndSession(
TCG_CREATE_STRUCT *CreateStruct,
UINT32 *Size,
UINT16 ComId,
UINT16 ComIdExtension,
UINT32 HostSessionId,
UINT32 TpSessionId
);
/**
Retrieves human-readable token type name.
@param[in] Type Token type to retrieve
**/
CHAR8*
EFIAPI
TcgTokenTypeString(
TCG_TOKEN_TYPE Type
);
/**
Returns the method status of the current subpacket. Does not affect the current position
in the ComPacket. In other words, it can be called whenever you have a valid SubPacket.
@param [in/out] ParseStruct Structure used to parse received TCG response
@param [in/out] MethodStatus Method status retrieved of the current SubPacket
**/
TCG_RESULT
EFIAPI
TcgGetMethodStatus(
const TCG_PARSE_STRUCT *ParseStruct,
UINT8 *MethodStatus
);
/**
Returns a human-readable string representing a method status return code.
@param[in] MethodStatus Method status to translate to a string
@retval return the string info.
**/
CHAR8*
EFIAPI
TcgMethodStatusString(
UINT8 MethodStatus
);
/**
Retrieves the comID and Extended comID of the ComPacket in the Tcg response.
It is intended to be used to confirm the received Tcg response is intended for user that received it.
@param [in] ParseStruct Structure used to parse received TCG response.
@param [in/out] ComId comID retrieved from received ComPacket.
@param [in/out] ComIdExtension Extended comID retrieved from received ComPacket
**/
TCG_RESULT
EFIAPI
TcgGetComIds(
const TCG_PARSE_STRUCT *ParseStruct,
UINT16 *ComId,
UINT16 *ComIdExtension
);
/**
Checks if the ComIDs of the response match the expected values.
@param[in] ParseStruct Structure used to parse received TCG response
@param[in] ExpectedComId Expected comID
@param[in] ExpectedComIdExtension Expected extended comID
**/
TCG_RESULT
EFIAPI
TcgCheckComIds(
const TCG_PARSE_STRUCT *ParseStruct,
UINT16 ExpectedComId,
UINT16 ExpectedComIdExtension
);
/**
Parses the Sync Session response contained in the parseStruct to retrieve Tper session ID. If the Sync Session response
parameters do not match the comID, extended ComID and host session ID then a failure is returned.
@param[in/out] ParseStruct Structure used to parse received TCG response, contains Sync Session response.
@param[in] ComId Expected ComID that is compared to actual ComID of response
@param[in] ComIdExtension Expected Extended ComID that is compared to actual Extended ComID of response
@param[in] HostSessionId Expected Host Session ID that is compared to actual Host Session ID of response
@param[in/out] TperSessionId Tper Session ID retrieved from the Sync Session response.
**/
TCG_RESULT
EFIAPI
TcgParseSyncSession(
const TCG_PARSE_STRUCT *ParseStruct,
UINT16 ComId,
UINT16 ComIdExtension,
UINT32 HostSessionId,
UINT32 *TperSessionId
);
/**
Create set ace.
@param CreateStruct Input create structure.
@param Size size info.
@param ComId ComId info.
@param ComIdExtension ComId extension info.
@param TperSession Tper session data.
@param HostSession Host session data.
@param AceRow Ace row info.
@param Authority1 Authority 1 info.
@param LogicalOperator Logiccal operator info.
@param Authority2 Authority 2 info.
@retval Return the action result.
**/
TCG_RESULT
EFIAPI
TcgCreateSetAce(
TCG_CREATE_STRUCT *CreateStruct,
UINT32 *Size,
UINT16 ComId,
UINT16 ComIdExtension,
UINT32 TperSession,
UINT32 HostSession,
TCG_UID AceRow,
TCG_UID Authority1,
BOOLEAN LogicalOperator,
TCG_UID Authority2
);
/**
Enum level 0 discovery.
@param DiscoveryHeader Discovery header.
@param Callback Callback function.
@param Context The context for the function.
@retval return true if the callback return TRUE, else return FALSE.
**/
BOOLEAN
EFIAPI
TcgEnumLevel0Discovery(
const TCG_LEVEL0_DISCOVERY_HEADER *DiscoveryHeader,
TCG_LEVEL0_ENUM_CALLBACK Callback,
VOID *Context
);
/**
Get Feature code from the header.
@param DiscoveryHeader The discovery header.
@param FeatureCode return the Feature code.
@param FeatureSize return the Feature size.
@retval return the Feature code data.
**/
TCG_LEVEL0_FEATURE_DESCRIPTOR_HEADER*
EFIAPI
TcgGetFeature(
const TCG_LEVEL0_DISCOVERY_HEADER *DiscoveryHeader,
UINT16 FeatureCode,
UINTN *FeatureSize
);
/**
Determines if the protocol provided is part of the provided supported protocol list.
@param[in] ProtocolList Supported protocol list to investigate
@param[in] Protocol Protocol value to determine if supported
@return TRUE = protocol is supported, FALSE = protocol is not supported
**/
BOOLEAN
EFIAPI
TcgIsProtocolSupported(
const TCG_SUPPORTED_SECURITY_PROTOCOLS *ProtocolList,
UINT16 Protocol
);
/**
Determines if the Locking Feature "Locked" bit is set in the level 0 discovery response.
@param[in] Discovery Level 0 discovery response
@return TRUE = Locked is set, FALSE = Locked is false
**/
BOOLEAN
EFIAPI
TcgIsLocked(
const TCG_LEVEL0_DISCOVERY_HEADER *Discovery
);
#pragma pack()
#endif // _TCG_CORE_H_
|