1b95db8d3SBoris Brezillon /* SPDX-License-Identifier: GPL-2.0 */
2b95db8d3SBoris Brezillon /*
3b95db8d3SBoris Brezillon * Copyright 2017 - Free Electrons
4b95db8d3SBoris Brezillon *
5b95db8d3SBoris Brezillon * Authors:
6b95db8d3SBoris Brezillon * Boris Brezillon <boris.brezillon@free-electrons.com>
7b95db8d3SBoris Brezillon * Peter Pan <peterpandong@micron.com>
8b95db8d3SBoris Brezillon */
9b95db8d3SBoris Brezillon
10b95db8d3SBoris Brezillon #ifndef __LINUX_MTD_NAND_H
11b95db8d3SBoris Brezillon #define __LINUX_MTD_NAND_H
12b95db8d3SBoris Brezillon
13b95db8d3SBoris Brezillon #include <linux/mtd/mtd.h>
14b95db8d3SBoris Brezillon
15b95db8d3SBoris Brezillon /**
16b95db8d3SBoris Brezillon * struct nand_memory_organization - Memory organization structure
17b95db8d3SBoris Brezillon * @bits_per_cell: number of bits per NAND cell
18b95db8d3SBoris Brezillon * @pagesize: page size
19b95db8d3SBoris Brezillon * @oobsize: OOB area size
20b95db8d3SBoris Brezillon * @pages_per_eraseblock: number of pages per eraseblock
21b95db8d3SBoris Brezillon * @eraseblocks_per_lun: number of eraseblocks per LUN (Logical Unit Number)
22b95db8d3SBoris Brezillon * @planes_per_lun: number of planes per LUN
23b95db8d3SBoris Brezillon * @luns_per_target: number of LUN per target (target is a synonym for die)
24b95db8d3SBoris Brezillon * @ntargets: total number of targets exposed by the NAND device
25b95db8d3SBoris Brezillon */
26b95db8d3SBoris Brezillon struct nand_memory_organization {
27b95db8d3SBoris Brezillon unsigned int bits_per_cell;
28b95db8d3SBoris Brezillon unsigned int pagesize;
29b95db8d3SBoris Brezillon unsigned int oobsize;
30b95db8d3SBoris Brezillon unsigned int pages_per_eraseblock;
31b95db8d3SBoris Brezillon unsigned int eraseblocks_per_lun;
32b95db8d3SBoris Brezillon unsigned int planes_per_lun;
33b95db8d3SBoris Brezillon unsigned int luns_per_target;
34b95db8d3SBoris Brezillon unsigned int ntargets;
35b95db8d3SBoris Brezillon };
36b95db8d3SBoris Brezillon
37b95db8d3SBoris Brezillon #define NAND_MEMORG(bpc, ps, os, ppe, epl, ppl, lpt, nt) \
38b95db8d3SBoris Brezillon { \
39b95db8d3SBoris Brezillon .bits_per_cell = (bpc), \
40b95db8d3SBoris Brezillon .pagesize = (ps), \
41b95db8d3SBoris Brezillon .oobsize = (os), \
42b95db8d3SBoris Brezillon .pages_per_eraseblock = (ppe), \
43b95db8d3SBoris Brezillon .eraseblocks_per_lun = (epl), \
44b95db8d3SBoris Brezillon .planes_per_lun = (ppl), \
45b95db8d3SBoris Brezillon .luns_per_target = (lpt), \
46b95db8d3SBoris Brezillon .ntargets = (nt), \
47b95db8d3SBoris Brezillon }
48b95db8d3SBoris Brezillon
49b95db8d3SBoris Brezillon /**
50b95db8d3SBoris Brezillon * struct nand_row_converter - Information needed to convert an absolute offset
51b95db8d3SBoris Brezillon * into a row address
52b95db8d3SBoris Brezillon * @lun_addr_shift: position of the LUN identifier in the row address
53b95db8d3SBoris Brezillon * @eraseblock_addr_shift: position of the eraseblock identifier in the row
54b95db8d3SBoris Brezillon * address
55b95db8d3SBoris Brezillon */
56b95db8d3SBoris Brezillon struct nand_row_converter {
57b95db8d3SBoris Brezillon unsigned int lun_addr_shift;
58b95db8d3SBoris Brezillon unsigned int eraseblock_addr_shift;
59b95db8d3SBoris Brezillon };
60b95db8d3SBoris Brezillon
61b95db8d3SBoris Brezillon /**
62b95db8d3SBoris Brezillon * struct nand_pos - NAND position object
63b95db8d3SBoris Brezillon * @target: the NAND target/die
64b95db8d3SBoris Brezillon * @lun: the LUN identifier
65b95db8d3SBoris Brezillon * @plane: the plane within the LUN
66b95db8d3SBoris Brezillon * @eraseblock: the eraseblock within the LUN
67b95db8d3SBoris Brezillon * @page: the page within the LUN
68b95db8d3SBoris Brezillon *
69b95db8d3SBoris Brezillon * These information are usually used by specific sub-layers to select the
70b95db8d3SBoris Brezillon * appropriate target/die and generate a row address to pass to the device.
71b95db8d3SBoris Brezillon */
72b95db8d3SBoris Brezillon struct nand_pos {
73b95db8d3SBoris Brezillon unsigned int target;
74b95db8d3SBoris Brezillon unsigned int lun;
75b95db8d3SBoris Brezillon unsigned int plane;
76b95db8d3SBoris Brezillon unsigned int eraseblock;
77b95db8d3SBoris Brezillon unsigned int page;
78b95db8d3SBoris Brezillon };
79b95db8d3SBoris Brezillon
80b95db8d3SBoris Brezillon /**
81b95db8d3SBoris Brezillon * struct nand_page_io_req - NAND I/O request object
82b95db8d3SBoris Brezillon * @pos: the position this I/O request is targeting
83b95db8d3SBoris Brezillon * @dataoffs: the offset within the page
84b95db8d3SBoris Brezillon * @datalen: number of data bytes to read from/write to this page
85b95db8d3SBoris Brezillon * @databuf: buffer to store data in or get data from
86b95db8d3SBoris Brezillon * @ooboffs: the OOB offset within the page
87b95db8d3SBoris Brezillon * @ooblen: the number of OOB bytes to read from/write to this page
88b95db8d3SBoris Brezillon * @oobbuf: buffer to store OOB data in or get OOB data from
89*f8678728SBoris Brezillon * @mode: one of the %MTD_OPS_XXX mode
90b95db8d3SBoris Brezillon *
91b95db8d3SBoris Brezillon * This object is used to pass per-page I/O requests to NAND sub-layers. This
92b95db8d3SBoris Brezillon * way all useful information are already formatted in a useful way and
93b95db8d3SBoris Brezillon * specific NAND layers can focus on translating these information into
94b95db8d3SBoris Brezillon * specific commands/operations.
95b95db8d3SBoris Brezillon */
96b95db8d3SBoris Brezillon struct nand_page_io_req {
97b95db8d3SBoris Brezillon struct nand_pos pos;
98b95db8d3SBoris Brezillon unsigned int dataoffs;
99b95db8d3SBoris Brezillon unsigned int datalen;
100b95db8d3SBoris Brezillon union {
101b95db8d3SBoris Brezillon const void *out;
102b95db8d3SBoris Brezillon void *in;
103b95db8d3SBoris Brezillon } databuf;
104b95db8d3SBoris Brezillon unsigned int ooboffs;
105b95db8d3SBoris Brezillon unsigned int ooblen;
106b95db8d3SBoris Brezillon union {
107b95db8d3SBoris Brezillon const void *out;
108b95db8d3SBoris Brezillon void *in;
109b95db8d3SBoris Brezillon } oobbuf;
110*f8678728SBoris Brezillon int mode;
111b95db8d3SBoris Brezillon };
112b95db8d3SBoris Brezillon
113b95db8d3SBoris Brezillon /**
114b95db8d3SBoris Brezillon * struct nand_ecc_req - NAND ECC requirements
115b95db8d3SBoris Brezillon * @strength: ECC strength
116b95db8d3SBoris Brezillon * @step_size: ECC step/block size
117b95db8d3SBoris Brezillon */
118b95db8d3SBoris Brezillon struct nand_ecc_req {
119b95db8d3SBoris Brezillon unsigned int strength;
120b95db8d3SBoris Brezillon unsigned int step_size;
121b95db8d3SBoris Brezillon };
122b95db8d3SBoris Brezillon
123b95db8d3SBoris Brezillon #define NAND_ECCREQ(str, stp) { .strength = (str), .step_size = (stp) }
124b95db8d3SBoris Brezillon
125b95db8d3SBoris Brezillon /**
126b95db8d3SBoris Brezillon * struct nand_bbt - bad block table object
127b95db8d3SBoris Brezillon * @cache: in memory BBT cache
128b95db8d3SBoris Brezillon */
129b95db8d3SBoris Brezillon struct nand_bbt {
130b95db8d3SBoris Brezillon unsigned long *cache;
131b95db8d3SBoris Brezillon };
132b95db8d3SBoris Brezillon
133b95db8d3SBoris Brezillon struct nand_device;
134b95db8d3SBoris Brezillon
135b95db8d3SBoris Brezillon /**
136b95db8d3SBoris Brezillon * struct nand_ops - NAND operations
137b95db8d3SBoris Brezillon * @erase: erase a specific block. No need to check if the block is bad before
138b95db8d3SBoris Brezillon * erasing, this has been taken care of by the generic NAND layer
139b95db8d3SBoris Brezillon * @markbad: mark a specific block bad. No need to check if the block is
140b95db8d3SBoris Brezillon * already marked bad, this has been taken care of by the generic
141b95db8d3SBoris Brezillon * NAND layer. This method should just write the BBM (Bad Block
142b95db8d3SBoris Brezillon * Marker) so that future call to struct_nand_ops->isbad() return
143b95db8d3SBoris Brezillon * true
144b95db8d3SBoris Brezillon * @isbad: check whether a block is bad or not. This method should just read
145b95db8d3SBoris Brezillon * the BBM and return whether the block is bad or not based on what it
146b95db8d3SBoris Brezillon * reads
147b95db8d3SBoris Brezillon *
148b95db8d3SBoris Brezillon * These are all low level operations that should be implemented by specialized
149b95db8d3SBoris Brezillon * NAND layers (SPI NAND, raw NAND, ...).
150b95db8d3SBoris Brezillon */
151b95db8d3SBoris Brezillon struct nand_ops {
152b95db8d3SBoris Brezillon int (*erase)(struct nand_device *nand, const struct nand_pos *pos);
153b95db8d3SBoris Brezillon int (*markbad)(struct nand_device *nand, const struct nand_pos *pos);
154b95db8d3SBoris Brezillon bool (*isbad)(struct nand_device *nand, const struct nand_pos *pos);
155b95db8d3SBoris Brezillon };
156b95db8d3SBoris Brezillon
157b95db8d3SBoris Brezillon /**
158b95db8d3SBoris Brezillon * struct nand_device - NAND device
159b95db8d3SBoris Brezillon * @mtd: MTD instance attached to the NAND device
160b95db8d3SBoris Brezillon * @memorg: memory layout
161b95db8d3SBoris Brezillon * @eccreq: ECC requirements
162b95db8d3SBoris Brezillon * @rowconv: position to row address converter
163b95db8d3SBoris Brezillon * @bbt: bad block table info
164b95db8d3SBoris Brezillon * @ops: NAND operations attached to the NAND device
165b95db8d3SBoris Brezillon *
166b95db8d3SBoris Brezillon * Generic NAND object. Specialized NAND layers (raw NAND, SPI NAND, OneNAND)
167b95db8d3SBoris Brezillon * should declare their own NAND object embedding a nand_device struct (that's
168b95db8d3SBoris Brezillon * how inheritance is done).
169b95db8d3SBoris Brezillon * struct_nand_device->memorg and struct_nand_device->eccreq should be filled
170b95db8d3SBoris Brezillon * at device detection time to reflect the NAND device
171b95db8d3SBoris Brezillon * capabilities/requirements. Once this is done nanddev_init() can be called.
172b95db8d3SBoris Brezillon * It will take care of converting NAND information into MTD ones, which means
173b95db8d3SBoris Brezillon * the specialized NAND layers should never manually tweak
174b95db8d3SBoris Brezillon * struct_nand_device->mtd except for the ->_read/write() hooks.
175b95db8d3SBoris Brezillon */
176b95db8d3SBoris Brezillon struct nand_device {
177b95db8d3SBoris Brezillon struct mtd_info *mtd;
178b95db8d3SBoris Brezillon struct nand_memory_organization memorg;
179b95db8d3SBoris Brezillon struct nand_ecc_req eccreq;
180b95db8d3SBoris Brezillon struct nand_row_converter rowconv;
181b95db8d3SBoris Brezillon struct nand_bbt bbt;
182b95db8d3SBoris Brezillon const struct nand_ops *ops;
183b95db8d3SBoris Brezillon };
184b95db8d3SBoris Brezillon
185b95db8d3SBoris Brezillon /**
186b95db8d3SBoris Brezillon * struct nand_io_iter - NAND I/O iterator
187b95db8d3SBoris Brezillon * @req: current I/O request
188b95db8d3SBoris Brezillon * @oobbytes_per_page: maximum number of OOB bytes per page
189b95db8d3SBoris Brezillon * @dataleft: remaining number of data bytes to read/write
190b95db8d3SBoris Brezillon * @oobleft: remaining number of OOB bytes to read/write
191b95db8d3SBoris Brezillon *
192b95db8d3SBoris Brezillon * Can be used by specialized NAND layers to iterate over all pages covered
193b95db8d3SBoris Brezillon * by an MTD I/O request, which should greatly simplifies the boiler-plate
194b95db8d3SBoris Brezillon * code needed to read/write data from/to a NAND device.
195b95db8d3SBoris Brezillon */
196b95db8d3SBoris Brezillon struct nand_io_iter {
197b95db8d3SBoris Brezillon struct nand_page_io_req req;
198b95db8d3SBoris Brezillon unsigned int oobbytes_per_page;
199b95db8d3SBoris Brezillon unsigned int dataleft;
200b95db8d3SBoris Brezillon unsigned int oobleft;
201b95db8d3SBoris Brezillon };
202b95db8d3SBoris Brezillon
203b95db8d3SBoris Brezillon /**
204b95db8d3SBoris Brezillon * mtd_to_nanddev() - Get the NAND device attached to the MTD instance
205b95db8d3SBoris Brezillon * @mtd: MTD instance
206b95db8d3SBoris Brezillon *
207b95db8d3SBoris Brezillon * Return: the NAND device embedding @mtd.
208b95db8d3SBoris Brezillon */
mtd_to_nanddev(struct mtd_info * mtd)209b95db8d3SBoris Brezillon static inline struct nand_device *mtd_to_nanddev(struct mtd_info *mtd)
210b95db8d3SBoris Brezillon {
211b95db8d3SBoris Brezillon return mtd->priv;
212b95db8d3SBoris Brezillon }
213b95db8d3SBoris Brezillon
214b95db8d3SBoris Brezillon /**
215b95db8d3SBoris Brezillon * nanddev_to_mtd() - Get the MTD device attached to a NAND device
216b95db8d3SBoris Brezillon * @nand: NAND device
217b95db8d3SBoris Brezillon *
218b95db8d3SBoris Brezillon * Return: the MTD device embedded in @nand.
219b95db8d3SBoris Brezillon */
nanddev_to_mtd(struct nand_device * nand)220b95db8d3SBoris Brezillon static inline struct mtd_info *nanddev_to_mtd(struct nand_device *nand)
221b95db8d3SBoris Brezillon {
222b95db8d3SBoris Brezillon return nand->mtd;
223b95db8d3SBoris Brezillon }
224b95db8d3SBoris Brezillon
225b95db8d3SBoris Brezillon /*
226b95db8d3SBoris Brezillon * nanddev_bits_per_cell() - Get the number of bits per cell
227b95db8d3SBoris Brezillon * @nand: NAND device
228b95db8d3SBoris Brezillon *
229b95db8d3SBoris Brezillon * Return: the number of bits per cell.
230b95db8d3SBoris Brezillon */
nanddev_bits_per_cell(const struct nand_device * nand)231b95db8d3SBoris Brezillon static inline unsigned int nanddev_bits_per_cell(const struct nand_device *nand)
232b95db8d3SBoris Brezillon {
233b95db8d3SBoris Brezillon return nand->memorg.bits_per_cell;
234b95db8d3SBoris Brezillon }
235b95db8d3SBoris Brezillon
236b95db8d3SBoris Brezillon /**
237b95db8d3SBoris Brezillon * nanddev_page_size() - Get NAND page size
238b95db8d3SBoris Brezillon * @nand: NAND device
239b95db8d3SBoris Brezillon *
240b95db8d3SBoris Brezillon * Return: the page size.
241b95db8d3SBoris Brezillon */
nanddev_page_size(const struct nand_device * nand)242b95db8d3SBoris Brezillon static inline size_t nanddev_page_size(const struct nand_device *nand)
243b95db8d3SBoris Brezillon {
244b95db8d3SBoris Brezillon return nand->memorg.pagesize;
245b95db8d3SBoris Brezillon }
246b95db8d3SBoris Brezillon
247b95db8d3SBoris Brezillon /**
248b95db8d3SBoris Brezillon * nanddev_per_page_oobsize() - Get NAND OOB size
249b95db8d3SBoris Brezillon * @nand: NAND device
250b95db8d3SBoris Brezillon *
251b95db8d3SBoris Brezillon * Return: the OOB size.
252b95db8d3SBoris Brezillon */
253b95db8d3SBoris Brezillon static inline unsigned int
nanddev_per_page_oobsize(const struct nand_device * nand)254b95db8d3SBoris Brezillon nanddev_per_page_oobsize(const struct nand_device *nand)
255b95db8d3SBoris Brezillon {
256b95db8d3SBoris Brezillon return nand->memorg.oobsize;
257b95db8d3SBoris Brezillon }
258b95db8d3SBoris Brezillon
259b95db8d3SBoris Brezillon /**
260b95db8d3SBoris Brezillon * nanddev_pages_per_eraseblock() - Get the number of pages per eraseblock
261b95db8d3SBoris Brezillon * @nand: NAND device
262b95db8d3SBoris Brezillon *
263b95db8d3SBoris Brezillon * Return: the number of pages per eraseblock.
264b95db8d3SBoris Brezillon */
265b95db8d3SBoris Brezillon static inline unsigned int
nanddev_pages_per_eraseblock(const struct nand_device * nand)266b95db8d3SBoris Brezillon nanddev_pages_per_eraseblock(const struct nand_device *nand)
267b95db8d3SBoris Brezillon {
268b95db8d3SBoris Brezillon return nand->memorg.pages_per_eraseblock;
269b95db8d3SBoris Brezillon }
270b95db8d3SBoris Brezillon
271b95db8d3SBoris Brezillon /**
272b95db8d3SBoris Brezillon * nanddev_per_page_oobsize() - Get NAND erase block size
273b95db8d3SBoris Brezillon * @nand: NAND device
274b95db8d3SBoris Brezillon *
275b95db8d3SBoris Brezillon * Return: the eraseblock size.
276b95db8d3SBoris Brezillon */
nanddev_eraseblock_size(const struct nand_device * nand)277b95db8d3SBoris Brezillon static inline size_t nanddev_eraseblock_size(const struct nand_device *nand)
278b95db8d3SBoris Brezillon {
279b95db8d3SBoris Brezillon return nand->memorg.pagesize * nand->memorg.pages_per_eraseblock;
280b95db8d3SBoris Brezillon }
281b95db8d3SBoris Brezillon
282b95db8d3SBoris Brezillon /**
283b95db8d3SBoris Brezillon * nanddev_eraseblocks_per_lun() - Get the number of eraseblocks per LUN
284b95db8d3SBoris Brezillon * @nand: NAND device
285b95db8d3SBoris Brezillon *
286b95db8d3SBoris Brezillon * Return: the number of eraseblocks per LUN.
287b95db8d3SBoris Brezillon */
288b95db8d3SBoris Brezillon static inline unsigned int
nanddev_eraseblocks_per_lun(const struct nand_device * nand)289b95db8d3SBoris Brezillon nanddev_eraseblocks_per_lun(const struct nand_device *nand)
290b95db8d3SBoris Brezillon {
291b95db8d3SBoris Brezillon return nand->memorg.eraseblocks_per_lun;
292b95db8d3SBoris Brezillon }
293b95db8d3SBoris Brezillon
294b95db8d3SBoris Brezillon /**
295b95db8d3SBoris Brezillon * nanddev_target_size() - Get the total size provided by a single target/die
296b95db8d3SBoris Brezillon * @nand: NAND device
297b95db8d3SBoris Brezillon *
298b95db8d3SBoris Brezillon * Return: the total size exposed by a single target/die in bytes.
299b95db8d3SBoris Brezillon */
nanddev_target_size(const struct nand_device * nand)300b95db8d3SBoris Brezillon static inline u64 nanddev_target_size(const struct nand_device *nand)
301b95db8d3SBoris Brezillon {
302b95db8d3SBoris Brezillon return (u64)nand->memorg.luns_per_target *
303b95db8d3SBoris Brezillon nand->memorg.eraseblocks_per_lun *
304b95db8d3SBoris Brezillon nand->memorg.pages_per_eraseblock *
305b95db8d3SBoris Brezillon nand->memorg.pagesize;
306b95db8d3SBoris Brezillon }
307b95db8d3SBoris Brezillon
308b95db8d3SBoris Brezillon /**
309b95db8d3SBoris Brezillon * nanddev_ntarget() - Get the total of targets
310b95db8d3SBoris Brezillon * @nand: NAND device
311b95db8d3SBoris Brezillon *
312b95db8d3SBoris Brezillon * Return: the number of targets/dies exposed by @nand.
313b95db8d3SBoris Brezillon */
nanddev_ntargets(const struct nand_device * nand)314b95db8d3SBoris Brezillon static inline unsigned int nanddev_ntargets(const struct nand_device *nand)
315b95db8d3SBoris Brezillon {
316b95db8d3SBoris Brezillon return nand->memorg.ntargets;
317b95db8d3SBoris Brezillon }
318b95db8d3SBoris Brezillon
319b95db8d3SBoris Brezillon /**
320b95db8d3SBoris Brezillon * nanddev_neraseblocks() - Get the total number of erasablocks
321b95db8d3SBoris Brezillon * @nand: NAND device
322b95db8d3SBoris Brezillon *
323b95db8d3SBoris Brezillon * Return: the total number of eraseblocks exposed by @nand.
324b95db8d3SBoris Brezillon */
nanddev_neraseblocks(const struct nand_device * nand)325b95db8d3SBoris Brezillon static inline unsigned int nanddev_neraseblocks(const struct nand_device *nand)
326b95db8d3SBoris Brezillon {
327b95db8d3SBoris Brezillon return (u64)nand->memorg.luns_per_target *
328b95db8d3SBoris Brezillon nand->memorg.eraseblocks_per_lun *
329b95db8d3SBoris Brezillon nand->memorg.pages_per_eraseblock;
330b95db8d3SBoris Brezillon }
331b95db8d3SBoris Brezillon
332b95db8d3SBoris Brezillon /**
333b95db8d3SBoris Brezillon * nanddev_size() - Get NAND size
334b95db8d3SBoris Brezillon * @nand: NAND device
335b95db8d3SBoris Brezillon *
336b95db8d3SBoris Brezillon * Return: the total size (in bytes) exposed by @nand.
337b95db8d3SBoris Brezillon */
nanddev_size(const struct nand_device * nand)338b95db8d3SBoris Brezillon static inline u64 nanddev_size(const struct nand_device *nand)
339b95db8d3SBoris Brezillon {
340b95db8d3SBoris Brezillon return nanddev_target_size(nand) * nanddev_ntargets(nand);
341b95db8d3SBoris Brezillon }
342b95db8d3SBoris Brezillon
343b95db8d3SBoris Brezillon /**
344b95db8d3SBoris Brezillon * nanddev_get_memorg() - Extract memory organization info from a NAND device
345b95db8d3SBoris Brezillon * @nand: NAND device
346b95db8d3SBoris Brezillon *
347b95db8d3SBoris Brezillon * This can be used by the upper layer to fill the memorg info before calling
348b95db8d3SBoris Brezillon * nanddev_init().
349b95db8d3SBoris Brezillon *
350b95db8d3SBoris Brezillon * Return: the memorg object embedded in the NAND device.
351b95db8d3SBoris Brezillon */
352b95db8d3SBoris Brezillon static inline struct nand_memory_organization *
nanddev_get_memorg(struct nand_device * nand)353b95db8d3SBoris Brezillon nanddev_get_memorg(struct nand_device *nand)
354b95db8d3SBoris Brezillon {
355b95db8d3SBoris Brezillon return &nand->memorg;
356b95db8d3SBoris Brezillon }
357b95db8d3SBoris Brezillon
358b95db8d3SBoris Brezillon int nanddev_init(struct nand_device *nand, const struct nand_ops *ops,
359b95db8d3SBoris Brezillon struct module *owner);
360b95db8d3SBoris Brezillon void nanddev_cleanup(struct nand_device *nand);
361b95db8d3SBoris Brezillon
362b95db8d3SBoris Brezillon /**
363b95db8d3SBoris Brezillon * nanddev_register() - Register a NAND device
364b95db8d3SBoris Brezillon * @nand: NAND device
365b95db8d3SBoris Brezillon *
366b95db8d3SBoris Brezillon * Register a NAND device.
367b95db8d3SBoris Brezillon * This function is just a wrapper around mtd_device_register()
368b95db8d3SBoris Brezillon * registering the MTD device embedded in @nand.
369b95db8d3SBoris Brezillon *
370b95db8d3SBoris Brezillon * Return: 0 in case of success, a negative error code otherwise.
371b95db8d3SBoris Brezillon */
nanddev_register(struct nand_device * nand)372b95db8d3SBoris Brezillon static inline int nanddev_register(struct nand_device *nand)
373b95db8d3SBoris Brezillon {
374b95db8d3SBoris Brezillon return mtd_device_register(nand->mtd, NULL, 0);
375b95db8d3SBoris Brezillon }
376b95db8d3SBoris Brezillon
377b95db8d3SBoris Brezillon /**
378b95db8d3SBoris Brezillon * nanddev_unregister() - Unregister a NAND device
379b95db8d3SBoris Brezillon * @nand: NAND device
380b95db8d3SBoris Brezillon *
381b95db8d3SBoris Brezillon * Unregister a NAND device.
382b95db8d3SBoris Brezillon * This function is just a wrapper around mtd_device_unregister()
383b95db8d3SBoris Brezillon * unregistering the MTD device embedded in @nand.
384b95db8d3SBoris Brezillon *
385b95db8d3SBoris Brezillon * Return: 0 in case of success, a negative error code otherwise.
386b95db8d3SBoris Brezillon */
nanddev_unregister(struct nand_device * nand)387b95db8d3SBoris Brezillon static inline int nanddev_unregister(struct nand_device *nand)
388b95db8d3SBoris Brezillon {
389b95db8d3SBoris Brezillon return mtd_device_unregister(nand->mtd);
390b95db8d3SBoris Brezillon }
391b95db8d3SBoris Brezillon
392b95db8d3SBoris Brezillon /**
393b95db8d3SBoris Brezillon * nanddev_set_of_node() - Attach a DT node to a NAND device
394b95db8d3SBoris Brezillon * @nand: NAND device
395b95db8d3SBoris Brezillon * @np: DT node
396b95db8d3SBoris Brezillon *
397b95db8d3SBoris Brezillon * Attach a DT node to a NAND device.
398b95db8d3SBoris Brezillon */
nanddev_set_of_node(struct nand_device * nand,const struct device_node * np)399b95db8d3SBoris Brezillon static inline void nanddev_set_of_node(struct nand_device *nand,
400b95db8d3SBoris Brezillon const struct device_node *np)
401b95db8d3SBoris Brezillon {
402b95db8d3SBoris Brezillon mtd_set_of_node(nand->mtd, np);
403b95db8d3SBoris Brezillon }
404b95db8d3SBoris Brezillon
405b95db8d3SBoris Brezillon /**
406b95db8d3SBoris Brezillon * nanddev_get_of_node() - Retrieve the DT node attached to a NAND device
407b95db8d3SBoris Brezillon * @nand: NAND device
408b95db8d3SBoris Brezillon *
409b95db8d3SBoris Brezillon * Return: the DT node attached to @nand.
410b95db8d3SBoris Brezillon */
nanddev_get_of_node(struct nand_device * nand)411b95db8d3SBoris Brezillon static inline const struct device_node *nanddev_get_of_node(struct nand_device *nand)
412b95db8d3SBoris Brezillon {
413b95db8d3SBoris Brezillon return mtd_get_of_node(nand->mtd);
414b95db8d3SBoris Brezillon }
415b95db8d3SBoris Brezillon
416b95db8d3SBoris Brezillon /**
417b95db8d3SBoris Brezillon * nanddev_offs_to_pos() - Convert an absolute NAND offset into a NAND position
418b95db8d3SBoris Brezillon * @nand: NAND device
419b95db8d3SBoris Brezillon * @offs: absolute NAND offset (usually passed by the MTD layer)
420b95db8d3SBoris Brezillon * @pos: a NAND position object to fill in
421b95db8d3SBoris Brezillon *
422b95db8d3SBoris Brezillon * Converts @offs into a nand_pos representation.
423b95db8d3SBoris Brezillon *
424b95db8d3SBoris Brezillon * Return: the offset within the NAND page pointed by @pos.
425b95db8d3SBoris Brezillon */
nanddev_offs_to_pos(struct nand_device * nand,loff_t offs,struct nand_pos * pos)426b95db8d3SBoris Brezillon static inline unsigned int nanddev_offs_to_pos(struct nand_device *nand,
427b95db8d3SBoris Brezillon loff_t offs,
428b95db8d3SBoris Brezillon struct nand_pos *pos)
429b95db8d3SBoris Brezillon {
430b95db8d3SBoris Brezillon unsigned int pageoffs;
431b95db8d3SBoris Brezillon u64 tmp = offs;
432b95db8d3SBoris Brezillon
433b95db8d3SBoris Brezillon pageoffs = do_div(tmp, nand->memorg.pagesize);
434b95db8d3SBoris Brezillon pos->page = do_div(tmp, nand->memorg.pages_per_eraseblock);
435b95db8d3SBoris Brezillon pos->eraseblock = do_div(tmp, nand->memorg.eraseblocks_per_lun);
436b95db8d3SBoris Brezillon pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;
437b95db8d3SBoris Brezillon pos->lun = do_div(tmp, nand->memorg.luns_per_target);
438b95db8d3SBoris Brezillon pos->target = tmp;
439b95db8d3SBoris Brezillon
440b95db8d3SBoris Brezillon return pageoffs;
441b95db8d3SBoris Brezillon }
442b95db8d3SBoris Brezillon
443b95db8d3SBoris Brezillon /**
444b95db8d3SBoris Brezillon * nanddev_pos_cmp() - Compare two NAND positions
445b95db8d3SBoris Brezillon * @a: First NAND position
446b95db8d3SBoris Brezillon * @b: Second NAND position
447b95db8d3SBoris Brezillon *
448b95db8d3SBoris Brezillon * Compares two NAND positions.
449b95db8d3SBoris Brezillon *
450b95db8d3SBoris Brezillon * Return: -1 if @a < @b, 0 if @a == @b and 1 if @a > @b.
451b95db8d3SBoris Brezillon */
nanddev_pos_cmp(const struct nand_pos * a,const struct nand_pos * b)452b95db8d3SBoris Brezillon static inline int nanddev_pos_cmp(const struct nand_pos *a,
453b95db8d3SBoris Brezillon const struct nand_pos *b)
454b95db8d3SBoris Brezillon {
455b95db8d3SBoris Brezillon if (a->target != b->target)
456b95db8d3SBoris Brezillon return a->target < b->target ? -1 : 1;
457b95db8d3SBoris Brezillon
458b95db8d3SBoris Brezillon if (a->lun != b->lun)
459b95db8d3SBoris Brezillon return a->lun < b->lun ? -1 : 1;
460b95db8d3SBoris Brezillon
461b95db8d3SBoris Brezillon if (a->eraseblock != b->eraseblock)
462b95db8d3SBoris Brezillon return a->eraseblock < b->eraseblock ? -1 : 1;
463b95db8d3SBoris Brezillon
464b95db8d3SBoris Brezillon if (a->page != b->page)
465b95db8d3SBoris Brezillon return a->page < b->page ? -1 : 1;
466b95db8d3SBoris Brezillon
467b95db8d3SBoris Brezillon return 0;
468b95db8d3SBoris Brezillon }
469b95db8d3SBoris Brezillon
470b95db8d3SBoris Brezillon /**
471b95db8d3SBoris Brezillon * nanddev_pos_to_offs() - Convert a NAND position into an absolute offset
472b95db8d3SBoris Brezillon * @nand: NAND device
473b95db8d3SBoris Brezillon * @pos: the NAND position to convert
474b95db8d3SBoris Brezillon *
475b95db8d3SBoris Brezillon * Converts @pos NAND position into an absolute offset.
476b95db8d3SBoris Brezillon *
477b95db8d3SBoris Brezillon * Return: the absolute offset. Note that @pos points to the beginning of a
478b95db8d3SBoris Brezillon * page, if one wants to point to a specific offset within this page
479b95db8d3SBoris Brezillon * the returned offset has to be adjusted manually.
480b95db8d3SBoris Brezillon */
nanddev_pos_to_offs(struct nand_device * nand,const struct nand_pos * pos)481b95db8d3SBoris Brezillon static inline loff_t nanddev_pos_to_offs(struct nand_device *nand,
482b95db8d3SBoris Brezillon const struct nand_pos *pos)
483b95db8d3SBoris Brezillon {
484b95db8d3SBoris Brezillon unsigned int npages;
485b95db8d3SBoris Brezillon
486b95db8d3SBoris Brezillon npages = pos->page +
487b95db8d3SBoris Brezillon ((pos->eraseblock +
488b95db8d3SBoris Brezillon (pos->lun +
489b95db8d3SBoris Brezillon (pos->target * nand->memorg.luns_per_target)) *
490b95db8d3SBoris Brezillon nand->memorg.eraseblocks_per_lun) *
491b95db8d3SBoris Brezillon nand->memorg.pages_per_eraseblock);
492b95db8d3SBoris Brezillon
493b95db8d3SBoris Brezillon return (loff_t)npages * nand->memorg.pagesize;
494b95db8d3SBoris Brezillon }
495b95db8d3SBoris Brezillon
496b95db8d3SBoris Brezillon /**
497b95db8d3SBoris Brezillon * nanddev_pos_to_row() - Extract a row address from a NAND position
498b95db8d3SBoris Brezillon * @nand: NAND device
499b95db8d3SBoris Brezillon * @pos: the position to convert
500b95db8d3SBoris Brezillon *
501b95db8d3SBoris Brezillon * Converts a NAND position into a row address that can then be passed to the
502b95db8d3SBoris Brezillon * device.
503b95db8d3SBoris Brezillon *
504b95db8d3SBoris Brezillon * Return: the row address extracted from @pos.
505b95db8d3SBoris Brezillon */
nanddev_pos_to_row(struct nand_device * nand,const struct nand_pos * pos)506b95db8d3SBoris Brezillon static inline unsigned int nanddev_pos_to_row(struct nand_device *nand,
507b95db8d3SBoris Brezillon const struct nand_pos *pos)
508b95db8d3SBoris Brezillon {
509b95db8d3SBoris Brezillon return (pos->lun << nand->rowconv.lun_addr_shift) |
510b95db8d3SBoris Brezillon (pos->eraseblock << nand->rowconv.eraseblock_addr_shift) |
511b95db8d3SBoris Brezillon pos->page;
512b95db8d3SBoris Brezillon }
513b95db8d3SBoris Brezillon
514b95db8d3SBoris Brezillon /**
515b95db8d3SBoris Brezillon * nanddev_pos_next_target() - Move a position to the next target/die
516b95db8d3SBoris Brezillon * @nand: NAND device
517b95db8d3SBoris Brezillon * @pos: the position to update
518b95db8d3SBoris Brezillon *
519b95db8d3SBoris Brezillon * Updates @pos to point to the start of the next target/die. Useful when you
520b95db8d3SBoris Brezillon * want to iterate over all targets/dies of a NAND device.
521b95db8d3SBoris Brezillon */
nanddev_pos_next_target(struct nand_device * nand,struct nand_pos * pos)522b95db8d3SBoris Brezillon static inline void nanddev_pos_next_target(struct nand_device *nand,
523b95db8d3SBoris Brezillon struct nand_pos *pos)
524b95db8d3SBoris Brezillon {
525b95db8d3SBoris Brezillon pos->page = 0;
526b95db8d3SBoris Brezillon pos->plane = 0;
527b95db8d3SBoris Brezillon pos->eraseblock = 0;
528b95db8d3SBoris Brezillon pos->lun = 0;
529b95db8d3SBoris Brezillon pos->target++;
530b95db8d3SBoris Brezillon }
531b95db8d3SBoris Brezillon
532b95db8d3SBoris Brezillon /**
533b95db8d3SBoris Brezillon * nanddev_pos_next_lun() - Move a position to the next LUN
534b95db8d3SBoris Brezillon * @nand: NAND device
535b95db8d3SBoris Brezillon * @pos: the position to update
536b95db8d3SBoris Brezillon *
537b95db8d3SBoris Brezillon * Updates @pos to point to the start of the next LUN. Useful when you want to
538b95db8d3SBoris Brezillon * iterate over all LUNs of a NAND device.
539b95db8d3SBoris Brezillon */
nanddev_pos_next_lun(struct nand_device * nand,struct nand_pos * pos)540b95db8d3SBoris Brezillon static inline void nanddev_pos_next_lun(struct nand_device *nand,
541b95db8d3SBoris Brezillon struct nand_pos *pos)
542b95db8d3SBoris Brezillon {
543b95db8d3SBoris Brezillon if (pos->lun >= nand->memorg.luns_per_target - 1)
544b95db8d3SBoris Brezillon return nanddev_pos_next_target(nand, pos);
545b95db8d3SBoris Brezillon
546b95db8d3SBoris Brezillon pos->lun++;
547b95db8d3SBoris Brezillon pos->page = 0;
548b95db8d3SBoris Brezillon pos->plane = 0;
549b95db8d3SBoris Brezillon pos->eraseblock = 0;
550b95db8d3SBoris Brezillon }
551b95db8d3SBoris Brezillon
552b95db8d3SBoris Brezillon /**
553b95db8d3SBoris Brezillon * nanddev_pos_next_eraseblock() - Move a position to the next eraseblock
554b95db8d3SBoris Brezillon * @nand: NAND device
555b95db8d3SBoris Brezillon * @pos: the position to update
556b95db8d3SBoris Brezillon *
557b95db8d3SBoris Brezillon * Updates @pos to point to the start of the next eraseblock. Useful when you
558b95db8d3SBoris Brezillon * want to iterate over all eraseblocks of a NAND device.
559b95db8d3SBoris Brezillon */
nanddev_pos_next_eraseblock(struct nand_device * nand,struct nand_pos * pos)560b95db8d3SBoris Brezillon static inline void nanddev_pos_next_eraseblock(struct nand_device *nand,
561b95db8d3SBoris Brezillon struct nand_pos *pos)
562b95db8d3SBoris Brezillon {
563b95db8d3SBoris Brezillon if (pos->eraseblock >= nand->memorg.eraseblocks_per_lun - 1)
564b95db8d3SBoris Brezillon return nanddev_pos_next_lun(nand, pos);
565b95db8d3SBoris Brezillon
566b95db8d3SBoris Brezillon pos->eraseblock++;
567b95db8d3SBoris Brezillon pos->page = 0;
568b95db8d3SBoris Brezillon pos->plane = pos->eraseblock % nand->memorg.planes_per_lun;
569b95db8d3SBoris Brezillon }
570b95db8d3SBoris Brezillon
571b95db8d3SBoris Brezillon /**
572b95db8d3SBoris Brezillon * nanddev_pos_next_eraseblock() - Move a position to the next page
573b95db8d3SBoris Brezillon * @nand: NAND device
574b95db8d3SBoris Brezillon * @pos: the position to update
575b95db8d3SBoris Brezillon *
576b95db8d3SBoris Brezillon * Updates @pos to point to the start of the next page. Useful when you want to
577b95db8d3SBoris Brezillon * iterate over all pages of a NAND device.
578b95db8d3SBoris Brezillon */
nanddev_pos_next_page(struct nand_device * nand,struct nand_pos * pos)579b95db8d3SBoris Brezillon static inline void nanddev_pos_next_page(struct nand_device *nand,
580b95db8d3SBoris Brezillon struct nand_pos *pos)
581b95db8d3SBoris Brezillon {
582b95db8d3SBoris Brezillon if (pos->page >= nand->memorg.pages_per_eraseblock - 1)
583b95db8d3SBoris Brezillon return nanddev_pos_next_eraseblock(nand, pos);
584b95db8d3SBoris Brezillon
585b95db8d3SBoris Brezillon pos->page++;
586b95db8d3SBoris Brezillon }
587b95db8d3SBoris Brezillon
588b95db8d3SBoris Brezillon /**
589b95db8d3SBoris Brezillon * nand_io_iter_init - Initialize a NAND I/O iterator
590b95db8d3SBoris Brezillon * @nand: NAND device
591b95db8d3SBoris Brezillon * @offs: absolute offset
592b95db8d3SBoris Brezillon * @req: MTD request
593b95db8d3SBoris Brezillon * @iter: NAND I/O iterator
594b95db8d3SBoris Brezillon *
595b95db8d3SBoris Brezillon * Initializes a NAND iterator based on the information passed by the MTD
596b95db8d3SBoris Brezillon * layer.
597b95db8d3SBoris Brezillon */
nanddev_io_iter_init(struct nand_device * nand,loff_t offs,struct mtd_oob_ops * req,struct nand_io_iter * iter)598b95db8d3SBoris Brezillon static inline void nanddev_io_iter_init(struct nand_device *nand,
599b95db8d3SBoris Brezillon loff_t offs, struct mtd_oob_ops *req,
600b95db8d3SBoris Brezillon struct nand_io_iter *iter)
601b95db8d3SBoris Brezillon {
602b95db8d3SBoris Brezillon struct mtd_info *mtd = nanddev_to_mtd(nand);
603b95db8d3SBoris Brezillon
604*f8678728SBoris Brezillon iter->req.mode = req->mode;
605b95db8d3SBoris Brezillon iter->req.dataoffs = nanddev_offs_to_pos(nand, offs, &iter->req.pos);
606b95db8d3SBoris Brezillon iter->req.ooboffs = req->ooboffs;
607b95db8d3SBoris Brezillon iter->oobbytes_per_page = mtd_oobavail(mtd, req);
608b95db8d3SBoris Brezillon iter->dataleft = req->len;
609b95db8d3SBoris Brezillon iter->oobleft = req->ooblen;
610b95db8d3SBoris Brezillon iter->req.databuf.in = req->datbuf;
611b95db8d3SBoris Brezillon iter->req.datalen = min_t(unsigned int,
612b95db8d3SBoris Brezillon nand->memorg.pagesize - iter->req.dataoffs,
613b95db8d3SBoris Brezillon iter->dataleft);
614b95db8d3SBoris Brezillon iter->req.oobbuf.in = req->oobbuf;
615b95db8d3SBoris Brezillon iter->req.ooblen = min_t(unsigned int,
616b95db8d3SBoris Brezillon iter->oobbytes_per_page - iter->req.ooboffs,
617b95db8d3SBoris Brezillon iter->oobleft);
618b95db8d3SBoris Brezillon }
619b95db8d3SBoris Brezillon
620b95db8d3SBoris Brezillon /**
621b95db8d3SBoris Brezillon * nand_io_iter_next_page - Move to the next page
622b95db8d3SBoris Brezillon * @nand: NAND device
623b95db8d3SBoris Brezillon * @iter: NAND I/O iterator
624b95db8d3SBoris Brezillon *
625b95db8d3SBoris Brezillon * Updates the @iter to point to the next page.
626b95db8d3SBoris Brezillon */
nanddev_io_iter_next_page(struct nand_device * nand,struct nand_io_iter * iter)627b95db8d3SBoris Brezillon static inline void nanddev_io_iter_next_page(struct nand_device *nand,
628b95db8d3SBoris Brezillon struct nand_io_iter *iter)
629b95db8d3SBoris Brezillon {
630b95db8d3SBoris Brezillon nanddev_pos_next_page(nand, &iter->req.pos);
631b95db8d3SBoris Brezillon iter->dataleft -= iter->req.datalen;
632b95db8d3SBoris Brezillon iter->req.databuf.in += iter->req.datalen;
633b95db8d3SBoris Brezillon iter->oobleft -= iter->req.ooblen;
634b95db8d3SBoris Brezillon iter->req.oobbuf.in += iter->req.ooblen;
635b95db8d3SBoris Brezillon iter->req.dataoffs = 0;
636b95db8d3SBoris Brezillon iter->req.ooboffs = 0;
637b95db8d3SBoris Brezillon iter->req.datalen = min_t(unsigned int, nand->memorg.pagesize,
638b95db8d3SBoris Brezillon iter->dataleft);
639b95db8d3SBoris Brezillon iter->req.ooblen = min_t(unsigned int, iter->oobbytes_per_page,
640b95db8d3SBoris Brezillon iter->oobleft);
641b95db8d3SBoris Brezillon }
642b95db8d3SBoris Brezillon
643b95db8d3SBoris Brezillon /**
644b95db8d3SBoris Brezillon * nand_io_iter_end - Should end iteration or not
645b95db8d3SBoris Brezillon * @nand: NAND device
646b95db8d3SBoris Brezillon * @iter: NAND I/O iterator
647b95db8d3SBoris Brezillon *
648b95db8d3SBoris Brezillon * Check whether @iter has reached the end of the NAND portion it was asked to
649b95db8d3SBoris Brezillon * iterate on or not.
650b95db8d3SBoris Brezillon *
651b95db8d3SBoris Brezillon * Return: true if @iter has reached the end of the iteration request, false
652b95db8d3SBoris Brezillon * otherwise.
653b95db8d3SBoris Brezillon */
nanddev_io_iter_end(struct nand_device * nand,const struct nand_io_iter * iter)654b95db8d3SBoris Brezillon static inline bool nanddev_io_iter_end(struct nand_device *nand,
655b95db8d3SBoris Brezillon const struct nand_io_iter *iter)
656b95db8d3SBoris Brezillon {
657b95db8d3SBoris Brezillon if (iter->dataleft || iter->oobleft)
658b95db8d3SBoris Brezillon return false;
659b95db8d3SBoris Brezillon
660b95db8d3SBoris Brezillon return true;
661b95db8d3SBoris Brezillon }
662b95db8d3SBoris Brezillon
663b95db8d3SBoris Brezillon /**
664b95db8d3SBoris Brezillon * nand_io_for_each_page - Iterate over all NAND pages contained in an MTD I/O
665b95db8d3SBoris Brezillon * request
666b95db8d3SBoris Brezillon * @nand: NAND device
667b95db8d3SBoris Brezillon * @start: start address to read/write from
668b95db8d3SBoris Brezillon * @req: MTD I/O request
669b95db8d3SBoris Brezillon * @iter: NAND I/O iterator
670b95db8d3SBoris Brezillon *
671b95db8d3SBoris Brezillon * Should be used for iterate over pages that are contained in an MTD request.
672b95db8d3SBoris Brezillon */
673b95db8d3SBoris Brezillon #define nanddev_io_for_each_page(nand, start, req, iter) \
674b95db8d3SBoris Brezillon for (nanddev_io_iter_init(nand, start, req, iter); \
675b95db8d3SBoris Brezillon !nanddev_io_iter_end(nand, iter); \
676b95db8d3SBoris Brezillon nanddev_io_iter_next_page(nand, iter))
677b95db8d3SBoris Brezillon
678b95db8d3SBoris Brezillon bool nanddev_isbad(struct nand_device *nand, const struct nand_pos *pos);
679b95db8d3SBoris Brezillon bool nanddev_isreserved(struct nand_device *nand, const struct nand_pos *pos);
680b95db8d3SBoris Brezillon int nanddev_erase(struct nand_device *nand, const struct nand_pos *pos);
681b95db8d3SBoris Brezillon int nanddev_markbad(struct nand_device *nand, const struct nand_pos *pos);
682b95db8d3SBoris Brezillon
683b95db8d3SBoris Brezillon /* BBT related functions */
684b95db8d3SBoris Brezillon enum nand_bbt_block_status {
685b95db8d3SBoris Brezillon NAND_BBT_BLOCK_STATUS_UNKNOWN,
686b95db8d3SBoris Brezillon NAND_BBT_BLOCK_GOOD,
687b95db8d3SBoris Brezillon NAND_BBT_BLOCK_WORN,
688b95db8d3SBoris Brezillon NAND_BBT_BLOCK_RESERVED,
689b95db8d3SBoris Brezillon NAND_BBT_BLOCK_FACTORY_BAD,
690b95db8d3SBoris Brezillon NAND_BBT_BLOCK_NUM_STATUS,
691b95db8d3SBoris Brezillon };
692b95db8d3SBoris Brezillon
693b95db8d3SBoris Brezillon int nanddev_bbt_init(struct nand_device *nand);
694b95db8d3SBoris Brezillon void nanddev_bbt_cleanup(struct nand_device *nand);
695b95db8d3SBoris Brezillon int nanddev_bbt_update(struct nand_device *nand);
696b95db8d3SBoris Brezillon int nanddev_bbt_get_block_status(const struct nand_device *nand,
697b95db8d3SBoris Brezillon unsigned int entry);
698b95db8d3SBoris Brezillon int nanddev_bbt_set_block_status(struct nand_device *nand, unsigned int entry,
699b95db8d3SBoris Brezillon enum nand_bbt_block_status status);
700b95db8d3SBoris Brezillon int nanddev_bbt_markbad(struct nand_device *nand, unsigned int block);
701b95db8d3SBoris Brezillon
702b95db8d3SBoris Brezillon /**
703b95db8d3SBoris Brezillon * nanddev_bbt_pos_to_entry() - Convert a NAND position into a BBT entry
704b95db8d3SBoris Brezillon * @nand: NAND device
705b95db8d3SBoris Brezillon * @pos: the NAND position we want to get BBT entry for
706b95db8d3SBoris Brezillon *
707b95db8d3SBoris Brezillon * Return the BBT entry used to store information about the eraseblock pointed
708b95db8d3SBoris Brezillon * by @pos.
709b95db8d3SBoris Brezillon *
710b95db8d3SBoris Brezillon * Return: the BBT entry storing information about eraseblock pointed by @pos.
711b95db8d3SBoris Brezillon */
nanddev_bbt_pos_to_entry(struct nand_device * nand,const struct nand_pos * pos)712b95db8d3SBoris Brezillon static inline unsigned int nanddev_bbt_pos_to_entry(struct nand_device *nand,
713b95db8d3SBoris Brezillon const struct nand_pos *pos)
714b95db8d3SBoris Brezillon {
715b95db8d3SBoris Brezillon return pos->eraseblock +
716b95db8d3SBoris Brezillon ((pos->lun + (pos->target * nand->memorg.luns_per_target)) *
717b95db8d3SBoris Brezillon nand->memorg.eraseblocks_per_lun);
718b95db8d3SBoris Brezillon }
719b95db8d3SBoris Brezillon
720b95db8d3SBoris Brezillon /**
721b95db8d3SBoris Brezillon * nanddev_bbt_is_initialized() - Check if the BBT has been initialized
722b95db8d3SBoris Brezillon * @nand: NAND device
723b95db8d3SBoris Brezillon *
724b95db8d3SBoris Brezillon * Return: true if the BBT has been initialized, false otherwise.
725b95db8d3SBoris Brezillon */
nanddev_bbt_is_initialized(struct nand_device * nand)726b95db8d3SBoris Brezillon static inline bool nanddev_bbt_is_initialized(struct nand_device *nand)
727b95db8d3SBoris Brezillon {
728b95db8d3SBoris Brezillon return !!nand->bbt.cache;
729b95db8d3SBoris Brezillon }
730b95db8d3SBoris Brezillon
731b95db8d3SBoris Brezillon /* MTD -> NAND helper functions. */
732b95db8d3SBoris Brezillon int nanddev_mtd_erase(struct mtd_info *mtd, struct erase_info *einfo);
733b95db8d3SBoris Brezillon
734b95db8d3SBoris Brezillon #endif /* __LINUX_MTD_NAND_H */
735