nand.h 21 KB

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