SecurityPkg: Apply uncrustify changes

[mirror_edk2.git] / SecurityPkg / Tcg / Tcg2Config / Tcg2ConfigImpl.h

/** @file\r
  The header file of HII Config Access protocol implementation of TCG2\r
  configuration module.\r
\r
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __TCG2_CONFIG_IMPL_H__\r
#define __TCG2_CONFIG_IMPL_H__\r
\r
#include <Uefi.h>\r
\r
#include <IndustryStandard/Tpm2Acpi.h>\r
\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/Tcg2Protocol.h>\r
#include <Protocol/VariableLock.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/Tcg2PhysicalPresenceLib.h>\r
\r
#include <Guid/MdeModuleHii.h>\r
\r
#include "Tcg2ConfigNvData.h"\r
#include "Tcg2Internal.h"\r
\r
#define TCG2_PROTOCOL_VERSION_DEFAULT  0x0001\r
\r
//\r
// Tool generated IFR binary data and String package data\r
//\r
extern UINT8  Tcg2ConfigBin[];\r
extern UINT8  Tcg2ConfigDxeStrings[];\r
\r
///\r
/// HII specific Vendor Device Path definition.\r
///\r
typedef struct {\r
  VENDOR_DEVICE_PATH          VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL    End;\r
} HII_VENDOR_DEVICE_PATH;\r
\r
typedef struct {\r
  UINTN                               Signature;\r
\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL      ConfigAccess;\r
  EFI_HII_HANDLE                      HiiHandle;\r
  EFI_HANDLE                          DriverHandle;\r
\r
  UINT8                               TpmDeviceDetected;\r
  EFI_TCG2_PROTOCOL                   *Tcg2Protocol;\r
  EFI_TCG2_BOOT_SERVICE_CAPABILITY    ProtocolCapability;\r
  UINT32                              PCRBanksDesired;\r
} TCG2_CONFIG_PRIVATE_DATA;\r
\r
extern TCG2_CONFIG_PRIVATE_DATA  mTcg2ConfigPrivateDateTemplate;\r
extern TCG2_CONFIG_PRIVATE_DATA  *mTcg2ConfigPrivateDate;\r
#define TCG2_CONFIG_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('T', 'r', 'E', 'D')\r
#define TCG2_CONFIG_PRIVATE_DATA_FROM_THIS(a)  CR (a, TCG2_CONFIG_PRIVATE_DATA, ConfigAccess, TCG2_CONFIG_PRIVATE_DATA_SIGNATURE)\r
\r
#define TPM_HID_PNP_SIZE   8\r
#define TPM_HID_ACPI_SIZE  9\r
\r
/**\r
  This function publish the TCG2 configuration Form for TPM device.\r
\r
  @param[in, out]  PrivateData   Points to TCG2 configuration private data.\r
\r
  @retval EFI_SUCCESS            HII Form is installed for this network device.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough resource for HII Form installation.\r
  @retval Others                 Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
InstallTcg2ConfigForm (\r
  IN OUT TCG2_CONFIG_PRIVATE_DATA  *PrivateData\r
  );\r
\r
/**\r
  This function removes TCG2 configuration Form.\r
\r
  @param[in, out]  PrivateData   Points to TCG2 configuration private data.\r
\r
**/\r
VOID\r
UninstallTcg2ConfigForm (\r
  IN OUT TCG2_CONFIG_PRIVATE_DATA  *PrivateData\r
  );\r
\r
/**\r
  This function allows a caller to extract the current configuration for one\r
  or more named elements from the target driver.\r
\r
  @param[in]   This              Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param[in]   Request           A null-terminated Unicode string in\r
                                 <ConfigRequest> format.\r
  @param[out]  Progress          On return, points to a character in the Request\r
                                 string. Points to the string's null terminator if\r
                                 request was successful. Points to the most recent\r
                                 '&' before the first failing name/value pair (or\r
                                 the beginning of the string if the failure is in\r
                                 the first name/value pair) if the request was not\r
                                 successful.\r
  @param[out]  Results           A null-terminated Unicode string in\r
                                 <ConfigAltResp> format which has all values filled\r
                                 in for the names in the Request string. String to\r
                                 be allocated by the called function.\r
\r
  @retval EFI_SUCCESS            The Results is filled with the requested values.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough memory to store the results.\r
  @retval EFI_INVALID_PARAMETER  Request is illegal syntax, or unknown name.\r
  @retval EFI_NOT_FOUND          Routing data doesn't match any storage in this\r
                                 driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcg2ExtractConfig (\r
  IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  IN CONST EFI_STRING                      Request,\r
  OUT EFI_STRING                           *Progress,\r
  OUT EFI_STRING                           *Results\r
  );\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
  @param[in]  This               Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param[in]  Configuration      A null-terminated Unicode string in <ConfigResp>\r
                                 format.\r
  @param[out] Progress           A pointer to a string filled in with the offset of\r
                                 the most recent '&' before the first failing\r
                                 name/value pair (or the beginning of the string if\r
                                 the failure is in the first name/value pair) or\r
                                 the terminating NULL if all was successful.\r
\r
  @retval EFI_SUCCESS            The Results is processed successfully.\r
  @retval EFI_INVALID_PARAMETER  Configuration is NULL.\r
  @retval EFI_NOT_FOUND          Routing data doesn't match any storage in this\r
                                 driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcg2RouteConfig (\r
  IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  IN CONST EFI_STRING                      Configuration,\r
  OUT EFI_STRING                           *Progress\r
  );\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
  @param[in]  This               Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param[in]  Action             Specifies the type of action taken by the browser.\r
  @param[in]  QuestionId         A unique value which is sent to the original\r
                                 exporting driver so that it can identify the type\r
                                 of data to expect.\r
  @param[in]  Type               The type of value for the question.\r
  @param[in]  Value              A pointer to the data being sent to the original\r
                                 exporting driver.\r
  @param[out] ActionRequest      On return, points to the action requested by the\r
                                 callback function.\r
\r
  @retval EFI_SUCCESS            The callback successfully handled the action.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the\r
                                 variable and its data.\r
  @retval EFI_DEVICE_ERROR       The variable could not be saved.\r
  @retval EFI_UNSUPPORTED        The specified Action is not supported by the\r
                                 callback.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcg2Callback (\r
  IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  IN     EFI_BROWSER_ACTION                Action,\r
  IN     EFI_QUESTION_ID                   QuestionId,\r
  IN     UINT8                             Type,\r
  IN     EFI_IFR_TYPE_VALUE                *Value,\r
  OUT EFI_BROWSER_ACTION_REQUEST           *ActionRequest\r
  );\r
\r
#endif\r