[mirror_edk2.git] / SecurityPkg / Tcg / MemoryOverwriteControl / TcgMor.c

/** @file\r
  TCG MOR (Memory Overwrite Request) Control Driver.\r
\r
  This driver initilize MemoryOverwriteRequestControl variable. It \r
  will clear MOR_CLEAR_MEMORY_BIT bit if it is set. It will also do TPer Reset for\r
  those encrypted drives through EFI_STORAGE_SECURITY_COMMAND_PROTOCOL at EndOfDxe.\r
\r
Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution.  The 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 "TcgMor.h"\r
\r
UINT8    mMorControl;\r
\r
/**\r
  Ready to Boot Event notification handler.\r
\r
  @param[in]  Event     Event whose notification function is being invoked\r
  @param[in]  Context   Pointer to the notification function's context\r
\r
**/\r
VOID\r
EFIAPI\r
OnReadyToBoot (\r
  IN      EFI_EVENT                 Event,\r
  IN      VOID                      *Context\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       DataSize;\r
  \r
  if (MOR_CLEAR_MEMORY_VALUE (mMorControl) == 0x0) {\r
    //\r
    // MorControl is expected, directly return to avoid unnecessary variable operation\r
    //\r
    return ;\r
  }\r
  //\r
  // Clear MOR_CLEAR_MEMORY_BIT\r
  //\r
  DEBUG ((EFI_D_INFO, "TcgMor: Clear MorClearMemory bit\n"));\r
  mMorControl &= 0xFE;  \r
\r
  DataSize = sizeof (mMorControl);\r
  Status   = gRT->SetVariable (\r
               MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
               &gEfiMemoryOverwriteControlDataGuid, \r
               EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
               DataSize, \r
               &mMorControl\r
               );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "TcgMor: Clear MOR_CLEAR_MEMORY_BIT failure, Status = %r\n"));\r
  }\r
}\r
\r
/**\r
  Send TPer Reset command to reset eDrive to lock all protected bands.\r
  Typically, there are 2 mechanism for resetting eDrive. They are:\r
  1. TPer Reset through IEEE 1667 protocol.\r
  2. TPer Reset through native TCG protocol.\r
  This routine will detect what protocol the attached eDrive comform to, TCG or\r
  IEEE 1667 protocol. Then send out TPer Reset command separately.\r
\r
  @param[in] Ssp      The pointer to EFI_STORAGE_SECURITY_COMMAND_PROTOCOL instance.\r
  @param[in] MediaId  ID of the medium to receive data from or send data to.\r
\r
**/\r
VOID\r
InitiateTPerReset (\r
  IN  EFI_STORAGE_SECURITY_COMMAND_PROTOCOL    *Ssp,\r
  IN  UINT32                                   MediaId\r
  )\r
{\r
\r
  EFI_STATUS                                   Status;\r
  UINT8                                        *Buffer;\r
  UINTN                                        XferSize;\r
  UINTN                                        Len;\r
  UINTN                                        Index;\r
  BOOLEAN                                      TcgFlag;\r
  BOOLEAN                                      IeeeFlag;\r
  SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA  *Data;\r
\r
  Buffer        = NULL;\r
  TcgFlag       = FALSE;\r
  IeeeFlag      = FALSE;\r
\r
  //\r
  // ATA8-ACS 7.57.6.1 indicates the Transfer Length field requirements a multiple of 512.\r
  // If the length of the TRUSTED RECEIVE parameter data is greater than the Transfer Length,\r
  // then the device shall return the TRUSTED RECEIVE parameter data truncated to the requested Transfer Length.\r
  //\r
  Len           = ROUNDUP512(sizeof(SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA));\r
  Buffer        = AllocateZeroPool(Len);\r
\r
  if (Buffer == NULL) {\r
    return;\r
  }\r
\r
  //\r
  // When the Security Protocol field is set to 00h, and SP Specific is set to 0000h in a TRUSTED RECEIVE\r
  // command, the device basic information data shall be returned.\r
  //\r
  Status = Ssp->ReceiveData (\r
                  Ssp,\r
                  MediaId,\r
                  100000000,                    // Timeout 10-sec\r
                  0,                            // SecurityProtocol\r
                  0,                            // SecurityProtocolSpecifcData\r
                  Len,                          // PayloadBufferSize,\r
                  Buffer,                       // PayloadBuffer\r
                  &XferSize\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  //\r
  // In returned data, the ListLength field indicates the total length, in bytes,\r
  // of the supported security protocol list.\r
  //\r
  Data = (SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA*)Buffer;\r
  Len  = ROUNDUP512(sizeof (SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA) +\r
                    (Data->SupportedSecurityListLength[0] << 8) +\r
                    (Data->SupportedSecurityListLength[1])\r
                    );\r
\r
  //\r
  // Free original buffer and allocate new buffer.\r
  //\r
  FreePool(Buffer);\r
  Buffer = AllocateZeroPool(Len);\r
  if (Buffer == NULL) {\r
    return;\r
  }\r
\r
  //\r
  // Read full supported security protocol list from device.\r
  //\r
  Status = Ssp->ReceiveData (\r
                  Ssp,\r
                  MediaId,\r
                  100000000,                    // Timeout 10-sec\r
                  0,                            // SecurityProtocol\r
                  0,                            // SecurityProtocolSpecifcData\r
                  Len,                          // PayloadBufferSize,\r
                  Buffer,                       // PayloadBuffer\r
                  &XferSize\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  Data = (SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA*)Buffer;\r
  Len  = (Data->SupportedSecurityListLength[0] << 8) + Data->SupportedSecurityListLength[1];\r
\r
  //\r
  // Iterate full supported security protocol list to check if TCG or IEEE 1667 protocol\r
  // is supported.\r
  //\r
  for (Index = 0; Index < Len; Index++) {\r
    if (Data->SupportedSecurityProtocol[Index] == SECURITY_PROTOCOL_TCG) {\r
      //\r
      // Found a  TCG device.\r
      //\r
      TcgFlag = TRUE;\r
      DEBUG ((EFI_D_INFO, "This device is a TCG protocol device\n"));\r
      break;\r
    }\r
\r
    if (Data->SupportedSecurityProtocol[Index] == SECURITY_PROTOCOL_IEEE1667) {\r
      //\r
      // Found a IEEE 1667 device.\r
      //\r
      IeeeFlag = TRUE;\r
      DEBUG ((EFI_D_INFO, "This device is a IEEE 1667 protocol device\n"));\r
      break;\r
    }\r
  }\r
\r
  if (!TcgFlag && !IeeeFlag) {\r
    DEBUG ((EFI_D_INFO, "Neither a TCG nor IEEE 1667 protocol device is found\n"));\r
    goto Exit;\r
  }\r
\r
  if (TcgFlag) {\r
    //\r
    // As long as TCG protocol is supported, send out a TPer Reset\r
    // TCG command to the device via the TrustedSend command with a non-zero Transfer Length.\r
    //\r
    Status = Ssp->SendData (\r
                    Ssp,\r
                    MediaId,\r
                    100000000,                    // Timeout 10-sec\r
                    SECURITY_PROTOCOL_TCG,        // SecurityProtocol\r
                    0x0400,                       // SecurityProtocolSpecifcData\r
                    512,                          // PayloadBufferSize,\r
                    Buffer                        // PayloadBuffer\r
                    );\r
\r
    if (!EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_INFO, "Send TPer Reset Command Successfully !\n"));\r
    } else {\r
      DEBUG ((EFI_D_INFO, "Send TPer Reset Command Fail !\n"));\r
    }\r
  }\r
\r
  if (IeeeFlag) {\r
    //\r
    // TBD : Perform a TPer Reset via IEEE 1667 Protocol\r
    //\r
    DEBUG ((EFI_D_INFO, "IEEE 1667 Protocol didn't support yet!\n"));\r
  }\r
\r
Exit:\r
\r
  if (Buffer != NULL) {\r
    FreePool(Buffer);\r
  }\r
}\r
\r
/**\r
  Notification function of END_OF_DXE.\r
\r
  @param[in] Event      Event whose notification function is being invoked.\r
  @param[in] Context    Pointer to the notification function's context.\r
\r
**/\r
VOID\r
EFIAPI\r
TPerResetAtEndOfDxe (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  EFI_STORAGE_SECURITY_COMMAND_PROTOCOL   *Ssp;\r
  EFI_BLOCK_IO_PROTOCOL                   *BlockIo;\r
  EFI_STATUS                              Status;\r
  UINTN                                   HandleCount;\r
  EFI_HANDLE                              *HandleBuffer;\r
  UINTN                                   Index;\r
\r
  //\r
  // Locate all SSP protocol instances.\r
  //\r
  HandleCount  = 0;\r
  HandleBuffer = NULL;\r
\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiStorageSecurityCommandProtocolGuid,\r
                  NULL,\r
                  &HandleCount,\r
                  &HandleBuffer\r
                  );\r
\r
  if (EFI_ERROR (Status) || (HandleCount == 0) || (HandleBuffer == NULL)) {\r
    return;\r
  }\r
\r
  for (Index = 0; Index < HandleCount; Index ++) {\r
    //\r
    // Get the SSP interface.\r
    //\r
    Status = gBS->HandleProtocol(\r
                    HandleBuffer[Index],\r
                    &gEfiStorageSecurityCommandProtocolGuid,\r
                    (VOID **) &Ssp\r
                    );\r
\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    Status = gBS->HandleProtocol(\r
                    HandleBuffer[Index],\r
                    &gEfiBlockIoProtocolGuid,\r
                    (VOID **) &BlockIo\r
                    );\r
\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    InitiateTPerReset (Ssp, BlockIo->Media->MediaId);\r
  }\r
\r
  FreePool (HandleBuffer);\r
}\r
\r
/**\r
  Entry Point for TCG MOR Control driver.\r
\r
  @param[in] ImageHandle  Image handle of this driver.\r
  @param[in] SystemTable  A Pointer to the EFI System Table.\r
\r
  @retval EFI_SUCEESS     \r
  @return Others          Some error occurs.\r
**/\r
EFI_STATUS\r
EFIAPI\r
MorDriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       DataSize;\r
  EFI_EVENT   Event;\r
\r
  ///\r
  /// The firmware is required to create the MemoryOverwriteRequestControl UEFI variable.\r
  ///\r
\r
  DataSize = sizeof (mMorControl);\r
  Status = gRT->GetVariable (\r
                  MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
                  &gEfiMemoryOverwriteControlDataGuid, \r
                  NULL, \r
                  &DataSize, \r
                  &mMorControl\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Set default value to 0\r
    //\r
    mMorControl = 0;\r
    Status = gRT->SetVariable (\r
                    MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
                    &gEfiMemoryOverwriteControlDataGuid, \r
                    EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
                    DataSize, \r
                    &mMorControl\r
                    );\r
    DEBUG ((EFI_D_INFO, "TcgMor: Create MOR variable! Status = %r\n", Status));\r
  } else {\r
    //\r
    // Create a Ready To Boot Event and Clear the MorControl bit in the call back function.\r
    //\r
    DEBUG ((EFI_D_INFO, "TcgMor: Create ReadyToBoot Event for MorControl Bit cleanning!\n"));\r
    Status = EfiCreateEventReadyToBootEx (\r
               TPL_CALLBACK,\r
               OnReadyToBoot,\r
               NULL,\r
               &Event\r
               );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    //\r
    // Register EFI_END_OF_DXE_EVENT_GROUP_GUID event.\r
    //\r
    DEBUG ((EFI_D_INFO, "TcgMor: Create EndofDxe Event for Mor TPer Reset!\n"));\r
    Status = gBS->CreateEventEx (\r
                    EVT_NOTIFY_SIGNAL,\r
                    TPL_CALLBACK,\r
                    TPerResetAtEndOfDxe,\r
                    NULL,\r
                    &gEfiEndOfDxeEventGroupGuid,\r
                    &Event\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
\r
Commit	Line	Data
0c18794e	1	/** @file\r
	2	TCG MOR (Memory Overwrite Request) Control Driver.\r
	3	\r
	4	This driver initilize MemoryOverwriteRequestControl variable. It \r
495ee9b8 TF	5	will clear MOR_CLEAR_MEMORY_BIT bit if it is set. It will also do TPer Reset for\r
495ee9b8 TF	6	those encrypted drives through EFI_STORAGE_SECURITY_COMMAND_PROTOCOL at EndOfDxe.\r
0c18794e	7	\r
495ee9b8	8	Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
0c18794e	9	This program and the accompanying materials \r
	10	are licensed and made available under the terms and conditions of the BSD License \r
	11	which accompanies this distribution. The full text of the license may be found at \r
	12	http://opensource.org/licenses/bsd-license.php\r
	13	\r
	14	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	15	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	16	\r
	17	**/\r
	18	\r
	19	#include "TcgMor.h"\r
	20	\r
504dfa9d	21	UINT8 mMorControl;\r
	22	\r
	23	/**\r
	24	Ready to Boot Event notification handler.\r
	25	\r
504dfa9d	26	@param[in] Event Event whose notification function is being invoked\r
	27	@param[in] Context Pointer to the notification function's context\r
	28	\r
	29	**/\r
	30	VOID\r
	31	EFIAPI\r
	32	OnReadyToBoot (\r
	33	IN EFI_EVENT Event,\r
	34	IN VOID *Context\r
	35	)\r
	36	{\r
8a8c6c96	37	EFI_STATUS Status;\r
504dfa9d	38	UINTN DataSize;\r
	39	\r
	40	if (MOR_CLEAR_MEMORY_VALUE (mMorControl) == 0x0) {\r
	41	//\r
	42	// MorControl is expected, directly return to avoid unnecessary variable operation\r
	43	//\r
	44	return ;\r
	45	}\r
	46	//\r
	47	// Clear MOR_CLEAR_MEMORY_BIT\r
	48	//\r
	49	DEBUG ((EFI_D_INFO, "TcgMor: Clear MorClearMemory bit\n"));\r
	50	mMorControl &= 0xFE; \r
	51	\r
	52	DataSize = sizeof (mMorControl);\r
8a8c6c96 DG	53	Status = gRT->SetVariable (\r
	54	MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
	55	&gEfiMemoryOverwriteControlDataGuid, \r
	56	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
	57	DataSize, \r
	58	&mMorControl\r
	59	);\r
	60	if (EFI_ERROR (Status)) {\r
	61	DEBUG ((EFI_D_ERROR, "TcgMor: Clear MOR_CLEAR_MEMORY_BIT failure, Status = %r\n"));\r
	62	}\r
504dfa9d	63	}\r
504dfa9d	64	\r
495ee9b8 TF	65	/**\r
	66	Send TPer Reset command to reset eDrive to lock all protected bands.\r
	67	Typically, there are 2 mechanism for resetting eDrive. They are:\r
	68	1. TPer Reset through IEEE 1667 protocol.\r
	69	2. TPer Reset through native TCG protocol.\r
	70	This routine will detect what protocol the attached eDrive comform to, TCG or\r
	71	IEEE 1667 protocol. Then send out TPer Reset command separately.\r
	72	\r
	73	@param[in] Ssp The pointer to EFI_STORAGE_SECURITY_COMMAND_PROTOCOL instance.\r
	74	@param[in] MediaId ID of the medium to receive data from or send data to.\r
	75	\r
	76	**/\r
	77	VOID\r
	78	InitiateTPerReset (\r
	79	IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *Ssp,\r
	80	IN UINT32 MediaId\r
	81	)\r
	82	{\r
	83	\r
	84	EFI_STATUS Status;\r
	85	UINT8 *Buffer;\r
	86	UINTN XferSize;\r
	87	UINTN Len;\r
	88	UINTN Index;\r
	89	BOOLEAN TcgFlag;\r
	90	BOOLEAN IeeeFlag;\r
	91	SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA *Data;\r
	92	\r
	93	Buffer = NULL;\r
	94	TcgFlag = FALSE;\r
	95	IeeeFlag = FALSE;\r
	96	\r
	97	//\r
	98	// ATA8-ACS 7.57.6.1 indicates the Transfer Length field requirements a multiple of 512.\r
	99	// If the length of the TRUSTED RECEIVE parameter data is greater than the Transfer Length,\r
	100	// then the device shall return the TRUSTED RECEIVE parameter data truncated to the requested Transfer Length.\r
	101	//\r
	102	Len = ROUNDUP512(sizeof(SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA));\r
	103	Buffer = AllocateZeroPool(Len);\r
	104	\r
	105	if (Buffer == NULL) {\r
	106	return;\r
	107	}\r
	108	\r
	109	//\r
	110	// When the Security Protocol field is set to 00h, and SP Specific is set to 0000h in a TRUSTED RECEIVE\r
	111	// command, the device basic information data shall be returned.\r
	112	//\r
	113	Status = Ssp->ReceiveData (\r
	114	Ssp,\r
	115	MediaId,\r
	116	100000000, // Timeout 10-sec\r
	117	0, // SecurityProtocol\r
	118	0, // SecurityProtocolSpecifcData\r
	119	Len, // PayloadBufferSize,\r
	120	Buffer, // PayloadBuffer\r
	121	&XferSize\r
	122	);\r
	123	if (EFI_ERROR (Status)) {\r
	124	goto Exit;\r
	125	}\r
	126	\r
	127	//\r
	128	// In returned data, the ListLength field indicates the total length, in bytes,\r
129	// of the supported security protocol list.\r
130	//\r
131	Data = (SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA*)Buffer;\r
132	Len = ROUNDUP512(sizeof (SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA) +\r
133	(Data->SupportedSecurityListLength[0] << 8) +\r
134	(Data->SupportedSecurityListLength[1])\r
135	);\r
136	\r
137	//\r
138	// Free original buffer and allocate new buffer.\r
139	//\r
140	FreePool(Buffer);\r
141	Buffer = AllocateZeroPool(Len);\r
142	if (Buffer == NULL) {\r
143	return;\r
144	}\r
145	\r
146	//\r
147	// Read full supported security protocol list from device.\r
148	//\r
149	Status = Ssp->ReceiveData (\r
150	Ssp,\r
151	MediaId,\r
152	100000000, // Timeout 10-sec\r
153	0, // SecurityProtocol\r
154	0, // SecurityProtocolSpecifcData\r
155	Len, // PayloadBufferSize,\r
156	Buffer, // PayloadBuffer\r
157	&XferSize\r
158	);\r
159	\r
160	if (EFI_ERROR (Status)) {\r
161	goto Exit;\r
162	}\r
163	\r
164	Data = (SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA*)Buffer;\r
165	Len = (Data->SupportedSecurityListLength[0] << 8) + Data->SupportedSecurityListLength[1];\r
166	\r
167	//\r
168	// Iterate full supported security protocol list to check if TCG or IEEE 1667 protocol\r
169	// is supported.\r
170	//\r
171	for (Index = 0; Index < Len; Index++) {\r
172	if (Data->SupportedSecurityProtocol[Index] == SECURITY_PROTOCOL_TCG) {\r
173	//\r
174	// Found a TCG device.\r
175	//\r
176	TcgFlag = TRUE;\r
177	DEBUG ((EFI_D_INFO, "This device is a TCG protocol device\n"));\r
178	break;\r
179	}\r
180	\r
181	if (Data->SupportedSecurityProtocol[Index] == SECURITY_PROTOCOL_IEEE1667) {\r
182	//\r
183	// Found a IEEE 1667 device.\r
184	//\r
185	IeeeFlag = TRUE;\r
186	DEBUG ((EFI_D_INFO, "This device is a IEEE 1667 protocol device\n"));\r
187	break;\r
188	}\r
189	}\r
190	\r
191	if (!TcgFlag && !IeeeFlag) {\r
192	DEBUG ((EFI_D_INFO, "Neither a TCG nor IEEE 1667 protocol device is found\n"));\r
193	goto Exit;\r
194	}\r
195	\r
196	if (TcgFlag) {\r
197	//\r
198	// As long as TCG protocol is supported, send out a TPer Reset\r
199	// TCG command to the device via the TrustedSend command with a non-zero Transfer Length.\r
200	//\r
201	Status = Ssp->SendData (\r
202	Ssp,\r
203	MediaId,\r
204	100000000, // Timeout 10-sec\r
205	SECURITY_PROTOCOL_TCG, // SecurityProtocol\r
206	0x0400, // SecurityProtocolSpecifcData\r
207	512, // PayloadBufferSize,\r
208	Buffer // PayloadBuffer\r
209	);\r
210	\r
211	if (!EFI_ERROR (Status)) {\r
212	DEBUG ((EFI_D_INFO, "Send TPer Reset Command Successfully !\n"));\r
213	} else {\r
214	DEBUG ((EFI_D_INFO, "Send TPer Reset Command Fail !\n"));\r
215	}\r
216	}\r
217	\r
218	if (IeeeFlag) {\r
219	//\r
220	// TBD : Perform a TPer Reset via IEEE 1667 Protocol\r
221	//\r
222	DEBUG ((EFI_D_INFO, "IEEE 1667 Protocol didn't support yet!\n"));\r
223	}\r
224	\r
225	Exit:\r
226	\r
227	if (Buffer != NULL) {\r
228	FreePool(Buffer);\r
229	}\r
230	}\r
231	\r
232	/**\r
233	Notification function of END_OF_DXE.\r
234	\r
495ee9b8 TF	235	@param[in] Event Event whose notification function is being invoked.\r
	236	@param[in] Context Pointer to the notification function's context.\r
	237	\r
	238	**/\r
	239	VOID\r
	240	EFIAPI\r
	241	TPerResetAtEndOfDxe (\r
	242	IN EFI_EVENT Event,\r
	243	IN VOID *Context\r
	244	)\r
	245	{\r
	246	EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *Ssp;\r
	247	EFI_BLOCK_IO_PROTOCOL *BlockIo;\r
	248	EFI_STATUS Status;\r
	249	UINTN HandleCount;\r
	250	EFI_HANDLE *HandleBuffer;\r
	251	UINTN Index;\r
	252	\r
	253	//\r
	254	// Locate all SSP protocol instances.\r
	255	//\r
	256	HandleCount = 0;\r
	257	HandleBuffer = NULL;\r
	258	\r
	259	Status = gBS->LocateHandleBuffer (\r
	260	ByProtocol,\r
	261	&gEfiStorageSecurityCommandProtocolGuid,\r
	262	NULL,\r
	263	&HandleCount,\r
	264	&HandleBuffer\r
	265	);\r
	266	\r
	267	if (EFI_ERROR (Status) \|\| (HandleCount == 0) \|\| (HandleBuffer == NULL)) {\r
	268	return;\r
	269	}\r
	270	\r
	271	for (Index = 0; Index < HandleCount; Index ++) {\r
	272	//\r
	273	// Get the SSP interface.\r
	274	//\r
	275	Status = gBS->HandleProtocol(\r
	276	HandleBuffer[Index],\r
	277	&gEfiStorageSecurityCommandProtocolGuid,\r
	278	(VOID **) &Ssp\r
	279	);\r
	280	\r
	281	if (EFI_ERROR (Status)) {\r
	282	continue;\r
	283	}\r
	284	\r
	285	Status = gBS->HandleProtocol(\r
	286	HandleBuffer[Index],\r
	287	&gEfiBlockIoProtocolGuid,\r
	288	(VOID **) &BlockIo\r
	289	);\r
	290	\r
	291	if (EFI_ERROR (Status)) {\r
	292	continue;\r
	293	}\r
	294	\r
	295	InitiateTPerReset (Ssp, BlockIo->Media->MediaId);\r
	296	}\r
e9dfa1b5 SZ	297	\r
e9dfa1b5 SZ	298	FreePool (HandleBuffer);\r
495ee9b8	299	}\r
504dfa9d	300	\r
0c18794e	301	/**\r
	302	Entry Point for TCG MOR Control driver.\r
	303	\r
	304	@param[in] ImageHandle Image handle of this driver.\r
	305	@param[in] SystemTable A Pointer to the EFI System Table.\r
	306	\r
	307	@retval EFI_SUCEESS \r
	308	@return Others Some error occurs.\r
	309	**/\r
	310	EFI_STATUS\r
	311	EFIAPI\r
	312	MorDriverEntryPoint (\r
	313	IN EFI_HANDLE ImageHandle,\r
	314	IN EFI_SYSTEM_TABLE *SystemTable\r
	315	)\r
	316	{\r
	317	EFI_STATUS Status;\r
0c18794e	318	UINTN DataSize;\r
504dfa9d	319	EFI_EVENT Event;\r
0c18794e	320	\r
	321	///\r
	322	/// The firmware is required to create the MemoryOverwriteRequestControl UEFI variable.\r
	323	///\r
	324	\r
504dfa9d	325	DataSize = sizeof (mMorControl);\r
0c18794e	326	Status = gRT->GetVariable (\r
	327	MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
	328	&gEfiMemoryOverwriteControlDataGuid, \r
	329	NULL, \r
	330	&DataSize, \r
504dfa9d	331	&mMorControl\r
0c18794e	332	);\r
	333	if (EFI_ERROR (Status)) {\r
	334	//\r
	335	// Set default value to 0\r
	336	//\r
504dfa9d	337	mMorControl = 0;\r
504dfa9d	338	Status = gRT->SetVariable (\r
	339	MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
	340	&gEfiMemoryOverwriteControlDataGuid, \r
	341	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
	342	DataSize, \r
	343	&mMorControl\r
	344	);\r
8a8c6c96	345	DEBUG ((EFI_D_INFO, "TcgMor: Create MOR variable! Status = %r\n", Status));\r
0c18794e	346	} else {\r
0c18794e	347	//\r
504dfa9d	348	// Create a Ready To Boot Event and Clear the MorControl bit in the call back function.\r
0c18794e	349	//\r
504dfa9d	350	DEBUG ((EFI_D_INFO, "TcgMor: Create ReadyToBoot Event for MorControl Bit cleanning!\n"));\r
	351	Status = EfiCreateEventReadyToBootEx (\r
	352	TPL_CALLBACK,\r
	353	OnReadyToBoot,\r
	354	NULL,\r
	355	&Event\r
	356	);\r
495ee9b8 TF	357	if (EFI_ERROR (Status)) {\r
	358	return Status;\r
	359	}\r
	360	\r
	361	//\r
	362	// Register EFI_END_OF_DXE_EVENT_GROUP_GUID event.\r
	363	//\r
	364	DEBUG ((EFI_D_INFO, "TcgMor: Create EndofDxe Event for Mor TPer Reset!\n"));\r
	365	Status = gBS->CreateEventEx (\r
	366	EVT_NOTIFY_SIGNAL,\r
	367	TPL_CALLBACK,\r
	368	TPerResetAtEndOfDxe,\r
	369	NULL,\r
	370	&gEfiEndOfDxeEventGroupGuid,\r
	371	&Event\r
	372	);\r
	373	if (EFI_ERROR (Status)) {\r
	374	return Status;\r
	375	}\r
	376	}\r
	377	\r
0c18794e	378	return Status;\r
	379	}\r
	380	\r
	381	\r