SecurityPkg/Tcg/TrEEConfig/TrEEConfigImpl.h File Reference


Data Structures

struct  HII_VENDOR_DEVICE_PATH
struct  TREE_CONFIG_PRIVATE_DATA

Defines

#define TREE_CONFIG_PRIVATE_DATA_SIGNATURE   SIGNATURE_32 ('T', 'r', 'E', 'D')
#define TREE_CONFIG_PRIVATE_DATA_FROM_THIS(a)   CR (a, TREE_CONFIG_PRIVATE_DATA, ConfigAccess, TREE_CONFIG_PRIVATE_DATA_SIGNATURE)

Functions

EFI_STATUS InstallTrEEConfigForm (IN OUT TREE_CONFIG_PRIVATE_DATA *PrivateData)
VOID UninstallTrEEConfigForm (IN OUT TREE_CONFIG_PRIVATE_DATA *PrivateData)
EFI_STATUS EFIAPI TrEEExtractConfig (IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, IN CONST EFI_STRING Request, OUT EFI_STRING *Progress, OUT EFI_STRING *Results)
EFI_STATUS EFIAPI TrEERouteConfig (IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, IN CONST EFI_STRING Configuration, OUT EFI_STRING *Progress)
EFI_STATUS EFIAPI TrEECallback (IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, IN EFI_BROWSER_ACTION Action, IN EFI_QUESTION_ID QuestionId, IN UINT8 Type, IN EFI_IFR_TYPE_VALUE *Value, OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest)

Variables

UINT8 TrEEConfigBin []
UINT8 TrEEConfigDxeStrings []
TREE_CONFIG_PRIVATE_DATA mTrEEConfigPrivateDateTemplate

Detailed Description

The header file of HII Config Access protocol implementation of TREE configuration module.

Copyright (c) 2013, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define TREE_CONFIG_PRIVATE_DATA_FROM_THIS (  )     CR (a, TREE_CONFIG_PRIVATE_DATA, ConfigAccess, TREE_CONFIG_PRIVATE_DATA_SIGNATURE)

#define TREE_CONFIG_PRIVATE_DATA_SIGNATURE   SIGNATURE_32 ('T', 'r', 'E', 'D')

Referenced by TrEEConfigDriverUnload().


Function Documentation

EFI_STATUS InstallTrEEConfigForm ( IN OUT TREE_CONFIG_PRIVATE_DATA PrivateData  ) 

This function publish the TREE configuration Form for TPM device.

Parameters:
[in,out] PrivateData Points to TREE configuration private data.
Return values:
EFI_SUCCESS HII Form is installed for this network device.
EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
Others Other errors as indicated.

References EFI_STATUS(), gTrEEConfigFormSetGuid, TPM_DEVICE_1_2, TPM_DEVICE_2_0_DTPM, TPM_DEVICE_NULL, TrEEConfigBin, and TrEEConfigDxeStrings.

Referenced by TrEEConfigDriverEntryPoint().

EFI_STATUS EFIAPI TrEECallback ( IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *  This,
IN EFI_BROWSER_ACTION  Action,
IN EFI_QUESTION_ID  QuestionId,
IN UINT8  Type,
IN EFI_IFR_TYPE_VALUE *  Value,
OUT EFI_BROWSER_ACTION_REQUEST *  ActionRequest 
)

This function processes the results of changes in configuration.

Parameters:
[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
[in] Action Specifies the type of action taken by the browser.
[in] QuestionId A unique value which is sent to the original exporting driver so that it can identify the type of data to expect.
[in] Type The type of value for the question.
[in] Value A pointer to the data being sent to the original exporting driver.
[out] ActionRequest On return, points to the action requested by the callback function.
Return values:
EFI_SUCCESS The callback successfully handled the action.
EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
EFI_DEVICE_ERROR The variable could not be saved.
EFI_UNSUPPORTED The specified Action is not supported by the callback.

References KEY_TPM2_OPERATION, KEY_TPM_DEVICE, and SaveTrEEPpRequest().

EFI_STATUS EFIAPI TrEEExtractConfig ( IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *  This,
IN CONST EFI_STRING  Request,
OUT EFI_STRING *  Progress,
OUT EFI_STRING *  Results 
)

This function allows a caller to extract the current configuration for one or more named elements from the target driver.

Parameters:
[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
[in] Request A null-terminated Unicode string in <ConfigRequest> format.
[out] Progress On return, points to a character in the Request string. Points to the string's null terminator if request was successful. Points to the most recent '&' before the first failing name/value pair (or the beginning of the string if the failure is in the first name/value pair) if the request was not successful.
[out] Results A null-terminated Unicode string in <ConfigAltResp> format which has all values filled in for the names in the Request string. String to be allocated by the called function.
Return values:
EFI_SUCCESS The Results is filled with the requested values.
EFI_OUT_OF_RESOURCES Not enough memory to store the results.
EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
EFI_NOT_FOUND Routing data doesn't match any storage in this driver.

EFI_STATUS EFIAPI TrEERouteConfig ( IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *  This,
IN CONST EFI_STRING  Configuration,
OUT EFI_STRING *  Progress 
)

This function processes the results of changes in configuration.

Parameters:
[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
[in] Configuration A null-terminated Unicode string in <ConfigResp> format.
[out] Progress A pointer to a string filled in with the offset of the most recent '&' before the first failing name/value pair (or the beginning of the string if the failure is in the first name/value pair) or the terminating NULL if all was successful.
Return values:
EFI_SUCCESS The Results is processed successfully.
EFI_INVALID_PARAMETER Configuration is NULL.
EFI_NOT_FOUND Routing data doesn't match any storage in this driver.

VOID UninstallTrEEConfigForm ( IN OUT TREE_CONFIG_PRIVATE_DATA PrivateData  ) 

This function removes TREE configuration Form.

Parameters:
[in,out] PrivateData Points to TREE configuration private data.

Referenced by TrEEConfigDriverEntryPoint(), and TrEEConfigDriverUnload().


Variable Documentation

UINT8 TrEEConfigBin[]

Referenced by InstallTrEEConfigForm().

Referenced by InstallTrEEConfigForm().


Generated on Thu Sep 24 23:44:24 2015 for SecurityPkg[ALL] by  doxygen 1.5.7.1