summaryrefslogtreecommitdiff
path: root/Core/EM/OFBD/CleanErrorLog/CleanErrorLog.c
blob: 80889d96e4f42d5e1b1013d9109e106b34be2625 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2011, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093        **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************

//**********************************************************************
// $Header: /Alaska/SOURCE/Modules/OFBD/CleanErrorLog/CleanErrorLog.c 3     10/06/11 1:28a Terrylin $
//
// $Revision: 3 $
//
// $Date: 10/06/11 1:28a $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Modules/OFBD/CleanErrorLog/CleanErrorLog.c $
// 
// 3     10/06/11 1:28a Terrylin
// Fix the build error, when Gpnv Error Logging module didn't enable.
// 
// 2     3/16/11 10:32p Terrylin
// [TAG]  		EIP51285
// [Category]  	Improvement
// [Description]  	Fill the description for user more clearly.
// [Files]  		CleanErrorLog.mak
// CleanErrorLog.h
// CleanErrorLog.c
// 
// 1     1/17/11 3:56a Terrylin
// 
//**********************************************************************
//<AMI_FHDR_START>
//
// Name:	CleanErrorLog.c
//
// Description:
// This function is used to Clean Error Log. For example,AFU will call this function to clean error log when
// /CLNEVNLOG is issued.
//
//<AMI_FHDR_END>
//**********************************************************************
#include "Efi.h"
#include <Protocol\SmiFlash.h>
#include <AmiLib.h>
#include <AmiDxeLib.h>
#include "CleanErrorLog.h"
#include "..\OFBD.h"

//#define CONVERT_TO_STRING(a) #a
#define STR(a) CONVERT_TO_STRING(a)

EFI_GUID gEfiSmiFlashProtocolGuid = EFI_SMI_FLASH_GUID;
EFI_SMI_FLASH_PROTOCOL *mSmiFlash = NULL;

//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	CleanErrorLogCallback
//
// Description:	Locate SmiFlash protocol callback
//
// Input:
//      IN EFI_EVENT    Event
//      IN VOID         *Context
//
// Output:
//      VOID
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID CleanErrorLogCallback(
    IN EFI_EVENT Event,
    IN VOID *Context
)
{
    EFI_GUID       gEfiSmiFlashProtocolGuid = EFI_SMI_FLASH_GUID;

    pBS->LocateProtocol (&gEfiSmiFlashProtocolGuid, NULL, &mSmiFlash);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	CleanErrorLogInSmm
//
// Description:	OFBD Clear event log InSmm Function
//
// Input:
//      VOID
//
// Output:
//      VOID
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID CleanErrorLogInSmm(VOID)
{
    EFI_STATUS     Status;
    EFI_GUID       gEfiSmiFlashProtocolGuid = EFI_SMI_FLASH_GUID;

    Status = pBS->LocateProtocol (&gEfiSmiFlashProtocolGuid, NULL, &mSmiFlash);
    if (EFI_ERROR(Status)){
        EFI_EVENT   SmiFlashCallbackEvt;
        VOID        *Reg;
        RegisterProtocolCallback(
             &gEfiSmiFlashProtocolGuid, CleanErrorLogCallback,
             NULL,&SmiFlashCallbackEvt, &Reg
        );
    }
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	OFBDCleanErrorLogHandle
//
// Description:	OFBD Clean Gpnv Error Log Handle
//
// Input:
//      IN OUT OFBD_HDR *pOFBDHdr
// Output:
//      EFI_STATUS
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
OFBDCleanErrorLogHandle( 
    IN OUT OFBD_HDR *pOFBDHdr)
{
    EFI_STATUS Status = EFI_SUCCESS;

#if CLEAN_GPNV_ERROR_LOG_SAMPLE_TEST

	UINT8 *pOFBDTblEnd;
	OFBD_TC_58_CEL_STRUCT *CELStructPtr;
    #if defined(FV_ERROR_LOGGING_BASE) && defined(FV_ERROR_LOGGING_SIZE)
	FUNC_BLOCK FuncBlock;
	UINT8      pType1Header[16];
    #endif
	
	pOFBDTblEnd = (UINT8 *)((UINT8 *)pOFBDHdr + (pOFBDHdr->OFBD_Size));
	CELStructPtr = (OFBD_TC_58_CEL_STRUCT *)((UINT8 *)pOFBDHdr + pOFBDHdr->OFBD_HDR_SIZE + sizeof(OFBD_EXT_HDR)); 
	
    // Is need to Clean Gpnv Error Log
	if (CELStructPtr->dwFunSts == OFBD_TC_CEL_FUNC_REQ)
	{
		// Check Gpnv Error Logging module whether support or not
    #if !defined(FV_ERROR_LOGGING_BASE) || !defined(FV_ERROR_LOGGING_SIZE)
		CELStructPtr->dwRetSts = OFBD_TC_CEL_BIOS_NOT_SUPPORT;
    #else
		//
		// Reference from "ErrorLogging/SmiGpnv/SmiGpnv.c" file code +>>>
		//
		// SS: Alaska;$/Alaska/SOURCE/Modules/ErrorLogging;
		//
		// Label 4.6.3.6_GPNV_ERRLOG_2.1a
		//    
		// Enable Flash Write.    
        Status = mSmiFlash->EnableFlashWrite(&FuncBlock);
        // Read flash to preserve EFI_GPNV_ERROR_HEADER_TYPE1 header.
        FuncBlock.BufAddr = (UINTN)&pType1Header;
        FuncBlock.BlockSize = 0x10; // EFI_GPNV_ERROR_HEADER_TYPE1
        FuncBlock.BlockAddr = ((UINT32)FV_ERROR_LOGGING_BASE & \
                               (FLASH_SIZE - 1)); //0 starts at 0xfff0_0000
        FuncBlock.ErrorCode = 0;
        Status = mSmiFlash->ReadFlash(&FuncBlock);
        // Erase Error Logging GPNV.
        FuncBlock.BlockSize = FV_ERROR_LOGGING_SIZE; //max size 0xffff
        FuncBlock.BufAddr = 0;
        Status = mSmiFlash->EraseFlash(&FuncBlock); // Write Flash
        // Restore EFI_GPNV_ERROR_HEADER_TYPE1 header.
        FuncBlock.BlockSize = 0x10; //EFI_GPNV_ERROR_HEADER_TYPE1
        FuncBlock.BufAddr = (UINTN)&pType1Header;
        Status = mSmiFlash->WriteFlash(&FuncBlock); // Write Flash
        // Disable Flash Write.    
        Status = mSmiFlash->DisableFlashWrite(&FuncBlock);
        //
        // <<<+
        //
        if (EFI_ERROR (Status))
            CELStructPtr->dwRetSts = OFBD_TC_CEL_ERROR;
        else
            CELStructPtr->dwRetSts = OFBD_TC_CEL_OK;
    #endif
	}
		
#endif

    return(Status);
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	CleanErrorLogEntry
//
// Description:	OFBD Clean Gpnv Error Log Entry Point
//
// Input:
//      IN VOID             *Buffer
//      IN OUT UINT8        *pOFBDDataHandled
// Output:
//      VOID
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID CleanErrorLogEntry (
    IN VOID             *Buffer,
    IN OUT UINT8        *pOFBDDataHandled )
{
	OFBD_HDR *pOFBDHdr;
	OFBD_EXT_HDR *pOFBDExtHdr; 
	VOID *pOFBDTblEnd;
	OFBD_TC_58_CEL_STRUCT *CELStructPtr;  

	if(*pOFBDDataHandled == 0)
	{
		pOFBDHdr = (OFBD_HDR *)Buffer;
		pOFBDExtHdr = (OFBD_EXT_HDR *)((UINT8 *)Buffer + (pOFBDHdr->OFBD_HDR_SIZE));
		CELStructPtr = (OFBD_TC_58_CEL_STRUCT *)((UINT8 *)pOFBDExtHdr + sizeof(OFBD_EXT_HDR)); 
		pOFBDTblEnd = (VOID *)((UINT8 *)Buffer + (pOFBDHdr->OFBD_Size));    
		
		if(pOFBDHdr->OFBD_FS & OFBD_FS_ERR_LOG)
		{   
			//Check Type Code ID
			if(pOFBDExtHdr->TypeCodeID == OFBD_EXT_TC_CLN_ERR_LOG)
			{  
				if(OFBDCleanErrorLogHandle(pOFBDHdr) == EFI_SUCCESS)
				{
					//OEM Default Command Configuration Handled.
					*pOFBDDataHandled = 0xFF;      
					return;
				}
			} 
			//Error occured
			*pOFBDDataHandled = 0xFE;          
			return;
		}  
	}

    return;
}

//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2011, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093        **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************