2 Diagnostics Protocol implementation for the MMC DXE driver
4 Copyright (c) 2011, ARM Limited. All rights reserved.
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Library/DebugLib.h>
18 #include <Library/BaseMemoryLib.h>
19 #include <Library/MemoryAllocationLib.h>
23 #define DIAGNOSTIC_LOGBUFFER_MAXCHAR 1024
25 CHAR16
* mLogBuffer
= NULL
;
26 UINTN mLogRemainChar
= 0;
33 mLogRemainChar
= MaxBufferChar
;
34 mLogBuffer
= AllocatePool ((UINTN
)MaxBufferChar
* sizeof(CHAR16
));
43 UINTN len
= StrLen (Str
);
44 if (len
<= mLogRemainChar
) {
45 mLogRemainChar
-= len
;
46 StrCpy (mLogBuffer
, Str
);
55 GenerateRandomBuffer (
61 UINT64
* Buffer64
= (UINT64
*)Buffer
;
63 for (i
= 0; i
< (BufferSize
>> 3); i
++) {
64 *Buffer64
= i
| (~i
<< 32);
77 UINT64
* BufferA64
= (UINT64
*)BufferA
;
78 UINT64
* BufferB64
= (UINT64
*)BufferB
;
80 for (i
= 0; i
< (BufferSize
>> 3); i
++) {
81 if (*BufferA64
!= *BufferB64
) {
82 DEBUG((EFI_D_ERROR
, "CompareBuffer: Error at %i", i
));
83 DEBUG((EFI_D_ERROR
, "(0x%lX) != (0x%lX)\n", *BufferA64
, *BufferB64
));
93 MmcReadWriteDataTest (
94 MMC_HOST_INSTANCE
*MmcHostInstance
,
104 // Check if a Media is Present
105 if (!MmcHostInstance
->BlockIo
.Media
->MediaPresent
) {
106 DiagnosticLog (L
"ERROR: No Media Present\n");
110 if (MmcHostInstance
->State
!= MmcTransferState
) {
111 DiagnosticLog (L
"ERROR: Not ready for Transfer state\n");
112 return EFI_NOT_READY
;
115 BackBuffer
= AllocatePool (BufferSize
);
116 WriteBuffer
= AllocatePool (BufferSize
);
117 ReadBuffer
= AllocatePool (BufferSize
);
119 // Read (and save) buffer at a specific location
120 Status
= MmcReadBlocks (&(MmcHostInstance
->BlockIo
), MmcHostInstance
->BlockIo
.Media
->MediaId
,Lba
,BufferSize
,BackBuffer
);
121 if (Status
!= EFI_SUCCESS
) {
122 DiagnosticLog (L
"ERROR: Fail to Read Block (1)\n");
126 // Write buffer at the same location
127 GenerateRandomBuffer (WriteBuffer
,BufferSize
);
128 Status
= MmcWriteBlocks (&(MmcHostInstance
->BlockIo
), MmcHostInstance
->BlockIo
.Media
->MediaId
,Lba
,BufferSize
,WriteBuffer
);
129 if (Status
!= EFI_SUCCESS
) {
130 DiagnosticLog (L
"ERROR: Fail to Write Block (1)\n");
134 // Read the buffer at the same location
135 Status
= MmcReadBlocks (&(MmcHostInstance
->BlockIo
), MmcHostInstance
->BlockIo
.Media
->MediaId
,Lba
,BufferSize
,ReadBuffer
);
136 if (Status
!= EFI_SUCCESS
) {
137 DiagnosticLog (L
"ERROR: Fail to Read Block (2)\n");
141 // Check that is conform
142 if (!CompareBuffer (ReadBuffer
,WriteBuffer
,BufferSize
)) {
143 DiagnosticLog (L
"ERROR: Fail to Read/Write Block (1)\n");
144 return EFI_INVALID_PARAMETER
;
147 // Restore content at the original location
148 Status
= MmcWriteBlocks (&(MmcHostInstance
->BlockIo
), MmcHostInstance
->BlockIo
.Media
->MediaId
,Lba
,BufferSize
,BackBuffer
);
149 if (Status
!= EFI_SUCCESS
) {
150 DiagnosticLog (L
"ERROR: Fail to Write Block (2)\n");
154 // Read the restored content
155 Status
= MmcReadBlocks (&(MmcHostInstance
->BlockIo
), MmcHostInstance
->BlockIo
.Media
->MediaId
,Lba
,BufferSize
,ReadBuffer
);
156 if (Status
!= EFI_SUCCESS
) {
157 DiagnosticLog (L
"ERROR: Fail to Read Block (3)\n");
161 // Check the content is correct
162 if (!CompareBuffer (ReadBuffer
,BackBuffer
,BufferSize
)) {
163 DiagnosticLog (L
"ERROR: Fail to Read/Write Block (2)\n");
164 return EFI_INVALID_PARAMETER
;
172 MmcDriverDiagnosticsRunDiagnostics (
173 IN EFI_DRIVER_DIAGNOSTICS_PROTOCOL
*This
,
174 IN EFI_HANDLE ControllerHandle
,
175 IN EFI_HANDLE ChildHandle OPTIONAL
,
176 IN EFI_DRIVER_DIAGNOSTIC_TYPE DiagnosticType
,
178 OUT EFI_GUID
**ErrorType
,
179 OUT UINTN
*BufferSize
,
183 LIST_ENTRY
*CurrentLink
;
184 MMC_HOST_INSTANCE
*MmcHostInstance
;
187 if ((Language
== NULL
) ||
188 (ErrorType
== NULL
) ||
190 (ControllerHandle
== NULL
) ||
191 (BufferSize
== NULL
)) {
192 return EFI_INVALID_PARAMETER
;
195 Status
= EFI_SUCCESS
;
197 *BufferSize
= DIAGNOSTIC_LOGBUFFER_MAXCHAR
;
198 *Buffer
= DiagnosticInitLog (DIAGNOSTIC_LOGBUFFER_MAXCHAR
);
200 DiagnosticLog (L
"MMC Driver Diagnostics\n");
202 // For each MMC instance
203 CurrentLink
= mMmcHostPool
.ForwardLink
;
204 while (CurrentLink
!= NULL
&& CurrentLink
!= &mMmcHostPool
&& (Status
== EFI_SUCCESS
)) {
205 MmcHostInstance
= MMC_HOST_INSTANCE_FROM_LINK(CurrentLink
);
206 ASSERT(MmcHostInstance
!= NULL
);
208 // LBA=1 Size=BlockSize
209 DiagnosticLog (L
"MMC Driver Diagnostics - Test: First Block\n");
210 Status
= MmcReadWriteDataTest (MmcHostInstance
, 1, MmcHostInstance
->BlockIo
.Media
->BlockSize
);
212 // LBA=2 Size=BlockSize
213 DiagnosticLog (L
"MMC Driver Diagnostics - Test: Second Block\n");
214 Status
= MmcReadWriteDataTest (MmcHostInstance
, 2, MmcHostInstance
->BlockIo
.Media
->BlockSize
);
216 // LBA=10 Size=BlockSize
217 DiagnosticLog (L
"MMC Driver Diagnostics - Test: Any Block\n");
218 Status
= MmcReadWriteDataTest (MmcHostInstance
, MmcHostInstance
->BlockIo
.Media
->LastBlock
>> 1, MmcHostInstance
->BlockIo
.Media
->BlockSize
);
220 // LBA=LastBlock Size=BlockSize
221 DiagnosticLog (L
"MMC Driver Diagnostics - Test: Last Block\n");
222 Status
= MmcReadWriteDataTest (MmcHostInstance
, MmcHostInstance
->BlockIo
.Media
->LastBlock
, MmcHostInstance
->BlockIo
.Media
->BlockSize
);
224 // LBA=1 Size=2*BlockSize
225 DiagnosticLog (L
"MMC Driver Diagnostics - Test: First Block / 2 BlockSSize\n");
226 Status
= MmcReadWriteDataTest (MmcHostInstance
, 1, 2*MmcHostInstance
->BlockIo
.Media
->BlockSize
);
228 CurrentLink
= CurrentLink
->ForwardLink
;
235 // EFI Driver Diagnostics 2 Protocol
237 GLOBAL_REMOVE_IF_UNREFERENCED EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gMmcDriverDiagnostics2
= {
238 (EFI_DRIVER_DIAGNOSTICS2_RUN_DIAGNOSTICS
) MmcDriverDiagnosticsRunDiagnostics
,