xref: /openbmc/u-boot/include/nand.h (revision 939e5bf9)
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 	loff_t length;		/* number of bytes to erase */
102 	loff_t 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 	/* Don't include skipped bad blocks in size to be erased */
110 	int spread;
111 };
112 
113 typedef struct nand_erase_options nand_erase_options_t;
114 
115 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
116 		       u_char *buffer);
117 
118 #define WITH_YAFFS_OOB	(1 << 0) /* whether write with yaffs format. This flag
119 				  * is a 'mode' meaning it cannot be mixed with
120 				  * other flags */
121 #define WITH_DROP_FFS	(1 << 1) /* drop trailing all-0xff pages */
122 
123 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
124 			u_char *buffer, int flags);
125 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
126 
127 #define NAND_LOCK_STATUS_TIGHT	0x01
128 #define NAND_LOCK_STATUS_LOCK	0x02
129 #define NAND_LOCK_STATUS_UNLOCK 0x04
130 
131 int nand_lock( nand_info_t *meminfo, int tight );
132 int nand_unlock( nand_info_t *meminfo, ulong start, ulong length );
133 int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
134 
135 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
136 void board_nand_select_device(struct nand_chip *nand, int chip);
137 #endif
138 
139 __attribute__((noreturn)) void nand_boot(void);
140 
141 #endif
142 
143 #ifdef CONFIG_ENV_OFFSET_OOB
144 #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
145 				    as block number*/
146 #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
147 					stored as byte number */
148 #define ENV_OFFSET_SIZE 8
149 int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
150 #endif
151