/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *    flash_mtd.amd.c
 *
 * Project:
 * --------
 *   Maui
 *
 * Description:
 * ------------
 *   This is flash MTD driver for AMD series devices.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================

/********************************************************/
/*                  Include Header Files                */
/********************************************************/

#include "flash_opt.h"
#include "flash_mtd.h"

#ifdef __AMD_SERIES_NOR__

/* ************************************************************
         SPANSION(AMD) NOR FLASH MTD Flash Driver
   ************************************************************ */

#ifdef __PAGE_BUFFER_PROGRAM__
   extern kal_uint32 PAGE_BUFFER_SIZE;
#endif

#ifdef __SPANSION_PL_N__
   extern kal_uint32 INT_GetCurrentTime(void);
#endif

static int CheckDeviceReady_AMD(void * DriveData, kal_uint32 BlockIndex);
/*-----------------------------------*/
static int MountDevice_AMD(void * DriveData, NOR_MTD_FlashInfo * FlashInfo)
{
   NOR_Flash_MTD_Data * D = DriveData;
   kal_uint32 i, MaxBlockSize = 0;

   i = 0;
   FlashInfo->TotalBlocks = 0;
   while(D->RegionInfo[i].BlockSize != 0)
   {
      FlashInfo->BlockSize[i] = D->RegionInfo[i].BlockSize;
      FlashInfo->RegionBlocks[i] = D->RegionInfo[i].RegionBlocks;
      FlashInfo->TotalBlocks += D->RegionInfo[i].RegionBlocks;

      if(D->RegionInfo[i].BlockSize > MaxBlockSize)
         MaxBlockSize = D->RegionInfo[i].BlockSize;
      i++;
   }
   FlashInfo->ActualRegionNum = i;
   return FS_NO_ERROR;
}


/*-----------------------------------*/
#ifdef _LOW_COST_SINGLE_BANK_FLASH_
#ifdef __MTK_TARGET__
#pragma arm section code = "SNORCODE"
#endif /* __MTK_TARGET__ */
#endif

void WaitReady_AMD(kal_uint32 addr,kal_uint16 data)//Validate!!
{
   kal_uint16 stat_data;
   kal_uint32 data_cache_id;   
#ifdef __SST_NOR__
   kal_uint16 data_toggle1 = 0, data_toggle2 = 0;
#else 
   kal_bool  pass_flag = 0;
#endif

   data_cache_id = INT_DisableDataCache();

#ifndef __SST_NOR__
   while(pass_flag == 0)
   {
      while(1)
      {
         stat_data = *(volatile kal_uint16*)addr;
         if((stat_data & POLL_BUSY) == (data & POLL_BUSY))
            break;

         if(stat_data & POLL_TIMEOUT) //DQ5 = 1 may imply a timeout happens
         {
            stat_data = *(volatile kal_uint16*)addr;
            if((stat_data & POLL_BUSY) == (data & POLL_BUSY))
               break;
            else
            {
               *(volatile kal_uint16*)addr = CMD_RESET;
               INT_RestoreDataCache(data_cache_id);
               EXT_ASSERT(0,0,0,0);
               return;
            }
         }

      }  /* Inner While(1) */

      stat_data = *(volatile kal_uint16*)addr;
      if ( stat_data==data )
      {
         pass_flag = 1;
      }
   }  /* Outer While(1) */
#else
	/* use toggle method instead of data polling method */ 
	/* SST also can use data polling method, but need to disable DQ5 check */
	/* because SST don't support DQ5 */
   while(1)
   {
      data_toggle1 = *(volatile kal_uint16*)addr;
      data_toggle2 = *(volatile kal_uint16*)addr;
      if( !((data_toggle1^data_toggle2) & TOGGLE_BUSY) )
      {
         data_toggle1 = *(volatile kal_uint16*)addr;
         data_toggle2 = *(volatile kal_uint16*)addr;
         if(data_toggle1 == data_toggle2)
         {
            stat_data = *(volatile kal_uint16*)addr;
            if(stat_data == data)
               break;
            else
               EXT_ASSERT(0,0,0,0);
         }
      }
   }
#endif

   INT_RestoreDataCache(data_cache_id);
   return;
}

/*-----------------------------------*/
static int ShutDown_AMD(void * DriveData)
{
   NOR_Flash_MTD_Data * D = DriveData;
   volatile FLASH_CELL *fp = (volatile FLASH_CELL*)D->BaseAddr;
   FLASH_CELL s1, s2;
   kal_uint32 data_cache_id;

   data_cache_id = INT_DisableDataCache();

   while(1)
   {
      s1 = fp[0];
      s2 = fp[0];
      if ((s1 ^ s2)==0)
         break;
      else
      {
         if(s2 & TOGGLE_TIMEOUT)
         {
            s1 = fp[0];
            s2 = fp[0];
            if ((s1 ^ s2)==0)
               break;
            else
            {
               fp[0] = CMD_RESET;
               break;
            }
         }
      }
   }

   D->CurrAddr = NULL;
   INT_RestoreDataCache(data_cache_id);
   return FS_NO_ERROR;
}

/*-----------------------------------*/
static void EraseCommand_AMD(volatile FLASH_CELL *fp)
{
   kal_uint32 savedMask;

   savedMask = SaveAndSetIRQMask();
   fp[ADDR_UNLOCK_1] = CMD_UNLOCK_1;
   fp[ADDR_UNLOCK_2] = CMD_UNLOCK_2;
   fp[ADDR_UNLOCK_1] = CMD_SERASE;
   fp[ADDR_UNLOCK_1] = CMD_UNLOCK_1;
   fp[ADDR_UNLOCK_2] = CMD_UNLOCK_2;
   fp[0]     = CMD_SERASE_END;
   RestoreIRQMask(savedMask);
}

/*-----------------------------------*/
#ifdef __SPANSION_PL_N__
static void DelayAWhile_AMD(void)
{
   
#if defined(MT6205B)

   volatile kal_uint32 i;
   for (i=0;i<8000;i++);
   
#else

   volatile kal_uint32 CurrentTime,StartTime;
   
   StartTime = INT_GetCurrentTime(); //32KHz Fregquency Counter
   while(1)
   {
      CurrentTime = INT_GetCurrentTime();
      if((CurrentTime > StartTime) && ((CurrentTime-StartTime)>=2))
         break;
      if((CurrentTime < StartTime) && (CurrentTime>=1))
         break;
   }
#endif
     
   return;
}
#endif //__SPANSION_PL_N__

/*-----------------------------------*/
static int EraseBlock_AMD(void * DriveData, kal_uint32 BlockIndex)
{
   NOR_Flash_MTD_Data * D = DriveData;
   volatile FLASH_CELL * fp = (volatile FLASH_CELL *) D->CurrAddr;

#ifdef DEBUG
   //EraseBlock: block not mapped
   ASSERT(D->CurrAddr == BlockAddress(D, BlockIndex));
#endif

   ASSERT((~D->Signature == (kal_uint32)D->RegionInfo));

   EraseCommand_AMD(fp);
#ifdef __SPANSION_PL_N__
   DelayAWhile_AMD();
#endif
   while(CheckDeviceReady_AMD(DriveData, 0)!= FS_NO_ERROR);

   return FS_NO_ERROR;
}

/*-----------------------------------*/
#if (defined(__TOSHIBA_TV__) || defined(__TOSHIBA_TY__))
static int ProgramData_TOSHIBA(void * DriveData, void * Address, void * Data, kal_uint32 Length)
{
   NOR_Flash_MTD_Data *D = DriveData;
   volatile FLASH_CELL *bp = (volatile FLASH_CELL *) D->CurrAddr;
   kal_uint32 savedMask;

   ASSERT((~D->Signature == (kal_uint32)D->RegionInfo));

   #ifdef DEBUG
   //can't write zero bytes into flash
   ASSERT(Length != 0);
   #endif

   switch (Length)
   {
      case sizeof(FLASH_CELL):
         #if defined(DEBUG)
            //Misaligned write into flash
            ASSERT(!(((kal_uint32)Address) % sizeof(FLASH_CELL)));
         #endif

         #ifdef DEBUG
         //Attempt to set bits in flash!
         ASSERT(!(~((volatile FLASH_CELL*)Address)[0] & ((FLASH_CELL*)Data)[0]));
         #endif

         savedMask = SaveAndSetIRQMask();
         bp[ADDR_UNLOCK_1] = CMD_UNLOCK_1;
         bp[ADDR_UNLOCK_2] = CMD_UNLOCK_2;
         bp[ADDR_UNLOCK_1] = CMD_PROG;
         ((volatile FLASH_CELL*)Address)[0] = ((FLASH_CELL*)Data)[0];
#ifdef _LOW_COST_SINGLE_BANK_FLASH_
         WaitReady_AMD((kal_uint32)Address, *(kal_uint16*)Data);
         RestoreIRQMask(savedMask);