nand.h 21 KB

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