Merge branch 'agust@denx.de' of git://git.denx.de/u-boot-staging
[kernel/u-boot.git] / include / dataflash.h
1 /*
2  * (C) Copyright 2003
3  * Data Flash Atmel Description File
4  * Author : Hamid Ikdoumi (Atmel)
5  *
6  * See file CREDITS for list of people who contributed to this
7  * project.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation; either version 2 of
12  * the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
22  * MA 02111-1307 USA
23  */
24
25 /* File Name            : dataflash.h                                   */
26 /* Object               : Data Flash Atmel Description File             */
27 /* Translator           :                                               */
28 /*                                                                      */
29 /* 1.0 03/04/01 HI      : Creation                                      */
30 /* 1.2 20/10/02 FB      : Adapatation Service and Lib v3                */
31 /*----------------------------------------------------------------------*/
32
33 #ifndef _DataFlash_h
34 #define _DataFlash_h
35
36
37 #include "config.h"
38
39 /*number of protected area*/
40 #define NB_DATAFLASH_AREA               5
41
42 #ifdef CONFIG_SYS_NO_FLASH
43
44 /*-----------------------------------------------------------------------
45  * return codes from flash_write():
46  */
47 # define ERR_OK                         0
48 # define ERR_TIMOUT                     1
49 # define ERR_NOT_ERASED                 2
50 # define ERR_PROTECTED                  4
51 # define ERR_INVAL                      8
52 # define ERR_ALIGN                      16
53 # define ERR_UNKNOWN_FLASH_VENDOR       32
54 # define ERR_UNKNOWN_FLASH_TYPE         64
55 # define ERR_PROG_ERROR                 128
56
57 /*-----------------------------------------------------------------------
58  * Protection Flags for flash_protect():
59  */
60 # define FLAG_PROTECT_SET               0x01
61 # define FLAG_PROTECT_CLEAR             0x02
62 # define FLAG_PROTECT_INVALID           0x03
63
64 /*-----------------------------------------------------------------------
65  * Set Environment according to label:
66  */
67 # define        FLAG_SETENV             0x80
68 #endif /* CONFIG_SYS_NO_FLASH */
69
70 /*define the area structure*/
71 typedef struct {
72         unsigned long start;
73         unsigned long end;
74         unsigned char protected;
75         unsigned char setenv;
76         unsigned char label[20];
77 } dataflash_protect_t;
78
79 typedef unsigned int AT91S_DataFlashStatus;
80
81 /*----------------------------------------------------------------------*/
82 /* DataFlash Structures                                                 */
83 /*----------------------------------------------------------------------*/
84
85 /*---------------------------------------------*/
86 /* DataFlash Descriptor Structure Definition   */
87 /*---------------------------------------------*/
88 typedef struct _AT91S_DataflashDesc {
89         unsigned char *tx_cmd_pt;
90         unsigned int tx_cmd_size;
91         unsigned char *rx_cmd_pt;
92         unsigned int rx_cmd_size;
93         unsigned char *tx_data_pt;
94         unsigned int tx_data_size;
95         unsigned char *rx_data_pt;
96         unsigned int rx_data_size;
97         volatile unsigned char state;
98         volatile unsigned char DataFlash_state;
99         unsigned char command[8];
100 } AT91S_DataflashDesc, *AT91PS_DataflashDesc;
101
102 /*---------------------------------------------*/
103 /* DataFlash device definition structure       */
104 /*---------------------------------------------*/
105 typedef struct _AT91S_Dataflash {
106         int pages_number;                       /* dataflash page number */
107         int pages_size;                         /* dataflash page size */
108         int page_offset;                        /* page offset in command */
109         int byte_mask;                          /* byte mask in command */
110         int cs;
111         dataflash_protect_t area_list[NB_DATAFLASH_AREA]; /* area protection status */
112 } AT91S_DataflashFeatures, *AT91PS_DataflashFeatures;
113
114 /*---------------------------------------------*/
115 /* DataFlash Structure Definition              */
116 /*---------------------------------------------*/
117 typedef struct _AT91S_DataFlash {
118         AT91PS_DataflashDesc pDataFlashDesc;    /* dataflash descriptor */
119         AT91PS_DataflashFeatures pDevice;       /* Pointer on a dataflash features array */
120 } AT91S_DataFlash, *AT91PS_DataFlash;
121
122
123 typedef struct _AT91S_DATAFLASH_INFO {
124
125         AT91S_DataflashDesc Desc;
126         AT91S_DataflashFeatures Device; /* Pointer on a dataflash features array */
127         unsigned long logical_address;
128         unsigned long end_address;
129         unsigned int id;                        /* device id */
130 } AT91S_DATAFLASH_INFO, *AT91PS_DATAFLASH_INFO;
131
132 struct dataflash_addr {
133         unsigned long addr;
134         int cs;
135 };
136 /*-------------------------------------------------------------------------------------------------*/
137 #define AT45DB161       0x2c
138 #define AT45DB021       0x14
139 #define AT45DB081       0x24
140 #define AT45DB321       0x34
141 #define AT45DB642       0x3c
142 #define AT45DB128       0x10
143 #define PAGES_PER_BLOCK 8
144
145 #define AT91C_DATAFLASH_TIMEOUT         10000   /* For AT91F_DataFlashWaitReady */
146
147 /* DataFlash return value */
148 #define DATAFLASH_BUSY                  0x00
149 #define DATAFLASH_OK                    0x01
150 #define DATAFLASH_ERROR                 0x02
151 #define DATAFLASH_MEMORY_OVERFLOW       0x03
152 #define DATAFLASH_BAD_COMMAND           0x04
153 #define DATAFLASH_BAD_ADDRESS           0x05
154
155
156 /* Driver State */
157 #define IDLE            0x0
158 #define BUSY            0x1
159 #define ERROR           0x2
160
161 /* DataFlash Driver State */
162 #define GET_STATUS      0x0F
163
164 /*-------------------------------------------------------------------------------------------------*/
165 /* Command Definition                                                                              */
166 /*-------------------------------------------------------------------------------------------------*/
167
168 /* READ COMMANDS */
169 #define DB_CONTINUOUS_ARRAY_READ        0xE8    /* Continuous array read */
170 #define DB_BURST_ARRAY_READ             0xE8    /* Burst array read */
171 #define DB_PAGE_READ                    0xD2    /* Main memory page read */
172 #define DB_BUF1_READ                    0xD4    /* Buffer 1 read */
173 #define DB_BUF2_READ                    0xD6    /* Buffer 2 read */
174 #define DB_STATUS                       0xD7    /* Status Register */
175
176 /* PROGRAM and ERASE COMMANDS */
177 #define DB_BUF1_WRITE                   0x84    /* Buffer 1 write */
178 #define DB_BUF2_WRITE                   0x87    /* Buffer 2 write */
179 #define DB_BUF1_PAGE_ERASE_PGM          0x83    /* Buffer 1 to main memory page program with built-In erase */
180 #define DB_BUF1_PAGE_ERASE_FASTPGM      0x93    /* Buffer 1 to main memory page program with built-In erase, Fast program */
181 #define DB_BUF2_PAGE_ERASE_PGM          0x86    /* Buffer 2 to main memory page program with built-In erase */
182 #define DB_BUF2_PAGE_ERASE_FASTPGM      0x96    /* Buffer 1 to main memory page program with built-In erase, Fast program */
183 #define DB_BUF1_PAGE_PGM                0x88    /* Buffer 1 to main memory page program without built-In erase */
184 #define DB_BUF1_PAGE_FASTPGM            0x98    /* Buffer 1 to main memory page program without built-In erase, Fast program */
185 #define DB_BUF2_PAGE_PGM                0x89    /* Buffer 2 to main memory page program without built-In erase */
186 #define DB_BUF2_PAGE_FASTPGM            0x99    /* Buffer 1 to main memory page program without built-In erase, Fast program */
187 #define DB_PAGE_ERASE                   0x81    /* Page Erase */
188 #define DB_BLOCK_ERASE                  0x50    /* Block Erase */
189 #define DB_PAGE_PGM_BUF1                0x82    /* Main memory page through buffer 1 */
190 #define DB_PAGE_FASTPGM_BUF1            0x92    /* Main memory page through buffer 1, Fast program */
191 #define DB_PAGE_PGM_BUF2                0x85    /* Main memory page through buffer 2 */
192 #define DB_PAGE_FastPGM_BUF2            0x95    /* Main memory page through buffer 2, Fast program */
193
194 /* ADDITIONAL COMMANDS */
195 #define DB_PAGE_2_BUF1_TRF              0x53    /* Main memory page to buffer 1 transfert */
196 #define DB_PAGE_2_BUF2_TRF              0x55    /* Main memory page to buffer 2 transfert */
197 #define DB_PAGE_2_BUF1_CMP              0x60    /* Main memory page to buffer 1 compare */
198 #define DB_PAGE_2_BUF2_CMP              0x61    /* Main memory page to buffer 2 compare */
199 #define DB_AUTO_PAGE_PGM_BUF1           0x58    /* Auto page rewrite throught buffer 1 */
200 #define DB_AUTO_PAGE_PGM_BUF2           0x59    /* Auto page rewrite throught buffer 2 */
201
202 /*-------------------------------------------------------------------------------------------------*/
203
204 extern int size_dataflash (AT91PS_DataFlash pdataFlash, unsigned long addr, unsigned long size);
205 extern int prot_dataflash (AT91PS_DataFlash pdataFlash, unsigned long addr);
206 extern int addr2ram(ulong addr);
207 extern int dataflash_real_protect (int flag, unsigned long start_addr, unsigned long end_addr);
208 extern int addr_dataflash (unsigned long addr);
209 extern int read_dataflash (unsigned long addr, unsigned long size, char *result);
210 extern int write_dataflash(unsigned long addr_dest, unsigned long addr_src,
211                         unsigned long size);
212 extern int AT91F_DataflashInit(void);
213
214 extern void dataflash_print_info (void);
215 extern void dataflash_perror (int err);
216 extern void AT91F_DataflashSetEnv (void);
217
218 extern struct dataflash_addr cs[CONFIG_SYS_MAX_DATAFLASH_BANKS];
219 extern dataflash_protect_t area_list[NB_DATAFLASH_AREA];
220 extern AT91S_DATAFLASH_INFO dataflash_info[];
221 #endif