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