2002-11-02 23:30:20 +00:00
|
|
|
/*
|
2003-03-26 06:55:25 +00:00
|
|
|
* linux/include/linux/mtd/nand.h
|
2002-11-02 23:30:20 +00:00
|
|
|
*
|
2011-10-12 07:32:02 +00:00
|
|
|
* Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
|
|
|
|
* Steven J. Hill <sjhill@realitydiluted.com>
|
|
|
|
* Thomas Gleixner <tglx@linutronix.de>
|
2002-11-02 23:30:20 +00:00
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
2007-10-31 12:53:06 +00:00
|
|
|
* Info:
|
|
|
|
* Contains standard defines and IDs for NAND flash devices
|
2002-11-02 23:30:20 +00:00
|
|
|
*
|
2007-10-31 12:53:06 +00:00
|
|
|
* Changelog:
|
|
|
|
* See git changelog.
|
2002-11-02 23:30:20 +00:00
|
|
|
*/
|
|
|
|
#ifndef __LINUX_MTD_NAND_H
|
|
|
|
#define __LINUX_MTD_NAND_H
|
|
|
|
|
2007-10-31 12:53:06 +00:00
|
|
|
#include "config.h"
|
|
|
|
|
2012-04-09 13:39:55 +00:00
|
|
|
#include "linux/compat.h"
|
2007-10-31 12:53:06 +00:00
|
|
|
#include "linux/mtd/mtd.h"
|
2008-10-31 21:33:21 +00:00
|
|
|
#include "linux/mtd/bbm.h"
|
2007-10-31 12:53:06 +00:00
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
|
|
|
|
struct mtd_info;
|
2011-01-06 01:48:18 +00:00
|
|
|
struct nand_flash_dev;
|
2006-03-05 17:57:33 +00:00
|
|
|
/* Scan and identify a NAND device */
|
|
|
|
extern int nand_scan (struct mtd_info *mtd, int max_chips);
|
2007-10-31 12:53:06 +00:00
|
|
|
/* Separate phases of nand_scan(), allowing board driver to intervene
|
|
|
|
* and override command or ECC setup according to flash type */
|
2011-01-06 01:48:18 +00:00
|
|
|
extern int nand_scan_ident(struct mtd_info *mtd, int max_chips,
|
|
|
|
const struct nand_flash_dev *table);
|
2007-10-31 12:53:06 +00:00
|
|
|
extern int nand_scan_tail(struct mtd_info *mtd);
|
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
/* Free resources held by the NAND device */
|
2011-10-12 07:32:02 +00:00
|
|
|
extern void nand_release(struct mtd_info *mtd);
|
2006-03-05 17:57:33 +00:00
|
|
|
|
2007-10-31 12:53:06 +00:00
|
|
|
/* Internal helper for board drivers which need to override command function */
|
|
|
|
extern void nand_wait_ready(struct mtd_info *mtd);
|
2006-03-05 17:57:33 +00:00
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
/*
|
|
|
|
* This constant declares the max. oobsize / page, which
|
2006-03-05 17:57:33 +00:00
|
|
|
* is supported now. If you add a chip with bigger oobsize/page
|
|
|
|
* adjust this accordingly.
|
|
|
|
*/
|
2011-10-12 07:32:02 +00:00
|
|
|
#define NAND_MAX_OOBSIZE 576
|
|
|
|
#define NAND_MAX_PAGESIZE 8192
|
2006-03-05 17:57:33 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Constants for hardware specific CLE/ALE/NCE function
|
2007-10-31 12:53:06 +00:00
|
|
|
*
|
|
|
|
* These are bits which can be or'ed to set/clear multiple
|
|
|
|
* bits in one go.
|
|
|
|
*/
|
2006-03-05 17:57:33 +00:00
|
|
|
/* Select the chip by setting nCE to low */
|
2007-10-31 12:53:06 +00:00
|
|
|
#define NAND_NCE 0x01
|
2006-03-05 17:57:33 +00:00
|
|
|
/* Select the command latch by setting CLE to high */
|
2007-10-31 12:53:06 +00:00
|
|
|
#define NAND_CLE 0x02
|
2006-03-05 17:57:33 +00:00
|
|
|
/* Select the address latch by setting ALE to high */
|
2007-10-31 12:53:06 +00:00
|
|
|
#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
|
2006-03-05 17:57:33 +00:00
|
|
|
|
2002-11-02 23:30:20 +00:00
|
|
|
/*
|
|
|
|
* Standard NAND flash commands
|
|
|
|
*/
|
|
|
|
#define NAND_CMD_READ0 0
|
|
|
|
#define NAND_CMD_READ1 1
|
2007-10-31 12:53:06 +00:00
|
|
|
#define NAND_CMD_RNDOUT 5
|
2002-11-02 23:30:20 +00:00
|
|
|
#define NAND_CMD_PAGEPROG 0x10
|
|
|
|
#define NAND_CMD_READOOB 0x50
|
|
|
|
#define NAND_CMD_ERASE1 0x60
|
|
|
|
#define NAND_CMD_STATUS 0x70
|
2006-03-05 17:57:33 +00:00
|
|
|
#define NAND_CMD_STATUS_MULTI 0x71
|
2002-11-02 23:30:20 +00:00
|
|
|
#define NAND_CMD_SEQIN 0x80
|
2007-10-31 12:53:06 +00:00
|
|
|
#define NAND_CMD_RNDIN 0x85
|
2002-11-02 23:30:20 +00:00
|
|
|
#define NAND_CMD_READID 0x90
|
|
|
|
#define NAND_CMD_ERASE2 0xd0
|
2011-10-12 07:32:02 +00:00
|
|
|
#define NAND_CMD_PARAM 0xec
|
2002-11-02 23:30:20 +00:00
|
|
|
#define NAND_CMD_RESET 0xff
|
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
#define NAND_CMD_LOCK 0x2a
|
2012-08-22 21:49:44 +00:00
|
|
|
#define NAND_CMD_LOCK_TIGHT 0x2c
|
2011-10-12 07:32:02 +00:00
|
|
|
#define NAND_CMD_UNLOCK1 0x23
|
|
|
|
#define NAND_CMD_UNLOCK2 0x24
|
2012-08-22 21:49:44 +00:00
|
|
|
#define NAND_CMD_LOCK_STATUS 0x7a
|
2011-10-12 07:32:02 +00:00
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
/* Extended commands for large page devices */
|
|
|
|
#define NAND_CMD_READSTART 0x30
|
2007-10-31 12:53:06 +00:00
|
|
|
#define NAND_CMD_RNDOUTSTART 0xE0
|
2006-03-05 17:57:33 +00:00
|
|
|
#define NAND_CMD_CACHEDPROG 0x15
|
|
|
|
|
2007-10-31 12:53:06 +00:00
|
|
|
/* Extended commands for AG-AND device */
|
|
|
|
/*
|
|
|
|
* Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
|
|
|
|
* 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
|
|
|
|
|
|
|
|
#define NAND_CMD_NONE -1
|
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
/* 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
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Constants for ECC_MODES
|
|
|
|
*/
|
2007-10-31 12:53:06 +00:00
|
|
|
typedef enum {
|
|
|
|
NAND_ECC_NONE,
|
|
|
|
NAND_ECC_SOFT,
|
|
|
|
NAND_ECC_HW,
|
|
|
|
NAND_ECC_HW_SYNDROME,
|
2009-08-10 17:27:56 +00:00
|
|
|
NAND_ECC_HW_OOB_FIRST,
|
2011-10-12 07:31:59 +00:00
|
|
|
NAND_ECC_SOFT_BCH,
|
2007-10-31 12:53:06 +00:00
|
|
|
} nand_ecc_modes_t;
|
2006-03-05 17:57:33 +00:00
|
|
|
|
2003-03-26 06:55:25 +00:00
|
|
|
/*
|
2006-03-05 17:57:33 +00:00
|
|
|
* Constants for Hardware ECC
|
2007-10-31 12:53:06 +00:00
|
|
|
*/
|
2006-03-05 17:57:33 +00:00
|
|
|
/* 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
|
|
|
|
|
2007-10-31 12:53:06 +00:00
|
|
|
/* Bit mask for flags passed to do_nand_read_ecc */
|
|
|
|
#define NAND_GET_DEVICE 0x80
|
|
|
|
|
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
/*
|
|
|
|
* Option constants for bizarre disfunctionality and real
|
|
|
|
* features.
|
|
|
|
*/
|
2006-03-05 17:57:33 +00:00
|
|
|
/* 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
|
2011-10-12 07:32:02 +00:00
|
|
|
/*
|
|
|
|
* AND Chip which has 4 banks and a confusing page / block
|
|
|
|
* assignment. See Renesas datasheet for further information.
|
|
|
|
*/
|
2006-03-05 17:57:33 +00:00
|
|
|
#define NAND_IS_AND 0x00000020
|
2011-10-12 07:32:02 +00:00
|
|
|
/*
|
|
|
|
* Chip has a array of 4 pages which can be read without
|
|
|
|
* additional ready /busy waits.
|
|
|
|
*/
|
2006-03-05 17:57:33 +00:00
|
|
|
#define NAND_4PAGE_ARRAY 0x00000040
|
2011-10-12 07:32:02 +00:00
|
|
|
/*
|
|
|
|
* Chip requires that BBT is periodically rewritten to prevent
|
2007-10-31 12:53:06 +00:00
|
|
|
* bits from adjacent blocks from 'leaking' in altering data.
|
2011-10-12 07:32:02 +00:00
|
|
|
* This happens with the Renesas AG-AND chips, possibly others.
|
|
|
|
*/
|
2007-10-31 12:53:06 +00:00
|
|
|
#define BBT_AUTO_REFRESH 0x00000080
|
2011-10-12 07:32:02 +00:00
|
|
|
/*
|
2013-04-01 18:29:11 +00:00
|
|
|
* Chip does not require ready check on read. true
|
2007-10-31 12:53:06 +00:00
|
|
|
* for all large page devices, as they do not support
|
2011-10-12 07:32:02 +00:00
|
|
|
* autoincrement.
|
|
|
|
*/
|
2007-10-31 12:53:06 +00:00
|
|
|
#define NAND_NO_READRDY 0x00000100
|
|
|
|
/* Chip does not allow subpage writes */
|
|
|
|
#define NAND_NO_SUBPAGE_WRITE 0x00000200
|
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
/* 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
|
2006-03-05 17:57:33 +00:00
|
|
|
|
2012-11-05 06:46:31 +00:00
|
|
|
/* Device supports subpage reads */
|
|
|
|
#define NAND_SUBPAGE_READ 0x00001000
|
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
/* 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))
|
2012-11-05 06:46:31 +00:00
|
|
|
#define NAND_HAS_SUBPAGE_READ(chip) ((chip->options & NAND_SUBPAGE_READ))
|
2006-03-05 17:57:33 +00:00
|
|
|
|
|
|
|
/* Non chip related options */
|
2011-10-12 07:32:02 +00:00
|
|
|
/*
|
|
|
|
* Use a flash based bad block table. OOB identifier is saved in OOB area.
|
|
|
|
* This option is passed to the default bad block table function.
|
|
|
|
*/
|
2006-03-05 17:57:33 +00:00
|
|
|
#define NAND_USE_FLASH_BBT 0x00010000
|
2007-10-31 12:53:06 +00:00
|
|
|
/* This option skips the bbt scan during initialization. */
|
|
|
|
#define NAND_SKIP_BBTSCAN 0x00020000
|
2011-10-12 07:32:02 +00:00
|
|
|
/*
|
|
|
|
* This option is defined if the board driver allocates its own buffers
|
|
|
|
* (e.g. because it needs them DMA-coherent).
|
|
|
|
*/
|
2007-10-31 12:53:06 +00:00
|
|
|
#define NAND_OWN_BUFFERS 0x00040000
|
2011-10-12 07:32:02 +00:00
|
|
|
/* Chip may not exist, so silence any errors in scan */
|
|
|
|
#define NAND_SCAN_SILENT_NODEV 0x00080000
|
|
|
|
/*
|
|
|
|
* If passed additionally to NAND_USE_FLASH_BBT then BBT code will not touch
|
|
|
|
* the OOB area.
|
|
|
|
*/
|
|
|
|
#define NAND_USE_FLASH_BBT_NO_OOB 0x00800000
|
|
|
|
/* Create an empty BBT with no vendor information if the BBT is available */
|
|
|
|
#define NAND_CREATE_EMPTY_BBT 0x01000000
|
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
/* Options set by nand scan */
|
2012-02-20 20:50:39 +00:00
|
|
|
/* bbt has already been read */
|
|
|
|
#define NAND_BBT_SCANNED 0x40000000
|
2007-10-31 12:53:06 +00:00
|
|
|
/* Nand scan has allocated controller struct */
|
|
|
|
#define NAND_CONTROLLER_ALLOC 0x80000000
|
2006-03-05 17:57:33 +00:00
|
|
|
|
2007-10-31 12:53:06 +00:00
|
|
|
/* Cell info constants */
|
|
|
|
#define NAND_CI_CHIPNR_MSK 0x03
|
|
|
|
#define NAND_CI_CELLTYPE_MSK 0x0C
|
2006-03-05 17:57:33 +00:00
|
|
|
|
|
|
|
/* Keep gcc happy */
|
|
|
|
struct nand_chip;
|
2003-03-26 06:55:25 +00:00
|
|
|
|
2011-02-25 00:01:34 +00:00
|
|
|
struct nand_onfi_params {
|
|
|
|
/* rev info and features block */
|
|
|
|
/* 'O' 'N' 'F' 'I' */
|
|
|
|
u8 sig[4];
|
|
|
|
__le16 revision;
|
|
|
|
__le16 features;
|
|
|
|
__le16 opt_cmd;
|
|
|
|
u8 reserved[22];
|
|
|
|
|
|
|
|
/* manufacturer information block */
|
|
|
|
char manufacturer[12];
|
|
|
|
char model[20];
|
|
|
|
u8 jedec_id;
|
|
|
|
__le16 date_code;
|
|
|
|
u8 reserved2[13];
|
|
|
|
|
|
|
|
/* memory organization block */
|
|
|
|
__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];
|
|
|
|
|
|
|
|
/* electrical parameter block */
|
|
|
|
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];
|
|
|
|
|
|
|
|
/* vendor */
|
|
|
|
u8 reserved5[90];
|
|
|
|
|
|
|
|
__le16 crc;
|
|
|
|
} __attribute__((packed));
|
|
|
|
|
|
|
|
#define ONFI_CRC_BASE 0x4F4E
|
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
/**
|
2007-10-31 12:53:06 +00:00
|
|
|
* struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
|
|
|
|
* @lock: protection lock
|
2006-03-05 17:57:33 +00:00
|
|
|
* @active: the mtd device which holds the controller currently
|
2011-10-12 07:32:02 +00:00
|
|
|
* @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.
|
2003-03-26 06:55:25 +00:00
|
|
|
*/
|
2006-03-05 17:57:33 +00:00
|
|
|
struct nand_hw_control {
|
2007-11-09 12:32:30 +00:00
|
|
|
/* XXX U-BOOT XXX */
|
2007-10-31 12:53:06 +00:00
|
|
|
#if 0
|
2007-11-09 12:32:30 +00:00
|
|
|
spinlock_t lock;
|
|
|
|
wait_queue_head_t wq;
|
2006-03-05 17:57:33 +00:00
|
|
|
#endif
|
2007-11-09 12:32:30 +00:00
|
|
|
struct nand_chip *active;
|
2007-10-31 12:53:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
* @total: total number of ecc bytes per page
|
|
|
|
* @prepad: padding information for syndrome based ecc generators
|
|
|
|
* @postpad: padding information for syndrome based ecc generators
|
|
|
|
* @layout: ECC layout control struct pointer
|
2011-10-12 07:32:02 +00:00
|
|
|
* @priv: pointer to private ecc control data
|
2007-10-31 12:53:06 +00:00
|
|
|
* @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)
|
|
|
|
* @read_page_raw: function to read a raw page without ECC
|
|
|
|
* @write_page_raw: function to write a raw page without ECC
|
2011-10-12 07:32:02 +00:00
|
|
|
* @read_page: function to read a page according to the ecc generator
|
|
|
|
* requirements.
|
|
|
|
* @read_subpage: function to read parts of the page covered by ECC.
|
|
|
|
* @write_page: function to write a page according to the ecc generator
|
|
|
|
* requirements.
|
2007-10-31 12:53:06 +00:00
|
|
|
* @read_oob: function to read chip OOB data
|
|
|
|
* @write_oob: function to write chip OOB data
|
|
|
|
*/
|
|
|
|
struct nand_ecc_ctrl {
|
2011-10-12 07:32:02 +00:00
|
|
|
nand_ecc_modes_t mode;
|
|
|
|
int steps;
|
|
|
|
int size;
|
|
|
|
int bytes;
|
|
|
|
int total;
|
|
|
|
int prepad;
|
|
|
|
int postpad;
|
2007-10-31 12:53:06 +00:00
|
|
|
struct nand_ecclayout *layout;
|
2011-10-12 07:32:02 +00:00
|
|
|
void *priv;
|
|
|
|
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,
|
|
|
|
uint8_t *buf, int page);
|
|
|
|
void (*write_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
|
|
|
|
const uint8_t *buf);
|
|
|
|
int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
|
|
|
|
uint8_t *buf, int page);
|
|
|
|
int (*read_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
|
|
|
|
uint32_t offs, uint32_t len, uint8_t *buf);
|
|
|
|
void (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
|
|
|
|
const uint8_t *buf);
|
|
|
|
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);
|
2007-10-31 12:53:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 {
|
2012-07-29 20:53:25 +00:00
|
|
|
uint8_t ecccalc[ALIGN(NAND_MAX_OOBSIZE, ARCH_DMA_MINALIGN)];
|
|
|
|
uint8_t ecccode[ALIGN(NAND_MAX_OOBSIZE, ARCH_DMA_MINALIGN)];
|
|
|
|
uint8_t databuf[ALIGN(NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE,
|
|
|
|
ARCH_DMA_MINALIGN)];
|
2007-10-31 12:53:06 +00:00
|
|
|
};
|
2006-03-05 17:57:33 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* struct nand_chip - NAND Private Flash Chip Data
|
2011-10-12 07:32:02 +00:00
|
|
|
* @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.
|
2006-03-05 17:57:33 +00:00
|
|
|
* @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
|
2011-10-12 07:32:02 +00:00
|
|
|
* @verify_buf: [REPLACEABLE] verify buffer contents against the chip
|
|
|
|
* data.
|
2006-03-05 17:57:33 +00:00
|
|
|
* @select_chip: [REPLACEABLE] select chip nr
|
|
|
|
* @block_bad: [REPLACEABLE] check, if the block is bad
|
|
|
|
* @block_markbad: [REPLACEABLE] mark the block bad
|
2011-10-12 07:32:02 +00:00
|
|
|
* @cmd_ctrl: [BOARDSPECIFIC] hardwarespecific function for controlling
|
2007-10-31 12:53:06 +00:00
|
|
|
* ALE/CLE/nCE. Also used to write command and address
|
2011-10-12 07:32:02 +00:00
|
|
|
* @init_size: [BOARDSPECIFIC] hardwarespecific function for setting
|
|
|
|
* mtd->oobsize, mtd->writesize and so on.
|
|
|
|
* @id_data contains the 8 bytes values of NAND_CMD_READID.
|
|
|
|
* Return with the bus width.
|
|
|
|
* @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.
|
2007-10-31 12:53:06 +00:00
|
|
|
* @ecc: [BOARDSPECIFIC] ecc control ctructure
|
|
|
|
* @buffers: buffer structure for read/write
|
|
|
|
* @hwcontrol: platform-specific hardware control structure
|
|
|
|
* @ops: oob operation operands
|
2011-10-12 07:32:02 +00:00
|
|
|
* @erase_cmd: [INTERN] erase command write function, selectable due
|
|
|
|
* to AND support.
|
2006-03-05 17:57:33 +00:00
|
|
|
* @scan_bbt: [REPLACEABLE] function to scan bad block table
|
2011-10-12 07:32:02 +00:00
|
|
|
* @chip_delay: [BOARDSPECIFIC] chip dependent delay for transferring
|
|
|
|
* data from array to read regs (tR).
|
2006-07-21 09:56:05 +00:00
|
|
|
* @state: [INTERN] the current state of the NAND device
|
2007-10-31 12:53:06 +00:00
|
|
|
* @oob_poi: poison value buffer
|
2011-10-12 07:32:02 +00:00
|
|
|
* @page_shift: [INTERN] number of address bits in a page (column
|
|
|
|
* address bits).
|
2006-03-05 17:57:33 +00:00
|
|
|
* @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
|
2011-10-12 07:32:02 +00:00
|
|
|
* @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.
|
|
|
|
* @badblockbits: [INTERN] number of bits to left-shift the bad block
|
|
|
|
* number
|
2007-10-31 12:53:06 +00:00
|
|
|
* @cellinfo: [INTERN] MLC/multichip data from chip ident
|
2006-03-05 17:57:33 +00:00
|
|
|
* @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
|
2011-10-12 07:32:02 +00:00
|
|
|
* @pagebuf: [INTERN] holds the pagenumber which is currently in
|
|
|
|
* data_buf.
|
2007-10-31 12:53:06 +00:00
|
|
|
* @subpagesize: [INTERN] holds the subpagesize
|
2011-10-12 07:32:02 +00:00
|
|
|
* @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.
|
2007-10-31 12:53:06 +00:00
|
|
|
* @ecclayout: [REPLACEABLE] the default ecc placement scheme
|
2006-03-05 17:57:33 +00:00
|
|
|
* @bbt: [INTERN] bad block table pointer
|
2011-10-12 07:32:02 +00:00
|
|
|
* @bbt_td: [REPLACEABLE] bad block table descriptor for flash
|
|
|
|
* lookup.
|
2006-03-05 17:57:33 +00:00
|
|
|
* @bbt_md: [REPLACEABLE] bad block table mirror descriptor
|
2011-10-12 07:32:02 +00:00
|
|
|
* @badblock_pattern: [REPLACEABLE] bad block scan pattern used for initial
|
|
|
|
* bad block scan.
|
|
|
|
* @controller: [REPLACEABLE] a pointer to a hardware controller
|
|
|
|
* structure which is shared among multiple independend
|
|
|
|
* devices.
|
2006-03-05 17:57:33 +00:00
|
|
|
* @priv: [OPTIONAL] pointer to private chip date
|
2011-10-12 07:32:02 +00:00
|
|
|
* @errstat: [OPTIONAL] hardware specific function to perform
|
|
|
|
* additional error status checks (determine if errors are
|
|
|
|
* correctable).
|
2007-10-31 12:53:06 +00:00
|
|
|
* @write_page: [REPLACEABLE] High-level page write function
|
2006-03-05 17:57:33 +00:00
|
|
|
*/
|
2003-03-26 06:55:25 +00:00
|
|
|
|
|
|
|
struct nand_chip {
|
2011-10-12 07:32:02 +00:00
|
|
|
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);
|
|
|
|
int (*verify_buf)(struct mtd_info *mtd, const 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,
|
|
|
|
const uint8_t *buf, int page, int cached, int raw);
|
|
|
|
|
|
|
|
int chip_delay;
|
|
|
|
unsigned int options;
|
|
|
|
|
|
|
|
int page_shift;
|
|
|
|
int phys_erase_shift;
|
|
|
|
int bbt_erase_shift;
|
|
|
|
int chip_shift;
|
|
|
|
int numchips;
|
|
|
|
uint64_t chipsize;
|
|
|
|
int pagemask;
|
|
|
|
int pagebuf;
|
|
|
|
int subpagesize;
|
|
|
|
uint8_t cellinfo;
|
|
|
|
int badblockpos;
|
|
|
|
int badblockbits;
|
|
|
|
|
|
|
|
int onfi_version;
|
2011-02-25 00:01:34 +00:00
|
|
|
#ifdef CONFIG_SYS_NAND_ONFI_DETECTION
|
|
|
|
struct nand_onfi_params onfi_params;
|
|
|
|
#endif
|
2007-10-31 12:53:06 +00:00
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
int state;
|
2007-10-31 12:53:06 +00:00
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
uint8_t *oob_poi;
|
|
|
|
struct nand_hw_control *controller;
|
|
|
|
struct nand_ecclayout *ecclayout;
|
2007-10-31 12:53:06 +00:00
|
|
|
|
|
|
|
struct nand_ecc_ctrl ecc;
|
|
|
|
struct nand_buffers *buffers;
|
|
|
|
struct nand_hw_control hwcontrol;
|
|
|
|
|
|
|
|
struct mtd_oob_ops ops;
|
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
uint8_t *bbt;
|
|
|
|
struct nand_bbt_descr *bbt_td;
|
|
|
|
struct nand_bbt_descr *bbt_md;
|
2007-10-31 12:53:06 +00:00
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
struct nand_bbt_descr *badblock_pattern;
|
2007-10-31 12:53:06 +00:00
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
void *priv;
|
2003-03-26 06:55:25 +00:00
|
|
|
};
|
|
|
|
|
2002-11-02 23:30:20 +00:00
|
|
|
/*
|
|
|
|
* NAND Flash Manufacturer ID Codes
|
|
|
|
*/
|
|
|
|
#define NAND_MFR_TOSHIBA 0x98
|
|
|
|
#define NAND_MFR_SAMSUNG 0xec
|
2006-03-05 17:57:33 +00:00
|
|
|
#define NAND_MFR_FUJITSU 0x04
|
|
|
|
#define NAND_MFR_NATIONAL 0x8f
|
|
|
|
#define NAND_MFR_RENESAS 0x07
|
|
|
|
#define NAND_MFR_STMICRO 0x20
|
2007-10-31 12:53:06 +00:00
|
|
|
#define NAND_MFR_HYNIX 0xad
|
2007-05-24 10:12:47 +00:00
|
|
|
#define NAND_MFR_MICRON 0x2c
|
2008-10-24 21:20:43 +00:00
|
|
|
#define NAND_MFR_AMD 0x01
|
2002-11-02 23:30:20 +00:00
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
/**
|
|
|
|
* struct nand_flash_dev - NAND Flash Device ID Structure
|
2006-07-21 09:56:05 +00:00
|
|
|
* @name: Identify the device type
|
|
|
|
* @id: device ID code
|
|
|
|
* @pagesize: Pagesize in bytes. Either 256 or 512 or 0
|
2006-03-05 17:57:33 +00:00
|
|
|
* If the pagesize is 0, then the real pagesize
|
|
|
|
* and the eraseize are determined from the
|
|
|
|
* extended id bytes in the chip
|
2006-07-21 09:56:05 +00:00
|
|
|
* @erasesize: Size of an erase block in the flash device.
|
|
|
|
* @chipsize: Total chipsize in Mega Bytes
|
2006-03-05 17:57:33 +00:00
|
|
|
* @options: Bitfield to store chip relevant options
|
2002-11-02 23:30:20 +00:00
|
|
|
*/
|
|
|
|
struct nand_flash_dev {
|
2006-03-05 17:57:33 +00:00
|
|
|
char *name;
|
|
|
|
int id;
|
|
|
|
unsigned long pagesize;
|
|
|
|
unsigned long chipsize;
|
2002-11-02 23:30:20 +00:00
|
|
|
unsigned long erasesize;
|
2006-03-05 17:57:33 +00:00
|
|
|
unsigned long options;
|
2002-11-02 23:30:20 +00:00
|
|
|
};
|
|
|
|
|
2006-03-05 17:57:33 +00:00
|
|
|
/**
|
|
|
|
* struct nand_manufacturers - NAND Flash Manufacturer ID Structure
|
|
|
|
* @name: Manufacturer name
|
2006-07-21 09:56:05 +00:00
|
|
|
* @id: manufacturer ID code of device.
|
2006-03-05 17:57:33 +00:00
|
|
|
*/
|
|
|
|
struct nand_manufacturers {
|
|
|
|
int id;
|
2011-10-12 07:32:02 +00:00
|
|
|
char *name;
|
2006-03-05 17:57:33 +00:00
|
|
|
};
|
|
|
|
|
2010-10-20 01:15:21 +00:00
|
|
|
extern const struct nand_flash_dev nand_flash_ids[];
|
|
|
|
extern const struct nand_manufacturers nand_manuf_ids[];
|
2006-03-05 17:57:33 +00:00
|
|
|
|
2007-10-31 12:53:06 +00:00
|
|
|
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,
|
2011-10-12 07:32:02 +00:00
|
|
|
size_t *retlen, uint8_t *buf);
|
2006-03-05 17:57:33 +00:00
|
|
|
|
2003-03-26 06:55:25 +00:00
|
|
|
/*
|
|
|
|
* Constants for oob configuration
|
|
|
|
*/
|
2006-03-05 17:57:33 +00:00
|
|
|
#define NAND_SMALL_BADBLOCK_POS 5
|
|
|
|
#define NAND_LARGE_BADBLOCK_POS 0
|
|
|
|
|
2007-10-31 12:53:06 +00:00
|
|
|
/**
|
|
|
|
* struct platform_nand_chip - chip level device structure
|
|
|
|
* @nr_chips: max. number of chips to scan for
|
|
|
|
* @chip_offset: chip number offset
|
|
|
|
* @nr_partitions: number of partitions pointed to by partitions (or zero)
|
|
|
|
* @partitions: mtd partition list
|
|
|
|
* @chip_delay: R/B delay value in us
|
|
|
|
* @options: Option flags, e.g. 16bit buswidth
|
|
|
|
* @ecclayout: ecc layout info structure
|
|
|
|
* @part_probe_types: NULL-terminated array of probe types
|
|
|
|
* @priv: hardware controller specific settings
|
|
|
|
*/
|
|
|
|
struct platform_nand_chip {
|
2011-10-12 07:32:02 +00:00
|
|
|
int nr_chips;
|
|
|
|
int chip_offset;
|
|
|
|
int nr_partitions;
|
|
|
|
struct mtd_partition *partitions;
|
|
|
|
struct nand_ecclayout *ecclayout;
|
|
|
|
int chip_delay;
|
|
|
|
unsigned int options;
|
|
|
|
const char **part_probe_types;
|
|
|
|
void *priv;
|
2007-10-31 12:53:06 +00:00
|
|
|
};
|
|
|
|
|
2011-10-12 07:32:02 +00:00
|
|
|
/* Keep gcc happy */
|
|
|
|
struct platform_device;
|
|
|
|
|
2007-10-31 12:53:06 +00:00
|
|
|
/**
|
|
|
|
* struct platform_nand_ctrl - controller level device structure
|
|
|
|
* @hwcontrol: platform specific hardware control structure
|
|
|
|
* @dev_ready: platform specific function to read ready/busy pin
|
|
|
|
* @select_chip: platform specific chip select function
|
|
|
|
* @cmd_ctrl: platform specific function for controlling
|
|
|
|
* ALE/CLE/nCE. Also used to write command and address
|
|
|
|
* @priv: private data to transport driver specific settings
|
|
|
|
*
|
|
|
|
* All fields are optional and depend on the hardware driver requirements
|
|
|
|
*/
|
|
|
|
struct platform_nand_ctrl {
|
2011-10-12 07:32:02 +00:00
|
|
|
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 *priv;
|
2007-10-31 12:53:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct platform_nand_data - container structure for platform-specific data
|
|
|
|
* @chip: chip level chip structure
|
|
|
|
* @ctrl: controller level device structure
|
|
|
|
*/
|
|
|
|
struct platform_nand_data {
|
2011-10-12 07:32:02 +00:00
|
|
|
struct platform_nand_chip chip;
|
|
|
|
struct platform_nand_ctrl ctrl;
|
2007-10-31 12:53:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* 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;
|
|
|
|
}
|
|
|
|
|
2011-10-31 06:34:44 +00:00
|
|
|
/* Standard NAND functions from nand_base.c */
|
|
|
|
void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len);
|
|
|
|
void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len);
|
|
|
|
void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len);
|
|
|
|
void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len);
|
|
|
|
uint8_t nand_read_byte(struct mtd_info *mtd);
|
|
|
|
|
2002-11-02 23:30:20 +00:00
|
|
|
#endif /* __LINUX_MTD_NAND_H */
|