2. EL 7
  3. kernel-doc
  4. struct_nand_chip(9)

Scroll to navigation

STRUCT NAND_CHIP(9) Structures STRUCT NAND_CHIP(9)

NAME

struct_nand_chip - NAND Private Flash Chip Data

SYNOPSIS

struct nand_chip {


  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,uint32_t offset, int data_len, const uint8_t *buf,int oob_required, int page, int cached, int raw);


  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);


  int chip_delay;


  unsigned int options;


  unsigned int bbt_options;


  int page_shift;


  int phys_erase_shift;


  int bbt_erase_shift;


  int chip_shift;


  int numchips;


  uint64_t chipsize;


  int pagemask;


  int pagebuf;


  unsigned int pagebuf_bitflips;


  int subpagesize;


  uint8_t cellinfo;


  int badblockpos;


  int badblockbits;


  int onfi_version;


  struct nand_onfi_params onfi_params;


  flstate_t state;


  uint8_t * oob_poi;


  struct nand_hw_control * controller;


  struct nand_ecclayout * ecclayout;


  struct nand_ecc_ctrl ecc;


  struct nand_buffers * buffers;


  struct nand_hw_control hwcontrol;


  uint8_t * bbt;


  struct nand_bbt_descr * bbt_td;


  struct nand_bbt_descr * bbt_md;


  struct nand_bbt_descr * badblock_pattern;


  void * priv;
};

MEMBERS

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.

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

cmd_ctrl

[BOARDSPECIFIC] hardwarespecific function for controlling ALE/CLE/nCE. Also used to write command and address

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 accessing 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.

erase_cmd

[INTERN] erase command write function, selectable due to AND support.

scan_bbt

[REPLACEABLE] function to scan bad block table

errstat

[OPTIONAL] hardware specific function to perform additional error status checks (determine if errors are correctable).

write_page

[REPLACEABLE] High-level page write function

onfi_set_features

[REPLACEABLE] set the features for ONFI nand

onfi_get_features

[REPLACEABLE] get the features for ONFI nand

chip_delay

[BOARDSPECIFIC] chip dependent delay for transferring data from array to read regs (tR).

options

[BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about special functionality. See the defines for further explanation.

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.

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

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.

pagebuf_bitflips

[INTERN] holds the bitflip count for the page which is currently in data_buf.

subpagesize

[INTERN] holds the subpagesize

cellinfo

[INTERN] MLC/multichip data from chip ident

badblockpos

[INTERN] position of the bad block marker in the oob area.

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

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.

state

[INTERN] the current state of the NAND device

oob_poi

"poison value buffer," used for laying out OOB data before writing

controller

[REPLACEABLE] a pointer to a hardware controller structure which is shared among multiple independent devices.

ecclayout

[REPLACEABLE] the default ECC placement scheme

ecc

[BOARDSPECIFIC] ECC control structure

buffers

buffer structure for read/write

hwcontrol

platform-specific hardware control structure

bbt

[INTERN] bad block table pointer

bbt_td

[REPLACEABLE] bad block table descriptor for flash lookup.

bbt_md

[REPLACEABLE] bad block table mirror descriptor

badblock_pattern

[REPLACEABLE] bad block scan pattern used for initial bad block scan.

priv

[OPTIONAL] pointer to private chip data

AUTHOR

Thomas Gleixner <tglx@linutronix.de>

Author.

COPYRIGHT

June 2024 Kernel Hackers Manual 3.10