2 HII Config Access protocol implementation of TCG configuration module.
4 Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "TcgConfigImpl.h"
17 CHAR16 mTcgStorageName
[] = L
"TCG_CONFIGURATION";
19 TCG_CONFIG_PRIVATE_DATA mTcgConfigPrivateDateTemplate
= {
20 TCG_CONFIG_PRIVATE_DATA_SIGNATURE
,
28 HII_VENDOR_DEVICE_PATH mTcgHiiVendorDevicePath
= {
34 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
35 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
38 TCG_CONFIG_FORM_SET_GUID
42 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
44 (UINT8
) (END_DEVICE_PATH_LENGTH
),
45 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
51 Get current state of TPM device.
53 @param[in] TcgProtocol Point to EFI_TCG_PROTOCOL instance.
54 @param[out] TpmEnable Flag to indicate TPM is enabled or not.
55 @param[out] TpmActivate Flag to indicate TPM is activated or not.
57 @retval EFI_SUCCESS State is successfully returned.
58 @retval EFI_DEVICE_ERROR Failed to get TPM response.
59 @retval Others Other errors as indicated.
64 IN EFI_TCG_PROTOCOL
*TcgProtocol
,
65 OUT BOOLEAN
*TpmEnable
, OPTIONAL
66 OUT BOOLEAN
*TpmActivate OPTIONAL
70 TPM_RSP_COMMAND_HDR
*TpmRsp
;
72 TPM_PERMANENT_FLAGS
*TpmPermanentFlags
;
75 ASSERT (TcgProtocol
!= NULL
);
78 // Get TPM Permanent flags (TpmEnable, TpmActivate)
80 if ((TpmEnable
!= NULL
) || (TpmActivate
!= NULL
)) {
81 TpmSendSize
= sizeof (TPM_RQU_COMMAND_HDR
) + sizeof (UINT32
) * 3;
82 *(UINT16
*)&CmdBuf
[0] = SwapBytes16 (TPM_TAG_RQU_COMMAND
);
83 *(UINT32
*)&CmdBuf
[2] = SwapBytes32 (TpmSendSize
);
84 *(UINT32
*)&CmdBuf
[6] = SwapBytes32 (TPM_ORD_GetCapability
);
86 *(UINT32
*)&CmdBuf
[10] = SwapBytes32 (TPM_CAP_FLAG
);
87 *(UINT32
*)&CmdBuf
[14] = SwapBytes32 (sizeof (TPM_CAP_FLAG_PERMANENT
));
88 *(UINT32
*)&CmdBuf
[18] = SwapBytes32 (TPM_CAP_FLAG_PERMANENT
);
90 Status
= TcgProtocol
->PassThroughToTpm (
97 TpmRsp
= (TPM_RSP_COMMAND_HDR
*) &CmdBuf
[0];
98 if (EFI_ERROR (Status
) || (TpmRsp
->tag
!= SwapBytes16 (TPM_TAG_RSP_COMMAND
)) || (TpmRsp
->returnCode
!= 0)) {
99 return EFI_DEVICE_ERROR
;
102 TpmPermanentFlags
= (TPM_PERMANENT_FLAGS
*) &CmdBuf
[sizeof (TPM_RSP_COMMAND_HDR
) + sizeof (UINT32
)];
104 if (TpmEnable
!= NULL
) {
105 *TpmEnable
= (BOOLEAN
) !TpmPermanentFlags
->disable
;
108 if (TpmActivate
!= NULL
) {
109 *TpmActivate
= (BOOLEAN
) !TpmPermanentFlags
->deactivated
;
117 This function allows a caller to extract the current configuration for one
118 or more named elements from the target driver.
120 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
121 @param[in] Request A null-terminated Unicode string in
122 <ConfigRequest> format.
123 @param[out] Progress On return, points to a character in the Request
124 string. Points to the string's null terminator if
125 request was successful. Points to the most recent
126 '&' before the first failing name/value pair (or
127 the beginning of the string if the failure is in
128 the first name/value pair) if the request was not
130 @param[out] Results A null-terminated Unicode string in
131 <ConfigAltResp> format which has all values filled
132 in for the names in the Request string. String to
133 be allocated by the called function.
135 @retval EFI_SUCCESS The Results is filled with the requested values.
136 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
137 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
138 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
145 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
146 IN CONST EFI_STRING Request
,
147 OUT EFI_STRING
*Progress
,
148 OUT EFI_STRING
*Results
152 TCG_CONFIG_PRIVATE_DATA
*PrivateData
;
153 EFI_STRING ConfigRequestHdr
;
154 EFI_STRING ConfigRequest
;
155 BOOLEAN AllocatedRequest
;
160 if (Progress
== NULL
|| Results
== NULL
) {
161 return EFI_INVALID_PARAMETER
;
165 if ((Request
!= NULL
) && !HiiIsConfigHdrMatch (Request
, &gTcgConfigFormSetGuid
, mTcgStorageName
)) {
166 return EFI_NOT_FOUND
;
169 ConfigRequestHdr
= NULL
;
170 ConfigRequest
= NULL
;
171 AllocatedRequest
= FALSE
;
174 PrivateData
= TCG_CONFIG_PRIVATE_DATA_FROM_THIS (This
);
177 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
179 PrivateData
->Configuration
->TpmOperation
= PHYSICAL_PRESENCE_ENABLE
;
182 // Get current TPM state.
184 if (PrivateData
->TcgProtocol
!= NULL
) {
185 Status
= GetTpmState (PrivateData
->TcgProtocol
, &TpmEnable
, &TpmActivate
);
186 if (EFI_ERROR (Status
)) {
190 PrivateData
->Configuration
->TpmEnable
= TpmEnable
;
191 PrivateData
->Configuration
->TpmActivate
= TpmActivate
;
194 ConfigRequest
= Request
;
195 if ((Request
== NULL
) || (StrStr (Request
, L
"OFFSET") == NULL
)) {
197 // Request has no request element, construct full request string.
198 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
199 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
201 ConfigRequestHdr
= HiiConstructConfigHdr (&gTcgConfigFormSetGuid
, mTcgStorageName
, PrivateData
->DriverHandle
);
202 Size
= (StrLen (ConfigRequestHdr
) + 32 + 1) * sizeof (CHAR16
);
203 ConfigRequest
= AllocateZeroPool (Size
);
204 ASSERT (ConfigRequest
!= NULL
);
205 AllocatedRequest
= TRUE
;
206 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr
, sizeof (TCG_CONFIGURATION
));
207 FreePool (ConfigRequestHdr
);
210 Status
= gHiiConfigRouting
->BlockToConfig (
213 (UINT8
*) PrivateData
->Configuration
,
214 sizeof (TCG_CONFIGURATION
),
219 // Free the allocated config request string.
221 if (AllocatedRequest
) {
222 FreePool (ConfigRequest
);
225 // Set Progress string to the original request string.
227 if (Request
== NULL
) {
229 } else if (StrStr (Request
, L
"OFFSET") == NULL
) {
230 *Progress
= Request
+ StrLen (Request
);
237 This function processes the results of changes in configuration.
239 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
240 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
242 @param[out] Progress A pointer to a string filled in with the offset of
243 the most recent '&' before the first failing
244 name/value pair (or the beginning of the string if
245 the failure is in the first name/value pair) or
246 the terminating NULL if all was successful.
248 @retval EFI_SUCCESS The Results is processed successfully.
249 @retval EFI_INVALID_PARAMETER Configuration is NULL.
250 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
257 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
258 IN CONST EFI_STRING Configuration
,
259 OUT EFI_STRING
*Progress
264 TCG_CONFIGURATION TcgConfiguration
;
266 if (Configuration
== NULL
|| Progress
== NULL
) {
267 return EFI_INVALID_PARAMETER
;
270 *Progress
= Configuration
;
271 if (!HiiIsConfigHdrMatch (Configuration
, &gTcgConfigFormSetGuid
, mTcgStorageName
)) {
272 return EFI_NOT_FOUND
;
276 // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()
278 BufferSize
= sizeof (TCG_CONFIGURATION
);
279 Status
= gHiiConfigRouting
->ConfigToBlock (
282 (UINT8
*) &TcgConfiguration
,
286 if (EFI_ERROR (Status
)) {
294 Save TPM request to variable space.
296 @param[in] PpRequest Physical Presence request command.
298 @retval EFI_SUCCESS The operation is finished successfully.
299 @retval Others Other errors as indicated.
309 EFI_PHYSICAL_PRESENCE PpData
;
312 // Save TPM command to variable.
314 DataSize
= sizeof (EFI_PHYSICAL_PRESENCE
);
315 Status
= gRT
->GetVariable (
316 PHYSICAL_PRESENCE_VARIABLE
,
317 &gEfiPhysicalPresenceGuid
,
322 if (EFI_ERROR (Status
)) {
326 PpData
.PPRequest
= PpRequest
;
327 Status
= gRT
->SetVariable (
328 PHYSICAL_PRESENCE_VARIABLE
,
329 &gEfiPhysicalPresenceGuid
,
330 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
334 if (EFI_ERROR(Status
)) {
342 This function processes the results of changes in configuration.
344 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
345 @param[in] Action Specifies the type of action taken by the browser.
346 @param[in] QuestionId A unique value which is sent to the original
347 exporting driver so that it can identify the type
349 @param[in] Type The type of value for the question.
350 @param[in] Value A pointer to the data being sent to the original
352 @param[out] ActionRequest On return, points to the action requested by the
355 @retval EFI_SUCCESS The callback successfully handled the action.
356 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
357 variable and its data.
358 @retval EFI_DEVICE_ERROR The variable could not be saved.
359 @retval EFI_UNSUPPORTED The specified Action is not supported by the
366 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
367 IN EFI_BROWSER_ACTION Action
,
368 IN EFI_QUESTION_ID QuestionId
,
370 IN EFI_IFR_TYPE_VALUE
*Value
,
371 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
374 TCG_CONFIG_PRIVATE_DATA
*PrivateData
;
377 if ((This
== NULL
) || (Value
== NULL
) || (ActionRequest
== NULL
)) {
378 return EFI_INVALID_PARAMETER
;
381 if (Action
== EFI_BROWSER_ACTION_FORM_OPEN
) {
382 if (QuestionId
== KEY_TPM_ACTION
) {
384 PrivateData
= TCG_CONFIG_PRIVATE_DATA_FROM_THIS (This
);
389 PrivateData
->Configuration
->TpmEnable
? L
"Enabled" : L
"Disabled",
390 PrivateData
->Configuration
->TpmActivate
? L
"Activated" : L
"Deactivated"
392 HiiSetString (PrivateData
->HiiHandle
, STRING_TOKEN (STR_TPM_STATE_CONTENT
), State
, NULL
);
397 if ((Action
!= EFI_BROWSER_ACTION_CHANGED
) || (QuestionId
!= KEY_TPM_ACTION
)) {
398 return EFI_UNSUPPORTED
;
401 SavePpRequest (Value
->u8
);
402 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
408 This function publish the TCG configuration Form for TPM device.
410 @param[in, out] PrivateData Points to TCG configuration private data.
412 @retval EFI_SUCCESS HII Form is installed for this network device.
413 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
414 @retval Others Other errors as indicated.
418 InstallTcgConfigForm (
419 IN OUT TCG_CONFIG_PRIVATE_DATA
*PrivateData
423 EFI_HII_HANDLE HiiHandle
;
424 EFI_HANDLE DriverHandle
;
425 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
428 ConfigAccess
= &PrivateData
->ConfigAccess
;
429 Status
= gBS
->InstallMultipleProtocolInterfaces (
431 &gEfiDevicePathProtocolGuid
,
432 &mTcgHiiVendorDevicePath
,
433 &gEfiHiiConfigAccessProtocolGuid
,
437 if (EFI_ERROR (Status
)) {
441 PrivateData
->DriverHandle
= DriverHandle
;
444 // Publish the HII package list
446 HiiHandle
= HiiAddPackages (
447 &gTcgConfigFormSetGuid
,
453 if (HiiHandle
== NULL
) {
454 gBS
->UninstallMultipleProtocolInterfaces (
456 &gEfiDevicePathProtocolGuid
,
457 &mTcgHiiVendorDevicePath
,
458 &gEfiHiiConfigAccessProtocolGuid
,
463 return EFI_OUT_OF_RESOURCES
;
466 PrivateData
->HiiHandle
= HiiHandle
;
472 This function removes TCG configuration Form.
474 @param[in, out] PrivateData Points to TCG configuration private data.
478 UninstallTcgConfigForm (
479 IN OUT TCG_CONFIG_PRIVATE_DATA
*PrivateData
483 // Uninstall HII package list
485 if (PrivateData
->HiiHandle
!= NULL
) {
486 HiiRemovePackages (PrivateData
->HiiHandle
);
487 PrivateData
->HiiHandle
= NULL
;
491 // Uninstall HII Config Access Protocol
493 if (PrivateData
->DriverHandle
!= NULL
) {
494 gBS
->UninstallMultipleProtocolInterfaces (
495 PrivateData
->DriverHandle
,
496 &gEfiDevicePathProtocolGuid
,
497 &mTcgHiiVendorDevicePath
,
498 &gEfiHiiConfigAccessProtocolGuid
,
499 &PrivateData
->ConfigAccess
,
502 PrivateData
->DriverHandle
= NULL
;
505 if (PrivateData
->Configuration
!= NULL
) {
506 FreePool(PrivateData
->Configuration
);
508 FreePool (PrivateData
);