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