bbm.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * linux/include/linux/mtd/bbm.h
  4. *
  5. * NAND family Bad Block Management (BBM) header file
  6. * - Bad Block Table (BBT) implementation
  7. *
  8. * Copyright © 2005 Samsung Electronics
  9. * Kyungmin Park <kyungmin.park@samsung.com>
  10. *
  11. * Copyright © 2000-2005
  12. * Thomas Gleixner <tglx@linuxtronix.de>
  13. *
  14. */
  15. #ifndef __LINUX_MTD_BBM_H
  16. #define __LINUX_MTD_BBM_H
  17. /* The maximum number of NAND chips in an array */
  18. #ifndef CONFIG_SYS_NAND_MAX_CHIPS
  19. #define CONFIG_SYS_NAND_MAX_CHIPS 1
  20. #endif
  21. /**
  22. * struct nand_bbt_descr - bad block table descriptor
  23. * @options: options for this descriptor
  24. * @pages: the page(s) where we find the bbt, used with option BBT_ABSPAGE
  25. * when bbt is searched, then we store the found bbts pages here.
  26. * Its an array and supports up to 8 chips now
  27. * @offs: offset of the pattern in the oob area of the page
  28. * @veroffs: offset of the bbt version counter in the oob are of the page
  29. * @version: version read from the bbt page during scan
  30. * @len: length of the pattern, if 0 no pattern check is performed
  31. * @maxblocks: maximum number of blocks to search for a bbt. This number of
  32. * blocks is reserved at the end of the device where the tables are
  33. * written.
  34. * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than
  35. * bad) block in the stored bbt
  36. * @pattern: pattern to identify bad block table or factory marked good /
  37. * bad blocks, can be NULL, if len = 0
  38. *
  39. * Descriptor for the bad block table marker and the descriptor for the
  40. * pattern which identifies good and bad blocks. The assumption is made
  41. * that the pattern and the version count are always located in the oob area
  42. * of the first block.
  43. */
  44. struct nand_bbt_descr {
  45. int options;
  46. int pages[CONFIG_SYS_NAND_MAX_CHIPS];
  47. int offs;
  48. int veroffs;
  49. uint8_t version[CONFIG_SYS_NAND_MAX_CHIPS];
  50. int len;
  51. int maxblocks;
  52. int reserved_block_code;
  53. uint8_t *pattern;
  54. };
  55. /* Options for the bad block table descriptors */
  56. /* The number of bits used per block in the bbt on the device */
  57. #define NAND_BBT_NRBITS_MSK 0x0000000F
  58. #define NAND_BBT_1BIT 0x00000001
  59. #define NAND_BBT_2BIT 0x00000002
  60. #define NAND_BBT_4BIT 0x00000004
  61. #define NAND_BBT_8BIT 0x00000008
  62. /* The bad block table is in the last good block of the device */
  63. #define NAND_BBT_LASTBLOCK 0x00000010
  64. /* The bbt is at the given page, else we must scan for the bbt */
  65. #define NAND_BBT_ABSPAGE 0x00000020
  66. /* bbt is stored per chip on multichip devices */
  67. #define NAND_BBT_PERCHIP 0x00000080
  68. /* bbt has a version counter at offset veroffs */
  69. #define NAND_BBT_VERSION 0x00000100
  70. /* Create a bbt if none exists */
  71. #define NAND_BBT_CREATE 0x00000200
  72. /*
  73. * Create an empty BBT with no vendor information. Vendor's information may be
  74. * unavailable, for example, if the NAND controller has a different data and OOB
  75. * layout or if this information is already purged. Must be used in conjunction
  76. * with NAND_BBT_CREATE.
  77. */
  78. #define NAND_BBT_CREATE_EMPTY 0x00000400
  79. /* Write bbt if neccecary */
  80. #define NAND_BBT_WRITE 0x00002000
  81. /* Read and write back block contents when writing bbt */
  82. #define NAND_BBT_SAVECONTENT 0x00004000
  83. /* Search good / bad pattern on the first and the second page */
  84. #define NAND_BBT_SCAN2NDPAGE 0x00008000
  85. /* Search good / bad pattern on the last page of the eraseblock */
  86. #define NAND_BBT_SCANLASTPAGE 0x00010000
  87. /*
  88. * Use a flash based bad block table. By default, OOB identifier is saved in
  89. * OOB area. This option is passed to the default bad block table function.
  90. */
  91. #define NAND_BBT_USE_FLASH 0x00020000
  92. /*
  93. * Do not store flash based bad block table marker in the OOB area; store it
  94. * in-band.
  95. */
  96. #define NAND_BBT_NO_OOB 0x00040000
  97. /*
  98. * Do not write new bad block markers to OOB; useful, e.g., when ECC covers
  99. * entire spare area. Must be used with NAND_BBT_USE_FLASH.
  100. */
  101. #define NAND_BBT_NO_OOB_BBM 0x00080000
  102. /*
  103. * Flag set by nand_create_default_bbt_descr(), marking that the nand_bbt_descr
  104. * was allocated dynamicaly and must be freed in nand_release(). Has no meaning
  105. * in nand_chip.bbt_options.
  106. */
  107. #define NAND_BBT_DYNAMICSTRUCT 0x80000000
  108. /* The maximum number of blocks to scan for a bbt */
  109. #define NAND_BBT_SCAN_MAXBLOCKS 4
  110. /*
  111. * Constants for oob configuration
  112. */
  113. #define NAND_SMALL_BADBLOCK_POS 5
  114. #define NAND_LARGE_BADBLOCK_POS 0
  115. #define ONENAND_BADBLOCK_POS 0
  116. /*
  117. * Bad block scanning errors
  118. */
  119. #define ONENAND_BBT_READ_ERROR 1
  120. #define ONENAND_BBT_READ_ECC_ERROR 2
  121. #define ONENAND_BBT_READ_FATAL_ERROR 4
  122. /**
  123. * struct bbm_info - [GENERIC] Bad Block Table data structure
  124. * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry
  125. * @badblockpos: [INTERN] position of the bad block marker in the oob area
  126. * @options: options for this descriptor
  127. * @bbt: [INTERN] bad block table pointer
  128. * @isbad_bbt: function to determine if a block is bad
  129. * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for
  130. * initial bad block scan
  131. * @priv: [OPTIONAL] pointer to private bbm date
  132. */
  133. struct bbm_info {
  134. int bbt_erase_shift;
  135. int badblockpos;
  136. int options;
  137. uint8_t *bbt;
  138. int (*isbad_bbt)(struct mtd_info *mtd, loff_t ofs, int allowbbt);
  139. /* TODO Add more NAND specific fileds */
  140. struct nand_bbt_descr *badblock_pattern;
  141. void *priv;
  142. };
  143. /* OneNAND BBT interface */
  144. extern int onenand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
  145. extern int onenand_default_bbt(struct mtd_info *mtd);
  146. #endif /* __LINUX_MTD_BBM_H */