Merge branch 'master' of git://git.denx.de/u-boot-nand-flash
[karo-tx-uboot.git] / include / nand.h
1 /*
2  * (C) Copyright 2005
3  * 2N Telekomunikace, a.s. <www.2n.cz>
4  * Ladislav Michl <michl@2n.cz>
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
11  * version 2 as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23
24 #ifndef _NAND_H_
25 #define _NAND_H_
26
27 #include <config.h>
28
29 /*
30  * All boards using a given driver must convert to self-init
31  * at the same time, so do it here.  When all drivers are
32  * converted, this will go away.
33  */
34 #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)\
35         || defined(CONFIG_NAND_FSL_IFC)
36 #define CONFIG_SYS_NAND_SELF_INIT
37 #endif
38
39 extern void nand_init(void);
40
41 #include <linux/compat.h>
42 #include <linux/mtd/mtd.h>
43 #include <linux/mtd/nand.h>
44
45 #ifdef CONFIG_SYS_NAND_SELF_INIT
46 void board_nand_init(void);
47 int nand_register(int devnum);
48 #else
49 extern int board_nand_init(struct nand_chip *nand);
50 #endif
51
52 typedef struct mtd_info nand_info_t;
53
54 extern int nand_curr_device;
55 extern nand_info_t nand_info[];
56
57 static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
58 {
59         return mtd_read(info, ofs, *len, (size_t *)len, buf);
60 }
61
62 static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
63 {
64         return mtd_write(info, ofs, *len, (size_t *)len, buf);
65 }
66
67 static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
68 {
69         return mtd_block_isbad(info, ofs);
70 }
71
72 static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
73 {
74         struct erase_info instr;
75
76         instr.mtd = info;
77         instr.addr = off;
78         instr.len = size;
79         instr.callback = 0;
80
81         return mtd_erase(info, &instr);
82 }
83
84
85 /*****************************************************************************
86  * declarations from nand_util.c
87  ****************************************************************************/
88
89 struct nand_write_options {
90         u_char *buffer;         /* memory block containing image to write */
91         ulong length;           /* number of bytes to write */
92         ulong offset;           /* start address in NAND */
93         int quiet;              /* don't display progress messages */
94         int autoplace;          /* if true use auto oob layout */
95         int forcejffs2;         /* force jffs2 oob layout */
96         int forceyaffs;         /* force yaffs oob layout */
97         int noecc;              /* write without ecc */
98         int writeoob;           /* image contains oob data */
99         int pad;                /* pad to page size */
100         int blockalign;         /* 1|2|4 set multiple of eraseblocks
101                                  * to align to */
102 };
103
104 typedef struct nand_write_options nand_write_options_t;
105 typedef struct mtd_oob_ops mtd_oob_ops_t;
106
107 struct nand_read_options {
108         u_char *buffer;         /* memory block in which read image is written*/
109         ulong length;           /* number of bytes to read */
110         ulong offset;           /* start address in NAND */
111         int quiet;              /* don't display progress messages */
112         int readoob;            /* put oob data in image */
113 };
114
115 typedef struct nand_read_options nand_read_options_t;
116
117 struct nand_erase_options {
118         loff_t length;          /* number of bytes to erase */
119         loff_t offset;          /* first address in NAND to erase */
120         int quiet;              /* don't display progress messages */
121         int jffs2;              /* if true: format for jffs2 usage
122                                  * (write appropriate cleanmarker blocks) */
123         int scrub;              /* if true, really clean NAND by erasing
124                                  * bad blocks (UNSAFE) */
125
126         /* Don't include skipped bad blocks in size to be erased */
127         int spread;
128         /* maximum size that actual may be in order to not exceed the buf */
129         loff_t lim;
130 };
131
132 typedef struct nand_erase_options nand_erase_options_t;
133
134 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
135                        size_t *actual, loff_t lim, u_char *buffer);
136
137 #define WITH_YAFFS_OOB  (1 << 0) /* whether write with yaffs format. This flag
138                                   * is a 'mode' meaning it cannot be mixed with
139                                   * other flags */
140 #define WITH_DROP_FFS   (1 << 1) /* drop trailing all-0xff pages */
141
142 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
143                         size_t *actual, loff_t lim, u_char *buffer, int flags);
144 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
145 int nand_torture(nand_info_t *nand, loff_t offset);
146
147 #define NAND_LOCK_STATUS_TIGHT  0x01
148 #define NAND_LOCK_STATUS_UNLOCK 0x04
149
150 int nand_lock(nand_info_t *meminfo, int tight);
151 int nand_unlock(nand_info_t *meminfo, loff_t start, size_t length,
152         int allexcept);
153 int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
154
155 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
156 void nand_deselect(void);
157
158 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
159 void board_nand_select_device(struct nand_chip *nand, int chip);
160 #endif
161
162 __attribute__((noreturn)) void nand_boot(void);
163
164 #endif
165
166 #ifdef CONFIG_ENV_OFFSET_OOB
167 #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
168                                     as block number*/
169 #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
170                                         stored as byte number */
171 #define ENV_OFFSET_SIZE 8
172 int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
173 #endif