nand.h 19.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/*
 *  linux/include/linux/mtd/nand.h
 *
4
 *  Copyright (c) 2000 David Woodhouse <dwmw2@infradead.org>
L
Linus Torvalds 已提交
5 6 7 8 9 10 11
 *                     Steven J. Hill <sjhill@realitydiluted.com>
 *		       Thomas Gleixner <tglx@linutronix.de>
 *
 * 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
L
Linus Torvalds 已提交
14
 *
15 16
 * Changelog:
 *	See git changelog.
L
Linus Torvalds 已提交
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>
A
Alessandro Rubini 已提交
25
#include <linux/mtd/bbm.h>
L
Linus Torvalds 已提交
26 27 28 29

struct mtd_info;
/* Scan and identify a NAND device */
extern int nand_scan (struct mtd_info *mtd, int max_chips);
30 31 32 33 34
/* Separate phases of nand_scan(), allowing board driver to intervene
 * and override command or ECC setup according to flash type */
extern int nand_scan_ident(struct mtd_info *mtd, int max_chips);
extern int nand_scan_tail(struct mtd_info *mtd);

L
Linus Torvalds 已提交
35 36 37
/* Free resources held by the NAND device */
extern void nand_release (struct mtd_info *mtd);

38 39 40
/* Internal helper for board drivers which need to override command function */
extern void nand_wait_ready(struct mtd_info *mtd);

41 42 43 44 45 46
/* locks all blockes present in the device */
extern int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);

/* unlocks specified locked blockes */
extern int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);

L
Linus Torvalds 已提交
47 48 49 50 51 52 53
/* The maximum number of NAND chips in an array */
#define NAND_MAX_CHIPS		8

/* This constant declares the max. oobsize / page, which
 * is supported now. If you add a chip with bigger oobsize/page
 * adjust this accordingly.
 */
54 55
#define NAND_MAX_OOBSIZE	128
#define NAND_MAX_PAGESIZE	4096
L
Linus Torvalds 已提交
56 57 58

/*
 * Constants for hardware specific CLE/ALE/NCE function
59 60 61 62
 *
 * These are bits which can be or'ed to set/clear multiple
 * bits in one go.
 */
L
Linus Torvalds 已提交
63
/* Select the chip by setting nCE to low */
64
#define NAND_NCE		0x01
L
Linus Torvalds 已提交
65
/* Select the command latch by setting CLE to high */
66
#define NAND_CLE		0x02
L
Linus Torvalds 已提交
67
/* Select the address latch by setting ALE to high */
68 69 70 71 72
#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
L
Linus Torvalds 已提交
73 74 75 76 77 78

/*
 * Standard NAND flash commands
 */
#define NAND_CMD_READ0		0
#define NAND_CMD_READ1		1
79
#define NAND_CMD_RNDOUT		5
L
Linus Torvalds 已提交
80 81 82 83 84 85
#define NAND_CMD_PAGEPROG	0x10
#define NAND_CMD_READOOB	0x50
#define NAND_CMD_ERASE1		0x60
#define NAND_CMD_STATUS		0x70
#define NAND_CMD_STATUS_MULTI	0x71
#define NAND_CMD_SEQIN		0x80
86
#define NAND_CMD_RNDIN		0x85
L
Linus Torvalds 已提交
87 88 89 90
#define NAND_CMD_READID		0x90
#define NAND_CMD_ERASE2		0xd0
#define NAND_CMD_RESET		0xff

91 92 93 94
#define NAND_CMD_LOCK		0x2a
#define NAND_CMD_UNLOCK1	0x23
#define NAND_CMD_UNLOCK2	0x24

L
Linus Torvalds 已提交
95 96
/* Extended commands for large page devices */
#define NAND_CMD_READSTART	0x30
97
#define NAND_CMD_RNDOUTSTART	0xE0
L
Linus Torvalds 已提交
98 99
#define NAND_CMD_CACHEDPROG	0x15

100
/* Extended commands for AG-AND device */
101 102
/*
 * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
 *       there is no way to distinguish that from NAND_CMD_READ0
 *       until the remaining sequence of commands has been completed
 *       so add a high order bit and mask it off in the command.
 */
#define NAND_CMD_DEPLETE1	0x100
#define NAND_CMD_DEPLETE2	0x38
#define NAND_CMD_STATUS_MULTI	0x71
#define NAND_CMD_STATUS_ERROR	0x72
/* multi-bank error status (banks 0-3) */
#define NAND_CMD_STATUS_ERROR0	0x73
#define NAND_CMD_STATUS_ERROR1	0x74
#define NAND_CMD_STATUS_ERROR2	0x75
#define NAND_CMD_STATUS_ERROR3	0x76
#define NAND_CMD_STATUS_RESET	0x7f
#define NAND_CMD_STATUS_CLEAR	0xff

119 120
#define NAND_CMD_NONE		-1

L
Linus Torvalds 已提交
121 122 123 124 125 126 127
/* 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

128
/*
L
Linus Torvalds 已提交
129 130
 * Constants for ECC_MODES
 */
T
Thomas Gleixner 已提交
131 132 133 134 135
typedef enum {
	NAND_ECC_NONE,
	NAND_ECC_SOFT,
	NAND_ECC_HW,
	NAND_ECC_HW_SYNDROME,
136
	NAND_ECC_HW_OOB_FIRST,
T
Thomas Gleixner 已提交
137
} nand_ecc_modes_t;
L
Linus Torvalds 已提交
138 139 140

/*
 * Constants for Hardware ECC
141
 */
L
Linus Torvalds 已提交
142 143 144 145 146 147 148
/* Reset Hardware ECC for read */
#define NAND_ECC_READ		0
/* Reset Hardware ECC for write */
#define NAND_ECC_WRITE		1
/* Enable Hardware ECC before syndrom is read back from flash */
#define NAND_ECC_READSYN	2

149 150 151 152
/* Bit mask for flags passed to do_nand_read_ecc */
#define NAND_GET_DEVICE		0x80


L
Linus Torvalds 已提交
153 154 155 156 157 158 159 160 161 162 163 164 165
/* Option constants for bizarre disfunctionality and real
*  features
*/
/* Chip can not auto increment pages */
#define NAND_NO_AUTOINCR	0x00000001
/* Buswitdh is 16 bit */
#define NAND_BUSWIDTH_16	0x00000002
/* Device supports partial programming without padding */
#define NAND_NO_PADDING		0x00000004
/* Chip has cache program function */
#define NAND_CACHEPRG		0x00000008
/* Chip has copy back function */
#define NAND_COPYBACK		0x00000010
166
/* AND Chip which has 4 banks and a confusing page / block
L
Linus Torvalds 已提交
167 168 169 170
 * assignment. See Renesas datasheet for further information */
#define NAND_IS_AND		0x00000020
/* Chip has a array of 4 pages which can be read without
 * additional ready /busy waits */
171
#define NAND_4PAGE_ARRAY	0x00000040
172 173 174 175
/* Chip requires that BBT is periodically rewritten to prevent
 * bits from adjacent blocks from 'leaking' in altering data.
 * This happens with the Renesas AG-AND chips, possibly others.  */
#define BBT_AUTO_REFRESH	0x00000080
176 177 178 179
/* Chip does not require ready check on read. True
 * for all large page devices, as they do not support
 * autoincrement.*/
#define NAND_NO_READRDY		0x00000100
180 181 182
/* Chip does not allow subpage writes */
#define NAND_NO_SUBPAGE_WRITE	0x00000200

L
Linus Torvalds 已提交
183 184 185 186 187 188 189 190 191
/* Options valid for Samsung large page devices */
#define NAND_SAMSUNG_LP_OPTIONS \
	(NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)

/* Macros to identify the above */
#define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
#define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
#define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
#define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
192 193 194
/* Large page NAND with SOFT_ECC should support subpage reads */
#define NAND_SUBPAGE_READ(chip) ((chip->ecc.mode == NAND_ECC_SOFT) \
					&& (chip->page_shift > 9))
L
Linus Torvalds 已提交
195 196 197 198 199 200 201 202

/* Mask to zero out the chip options, which come from the id table */
#define NAND_CHIPOPTIONS_MSK	(0x0000ffff & ~NAND_NO_AUTOINCR)

/* Non chip related options */
/* Use a flash based bad block table. This option is passed to the
 * default bad block table function. */
#define NAND_USE_FLASH_BBT	0x00010000
203
/* This option skips the bbt scan during initialization. */
204
#define NAND_SKIP_BBTSCAN	0x00020000
205 206 207
/* This option is defined if the board driver allocates its own buffers
   (e.g. because it needs them DMA-coherent */
#define NAND_OWN_BUFFERS	0x00040000
208 209 210
/* Chip may not exist, so silence any errors in scan */
#define NAND_SCAN_SILENT_NODEV	0x00080000

L
Linus Torvalds 已提交
211
/* Options set by nand scan */
T
Thomas Gleixner 已提交
212
/* Nand scan has allocated controller struct */
213
#define NAND_CONTROLLER_ALLOC	0x80000000
L
Linus Torvalds 已提交
214

215 216 217
/* Cell info constants */
#define NAND_CI_CHIPNR_MSK	0x03
#define NAND_CI_CELLTYPE_MSK	0x0C
L
Linus Torvalds 已提交
218 219 220 221 222

/* Keep gcc happy */
struct nand_chip;

/**
R
Randy Dunlap 已提交
223
 * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
224
 * @lock:               protection lock
L
Linus Torvalds 已提交
225
 * @active:		the mtd device which holds the controller currently
226 227
 * @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
L
Linus Torvalds 已提交
228 229 230 231
 */
struct nand_hw_control {
	spinlock_t	 lock;
	struct nand_chip *active;
232
	wait_queue_head_t wq;
L
Linus Torvalds 已提交
233 234
};

T
Thomas Gleixner 已提交
235 236 237 238 239 240
/**
 * 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
241 242 243
 * @total:	total number of ecc bytes per page
 * @prepad:	padding information for syndrome based ecc generators
 * @postpad:	padding information for syndrome based ecc generators
R
Randy Dunlap 已提交
244
 * @layout:	ECC layout control struct pointer
T
Thomas Gleixner 已提交
245 246 247 248
 * @hwctl:	function to control hardware ecc generator. Must only
 *		be provided if an hardware ECC is available
 * @calculate:	function for ecc calculation or readback from ecc hardware
 * @correct:	function for ecc correction, matching to ecc generator (sw/hw)
249 250
 * @read_page_raw:	function to read a raw page without ECC
 * @write_page_raw:	function to write a raw page without ECC
251
 * @read_page:	function to read a page according to the ecc generator requirements
252
 * @read_subpage:	function to read parts of the page covered by ECC.
253
 * @write_page:	function to write a page according to the ecc generator requirements
R
Randy Dunlap 已提交
254 255
 * @read_oob:	function to read chip OOB data
 * @write_oob:	function to write chip OOB data
T
Thomas Gleixner 已提交
256 257 258 259 260 261
 */
struct nand_ecc_ctrl {
	nand_ecc_modes_t	mode;
	int			steps;
	int			size;
	int			bytes;
262 263 264
	int			total;
	int			prepad;
	int			postpad;
265
	struct nand_ecclayout	*layout;
266
	void			(*hwctl)(struct mtd_info *mtd, int mode);
T
Thomas Gleixner 已提交
267 268 269 270 271 272
	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);
273 274
	int			(*read_page_raw)(struct mtd_info *mtd,
						 struct nand_chip *chip,
275
						 uint8_t *buf, int page);
276 277 278
	void			(*write_page_raw)(struct mtd_info *mtd,
						  struct nand_chip *chip,
						  const uint8_t *buf);
279 280
	int			(*read_page)(struct mtd_info *mtd,
					     struct nand_chip *chip,
281
					     uint8_t *buf, int page);
282 283 284 285
	int			(*read_subpage)(struct mtd_info *mtd,
					     struct nand_chip *chip,
					     uint32_t offs, uint32_t len,
					     uint8_t *buf);
286
	void			(*write_page)(struct mtd_info *mtd,
287
					      struct nand_chip *chip,
288
					      const uint8_t *buf);
289 290 291 292 293 294 295
	int			(*read_oob)(struct mtd_info *mtd,
					    struct nand_chip *chip,
					    int page,
					    int sndcmd);
	int			(*write_oob)(struct mtd_info *mtd,
					     struct nand_chip *chip,
					     int page);
296 297 298 299 300 301 302 303 304 305 306 307 308 309
};

/**
 * struct nand_buffers - buffer structure for read/write
 * @ecccalc:	buffer for calculated ecc
 * @ecccode:	buffer for ecc read from flash
 * @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];
310
	uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
T
Thomas Gleixner 已提交
311 312
};

L
Linus Torvalds 已提交
313 314
/**
 * struct nand_chip - NAND Private Flash Chip Data
315 316
 * @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
L
Linus Torvalds 已提交
317 318 319 320 321 322 323 324
 * @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
 * @verify_buf:		[REPLACEABLE] verify buffer contents against the chip data
 * @select_chip:	[REPLACEABLE] select chip nr
 * @block_bad:		[REPLACEABLE] check, if the block is bad
 * @block_markbad:	[REPLACEABLE] mark the block bad
325 326
 * @cmd_ctrl:		[BOARDSPECIFIC] hardwarespecific funtion for controlling
 *			ALE/CLE/nCE. Also used to write command and address
L
Linus Torvalds 已提交
327 328 329 330 331
 * @dev_ready:		[BOARDSPECIFIC] hardwarespecific function for accesing 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
T
Thomas Gleixner 已提交
332
 * @ecc:		[BOARDSPECIFIC] ecc control ctructure
R
Randy Dunlap 已提交
333 334 335
 * @buffers:		buffer structure for read/write
 * @hwcontrol:		platform-specific hardware control structure
 * @ops:		oob operation operands
L
Linus Torvalds 已提交
336 337 338
 * @erase_cmd:		[INTERN] erase command write function, selectable due to AND support
 * @scan_bbt:		[REPLACEABLE] function to scan bad block table
 * @chip_delay:		[BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR)
339
 * @state:		[INTERN] the current state of the NAND device
R
Randy Dunlap 已提交
340
 * @oob_poi:		poison value buffer
L
Linus Torvalds 已提交
341 342 343 344 345 346 347
 * @page_shift:		[INTERN] number of address bits in a page (column address bits)
 * @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
 * @options:		[BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about
 *			special functionality. See the defines for further explanation
 * @badblockpos:	[INTERN] position of the bad block marker in the oob area
348
 * @cellinfo:		[INTERN] MLC/multichip data from chip ident
L
Linus Torvalds 已提交
349 350 351 352
 * @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
 * @pagebuf:		[INTERN] holds the pagenumber which is currently in data_buf
353
 * @subpagesize:	[INTERN] holds the subpagesize
354
 * @ecclayout:		[REPLACEABLE] the default ecc placement scheme
L
Linus Torvalds 已提交
355 356 357
 * @bbt:		[INTERN] bad block table pointer
 * @bbt_td:		[REPLACEABLE] bad block table descriptor for flash lookup
 * @bbt_md:		[REPLACEABLE] bad block table mirror descriptor
358
 * @badblock_pattern:	[REPLACEABLE] bad block scan pattern used for initial bad block scan
T
Thomas Gleixner 已提交
359 360
 * @controller:		[REPLACEABLE] a pointer to a hardware controller structure
 *			which is shared among multiple independend devices
L
Linus Torvalds 已提交
361
 * @priv:		[OPTIONAL] pointer to private chip date
362
 * @errstat:		[OPTIONAL] hardware specific function to perform additional error status checks
363
 *			(determine if errors are correctable)
364
 * @write_page:		[REPLACEABLE] High-level page write function
L
Linus Torvalds 已提交
365
 */
366

L
Linus Torvalds 已提交
367 368
struct nand_chip {
	void  __iomem	*IO_ADDR_R;
369
	void  __iomem	*IO_ADDR_W;
370

371
	uint8_t		(*read_byte)(struct mtd_info *mtd);
L
Linus Torvalds 已提交
372
	u16		(*read_word)(struct mtd_info *mtd);
373 374 375
	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);
	int		(*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
L
Linus Torvalds 已提交
376 377 378
	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);
379 380
	void		(*cmd_ctrl)(struct mtd_info *mtd, int dat,
				    unsigned int ctrl);
381 382
	int		(*dev_ready)(struct mtd_info *mtd);
	void		(*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr);
383
	int		(*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
L
Linus Torvalds 已提交
384 385
	void		(*erase_cmd)(struct mtd_info *mtd, int page);
	int		(*scan_bbt)(struct mtd_info *mtd);
386
	int		(*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page);
387 388
	int		(*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
				      const uint8_t *buf, int page, int cached, int raw);
389

390
	int		chip_delay;
391 392
	unsigned int	options;

393
	int		page_shift;
L
Linus Torvalds 已提交
394 395 396 397
	int		phys_erase_shift;
	int		bbt_erase_shift;
	int		chip_shift;
	int		numchips;
398
	uint64_t	chipsize;
L
Linus Torvalds 已提交
399 400
	int		pagemask;
	int		pagebuf;
401 402
	int		subpagesize;
	uint8_t		cellinfo;
403
	int		badblockpos;
404
	int		badblockbits;
405

406
	flstate_t	state;
407 408 409

	uint8_t		*oob_poi;
	struct nand_hw_control  *controller;
410
	struct nand_ecclayout	*ecclayout;
411 412

	struct nand_ecc_ctrl ecc;
413
	struct nand_buffers *buffers;
414 415
	struct nand_hw_control hwcontrol;

416 417
	struct mtd_oob_ops ops;

L
Linus Torvalds 已提交
418 419 420
	uint8_t		*bbt;
	struct nand_bbt_descr	*bbt_td;
	struct nand_bbt_descr	*bbt_md;
421

L
Linus Torvalds 已提交
422
	struct nand_bbt_descr	*badblock_pattern;
423

L
Linus Torvalds 已提交
424 425 426 427 428 429 430 431 432 433 434 435
	void		*priv;
};

/*
 * 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
436
#define NAND_MFR_HYNIX		0xad
437
#define NAND_MFR_MICRON		0x2c
438
#define NAND_MFR_AMD		0x01
L
Linus Torvalds 已提交
439 440 441

/**
 * struct nand_flash_dev - NAND Flash Device ID Structure
442 443 444
 * @name:	Identify the device type
 * @id:		device ID code
 * @pagesize:	Pagesize in bytes. Either 256 or 512 or 0
445
 *		If the pagesize is 0, then the real pagesize
L
Linus Torvalds 已提交
446 447
 *		and the eraseize are determined from the
 *		extended id bytes in the chip
448 449
 * @erasesize:	Size of an erase block in the flash device.
 * @chipsize:	Total chipsize in Mega Bytes
L
Linus Torvalds 已提交
450 451 452 453 454 455 456 457 458 459 460 461 462 463
 * @options:	Bitfield to store chip relevant options
 */
struct nand_flash_dev {
	char *name;
	int id;
	unsigned long pagesize;
	unsigned long chipsize;
	unsigned long erasesize;
	unsigned long options;
};

/**
 * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
 * @name:	Manufacturer name
464
 * @id:		manufacturer ID code of device.
L
Linus Torvalds 已提交
465 466 467 468 469 470 471 472 473
*/
struct nand_manufacturers {
	int id;
	char * name;
};

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

474 475 476 477 478 479 480 481
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,
			size_t * retlen, uint8_t * buf);
L
Linus Torvalds 已提交
482

483 484 485
/**
 * struct platform_nand_chip - chip level device structure
 * @nr_chips:		max. number of chips to scan for
R
Randy Dunlap 已提交
486
 * @chip_offset:	chip number offset
487
 * @nr_partitions:	number of partitions pointed to by partitions (or zero)
488 489 490
 * @partitions:		mtd partition list
 * @chip_delay:		R/B delay value in us
 * @options:		Option flags, e.g. 16bit buswidth
491
 * @ecclayout:		ecc layout info structure
492
 * @part_probe_types:	NULL-terminated array of probe types
493
 * @set_parts:		platform specific function to set partitions
494 495 496 497 498 499 500
 * @priv:		hardware controller specific settings
 */
struct platform_nand_chip {
	int			nr_chips;
	int			chip_offset;
	int			nr_partitions;
	struct mtd_partition	*partitions;
501
	struct nand_ecclayout	*ecclayout;
502
	int			chip_delay;
503
	unsigned int		options;
504
	const char		**part_probe_types;
505 506
	void			(*set_parts)(uint64_t size,
					struct platform_nand_chip *chip);
507 508 509
	void			*priv;
};

510 511 512
/* Keep gcc happy */
struct platform_device;

513 514
/**
 * struct platform_nand_ctrl - controller level device structure
515 516
 * @probe:		platform specific function to probe/setup hardware
 * @remove:		platform specific function to remove/teardown hardware
517 518 519
 * @hwcontrol:		platform specific hardware control structure
 * @dev_ready:		platform specific function to read ready/busy pin
 * @select_chip:	platform specific chip select function
520 521
 * @cmd_ctrl:		platform specific function for controlling
 *			ALE/CLE/nCE. Also used to write command and address
522 523
 * @write_buf:		platform specific function for write buffer
 * @read_buf:		platform specific function for read buffer
R
Randy Dunlap 已提交
524
 * @priv:		private data to transport driver specific settings
525 526 527 528
 *
 * All fields are optional and depend on the hardware driver requirements
 */
struct platform_nand_ctrl {
529 530
	int		(*probe)(struct platform_device *pdev);
	void		(*remove)(struct platform_device *pdev);
531 532
	void		(*hwcontrol)(struct mtd_info *mtd, int cmd);
	int		(*dev_ready)(struct mtd_info *mtd);
533
	void		(*select_chip)(struct mtd_info *mtd, int chip);
534 535
	void		(*cmd_ctrl)(struct mtd_info *mtd, int dat,
				    unsigned int ctrl);
536 537 538 539
	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);
540 541 542
	void		*priv;
};

543 544 545 546 547 548 549 550 551 552
/**
 * struct platform_nand_data - container structure for platform-specific data
 * @chip:		chip level chip structure
 * @ctrl:		controller level device structure
 */
struct platform_nand_data {
	struct platform_nand_chip	chip;
	struct platform_nand_ctrl	ctrl;
};

553 554 555 556 557 558 559 560 561
/* 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;
}

L
Linus Torvalds 已提交
562
#endif /* __LINUX_MTD_NAND_H */