/*C**************************************************************************
* NAME:         nf.c
*----------------------------------------------------------------------------
* Copyright (c) 2003 Atmel.
*----------------------------------------------------------------------------
* RELEASE:      snd1c-refd-nf-4_0_3      
* REVISION:     1.11     
*----------------------------------------------------------------------------
* PURPOSE:
* This file contains the high level NF with 2Kb page routines
*****************************************************************************/
 
/*_____ I N C L U D E S ____________________________________________________*/


#include "config.h"                           /* system configuration */
#include "board.h"                            /* board definition  */
#include "lib_mcu\usb\usb_drv.h"              /* usb driver definition */
#include "nf.h"                               /* NF definition */


/*_____ M A C R O S ________________________________________________________*/

#ifndef NF_CAPACITY_AUTO_DETECT
  #error  NF_CAPACITY_AUTO_DETECT must be defined in board.h
#endif

#if NF_CONFIG != NF_1X_2KB
  #error NF_CONFIG must be defined with NF_1X_2KB in config.h
#endif

#ifndef NF_FULL_CHIP_ERASE
  #error NF_FULL_CHIP_ERASE  must be set to TRUE or FALSE in config.h
#endif

#ifndef MEM_RESERVED_SIZE
  #error MEM_RESERVED_SIZE must be defined in config.h
#endif


/*_____ D E F I N I T I O N ________________________________________________*/

xdata Byte nf_send_cmd At(NF_CMD_LATCH_ENABLE_ADD);   /* Command */
xdata Byte nf_send_add At(NF_ADD_LATCH_ENABLE_ADD);   /* Address */
xdata Byte volatile nf_data At(NF_ADDRESS_CMD_DATA);  /* Data    */

/*_____ D E C L A R A T I O N ______________________________________________*/
extern  data    Uint32  gl_ptr_mem;               /* memory data pointer                        */
extern  pdata   Byte gl_buffer[];
extern          bit reserved_disk_space;

data  Uint32  nf_current_physical_sector_addr;   /* give the address of the current sector     */  
data  Uint32  gl_address;                        /* general address variable                   */
data  Uint16  nf_look_up_table_block;            /* look up table address (block)              */
data  Uint16  gl_cpt_page;                       /* internal page counter (byte access)        */
data  Byte    nf_zone;                           /* current zone number                        */
data  Byte    nf_gl_buf_idx;
data  Byte    gl_buf_free_idx ;

bdata bit nf_block_used = FALSE;                  /* Set when a block was used                  */
bdata bit nf_busy = FALSE;                        /* indicate that nand flash is busy           */
bdata bit nf_lut_modified = FALSE;                /* indicate that LUT have been modified       */
bdata bit nf_wr_open = FALSE;                     /* indicate that a write command is required  */ 
bdata bit nf_reserved_space = FALSE;

idata Uint16  nf_logical_block;                   /* Current logical block value                */
idata Byte    nf_gl_buf_idx_max;                  /* max index for updating LUT                 */

xdata Uint16  nf_lut_block[NF_ZONE_MAX];          /* LUT address (block value)                  */
xdata Uint16  nf_buf_free[24];                    /* contain free physical block address        */
xdata Byte    nf_spare_block;                     /* number of free block                       */
xdata Uint16  nf_block_to_be_deleted;             /* give the address of the next deleted block */
xdata Uint16  nf_block_min;                       /* address of the first block in the buffer   */
xdata Uint16  nf_block_max;                       /* address of the last block in the buffer    */
xdata Union16 nf_buf[NF_BUFFER_SIZE];             /* Buffer for write operation                 */
xdata Byte    nf_old_zone;                        /* for zone change                            */  
xdata Byte    nf_lut_index[NF_ZONE_MAX];          /* give the index for updating LUT            */
xdata Byte    nf_spare_block_number[NF_ZONE_MAX]; /* Number of free spare block in each zone    */




xdata Uint32 nf_mem_size;
xdata Uint32 nf_reserved_space_start;
xdata Uint32 save_gl_ptr_mem;
xdata Uint32 save_physical_sector;
bit nf_write_advanced = FALSE;
bit nf_close_write_session = FALSE;

#if (NF_CAPACITY_AUTO_DETECT == TRUE)             /* If autodetect capacity nand flash is active  */
  xdata Byte    nf_zone_max;                      /* nf_zone_max definition                       */
  xdata Byte    nf_device_type;                   /* nf_device_type definition                    */
  bdata bit     nf_5_cycle_address;               /* nf_5_cycle_address definition                */
#endif



/**************************************************************************************
manufacturer code :
            0x98                Toshiba
            0xEC                Samsung


supported   |  device |  capacity |     |manufacturer | Copy back
by this     |   code  |           |     |S : Samsung  | supported
driver      |         |           |     |T : Toshiba  |
------------------------------------------------------------------------------------
  no        |   0x39  |    8MB    | 512 |S    (1,8V)  | no
  no        |   0xE6  |    8MB    | 512 |S - T(3,3V)  | no
  no        |   0x73  |   16MB    | 512 |S - T(3,3V)  | no
  no        |   0x33  |   16MB    | 512 |S    (1,8V)  | no
  no        |   0x75  |   32MB    | 512 |S    (3,3V)  | yes
  no        |   0x75  |   32MB    | 512 |T    (3,3V)  | no
  no        |   0x76  |   64MB    | 512 |S    (3,3V)  | yes
  no        |   0x76  |   64MB    | 512 |T    (3,3V)  | no
  no        |   0x79  |  128MB    | 512 |S    (3,3V)  | yes
  no        |   0x79  |  128MB    | 512 |T    (3,3V)  | no
  yes       |   0xA1  |  128MB    |2048 |S    (1,8V)  | yes
  yes       |   0xF1  |  128MB    |2048 |S    (3,3V)  | yes
  yes       |   0xAA  |  256MB    |2048 |S    (1,8V)  | yes
  yes       |   0xDA  |  256MB    |2048 |S    (3,3V)  | yes
**************************************************************************************/


/*F**************************************************************************
* NAME: nf_force_write_close
*----------------------------------------------------------------------------
* PARAMS:
*
* return:
*----------------------------------------------------------------------------
* PURPOSE:
*   End of write close function.
*----------------------------------------------------------------------------
* EXAMPLE:
*----------------------------------------------------------------------------
* NOTE:
*   Call to this function is mandatory after a write session.
*   Flag nf_close_write_session must be set to 1 during the call to 
*   nf_write_close() function.
*   This flag must be reset after a call to nf_force_write_close().
*----------------------------------------------------------------------------
* REQUIREMENTS:
*****************************************************************************/
void nf_force_write_close(void)
{
  /* Copy last part of a block if the block was assigned */
  Nf_CS_ON();
  if (nf_block_used)
  {
    if ( (((Byte*)&gl_ptr_mem)[3] & 0x3F) || (gl_cpt_page != 0) ) 
      nf_copy_block_tail();
    nf_block_erase((Uint32)(nf_block_to_be_deleted) << NF_SHIFT_SECTOR_BLOCK);    /* Erase old block */
    nf_block_used = FALSE;
  }
}


/*F**************************************************************************
* NAME: nf_read_spare_byte
*----------------------------------------------------------------------------
* PARAMS:
*
* return:
*   OK : LUT construction complete
*   KO : pb for LUT
*----------------------------------------------------------------------------
* PURPOSE:
*   read spare data byte and construct the look up table.
*----------------------------------------------------------------------------
* EXAMPLE:
*----------------------------------------------------------------------------
* NOTE:
*----------------------------------------------------------------------------
* REQUIREMENTS:
*****************************************************************************/
bit nf_read_spare_byte(void)
{
Byte byte_5;
Byte byte_6;
Byte lut_is_present;
Byte page;
Uint16 block;
Uint16 j;                       /* counter */
Uint16 i;                       /* counter */
Uint16 start;                   /* start value for the construction of the LUT */
Uint16 end;                     /* final value */
Uint16 free_bloc_pos;
Union16 block2;
bit   block_valid;
xdata Uint16 last_physical_used_block[NF_ZONE_MAX]; /* Last physical block used */
#define temp_address  gl_ptr_mem

  Nf_CS_ON();

  lut_is_present      = 0x00;         
  nf_close_write_session = FALSE;
  for (i = 0; i < NF_ZONE_MAX_CPT; i++)
  {
    nf_lut_index[i] = 0;                /* LUT index */
  }

  /***************************************************/
  /* For each zone, this following lines :           */
  /*   Search bad block                              */
  /*   Determine if a LUT is present                 */
  /*   Determine the last physical block             */ 
  /***************************************************/
  gl_address = 0;
  Nf_wait_busy();
                                      
  for (i = 0; i < NF_ZONE_MAX_CPT; i++)                               /* for each zone */

  {
    nf_spare_block_number[i] = 23;                                    /* initialize the spare block table */
    last_physical_used_block[i] = (Uint16)(i) << NF_SHIFT_BLOCK_ZONE; /* initialize the last used physical block value */
    for (j = NF_BLOCK_PER_ZONE; j != 0; j--)        
    {
      Nf_read_open_spare_area(gl_address, 0x05);
      if ( Nf_rd_byte() != 0xFF )                                     /* block status : valid/invalid */
      {
        nf_spare_block_number[i]--;                                   /* Defect block  */
        if (nf_spare_block_number[i] < 4)
          return KO;
      }
      else                                                            /* Block is valid */
      {
        byte_6 = Nf_rd_byte();                                        /* Determine is the block is a specific block */
        if (  (byte_6 == 0x00) ||                                     /* 0x00 = specific block */
              ( (byte_6 != 0xFF) && ( (byte_6 & 0xF8) != 0x10 ) &&    /* Value in redundant spare area not correct */
                (byte_6 != 0xE8) )                                    /* Don't care about LUT block */
           )
        { 
          nf_spare_block_number[i]--;                                 /* specific or invalid block */
          if (nf_spare_block_number[i] < 4)
            return KO;

        }
        else
        {
          if (byte_6 == 0xE8)                                         /* look up table ? */
          {
              lut_is_present |= (0x01) << i;
              nf_lut_block[i] = gl_address >> NF_SHIFT_SECTOR_BLOCK;
          }

          if ( (byte_6 & 0xF8) == 0x10)                               /* Determine the last physical used block */
          {
            last_physical_used_block[i] = gl_address >> NF_SHIFT_SECTOR_BLOCK;
          }
        }

      }
      gl_address += NF_PAGE_PER_BLOCK;
    }
  }

  for (i = 0; i < NF_ZONE_MAX_CPT; i++)
  { /* Determine the index for each correct lut */
    if ((lut_is_present & (0x01 << i)))
    {
      gl_address = (Uint32)(nf_lut_block[i]) << NF_SHIFT_SECTOR_BLOCK;
      do
      {
        Nf_read_open_spare_area(gl_address, 0x06);
        nf_lut_index[i]++;
        gl_address++;
        byte_6 = Nf_rd_byte();
      }
      while ((byte_6 == 0xE8) && ((gl_address & 0x3F) != 0)); 
      if ((byte_6 == 0xE8) && ((gl_address & 0x3F) == 0))
      {
        nf_lut_index[i]--;
        gl_address--;
      }
      else
      {
        nf_lut_index[i]-=2;
        gl_address-=2;
      }      

      Nf_read_open_spare_area(gl_address, 0x00);
      if (Nf_rd_byte() != 0xFF)                       /* LUT have been modified */
      {
        nf_block_erase(gl_address);
        lut_is_present &= ~((0x01) << i);             /* Reset bit */
        nf_lut_index[i] = 0;
        Nf_wait_busy();
      }

    }
  }
  /*****************************************************************/
  /*          Find free physical block for LUT for each zone       */
  /*****************************************************************/
  for (i = 0; i < NF_ZONE_MAX_CPT; i++)
  {
    if (!(lut_is_present & (0x01 << i)))
    {
      block = last_physical_used_block[i];
      start = (Uint16)(i) << NF_SHIFT_BLOCK_ZONE;                   /* starting value for each zone */
      j = 0;
      if (block == start)                                           /* starting block for scan      */
      {
        block = start + 1023;
      }
      block_valid = FALSE;                                          /* init flag block valid */
      do
      {
        gl_address = (Uint32)(block) << NF_SHIFT_SECTOR_BLOCK;
        Nf_read_open_spare_area(gl_address, 0x05);
        byte_5 = Nf_rd_byte();
        byte_6 = Nf_rd_byte();
  
        if ( (byte_5 == 0xFF) && (byte_6 == 0xFF) ) /* not assigned and valid block */