[mirror_edk2.git] / MdeModulePkg / Library / SmmLockBoxLib / SmmLockBoxDxeLib.c

/** @file\r
\r
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
of the BSD License which accompanies this distribution.  The\r
full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <PiDxe.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/LockBoxLib.h>\r
#include <Library/DebugLib.h>\r
#include <Protocol/SmmCommunication.h>\r
#include <Guid/SmmLockBox.h>\r
\r
#include "SmmLockBoxLibPrivate.h"\r
\r
/**\r
  This function will save confidential information to lockbox.\r
\r
  @param Guid       the guid to identify the confidential information\r
  @param Buffer     the address of the confidential information\r
  @param Length     the length of the confidential information\r
\r
  @retval RETURN_SUCCESS            the information is saved successfully.\r
  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0\r
  @retval RETURN_ALREADY_STARTED    the requested GUID already exist.\r
  @retval RETURN_OUT_OF_RESOURCES   no enough resource to save the information.\r
  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface\r
  @retval RETURN_NOT_STARTED        it is too early to invoke this interface\r
  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SaveLockBox (\r
  IN  GUID                        *Guid,\r
  IN  VOID                        *Buffer,\r
  IN  UINTN                       Length\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  EFI_SMM_COMMUNICATION_PROTOCOL  *SmmCommunication;\r
  EFI_SMM_LOCK_BOX_PARAMETER_SAVE *LockBoxParameterSave;\r
  EFI_SMM_COMMUNICATE_HEADER      *CommHeader;\r
  UINT8                           CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SAVE)];\r
  UINTN                           CommSize;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SaveLockBox - Enter\n"));\r
\r
  //\r
  // Basic check\r
  //\r
  if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Get needed resource\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiSmmCommunicationProtocolGuid,\r
                  NULL,\r
                  (VOID **)&SmmCommunication\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  //\r
  // Prepare parameter\r
  //\r
  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
  CommHeader->MessageLength = sizeof(*LockBoxParameterSave);\r
\r
  LockBoxParameterSave = (EFI_SMM_LOCK_BOX_PARAMETER_SAVE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
  LockBoxParameterSave->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_SAVE;\r
  LockBoxParameterSave->Header.DataLength = sizeof(*LockBoxParameterSave);\r
  LockBoxParameterSave->Header.ReturnStatus = (UINT64)-1;\r
  CopyMem (&LockBoxParameterSave->Guid, Guid, sizeof(*Guid));\r
  LockBoxParameterSave->Buffer     = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;\r
  LockBoxParameterSave->Length     = (UINT64)Length;\r
\r
  //\r
  // Send command\r
  //\r
  CommSize = sizeof(CommBuffer);\r
  Status = SmmCommunication->Communicate (\r
                               SmmCommunication,\r
                               &CommBuffer[0],\r
                               &CommSize\r
                               );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = (EFI_STATUS)LockBoxParameterSave->Header.ReturnStatus;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SaveLockBox - Exit (%r)\n", Status));\r
\r
  //\r
  // Done\r
  //\r
  return Status;\r
}\r
\r
/**\r
  This function will set lockbox attributes.\r
\r
  @param Guid       the guid to identify the confidential information\r
  @param Attributes the attributes of the lockbox\r
\r
  @retval RETURN_SUCCESS            the information is saved successfully.\r
  @retval RETURN_INVALID_PARAMETER  attributes is invalid.\r
  @retval RETURN_NOT_FOUND          the requested GUID not found.\r
  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface\r
  @retval RETURN_NOT_STARTED        it is too early to invoke this interface\r
  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SetLockBoxAttributes (\r
  IN  GUID                        *Guid,\r
  IN  UINT64                      Attributes\r
  )\r
{\r
  EFI_STATUS                                Status;\r
  EFI_SMM_COMMUNICATION_PROTOCOL            *SmmCommunication;\r
  EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *LockBoxParameterSetAttributes;\r
  EFI_SMM_COMMUNICATE_HEADER                *CommHeader;\r
  UINT8                                     CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES)];\r
  UINTN                                     CommSize;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SetLockBoxAttributes - Enter\n"));\r
\r
  //\r
  // Basic check\r
  //\r
  if ((Guid == NULL) ||\r
      ((Attributes & ~LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) != 0)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Get needed resource\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiSmmCommunicationProtocolGuid,\r
                  NULL,\r
                  (VOID **)&SmmCommunication\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  //\r
  // Prepare parameter\r
  //\r
  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
  CommHeader->MessageLength = sizeof(*LockBoxParameterSetAttributes);\r
\r
  LockBoxParameterSetAttributes = (EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
  LockBoxParameterSetAttributes->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_SET_ATTRIBUTES;\r
  LockBoxParameterSetAttributes->Header.DataLength = sizeof(*LockBoxParameterSetAttributes);\r
  LockBoxParameterSetAttributes->Header.ReturnStatus = (UINT64)-1;\r
  CopyMem (&LockBoxParameterSetAttributes->Guid, Guid, sizeof(*Guid));\r
  LockBoxParameterSetAttributes->Attributes = (UINT64)Attributes;\r
\r
  //\r
  // Send command\r
  //\r
  CommSize = sizeof(CommBuffer);\r
  Status = SmmCommunication->Communicate (\r
                               SmmCommunication,\r
                               &CommBuffer[0],\r
                               &CommSize\r
                               );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = (EFI_STATUS)LockBoxParameterSetAttributes->Header.ReturnStatus;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SetLockBoxAttributes - Exit (%r)\n", Status));\r
\r
  //\r
  // Done\r
  //\r
  return Status;\r
}\r
\r
/**\r
  This function will update confidential information to lockbox.\r
\r
  @param Guid   the guid to identify the original confidential information\r
  @param Offset the offset of the original confidential information\r
  @param Buffer the address of the updated confidential information\r
  @param Length the length of the updated confidential information\r
\r
  @retval RETURN_SUCCESS            the information is saved successfully.\r
  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0.\r
  @retval RETURN_NOT_FOUND          the requested GUID not found.\r
  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold new information.\r
  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface\r
  @retval RETURN_NOT_STARTED        it is too early to invoke this interface\r
  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
UpdateLockBox (\r
  IN  GUID                        *Guid,\r
  IN  UINTN                       Offset,\r
  IN  VOID                        *Buffer,\r
  IN  UINTN                       Length\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EFI_SMM_COMMUNICATION_PROTOCOL    *SmmCommunication;\r
  EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *LockBoxParameterUpdate;\r
  EFI_SMM_COMMUNICATE_HEADER        *CommHeader;\r
  UINT8                             CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_UPDATE)];\r
  UINTN                             CommSize;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib UpdateLockBox - Enter\n"));\r
\r
  //\r
  // Basic check\r
  //\r
  if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Get needed resource\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiSmmCommunicationProtocolGuid,\r
                  NULL,\r
                  (VOID **)&SmmCommunication\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  //\r
  // Prepare parameter\r
  //\r
  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
  CommHeader->MessageLength = sizeof(*LockBoxParameterUpdate);\r
\r
  LockBoxParameterUpdate = (EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *)(UINTN)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
  LockBoxParameterUpdate->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_UPDATE;\r
  LockBoxParameterUpdate->Header.DataLength = sizeof(*LockBoxParameterUpdate);\r
  LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)-1;\r
  CopyMem (&LockBoxParameterUpdate->Guid, Guid, sizeof(*Guid));\r
  LockBoxParameterUpdate->Offset = (UINT64)Offset;\r
  LockBoxParameterUpdate->Buffer = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;\r
  LockBoxParameterUpdate->Length = (UINT64)Length;\r
\r
  //\r
  // Send command\r
  //\r
  CommSize = sizeof(CommBuffer);\r
  Status = SmmCommunication->Communicate (\r
                               SmmCommunication,\r
                               &CommBuffer[0],\r
                               &CommSize\r
                               );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = (EFI_STATUS)LockBoxParameterUpdate->Header.ReturnStatus;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib UpdateLockBox - Exit (%r)\n", Status));\r
\r
  //\r
  // Done\r
  //\r
  return Status;\r
}\r
\r
/**\r
  This function will restore confidential information from lockbox.\r
\r
  @param Guid   the guid to identify the confidential information\r
  @param Buffer the address of the restored confidential information\r
                NULL means restored to original address, Length MUST be NULL at same time.\r
  @param Length the length of the restored confidential information\r
\r
  @retval RETURN_SUCCESS            the information is restored successfully.\r
  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or one of Buffer and Length is NULL.\r
  @retval RETURN_WRITE_PROTECTED    Buffer and Length are NULL, but the LockBox has no \r
                                    LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE attribute.\r
  @retval RETURN_BUFFER_TOO_SMALL   the Length is too small to hold the confidential information.\r
  @retval RETURN_NOT_FOUND          the requested GUID not found.\r
  @retval RETURN_NOT_STARTED        it is too early to invoke this interface\r
  @retval RETURN_ACCESS_DENIED      not allow to restore to the address\r
  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
RestoreLockBox (\r
  IN  GUID                        *Guid,\r
  IN  VOID                        *Buffer, OPTIONAL\r
  IN  OUT UINTN                   *Length  OPTIONAL\r
  )\r
{\r
  EFI_STATUS                         Status;\r
  EFI_SMM_COMMUNICATION_PROTOCOL     *SmmCommunication;\r
  EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *LockBoxParameterRestore;\r
  EFI_SMM_COMMUNICATE_HEADER         *CommHeader;\r
  UINT8                              CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE)];\r
  UINTN                              CommSize;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreLockBox - Enter\n"));\r
\r
  //\r
  // Basic check\r
  //\r
  if ((Guid == NULL) ||\r
      ((Buffer == NULL) && (Length != NULL)) ||\r
      ((Buffer != NULL) && (Length == NULL))) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Get needed resource\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiSmmCommunicationProtocolGuid,\r
                  NULL,\r
                  (VOID **)&SmmCommunication\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  //\r
  // Prepare parameter\r
  //\r
  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
  CommHeader->MessageLength = sizeof(*LockBoxParameterRestore);\r
\r
  LockBoxParameterRestore = (EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
  LockBoxParameterRestore->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_RESTORE;\r
  LockBoxParameterRestore->Header.DataLength = sizeof(*LockBoxParameterRestore);\r
  LockBoxParameterRestore->Header.ReturnStatus = (UINT64)-1;\r
  CopyMem (&LockBoxParameterRestore->Guid, Guid, sizeof(*Guid));\r
  LockBoxParameterRestore->Buffer = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;\r
  if (Length != NULL) {\r
    LockBoxParameterRestore->Length = (EFI_PHYSICAL_ADDRESS)*Length;\r
  } else {\r
    LockBoxParameterRestore->Length = 0;\r
  }\r
\r
  //\r
  // Send command\r
  //\r
  CommSize = sizeof(CommBuffer);\r
  Status = SmmCommunication->Communicate (\r
                               SmmCommunication,\r
                               &CommBuffer[0],\r
                               &CommSize\r
                               );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  if (Length != NULL) {\r
    *Length = (UINTN)LockBoxParameterRestore->Length;\r
  }\r
\r
  Status = (EFI_STATUS)LockBoxParameterRestore->Header.ReturnStatus;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreLockBox - Exit (%r)\n", Status));\r
\r
  //\r
  // Done\r
  //\r
  return Status;\r
}\r
\r
/**\r
  This function will restore confidential information from all lockbox which have RestoreInPlace attribute.\r
\r
  @retval RETURN_SUCCESS            the information is restored successfully.\r
  @retval RETURN_NOT_STARTED        it is too early to invoke this interface\r
  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
RestoreAllLockBoxInPlace (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                                      Status;\r
  EFI_SMM_COMMUNICATION_PROTOCOL                  *SmmCommunication;\r
  EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *LockBoxParameterRestoreAllInPlace;\r
  EFI_SMM_COMMUNICATE_HEADER                      *CommHeader;\r
  UINT8                                           CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE)];\r
  UINTN                                           CommSize;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreAllLockBoxInPlace - Enter\n"));\r
\r
  //\r
  // Get needed resource\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiSmmCommunicationProtocolGuid,\r
                  NULL,\r
                  (VOID **)&SmmCommunication\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  //\r
  // Prepare parameter\r
  //\r
  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
  CommHeader->MessageLength = sizeof(*LockBoxParameterRestoreAllInPlace);\r
\r
  LockBoxParameterRestoreAllInPlace = (EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
  LockBoxParameterRestoreAllInPlace->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_RESTORE_ALL_IN_PLACE;\r
  LockBoxParameterRestoreAllInPlace->Header.DataLength = sizeof(*LockBoxParameterRestoreAllInPlace);\r
  LockBoxParameterRestoreAllInPlace->Header.ReturnStatus = (UINT64)-1;\r
\r
  //\r
  // Send command\r
  //\r
  CommSize = sizeof(CommBuffer);\r
  Status = SmmCommunication->Communicate (\r
                               SmmCommunication,\r
                               &CommBuffer[0],\r
                               &CommSize\r
                               );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = (EFI_STATUS)LockBoxParameterRestoreAllInPlace->Header.ReturnStatus;\r
\r
  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreAllLockBoxInPlace - Exit (%r)\n", Status));\r
\r
  //\r
  // Done\r
  //\r
  return Status;\r
}\r
\r
Commit	Line	Data
1c837cd5	1	/** @file\r
	2	\r
	3	Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
	4	\r
	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions\r
	7	of the BSD License which accompanies this distribution. The\r
	8	full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#include <PiDxe.h>\r
	17	#include <Library/UefiBootServicesTableLib.h>\r
	18	#include <Library/UefiRuntimeServicesTableLib.h>\r
	19	#include <Library/BaseLib.h>\r
	20	#include <Library/BaseMemoryLib.h>\r
	21	#include <Library/LockBoxLib.h>\r
	22	#include <Library/DebugLib.h>\r
	23	#include <Protocol/SmmCommunication.h>\r
	24	#include <Guid/SmmLockBox.h>\r
	25	\r
	26	#include "SmmLockBoxLibPrivate.h"\r
	27	\r
	28	/**\r
	29	This function will save confidential information to lockbox.\r
	30	\r
	31	@param Guid the guid to identify the confidential information\r
	32	@param Buffer the address of the confidential information\r
	33	@param Length the length of the confidential information\r
	34	\r
	35	@retval RETURN_SUCCESS the information is saved successfully.\r
	36	@retval RETURN_INVALID_PARAMETER the Guid is NULL, or Buffer is NULL, or Length is 0\r
	37	@retval RETURN_ALREADY_STARTED the requested GUID already exist.\r
	38	@retval RETURN_OUT_OF_RESOURCES no enough resource to save the information.\r
	39	@retval RETURN_ACCESS_DENIED it is too late to invoke this interface\r
	40	@retval RETURN_NOT_STARTED it is too early to invoke this interface\r
	41	@retval RETURN_UNSUPPORTED the service is not supported by implementaion.\r
	42	**/\r
	43	RETURN_STATUS\r
	44	EFIAPI\r
	45	SaveLockBox (\r
	46	IN GUID *Guid,\r
	47	IN VOID *Buffer,\r
	48	IN UINTN Length\r
	49	)\r
	50	{\r
	51	EFI_STATUS Status;\r
	52	EFI_SMM_COMMUNICATION_PROTOCOL *SmmCommunication;\r
	53	EFI_SMM_LOCK_BOX_PARAMETER_SAVE *LockBoxParameterSave;\r
	54	EFI_SMM_COMMUNICATE_HEADER *CommHeader;\r
	55	UINT8 CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SAVE)];\r
	56	UINTN CommSize;\r
	57	\r
	58	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SaveLockBox - Enter\n"));\r
	59	\r
	60	//\r
	61	// Basic check\r
	62	//\r
	63	if ((Guid == NULL) \|\| (Buffer == NULL) \|\| (Length == 0)) {\r
	64	return EFI_INVALID_PARAMETER;\r
65	}\r
66	\r
67	//\r
68	// Get needed resource\r
69	//\r
70	Status = gBS->LocateProtocol (\r
71	&gEfiSmmCommunicationProtocolGuid,\r
72	NULL,\r
73	(VOID **)&SmmCommunication\r
74	);\r
75	if (EFI_ERROR (Status)) {\r
76	return EFI_NOT_STARTED;\r
77	}\r
78	\r
79	//\r
80	// Prepare parameter\r
81	//\r
82	CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
83	CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
84	CommHeader->MessageLength = sizeof(*LockBoxParameterSave);\r
85	\r
86	LockBoxParameterSave = (EFI_SMM_LOCK_BOX_PARAMETER_SAVE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
87	LockBoxParameterSave->Header.Command = EFI_SMM_LOCK_BOX_COMMAND_SAVE;\r
88	LockBoxParameterSave->Header.DataLength = sizeof(*LockBoxParameterSave);\r
89	LockBoxParameterSave->Header.ReturnStatus = (UINT64)-1;\r
90	CopyMem (&LockBoxParameterSave->Guid, Guid, sizeof(*Guid));\r
91	LockBoxParameterSave->Buffer = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;\r
92	LockBoxParameterSave->Length = (UINT64)Length;\r
93	\r
94	//\r
95	// Send command\r
96	//\r
97	CommSize = sizeof(CommBuffer);\r
98	Status = SmmCommunication->Communicate (\r
99	SmmCommunication,\r
100	&CommBuffer[0],\r
101	&CommSize\r
102	);\r
103	ASSERT_EFI_ERROR (Status);\r
104	\r
105	Status = (EFI_STATUS)LockBoxParameterSave->Header.ReturnStatus;\r
106	\r
107	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SaveLockBox - Exit (%r)\n", Status));\r
108	\r
109	//\r
110	// Done\r
111	//\r
112	return Status;\r
113	}\r
114	\r
115	/**\r
116	This function will set lockbox attributes.\r
117	\r
118	@param Guid the guid to identify the confidential information\r
119	@param Attributes the attributes of the lockbox\r
120	\r
121	@retval RETURN_SUCCESS the information is saved successfully.\r
122	@retval RETURN_INVALID_PARAMETER attributes is invalid.\r
123	@retval RETURN_NOT_FOUND the requested GUID not found.\r
124	@retval RETURN_ACCESS_DENIED it is too late to invoke this interface\r
125	@retval RETURN_NOT_STARTED it is too early to invoke this interface\r
126	@retval RETURN_UNSUPPORTED the service is not supported by implementaion.\r
127	**/\r
128	RETURN_STATUS\r
129	EFIAPI\r
130	SetLockBoxAttributes (\r
131	IN GUID *Guid,\r
132	IN UINT64 Attributes\r
133	)\r
134	{\r
135	EFI_STATUS Status;\r
136	EFI_SMM_COMMUNICATION_PROTOCOL *SmmCommunication;\r
137	EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *LockBoxParameterSetAttributes;\r
138	EFI_SMM_COMMUNICATE_HEADER *CommHeader;\r
139	UINT8 CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES)];\r
140	UINTN CommSize;\r
141	\r
142	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SetLockBoxAttributes - Enter\n"));\r
143	\r
144	//\r
145	// Basic check\r
146	//\r
147	if ((Guid == NULL) \|\|\r
148	((Attributes & ~LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) != 0)) {\r
149	return EFI_INVALID_PARAMETER;\r
150	}\r
151	\r
152	//\r
153	// Get needed resource\r
154	//\r
155	Status = gBS->LocateProtocol (\r
156	&gEfiSmmCommunicationProtocolGuid,\r
157	NULL,\r
158	(VOID **)&SmmCommunication\r
159	);\r
160	if (EFI_ERROR (Status)) {\r
161	return EFI_NOT_STARTED;\r
162	}\r
163	\r
164	//\r
165	// Prepare parameter\r
166	//\r
167	CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
168	CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
169	CommHeader->MessageLength = sizeof(*LockBoxParameterSetAttributes);\r
170	\r
171	LockBoxParameterSetAttributes = (EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
172	LockBoxParameterSetAttributes->Header.Command = EFI_SMM_LOCK_BOX_COMMAND_SET_ATTRIBUTES;\r
173	LockBoxParameterSetAttributes->Header.DataLength = sizeof(*LockBoxParameterSetAttributes);\r
174	LockBoxParameterSetAttributes->Header.ReturnStatus = (UINT64)-1;\r
175	CopyMem (&LockBoxParameterSetAttributes->Guid, Guid, sizeof(*Guid));\r
176	LockBoxParameterSetAttributes->Attributes = (UINT64)Attributes;\r
177	\r
178	//\r
179	// Send command\r
180	//\r
181	CommSize = sizeof(CommBuffer);\r
182	Status = SmmCommunication->Communicate (\r
183	SmmCommunication,\r
184	&CommBuffer[0],\r
185	&CommSize\r
186	);\r
187	ASSERT_EFI_ERROR (Status);\r
188	\r
189	Status = (EFI_STATUS)LockBoxParameterSetAttributes->Header.ReturnStatus;\r
190	\r
191	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SetLockBoxAttributes - Exit (%r)\n", Status));\r
192	\r
193	//\r
194	// Done\r
195	//\r
196	return Status;\r
197	}\r
198	\r
199	/**\r
200	This function will update confidential information to lockbox.\r
201	\r
202	@param Guid the guid to identify the original confidential information\r
203	@param Offset the offset of the original confidential information\r
204	@param Buffer the address of the updated confidential information\r
205	@param Length the length of the updated confidential information\r
206	\r
207	@retval RETURN_SUCCESS the information is saved successfully.\r
208	@retval RETURN_INVALID_PARAMETER the Guid is NULL, or Buffer is NULL, or Length is 0.\r
209	@retval RETURN_NOT_FOUND the requested GUID not found.\r
210	@retval RETURN_BUFFER_TOO_SMALL the original buffer to too small to hold new information.\r
211	@retval RETURN_ACCESS_DENIED it is too late to invoke this interface\r
212	@retval RETURN_NOT_STARTED it is too early to invoke this interface\r
213	@retval RETURN_UNSUPPORTED the service is not supported by implementaion.\r
214	**/\r
215	RETURN_STATUS\r
216	EFIAPI\r
217	UpdateLockBox (\r
218	IN GUID *Guid,\r
219	IN UINTN Offset,\r
220	IN VOID *Buffer,\r
221	IN UINTN Length\r
222	)\r
223	{\r
224	EFI_STATUS Status;\r
225	EFI_SMM_COMMUNICATION_PROTOCOL *SmmCommunication;\r
226	EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *LockBoxParameterUpdate;\r
227	EFI_SMM_COMMUNICATE_HEADER *CommHeader;\r
228	UINT8 CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_UPDATE)];\r
229	UINTN CommSize;\r
230	\r
231	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib UpdateLockBox - Enter\n"));\r
232	\r
233	//\r
234	// Basic check\r
235	//\r
236	if ((Guid == NULL) \|\| (Buffer == NULL) \|\| (Length == 0)) {\r
237	return EFI_INVALID_PARAMETER;\r
238	}\r
239	\r
240	//\r
241	// Get needed resource\r
242	//\r
243	Status = gBS->LocateProtocol (\r
244	&gEfiSmmCommunicationProtocolGuid,\r
245	NULL,\r
246	(VOID **)&SmmCommunication\r
247	);\r
248	if (EFI_ERROR (Status)) {\r
249	return EFI_NOT_STARTED;\r
250	}\r
251	\r
252	//\r
253	// Prepare parameter\r
254	//\r
255	CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
256	CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
257	CommHeader->MessageLength = sizeof(*LockBoxParameterUpdate);\r
258	\r
259	LockBoxParameterUpdate = (EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *)(UINTN)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
260	LockBoxParameterUpdate->Header.Command = EFI_SMM_LOCK_BOX_COMMAND_UPDATE;\r
261	LockBoxParameterUpdate->Header.DataLength = sizeof(*LockBoxParameterUpdate);\r
262	LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)-1;\r
263	CopyMem (&LockBoxParameterUpdate->Guid, Guid, sizeof(*Guid));\r
264	LockBoxParameterUpdate->Offset = (UINT64)Offset;\r
265	LockBoxParameterUpdate->Buffer = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;\r
266	LockBoxParameterUpdate->Length = (UINT64)Length;\r
267	\r
268	//\r
269	// Send command\r
270	//\r
271	CommSize = sizeof(CommBuffer);\r
272	Status = SmmCommunication->Communicate (\r
273	SmmCommunication,\r
274	&CommBuffer[0],\r
275	&CommSize\r
276	);\r
277	ASSERT_EFI_ERROR (Status);\r
278	\r
279	Status = (EFI_STATUS)LockBoxParameterUpdate->Header.ReturnStatus;\r
280	\r
281	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib UpdateLockBox - Exit (%r)\n", Status));\r
282	\r
283	//\r
284	// Done\r
285	//\r
286	return Status;\r
287	}\r
288	\r
289	/**\r
290	This function will restore confidential information from lockbox.\r
291	\r
292	@param Guid the guid to identify the confidential information\r
293	@param Buffer the address of the restored confidential information\r
294	NULL means restored to original address, Length MUST be NULL at same time.\r
295	@param Length the length of the restored confidential information\r
296	\r
297	@retval RETURN_SUCCESS the information is restored successfully.\r
298	@retval RETURN_INVALID_PARAMETER the Guid is NULL, or one of Buffer and Length is NULL.\r
299	@retval RETURN_WRITE_PROTECTED Buffer and Length are NULL, but the LockBox has no \r
300	LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE attribute.\r
301	@retval RETURN_BUFFER_TOO_SMALL the Length is too small to hold the confidential information.\r
302	@retval RETURN_NOT_FOUND the requested GUID not found.\r
303	@retval RETURN_NOT_STARTED it is too early to invoke this interface\r
304	@retval RETURN_ACCESS_DENIED not allow to restore to the address\r
305	@retval RETURN_UNSUPPORTED the service is not supported by implementaion.\r
306	**/\r
307	RETURN_STATUS\r
308	EFIAPI\r
309	RestoreLockBox (\r
310	IN GUID *Guid,\r
311	IN VOID *Buffer, OPTIONAL\r
312	IN OUT UINTN *Length OPTIONAL\r
313	)\r
314	{\r
315	EFI_STATUS Status;\r
316	EFI_SMM_COMMUNICATION_PROTOCOL *SmmCommunication;\r
317	EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *LockBoxParameterRestore;\r
318	EFI_SMM_COMMUNICATE_HEADER *CommHeader;\r
319	UINT8 CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE)];\r
320	UINTN CommSize;\r
321	\r
322	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreLockBox - Enter\n"));\r
323	\r
324	//\r
325	// Basic check\r
326	//\r
327	if ((Guid == NULL) \|\|\r
328	((Buffer == NULL) && (Length != NULL)) \|\|\r
329	((Buffer != NULL) && (Length == NULL))) {\r
330	return EFI_INVALID_PARAMETER;\r
331	}\r
332	\r
333	//\r
334	// Get needed resource\r
335	//\r
336	Status = gBS->LocateProtocol (\r
337	&gEfiSmmCommunicationProtocolGuid,\r
338	NULL,\r
339	(VOID **)&SmmCommunication\r
340	);\r
341	if (EFI_ERROR (Status)) {\r
342	return EFI_NOT_STARTED;\r
343	}\r
344	\r
345	//\r
346	// Prepare parameter\r
347	//\r
348	CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
349	CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
350	CommHeader->MessageLength = sizeof(*LockBoxParameterRestore);\r
351	\r
352	LockBoxParameterRestore = (EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
353	LockBoxParameterRestore->Header.Command = EFI_SMM_LOCK_BOX_COMMAND_RESTORE;\r
354	LockBoxParameterRestore->Header.DataLength = sizeof(*LockBoxParameterRestore);\r
355	LockBoxParameterRestore->Header.ReturnStatus = (UINT64)-1;\r
356	CopyMem (&LockBoxParameterRestore->Guid, Guid, sizeof(*Guid));\r
357	LockBoxParameterRestore->Buffer = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;\r
358	if (Length != NULL) {\r
359	LockBoxParameterRestore->Length = (EFI_PHYSICAL_ADDRESS)*Length;\r
360	} else {\r
361	LockBoxParameterRestore->Length = 0;\r
362	}\r
363	\r
364	//\r
365	// Send command\r
366	//\r
367	CommSize = sizeof(CommBuffer);\r
368	Status = SmmCommunication->Communicate (\r
369	SmmCommunication,\r
370	&CommBuffer[0],\r
371	&CommSize\r
372	);\r
373	ASSERT_EFI_ERROR (Status);\r
374	\r
375	if (Length != NULL) {\r
376	*Length = (UINTN)LockBoxParameterRestore->Length;\r
377	}\r
378	\r
379	Status = (EFI_STATUS)LockBoxParameterRestore->Header.ReturnStatus;\r
380	\r
381	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreLockBox - Exit (%r)\n", Status));\r
382	\r
383	//\r
384	// Done\r
385	//\r
386	return Status;\r
387	}\r
388	\r
389	/**\r
390	This function will restore confidential information from all lockbox which have RestoreInPlace attribute.\r
391	\r
392	@retval RETURN_SUCCESS the information is restored successfully.\r
393	@retval RETURN_NOT_STARTED it is too early to invoke this interface\r
394	@retval RETURN_UNSUPPORTED the service is not supported by implementaion.\r
395	**/\r
396	RETURN_STATUS\r
397	EFIAPI\r
398	RestoreAllLockBoxInPlace (\r
399	VOID\r
400	)\r
401	{\r
402	EFI_STATUS Status;\r
403	EFI_SMM_COMMUNICATION_PROTOCOL *SmmCommunication;\r
404	EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *LockBoxParameterRestoreAllInPlace;\r
405	EFI_SMM_COMMUNICATE_HEADER *CommHeader;\r
406	UINT8 CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE)];\r
407	UINTN CommSize;\r
408	\r
409	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreAllLockBoxInPlace - Enter\n"));\r
410	\r
411	//\r
412	// Get needed resource\r
413	//\r
414	Status = gBS->LocateProtocol (\r
415	&gEfiSmmCommunicationProtocolGuid,\r
416	NULL,\r
417	(VOID **)&SmmCommunication\r
418	);\r
419	if (EFI_ERROR (Status)) {\r
420	return EFI_NOT_STARTED;\r
421	}\r
422	\r
423	//\r
424	// Prepare parameter\r
425	//\r
426	CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];\r
427	CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));\r
428	CommHeader->MessageLength = sizeof(*LockBoxParameterRestoreAllInPlace);\r
429	\r
430	LockBoxParameterRestoreAllInPlace = (EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];\r
431	LockBoxParameterRestoreAllInPlace->Header.Command = EFI_SMM_LOCK_BOX_COMMAND_RESTORE_ALL_IN_PLACE;\r
432	LockBoxParameterRestoreAllInPlace->Header.DataLength = sizeof(*LockBoxParameterRestoreAllInPlace);\r
433	LockBoxParameterRestoreAllInPlace->Header.ReturnStatus = (UINT64)-1;\r
434	\r
435	//\r
436	// Send command\r
437	//\r
438	CommSize = sizeof(CommBuffer);\r
439	Status = SmmCommunication->Communicate (\r
440	SmmCommunication,\r
441	&CommBuffer[0],\r
442	&CommSize\r
443	);\r
444	ASSERT_EFI_ERROR (Status);\r
445	\r
446	Status = (EFI_STATUS)LockBoxParameterRestoreAllInPlace->Header.ReturnStatus;\r
447	\r
448	DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreAllLockBoxInPlace - Exit (%r)\n", Status));\r
449	\r
450	//\r
451	// Done\r
452	//\r
453	return Status;\r
454	}\r
455	\r