blob: 527d9ae03f8b2b226d06f77b426885db5e2af762 [file] [log] [blame]
wdenke2211742002-11-02 23:30:20 +00001/*
wdenkdc7c9a12003-03-26 06:55:25 +00002 * linux/include/linux/mtd/nand.h
wdenke2211742002-11-02 23:30:20 +00003 *
Scott Woodc45912d2008-10-24 16:20:43 -05004 * Copyright (c) 2000 David Woodhouse <dwmw2@infradead.org>
William Juulcfa460a2007-10-31 13:53:06 +01005 * Steven J. Hill <sjhill@realitydiluted.com>
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +01006 * Thomas Gleixner <tglx@linutronix.de>
wdenke2211742002-11-02 23:30:20 +00007 *
wdenke2211742002-11-02 23:30:20 +00008 * 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 *
William Juulcfa460a2007-10-31 13:53:06 +010012 * Info:
13 * Contains standard defines and IDs for NAND flash devices
wdenke2211742002-11-02 23:30:20 +000014 *
William Juulcfa460a2007-10-31 13:53:06 +010015 * Changelog:
16 * See git changelog.
wdenke2211742002-11-02 23:30:20 +000017 */
18#ifndef __LINUX_MTD_NAND_H
19#define __LINUX_MTD_NAND_H
20
William Juulcfa460a2007-10-31 13:53:06 +010021#include "config.h"
22
23#include "linux/mtd/compat.h"
24#include "linux/mtd/mtd.h"
Alessandro Rubinia47f9572008-10-31 22:33:21 +010025#include "linux/mtd/bbm.h"
William Juulcfa460a2007-10-31 13:53:06 +010026
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010027
28struct mtd_info;
Lei Wen245eb902011-01-06 09:48:18 +080029struct nand_flash_dev;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010030/* Scan and identify a NAND device */
31extern int nand_scan (struct mtd_info *mtd, int max_chips);
William Juulcfa460a2007-10-31 13:53:06 +010032/* Separate phases of nand_scan(), allowing board driver to intervene
33 * and override command or ECC setup according to flash type */
Lei Wen245eb902011-01-06 09:48:18 +080034extern int nand_scan_ident(struct mtd_info *mtd, int max_chips,
35 const struct nand_flash_dev *table);
William Juulcfa460a2007-10-31 13:53:06 +010036extern int nand_scan_tail(struct mtd_info *mtd);
37
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010038/* Free resources held by the NAND device */
39extern void nand_release (struct mtd_info *mtd);
40
William Juulcfa460a2007-10-31 13:53:06 +010041/* Internal helper for board drivers which need to override command function */
42extern void nand_wait_ready(struct mtd_info *mtd);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010043
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010044/* This constant declares the max. oobsize / page, which
45 * is supported now. If you add a chip with bigger oobsize/page
46 * adjust this accordingly.
47 */
Stefan Roesefbdaafa2009-06-04 16:40:36 +020048#define NAND_MAX_OOBSIZE 218
William Juulcfa460a2007-10-31 13:53:06 +010049#define NAND_MAX_PAGESIZE 4096
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010050
51/*
52 * Constants for hardware specific CLE/ALE/NCE function
William Juulcfa460a2007-10-31 13:53:06 +010053 *
54 * These are bits which can be or'ed to set/clear multiple
55 * bits in one go.
56 */
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010057/* Select the chip by setting nCE to low */
William Juulcfa460a2007-10-31 13:53:06 +010058#define NAND_NCE 0x01
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010059/* Select the command latch by setting CLE to high */
William Juulcfa460a2007-10-31 13:53:06 +010060#define NAND_CLE 0x02
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010061/* Select the address latch by setting ALE to high */
William Juulcfa460a2007-10-31 13:53:06 +010062#define NAND_ALE 0x04
63
64#define NAND_CTRL_CLE (NAND_NCE | NAND_CLE)
65#define NAND_CTRL_ALE (NAND_NCE | NAND_ALE)
66#define NAND_CTRL_CHANGE 0x80
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010067
wdenke2211742002-11-02 23:30:20 +000068/*
69 * Standard NAND flash commands
70 */
71#define NAND_CMD_READ0 0
72#define NAND_CMD_READ1 1
William Juulcfa460a2007-10-31 13:53:06 +010073#define NAND_CMD_RNDOUT 5
wdenke2211742002-11-02 23:30:20 +000074#define NAND_CMD_PAGEPROG 0x10
75#define NAND_CMD_READOOB 0x50
76#define NAND_CMD_ERASE1 0x60
77#define NAND_CMD_STATUS 0x70
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010078#define NAND_CMD_STATUS_MULTI 0x71
wdenke2211742002-11-02 23:30:20 +000079#define NAND_CMD_SEQIN 0x80
William Juulcfa460a2007-10-31 13:53:06 +010080#define NAND_CMD_RNDIN 0x85
wdenke2211742002-11-02 23:30:20 +000081#define NAND_CMD_READID 0x90
Florian Fainelli1ce70842010-12-10 12:16:41 +000082#define NAND_CMD_PARAM 0xec
wdenke2211742002-11-02 23:30:20 +000083#define NAND_CMD_ERASE2 0xd0
84#define NAND_CMD_RESET 0xff
85
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010086/* Extended commands for large page devices */
87#define NAND_CMD_READSTART 0x30
William Juulcfa460a2007-10-31 13:53:06 +010088#define NAND_CMD_RNDOUTSTART 0xE0
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010089#define NAND_CMD_CACHEDPROG 0x15
90
William Juulcfa460a2007-10-31 13:53:06 +010091/* Extended commands for AG-AND device */
92/*
93 * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
94 * there is no way to distinguish that from NAND_CMD_READ0
95 * until the remaining sequence of commands has been completed
96 * so add a high order bit and mask it off in the command.
97 */
98#define NAND_CMD_DEPLETE1 0x100
99#define NAND_CMD_DEPLETE2 0x38
100#define NAND_CMD_STATUS_MULTI 0x71
101#define NAND_CMD_STATUS_ERROR 0x72
102/* multi-bank error status (banks 0-3) */
103#define NAND_CMD_STATUS_ERROR0 0x73
104#define NAND_CMD_STATUS_ERROR1 0x74
105#define NAND_CMD_STATUS_ERROR2 0x75
106#define NAND_CMD_STATUS_ERROR3 0x76
107#define NAND_CMD_STATUS_RESET 0x7f
108#define NAND_CMD_STATUS_CLEAR 0xff
109
110#define NAND_CMD_NONE -1
111
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100112/* Status bits */
113#define NAND_STATUS_FAIL 0x01
114#define NAND_STATUS_FAIL_N1 0x02
115#define NAND_STATUS_TRUE_READY 0x20
116#define NAND_STATUS_READY 0x40
117#define NAND_STATUS_WP 0x80
118
wdenke2211742002-11-02 23:30:20 +0000119/*
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100120 * Constants for ECC_MODES
121 */
William Juulcfa460a2007-10-31 13:53:06 +0100122typedef enum {
123 NAND_ECC_NONE,
124 NAND_ECC_SOFT,
125 NAND_ECC_HW,
126 NAND_ECC_HW_SYNDROME,
Sandeep Paulrajf83b7f92009-08-10 13:27:56 -0400127 NAND_ECC_HW_OOB_FIRST,
Christian Hitz4c6de852011-10-12 09:31:59 +0200128 NAND_ECC_SOFT_BCH,
William Juulcfa460a2007-10-31 13:53:06 +0100129} nand_ecc_modes_t;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100130
131/*
132 * Constants for Hardware ECC
William Juulcfa460a2007-10-31 13:53:06 +0100133 */
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100134/* Reset Hardware ECC for read */
135#define NAND_ECC_READ 0
136/* Reset Hardware ECC for write */
137#define NAND_ECC_WRITE 1
138/* Enable Hardware ECC before syndrom is read back from flash */
139#define NAND_ECC_READSYN 2
140
William Juulcfa460a2007-10-31 13:53:06 +0100141/* Bit mask for flags passed to do_nand_read_ecc */
142#define NAND_GET_DEVICE 0x80
143
144
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100145/* Option constants for bizarre disfunctionality and real
146* features
147*/
148/* Chip can not auto increment pages */
149#define NAND_NO_AUTOINCR 0x00000001
150/* Buswitdh is 16 bit */
151#define NAND_BUSWIDTH_16 0x00000002
152/* Device supports partial programming without padding */
153#define NAND_NO_PADDING 0x00000004
154/* Chip has cache program function */
155#define NAND_CACHEPRG 0x00000008
156/* Chip has copy back function */
157#define NAND_COPYBACK 0x00000010
158/* AND Chip which has 4 banks and a confusing page / block
159 * assignment. See Renesas datasheet for further information */
160#define NAND_IS_AND 0x00000020
161/* Chip has a array of 4 pages which can be read without
162 * additional ready /busy waits */
163#define NAND_4PAGE_ARRAY 0x00000040
William Juulcfa460a2007-10-31 13:53:06 +0100164/* Chip requires that BBT is periodically rewritten to prevent
165 * bits from adjacent blocks from 'leaking' in altering data.
166 * This happens with the Renesas AG-AND chips, possibly others. */
167#define BBT_AUTO_REFRESH 0x00000080
168/* Chip does not require ready check on read. True
169 * for all large page devices, as they do not support
170 * autoincrement.*/
171#define NAND_NO_READRDY 0x00000100
172/* Chip does not allow subpage writes */
173#define NAND_NO_SUBPAGE_WRITE 0x00000200
174
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100175
176/* Options valid for Samsung large page devices */
177#define NAND_SAMSUNG_LP_OPTIONS \
178 (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)
179
180/* Macros to identify the above */
181#define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
182#define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
183#define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
184#define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
Scott Woodc45912d2008-10-24 16:20:43 -0500185/* Large page NAND with SOFT_ECC should support subpage reads */
186#define NAND_SUBPAGE_READ(chip) ((chip->ecc.mode == NAND_ECC_SOFT) \
187 && (chip->page_shift > 9))
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100188
189/* Mask to zero out the chip options, which come from the id table */
190#define NAND_CHIPOPTIONS_MSK (0x0000ffff & ~NAND_NO_AUTOINCR)
191
192/* Non chip related options */
193/* Use a flash based bad block table. This option is passed to the
194 * default bad block table function. */
195#define NAND_USE_FLASH_BBT 0x00010000
William Juulcfa460a2007-10-31 13:53:06 +0100196/* This option skips the bbt scan during initialization. */
197#define NAND_SKIP_BBTSCAN 0x00020000
198/* This option is defined if the board driver allocates its own buffers
199 (e.g. because it needs them DMA-coherent */
200#define NAND_OWN_BUFFERS 0x00040000
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100201/* Options set by nand scan */
Ilya Yanok13f0fd92008-06-30 15:34:40 +0200202/* bbt has already been read */
203#define NAND_BBT_SCANNED 0x40000000
William Juulcfa460a2007-10-31 13:53:06 +0100204/* Nand scan has allocated controller struct */
205#define NAND_CONTROLLER_ALLOC 0x80000000
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100206
William Juulcfa460a2007-10-31 13:53:06 +0100207/* Cell info constants */
208#define NAND_CI_CHIPNR_MSK 0x03
209#define NAND_CI_CELLTYPE_MSK 0x0C
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100210
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100211/* Keep gcc happy */
212struct nand_chip;
wdenkdc7c9a12003-03-26 06:55:25 +0000213
Florian Fainelli0272c712011-02-25 00:01:34 +0000214struct nand_onfi_params {
215 /* rev info and features block */
216 /* 'O' 'N' 'F' 'I' */
217 u8 sig[4];
218 __le16 revision;
219 __le16 features;
220 __le16 opt_cmd;
221 u8 reserved[22];
222
223 /* manufacturer information block */
224 char manufacturer[12];
225 char model[20];
226 u8 jedec_id;
227 __le16 date_code;
228 u8 reserved2[13];
229
230 /* memory organization block */
231 __le32 byte_per_page;
232 __le16 spare_bytes_per_page;
233 __le32 data_bytes_per_ppage;
234 __le16 spare_bytes_per_ppage;
235 __le32 pages_per_block;
236 __le32 blocks_per_lun;
237 u8 lun_count;
238 u8 addr_cycles;
239 u8 bits_per_cell;
240 __le16 bb_per_lun;
241 __le16 block_endurance;
242 u8 guaranteed_good_blocks;
243 __le16 guaranteed_block_endurance;
244 u8 programs_per_page;
245 u8 ppage_attr;
246 u8 ecc_bits;
247 u8 interleaved_bits;
248 u8 interleaved_ops;
249 u8 reserved3[13];
250
251 /* electrical parameter block */
252 u8 io_pin_capacitance_max;
253 __le16 async_timing_mode;
254 __le16 program_cache_timing_mode;
255 __le16 t_prog;
256 __le16 t_bers;
257 __le16 t_r;
258 __le16 t_ccs;
259 __le16 src_sync_timing_mode;
260 __le16 src_ssync_features;
261 __le16 clk_pin_capacitance_typ;
262 __le16 io_pin_capacitance_typ;
263 __le16 input_pin_capacitance_typ;
264 u8 input_pin_capacitance_max;
265 u8 driver_strenght_support;
266 __le16 t_int_r;
267 __le16 t_ald;
268 u8 reserved4[7];
269
270 /* vendor */
271 u8 reserved5[90];
272
273 __le16 crc;
274} __attribute__((packed));
275
276#define ONFI_CRC_BASE 0x4F4E
277
278
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100279/**
William Juulcfa460a2007-10-31 13:53:06 +0100280 * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
281 * @lock: protection lock
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100282 * @active: the mtd device which holds the controller currently
William Juulcfa460a2007-10-31 13:53:06 +0100283 * @wq: wait queue to sleep on if a NAND operation is in progress
284 * used instead of the per chip wait queue when a hw controller is available
wdenkdc7c9a12003-03-26 06:55:25 +0000285 */
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100286struct nand_hw_control {
William Juul5e1dae52007-11-09 13:32:30 +0100287/* XXX U-BOOT XXX */
William Juulcfa460a2007-10-31 13:53:06 +0100288#if 0
William Juul5e1dae52007-11-09 13:32:30 +0100289 spinlock_t lock;
290 wait_queue_head_t wq;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100291#endif
William Juul5e1dae52007-11-09 13:32:30 +0100292 struct nand_chip *active;
William Juulcfa460a2007-10-31 13:53:06 +0100293};
294
295/**
296 * struct nand_ecc_ctrl - Control structure for ecc
297 * @mode: ecc mode
298 * @steps: number of ecc steps per page
299 * @size: data bytes per ecc step
300 * @bytes: ecc bytes per step
301 * @total: total number of ecc bytes per page
302 * @prepad: padding information for syndrome based ecc generators
303 * @postpad: padding information for syndrome based ecc generators
304 * @layout: ECC layout control struct pointer
Christian Hitz4c6de852011-10-12 09:31:59 +0200305 * @priv: pointer to private ecc control data
William Juulcfa460a2007-10-31 13:53:06 +0100306 * @hwctl: function to control hardware ecc generator. Must only
307 * be provided if an hardware ECC is available
308 * @calculate: function for ecc calculation or readback from ecc hardware
309 * @correct: function for ecc correction, matching to ecc generator (sw/hw)
310 * @read_page_raw: function to read a raw page without ECC
311 * @write_page_raw: function to write a raw page without ECC
312 * @read_page: function to read a page according to the ecc generator requirements
313 * @write_page: function to write a page according to the ecc generator requirements
314 * @read_oob: function to read chip OOB data
315 * @write_oob: function to write chip OOB data
316 */
317struct nand_ecc_ctrl {
318 nand_ecc_modes_t mode;
319 int steps;
320 int size;
321 int bytes;
322 int total;
323 int prepad;
324 int postpad;
325 struct nand_ecclayout *layout;
Christian Hitz4c6de852011-10-12 09:31:59 +0200326 void *priv;
William Juulcfa460a2007-10-31 13:53:06 +0100327 void (*hwctl)(struct mtd_info *mtd, int mode);
328 int (*calculate)(struct mtd_info *mtd,
329 const uint8_t *dat,
330 uint8_t *ecc_code);
331 int (*correct)(struct mtd_info *mtd, uint8_t *dat,
332 uint8_t *read_ecc,
333 uint8_t *calc_ecc);
334 int (*read_page_raw)(struct mtd_info *mtd,
335 struct nand_chip *chip,
Sandeep Paulraja2c65b42009-08-10 13:27:46 -0400336 uint8_t *buf, int page);
William Juulcfa460a2007-10-31 13:53:06 +0100337 void (*write_page_raw)(struct mtd_info *mtd,
338 struct nand_chip *chip,
339 const uint8_t *buf);
340 int (*read_page)(struct mtd_info *mtd,
341 struct nand_chip *chip,
Sandeep Paulraja2c65b42009-08-10 13:27:46 -0400342 uint8_t *buf, int page);
Scott Woodc45912d2008-10-24 16:20:43 -0500343 int (*read_subpage)(struct mtd_info *mtd,
344 struct nand_chip *chip,
345 uint32_t offs, uint32_t len,
346 uint8_t *buf);
William Juulcfa460a2007-10-31 13:53:06 +0100347 void (*write_page)(struct mtd_info *mtd,
348 struct nand_chip *chip,
349 const uint8_t *buf);
350 int (*read_oob)(struct mtd_info *mtd,
351 struct nand_chip *chip,
352 int page,
353 int sndcmd);
354 int (*write_oob)(struct mtd_info *mtd,
355 struct nand_chip *chip,
356 int page);
357};
358
359/**
360 * struct nand_buffers - buffer structure for read/write
361 * @ecccalc: buffer for calculated ecc
362 * @ecccode: buffer for ecc read from flash
363 * @databuf: buffer for data - dynamically sized
364 *
365 * Do not change the order of buffers. databuf and oobrbuf must be in
366 * consecutive order.
367 */
368struct nand_buffers {
369 uint8_t ecccalc[NAND_MAX_OOBSIZE];
370 uint8_t ecccode[NAND_MAX_OOBSIZE];
371 uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
372};
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100373
374/**
375 * struct nand_chip - NAND Private Flash Chip Data
376 * @IO_ADDR_R: [BOARDSPECIFIC] address to read the 8 I/O lines of the flash device
377 * @IO_ADDR_W: [BOARDSPECIFIC] address to write the 8 I/O lines of the flash device
378 * @read_byte: [REPLACEABLE] read one byte from the chip
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100379 * @read_word: [REPLACEABLE] read one word from the chip
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100380 * @write_buf: [REPLACEABLE] write data from the buffer to the chip
381 * @read_buf: [REPLACEABLE] read data from the chip into the buffer
382 * @verify_buf: [REPLACEABLE] verify buffer contents against the chip data
383 * @select_chip: [REPLACEABLE] select chip nr
384 * @block_bad: [REPLACEABLE] check, if the block is bad
385 * @block_markbad: [REPLACEABLE] mark the block bad
William Juulcfa460a2007-10-31 13:53:06 +0100386 * @cmd_ctrl: [BOARDSPECIFIC] hardwarespecific funtion for controlling
387 * ALE/CLE/nCE. Also used to write command and address
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100388 * @dev_ready: [BOARDSPECIFIC] hardwarespecific function for accesing device ready/busy line
389 * If set to NULL no access to ready/busy is available and the ready/busy information
390 * is read from the chip status register
391 * @cmdfunc: [REPLACEABLE] hardwarespecific function for writing commands to the chip
392 * @waitfunc: [REPLACEABLE] hardwarespecific function for wait on ready
William Juulcfa460a2007-10-31 13:53:06 +0100393 * @ecc: [BOARDSPECIFIC] ecc control ctructure
394 * @buffers: buffer structure for read/write
395 * @hwcontrol: platform-specific hardware control structure
396 * @ops: oob operation operands
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100397 * @erase_cmd: [INTERN] erase command write function, selectable due to AND support
398 * @scan_bbt: [REPLACEABLE] function to scan bad block table
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100399 * @chip_delay: [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR)
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100400 * @wq: [INTERN] wait queue to sleep on if a NAND operation is in progress
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200401 * @state: [INTERN] the current state of the NAND device
William Juulcfa460a2007-10-31 13:53:06 +0100402 * @oob_poi: poison value buffer
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100403 * @page_shift: [INTERN] number of address bits in a page (column address bits)
404 * @phys_erase_shift: [INTERN] number of address bits in a physical eraseblock
405 * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry
406 * @chip_shift: [INTERN] number of address bits in one chip
William Juulcfa460a2007-10-31 13:53:06 +0100407 * @datbuf: [INTERN] internal buffer for one page + oob
408 * @oobbuf: [INTERN] oob buffer for one eraseblock
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100409 * @oobdirty: [INTERN] indicates that oob_buf must be reinitialized
410 * @data_poi: [INTERN] pointer to a data buffer
411 * @options: [BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about
412 * special functionality. See the defines for further explanation
413 * @badblockpos: [INTERN] position of the bad block marker in the oob area
William Juulcfa460a2007-10-31 13:53:06 +0100414 * @cellinfo: [INTERN] MLC/multichip data from chip ident
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100415 * @numchips: [INTERN] number of physical chips
416 * @chipsize: [INTERN] the size of one chip for multichip arrays
417 * @pagemask: [INTERN] page number mask = number of (pages / chip) - 1
418 * @pagebuf: [INTERN] holds the pagenumber which is currently in data_buf
William Juulcfa460a2007-10-31 13:53:06 +0100419 * @subpagesize: [INTERN] holds the subpagesize
420 * @ecclayout: [REPLACEABLE] the default ecc placement scheme
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100421 * @bbt: [INTERN] bad block table pointer
422 * @bbt_td: [REPLACEABLE] bad block table descriptor for flash lookup
423 * @bbt_md: [REPLACEABLE] bad block table mirror descriptor
424 * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for initial bad block scan
William Juulcfa460a2007-10-31 13:53:06 +0100425 * @controller: [REPLACEABLE] a pointer to a hardware controller structure
426 * which is shared among multiple independend devices
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100427 * @priv: [OPTIONAL] pointer to private chip date
William Juulcfa460a2007-10-31 13:53:06 +0100428 * @errstat: [OPTIONAL] hardware specific function to perform additional error status checks
429 * (determine if errors are correctable)
430 * @write_page: [REPLACEABLE] High-level page write function
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100431 */
wdenkdc7c9a12003-03-26 06:55:25 +0000432
433struct nand_chip {
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100434 void __iomem *IO_ADDR_R;
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200435 void __iomem *IO_ADDR_W;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100436
William Juulcfa460a2007-10-31 13:53:06 +0100437 uint8_t (*read_byte)(struct mtd_info *mtd);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100438 u16 (*read_word)(struct mtd_info *mtd);
William Juulcfa460a2007-10-31 13:53:06 +0100439 void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
440 void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
441 int (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100442 void (*select_chip)(struct mtd_info *mtd, int chip);
443 int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
444 int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
William Juulcfa460a2007-10-31 13:53:06 +0100445 void (*cmd_ctrl)(struct mtd_info *mtd, int dat,
446 unsigned int ctrl);
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200447 int (*dev_ready)(struct mtd_info *mtd);
448 void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr);
William Juulcfa460a2007-10-31 13:53:06 +0100449 int (*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100450 void (*erase_cmd)(struct mtd_info *mtd, int page);
451 int (*scan_bbt)(struct mtd_info *mtd);
William Juulcfa460a2007-10-31 13:53:06 +0100452 int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page);
453 int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
454 const uint8_t *buf, int page, int cached, int raw);
455
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200456 int chip_delay;
William Juulcfa460a2007-10-31 13:53:06 +0100457 unsigned int options;
458
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200459 int page_shift;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100460 int phys_erase_shift;
461 int bbt_erase_shift;
462 int chip_shift;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100463 int numchips;
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -0400464 uint64_t chipsize;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100465 int pagemask;
466 int pagebuf;
William Juulcfa460a2007-10-31 13:53:06 +0100467 int subpagesize;
468 uint8_t cellinfo;
469 int badblockpos;
Florian Fainelli0272c712011-02-25 00:01:34 +0000470 int onfi_version;
471#ifdef CONFIG_SYS_NAND_ONFI_DETECTION
472 struct nand_onfi_params onfi_params;
473#endif
William Juulcfa460a2007-10-31 13:53:06 +0100474
Kyungmin Parkd438d502008-08-13 09:11:02 +0900475 int state;
William Juulcfa460a2007-10-31 13:53:06 +0100476
477 uint8_t *oob_poi;
478 struct nand_hw_control *controller;
479 struct nand_ecclayout *ecclayout;
480
481 struct nand_ecc_ctrl ecc;
482 struct nand_buffers *buffers;
William Juul4cbb6512007-11-08 10:39:53 +0100483
William Juulcfa460a2007-10-31 13:53:06 +0100484 struct nand_hw_control hwcontrol;
485
486 struct mtd_oob_ops ops;
487
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100488 uint8_t *bbt;
489 struct nand_bbt_descr *bbt_td;
490 struct nand_bbt_descr *bbt_md;
William Juulcfa460a2007-10-31 13:53:06 +0100491
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100492 struct nand_bbt_descr *badblock_pattern;
William Juulcfa460a2007-10-31 13:53:06 +0100493
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100494 void *priv;
wdenkdc7c9a12003-03-26 06:55:25 +0000495};
496
497/*
wdenke2211742002-11-02 23:30:20 +0000498 * NAND Flash Manufacturer ID Codes
499 */
500#define NAND_MFR_TOSHIBA 0x98
501#define NAND_MFR_SAMSUNG 0xec
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100502#define NAND_MFR_FUJITSU 0x04
503#define NAND_MFR_NATIONAL 0x8f
504#define NAND_MFR_RENESAS 0x07
505#define NAND_MFR_STMICRO 0x20
William Juulcfa460a2007-10-31 13:53:06 +0100506#define NAND_MFR_HYNIX 0xad
Ulf Samuelsson7ebb4472007-05-24 12:12:47 +0200507#define NAND_MFR_MICRON 0x2c
Scott Woodc45912d2008-10-24 16:20:43 -0500508#define NAND_MFR_AMD 0x01
wdenke2211742002-11-02 23:30:20 +0000509
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100510/**
511 * struct nand_flash_dev - NAND Flash Device ID Structure
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200512 * @name: Identify the device type
513 * @id: device ID code
514 * @pagesize: Pagesize in bytes. Either 256 or 512 or 0
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100515 * If the pagesize is 0, then the real pagesize
516 * and the eraseize are determined from the
517 * extended id bytes in the chip
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200518 * @erasesize: Size of an erase block in the flash device.
519 * @chipsize: Total chipsize in Mega Bytes
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100520 * @options: Bitfield to store chip relevant options
wdenke2211742002-11-02 23:30:20 +0000521 */
522struct nand_flash_dev {
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100523 char *name;
524 int id;
525 unsigned long pagesize;
526 unsigned long chipsize;
wdenke2211742002-11-02 23:30:20 +0000527 unsigned long erasesize;
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100528 unsigned long options;
wdenke2211742002-11-02 23:30:20 +0000529};
530
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100531/**
532 * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
533 * @name: Manufacturer name
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200534 * @id: manufacturer ID code of device.
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100535*/
536struct nand_manufacturers {
537 int id;
538 char * name;
539};
540
Mike Frysinger0bdecd82010-10-20 01:15:21 +0000541extern const struct nand_flash_dev nand_flash_ids[];
542extern const struct nand_manufacturers nand_manuf_ids[];
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100543
William Juulcfa460a2007-10-31 13:53:06 +0100544extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
545extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
546extern int nand_default_bbt(struct mtd_info *mtd);
547extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
548extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
549 int allowbbt);
550extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
551 size_t * retlen, uint8_t * buf);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100552
wdenkdc7c9a12003-03-26 06:55:25 +0000553/*
554* Constants for oob configuration
555*/
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100556#define NAND_SMALL_BADBLOCK_POS 5
557#define NAND_LARGE_BADBLOCK_POS 0
wdenkdc7c9a12003-03-26 06:55:25 +0000558
William Juulcfa460a2007-10-31 13:53:06 +0100559/**
560 * struct platform_nand_chip - chip level device structure
561 * @nr_chips: max. number of chips to scan for
562 * @chip_offset: chip number offset
563 * @nr_partitions: number of partitions pointed to by partitions (or zero)
564 * @partitions: mtd partition list
565 * @chip_delay: R/B delay value in us
566 * @options: Option flags, e.g. 16bit buswidth
567 * @ecclayout: ecc layout info structure
568 * @part_probe_types: NULL-terminated array of probe types
569 * @priv: hardware controller specific settings
570 */
571struct platform_nand_chip {
572 int nr_chips;
573 int chip_offset;
574 int nr_partitions;
575 struct mtd_partition *partitions;
576 struct nand_ecclayout *ecclayout;
577 int chip_delay;
578 unsigned int options;
579 const char **part_probe_types;
580 void *priv;
581};
582
583/**
584 * struct platform_nand_ctrl - controller level device structure
585 * @hwcontrol: platform specific hardware control structure
586 * @dev_ready: platform specific function to read ready/busy pin
587 * @select_chip: platform specific chip select function
588 * @cmd_ctrl: platform specific function for controlling
589 * ALE/CLE/nCE. Also used to write command and address
590 * @priv: private data to transport driver specific settings
591 *
592 * All fields are optional and depend on the hardware driver requirements
593 */
594struct platform_nand_ctrl {
595 void (*hwcontrol)(struct mtd_info *mtd, int cmd);
596 int (*dev_ready)(struct mtd_info *mtd);
597 void (*select_chip)(struct mtd_info *mtd, int chip);
598 void (*cmd_ctrl)(struct mtd_info *mtd, int dat,
599 unsigned int ctrl);
600 void *priv;
601};
602
603/**
604 * struct platform_nand_data - container structure for platform-specific data
605 * @chip: chip level chip structure
606 * @ctrl: controller level device structure
607 */
608struct platform_nand_data {
609 struct platform_nand_chip chip;
610 struct platform_nand_ctrl ctrl;
611};
612
613/* Some helpers to access the data structures */
614static inline
615struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
616{
617 struct nand_chip *chip = mtd->priv;
618
619 return chip->priv;
620}
621
Simon Schwarz82645f82011-10-31 06:34:44 +0000622/* Standard NAND functions from nand_base.c */
623void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len);
624void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len);
625void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len);
626void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len);
627uint8_t nand_read_byte(struct mtd_info *mtd);
628
wdenke2211742002-11-02 23:30:20 +0000629#endif /* __LINUX_MTD_NAND_H */