nand.h 23.7 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
3
/*
 *  linux/include/linux/mtd/nand.h
 *
4
5
6
 *  Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
 *                        Steven J. Hill <sjhill@realitydiluted.com>
 *		          Thomas Gleixner <tglx@linutronix.de>
Linus Torvalds's avatar
Linus Torvalds committed
7
8
9
10
11
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
12
13
 * Info:
 *	Contains standard defines and IDs for NAND flash devices
Linus Torvalds's avatar
Linus Torvalds committed
14
 *
15
16
 * Changelog:
 *	See git changelog.
Linus Torvalds's avatar
Linus Torvalds committed
17
18
19
20
21
22
23
 */
#ifndef __LINUX_MTD_NAND_H
#define __LINUX_MTD_NAND_H

#include <linux/wait.h>
#include <linux/spinlock.h>
#include <linux/mtd/mtd.h>
24
#include <linux/mtd/flashchip.h>
Alessandro Rubini's avatar
Alessandro Rubini committed
25
#include <linux/mtd/bbm.h>
Linus Torvalds's avatar
Linus Torvalds committed
26
27

struct mtd_info;
28
struct nand_flash_dev;
Linus Torvalds's avatar
Linus Torvalds committed
29
/* Scan and identify a NAND device */
30
31
32
33
34
extern int nand_scan(struct mtd_info *mtd, int max_chips);
/*
 * Separate phases of nand_scan(), allowing board driver to intervene
 * and override command or ECC setup according to flash type.
 */
35
36
extern int nand_scan_ident(struct mtd_info *mtd, int max_chips,
			   struct nand_flash_dev *table);
37
38
extern int nand_scan_tail(struct mtd_info *mtd);

Linus Torvalds's avatar
Linus Torvalds committed
39
/* Free resources held by the NAND device */
40
extern void nand_release(struct mtd_info *mtd);
Linus Torvalds's avatar
Linus Torvalds committed
41

42
43
44
/* Internal helper for board drivers which need to override command function */
extern void nand_wait_ready(struct mtd_info *mtd);

45
/* locks all blocks present in the device */
46
47
extern int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);

48
/* unlocks specified locked blocks */
49
50
extern int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);

Linus Torvalds's avatar
Linus Torvalds committed
51
52
53
/* The maximum number of NAND chips in an array */
#define NAND_MAX_CHIPS		8

54
55
/*
 * This constant declares the max. oobsize / page, which
Linus Torvalds's avatar
Linus Torvalds committed
56
57
58
 * is supported now. If you add a chip with bigger oobsize/page
 * adjust this accordingly.
 */
59
#define NAND_MAX_OOBSIZE	640
60
#define NAND_MAX_PAGESIZE	8192
Linus Torvalds's avatar
Linus Torvalds committed
61
62
63

/*
 * Constants for hardware specific CLE/ALE/NCE function
64
65
66
67
 *
 * These are bits which can be or'ed to set/clear multiple
 * bits in one go.
 */
Linus Torvalds's avatar
Linus Torvalds committed
68
/* Select the chip by setting nCE to low */
69
#define NAND_NCE		0x01
Linus Torvalds's avatar
Linus Torvalds committed
70
/* Select the command latch by setting CLE to high */
71
#define NAND_CLE		0x02
Linus Torvalds's avatar
Linus Torvalds committed
72
/* Select the address latch by setting ALE to high */
73
74
75
76
77
#define NAND_ALE		0x04

#define NAND_CTRL_CLE		(NAND_NCE | NAND_CLE)
#define NAND_CTRL_ALE		(NAND_NCE | NAND_ALE)
#define NAND_CTRL_CHANGE	0x80
Linus Torvalds's avatar
Linus Torvalds committed
78
79
80
81
82
83

/*
 * Standard NAND flash commands
 */
#define NAND_CMD_READ0		0
#define NAND_CMD_READ1		1
84
#define NAND_CMD_RNDOUT		5
Linus Torvalds's avatar
Linus Torvalds committed
85
86
87
88
89
#define NAND_CMD_PAGEPROG	0x10
#define NAND_CMD_READOOB	0x50
#define NAND_CMD_ERASE1		0x60
#define NAND_CMD_STATUS		0x70
#define NAND_CMD_SEQIN		0x80
90
#define NAND_CMD_RNDIN		0x85
Linus Torvalds's avatar
Linus Torvalds committed
91
92
#define NAND_CMD_READID		0x90
#define NAND_CMD_ERASE2		0xd0
93
#define NAND_CMD_PARAM		0xec
94
95
#define NAND_CMD_GET_FEATURES	0xee
#define NAND_CMD_SET_FEATURES	0xef
Linus Torvalds's avatar
Linus Torvalds committed
96
97
#define NAND_CMD_RESET		0xff

98
99
100
101
#define NAND_CMD_LOCK		0x2a
#define NAND_CMD_UNLOCK1	0x23
#define NAND_CMD_UNLOCK2	0x24

Linus Torvalds's avatar
Linus Torvalds committed
102
103
/* Extended commands for large page devices */
#define NAND_CMD_READSTART	0x30
104
#define NAND_CMD_RNDOUTSTART	0xE0
Linus Torvalds's avatar
Linus Torvalds committed
105
106
#define NAND_CMD_CACHEDPROG	0x15

107
108
#define NAND_CMD_NONE		-1

Linus Torvalds's avatar
Linus Torvalds committed
109
110
111
112
113
114
115
/* Status bits */
#define NAND_STATUS_FAIL	0x01
#define NAND_STATUS_FAIL_N1	0x02
#define NAND_STATUS_TRUE_READY	0x20
#define NAND_STATUS_READY	0x40
#define NAND_STATUS_WP		0x80

116
/*
Linus Torvalds's avatar
Linus Torvalds committed
117
118
 * Constants for ECC_MODES
 */
Thomas Gleixner's avatar
Thomas Gleixner committed
119
120
121
122
123
typedef enum {
	NAND_ECC_NONE,
	NAND_ECC_SOFT,
	NAND_ECC_HW,
	NAND_ECC_HW_SYNDROME,
124
	NAND_ECC_HW_OOB_FIRST,
125
	NAND_ECC_SOFT_BCH,
Thomas Gleixner's avatar
Thomas Gleixner committed
126
} nand_ecc_modes_t;
Linus Torvalds's avatar
Linus Torvalds committed
127
128
129

/*
 * Constants for Hardware ECC
130
 */
Linus Torvalds's avatar
Linus Torvalds committed
131
132
133
134
/* Reset Hardware ECC for read */
#define NAND_ECC_READ		0
/* Reset Hardware ECC for write */
#define NAND_ECC_WRITE		1
135
/* Enable Hardware ECC before syndrome is read back from flash */
Linus Torvalds's avatar
Linus Torvalds committed
136
137
#define NAND_ECC_READSYN	2

138
139
140
141
/* Bit mask for flags passed to do_nand_read_ecc */
#define NAND_GET_DEVICE		0x80


142
143
144
145
/*
 * Option constants for bizarre disfunctionality and real
 * features.
 */
146
/* Buswidth is 16 bit */
Linus Torvalds's avatar
Linus Torvalds committed
147
148
149
#define NAND_BUSWIDTH_16	0x00000002
/* Chip has cache program function */
#define NAND_CACHEPRG		0x00000008
150
151
152
153
154
155
156
/*
 * Chip requires ready check on read (for auto-incremented sequential read).
 * True only for small page devices; large page devices do not support
 * autoincrement.
 */
#define NAND_NEED_READRDY	0x00000100

157
158
159
/* Chip does not allow subpage writes */
#define NAND_NO_SUBPAGE_WRITE	0x00000200

160
161
162
163
164
165
/* Device is one of 'new' xD cards that expose fake nand command set */
#define NAND_BROKEN_XD		0x00000400

/* Device behaves just like nand, but is readonly */
#define NAND_ROM		0x00000800

166
167
168
/* Device supports subpage reads */
#define NAND_SUBPAGE_READ	0x00001000

Linus Torvalds's avatar
Linus Torvalds committed
169
/* Options valid for Samsung large page devices */
170
#define NAND_SAMSUNG_LP_OPTIONS NAND_CACHEPRG
Linus Torvalds's avatar
Linus Torvalds committed
171
172
173

/* Macros to identify the above */
#define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
174
#define NAND_HAS_SUBPAGE_READ(chip) ((chip->options & NAND_SUBPAGE_READ))
Linus Torvalds's avatar
Linus Torvalds committed
175
176

/* Non chip related options */
177
/* This option skips the bbt scan during initialization. */
178
#define NAND_SKIP_BBTSCAN	0x00010000
179
180
181
182
/*
 * This option is defined if the board driver allocates its own buffers
 * (e.g. because it needs them DMA-coherent).
 */
183
#define NAND_OWN_BUFFERS	0x00020000
184
/* Chip may not exist, so silence any errors in scan */
185
#define NAND_SCAN_SILENT_NODEV	0x00040000
186
187
188
189
190
191
192
/*
 * Autodetect nand buswidth with readid/onfi.
 * This suppose the driver will configure the hardware in 8 bits mode
 * when calling nand_scan_ident, and update its configuration
 * before calling nand_scan_tail.
 */
#define NAND_BUSWIDTH_AUTO      0x00080000
193

Linus Torvalds's avatar
Linus Torvalds committed
194
/* Options set by nand scan */
Thomas Gleixner's avatar
Thomas Gleixner committed
195
/* Nand scan has allocated controller struct */
196
#define NAND_CONTROLLER_ALLOC	0x80000000
Linus Torvalds's avatar
Linus Torvalds committed
197

198
199
200
/* Cell info constants */
#define NAND_CI_CHIPNR_MSK	0x03
#define NAND_CI_CELLTYPE_MSK	0x0C
Linus Torvalds's avatar
Linus Torvalds committed
201
202
203
204

/* Keep gcc happy */
struct nand_chip;

205
206
207
208
209
210
211
212
213
/* ONFI timing mode, used in both asynchronous and synchronous mode */
#define ONFI_TIMING_MODE_0		(1 << 0)
#define ONFI_TIMING_MODE_1		(1 << 1)
#define ONFI_TIMING_MODE_2		(1 << 2)
#define ONFI_TIMING_MODE_3		(1 << 3)
#define ONFI_TIMING_MODE_4		(1 << 4)
#define ONFI_TIMING_MODE_5		(1 << 5)
#define ONFI_TIMING_MODE_UNKNOWN	(1 << 6)

214
215
216
217
218
219
/* ONFI feature address */
#define ONFI_FEATURE_ADDR_TIMING_MODE	0x1

/* ONFI subfeature parameters length */
#define ONFI_SUBFEATURE_PARAM_LEN	4

220
221
struct nand_onfi_params {
	/* rev info and features block */
222
223
224
225
226
227
	/* 'O' 'N' 'F' 'I'  */
	u8 sig[4];
	__le16 revision;
	__le16 features;
	__le16 opt_cmd;
	u8 reserved[22];
228
229

	/* manufacturer information block */
230
231
232
233
234
	char manufacturer[12];
	char model[20];
	u8 jedec_id;
	__le16 date_code;
	u8 reserved2[13];
235
236

	/* memory organization block */
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
	__le32 byte_per_page;
	__le16 spare_bytes_per_page;
	__le32 data_bytes_per_ppage;
	__le16 spare_bytes_per_ppage;
	__le32 pages_per_block;
	__le32 blocks_per_lun;
	u8 lun_count;
	u8 addr_cycles;
	u8 bits_per_cell;
	__le16 bb_per_lun;
	__le16 block_endurance;
	u8 guaranteed_good_blocks;
	__le16 guaranteed_block_endurance;
	u8 programs_per_page;
	u8 ppage_attr;
	u8 ecc_bits;
	u8 interleaved_bits;
	u8 interleaved_ops;
	u8 reserved3[13];
256
257

	/* electrical parameter block */
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
	u8 io_pin_capacitance_max;
	__le16 async_timing_mode;
	__le16 program_cache_timing_mode;
	__le16 t_prog;
	__le16 t_bers;
	__le16 t_r;
	__le16 t_ccs;
	__le16 src_sync_timing_mode;
	__le16 src_ssync_features;
	__le16 clk_pin_capacitance_typ;
	__le16 io_pin_capacitance_typ;
	__le16 input_pin_capacitance_typ;
	u8 input_pin_capacitance_max;
	u8 driver_strenght_support;
	__le16 t_int_r;
	__le16 t_ald;
	u8 reserved4[7];
275
276

	/* vendor */
277
	u8 reserved5[90];
278
279
280
281
282
283

	__le16 crc;
} __attribute__((packed));

#define ONFI_CRC_BASE	0x4F4E

Linus Torvalds's avatar
Linus Torvalds committed
284
/**
285
 * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
286
 * @lock:               protection lock
Linus Torvalds's avatar
Linus Torvalds committed
287
 * @active:		the mtd device which holds the controller currently
288
289
290
 * @wq:			wait queue to sleep on if a NAND operation is in
 *			progress used instead of the per chip wait queue
 *			when a hw controller is available.
Linus Torvalds's avatar
Linus Torvalds committed
291
292
 */
struct nand_hw_control {
293
	spinlock_t lock;
Linus Torvalds's avatar
Linus Torvalds committed
294
	struct nand_chip *active;
295
	wait_queue_head_t wq;
Linus Torvalds's avatar
Linus Torvalds committed
296
297
};

Thomas Gleixner's avatar
Thomas Gleixner committed
298
/**
299
300
301
302
303
 * struct nand_ecc_ctrl - Control structure for ECC
 * @mode:	ECC mode
 * @steps:	number of ECC steps per page
 * @size:	data bytes per ECC step
 * @bytes:	ECC bytes per step
304
 * @strength:	max number of correctible bits per ECC step
305
306
307
 * @total:	total number of ECC bytes per page
 * @prepad:	padding information for syndrome based ECC generators
 * @postpad:	padding information for syndrome based ECC generators
308
 * @layout:	ECC layout control struct pointer
309
310
 * @priv:	pointer to private ECC control data
 * @hwctl:	function to control hardware ECC generator. Must only
Thomas Gleixner's avatar
Thomas Gleixner committed
311
 *		be provided if an hardware ECC is available
312
313
 * @calculate:	function for ECC calculation or readback from ECC hardware
 * @correct:	function for ECC correction, matching to ECC generator (sw/hw)
314
315
 * @read_page_raw:	function to read a raw page without ECC
 * @write_page_raw:	function to write a raw page without ECC
316
 * @read_page:	function to read a page according to the ECC generator
317
318
319
320
 *		requirements; returns maximum number of bitflips corrected in
 *		any single ECC step, 0 if bitflips uncorrectable, -EIO hw error
 * @read_subpage:	function to read parts of the page covered by ECC;
 *			returns same as read_page()
321
 * @write_page:	function to write a page according to the ECC generator
322
 *		requirements.
323
 * @write_oob_raw:	function to write chip OOB data without ECC
324
 * @read_oob_raw:	function to read chip OOB data without ECC
325
326
 * @read_oob:	function to read chip OOB data
 * @write_oob:	function to write chip OOB data
Thomas Gleixner's avatar
Thomas Gleixner committed
327
328
 */
struct nand_ecc_ctrl {
329
330
331
332
333
	nand_ecc_modes_t mode;
	int steps;
	int size;
	int bytes;
	int total;
334
	int strength;
335
336
	int prepad;
	int postpad;
337
	struct nand_ecclayout	*layout;
338
	void *priv;
339
340
341
342
343
344
	void (*hwctl)(struct mtd_info *mtd, int mode);
	int (*calculate)(struct mtd_info *mtd, const uint8_t *dat,
			uint8_t *ecc_code);
	int (*correct)(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc,
			uint8_t *calc_ecc);
	int (*read_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
345
			uint8_t *buf, int oob_required, int page);
346
	int (*write_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
347
			const uint8_t *buf, int oob_required);
348
	int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
349
			uint8_t *buf, int oob_required, int page);
350
351
	int (*read_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
			uint32_t offs, uint32_t len, uint8_t *buf);
352
	int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
353
			const uint8_t *buf, int oob_required);
354
355
	int (*write_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
			int page);
356
	int (*read_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
357
358
			int page);
	int (*read_oob)(struct mtd_info *mtd, struct nand_chip *chip, int page);
359
360
	int (*write_oob)(struct mtd_info *mtd, struct nand_chip *chip,
			int page);
361
362
363
364
};

/**
 * struct nand_buffers - buffer structure for read/write
365
366
 * @ecccalc:	buffer for calculated ECC
 * @ecccode:	buffer for ECC read from flash
367
368
369
370
371
372
373
374
 * @databuf:	buffer for data - dynamically sized
 *
 * Do not change the order of buffers. databuf and oobrbuf must be in
 * consecutive order.
 */
struct nand_buffers {
	uint8_t	ecccalc[NAND_MAX_OOBSIZE];
	uint8_t	ecccode[NAND_MAX_OOBSIZE];
375
	uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
Thomas Gleixner's avatar
Thomas Gleixner committed
376
377
};

Linus Torvalds's avatar
Linus Torvalds committed
378
379
/**
 * struct nand_chip - NAND Private Flash Chip Data
380
381
382
383
 * @IO_ADDR_R:		[BOARDSPECIFIC] address to read the 8 I/O lines of the
 *			flash device
 * @IO_ADDR_W:		[BOARDSPECIFIC] address to write the 8 I/O lines of the
 *			flash device.
Linus Torvalds's avatar
Linus Torvalds committed
384
385
386
387
388
389
390
 * @read_byte:		[REPLACEABLE] read one byte from the chip
 * @read_word:		[REPLACEABLE] read one word from the chip
 * @write_buf:		[REPLACEABLE] write data from the buffer to the chip
 * @read_buf:		[REPLACEABLE] read data from the chip into the buffer
 * @select_chip:	[REPLACEABLE] select chip nr
 * @block_bad:		[REPLACEABLE] check, if the block is bad
 * @block_markbad:	[REPLACEABLE] mark the block bad
Lucas De Marchi's avatar
Lucas De Marchi committed
391
 * @cmd_ctrl:		[BOARDSPECIFIC] hardwarespecific function for controlling
392
 *			ALE/CLE/nCE. Also used to write command and address
Lucas De Marchi's avatar
Lucas De Marchi committed
393
 * @init_size:		[BOARDSPECIFIC] hardwarespecific function for setting
394
395
396
 *			mtd->oobsize, mtd->writesize and so on.
 *			@id_data contains the 8 bytes values of NAND_CMD_READID.
 *			Return with the bus width.
397
 * @dev_ready:		[BOARDSPECIFIC] hardwarespecific function for accessing
398
399
400
401
402
403
404
 *			device ready/busy line. If set to NULL no access to
 *			ready/busy is available and the ready/busy information
 *			is read from the chip status register.
 * @cmdfunc:		[REPLACEABLE] hardwarespecific function for writing
 *			commands to the chip.
 * @waitfunc:		[REPLACEABLE] hardwarespecific function for wait on
 *			ready.
405
 * @ecc:		[BOARDSPECIFIC] ECC control structure
406
407
 * @buffers:		buffer structure for read/write
 * @hwcontrol:		platform-specific hardware control structure
408
409
 * @erase_cmd:		[INTERN] erase command write function, selectable due
 *			to AND support.
Linus Torvalds's avatar
Linus Torvalds committed
410
 * @scan_bbt:		[REPLACEABLE] function to scan bad block table
Lucas De Marchi's avatar
Lucas De Marchi committed
411
 * @chip_delay:		[BOARDSPECIFIC] chip dependent delay for transferring
412
 *			data from array to read regs (tR).
413
 * @state:		[INTERN] the current state of the NAND device
414
415
 * @oob_poi:		"poison value buffer," used for laying out OOB data
 *			before writing
416
417
 * @page_shift:		[INTERN] number of address bits in a page (column
 *			address bits).
Linus Torvalds's avatar
Linus Torvalds committed
418
419
420
 * @phys_erase_shift:	[INTERN] number of address bits in a physical eraseblock
 * @bbt_erase_shift:	[INTERN] number of address bits in a bbt entry
 * @chip_shift:		[INTERN] number of address bits in one chip
421
422
423
 * @options:		[BOARDSPECIFIC] various chip options. They can partly
 *			be set to inform nand_scan about special functionality.
 *			See the defines for further explanation.
424
425
426
 * @bbt_options:	[INTERN] bad block specific options. All options used
 *			here must come from bbm.h. By default, these options
 *			will be copied to the appropriate nand_bbt_descr's.
427
428
 * @badblockpos:	[INTERN] position of the bad block marker in the oob
 *			area.
429
430
431
 * @badblockbits:	[INTERN] minimum number of set bits in a good block's
 *			bad block marker position; i.e., BBM == 11110111b is
 *			not bad when badblockbits == 7
432
 * @cellinfo:		[INTERN] MLC/multichip data from chip ident
Linus Torvalds's avatar
Linus Torvalds committed
433
434
435
 * @numchips:		[INTERN] number of physical chips
 * @chipsize:		[INTERN] the size of one chip for multichip arrays
 * @pagemask:		[INTERN] page number mask = number of (pages / chip) - 1
436
437
 * @pagebuf:		[INTERN] holds the pagenumber which is currently in
 *			data_buf.
438
439
 * @pagebuf_bitflips:	[INTERN] holds the bitflip count for the page which is
 *			currently in data_buf.
440
 * @subpagesize:	[INTERN] holds the subpagesize
441
442
443
444
 * @onfi_version:	[INTERN] holds the chip ONFI version (BCD encoded),
 *			non 0 if ONFI supported.
 * @onfi_params:	[INTERN] holds the ONFI page parameter when ONFI is
 *			supported, 0 otherwise.
445
446
 * @onfi_set_features:	[REPLACEABLE] set the features for ONFI nand
 * @onfi_get_features:	[REPLACEABLE] get the features for ONFI nand
447
 * @ecclayout:		[REPLACEABLE] the default ECC placement scheme
Linus Torvalds's avatar
Linus Torvalds committed
448
 * @bbt:		[INTERN] bad block table pointer
449
450
 * @bbt_td:		[REPLACEABLE] bad block table descriptor for flash
 *			lookup.
Linus Torvalds's avatar
Linus Torvalds committed
451
 * @bbt_md:		[REPLACEABLE] bad block table mirror descriptor
452
453
454
 * @badblock_pattern:	[REPLACEABLE] bad block scan pattern used for initial
 *			bad block scan.
 * @controller:		[REPLACEABLE] a pointer to a hardware controller
455
 *			structure which is shared among multiple independent
456
 *			devices.
457
 * @priv:		[OPTIONAL] pointer to private chip data
458
459
460
 * @errstat:		[OPTIONAL] hardware specific function to perform
 *			additional error status checks (determine if errors are
 *			correctable).
461
 * @write_page:		[REPLACEABLE] High-level page write function
Linus Torvalds's avatar
Linus Torvalds committed
462
 */
463

Linus Torvalds's avatar
Linus Torvalds committed
464
struct nand_chip {
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
	void __iomem *IO_ADDR_R;
	void __iomem *IO_ADDR_W;

	uint8_t (*read_byte)(struct mtd_info *mtd);
	u16 (*read_word)(struct mtd_info *mtd);
	void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
	void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
	void (*select_chip)(struct mtd_info *mtd, int chip);
	int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
	int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
	void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
	int (*init_size)(struct mtd_info *mtd, struct nand_chip *this,
			u8 *id_data);
	int (*dev_ready)(struct mtd_info *mtd);
	void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column,
			int page_addr);
	int(*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
	void (*erase_cmd)(struct mtd_info *mtd, int page);
	int (*scan_bbt)(struct mtd_info *mtd);
	int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state,
			int status, int page);
	int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
487
488
			const uint8_t *buf, int oob_required, int page,
			int cached, int raw);
489
490
491
492
	int (*onfi_set_features)(struct mtd_info *mtd, struct nand_chip *chip,
			int feature_addr, uint8_t *subfeature_para);
	int (*onfi_get_features)(struct mtd_info *mtd, struct nand_chip *chip,
			int feature_addr, uint8_t *subfeature_para);
493
494
495

	int chip_delay;
	unsigned int options;
496
	unsigned int bbt_options;
497
498
499
500
501
502
503
504
505

	int page_shift;
	int phys_erase_shift;
	int bbt_erase_shift;
	int chip_shift;
	int numchips;
	uint64_t chipsize;
	int pagemask;
	int pagebuf;
506
	unsigned int pagebuf_bitflips;
507
508
509
510
511
512
	int subpagesize;
	uint8_t cellinfo;
	int badblockpos;
	int badblockbits;

	int onfi_version;
513
514
	struct nand_onfi_params	onfi_params;

515
	flstate_t state;
516

517
518
519
	uint8_t *oob_poi;
	struct nand_hw_control *controller;
	struct nand_ecclayout *ecclayout;
520
521

	struct nand_ecc_ctrl ecc;
522
	struct nand_buffers *buffers;
523
524
	struct nand_hw_control hwcontrol;

525
526
527
	uint8_t *bbt;
	struct nand_bbt_descr *bbt_td;
	struct nand_bbt_descr *bbt_md;
528

529
	struct nand_bbt_descr *badblock_pattern;
530

531
	void *priv;
Linus Torvalds's avatar
Linus Torvalds committed
532
533
534
535
536
537
538
539
540
541
542
};

/*
 * NAND Flash Manufacturer ID Codes
 */
#define NAND_MFR_TOSHIBA	0x98
#define NAND_MFR_SAMSUNG	0xec
#define NAND_MFR_FUJITSU	0x04
#define NAND_MFR_NATIONAL	0x8f
#define NAND_MFR_RENESAS	0x07
#define NAND_MFR_STMICRO	0x20
543
#define NAND_MFR_HYNIX		0xad
544
#define NAND_MFR_MICRON		0x2c
545
#define NAND_MFR_AMD		0x01
546
#define NAND_MFR_MACRONIX	0xc2
547
#define NAND_MFR_EON		0x92
Linus Torvalds's avatar
Linus Torvalds committed
548

549
550
551
/* The maximum expected count of bytes in the NAND ID sequence */
#define NAND_MAX_ID_LEN 8

552
553
554
555
556
/*
 * A helper for defining older NAND chips where the second ID byte fully
 * defined the chip, including the geometry (chip size, eraseblock size, page
 * size).
 */
557
558
559
#define LEGACY_ID_NAND(nm, devid, pagesz, chipsz, erasesz, opts)       \
	{ .name = (nm), {{ .dev_id = (devid) }}, .pagesize = (pagesz), \
	  .chipsize = (chipsz), .erasesize = (erasesz),                \
560
561
562
563
564
565
566
567
568
569
570
571
	  .options = (opts) }

/*
 * A helper for defining newer chips which report their page size and
 * eraseblock size via the extended ID bytes.
 *
 * The real difference between LEGACY_ID_NAND and EXTENDED_ID_NAND is that with
 * EXTENDED_ID_NAND, manufacturers overloaded the same device ID so that the
 * device ID now only represented a particular total chip size (and voltage,
 * buswidth), and the page size, eraseblock size, and OOB size could vary while
 * using the same device ID.
 */
572
573
#define EXTENDED_ID_NAND(nm, devid, chipsz, opts)                      \
	{ .name = (nm), {{ .dev_id = (devid) }}, .chipsize = (chipsz), \
574
575
	  .options = (opts) }

Linus Torvalds's avatar
Linus Torvalds committed
576
577
/**
 * struct nand_flash_dev - NAND Flash Device ID Structure
578
579
 * @name: a human-readable name of the NAND chip
 * @dev_id: the device ID (the second byte of the full chip ID array)
580
581
582
583
584
 * @mfr_id: manufecturer ID part of the full chip ID array (refers the same
 *          memory address as @id[0])
 * @dev_id: device ID part of the full chip ID array (refers the same memory
 *          address as @id[1])
 * @id: full device ID array
585
586
587
588
 * @pagesize: size of the NAND page in bytes; if 0, then the real page size (as
 *            well as the eraseblock size) is determined from the extended NAND
 *            chip ID array)
 * @chipsize: total chip size in MiB
589
 * @erasesize: eraseblock size in bytes (determined from the extended ID if 0)
590
 * @options: stores various chip bit options
Linus Torvalds's avatar
Linus Torvalds committed
591
592
593
 */
struct nand_flash_dev {
	char *name;
594
595
596
597
598
	union {
		struct {
			uint8_t mfr_id;
			uint8_t dev_id;
		};
599
		uint8_t id[NAND_MAX_ID_LEN];
600
	};
601
602
603
604
	unsigned int pagesize;
	unsigned int chipsize;
	unsigned int erasesize;
	unsigned int options;
Linus Torvalds's avatar
Linus Torvalds committed
605
606
607
608
609
};

/**
 * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
 * @name:	Manufacturer name
610
 * @id:		manufacturer ID code of device.
Linus Torvalds's avatar
Linus Torvalds committed
611
612
613
*/
struct nand_manufacturers {
	int id;
614
	char *name;
Linus Torvalds's avatar
Linus Torvalds committed
615
616
617
618
619
};

extern struct nand_flash_dev nand_flash_ids[];
extern struct nand_manufacturers nand_manuf_ids[];

620
621
622
623
624
625
626
extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
extern int nand_default_bbt(struct mtd_info *mtd);
extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
			   int allowbbt);
extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
627
			size_t *retlen, uint8_t *buf);
Linus Torvalds's avatar
Linus Torvalds committed
628

629
630
631
/**
 * struct platform_nand_chip - chip level device structure
 * @nr_chips:		max. number of chips to scan for
632
 * @chip_offset:	chip number offset
633
 * @nr_partitions:	number of partitions pointed to by partitions (or zero)
634
635
636
 * @partitions:		mtd partition list
 * @chip_delay:		R/B delay value in us
 * @options:		Option flags, e.g. 16bit buswidth
637
 * @bbt_options:	BBT option flags, e.g. NAND_BBT_USE_FLASH
638
 * @ecclayout:		ECC layout info structure
639
 * @part_probe_types:	NULL-terminated array of probe types
640
641
 */
struct platform_nand_chip {
642
643
644
645
646
647
648
	int nr_chips;
	int chip_offset;
	int nr_partitions;
	struct mtd_partition *partitions;
	struct nand_ecclayout *ecclayout;
	int chip_delay;
	unsigned int options;
649
	unsigned int bbt_options;
650
	const char **part_probe_types;
651
652
};

653
654
655
/* Keep gcc happy */
struct platform_device;

656
657
/**
 * struct platform_nand_ctrl - controller level device structure
658
659
 * @probe:		platform specific function to probe/setup hardware
 * @remove:		platform specific function to remove/teardown hardware
660
661
662
 * @hwcontrol:		platform specific hardware control structure
 * @dev_ready:		platform specific function to read ready/busy pin
 * @select_chip:	platform specific chip select function
663
664
 * @cmd_ctrl:		platform specific function for controlling
 *			ALE/CLE/nCE. Also used to write command and address
665
666
 * @write_buf:		platform specific function for write buffer
 * @read_buf:		platform specific function for read buffer
667
 * @read_byte:		platform specific function to read one byte from chip
668
 * @priv:		private data to transport driver specific settings
669
670
671
672
 *
 * All fields are optional and depend on the hardware driver requirements
 */
struct platform_nand_ctrl {
673
674
675
676
677
678
679
680
	int (*probe)(struct platform_device *pdev);
	void (*remove)(struct platform_device *pdev);
	void (*hwcontrol)(struct mtd_info *mtd, int cmd);
	int (*dev_ready)(struct mtd_info *mtd);
	void (*select_chip)(struct mtd_info *mtd, int chip);
	void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
	void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
	void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
681
	unsigned char (*read_byte)(struct mtd_info *mtd);
682
	void *priv;
683
684
};

685
686
687
688
689
690
/**
 * struct platform_nand_data - container structure for platform-specific data
 * @chip:		chip level chip structure
 * @ctrl:		controller level device structure
 */
struct platform_nand_data {
691
692
	struct platform_nand_chip chip;
	struct platform_nand_ctrl ctrl;
693
694
};

695
696
697
698
699
700
701
702
703
/* Some helpers to access the data structures */
static inline
struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
{
	struct nand_chip *chip = mtd->priv;

	return chip->priv;
}

704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
/* return the supported asynchronous timing mode. */
static inline int onfi_get_async_timing_mode(struct nand_chip *chip)
{
	if (!chip->onfi_version)
		return ONFI_TIMING_MODE_UNKNOWN;
	return le16_to_cpu(chip->onfi_params.async_timing_mode);
}

/* return the supported synchronous timing mode. */
static inline int onfi_get_sync_timing_mode(struct nand_chip *chip)
{
	if (!chip->onfi_version)
		return ONFI_TIMING_MODE_UNKNOWN;
	return le16_to_cpu(chip->onfi_params.src_sync_timing_mode);
}

Linus Torvalds's avatar
Linus Torvalds committed
720
#endif /* __LINUX_MTD_NAND_H */