linux/mtd/bbm.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
5  *  NAND family Bad Block Management (BBM) header file
6  *    - Bad Block Table (BBT) implementation
11  *  Copyright © 2000-2005
18 /* The maximum number of NAND chips in an array */
24  * struct nand_bbt_descr - bad block table descriptor
26  * @pages:	the page(s) where we find the bbt, used with option BBT_ABSPAGE
27  *		when bbt is searched, then we store the found bbts pages here.
30  * @veroffs:	offset of the bbt version counter in the oob are of the page
31  * @version:	version read from the bbt page during scan
33  * @maxblocks:	maximum number of blocks to search for a bbt. This number of
36  * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than
37  *              bad) block in the stored bbt
60 /* The number of bits used per block in the bbt on the device */
68 /* The bbt is at the given page, else we must scan for the bbt */
70 /* bbt is stored per chip on multichip devices */
72 /* bbt has a version counter at offset veroffs */
74 /* Create a bbt if none exists */
77  * Create an empty BBT with no vendor information. Vendor's information may be
78  * unavailable, for example, if the NAND controller has a different data and OOB
83 /* Write bbt if neccecary */
85 /* Read and write back block contents when writing bbt */
87 /* Search good / bad pattern on the first and the second page */
89 /* Search good / bad pattern on the last page of the eraseblock */
92  * Use a flash based bad block table. By default, OOB identifier is saved in
97  * Do not store flash based bad block table marker in the OOB area; store it
98  * in-band.
114 /* The maximum number of blocks to scan for a bbt */
132  * struct bbm_info - [GENERIC] Bad Block Table data structure
133  * @bbt_erase_shift:	[INTERN] number of address bits in a bbt entry
136  * @bbt:		[INTERN] bad block table pointer
147 	uint8_t *bbt;  member
151 	/* TODO Add more NAND specific fileds */
157 /* OneNAND BBT interface */