drivers/mtd/rknand/api_flash.h

   1 /********************************************************************************\r
   2 *********************************************************************************\r
   3                         COPYRIGHT (c)   2004 BY ROCK-CHIP FUZHOU\r
   4                                 --  ALL RIGHTS RESERVED  --\r
   5 \r
   6 File Name:  api_flash.h\r
   7 Author:     XUESHAN LIN\r
   8 Created:    1st Dec 2008\r
   9 Modified:\r
  10 Revision:   1.00\r
  11 Modify log:\r
  12             1.01    Ôö¼ÓFtlClose½Ó¿Úº¯Êý    2009.10.15  lxs\r
  13 ********************************************************************************\r
  14 ********************************************************************************/\r
  15 #ifndef _API_FLASH_H\r
  16 #define _API_FLASH_H\r
  17 \r
  18 //1º¯ÊýÔÐÍÉùÃ÷\r
  19 /***************************************************************************\r
  20 º¯ÊýÃèÊö:FTLºÍFLASH³õÊ¼»¯\r
  21 Èë¿Ú²ÎÊý:ÎÞ\r
  22 ³ö¿Ú²ÎÊý:\r
  23         0=Õý³£·µ»Ø \r
  24         1=Ó³Éä±í³ö´í, ±»Ç¿ÖÆµÍ¸ñ\r
  25         2=flash³õÊ¼»¯Ê§°Ü,¿ÉÄÜÊÇÓ²¼þ´íÎó»òÒª½øÐÐ¹Ì¼þÉý¼¶\r
  26         ÆäËüÖµ:ÄÚ²¿´íÎó, ¸ÃÇý¶¯²»¿ÉÊ¹ÓÃ\r
  27 Ëµ    Ã÷:ÉÏµçÖ»Ðèµ÷ÓÃÒ»´Î³õÊ¼»¯¼´¿É\r
  28 ***************************************************************************/\r
  29 extern int FtlInit(unsigned int nandcBaseAddr,unsigned char pageRemapEn);\r
  30 extern int FTLInit_WithoutPageRemap(void);\r
  31 extern int FTLInit(void);\r
  32 \r
  33 \r
  34 /***************************************************************************\r
  35 º¯ÊýÃèÊö:»ñÈ¡FLASH´ÅÅÌÈÝÁ¿\r
  36 Èë¿Ú²ÎÊý:\r
  37         DISK_NAND_CODE:¹Ì¼þÅÌ\r
  38         DISK_NAND_DATA:ÏµÍ³²ÎÊýÅÌ\r
  39         DISK_NAND_USER:ÓÃ»§ÅÌ\r
  40 ³ö¿Ú²ÎÊý:´ÅÅÌ×ÜÉÈÇøÊý\r
  41 Ëµ    Ã÷:\r
  42 ***************************************************************************/\r
  43 extern unsigned int FtlGetCapacity(unsigned char LUN);\r
  44 \r
  45 /***************************************************************************\r
  46 º¯ÊýÃèÊö:¶ÁÉÈÇø½Ó¿Ú\r
  47 Èë¿Ú²ÎÊý:LUN=Âß¼·ÖÇøºÅ, Index=ÆðÊ¼ÉÈÇøµØÖ·, buf=Êý¾Ý»º³åÇø, nSec=ÉÈÇøÊý\r
  48 ³ö¿Ú²ÎÊý:0=¶ÁÈ¡ÕýÈ·; ·Ç0=¶ÁÈ¡³ö´í, Êý¾Ý²»¿ÉÓÃ\r
  49 µ÷ÓÃº¯Êý:\r
  50 Ëµ    Ã÷:\r
  51 ***************************************************************************/\r
  52 extern int FtlRead(unsigned char LUN, unsigned int Index, unsigned int nSec, void *buf);\r
  53 \r
  54 /***************************************************************************\r
  55 º¯ÊýÃèÊö:Ð´ÉÈÇø½Ó¿Ú\r
  56 Èë¿Ú²ÎÊý:LUN=Âß¼·ÖÇøºÅ, Index=ÆðÊ¼ÉÈÇøµØÖ·, buf=Êý¾Ý»º³åÇø, nSec=ÉÈÇøÊý\r
  57 ³ö¿Ú²ÎÊý:0=ÕýÈ·Ð´Èë; ·Ç0=Ð´²Ù×÷Ê§°Ü, Êý¾ÝÃ»ÓÐ±»ÕýÈ·Ð´Èë\r
  58 µ÷ÓÃº¯Êý:\r
  59 Ëµ    Ã÷:\r
  60 ***************************************************************************/\r
  61 extern int FtlWrite(unsigned char LUN, unsigned int Index, unsigned int nSec, void *buf);\r
  62 \r
  63 /***************************************************************************\r
  64 º¯ÊýÃèÊö:MLC FLASHÊý¾ÝË¢ÐÂ\r
  65 Èë¿Ú²ÎÊý:\r
  66 ³ö¿Ú²ÎÊý:\r
  67 µ÷ÓÃº¯Êý:\r
  68 Ëµ    Ã÷:ÔÚÏµÍ³IDLE/ÔÚ±È½Ï¼¯ÖÐ¶ÁÊý¾ÝÊ±(ÈçA-B²¥·Å¡¢Æµ·±¶Á×ÊÔ´µÈ)µ÷ÓÃ¸Ãº¯Êý, \r
  69                                  ÄÜ¼°Ê±ÐÞÕý±»Æµ·±¼¯ÖÐ¶Á»µµÄÊý¾Ý,º¯ÊýÖ´ÐÐÊ±¼ä¿ÉÄÜ½Ï³¤(¼¸°ÙmsÉõÖÁ¼¸s)\r
  70 ***************************************************************************/\r
  71 extern  void    FlashRefreshHook(void);\r
  72 \r
  73 /***************************************************************************\r
  74 º¯ÊýÃèÊö:AHBÖ÷Æµ¸üÐÂÊ±ÐèÒªµ÷ÓÃ´Ë½Ó¿ÚÀ´ÅäÖÃFLASHÊ±Ðò\r
  75 Èë¿Ú²ÎÊý:AHBnKHz=Ö÷Æµ(AHB)\r
  76 ³ö¿Ú²ÎÊý:\r
  77 µ÷ÓÃº¯Êý:\r
  78 ***************************************************************************/\r
  79 extern  void    FlashTimingCfg(unsigned int AHBnKHz);\r
  80 \r
  81 /***************************************************************************\r
  82 º¯ÊýÃèÊö:FTL ¹Ø±Õ£¬¹Ø»úÊ±µ÷ÓÃ\r
  83 Èë¿Ú²ÎÊý:ÎÞ\r
  84 ³ö¿Ú²ÎÊý:ÎÞ\r
  85 Ëµ    Ã÷:¹Ø»úÊ±£¬ÔÚËùÓÐÐ´ÎÄ¼þ²Ù×÷½áÊøºóµ÷ÓÃ\r
  86 ***************************************************************************/\r
  87 extern  void  FtlClose(void);\r
  88 \r
  89 /***************************************************************************\r
  90 º¯ÊýÃèÊö:FTL ¶¨Ê±»Øµ÷º¯Êý£¬ÏµÍ³1S×óÓÒµ÷ÓÃÒ»´Î\r
  91 Èë¿Ú²ÎÊý:ÎÞ\r
  92 ³ö¿Ú²ÎÊý:ÎÞ\r
  93 Ëµ    Ã÷:FTLÖÐÒ»Ð©CACHEÔÚ¶¨Ê±ÖÐ»ØÐ´flash\r
  94 ***************************************************************************/\r
  95 extern  void  FtlTimeHook(void);\r
  96 \r
  97 /***************************************************************************\r
  98 º¯ÊýÃèÊö:»ñÈ¡ flash page ´óÐ¡£¬ÒÔ±ãÍâÃæ¿ª»º³å,\r
  99 Èë¿Ú²ÎÊý:ÎÞ\r
 100 ³ö¿Ú²ÎÊý:page´óÐ¡£¬sectorµ¥Î»\r
 101 µ÷ÓÃº¯Êý:\r
 102 ËµÃ÷: ÐèÒªÔÚFTLInitºó²Å¿ÉÓÃ\r
 103 ***************************************************************************/\r
 104 extern  int   FlashGetPageSize(void);\r
 105 \r
 106 /***************************************************************************\r
 107 º¯ÊýÃèÊö:AHBÖ÷Æµ¸üÐÂÊ±ÐèÒªµ÷ÓÃ´Ë½Ó¿ÚÀ´ÅäÖÃFLASHÊ±Ðò\r
 108 Èë¿Ú²ÎÊý:AHBnMHz=Ö÷Æµ(AHB)\r
 109 ³ö¿Ú²ÎÊý:\r
 110 µ÷ÓÃº¯Êý:\r
 111 ***************************************************************************/\r
 112 extern  void    FlashTimingCfg(unsigned int AHBnKHz);\r
 113 \r
 114 /***************************************************************************\r
 115 º¯ÊýÃèÊö:ÏµÍ³ÅÌÐ´²»ÔÊÐí\r
 116 Èë¿Ú²ÎÊý:\r
 117 ³ö¿Ú²ÎÊý:\r
 118 µ÷ÓÃº¯Êý:\r
 119 ***************************************************************************/\r
 120 extern void FtlFlashSysProtSetOn(void);\r
 121 \r
 122 /***************************************************************************\r
 123 º¯ÊýÃèÊö:ÏµÍ³ÅÌÐ´ÔÊÐí\r
 124 Èë¿Ú²ÎÊý:\r
 125 ³ö¿Ú²ÎÊý:\r
 126 µ÷ÓÃº¯Êý:\r
 127 ***************************************************************************/\r
 128 extern void FtlFlashSysProtSetOff(void);\r
 129 \r
 130 /***************************************************************************\r
 131 º¯ÊýÃèÊö:²Á³ýÏµÍ³ÅÌ£¬Éý¼¶Ê±Ê¹ÓÃ\r
 132 Èë¿Ú²ÎÊý:\r
 133 ³ö¿Ú²ÎÊý:\r
 134 µ÷ÓÃº¯Êý:\r
 135 ***************************************************************************/\r
 136 extern void FtlLowFormatSysDisk(void);\r
 137 \r
 138 extern int FtlWriteImage(unsigned int Index, unsigned int nSec, void *buf);\r
 139 /***************************************************************************\r
 140 º¯ÊýÃèÊö:½«ËùÓÐ»º´æµÄcache Ð´µ½cache ¿é\r
 141 Èë¿Ú²ÎÊý:\r
 142 ³ö¿Ú²ÎÊý:\r
 143 µ÷ÓÃº¯Êý:\r
 144 ***************************************************************************/\r
 145 extern void     FtlCacheDelayWriteALL(void);\r
 146 \r
 147 /***************************************************************************\r
 148 º¯ÊýÃèÊö:ÉèÖÃ´ÅÅÌÐ´±£»¤µØÖ·£¬\r
 149 Èë¿Ú²ÎÊý:LBAµØÖ·£¬Ð¡ÓÚLBAµÄµØÖ·Ð´±£»¤\r
 150 ³ö¿Ú²ÎÊý:\r
 151 µ÷ÓÃº¯Êý:\r
 152 ***************************************************************************/\r
 153 void FtlSetSysProtAddr(int LBA);\r
 154 \r
 155 \r
 156 /***************************************************************************\r
 157 º¯ÊýÃèÊö:»ñÈ¡FLASH´ÅÅÌÈÝÁ¿\r
 158 Èë¿Ú²ÎÊý:ÅÌ·û\r
 159 ³ö¿Ú²ÎÊý:ÈÝÁ¿,ÒÔÉÈÇøÎªµ¥Î»\r
 160 µ÷ÓÃº¯Êý:\r
 161 ***************************************************************************/\r
 162 int FtlGetPageZoneCapacity(void);\r
 163 \r
 164 /***************************************************************************\r
 165 º¯ÊýÃèÊö:¶Á¶àÉÈÇø\r
 166 Èë¿Ú²ÎÊý:Index=ÉÈÇøºÅ, nSec=ÉÈÇøÊý\r
 167 ³ö¿Ú²ÎÊý:¶Áµ½µÄÊý¾ÝÔÚ»º³åÇøbufÖÐ\r
 168 µ÷ÓÃº¯Êý:\r
 169 ***************************************************************************/\r
 170 int FtlPageWrite(int Index, int nSec, void *buf);\r
 171 \r
 172 \r
 173 /***************************************************************************\r
 174 º¯ÊýÃèÊö:¶Á¶àÉÈÇø\r
 175 Èë¿Ú²ÎÊý:Index=ÉÈÇøºÅ, nSec=ÉÈÇøÊý\r
 176 ³ö¿Ú²ÎÊý:¶Áµ½µÄÊý¾ÝÔÚ»º³åÇøbufÖÐ\r
 177 µ÷ÓÃº¯Êý:\r
 178 ***************************************************************************/\r
 179 int FtlPageRead(int Index, int nSec, void *buf);\r
 180 \r
 181 \r
 182 /***************************************************************************\r
 183 º¯ÊýÃèÊö:¶ÁÈ¡ SN sectorÐÅÏ¢\r
 184 Èë¿Ú²ÎÊý:pbuf\r
 185 ³ö¿Ú²ÎÊý:\r
 186 µ÷ÓÃº¯Êý:\r
 187 ×¢ÒâÐÅÏ¢£ºÐèÒªÔÚflash Çý¶¯¼ÓÔØºó²ÅÄÜµ÷ÓÃ£¬pbuf´óÐ¡ÐèÒª´óÓÚµÈÓÚ512 bytes£¬·µ»ØÐÅÏ¢Îª512\r
 188           bytes¡£\r
 189 ***************************************************************************/\r
 190 char GetSNSectorInfo(char * pbuf);\r
 191 \r
 192 \r
 193 extern int NandInit(void);\r
 194 extern int NandRead(unsigned int Index, unsigned int nSec, void * buf) ;\r
 195 extern int NandWriteImage(unsigned int Index, unsigned int nSec, void * buf);\r
 196 extern int NandWrite(unsigned int Index, unsigned int nSec, void * buf) ;\r
 197 extern int NandDeInit(void) ;\r
 198 extern int NandForceDeInit(void);\r
 199 extern unsigned int NandGetCapacity(void); \r
 200 extern void NandSetSysProtAddr(unsigned int SysImageWriteEndAdd);\r
 201 extern void FtlDelayWriteCacheEn(unsigned int en);\r
 202 #endif\r