Merge branch 'master' of git://git.denx.de/u-boot-arm
[platform/kernel/u-boot.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 extern void nand_init(void);
28
29 #include <linux/mtd/compat.h>
30 #include <linux/mtd/mtd.h>
31 #include <linux/mtd/nand.h>
32
33 extern int board_nand_init(struct nand_chip *nand);
34
35 typedef struct mtd_info nand_info_t;
36
37 extern int nand_curr_device;
38 extern nand_info_t nand_info[];
39
40 static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
41 {
42         return info->read(info, ofs, *len, (size_t *)len, buf);
43 }
44
45 static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
46 {
47         return info->write(info, ofs, *len, (size_t *)len, buf);
48 }
49
50 static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
51 {
52         return info->block_isbad(info, ofs);
53 }
54
55 static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
56 {
57         struct erase_info instr;
58
59         instr.mtd = info;
60         instr.addr = off;
61         instr.len = size;
62         instr.callback = 0;
63
64         return info->erase(info, &instr);
65 }
66
67
68 /*****************************************************************************
69  * declarations from nand_util.c
70  ****************************************************************************/
71
72 struct nand_write_options {
73         u_char *buffer;         /* memory block containing image to write */
74         ulong length;           /* number of bytes to write */
75         ulong offset;           /* start address in NAND */
76         int quiet;              /* don't display progress messages */
77         int autoplace;          /* if true use auto oob layout */
78         int forcejffs2;         /* force jffs2 oob layout */
79         int forceyaffs;         /* force yaffs oob layout */
80         int noecc;              /* write without ecc */
81         int writeoob;           /* image contains oob data */
82         int pad;                /* pad to page size */
83         int blockalign;         /* 1|2|4 set multiple of eraseblocks
84                                  * to align to */
85 };
86
87 typedef struct nand_write_options nand_write_options_t;
88 typedef struct mtd_oob_ops mtd_oob_ops_t;
89
90 struct nand_read_options {
91         u_char *buffer;         /* memory block in which read image is written*/
92         ulong length;           /* number of bytes to read */
93         ulong offset;           /* start address in NAND */
94         int quiet;              /* don't display progress messages */
95         int readoob;            /* put oob data in image */
96 };
97
98 typedef struct nand_read_options nand_read_options_t;
99
100 struct nand_erase_options {
101         ulong length;           /* number of bytes to erase */
102         ulong offset;           /* first address in NAND to erase */
103         int quiet;              /* don't display progress messages */
104         int jffs2;              /* if true: format for jffs2 usage
105                                  * (write appropriate cleanmarker blocks) */
106         int scrub;              /* if true, really clean NAND by erasing
107                                  * bad blocks (UNSAFE) */
108 };
109
110 typedef struct nand_erase_options nand_erase_options_t;
111
112 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
113                        u_char *buffer);
114 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
115                         u_char *buffer);
116 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
117
118 #define NAND_LOCK_STATUS_TIGHT  0x01
119 #define NAND_LOCK_STATUS_LOCK   0x02
120 #define NAND_LOCK_STATUS_UNLOCK 0x04
121
122 int nand_lock( nand_info_t *meminfo, int tight );
123 int nand_unlock( nand_info_t *meminfo, ulong start, ulong length );
124 int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
125
126 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
127 void board_nand_select_device(struct nand_chip *nand, int chip);
128 #endif
129
130 __attribute__((noreturn)) void nand_boot(void);
131
132 #endif