SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / HddPassword / HddPasswordDxe.h

/** @file\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _HDD_PASSWORD_DXE_H_\r
#define _HDD_PASSWORD_DXE_H_\r
\r
#include <Uefi.h>\r
\r
#include <IndustryStandard/Atapi.h>\r
#include <IndustryStandard/Pci.h>\r
#include <Protocol/AtaPassThru.h>\r
#include <Protocol/PciIo.h>\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/VariableLock.h>\r
\r
#include <Guid/MdeModuleHii.h>\r
#include <Guid/EventGroup.h>\r
#include <Guid/S3StorageDeviceInitList.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/LockBoxLib.h>\r
#include <Library/S3BootScriptLib.h>\r
#include <Library/PciLib.h>\r
#include <Library/BaseCryptLib.h>\r
\r
#include "HddPasswordCommon.h"\r
#include "HddPasswordHiiDataStruc.h"\r
\r
//\r
// This is the generated IFR binary data for each formset defined in VFR.\r
// This data array is ready to be used as input of HiiAddPackages() to\r
// create a packagelist (which contains Form packages, String packages, etc).\r
//\r
extern UINT8  HddPasswordBin[];\r
\r
//\r
// This is the generated String package data for all .UNI files.\r
// This data array is ready to be used as input of HiiAddPackages() to\r
// create a packagelist (which contains Form packages, String packages, etc).\r
//\r
extern UINT8  HddPasswordDxeStrings[];\r
\r
#define HDD_PASSWORD_DXE_PRIVATE_SIGNATURE SIGNATURE_32 ('H', 'D', 'D', 'P')\r
\r
typedef struct _HDD_PASSWORD_CONFIG_FORM_ENTRY {\r
  LIST_ENTRY                    Link;\r
  EFI_HANDLE                    Controller;\r
  UINTN                         Bus;\r
  UINTN                         Device;\r
  UINTN                         Function;\r
  UINT16                        Port;\r
  UINT16                        PortMultiplierPort;\r
  EFI_DEVICE_PATH_PROTOCOL      *DevicePath;\r
  CHAR16                        HddString[64];\r
  CHAR8                         Password[HDD_PASSWORD_MAX_LENGTH];\r
  EFI_STRING_ID                 TitleToken;\r
  EFI_STRING_ID                 TitleHelpToken;\r
\r
  HDD_PASSWORD_CONFIG           IfrData;\r
  EFI_ATA_PASS_THRU_PROTOCOL    *AtaPassThru;\r
} HDD_PASSWORD_CONFIG_FORM_ENTRY;\r
\r
typedef struct _HDD_PASSWORD_DXE_PRIVATE_DATA {\r
  UINTN                            Signature;\r
  EFI_HANDLE                       DriverHandle;\r
  EFI_HII_HANDLE                   HiiHandle;\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;\r
  HDD_PASSWORD_CONFIG_FORM_ENTRY   *Current;\r
} HDD_PASSWORD_DXE_PRIVATE_DATA;\r
\r
#define HDD_PASSWORD_DXE_PRIVATE_FROM_THIS(a)  CR (a, HDD_PASSWORD_DXE_PRIVATE_DATA, ConfigAccess, HDD_PASSWORD_DXE_PRIVATE_SIGNATURE)\r
\r
//\r
//Iterate through the doule linked list. NOT delete safe\r
//\r
#define EFI_LIST_FOR_EACH(Entry, ListHead)    \\r
  for (Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)\r
\r
#define PASSWORD_SALT_SIZE                  32\r
\r
#define HDD_PASSWORD_REQUEST_VARIABLE_NAME  L"HddPasswordRequest"\r
\r
//\r
// It needs to be locked before EndOfDxe.\r
//\r
#define HDD_PASSWORD_VARIABLE_NAME          L"HddPassword"\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  HDD_PASSWORD_DEVICE   Device;\r
  HDD_PASSWORD_REQUEST  Request;\r
} HDD_PASSWORD_REQUEST_VARIABLE;\r
\r
//\r
// It will be used to validate HDD password when the device is at frozen state.\r
//\r
typedef struct {\r
  HDD_PASSWORD_DEVICE   Device;\r
  UINT8                 PasswordHash[SHA256_DIGEST_SIZE];\r
  UINT8                 PasswordSalt[PASSWORD_SALT_SIZE];\r
} HDD_PASSWORD_VARIABLE;\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
#pragma pack()\r
\r
//\r
// Time out value for ATA pass through protocol\r
//\r
#define ATA_TIMEOUT        EFI_TIMER_PERIOD_SECONDS (3)\r
\r
typedef struct {\r
  UINT32                   Address;\r
  S3_BOOT_SCRIPT_LIB_WIDTH Width;\r
} HDD_HC_PCI_REGISTER_SAVE;\r
\r
#endif\r