nand.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619
  1. /*
  2. * linux/include/linux/mtd/nand.h
  3. *
  4. * Copyright (c) 2000 David Woodhouse <dwmw2@infradead.org>
  5. * Steven J. Hill <sjhill@realitydiluted.com>
  6. * Thomas Gleixner <tglx@linutronix.de>
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License version 2 as
  10. * published by the Free Software Foundation.
  11. *
  12. * Info:
  13. * Contains standard defines and IDs for NAND flash devices
  14. *
  15. * Changelog:
  16. * See git changelog.
  17. */
  18. #ifndef __LINUX_MTD_NAND_H
  19. #define __LINUX_MTD_NAND_H
  20. #include <linux/wait.h>
  21. #include <linux/spinlock.h>
  22. #include <linux/mtd/mtd.h>
  23. struct mtd_info;
  24. /* Scan and identify a NAND device */
  25. extern int nand_scan (struct mtd_info *mtd, int max_chips);
  26. /* Separate phases of nand_scan(), allowing board driver to intervene
  27. * and override command or ECC setup according to flash type */
  28. extern int nand_scan_ident(struct mtd_info *mtd, int max_chips);
  29. extern int nand_scan_tail(struct mtd_info *mtd);
  30. /* Free resources held by the NAND device */
  31. extern void nand_release (struct mtd_info *mtd);
  32. /* Internal helper for board drivers which need to override command function */
  33. extern void nand_wait_ready(struct mtd_info *mtd);
  34. /* The maximum number of NAND chips in an array */
  35. #define NAND_MAX_CHIPS 8
  36. /* This constant declares the max. oobsize / page, which
  37. * is supported now. If you add a chip with bigger oobsize/page
  38. * adjust this accordingly.
  39. */
  40. #define NAND_MAX_OOBSIZE 64
  41. #define NAND_MAX_PAGESIZE 2048
  42. /*
  43. * Constants for hardware specific CLE/ALE/NCE function
  44. *
  45. * These are bits which can be or'ed to set/clear multiple
  46. * bits in one go.
  47. */
  48. /* Select the chip by setting nCE to low */
  49. #define NAND_NCE 0x01
  50. /* Select the command latch by setting CLE to high */
  51. #define NAND_CLE 0x02
  52. /* Select the address latch by setting ALE to high */
  53. #define NAND_ALE 0x04
  54. #define NAND_CTRL_CLE (NAND_NCE | NAND_CLE)
  55. #define NAND_CTRL_ALE (NAND_NCE | NAND_ALE)
  56. #define NAND_CTRL_CHANGE 0x80
  57. /*
  58. * Standard NAND flash commands
  59. */
  60. #define NAND_CMD_READ0 0
  61. #define NAND_CMD_READ1 1
  62. #define NAND_CMD_RNDOUT 5
  63. #define NAND_CMD_PAGEPROG 0x10
  64. #define NAND_CMD_READOOB 0x50
  65. #define NAND_CMD_ERASE1 0x60
  66. #define NAND_CMD_STATUS 0x70
  67. #define NAND_CMD_STATUS_MULTI 0x71
  68. #define NAND_CMD_SEQIN 0x80
  69. #define NAND_CMD_RNDIN 0x85
  70. #define NAND_CMD_READID 0x90
  71. #define NAND_CMD_ERASE2 0xd0
  72. #define NAND_CMD_RESET 0xff
  73. /* Extended commands for large page devices */
  74. #define NAND_CMD_READSTART 0x30
  75. #define NAND_CMD_RNDOUTSTART 0xE0
  76. #define NAND_CMD_CACHEDPROG 0x15
  77. /* Extended commands for AG-AND device */
  78. /*
  79. * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
  80. * there is no way to distinguish that from NAND_CMD_READ0
  81. * until the remaining sequence of commands has been completed
  82. * so add a high order bit and mask it off in the command.
  83. */
  84. #define NAND_CMD_DEPLETE1 0x100
  85. #define NAND_CMD_DEPLETE2 0x38
  86. #define NAND_CMD_STATUS_MULTI 0x71
  87. #define NAND_CMD_STATUS_ERROR 0x72
  88. /* multi-bank error status (banks 0-3) */
  89. #define NAND_CMD_STATUS_ERROR0 0x73
  90. #define NAND_CMD_STATUS_ERROR1 0x74
  91. #define NAND_CMD_STATUS_ERROR2 0x75
  92. #define NAND_CMD_STATUS_ERROR3 0x76
  93. #define NAND_CMD_STATUS_RESET 0x7f
  94. #define NAND_CMD_STATUS_CLEAR 0xff
  95. #define NAND_CMD_NONE -1
  96. /* Status bits */
  97. #define NAND_STATUS_FAIL 0x01
  98. #define NAND_STATUS_FAIL_N1 0x02
  99. #define NAND_STATUS_TRUE_READY 0x20
  100. #define NAND_STATUS_READY 0x40
  101. #define NAND_STATUS_WP 0x80
  102. /*
  103. * Constants for ECC_MODES
  104. */
  105. typedef enum {
  106. NAND_ECC_NONE,
  107. NAND_ECC_SOFT,
  108. NAND_ECC_HW,
  109. NAND_ECC_HW_SYNDROME,
  110. } nand_ecc_modes_t;
  111. /*
  112. * Constants for Hardware ECC
  113. */
  114. /* Reset Hardware ECC for read */
  115. #define NAND_ECC_READ 0
  116. /* Reset Hardware ECC for write */
  117. #define NAND_ECC_WRITE 1
  118. /* Enable Hardware ECC before syndrom is read back from flash */
  119. #define NAND_ECC_READSYN 2
  120. /* Bit mask for flags passed to do_nand_read_ecc */
  121. #define NAND_GET_DEVICE 0x80
  122. /* Option constants for bizarre disfunctionality and real
  123. * features
  124. */
  125. /* Chip can not auto increment pages */
  126. #define NAND_NO_AUTOINCR 0x00000001
  127. /* Buswitdh is 16 bit */
  128. #define NAND_BUSWIDTH_16 0x00000002
  129. /* Device supports partial programming without padding */
  130. #define NAND_NO_PADDING 0x00000004
  131. /* Chip has cache program function */
  132. #define NAND_CACHEPRG 0x00000008
  133. /* Chip has copy back function */
  134. #define NAND_COPYBACK 0x00000010
  135. /* AND Chip which has 4 banks and a confusing page / block
  136. * assignment. See Renesas datasheet for further information */
  137. #define NAND_IS_AND 0x00000020
  138. /* Chip has a array of 4 pages which can be read without
  139. * additional ready /busy waits */
  140. #define NAND_4PAGE_ARRAY 0x00000040
  141. /* Chip requires that BBT is periodically rewritten to prevent
  142. * bits from adjacent blocks from 'leaking' in altering data.
  143. * This happens with the Renesas AG-AND chips, possibly others. */
  144. #define BBT_AUTO_REFRESH 0x00000080
  145. /* Chip does not require ready check on read. True
  146. * for all large page devices, as they do not support
  147. * autoincrement.*/
  148. #define NAND_NO_READRDY 0x00000100
  149. /* Chip does not allow subpage writes */
  150. #define NAND_NO_SUBPAGE_WRITE 0x00000200
  151. /* Options valid for Samsung large page devices */
  152. #define NAND_SAMSUNG_LP_OPTIONS \
  153. (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)
  154. /* Macros to identify the above */
  155. #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
  156. #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
  157. #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
  158. #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
  159. /* Large page NAND with SOFT_ECC should support subpage reads */
  160. #define NAND_SUBPAGE_READ(chip) ((chip->ecc.mode == NAND_ECC_SOFT) \
  161. && (chip->page_shift > 9))
  162. /* Mask to zero out the chip options, which come from the id table */
  163. #define NAND_CHIPOPTIONS_MSK (0x0000ffff & ~NAND_NO_AUTOINCR)
  164. /* Non chip related options */
  165. /* Use a flash based bad block table. This option is passed to the
  166. * default bad block table function. */
  167. #define NAND_USE_FLASH_BBT 0x00010000
  168. /* This option skips the bbt scan during initialization. */
  169. #define NAND_SKIP_BBTSCAN 0x00020000
  170. /* This option is defined if the board driver allocates its own buffers
  171. (e.g. because it needs them DMA-coherent */
  172. #define NAND_OWN_BUFFERS 0x00040000
  173. /* Options set by nand scan */
  174. /* Nand scan has allocated controller struct */
  175. #define NAND_CONTROLLER_ALLOC 0x80000000
  176. /* Cell info constants */
  177. #define NAND_CI_CHIPNR_MSK 0x03
  178. #define NAND_CI_CELLTYPE_MSK 0x0C
  179. /*
  180. * nand_state_t - chip states
  181. * Enumeration for NAND flash chip state
  182. */
  183. typedef enum {
  184. FL_READY,
  185. FL_READING,
  186. FL_WRITING,
  187. FL_ERASING,
  188. FL_SYNCING,
  189. FL_CACHEDPRG,
  190. FL_PM_SUSPENDED,
  191. } nand_state_t;
  192. /* Keep gcc happy */
  193. struct nand_chip;
  194. /**
  195. * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
  196. * @lock: protection lock
  197. * @active: the mtd device which holds the controller currently
  198. * @wq: wait queue to sleep on if a NAND operation is in progress
  199. * used instead of the per chip wait queue when a hw controller is available
  200. */
  201. struct nand_hw_control {
  202. spinlock_t lock;
  203. struct nand_chip *active;
  204. wait_queue_head_t wq;
  205. };
  206. /**
  207. * struct nand_ecc_ctrl - Control structure for ecc
  208. * @mode: ecc mode
  209. * @steps: number of ecc steps per page
  210. * @size: data bytes per ecc step
  211. * @bytes: ecc bytes per step
  212. * @total: total number of ecc bytes per page
  213. * @prepad: padding information for syndrome based ecc generators
  214. * @postpad: padding information for syndrome based ecc generators
  215. * @layout: ECC layout control struct pointer
  216. * @hwctl: function to control hardware ecc generator. Must only
  217. * be provided if an hardware ECC is available
  218. * @calculate: function for ecc calculation or readback from ecc hardware
  219. * @correct: function for ecc correction, matching to ecc generator (sw/hw)
  220. * @read_page_raw: function to read a raw page without ECC
  221. * @write_page_raw: function to write a raw page without ECC
  222. * @read_page: function to read a page according to the ecc generator requirements
  223. * @read_subpage: function to read parts of the page covered by ECC.
  224. * @write_page: function to write a page according to the ecc generator requirements
  225. * @read_oob: function to read chip OOB data
  226. * @write_oob: function to write chip OOB data
  227. */
  228. struct nand_ecc_ctrl {
  229. nand_ecc_modes_t mode;
  230. int steps;
  231. int size;
  232. int bytes;
  233. int total;
  234. int prepad;
  235. int postpad;
  236. struct nand_ecclayout *layout;
  237. void (*hwctl)(struct mtd_info *mtd, int mode);
  238. int (*calculate)(struct mtd_info *mtd,
  239. const uint8_t *dat,
  240. uint8_t *ecc_code);
  241. int (*correct)(struct mtd_info *mtd, uint8_t *dat,
  242. uint8_t *read_ecc,
  243. uint8_t *calc_ecc);
  244. int (*read_page_raw)(struct mtd_info *mtd,
  245. struct nand_chip *chip,
  246. uint8_t *buf);
  247. void (*write_page_raw)(struct mtd_info *mtd,
  248. struct nand_chip *chip,
  249. const uint8_t *buf);
  250. int (*read_page)(struct mtd_info *mtd,
  251. struct nand_chip *chip,
  252. uint8_t *buf);
  253. int (*read_subpage)(struct mtd_info *mtd,
  254. struct nand_chip *chip,
  255. uint32_t offs, uint32_t len,
  256. uint8_t *buf);
  257. void (*write_page)(struct mtd_info *mtd,
  258. struct nand_chip *chip,
  259. const uint8_t *buf);
  260. int (*read_oob)(struct mtd_info *mtd,
  261. struct nand_chip *chip,
  262. int page,
  263. int sndcmd);
  264. int (*write_oob)(struct mtd_info *mtd,
  265. struct nand_chip *chip,
  266. int page);
  267. };
  268. /**
  269. * struct nand_buffers - buffer structure for read/write
  270. * @ecccalc: buffer for calculated ecc
  271. * @ecccode: buffer for ecc read from flash
  272. * @databuf: buffer for data - dynamically sized
  273. *
  274. * Do not change the order of buffers. databuf and oobrbuf must be in
  275. * consecutive order.
  276. */
  277. struct nand_buffers {
  278. uint8_t ecccalc[NAND_MAX_OOBSIZE];
  279. uint8_t ecccode[NAND_MAX_OOBSIZE];
  280. uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
  281. };
  282. /**
  283. * struct nand_chip - NAND Private Flash Chip Data
  284. * @IO_ADDR_R: [BOARDSPECIFIC] address to read the 8 I/O lines of the flash device
  285. * @IO_ADDR_W: [BOARDSPECIFIC] address to write the 8 I/O lines of the flash device
  286. * @read_byte: [REPLACEABLE] read one byte from the chip
  287. * @read_word: [REPLACEABLE] read one word from the chip
  288. * @write_buf: [REPLACEABLE] write data from the buffer to the chip
  289. * @read_buf: [REPLACEABLE] read data from the chip into the buffer
  290. * @verify_buf: [REPLACEABLE] verify buffer contents against the chip data
  291. * @select_chip: [REPLACEABLE] select chip nr
  292. * @block_bad: [REPLACEABLE] check, if the block is bad
  293. * @block_markbad: [REPLACEABLE] mark the block bad
  294. * @cmd_ctrl: [BOARDSPECIFIC] hardwarespecific funtion for controlling
  295. * ALE/CLE/nCE. Also used to write command and address
  296. * @dev_ready: [BOARDSPECIFIC] hardwarespecific function for accesing device ready/busy line
  297. * If set to NULL no access to ready/busy is available and the ready/busy information
  298. * is read from the chip status register
  299. * @cmdfunc: [REPLACEABLE] hardwarespecific function for writing commands to the chip
  300. * @waitfunc: [REPLACEABLE] hardwarespecific function for wait on ready
  301. * @ecc: [BOARDSPECIFIC] ecc control ctructure
  302. * @buffers: buffer structure for read/write
  303. * @hwcontrol: platform-specific hardware control structure
  304. * @ops: oob operation operands
  305. * @erase_cmd: [INTERN] erase command write function, selectable due to AND support
  306. * @scan_bbt: [REPLACEABLE] function to scan bad block table
  307. * @chip_delay: [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR)
  308. * @state: [INTERN] the current state of the NAND device
  309. * @oob_poi: poison value buffer
  310. * @page_shift: [INTERN] number of address bits in a page (column address bits)
  311. * @phys_erase_shift: [INTERN] number of address bits in a physical eraseblock
  312. * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry
  313. * @chip_shift: [INTERN] number of address bits in one chip
  314. * @options: [BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about
  315. * special functionality. See the defines for further explanation
  316. * @badblockpos: [INTERN] position of the bad block marker in the oob area
  317. * @cellinfo: [INTERN] MLC/multichip data from chip ident
  318. * @numchips: [INTERN] number of physical chips
  319. * @chipsize: [INTERN] the size of one chip for multichip arrays
  320. * @pagemask: [INTERN] page number mask = number of (pages / chip) - 1
  321. * @pagebuf: [INTERN] holds the pagenumber which is currently in data_buf
  322. * @subpagesize: [INTERN] holds the subpagesize
  323. * @ecclayout: [REPLACEABLE] the default ecc placement scheme
  324. * @bbt: [INTERN] bad block table pointer
  325. * @bbt_td: [REPLACEABLE] bad block table descriptor for flash lookup
  326. * @bbt_md: [REPLACEABLE] bad block table mirror descriptor
  327. * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for initial bad block scan
  328. * @controller: [REPLACEABLE] a pointer to a hardware controller structure
  329. * which is shared among multiple independend devices
  330. * @priv: [OPTIONAL] pointer to private chip date
  331. * @errstat: [OPTIONAL] hardware specific function to perform additional error status checks
  332. * (determine if errors are correctable)
  333. * @write_page: [REPLACEABLE] High-level page write function
  334. */
  335. struct nand_chip {
  336. void __iomem *IO_ADDR_R;
  337. void __iomem *IO_ADDR_W;
  338. uint8_t (*read_byte)(struct mtd_info *mtd);
  339. u16 (*read_word)(struct mtd_info *mtd);
  340. void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
  341. void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
  342. int (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
  343. void (*select_chip)(struct mtd_info *mtd, int chip);
  344. int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
  345. int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
  346. void (*cmd_ctrl)(struct mtd_info *mtd, int dat,
  347. unsigned int ctrl);
  348. int (*dev_ready)(struct mtd_info *mtd);
  349. void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr);
  350. int (*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
  351. void (*erase_cmd)(struct mtd_info *mtd, int page);
  352. int (*scan_bbt)(struct mtd_info *mtd);
  353. int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page);
  354. int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
  355. const uint8_t *buf, int page, int cached, int raw);
  356. int chip_delay;
  357. unsigned int options;
  358. int page_shift;
  359. int phys_erase_shift;
  360. int bbt_erase_shift;
  361. int chip_shift;
  362. int numchips;
  363. uint64_t chipsize;
  364. int pagemask;
  365. int pagebuf;
  366. int subpagesize;
  367. uint8_t cellinfo;
  368. int badblockpos;
  369. nand_state_t state;
  370. uint8_t *oob_poi;
  371. struct nand_hw_control *controller;
  372. struct nand_ecclayout *ecclayout;
  373. struct nand_ecc_ctrl ecc;
  374. struct nand_buffers *buffers;
  375. struct nand_hw_control hwcontrol;
  376. struct mtd_oob_ops ops;
  377. uint8_t *bbt;
  378. struct nand_bbt_descr *bbt_td;
  379. struct nand_bbt_descr *bbt_md;
  380. struct nand_bbt_descr *badblock_pattern;
  381. void *priv;
  382. };
  383. /*
  384. * NAND Flash Manufacturer ID Codes
  385. */
  386. #define NAND_MFR_TOSHIBA 0x98
  387. #define NAND_MFR_SAMSUNG 0xec
  388. #define NAND_MFR_FUJITSU 0x04
  389. #define NAND_MFR_NATIONAL 0x8f
  390. #define NAND_MFR_RENESAS 0x07
  391. #define NAND_MFR_STMICRO 0x20
  392. #define NAND_MFR_HYNIX 0xad
  393. #define NAND_MFR_MICRON 0x2c
  394. #define NAND_MFR_AMD 0x01
  395. /**
  396. * struct nand_flash_dev - NAND Flash Device ID Structure
  397. * @name: Identify the device type
  398. * @id: device ID code
  399. * @pagesize: Pagesize in bytes. Either 256 or 512 or 0
  400. * If the pagesize is 0, then the real pagesize
  401. * and the eraseize are determined from the
  402. * extended id bytes in the chip
  403. * @erasesize: Size of an erase block in the flash device.
  404. * @chipsize: Total chipsize in Mega Bytes
  405. * @options: Bitfield to store chip relevant options
  406. */
  407. struct nand_flash_dev {
  408. char *name;
  409. int id;
  410. unsigned long pagesize;
  411. unsigned long chipsize;
  412. unsigned long erasesize;
  413. unsigned long options;
  414. };
  415. /**
  416. * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
  417. * @name: Manufacturer name
  418. * @id: manufacturer ID code of device.
  419. */
  420. struct nand_manufacturers {
  421. int id;
  422. char * name;
  423. };
  424. extern struct nand_flash_dev nand_flash_ids[];
  425. extern struct nand_manufacturers nand_manuf_ids[];
  426. /**
  427. * struct nand_bbt_descr - bad block table descriptor
  428. * @options: options for this descriptor
  429. * @pages: the page(s) where we find the bbt, used with option BBT_ABSPAGE
  430. * when bbt is searched, then we store the found bbts pages here.
  431. * Its an array and supports up to 8 chips now
  432. * @offs: offset of the pattern in the oob area of the page
  433. * @veroffs: offset of the bbt version counter in the oob are of the page
  434. * @version: version read from the bbt page during scan
  435. * @len: length of the pattern, if 0 no pattern check is performed
  436. * @maxblocks: maximum number of blocks to search for a bbt. This number of
  437. * blocks is reserved at the end of the device where the tables are
  438. * written.
  439. * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than
  440. * bad) block in the stored bbt
  441. * @pattern: pattern to identify bad block table or factory marked good /
  442. * bad blocks, can be NULL, if len = 0
  443. *
  444. * Descriptor for the bad block table marker and the descriptor for the
  445. * pattern which identifies good and bad blocks. The assumption is made
  446. * that the pattern and the version count are always located in the oob area
  447. * of the first block.
  448. */
  449. struct nand_bbt_descr {
  450. int options;
  451. int pages[NAND_MAX_CHIPS];
  452. int offs;
  453. int veroffs;
  454. uint8_t version[NAND_MAX_CHIPS];
  455. int len;
  456. int maxblocks;
  457. int reserved_block_code;
  458. uint8_t *pattern;
  459. };
  460. /* Options for the bad block table descriptors */
  461. /* The number of bits used per block in the bbt on the device */
  462. #define NAND_BBT_NRBITS_MSK 0x0000000F
  463. #define NAND_BBT_1BIT 0x00000001
  464. #define NAND_BBT_2BIT 0x00000002
  465. #define NAND_BBT_4BIT 0x00000004
  466. #define NAND_BBT_8BIT 0x00000008
  467. /* The bad block table is in the last good block of the device */
  468. #define NAND_BBT_LASTBLOCK 0x00000010
  469. /* The bbt is at the given page, else we must scan for the bbt */
  470. #define NAND_BBT_ABSPAGE 0x00000020
  471. /* The bbt is at the given page, else we must scan for the bbt */
  472. #define NAND_BBT_SEARCH 0x00000040
  473. /* bbt is stored per chip on multichip devices */
  474. #define NAND_BBT_PERCHIP 0x00000080
  475. /* bbt has a version counter at offset veroffs */
  476. #define NAND_BBT_VERSION 0x00000100
  477. /* Create a bbt if none axists */
  478. #define NAND_BBT_CREATE 0x00000200
  479. /* Search good / bad pattern through all pages of a block */
  480. #define NAND_BBT_SCANALLPAGES 0x00000400
  481. /* Scan block empty during good / bad block scan */
  482. #define NAND_BBT_SCANEMPTY 0x00000800
  483. /* Write bbt if neccecary */
  484. #define NAND_BBT_WRITE 0x00001000
  485. /* Read and write back block contents when writing bbt */
  486. #define NAND_BBT_SAVECONTENT 0x00002000
  487. /* Search good / bad pattern on the first and the second page */
  488. #define NAND_BBT_SCAN2NDPAGE 0x00004000
  489. /* The maximum number of blocks to scan for a bbt */
  490. #define NAND_BBT_SCAN_MAXBLOCKS 4
  491. extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
  492. extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
  493. extern int nand_default_bbt(struct mtd_info *mtd);
  494. extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
  495. extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
  496. int allowbbt);
  497. extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
  498. size_t * retlen, uint8_t * buf);
  499. /*
  500. * Constants for oob configuration
  501. */
  502. #define NAND_SMALL_BADBLOCK_POS 5
  503. #define NAND_LARGE_BADBLOCK_POS 0
  504. /**
  505. * struct platform_nand_chip - chip level device structure
  506. * @nr_chips: max. number of chips to scan for
  507. * @chip_offset: chip number offset
  508. * @nr_partitions: number of partitions pointed to by partitions (or zero)
  509. * @partitions: mtd partition list
  510. * @chip_delay: R/B delay value in us
  511. * @options: Option flags, e.g. 16bit buswidth
  512. * @ecclayout: ecc layout info structure
  513. * @part_probe_types: NULL-terminated array of probe types
  514. * @priv: hardware controller specific settings
  515. */
  516. struct platform_nand_chip {
  517. int nr_chips;
  518. int chip_offset;
  519. int nr_partitions;
  520. struct mtd_partition *partitions;
  521. struct nand_ecclayout *ecclayout;
  522. int chip_delay;
  523. unsigned int options;
  524. const char **part_probe_types;
  525. void *priv;
  526. };
  527. /**
  528. * struct platform_nand_ctrl - controller level device structure
  529. * @hwcontrol: platform specific hardware control structure
  530. * @dev_ready: platform specific function to read ready/busy pin
  531. * @select_chip: platform specific chip select function
  532. * @cmd_ctrl: platform specific function for controlling
  533. * ALE/CLE/nCE. Also used to write command and address
  534. * @priv: private data to transport driver specific settings
  535. *
  536. * All fields are optional and depend on the hardware driver requirements
  537. */
  538. struct platform_nand_ctrl {
  539. void (*hwcontrol)(struct mtd_info *mtd, int cmd);
  540. int (*dev_ready)(struct mtd_info *mtd);
  541. void (*select_chip)(struct mtd_info *mtd, int chip);
  542. void (*cmd_ctrl)(struct mtd_info *mtd, int dat,
  543. unsigned int ctrl);
  544. void *priv;
  545. };
  546. /**
  547. * struct platform_nand_data - container structure for platform-specific data
  548. * @chip: chip level chip structure
  549. * @ctrl: controller level device structure
  550. */
  551. struct platform_nand_data {
  552. struct platform_nand_chip chip;
  553. struct platform_nand_ctrl ctrl;
  554. };
  555. /* Some helpers to access the data structures */
  556. static inline
  557. struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
  558. {
  559. struct nand_chip *chip = mtd->priv;
  560. return chip->priv;
  561. }
  562. #endif /* __LINUX_MTD_NAND_H */