summaryrefslogtreecommitdiff
path: root/Core/EM/OFBD/StdEC/StdEC.c
blob: 7fd87fabe7afe4b446766d0b5f7f112a5dbb30e3 (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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (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/StdEC/StdEC.c 2     3/16/11 10:36p Terrylin $
//
// $Revision: 2 $
//
// $Date: 3/16/11 10:36p $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Modules/OFBD/StdEC/StdEC.c $
// 
// 2     3/16/11 10:36p Terrylin
// [TAG]  		EIP51285
// [Category]  	Improvement
// [Description]  	Fill the description for user more clearly.
// [Files]  		StdEC.mak
// StdEC.c
// StdEC.h
// 
// 1     4/13/09 5:46a Lawrencechang
// Initial check-in.
// 
// 1     3/25/05 5:37p Markw
// 
//**********************************************************************
//<AMI_FHDR_START>
//
// Name:	StdEC.c
//
// Description: 
// This function is used to support flashing AMI EC firmware.
//
//<AMI_FHDR_END>
//**********************************************************************
#include "Efi.h"
#include "token.h"
#include <AmiLib.h>
#include <AmiDxeLib.h>
#include "StdEC.h"
#include "..\OFBD.h"


UINT8	PMBase30 = 0 ;		//	(for Intel ICHx)
//**********************************************************************
//<AMI_PHDR_START>
//
// Procedure:	ObFullRead
//
// Description:	Waits for Output Buffer Full and then reads the data port
//
// Input:		None
//
// Output:		KBC Data port data
//
//<AMI_PHDR_END>
//**********************************************************************                

UINT8 ObFullRead()
{
	for (;;) {
		if (IoRead8(EC_KBC_CMD_PORT) & EC_KBC_OBF) {
			return IoRead8(EC_KBC_DATA_PORT);
		}
	}
}

void IbFree()
{
	for (;;) {
		if (!(IoRead8(EC_KBC_CMD_PORT) & EC_KBC_IBF)) {
			break;
		}
	}
}
//**********************************************************************
//<AMI_PHDR_START>
//
// Procedure:	WriteKeyboardCommand
//
// Description:	Writes command to KBC.
//
// Input:		Command to send to KBC
//
// Output:		None
//
//<AMI_PHDR_END>
//**********************************************************************                

void WriteKeyboardCommand(UINT8 bCmd)
{
	IbFree();
	IoWrite8(EC_KBC_CMD_PORT, bCmd);
	IbFree();
}
//**********************************************************************
//<AMI_PHDR_START>
//
// Procedure:	WriteKeyboardData
//
// Description:	Writes data to KBC.
//
// Input:		Data to send to KBC
//
// Output:		None
//
//<AMI_PHDR_END>
//**********************************************************************                
void WriteKeyboardData(UINT8 bData)
{
	IbFree();
	IoWrite8(EC_KBC_DATA_PORT, bData);
	IbFree();
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	OFBDECCommand
//
// Description:	EC command
//
// Input:
//      IN UINT8            bCmd
// Output:
//      EFI_STATUS
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
OFBDECCommand(IN UINT8 bCmd)
{
    EFI_STATUS Status = EFI_SUCCESS;

    WriteKeyboardCommand(bCmd);
    if(ObFullRead() != EC_NO_ERROR_FM_ACK)
        Status = RETURN_ERR;

    return(Status);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	OFBDECCheckSum
//
// Description:	computes EC data checksum
//
// Input:
//      IN UINT8 *BuffPtr
//      IN UINT32 Size
// Output:
//      UINT32
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
UINT32
OFBDECCheckSum(IN UINT8 *BuffPtr, IN UINT32 Size)
{
    UINT32 CheckSum = 0;
    UINT32 i = 0;

    for (i = 0; i < Size / sizeof (UINT32); i++)
        CheckSum += *(UINT32*)(BuffPtr + i * sizeof (UINT32));

    return (~CheckSum);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	USBKeyboardMouseDisable
//
// Description:	USB Keyboard Mouse Disable
//
// Input:
//      IN OFBD_TC_54_STD_EC_STRUCT *ECStructPtr
//      OUT UINT8 *ReturnErr
// Output:
//      EFI_STATUS
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
USBKeyboardMouseDisable(
    IN OFBD_TC_54_STD_EC_STRUCT *ECStructPtr,
    OUT UINT8   *ReturnErr)
{
    EFI_STATUS Status = EFI_SUCCESS;

    if(ECStructPtr->dbFlaSts & OFBD_TC_STD_EC_START)
    {
        *ReturnErr = 0;
        // Disable Legacy USB SMI	
        //for example (for Intel ICHx)
	    //PMBase30 = IoRead8 (PM_BASE_ADDRESS + 0x30) ;
	    //IoWrite8 ( (PM_BASE_ADDRESS + 0x30), (PMBase30 & ~8));
    }

    return(Status);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	USBKeyboardMouseEnable
//
// Description:	USB Keyboard Mouse Enable
//
// Input:
//      IN OFBD_TC_54_STD_EC_STRUCT *ECStructPtr,
//      IN UINT8 *ReturnErr)
// Output:
//      EFI_STATUS
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
USBKeyboardMouseEnable(
    IN OFBD_TC_54_STD_EC_STRUCT *ECStructPtr,
    IN UINT8 *ReturnErr)
{
    EFI_STATUS Status = EFI_SUCCESS;

    if((ECStructPtr->dbFlaSts & OFBD_TC_STD_EC_END) | (*ReturnErr != 0))
    {
        // Restore Legacy USB SMI	
        //for example (for Intel ICHx)
	    //IoWrite8 ( (PM_BASE_ADDRESS + 0x30), PMBase30 ) ;
    }

    return(Status);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	OFBDStdECStart
//
// Description:	for EC firmware entry flash mode and start transmit data
//
// Input:
//      IN OUT OFBD_TC_54_STD_EC_STRUCT *ECStructPtr
// Output:
//      EFI_STATUS
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
OFBDStdECStart(
    IN OUT OFBD_TC_54_STD_EC_STRUCT *ECStructPtr)
{
    EFI_STATUS Status = EFI_SUCCESS;
    UINT16 ChipID = 0;
    VOID *pOFBDTblEnd = (VOID *)((UINT8 *)ECStructPtr + sizeof(OFBD_TC_54_STD_EC_STRUCT) + sizeof(OFBD_END));

    WriteKeyboardCommand(EC_CMD_DISABLE_KBD); //0xAD

    //Identify Chip ID
    WriteKeyboardCommand(EC_CMD_GET_CHIPID);    //0xA3
    ChipID = ObFullRead() << 8;                 //Chip ID HiByte
    ChipID |= ObFullRead();                     //save Chip ID LowByte
    if(*(UINT16 *)pOFBDTblEnd != ChipID)        
    {
        ECStructPtr->dwRetSts |= OFBD_RS_EC_CHIPID; 
        WriteKeyboardCommand(EC_CMD_ENABLE_KBD);   //0xAE
        return(RETURN_ERR);
    }

    WriteKeyboardCommand(EC_CMD_ENABLE_KBD);   //0xAE

    //Entry Flash Mode			0xDF
    if(OFBDECCommand(EC_CMD_ENTRY_FLASHMODE) != EFI_SUCCESS)
    {
        ECStructPtr->dwRetSts |= OFBD_RS_EC_ENTRY;    
        return(RETURN_ERR);
    }

    //Erase Flash Memory			0x01
    if(OFBDECCommand(EC_CMD_ERASE_MEMORY) != EFI_SUCCESS)
    {
        ECStructPtr->dwRetSts |= OFBD_RS_EC_ERASE;      
        WriteKeyboardCommand(EC_CMD_EXIT_FLASHMODE);    //0xFE  
        return(RETURN_ERR);
    }

    //Initial Programming Mode			0x02
    if(OFBDECCommand(EC_CMD_INITIAL_PM) != EFI_SUCCESS)
    {
        ECStructPtr->dwRetSts |= OFBD_RS_EC_INIT;       
        WriteKeyboardCommand(EC_CMD_EXIT_FLASHMODE);    //0xFE  
        return(RETURN_ERR);
    }
       
    ECStructPtr->dwRetSts |= OFBD_RS_EC_OK;              

    return(Status);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	OFBDStdECFlash
//
// Description:	for EC firmware to transmit data
//
// Input:
//      IN OFBD_TC_54_STD_EC_STRUCT *ECStructPtr
// Output:
//      EFI_STATUS
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
OFBDStdECFlash(IN OFBD_TC_54_STD_EC_STRUCT *ECStructPtr)
{
    EFI_STATUS Status = EFI_SUCCESS;
    UINT32 CheckSum = 0;
    UINT8 ByteCheckSum = 0;
    VOID *pOFBDTblEnd = (VOID *)((UINT8 *)ECStructPtr + sizeof(OFBD_TC_54_STD_EC_STRUCT) + sizeof(OFBD_END));
    UINT8 *DataPtr = (UINT8 *)(*(UINT64 *)((UINT8 *)pOFBDTblEnd - sizeof(OFBD_END)));
    UINT32 i, j;

    //calc Check Sum
    CheckSum = OFBDECCheckSum(DataPtr, ECStructPtr->ddSize);
    if(ECStructPtr->ddChkSum != CheckSum)
    {
        ECStructPtr->dwRetSts |= OFBD_RS_EC_CHKSUM;
        return(RETURN_ERR);
    }

    for(i=0; i < ECStructPtr->ddSize; i += 0x80)
    {
        //Start Flash Data Transmit
        if(OFBDECCommand(EC_CMD_START_TRANS) != EFI_SUCCESS)
        {
             ECStructPtr->dwRetSts |= OFBD_RS_EC_START;       
             WriteKeyboardCommand(EC_CMD_EXIT_FLASHMODE);    //0xFE  
             return(RETURN_ERR);
        }
        ByteCheckSum = 0;
        for(j = 0; j < 0x80; j++)
        {
             WriteKeyboardData(*(DataPtr + i + j));
             ByteCheckSum += *(DataPtr + i + j);   
        }
        if(ObFullRead() == ByteCheckSum)
        {
             //Write Flash Data	        0x04
             if(OFBDECCommand(EC_CMD_WRITE_DATA) != EFI_SUCCESS)
             {
                 ECStructPtr->dwRetSts |= OFBD_RS_EC_WRITE;       
                 WriteKeyboardCommand(EC_CMD_EXIT_FLASHMODE);    //0xFE  
                 return(RETURN_ERR);
             }
       }
       else
       {
             i -= 0x80;
       }
    }
    ECStructPtr->dwRetSts |= OFBD_RS_EC_OK;             

    return(Status);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	OFBDStdECEnd
//
// Description:	for EC firmware leave flash mode and finished transmit data
//
// Input:
//      IN OUT OFBD_TC_54_STD_EC_STRUCT *ECStructPtr
//      IN OUT OFBD_HDR *pOFBDHdr
// Output:
//      EFI_STATUS
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
OFBDStdECEnd(
    IN OUT OFBD_TC_54_STD_EC_STRUCT *ECStructPtr, 
    IN OUT OFBD_HDR *pOFBDHdr)
{
    EFI_STATUS Status = EFI_SUCCESS;

    //Exit Programming Mode				0x05
    if(OFBDECCommand(EC_CMD_EXIT_PM) != EFI_SUCCESS)
    {
        ECStructPtr->dwRetSts |= OFBD_RS_EC_EXIT;      
        WriteKeyboardCommand(EC_CMD_EXIT_FLASHMODE);    //0xFE  
        return(RETURN_ERR);
    }

    if(pOFBDHdr->OFBD_OS & OFBD_OS_DOS)         
        WriteKeyboardCommand(EC_CMD_RESTART);    //0xFF
    else
        WriteKeyboardCommand(EC_CMD_EXIT_FLASHMODE);    //0xFE
        
    ECStructPtr->dwRetSts |= OFBD_RS_EC_OK;              

    return(Status);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	OFBDStdECFlashHandle
//
// Description:	OFBD Standard EC Flash Handle
//
// Input:
//      IN OUT OFBD_TC_54_STD_EC_STRUCT *ECStructPtr
//      IN OUT OFBD_HDR *pOFBDHdr
// Output:
//      EFI_STATUS
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
OFBDStdECFlashHandle(
    IN OUT OFBD_TC_54_STD_EC_STRUCT *ECStructPtr, 
    IN OUT OFBD_HDR *pOFBDHdr)
{
    EFI_STATUS Status = EFI_SUCCESS;
    UINT8   ReturnErr = 0;

    USBKeyboardMouseDisable(ECStructPtr, &ReturnErr); 

    if(ECStructPtr->dbFlaSts & OFBD_TC_STD_EC_START) 
    {   
        //Entry flash mode
        ReturnErr = (UINT8)OFBDStdECStart(ECStructPtr);
    }
    else if(ECStructPtr->dbFlaSts & OFBD_TC_STD_EC_FLASH)                       
    {
        //Transmit data
        ReturnErr = (UINT8)OFBDStdECFlash(ECStructPtr);
    }
    else if(ECStructPtr->dbFlaSts & OFBD_TC_STD_EC_END)         
    {
        //Leave flash mode
        ReturnErr = (UINT8)OFBDStdECEnd(ECStructPtr, pOFBDHdr);
    }
    else
    {
        Status = RETURN_ERR;
    }
    
    USBKeyboardMouseEnable(ECStructPtr, &ReturnErr);

    return(Status);
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:	OFBDEntryPoint
//
// Description:	OFBD Standard EC Flash Entry Point
//
// Input:
//      IN VOID             *Buffer
//      IN OUT UINT8        *pOFBDDataHandled
// Output:
//      VOID
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID StdECEntry (
    IN VOID             *Buffer,
    IN OUT UINT8        *pOFBDDataHandled )
{
    OFBD_HDR *pOFBDHdr;
    OFBD_EXT_HDR *pOFBDExtHdr; 
    VOID *pOFBDTblEnd;
    OFBD_TC_54_STD_EC_STRUCT *ECStructPtr;    

    if(*pOFBDDataHandled == 0)
    {
        pOFBDHdr = (OFBD_HDR *)Buffer;
        pOFBDExtHdr = (OFBD_EXT_HDR *)((UINT8 *)Buffer + (pOFBDHdr->OFBD_HDR_SIZE));
        ECStructPtr = (OFBD_TC_54_STD_EC_STRUCT *)((UINT8 *)pOFBDExtHdr + sizeof(OFBD_EXT_HDR)); 
        pOFBDTblEnd = (VOID *)((UINT8 *)Buffer + (pOFBDHdr->OFBD_Size));    

        //TRACE((-1,"pOFBDHdr address is:%x ------\n",pOFBDHdr));
        //TRACE((-1,"pOFBDTblEnd address is:%x ------\n",*(UINT64 *)((UINT8 *)pOFBDTblEnd -sizeof(OFBD_END))));
        
        if(pOFBDHdr->OFBD_FS & OFBD_FS_EC)
        {   
            //Check Type Code ID
            if(pOFBDExtHdr->TypeCodeID == OFBD_EXT_TC_EC)
            {  
                //IoWrite32(0x300, *(UINT32 *)((UINT8 *)pOFBDTblEnd -4)); //debug

                if(OFBDStdECFlashHandle(ECStructPtr, pOFBDHdr) == EFI_SUCCESS)
                {
                    //Standard EC Flash Handled
                    *pOFBDDataHandled = 0xFF;      
                    return;
                }
                else
                {
                    //Not Standard EC Flash Data
                    *pOFBDDataHandled = 0;          
                    return;
                }
            } 
            else
            {
                 //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                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************