1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * (C) Copyright 2005
4 * 2N Telekomunikace, a.s. <www.2n.cz>
5 * Ladislav Michl <michl@2n.cz>
6 */
7
8 #ifndef _NAND_H_
9 #define _NAND_H_
10
11 #include <config.h>
12
13 /*
14 * All boards using a given driver must convert to self-init
15 * at the same time, so do it here. When all drivers are
16 * converted, this will go away.
17 */
18 #ifdef CONFIG_SPL_BUILD
19 #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_FSL_IFC)
20 #define CONFIG_SYS_NAND_SELF_INIT
21 #endif
22 #else
23 #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)\
24 || defined(CONFIG_NAND_FSL_IFC)
25 #define CONFIG_SYS_NAND_SELF_INIT
26 #endif
27 #endif
28
29 extern void nand_init(void);
30 unsigned long nand_size(void);
31
32 #include <linux/compat.h>
33 #include <linux/mtd/mtd.h>
34 #include <linux/mtd/rawnand.h>
35
36 int nand_mtd_to_devnum(struct mtd_info *mtd);
37
38 #ifdef CONFIG_SYS_NAND_SELF_INIT
39 void board_nand_init(void);
40 int nand_register(int devnum, struct mtd_info *mtd);
41 #else
42 extern int board_nand_init(struct nand_chip *nand);
43 #endif
44
45 extern int nand_curr_device;
46 extern struct mtd_info *nand_info[];
47
48 extern unsigned int ecc0_flag;
49 extern unsigned int oobsize_real;
50
nand_read(struct mtd_info * info,loff_t ofs,size_t * len,u_char * buf)51 static inline int nand_read(struct mtd_info *info, loff_t ofs, size_t *len,
52 u_char *buf)
53 {
54 return mtd_read(info, ofs, *len, (size_t *)len, buf);
55 }
56
nand_write(struct mtd_info * info,loff_t ofs,size_t * len,u_char * buf)57 static inline int nand_write(struct mtd_info *info, loff_t ofs, size_t *len,
58 u_char *buf)
59 {
60 return mtd_write(info, ofs, *len, (size_t *)len, buf);
61 }
62
nand_block_isbad(struct mtd_info * info,loff_t ofs)63 static inline int nand_block_isbad(struct mtd_info *info, loff_t ofs)
64 {
65 return mtd_block_isbad(info, ofs);
66 }
67
nand_erase(struct mtd_info * info,loff_t off,size_t size)68 static inline int nand_erase(struct mtd_info *info, loff_t off, size_t size)
69 {
70 struct erase_info instr;
71
72 instr.mtd = info;
73 instr.addr = off;
74 instr.len = size;
75 instr.callback = 0;
76
77 return mtd_erase(info, &instr);
78 }
79
80
81 /*****************************************************************************
82 * declarations from nand_util.c
83 ****************************************************************************/
84
85 typedef struct mtd_oob_ops mtd_oob_ops_t;
86
87 struct nand_erase_options {
88 loff_t length; /* number of bytes to erase */
89 loff_t offset; /* first address in NAND to erase */
90 int quiet; /* don't display progress messages */
91 int jffs2; /* if true: format for jffs2 usage
92 * (write appropriate cleanmarker blocks) */
93 int scrub; /* if true, really clean NAND by erasing
94 * bad blocks (UNSAFE) */
95
96 /* Don't include skipped bad blocks in size to be erased */
97 int spread;
98 /* maximum size that actual may be in order to not exceed the buf */
99 loff_t lim;
100 };
101
102 typedef struct nand_erase_options nand_erase_options_t;
103
104 void nand_fill_ecc(struct nand_chip *chip, uint8_t *oob, size_t len);
105
106 int nand_read_yaffs_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
107 u_char *buffer);
108 int nand_write_yaffs_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
109 u_char *buffer);
110
111 int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
112 size_t *actual, loff_t lim, u_char *buffer);
113
114 #define WITH_DROP_FFS (1 << 0) /* drop trailing all-0xff pages */
115 #define WITH_WR_VERIFY (1 << 1) /* verify data was written correctly */
116
117 int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
118 size_t *actual, loff_t lim, u_char *buffer, int flags);
119 int nand_erase_opts(struct mtd_info *mtd,
120 const nand_erase_options_t *opts);
121 int nand_torture(struct mtd_info *mtd, loff_t offset);
122 int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
123 loff_t ofs);
124 int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf);
125
126 #define NAND_LOCK_STATUS_TIGHT 0x01
127 #define NAND_LOCK_STATUS_UNLOCK 0x04
128
129 int nand_lock(struct mtd_info *mtd, int tight);
130 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
131 int allexcept);
132 int nand_get_lock_status(struct mtd_info *mtd, loff_t offset);
133
134 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
135 int nand_spl_read_block(int block, int offset, int len, void *dst);
136 void nand_deselect(void);
137
138 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
139 void board_nand_select_device(struct nand_chip *nand, int chip);
140 #endif
141
142 __attribute__((noreturn)) void nand_boot(void);
143
144 #ifdef CONFIG_ENV_OFFSET_OOB
145 #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
146 as block number*/
147 #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
148 stored as byte number */
149 #define ENV_OFFSET_SIZE 8
150 int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result);
151 #endif
152 int spl_nand_erase_one(int block, int page);
153
154 /* platform specific init functions */
155 void sunxi_nand_init(void);
156
157 /*
158 * get_nand_dev_by_index - Get the nand info based in index.
159 *
160 * @dev - index to the nand device.
161 *
162 * returns pointer to the nand device info structure or NULL on failure.
163 */
164 struct mtd_info *get_nand_dev_by_index(int dev);
165
166 #endif /* _NAND_H_ */
167