[mirror_edk2.git] / EmbeddedPkg / Universal / MmcDxe / Diagnostics.c

/** @file\r
  Diagnostics Protocol implementation for the MMC DXE driver\r
\r
  Copyright (c) 2011, ARM Limited. All rights reserved.\r
  \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 <Uefi.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseLib.h>\r
\r
#include "Mmc.h"\r
\r
#define DIAGNOSTIC_LOGBUFFER_MAXCHAR  1024\r
\r
CHAR16* mLogBuffer = NULL;\r
UINTN   mLogRemainChar = 0;\r
\r
CHAR16*\r
DiagnosticInitLog (\r
  UINTN MaxBufferChar\r
  )\r
{\r
  mLogRemainChar = MaxBufferChar;\r
  mLogBuffer = AllocatePool ((UINTN)MaxBufferChar * sizeof (CHAR16));\r
  return mLogBuffer;\r
}\r
\r
UINTN\r
DiagnosticLog (\r
  CONST CHAR16* Str\r
  )\r
{\r
  UINTN len = StrLen (Str);\r
  if (len <= mLogRemainChar) {\r
    mLogRemainChar -= len;\r
    StrCpy (mLogBuffer, Str);\r
    mLogBuffer += len;\r
    return len;\r
  } else {\r
    return 0;\r
  }\r
}\r
\r
VOID\r
GenerateRandomBuffer (\r
  VOID* Buffer,\r
  UINTN BufferSize\r
  )\r
{\r
  UINT64  i;\r
  UINT64* Buffer64 = (UINT64*)Buffer;\r
\r
  for (i = 0; i < (BufferSize >> 3); i++) {\r
    *Buffer64 = i | (~i << 32);\r
    Buffer64++;\r
  }\r
}\r
\r
BOOLEAN\r
CompareBuffer (\r
  VOID  *BufferA,\r
  VOID  *BufferB,\r
  UINTN BufferSize\r
  )\r
{\r
  UINTN i;\r
  UINT64* BufferA64 = (UINT64*)BufferA;\r
  UINT64* BufferB64 = (UINT64*)BufferB;\r
\r
  for (i = 0; i < (BufferSize >> 3); i++) {\r
    if (*BufferA64 != *BufferB64) {\r
      DEBUG ((EFI_D_ERROR, "CompareBuffer: Error at %i", i));\r
      DEBUG ((EFI_D_ERROR, "(0x%lX) != (0x%lX)\n", *BufferA64, *BufferB64));\r
      return FALSE;\r
    }\r
    BufferA64++;\r
    BufferB64++;\r
  }\r
  return TRUE;\r
}\r
\r
EFI_STATUS\r
MmcReadWriteDataTest (\r
  MMC_HOST_INSTANCE *MmcHostInstance,\r
  EFI_LBA           Lba,\r
  UINTN             BufferSize\r
  )\r
{\r
  VOID                        *BackBuffer;\r
  VOID                        *WriteBuffer;\r
  VOID                        *ReadBuffer;\r
  EFI_STATUS                  Status;\r
\r
  // Check if a Media is Present\r
  if (!MmcHostInstance->BlockIo.Media->MediaPresent) {\r
    DiagnosticLog (L"ERROR: No Media Present\n");\r
    return EFI_NO_MEDIA;\r
  }\r
\r
  if (MmcHostInstance->State != MmcTransferState) {\r
    DiagnosticLog (L"ERROR: Not ready for Transfer state\n");\r
    return EFI_NOT_READY;\r
  }\r
\r
  BackBuffer = AllocatePool (BufferSize);\r
  WriteBuffer = AllocatePool (BufferSize);\r
  ReadBuffer = AllocatePool (BufferSize);\r
\r
  // Read (and save) buffer at a specific location\r
  Status = MmcReadBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,BackBuffer);\r
  if (Status != EFI_SUCCESS) {\r
    DiagnosticLog (L"ERROR: Fail to Read Block (1)\n");\r
    return Status;\r
  }\r
\r
  // Write buffer at the same location\r
  GenerateRandomBuffer (WriteBuffer,BufferSize);\r
  Status = MmcWriteBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,WriteBuffer);\r
  if (Status != EFI_SUCCESS) {\r
    DiagnosticLog (L"ERROR: Fail to Write Block (1)\n");\r
    return Status;\r
  }\r
\r
  // Read the buffer at the same location\r
  Status = MmcReadBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,ReadBuffer);\r
  if (Status != EFI_SUCCESS) {\r
    DiagnosticLog (L"ERROR: Fail to Read Block (2)\n");\r
    return Status;\r
  }\r
\r
  // Check that is conform\r
  if (!CompareBuffer (ReadBuffer,WriteBuffer,BufferSize)) {\r
    DiagnosticLog (L"ERROR: Fail to Read/Write Block (1)\n");\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  // Restore content at the original location\r
  Status = MmcWriteBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,BackBuffer);\r
  if (Status != EFI_SUCCESS) {\r
    DiagnosticLog (L"ERROR: Fail to Write Block (2)\n");\r
    return Status;\r
  }\r
\r
  // Read the restored content\r
  Status = MmcReadBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,ReadBuffer);\r
  if (Status != EFI_SUCCESS) {\r
    DiagnosticLog (L"ERROR: Fail to Read Block (3)\n");\r
    return Status;\r
  }\r
\r
  // Check the content is correct\r
  if (!CompareBuffer (ReadBuffer,BackBuffer,BufferSize)) {\r
    DiagnosticLog (L"ERROR: Fail to Read/Write Block (2)\n");\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
MmcDriverDiagnosticsRunDiagnostics (\r
  IN  EFI_DRIVER_DIAGNOSTICS_PROTOCOL               *This,\r
  IN  EFI_HANDLE                                    ControllerHandle,\r
  IN  EFI_HANDLE                                    ChildHandle  OPTIONAL,\r
  IN  EFI_DRIVER_DIAGNOSTIC_TYPE                    DiagnosticType,\r
  IN  CHAR8                                         *Language,\r
  OUT EFI_GUID                                      **ErrorType,\r
  OUT UINTN                                         *BufferSize,\r
  OUT CHAR16                                        **Buffer\r
  )\r
{\r
  LIST_ENTRY              *CurrentLink;\r
  MMC_HOST_INSTANCE       *MmcHostInstance;\r
  EFI_STATUS              Status;\r
\r
  if ((Language         == NULL) ||\r
      (ErrorType        == NULL) ||\r
      (Buffer           == NULL) ||\r
      (ControllerHandle == NULL) ||\r
      (BufferSize       == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  // Check Language is supported (i.e. is "en-*" - only English is supported)\r
  if (AsciiStrnCmp (Language, "en", 2) != 0) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Status = EFI_SUCCESS;\r
  *ErrorType  = NULL;\r
  *BufferSize = DIAGNOSTIC_LOGBUFFER_MAXCHAR;\r
  *Buffer = DiagnosticInitLog (DIAGNOSTIC_LOGBUFFER_MAXCHAR);\r
\r
  DiagnosticLog (L"MMC Driver Diagnostics\n");\r
\r
  // For each MMC instance\r
  CurrentLink = mMmcHostPool.ForwardLink;\r
  while (CurrentLink != NULL && CurrentLink != &mMmcHostPool && (Status == EFI_SUCCESS)) {\r
    MmcHostInstance = MMC_HOST_INSTANCE_FROM_LINK (CurrentLink);\r
    ASSERT (MmcHostInstance != NULL);\r
\r
    // LBA=1 Size=BlockSize\r
    DiagnosticLog (L"MMC Driver Diagnostics - Test: First Block\n");\r
    Status = MmcReadWriteDataTest (MmcHostInstance, 1, MmcHostInstance->BlockIo.Media->BlockSize);\r
\r
    // LBA=2 Size=BlockSize\r
    DiagnosticLog (L"MMC Driver Diagnostics - Test: Second Block\n");\r
    Status = MmcReadWriteDataTest (MmcHostInstance, 2, MmcHostInstance->BlockIo.Media->BlockSize);\r
\r
    // LBA=10 Size=BlockSize\r
    DiagnosticLog (L"MMC Driver Diagnostics - Test: Any Block\n");\r
    Status = MmcReadWriteDataTest (MmcHostInstance, MmcHostInstance->BlockIo.Media->LastBlock >> 1, MmcHostInstance->BlockIo.Media->BlockSize);\r
\r
    // LBA=LastBlock Size=BlockSize\r
    DiagnosticLog (L"MMC Driver Diagnostics - Test: Last Block\n");\r
    Status = MmcReadWriteDataTest (MmcHostInstance, MmcHostInstance->BlockIo.Media->LastBlock, MmcHostInstance->BlockIo.Media->BlockSize);\r
\r
    // LBA=1 Size=2*BlockSize\r
    DiagnosticLog (L"MMC Driver Diagnostics - Test: First Block / 2 BlockSSize\n");\r
    Status = MmcReadWriteDataTest (MmcHostInstance, 1, 2*MmcHostInstance->BlockIo.Media->BlockSize);\r
\r
    CurrentLink = CurrentLink->ForwardLink;\r
  }\r
\r
  return Status;\r
}\r
\r
//\r
// EFI Driver Diagnostics 2 Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2 = {\r
  (EFI_DRIVER_DIAGNOSTICS2_RUN_DIAGNOSTICS) MmcDriverDiagnosticsRunDiagnostics,\r
  "en"\r
};\r
Commit	Line	Data
1bfda055	1	/** @file\r
	2	Diagnostics Protocol implementation for the MMC DXE driver\r
	3	\r
	4	Copyright (c) 2011, ARM Limited. All rights reserved.\r
	5	\r
	6	This program and the accompanying materials \r
	7	are licensed and made available under the terms and conditions of the BSD License \r
	8	which accompanies this distribution. The 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 <Uefi.h>\r
	17	#include <Library/DebugLib.h>\r
	18	#include <Library/BaseMemoryLib.h>\r
	19	#include <Library/MemoryAllocationLib.h>\r
c8af31ec	20	#include <Library/BaseLib.h>\r
1bfda055	21	\r
	22	#include "Mmc.h"\r
	23	\r
	24	#define DIAGNOSTIC_LOGBUFFER_MAXCHAR 1024\r
	25	\r
	26	CHAR16* mLogBuffer = NULL;\r
	27	UINTN mLogRemainChar = 0;\r
	28	\r
11c20f4e	29	CHAR16*\r
	30	DiagnosticInitLog (\r
	31	UINTN MaxBufferChar\r
	32	)\r
	33	{\r
	34	mLogRemainChar = MaxBufferChar;\r
c8af31ec	35	mLogBuffer = AllocatePool ((UINTN)MaxBufferChar * sizeof (CHAR16));\r
11c20f4e	36	return mLogBuffer;\r
1bfda055	37	}\r
1bfda055	38	\r
11c20f4e	39	UINTN\r
	40	DiagnosticLog (\r
	41	CONST CHAR16* Str\r
	42	)\r
	43	{\r
	44	UINTN len = StrLen (Str);\r
	45	if (len <= mLogRemainChar) {\r
	46	mLogRemainChar -= len;\r
	47	StrCpy (mLogBuffer, Str);\r
	48	mLogBuffer += len;\r
	49	return len;\r
	50	} else {\r
	51	return 0;\r
	52	}\r
1bfda055	53	}\r
1bfda055	54	\r
11c20f4e	55	VOID\r
	56	GenerateRandomBuffer (\r
	57	VOID* Buffer,\r
	58	UINTN BufferSize\r
	59	)\r
	60	{\r
	61	UINT64 i;\r
	62	UINT64* Buffer64 = (UINT64*)Buffer;\r
1bfda055	63	\r
11c20f4e	64	for (i = 0; i < (BufferSize >> 3); i++) {\r
	65	*Buffer64 = i \| (~i << 32);\r
	66	Buffer64++;\r
	67	}\r
1bfda055	68	}\r
1bfda055	69	\r
11c20f4e	70	BOOLEAN\r
	71	CompareBuffer (\r
	72	VOID *BufferA,\r
	73	VOID *BufferB,\r
	74	UINTN BufferSize\r
	75	)\r
	76	{\r
	77	UINTN i;\r
	78	UINT64* BufferA64 = (UINT64*)BufferA;\r
	79	UINT64* BufferB64 = (UINT64*)BufferB;\r
	80	\r
	81	for (i = 0; i < (BufferSize >> 3); i++) {\r
	82	if (BufferA64 != BufferB64) {\r
c8af31ec OM	83	DEBUG ((EFI_D_ERROR, "CompareBuffer: Error at %i", i));\r
c8af31ec OM	84	DEBUG ((EFI_D_ERROR, "(0x%lX) != (0x%lX)\n", BufferA64, BufferB64));\r
11c20f4e	85	return FALSE;\r
1bfda055	86	}\r
11c20f4e	87	BufferA64++;\r
	88	BufferB64++;\r
	89	}\r
	90	return TRUE;\r
1bfda055	91	}\r
1bfda055	92	\r
11c20f4e	93	EFI_STATUS\r
	94	MmcReadWriteDataTest (\r
	95	MMC_HOST_INSTANCE *MmcHostInstance,\r
	96	EFI_LBA Lba,\r
	97	UINTN BufferSize\r
	98	)\r
	99	{\r
	100	VOID *BackBuffer;\r
	101	VOID *WriteBuffer;\r
	102	VOID *ReadBuffer;\r
	103	EFI_STATUS Status;\r
	104	\r
	105	// Check if a Media is Present\r
	106	if (!MmcHostInstance->BlockIo.Media->MediaPresent) {\r
	107	DiagnosticLog (L"ERROR: No Media Present\n");\r
	108	return EFI_NO_MEDIA;\r
	109	}\r
	110	\r
	111	if (MmcHostInstance->State != MmcTransferState) {\r
	112	DiagnosticLog (L"ERROR: Not ready for Transfer state\n");\r
	113	return EFI_NOT_READY;\r
	114	}\r
	115	\r
	116	BackBuffer = AllocatePool (BufferSize);\r
	117	WriteBuffer = AllocatePool (BufferSize);\r
	118	ReadBuffer = AllocatePool (BufferSize);\r
	119	\r
	120	// Read (and save) buffer at a specific location\r
	121	Status = MmcReadBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,BackBuffer);\r
	122	if (Status != EFI_SUCCESS) {\r
	123	DiagnosticLog (L"ERROR: Fail to Read Block (1)\n");\r
	124	return Status;\r
	125	}\r
1bfda055	126	\r
11c20f4e	127	// Write buffer at the same location\r
	128	GenerateRandomBuffer (WriteBuffer,BufferSize);\r
	129	Status = MmcWriteBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,WriteBuffer);\r
	130	if (Status != EFI_SUCCESS) {\r
	131	DiagnosticLog (L"ERROR: Fail to Write Block (1)\n");\r
	132	return Status;\r
	133	}\r
1bfda055	134	\r
11c20f4e	135	// Read the buffer at the same location\r
	136	Status = MmcReadBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,ReadBuffer);\r
	137	if (Status != EFI_SUCCESS) {\r
	138	DiagnosticLog (L"ERROR: Fail to Read Block (2)\n");\r
	139	return Status;\r
	140	}\r
	141	\r
	142	// Check that is conform\r
	143	if (!CompareBuffer (ReadBuffer,WriteBuffer,BufferSize)) {\r
	144	DiagnosticLog (L"ERROR: Fail to Read/Write Block (1)\n");\r
	145	return EFI_INVALID_PARAMETER;\r
	146	}\r
	147	\r
	148	// Restore content at the original location\r
	149	Status = MmcWriteBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,BackBuffer);\r
	150	if (Status != EFI_SUCCESS) {\r
	151	DiagnosticLog (L"ERROR: Fail to Write Block (2)\n");\r
	152	return Status;\r
	153	}\r
1bfda055	154	\r
11c20f4e	155	// Read the restored content\r
	156	Status = MmcReadBlocks (&(MmcHostInstance->BlockIo), MmcHostInstance->BlockIo.Media->MediaId,Lba,BufferSize,ReadBuffer);\r
	157	if (Status != EFI_SUCCESS) {\r
	158	DiagnosticLog (L"ERROR: Fail to Read Block (3)\n");\r
	159	return Status;\r
	160	}\r
1bfda055	161	\r
11c20f4e	162	// Check the content is correct\r
	163	if (!CompareBuffer (ReadBuffer,BackBuffer,BufferSize)) {\r
	164	DiagnosticLog (L"ERROR: Fail to Read/Write Block (2)\n");\r
	165	return EFI_INVALID_PARAMETER;\r
	166	}\r
1bfda055	167	\r
11c20f4e	168	return EFI_SUCCESS;\r
1bfda055	169	}\r
	170	\r
	171	EFI_STATUS\r
	172	EFIAPI\r
	173	MmcDriverDiagnosticsRunDiagnostics (\r
	174	IN EFI_DRIVER_DIAGNOSTICS_PROTOCOL *This,\r
	175	IN EFI_HANDLE ControllerHandle,\r
	176	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	177	IN EFI_DRIVER_DIAGNOSTIC_TYPE DiagnosticType,\r
	178	IN CHAR8 *Language,\r
	179	OUT EFI_GUID **ErrorType,\r
	180	OUT UINTN *BufferSize,\r
	181	OUT CHAR16 **Buffer\r
	182	)\r
	183	{\r
11c20f4e	184	LIST_ENTRY *CurrentLink;\r
	185	MMC_HOST_INSTANCE *MmcHostInstance;\r
	186	EFI_STATUS Status;\r
	187	\r
	188	if ((Language == NULL) \|\|\r
	189	(ErrorType == NULL) \|\|\r
	190	(Buffer == NULL) \|\|\r
	191	(ControllerHandle == NULL) \|\|\r
	192	(BufferSize == NULL)) {\r
	193	return EFI_INVALID_PARAMETER;\r
	194	}\r
	195	\r
c8af31ec OM	196	// Check Language is supported (i.e. is "en-*" - only English is supported)\r
	197	if (AsciiStrnCmp (Language, "en", 2) != 0) {\r
	198	return EFI_UNSUPPORTED;\r
	199	}\r
	200	\r
11c20f4e	201	Status = EFI_SUCCESS;\r
	202	*ErrorType = NULL;\r
	203	*BufferSize = DIAGNOSTIC_LOGBUFFER_MAXCHAR;\r
	204	*Buffer = DiagnosticInitLog (DIAGNOSTIC_LOGBUFFER_MAXCHAR);\r
	205	\r
	206	DiagnosticLog (L"MMC Driver Diagnostics\n");\r
	207	\r
	208	// For each MMC instance\r
	209	CurrentLink = mMmcHostPool.ForwardLink;\r
	210	while (CurrentLink != NULL && CurrentLink != &mMmcHostPool && (Status == EFI_SUCCESS)) {\r
c8af31ec OM	211	MmcHostInstance = MMC_HOST_INSTANCE_FROM_LINK (CurrentLink);\r
c8af31ec OM	212	ASSERT (MmcHostInstance != NULL);\r
11c20f4e	213	\r
	214	// LBA=1 Size=BlockSize\r
	215	DiagnosticLog (L"MMC Driver Diagnostics - Test: First Block\n");\r
	216	Status = MmcReadWriteDataTest (MmcHostInstance, 1, MmcHostInstance->BlockIo.Media->BlockSize);\r
	217	\r
	218	// LBA=2 Size=BlockSize\r
	219	DiagnosticLog (L"MMC Driver Diagnostics - Test: Second Block\n");\r
	220	Status = MmcReadWriteDataTest (MmcHostInstance, 2, MmcHostInstance->BlockIo.Media->BlockSize);\r
	221	\r
	222	// LBA=10 Size=BlockSize\r
	223	DiagnosticLog (L"MMC Driver Diagnostics - Test: Any Block\n");\r
	224	Status = MmcReadWriteDataTest (MmcHostInstance, MmcHostInstance->BlockIo.Media->LastBlock >> 1, MmcHostInstance->BlockIo.Media->BlockSize);\r
	225	\r
	226	// LBA=LastBlock Size=BlockSize\r
	227	DiagnosticLog (L"MMC Driver Diagnostics - Test: Last Block\n");\r
	228	Status = MmcReadWriteDataTest (MmcHostInstance, MmcHostInstance->BlockIo.Media->LastBlock, MmcHostInstance->BlockIo.Media->BlockSize);\r
	229	\r
	230	// LBA=1 Size=2*BlockSize\r
	231	DiagnosticLog (L"MMC Driver Diagnostics - Test: First Block / 2 BlockSSize\n");\r
	232	Status = MmcReadWriteDataTest (MmcHostInstance, 1, 2*MmcHostInstance->BlockIo.Media->BlockSize);\r
	233	\r
	234	CurrentLink = CurrentLink->ForwardLink;\r
	235	}\r
	236	\r
	237	return Status;\r
1bfda055	238	}\r
	239	\r
	240	//\r
	241	// EFI Driver Diagnostics 2 Protocol\r
	242	//\r
	243	GLOBAL_REMOVE_IF_UNREFERENCED EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2 = {\r
	244	(EFI_DRIVER_DIAGNOSTICS2_RUN_DIAGNOSTICS) MmcDriverDiagnosticsRunDiagnostics,\r
	245	"en"\r
	246	};\r