xref: /OK3568_Linux_fs/kernel/drivers/mtd/rknand/api_flash.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /********************************************************************************
3*4882a593Smuzhiyun *********************************************************************************
4*4882a593Smuzhiyun 			COPYRIGHT (c)   2004 BY ROCK-CHIP FUZHOU
5*4882a593Smuzhiyun 				--  ALL RIGHTS RESERVED  --
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun File Name:  api_flash.h
8*4882a593Smuzhiyun Author:     XUESHAN LIN
9*4882a593Smuzhiyun Created:    1st Dec 2008
10*4882a593Smuzhiyun Modified:
11*4882a593Smuzhiyun Revision:   1.00
12*4882a593Smuzhiyun Modify log:
13*4882a593Smuzhiyun             1.01    ����FtlClose�ӿں���    2009.10.15  lxs
14*4882a593Smuzhiyun ********************************************************************************
15*4882a593Smuzhiyun ********************************************************************************/
16*4882a593Smuzhiyun #ifndef _API_FLASH_H
17*4882a593Smuzhiyun #define _API_FLASH_H
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun //1����ԭ������
20*4882a593Smuzhiyun /***************************************************************************
21*4882a593Smuzhiyun ��������:FTL��FLASH��ʼ��
22*4882a593Smuzhiyun ��ڲ���:��
23*4882a593Smuzhiyun ���ڲ���:
24*4882a593Smuzhiyun         0=��������
25*4882a593Smuzhiyun         1=ӳ������, ��ǿ�Ƶ͸�
26*4882a593Smuzhiyun         2=flash��ʼ��ʧ��,������Ӳ�������Ҫ���й̼�����
27*4882a593Smuzhiyun         ����ֵ:�ڲ�����, ����������ʹ��
28*4882a593Smuzhiyun ˵    ��:�ϵ�ֻ�����һ�γ�ʼ������
29*4882a593Smuzhiyun ***************************************************************************/
30*4882a593Smuzhiyun extern int FtlInit(unsigned int nandcBaseAddr,unsigned char pageRemapEn);
31*4882a593Smuzhiyun extern int FTLInit_WithoutPageRemap(void);
32*4882a593Smuzhiyun extern int FTLInit(void);
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun /***************************************************************************
36*4882a593Smuzhiyun ��������:��ȡFLASH��������
37*4882a593Smuzhiyun ��ڲ���:
38*4882a593Smuzhiyun         DISK_NAND_CODE:�̼���
39*4882a593Smuzhiyun         DISK_NAND_DATA:ϵͳ������
40*4882a593Smuzhiyun         DISK_NAND_USER:�û���
41*4882a593Smuzhiyun ���ڲ���:������������
42*4882a593Smuzhiyun ˵    ��:
43*4882a593Smuzhiyun ***************************************************************************/
44*4882a593Smuzhiyun extern unsigned int FtlGetCapacity(unsigned char LUN);
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun /***************************************************************************
47*4882a593Smuzhiyun ��������:�������ӿ�
48*4882a593Smuzhiyun ��ڲ���:LUN=�߼�������, Index=��ʼ������ַ, buf=���ݻ�����, nSec=������
49*4882a593Smuzhiyun ���ڲ���:0=��ȡ��ȷ; ��0=��ȡ����, ���ݲ�����
50*4882a593Smuzhiyun ���ú���:
51*4882a593Smuzhiyun ˵    ��:
52*4882a593Smuzhiyun ***************************************************************************/
53*4882a593Smuzhiyun extern int FtlRead(unsigned char LUN, unsigned int Index, unsigned int nSec, void *buf);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun /***************************************************************************
56*4882a593Smuzhiyun ��������:д�����ӿ�
57*4882a593Smuzhiyun ��ڲ���:LUN=�߼�������, Index=��ʼ������ַ, buf=���ݻ�����, nSec=������
58*4882a593Smuzhiyun ���ڲ���:0=��ȷд��; ��0=д����ʧ��, ����û�б���ȷд��
59*4882a593Smuzhiyun ���ú���:
60*4882a593Smuzhiyun ˵    ��:
61*4882a593Smuzhiyun ***************************************************************************/
62*4882a593Smuzhiyun extern int FtlWrite(unsigned char LUN, unsigned int Index, unsigned int nSec, void *buf);
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun /***************************************************************************
65*4882a593Smuzhiyun ��������:MLC FLASH����ˢ��
66*4882a593Smuzhiyun ��ڲ���:
67*4882a593Smuzhiyun ���ڲ���:
68*4882a593Smuzhiyun ���ú���:
69*4882a593Smuzhiyun ˵    ��:��ϵͳIDLE/�ڱȽϼ��ж�����ʱ(��A-B���š�Ƶ������Դ��)���øú���,
70*4882a593Smuzhiyun 				 �ܼ�ʱ������Ƶ�����ж���������,����ִ��ʱ����ܽϳ�(����ms������s)
71*4882a593Smuzhiyun ***************************************************************************/
72*4882a593Smuzhiyun extern	void    FlashRefreshHook(void);
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun /***************************************************************************
75*4882a593Smuzhiyun ��������:AHB��Ƶ����ʱ��Ҫ���ô˽ӿ�������FLASHʱ��
76*4882a593Smuzhiyun ��ڲ���:AHBnKHz=��Ƶ(AHB)
77*4882a593Smuzhiyun ���ڲ���:
78*4882a593Smuzhiyun ���ú���:
79*4882a593Smuzhiyun ***************************************************************************/
80*4882a593Smuzhiyun extern	void    FlashTimingCfg(unsigned int AHBnKHz);
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun /***************************************************************************
83*4882a593Smuzhiyun ��������:FTL �رգ��ػ�ʱ����
84*4882a593Smuzhiyun ��ڲ���:��
85*4882a593Smuzhiyun ���ڲ���:��
86*4882a593Smuzhiyun ˵    ��:�ػ�ʱ��������д�ļ��������������
87*4882a593Smuzhiyun ***************************************************************************/
88*4882a593Smuzhiyun extern	void  FtlClose(void);
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun /***************************************************************************
91*4882a593Smuzhiyun ��������:FTL ��ʱ�ص�������ϵͳ1S���ҵ���һ��
92*4882a593Smuzhiyun ��ڲ���:��
93*4882a593Smuzhiyun ���ڲ���:��
94*4882a593Smuzhiyun ˵    ��:FTL��һЩCACHE�ڶ�ʱ�л�дflash
95*4882a593Smuzhiyun ***************************************************************************/
96*4882a593Smuzhiyun extern	void  FtlTimeHook(void);
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun /***************************************************************************
99*4882a593Smuzhiyun ��������:��ȡ flash page ��С���Ա����濪����,
100*4882a593Smuzhiyun ��ڲ���:��
101*4882a593Smuzhiyun ���ڲ���:page��С��sector��λ
102*4882a593Smuzhiyun ���ú���:
103*4882a593Smuzhiyun ˵��: ��Ҫ��FTLInit��ſ���
104*4882a593Smuzhiyun ***************************************************************************/
105*4882a593Smuzhiyun extern	int   FlashGetPageSize(void);
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun /***************************************************************************
108*4882a593Smuzhiyun ��������:AHB��Ƶ����ʱ��Ҫ���ô˽ӿ�������FLASHʱ��
109*4882a593Smuzhiyun ��ڲ���:AHBnMHz=��Ƶ(AHB)
110*4882a593Smuzhiyun ���ڲ���:
111*4882a593Smuzhiyun ���ú���:
112*4882a593Smuzhiyun ***************************************************************************/
113*4882a593Smuzhiyun extern	void    FlashTimingCfg(unsigned int AHBnKHz);
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun /***************************************************************************
116*4882a593Smuzhiyun ��������:ϵͳ��д������
117*4882a593Smuzhiyun ��ڲ���:
118*4882a593Smuzhiyun ���ڲ���:
119*4882a593Smuzhiyun ���ú���:
120*4882a593Smuzhiyun ***************************************************************************/
121*4882a593Smuzhiyun extern void FtlFlashSysProtSetOn(void);
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun /***************************************************************************
124*4882a593Smuzhiyun ��������:ϵͳ��д����
125*4882a593Smuzhiyun ��ڲ���:
126*4882a593Smuzhiyun ���ڲ���:
127*4882a593Smuzhiyun ���ú���:
128*4882a593Smuzhiyun ***************************************************************************/
129*4882a593Smuzhiyun extern void FtlFlashSysProtSetOff(void);
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun /***************************************************************************
132*4882a593Smuzhiyun ��������:����ϵͳ�̣�����ʱʹ��
133*4882a593Smuzhiyun ��ڲ���:
134*4882a593Smuzhiyun ���ڲ���:
135*4882a593Smuzhiyun ���ú���:
136*4882a593Smuzhiyun ***************************************************************************/
137*4882a593Smuzhiyun extern void FtlLowFormatSysDisk(void);
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun extern int FtlWriteImage(unsigned int Index, unsigned int nSec, void *buf);
140*4882a593Smuzhiyun /***************************************************************************
141*4882a593Smuzhiyun ��������:�����л����cache д��cache ��
142*4882a593Smuzhiyun ��ڲ���:
143*4882a593Smuzhiyun ���ڲ���:
144*4882a593Smuzhiyun ���ú���:
145*4882a593Smuzhiyun ***************************************************************************/
146*4882a593Smuzhiyun extern void	FtlCacheDelayWriteALL(void);
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun /***************************************************************************
149*4882a593Smuzhiyun ��������:���ô���д������ַ��
150*4882a593Smuzhiyun ��ڲ���:LBA��ַ��С��LBA�ĵ�ַд����
151*4882a593Smuzhiyun ���ڲ���:
152*4882a593Smuzhiyun ���ú���:
153*4882a593Smuzhiyun ***************************************************************************/
154*4882a593Smuzhiyun void FtlSetSysProtAddr(int LBA);
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun /***************************************************************************
158*4882a593Smuzhiyun ��������:��ȡFLASH��������
159*4882a593Smuzhiyun ��ڲ���:�̷�
160*4882a593Smuzhiyun ���ڲ���:����,������Ϊ��λ
161*4882a593Smuzhiyun ���ú���:
162*4882a593Smuzhiyun ***************************************************************************/
163*4882a593Smuzhiyun int FtlGetPageZoneCapacity(void);
164*4882a593Smuzhiyun 
165*4882a593Smuzhiyun /***************************************************************************
166*4882a593Smuzhiyun ��������:��������
167*4882a593Smuzhiyun ��ڲ���:Index=������, nSec=������
168*4882a593Smuzhiyun ���ڲ���:�����������ڻ�����buf��
169*4882a593Smuzhiyun ���ú���:
170*4882a593Smuzhiyun ***************************************************************************/
171*4882a593Smuzhiyun int FtlPageWrite(int Index, int nSec, void *buf);
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun /***************************************************************************
175*4882a593Smuzhiyun ��������:��������
176*4882a593Smuzhiyun ��ڲ���:Index=������, nSec=������
177*4882a593Smuzhiyun ���ڲ���:�����������ڻ�����buf��
178*4882a593Smuzhiyun ���ú���:
179*4882a593Smuzhiyun ***************************************************************************/
180*4882a593Smuzhiyun int FtlPageRead(int Index, int nSec, void *buf);
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun /***************************************************************************
184*4882a593Smuzhiyun ��������:��ȡ SN sector��Ϣ
185*4882a593Smuzhiyun ��ڲ���:pbuf
186*4882a593Smuzhiyun ���ڲ���:
187*4882a593Smuzhiyun ���ú���:
188*4882a593Smuzhiyun ע����Ϣ����Ҫ��flash �������غ���ܵ��ã�pbuf��С��Ҫ���ڵ���512 bytes��������ϢΪ512
189*4882a593Smuzhiyun           bytes��
190*4882a593Smuzhiyun ***************************************************************************/
191*4882a593Smuzhiyun char GetSNSectorInfo(char * pbuf);
192*4882a593Smuzhiyun 
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun extern int NandInit(void);
195*4882a593Smuzhiyun extern int NandRead(unsigned int Index, unsigned int nSec, void * buf) ;
196*4882a593Smuzhiyun extern int NandWriteImage(unsigned int Index, unsigned int nSec, void * buf);
197*4882a593Smuzhiyun extern int NandWrite(unsigned int Index, unsigned int nSec, void * buf) ;
198*4882a593Smuzhiyun extern int NandDeInit(void) ;
199*4882a593Smuzhiyun extern int NandForceDeInit(void);
200*4882a593Smuzhiyun extern unsigned int NandGetCapacity(void);
201*4882a593Smuzhiyun extern void NandSetSysProtAddr(unsigned int SysImageWriteEndAdd);
202*4882a593Smuzhiyun extern void FtlDelayWriteCacheEn(unsigned int en);
203*4882a593Smuzhiyun #endif
204