|
|
|
|
@ -2,7 +2,7 @@ |
|
|
|
|
* linux/include/linux/mtd/nand.h |
|
|
|
|
* |
|
|
|
|
* Copyright (c) 2000 David Woodhouse <dwmw2@mvhi.com> |
|
|
|
|
* Steven J. Hill <sjhill@realitydiluted.com> |
|
|
|
|
* Steven J. Hill <sjhill@realitydiluted.com> |
|
|
|
|
* Thomas Gleixner <tglx@linutronix.de> |
|
|
|
|
* |
|
|
|
|
* $Id: nand.h,v 1.68 2004/11/12 10:40:37 gleixner Exp $ |
|
|
|
|
@ -15,15 +15,15 @@ |
|
|
|
|
* Contains standard defines and IDs for NAND flash devices |
|
|
|
|
* |
|
|
|
|
* Changelog: |
|
|
|
|
* 01-31-2000 DMW Created |
|
|
|
|
* 09-18-2000 SJH Moved structure out of the Disk-On-Chip drivers |
|
|
|
|
* 01-31-2000 DMW Created |
|
|
|
|
* 09-18-2000 SJH Moved structure out of the Disk-On-Chip drivers |
|
|
|
|
* so it can be used by other NAND flash device |
|
|
|
|
* drivers. I also changed the copyright since none |
|
|
|
|
* of the original contents of this file are specific |
|
|
|
|
* to DoC devices. David can whack me with a baseball |
|
|
|
|
* bat later if I did something naughty. |
|
|
|
|
* 10-11-2000 SJH Added private NAND flash structure for driver |
|
|
|
|
* 10-24-2000 SJH Added prototype for 'nand_scan' function |
|
|
|
|
* 10-11-2000 SJH Added private NAND flash structure for driver |
|
|
|
|
* 10-24-2000 SJH Added prototype for 'nand_scan' function |
|
|
|
|
* 10-29-2001 TG changed nand_chip structure to support |
|
|
|
|
* hardwarespecific function for accessing control lines |
|
|
|
|
* 02-21-2002 TG added support for different read/write adress and |
|
|
|
|
@ -36,7 +36,7 @@ |
|
|
|
|
* CONFIG_MTD_NAND_ECC_JFFS2 is not set |
|
|
|
|
* 08-10-2002 TG extensions to nand_chip structure to support HW-ECC |
|
|
|
|
* |
|
|
|
|
* 08-29-2002 tglx nand_chip structure: data_poi for selecting |
|
|
|
|
* 08-29-2002 tglx nand_chip structure: data_poi for selecting |
|
|
|
|
* internal / fs-driver buffer |
|
|
|
|
* support for 6byte/512byte hardware ECC |
|
|
|
|
* read_ecc, write_ecc extended for different oob-layout |
|
|
|
|
@ -45,8 +45,8 @@ |
|
|
|
|
* 11-25-2002 tglx Added Manufacturer code FUJITSU, NATIONAL |
|
|
|
|
* Split manufacturer and device ID structures |
|
|
|
|
* |
|
|
|
|
* 02-08-2004 tglx added option field to nand structure for chip anomalities |
|
|
|
|
* 05-25-2004 tglx added bad block table support, ST-MICRO manufacturer id |
|
|
|
|
* 02-08-2004 tglx added option field to nand structure for chip anomalities |
|
|
|
|
* 05-25-2004 tglx added bad block table support, ST-MICRO manufacturer id |
|
|
|
|
* update of nand_chip structure description |
|
|
|
|
*/ |
|
|
|
|
#ifndef __LINUX_MTD_NAND_H |
|
|
|
|
@ -75,7 +75,7 @@ extern int nand_read_raw (struct mtd_info *mtd, uint8_t *buf, loff_t from, size_ |
|
|
|
|
* Constants for hardware specific CLE/ALE/NCE function |
|
|
|
|
*/ |
|
|
|
|
/* Select the chip by setting nCE to low */ |
|
|
|
|
#define NAND_CTL_SETNCE 1 |
|
|
|
|
#define NAND_CTL_SETNCE 1 |
|
|
|
|
/* Deselect the chip by setting nCE to high */ |
|
|
|
|
#define NAND_CTL_CLRNCE 2 |
|
|
|
|
/* Select the command latch by setting CLE to high */ |
|
|
|
|
@ -215,7 +215,7 @@ struct nand_chip; |
|
|
|
|
#if 0 |
|
|
|
|
/**
|
|
|
|
|
* struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independend devices |
|
|
|
|
* @lock: protection lock |
|
|
|
|
* @lock: protection lock |
|
|
|
|
* @active: the mtd device which holds the controller currently |
|
|
|
|
*/ |
|
|
|
|
struct nand_hw_control { |
|
|
|
|
@ -244,20 +244,20 @@ struct nand_hw_control { |
|
|
|
|
* 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 |
|
|
|
|
* @calculate_ecc: [REPLACEABLE] function for ecc calculation or readback from ecc hardware |
|
|
|
|
* @calculate_ecc: [REPLACEABLE] function for ecc calculation or readback from ecc hardware |
|
|
|
|
* @correct_data: [REPLACEABLE] function for ecc correction, matching to ecc generator (sw/hw) |
|
|
|
|
* @enable_hwecc: [BOARDSPECIFIC] function to enable (reset) hardware ecc generator. Must only |
|
|
|
|
* be provided if a hardware ECC is available |
|
|
|
|
* @erase_cmd: [INTERN] erase command write function, selectable due to AND support |
|
|
|
|
* @scan_bbt: [REPLACEABLE] function to scan bad block table |
|
|
|
|
* @eccmode: [BOARDSPECIFIC] mode of ecc, see defines |
|
|
|
|
* @eccsize: [INTERN] databytes used per ecc-calculation |
|
|
|
|
* @eccbytes: [INTERN] number of ecc bytes per ecc-calculation step |
|
|
|
|
* @eccsize: [INTERN] databytes used per ecc-calculation |
|
|
|
|
* @eccbytes: [INTERN] number of ecc bytes per ecc-calculation step |
|
|
|
|
* @eccsteps: [INTERN] number of ecc calculation steps per page |
|
|
|
|
* @chip_delay: [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR) |
|
|
|
|
* @chip_lock: [INTERN] spinlock used to protect access to this structure and the chip |
|
|
|
|
* @wq: [INTERN] wait queue to sleep on if a NAND operation is in progress |
|
|
|
|
* @state: [INTERN] the current state of the NAND device |
|
|
|
|
* @state: [INTERN] the current state of the NAND device |
|
|
|
|
* @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 |
|
|
|
|
@ -284,7 +284,7 @@ struct nand_hw_control { |
|
|
|
|
|
|
|
|
|
struct nand_chip { |
|
|
|
|
void __iomem *IO_ADDR_R; |
|
|
|
|
void __iomem *IO_ADDR_W; |
|
|
|
|
void __iomem *IO_ADDR_W; |
|
|
|
|
|
|
|
|
|
u_char (*read_byte)(struct mtd_info *mtd); |
|
|
|
|
void (*write_byte)(struct mtd_info *mtd, u_char byte); |
|
|
|
|
@ -297,12 +297,12 @@ struct nand_chip { |
|
|
|
|
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 (*hwcontrol)(struct mtd_info *mtd, int cmd); |
|
|
|
|
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, int state); |
|
|
|
|
void (*hwcontrol)(struct mtd_info *mtd, int cmd); |
|
|
|
|
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, int state); |
|
|
|
|
int (*calculate_ecc)(struct mtd_info *mtd, const u_char *dat, u_char *ecc_code); |
|
|
|
|
int (*correct_data)(struct mtd_info *mtd, u_char *dat, u_char *read_ecc, u_char *calc_ecc); |
|
|
|
|
int (*correct_data)(struct mtd_info *mtd, u_char *dat, u_char *read_ecc, u_char *calc_ecc); |
|
|
|
|
void (*enable_hwecc)(struct mtd_info *mtd, int mode); |
|
|
|
|
void (*erase_cmd)(struct mtd_info *mtd, int page); |
|
|
|
|
int (*scan_bbt)(struct mtd_info *mtd); |
|
|
|
|
@ -310,17 +310,17 @@ struct nand_chip { |
|
|
|
|
int eccsize; |
|
|
|
|
int eccbytes; |
|
|
|
|
int eccsteps; |
|
|
|
|
int chip_delay; |
|
|
|
|
int chip_delay; |
|
|
|
|
#if 0 |
|
|
|
|
spinlock_t chip_lock; |
|
|
|
|
wait_queue_head_t wq; |
|
|
|
|
nand_state_t state; |
|
|
|
|
nand_state_t state; |
|
|
|
|
#endif |
|
|
|
|
int page_shift; |
|
|
|
|
int page_shift; |
|
|
|
|
int phys_erase_shift; |
|
|
|
|
int bbt_erase_shift; |
|
|
|
|
int chip_shift; |
|
|
|
|
u_char *data_buf; |
|
|
|
|
u_char *data_buf; |
|
|
|
|
u_char *oob_buf; |
|
|
|
|
int oobdirty; |
|
|
|
|
u_char *data_poi; |
|
|
|
|
@ -335,7 +335,7 @@ struct nand_chip { |
|
|
|
|
struct nand_bbt_descr *bbt_td; |
|
|
|
|
struct nand_bbt_descr *bbt_md; |
|
|
|
|
struct nand_bbt_descr *badblock_pattern; |
|
|
|
|
struct nand_hw_control *controller; |
|
|
|
|
struct nand_hw_control *controller; |
|
|
|
|
void *priv; |
|
|
|
|
}; |
|
|
|
|
|
|
|
|
|
@ -352,14 +352,14 @@ struct nand_chip { |
|
|
|
|
/**
|
|
|
|
|
* struct nand_flash_dev - NAND Flash Device ID Structure |
|
|
|
|
* |
|
|
|
|
* @name: Identify the device type |
|
|
|
|
* @id: device ID code |
|
|
|
|
* @pagesize: Pagesize in bytes. Either 256 or 512 or 0 |
|
|
|
|
* @name: Identify the device type |
|
|
|
|
* @id: device ID code |
|
|
|
|
* @pagesize: Pagesize in bytes. Either 256 or 512 or 0 |
|
|
|
|
* If the pagesize is 0, then the real pagesize |
|
|
|
|
* and the eraseize are determined from the |
|
|
|
|
* extended id bytes in the chip |
|
|
|
|
* @erasesize: Size of an erase block in the flash device. |
|
|
|
|
* @chipsize: Total chipsize in Mega Bytes |
|
|
|
|
* @erasesize: Size of an erase block in the flash device. |
|
|
|
|
* @chipsize: Total chipsize in Mega Bytes |
|
|
|
|
* @options: Bitfield to store chip relevant options |
|
|
|
|
*/ |
|
|
|
|
struct nand_flash_dev { |
|
|
|
|
@ -374,7 +374,7 @@ struct nand_flash_dev { |
|
|
|
|
/**
|
|
|
|
|
* struct nand_manufacturers - NAND Flash Manufacturer ID Structure |
|
|
|
|
* @name: Manufacturer name |
|
|
|
|
* @id: manufacturer ID code of device. |
|
|
|
|
* @id: manufacturer ID code of device. |
|
|
|
|
*/ |
|
|
|
|
struct nand_manufacturers { |
|
|
|
|
int id; |
|
|
|
|
@ -398,7 +398,7 @@ extern struct nand_manufacturers nand_manuf_ids[]; |
|
|
|
|
* blocks is reserved at the end of the device where the tables are |
|
|
|
|
* written. |
|
|
|
|
* @reserved_block_code: if non-0, this pattern denotes a reserved (rather than |
|
|
|
|
* bad) block in the stored bbt |
|
|
|
|
* bad) block in the stored bbt |
|
|
|
|
* @pattern: pattern to identify bad block table or factory marked good / |
|
|
|
|
* bad blocks, can be NULL, if len = 0 |
|
|
|
|
* |
|
|
|
|
@ -412,11 +412,11 @@ struct nand_bbt_descr { |
|
|
|
|
int pages[NAND_MAX_CHIPS]; |
|
|
|
|
int offs; |
|
|
|
|
int veroffs; |
|
|
|
|
uint8_t version[NAND_MAX_CHIPS]; |
|
|
|
|
uint8_t version[NAND_MAX_CHIPS]; |
|
|
|
|
int len; |
|
|
|
|
int maxblocks; |
|
|
|
|
int maxblocks; |
|
|
|
|
int reserved_block_code; |
|
|
|
|
uint8_t *pattern; |
|
|
|
|
uint8_t *pattern; |
|
|
|
|
}; |
|
|
|
|
|
|
|
|
|
/* Options for the bad block table descriptors */ |
|
|
|
|
@ -428,7 +428,7 @@ struct nand_bbt_descr { |
|
|
|
|
#define NAND_BBT_4BIT 0x00000004 |
|
|
|
|
#define NAND_BBT_8BIT 0x00000008 |
|
|
|
|
/* The bad block table is in the last good block of the device */ |
|
|
|
|
#define NAND_BBT_LASTBLOCK 0x00000010 |
|
|
|
|
#define NAND_BBT_LASTBLOCK 0x00000010 |
|
|
|
|
/* The bbt is at the given page, else we must scan for the bbt */ |
|
|
|
|
#define NAND_BBT_ABSPAGE 0x00000020 |
|
|
|
|
/* The bbt is at the given page, else we must scan for the bbt */ |
|
|
|
|
@ -451,7 +451,7 @@ struct nand_bbt_descr { |
|
|
|
|
#define NAND_BBT_SCAN2NDPAGE 0x00004000 |
|
|
|
|
|
|
|
|
|
/* The maximum number of blocks to scan for a bbt */ |
|
|
|
|
#define NAND_BBT_SCAN_MAXBLOCKS 4 |
|
|
|
|
#define NAND_BBT_SCAN_MAXBLOCKS 4 |
|
|
|
|
|
|
|
|
|
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); |
|
|
|
|
|
Wolfgang Denk
19 years ago