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