diff options
Diffstat (limited to 'Board/Flash/STD/StdSpansionFlashWrite.c')
| -rw-r--r-- | Board/Flash/STD/StdSpansionFlashWrite.c | 669 |
1 files changed, 669 insertions, 0 deletions
diff --git a/Board/Flash/STD/StdSpansionFlashWrite.c b/Board/Flash/STD/StdSpansionFlashWrite.c new file mode 100644 index 0000000..1bb80d5 --- /dev/null +++ b/Board/Flash/STD/StdSpansionFlashWrite.c @@ -0,0 +1,669 @@ +//************************************************************************* +//************************************************************************* +//** ** +//** (C)Copyright 1985-2008, American Megatrends, Inc. ** +//** ** +//** All Rights Reserved. ** +//** ** +//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 ** +//** ** +//** Phone: (770)-246-8600 ** +//** ** +//************************************************************************* +//************************************************************************* + +//************************************************************************* +// $Header: /Alaska/SOURCE/Flash_Combined_2/Core/STD/StdSpansionFlashWrite.c 8 2/10/11 5:37a Calvinchen $ +// +// $Revision: 8 $ +// +// $Date: 2/10/11 5:37a $ +//********************************************************************** +// Revision History +// ---------------- +// $Log: /Alaska/SOURCE/Flash_Combined_2/Core/STD/StdSpansionFlashWrite.c $ +// +// 8 2/10/11 5:37a Calvinchen +// [TAG] EIP50771 +// [Category] Bug Fix +// [Severity] Normal +// [Symptom] Sometime vendor id return incorrect value. +// [RootCause] There should have a 10ns delay according SSTVF1681 +// specification. +// [Solution] Added an IO Delay before get vendor/Device i. +// [Files] StdSpansionFlashWrite.c +// +// 7 12/23/09 6:13a Calvinchen +// Improvement: +// 1.Added FWH/LPC/STD Flash Device Number support. +// 2.Changed for SMIFlash module Label "4.6.3.6_SMIFLASH_12" or later +// +// 6 12/15/09 5:50a Calvinchen +// 1. Modified for adding flash chip name support. +// 2. Bug fixed : Programming failed with SST 39VF1681. +// +// 5 6/24/09 3:15a Calvinchen +// (EIP22177) Updated for Aptio Source Enhancement. +// +// 2 1/14/09 10:37p Calvinchen +// +// 1 12/11/08 2:18a Calvinchen +// Added support for Spansion 29GL128/256/512/01GP STD flash. +// +// +// +//********************************************************************** + +//<AMI_FHDR_START> +// +// Name: SpansionFlashWrite.c +// +// Description: Flash update routines +// +//<AMI_FHDR_END> +//********************************************************************** + +//---------------------------------------------------------------------- +// Includes +#include <efi.h> +#include <AmiDxeLib.h> +#include "FlashPart.h" +#include "token.h" + + +//---------------------------------------------------------------------- +// Local MACRO Definitions +#define UNLOCK 0 +#define LOCK 1 + +//---------------------------------------------------------------------------- +// Flash Part Specific Definitions + +#define S29GL01GP_MANID 0x01 // offset 0x00 = Manufacturers ID +#define S29GL01GP_DEVID1 0x7e // offset 0x02 = Device ID byte 1 +#define S29GL01GP_DEVID2 0x28 // offset 0x1c = Device ID byte 2 +#define S29GL01GP_DEVID3 0x01 // offset 0x1e = Device ID byte 3 +#define Spansion29GLxxx 0x7e01 + +//---------------------------------------------------------------------------- +// Module level global data +extern UINT8 pFlashDeviceNumber[FLASH_PART_STRING_LENGTH]; + +//---------------------------------------------------------------------------- +// Function Prototypes +VOID +SpansionFlashEraseCommand ( + volatile UINT8 *pBlockAddress + ); +VOID +SpansionFlashReadCommand ( + volatile UINT8 *pByteAddress, + UINT8 *Data, + UINT32 *Length + ); +VOID +SpansionFlashProgramCommand ( + volatile UINT8 *pByteAddress, + UINT8 *Data, + UINT32 *Length + ); +BOOLEAN +SpansionFlashIsEraseCompleted ( + volatile UINT8 *pBlockAddress, + BOOLEAN *pError, + UINTN *pStatus + ); +BOOLEAN +SpansionFlashIsProgramCompleted ( + volatile UINT8 *pByteAddress, + UINT8 *Byte, + UINT32 Length, + BOOLEAN *pError, + UINTN *pStatus + ); +VOID +SpansionFlashBlockWriteEnable ( + UINT8* pBlockAddress + ); +VOID +SpansionFlashBlockWriteDisable ( + UINT8* pBlockAddress + ); +VOID +SpansionFlashDeviceWriteEnable ( + VOID + ); +VOID +SpansionFlashDeviceWriteDisable ( + VOID + ); +VOID +SpansionFlashVirtualFixup ( + EFI_RUNTIME_SERVICES *pRS + ); + + + +//---------------------------------------------------------------------------- +// Module specific variables +FLASH_PART mStdSpansionFlash = + { + SpansionFlashReadCommand, + SpansionFlashEraseCommand, + SpansionFlashProgramCommand, + SpansionFlashIsEraseCompleted, + SpansionFlashIsProgramCompleted, + SpansionFlashBlockWriteEnable, + SpansionFlashBlockWriteDisable, + SpansionFlashDeviceWriteEnable, + SpansionFlashDeviceWriteDisable, + SpansionFlashVirtualFixup, // Spansion flash device virtual address + // fix up routine + 1, // Number of bytes to program to the + // Flash part in each program command + 0, // Dummy value to hold place - only used in SPI + NULL // Flash Part Number Pointer + }; + +//---------------------------------------------------------------------------- +// Function definitions + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionResetFlash +// +// Description: This function resets the Spansion flash part +// +// Input: None +// +// Output: None +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +VOID +SpansionResetFlash ( + IN volatile UINT8* pAddress +) +{ + *pAddress = 0xf0; +} +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionWriteBufferAbortReset +// +// Description: This function resets the Spansion flash part +// +// Input: None +// +// Output: None +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +VOID +SpansionWriteBufferAbortReset ( + IN volatile UINT8* pAddress +) +{ + pAddress[0xaaa] = 0xaa; + pAddress[0x555] = 0x55; + pAddress[0x555] = 0xf0; +} +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashReadCommand +// +// Description: This function programs a byte data to the specified location +// +// Input: *pByteAddress Location where the data to be written +// Bytes - data to be written. +// Length - number of bytes to write +// +// Output: Length - number of bytes that were not written +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> + +static +VOID +SpansionFlashReadCommand ( + IN volatile UINT8* pByteAddress, + OUT UINT8 *Byte, + OUT UINT32 *Length +) +{ + UINT32 dNumBytes = 0; + + // Changes for SMIFlash module label "4.6.3.6_SMIFLASH_12" or later. + for ( dNumBytes = 0; dNumBytes < *Length ; dNumBytes++ ) + *( Byte + dNumBytes ) = *(UINT8*)((UINT32)pByteAddress + dNumBytes ); + *Length = 0; + return ; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: WaitForPollingCompleted +// +// Description: +// This function waits until the command sent to the flash part +// has completed +// +// Input: +// IN volatile UINT8* pAddress Location to check the device status +// IN UINT8 bData Polling Data +// +// Output: Nothing +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +EFI_STATUS +WaitForPollingCompleted ( + IN volatile UINT8* pAddress, + IN UINT8 bData +) +{ + UINT8 bStatus; + UINT32 dTimeout = FLASH_RETRIES * 0x10000; + EFI_STATUS Status = EFI_TIMEOUT; + + for ( ; dTimeout > 0; dTimeout-- ) { + // Read DQ0~7 + bStatus = *(volatile UINT8*)pAddress; + // Check DQ7 for Polling completed. + if ((bStatus & BIT07) == (bData & BIT07)) return EFI_SUCCESS; + // Check DQ5(Write Timeout),DQ3(Erase Timeout) and DQ1(Abort) for + // error occured. + if ( (bStatus & BIT05) || (bStatus & BIT03) || (bStatus & BIT01) ) { + bStatus = *(volatile UINT8*)pAddress; + if ((bStatus & BIT07) == (bData & BIT07)) return EFI_SUCCESS; + else return EFI_TIMEOUT; + } + } + return EFI_DEVICE_ERROR; +} +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashEraseCommand +// +// Description: This API function erases a block in the flash. Flash model +// specific code will branch out from this routine +// +// Input: pBlockAddress Block that need to be erased +// +// Output: Nothing +// +// Returns: None +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +VOID +SpansionFlashEraseCommand ( + IN volatile UINT8* pBlockAddress +) +{ + EFI_STATUS Status; + UINT8 bFlashRetry; + + for ( bFlashRetry = 0; bFlashRetry < FLASH_RETRIES; bFlashRetry++ ) { + SpansionResetFlash ( pBlockAddress ); + pBlockAddress[0xaaa] = 0xaa; + pBlockAddress[0x555] = 0x55; + pBlockAddress[0xaaa] = 0x80; + pBlockAddress[0xaaa] = 0xaa; + pBlockAddress[0x555] = 0x55; + *pBlockAddress = 0x30; + Status = WaitForPollingCompleted ( pBlockAddress, 0xff ); + if ( Status != EFI_SUCCESS ) SpansionResetFlash ( pBlockAddress ); + if ( *pBlockAddress == 0xFF ) { + Status = EFI_SUCCESS; + break; + } else Status = EFI_DEVICE_ERROR; + } +//- return Status; +} +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashIsEraseCompleted +// +// Description: This function verifies whether the block erase +// command is completed and returns the status of the command +// +// Input: *pBlockAddress Location of the block erase +// +// Output: *pError True on error and false on success +// *Status Error status code (0 - Success) +// +// Return: TRUE If operation completed successfully +// *pError = FALSE, *pStatus = 0 +// FALSE If operation failed +// *pError = TRUE, *pStatus = error status +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +BOOLEAN +SpansionFlashIsEraseCompleted ( + IN volatile UINT8 *pBlockAddress, + OUT BOOLEAN *pError, + OUT UINTN *pStatus +) +{ + UINT32 dNumBytes; + + for ( dNumBytes = 0; dNumBytes < FlashBlockSize; dNumBytes++ ) { + if ( *(volatile UINT8*)( pBlockAddress + dNumBytes ) != 0xFF ) { + if ( pError ) *pError = TRUE; + if ( pStatus ) *pStatus = EFI_DEVICE_ERROR; + return FALSE; + } + } + if ( pError ) *pError = FALSE; + if ( pStatus ) *pStatus = EFI_SUCCESS; + return TRUE; +} + + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashProgramCommand +// +// Description: This function programs a byte data to the specified location +// +// Input: *pByteAddress - Location where the data to be written +// *Byte - Byte to be written +// *Length - Number of bytes to write +// +// Output: *Length - Number of bytes still left to write +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +VOID +SpansionFlashProgramCommand ( + IN volatile UINT8* pByteAddress, + IN UINT8 *Byte, + IN OUT UINT32 *Length +) +{ + volatile UINT8* pBlockAddress = (volatile UINT8*)BLOCK(pByteAddress); + UINT8 bFlashRetry; + EFI_STATUS Status = EFI_SUCCESS; + + + if ( *Byte != *pByteAddress ) { + SpansionResetFlash ( pBlockAddress ); + for ( bFlashRetry = 0; bFlashRetry < FLASH_RETRIES; bFlashRetry++ ) { + // Program Command Sequence - Write to Buffer + pBlockAddress[0xaaa] = 0xaa; + pBlockAddress[0x555] = 0x55; + *pByteAddress = 0x25; // write to buffer command. + *pByteAddress = 0; // write count - 1 + *pByteAddress = *Byte; // + *pByteAddress = 0x29; // program buffer to flash command. + Status = WaitForPollingCompleted ( pByteAddress, *Byte ); + if ( Status == EFI_TIMEOUT ) { + SpansionWriteBufferAbortReset ( pBlockAddress ); + continue; + } + if ( Status == EFI_DEVICE_ERROR ) + SpansionResetFlash ( pByteAddress ); + if ( *pByteAddress == *Byte ) { + Status = EFI_SUCCESS; + break; + } else Status = EFI_DEVICE_ERROR; + } + } else Status = EFI_SUCCESS; + *Length = *Length - 1; + //- return Status; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashIsProgramCompleted +// +// Description: This function verifies whether the program (page or byte) +// command is completed and returns the status of the command +// +// Input: *pByteAddress Location of the program command +// *Byte Pointer to data written +// Length Amount of data to check +// +// Output: *pError True on error and false on success +// *Status Error status code (0 - Success) +// +// Return: TRUE If operation completed successfully +// *pError = FALSE, *pStatus = 0 +// FALSE If operation failed +// *pError = TRUE, *pStatus = error status +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +BOOLEAN +SpansionFlashIsProgramCompleted ( + IN volatile UINT8* pByteAddress, + IN UINT8 *Byte, + IN UINT32 Length, + OUT BOOLEAN *pError, + OUT UINTN *pStatus +) +{ + UINT32 dNumBytes; + UINT8 bByte; + + for ( dNumBytes = 0; dNumBytes < Length; dNumBytes++ ) { + bByte = * ( Byte + dNumBytes ); + if ( bByte != *(volatile UINT8*)( pByteAddress + dNumBytes ) ) { + if ( pError ) *pError = TRUE; + if ( pStatus ) *pStatus = EFI_DEVICE_ERROR; + return FALSE; + } + } + if ( pError ) *pError = FALSE; + if ( pStatus ) *pStatus = EFI_SUCCESS; + return TRUE; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashBlockWriteEnable +// +// Description: This function contains any flash specific code need to +// enable a particular flash block write +// +// Input: None +// +// Output: None +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +VOID +SpansionFlashBlockWriteEnable ( + IN UINT8* pBlockAddress +) +{ + +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashBlockWriteDisable +// +// Description: This function contains any flash specific code need to +// disable a particular flash block write +// +// Input: None +// +// Output: None +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +VOID +SpansionFlashBlockWriteDisable ( + IN UINT8* pBlockAddress +) +{ + +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashDeviceWriteEnable +// +// Description: This function contains any flash specific code need to +// enable flash write +// +// Input: None +// +// Output: None +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +VOID +SpansionFlashDeviceWriteEnable (VOID) +{ + //We don't have to do anything here because + //Flash Device is write enabled by the South Bridge driver +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashDeviceWriteDisable +// +// Description: This function contains any flash specific code need to +// disable flash write +// +// Input: None +// +// Output: None +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +static +VOID +SpansionFlashDeviceWriteDisable (VOID) +{ + //We don't have to do anything here because + //we always keep flash device in the write enabled state +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SpansionFlashVirtualFixup +// +// Description: This function will be invoked by the core to convert +// runtime pointers to virtual address +// +// Input: *pRS Pointer to runtime services +// +// Output: None +// +// Return: None +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> + +static +VOID +SpansionFlashVirtualFixup( + IN EFI_RUNTIME_SERVICES *pRS +) +{ + +// // Following is an example code for virtual address conversion +// pRS->ConvertPointer(0, (VOID**)&FlashDeviceBase); + + return; +} + + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: mStdSpansionIdentify +// +// Description: This function identifies the supported Spansion flash part and +// returns appropriate flash device API pointer. If flash part is +// not supported by this module it will return FALSE. +// +// +// Input: pBlockAddress Block address of the flash part. Can be used to +// send ID command +// +// Output: **FlashApi Pointer to hold the returned flash API +// +// Return: TRUE If flash part is supported, FlashApi contains +// routines to handle the flash requests +// FALSE Flash part is not supported +// +// Note: This routine is part of the global flash init list. Make sure +// it is properly linked to the init list "FlashList" (in SDL file) +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +BOOLEAN +mStdSpansionIdentify ( + IN volatile UINT8* pBlockAddress, + OUT FLASH_PART **Struct +) +{ + UINT8 MID; + UINT8 DID1, DID2, DID3; + + SpansionResetFlash( pBlockAddress ); + + pBlockAddress[0xaaa] = 0xaa; + pBlockAddress[0x555] = 0x55; + pBlockAddress[0xaaa] = 0x90; + // Delay before read flash ID. + IoWrite8 ( 0xeb, 0x55 ); + MID = *pBlockAddress; + DID1 = *(pBlockAddress + 0x02); + DID2 = *(pBlockAddress + 0x1c); + DID3 = *(pBlockAddress + 0x1e); + + SpansionResetFlash( pBlockAddress ); + + // Check MID & DID1 for S29GL01G/512/256/128P support. + if ((MID == S29GL01GP_MANID) && (DID1 == S29GL01GP_DEVID1)) { + MemCpy ( pFlashDeviceNumber, "Spansion S29GL128/256/512/01GP", 30 ); + mStdSpansionFlash.FlashPartNumber = pFlashDeviceNumber; + *Struct = &mStdSpansionFlash; + return TRUE; + } + return FALSE; +} + +//************************************************************************* +//************************************************************************* +//** ** +//** (C)Copyright 1985-2008, American Megatrends, Inc. ** +//** ** +//** All Rights Reserved. ** +//** ** +//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 ** +//** ** +//** Phone: (770)-246-8600 ** +//** ** +//************************************************************************* +//************************************************************************* |