MTDデバイスドライバとNAND Flashドライバ分析.


ハードウェア環境:飛凌OK 6410256 MB DDR、2 GB NAND Flash、NAND Flash型番:K 9 G 8 G 08 U 9 A、分析ソース:Linux 2.6.36.2カーネルソース.
一、MTD設備駆動.
1、MTDについて簡単にご紹介します
Linuxシステムでは、MTD(Memory Technology Device)システムを提供し、FlashのLinuxに対するシステム、抽象的なインタフェースを確立し、MTDはファイルシステムを最下位のFlashと
メモリは、Flashドライバエンジニアが文字デバイスとブロックデバイスとしてLInuxカーネルとのインタフェースに関心を持つ必要がないように分離されています.
2、MTD導入後のLinuxシステムにおけるFlashデバイスおよびインタフェースは、デバイスノード、MTDデバイス層、MTD元デバイス層およびハードウェア駆動層の4層に分けられる.この4つの階層の役割は次のように定義されます.
1->ハードウェア駆動層:Flashハードウェア駆動層はFlashハードウェアデバイスの読み取り、書き込み、消去を担当し、LInux MTDデバイスのNOR Flashチップ駆動はdrivers/mtd/chipsサブディレクトリの下にあり、NAND Flash
のドライバはdrivers/mtd/nandサブディレクトリの下にあります.
2->MTDオリジナルデバイス層:MTDオリジナルデバイス層は、MTDオリジナルデバイスの汎用コードの一部と、パーティションなどの特定のFlashのデータの2つの部分から構成される.
3->MTDデバイス層:MTDオリジナルデバイスに基づいてLinuxシステムはMTDのブロックデバイスの構造(メインデバイス番号31)と文字デバイス(デバイス番号90)を定義し、MTDデバイス層を構成し、MTD文字デバイス定義
mtdchar.cでは、MTDブロックデバイスは、MTDブロックデバイスを記述する構造mtdblk_を定義するdevは、mtdblksというポインタ配列を宣言し、この配列の各mtdblk_dev 
およびmtd_tableの各mtd_info一つ一つ対応.
4->デバイスノード:mknodによって/devサブディレクトリの下でMTD文字デバイスノードとブロックデバイスノードを確立し、ユーザーはこのデバイスノードにアクセスすることによってMTD文字デバイスとブロックデバイスにアクセスすることができる.
3、Linux MTDシステムインタフェースmtd_を分析するinfo構造体コード解析この構造体定義は./include/linux/mtd/mtd.h中
キーワード語解析:
XIP:XIP eXecute In Placeは、チップ内で実行され、アプリケーションがflashフラッシュメモリ内で直接実行でき、システムRAMにコードを読む必要がないことを意味します.Flash内での実行
nor flashは初期化する必要がなく、直接flash内でコードを実行できることを意味します.しかし、RAMの初期化などの一部のコードのみが実行することが多い.
OOB:Out Of Browerトランスポート層プロトコルは帯域外データ(out-of-band,OOB)を使用していくつかの重要なデータを送信し、通信側が重要なデータを相手に通知する必要がある場合、プロトコルはこれらのデータを送信することができる.
相手に素早く送るこれらのデータを送信するために
iovec-base:iovec構造体ベース.struct iovecはベクトル要素を定義します.通常、この構造は多要素の配列として使用されます.各転送要素について、ポインタメンバーiov_ベースほうこう
readvが受信したデータまたはwritevが送信するデータを格納するバッファ.メンバーiov_lenは、受信の最大長さおよび実際の書き込みの長さをそれぞれ決定する.
Sync:関数、関数の説明:この関数は、システムバッファの内容をディスクに書き込み、データの同期を確保します.
struct mtd_info {
	u_char type;     //        
	uint32_t flags;  //    
	uint64_t size;	 // Total size of the MTD 、mtd      

	/* "Major" erase size for the device. Na ve users may take this
	 * to be the only erase size available, or may use the more detailed
	 * information below if they desire
	 */
	uint32_t erasesize;    //          erase size of main block
	/* Minimal writable flash unit size. In case of NOR flash it is 1 (even
	 * though individual bits can be cleared), in case of NAND flash it is
	 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
	 * it is of ECC block size, etc. It is illegal to have writesize = 0.
	 * Any driver registering a struct mtd_info must ensure a writesize of
	 * 1 or larger.
	 */
	uint32_t writesize;           //            

	uint32_t oobsize;   // Amount of OOB data per block (e.g. 16) OOB    
	uint32_t oobavail;  // Available OOB bytes per block     OBB    

	/*
	 * If erasesize is a power of 2 then the shift is stored in
	 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
	 */
	unsigned int erasesize_shift;
	unsigned int writesize_shift;
	/* Masks based on erasesize_shift and writesize_shift */
	unsigned int erasesize_mask;
	unsigned int writesize_mask;

	// Kernel-only stuff starts here.
	const char *name;
	int index;

	/* ecc layout structure pointer - read only ! */
	struct nand_ecclayout *ecclayout;  // ECC        

	/* Data for variable erase regions. If numeraseregions is zero,
	 * it means that the whole device has erasesize as given above.
	 */ 
	int numeraseregions;              //    erasesize            1
	struct mtd_erase_region_info *eraseregions;

	/*
	 * Erase is an asynchronous operation.  Device drivers are supposed
	 * to call instr->callback() whenever the operation completes, even
	 * if it completes with a failure.
	 * Callers are supposed to pass a callback function and wait for it
	 * to be called before writing to the block.
	 */
	int (*erase) (struct mtd_info *mtd, struct erase_info *instr);

	/* This stuff for eXecute-In-Place */
	/* phys is optional and may be set to NULL */
	int (*point) (struct mtd_info *mtd, loff_t from, size_t len,            //    eXecute-In- Place
			size_t *retlen, void **virt, resource_size_t *phys);

	/* We probably shouldn't allow XIP if the unpoint isn't a NULL */
	void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);        //   unpoint   ,    XIP

	/* Allow NOMMU mmap() to directly map the device (if not NULL)
	 * - return the address to which the offset maps
	 * - return -ENOSYS to indicate refusal to do the mapping
	 */
	unsigned long (*get_unmapped_area) (struct mtd_info *mtd,
					    unsigned long len,
					    unsigned long offset,
					    unsigned long flags);

	/* Backing device capabilities for this device
	 * - provides mmap capabilities
	 */
	struct backing_dev_info *backing_dev_info;


	int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);        //   flash
	int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);   //   flash

	/* In blackbox flight recorder like scenarios we want to make successful
	   writes in interrupt context. panic_write() is only intended to be
	   called when its known the kernel is about to panic and we need the
	   write to succeed. Since the kernel is not going to be running for much
	   longer, this function can break locks and delay to ensure the write
	   succeeds (but not sleep). */

	int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);   // Kernel panic     

	int (*read_oob) (struct mtd_info *mtd, loff_t from,           //   out-of-band
			 struct mtd_oob_ops *ops);
	int (*write_oob) (struct mtd_info *mtd, loff_t to,            //   out-of-band
			 struct mtd_oob_ops *ops);

	/*
	 * Methods to access the protection register area, present in some
	 * flash devices. The user data is one time programmable but the
	 * factory data is read only.
	 */
	int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
	int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
	int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
	int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
	int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
	int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);

	/* kvec-based read/write methods.
	   NB: The 'count' parameter is the number of _vectors_, each of
	   which contains an (ofs, len) tuple.
	*/
	int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen); // iovec-based     

	/* Sync */  
	void (*sync) (struct mtd_info *mtd);                             // Sync 

	/* Chip-supported device locking */
	int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);    //    
	int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
	int (*is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);

	/* Power Management functions */ 
	int (*suspend) (struct mtd_info *mtd);                          //       
	void (*resume) (struct mtd_info *mtd);

	/* Bad block management functions */
	int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);          //       
	int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);

	struct notifier_block reboot_notifier;  /* default mode before reboot */

	/* ECC status information */
	struct mtd_ecc_stats ecc_stats;
	/* Subpage shift (NAND) */
	int subpage_sft;

	void *priv;                                                   //     

	struct module *owner;
	struct device dev;
	int usecount;

	/* If the driver is something smart, like UBI, it may need to maintain
	 * its own reference counting. The below functions are only for driver.
	 * The driver may register its callbacks. These callbacks are not
	 * supposed to be called by MTD users */
	int (*get_device) (struct mtd_info *mtd);
	void (*put_device) (struct mtd_info *mtd);
};

mtd_infoのread().write(). read_oob(). write_oob(). erase()はMTDデバイス駆動の主な実現関数である.後述するnand flahsドライバではmtd_はほとんど見えませんinfo
のメンバー関数(つまりこれらの関数はFlashチップにとって透明である)は、Linux MTD下層においてNOR、NAND Flashに対する同流mtd_が実現されているためであるinfoメンバー関数.
Flashドライバでは、次の2つの関数を使用してMTDデバイスを登録およびログアウトします.
int add_mtd_device(struct mtd_info *mtd);
int del_mtd_device (struct mtd_info *mtd)
4、mtd_part構造体分析この構造定義は.../drivers/mtd/mtdpart.c中
struct mtd_part {
	struct mtd_info mtd;      //      (      master   )
	struct mtd_info *master;  //        
	uint64_t offset;          //        
	struct list_head list;    //    
};
mtd_part構造体はパーティションを表すためmtd_info構造体メンバーは、mtd_に追加されるパーティションを記述するために使用されます.table(struct mtd_info*mtd_table[MAX_MTD_DEVICES])では、
ほとんどのメンバーはmtd_ですpart—>は、各関数がプライマリパーティションの対応する関数を指すことを決定します.
5、mtd_partition構造体分析この構造体定義はinclude/linux/mtd/partitions.h中
struct mtd_partition {
	char *name;			/* identifier string */     //      
	uint64_t size;			/* partition size */        //     
	uint64_t offset;		/* offset within the master MTD space */                              //  MTD                             
	uint32_t mask_flags;		/* master MTD flags to mask out for this partition */                 //     
	struct nand_ecclayout *ecclayout;	/* out of band layout for this partition (NAND only)*/
};

mtd_parttionはMTD元のデバイスレイヤでadd_を呼び出すmtd_partitons()でパーティション情報を渡し、次の2つの関数でパーティションの登録とログアウトを行います.
int add_mtd_partitions( struct mtd_info *master, struct mtd_partition *parts, int nbparts);
int del_mtd_partitions (struct mtd_info *master);
add_mtd_partitions()は、新しく確立されたパーティションごとに新しいmtd_を確立します.part構造体、mtd_に加えるpartitionsでadd_を呼び出しますmtd_デバイス()このパーティションをMTDデバイスとしてmtd_に追加tabe.
第二、NAND Flashドライバ分析:
LinuxカーネルはMTDの下層で汎用NAND駆動(主にdrivers/mtd/nand/nand_base.cファイルで実現)を実現しているため、チップレベルの駆動ではmtd_を実現する必要はないinfoの:read()、write()、
read_oob(), write_oobなどのメンバー関数で、本体はnand_に移行しました.chipデータ構造.
キーワード解析:
ALE:アドレスラッチイネーブル(Address Latch Enable,ALE):ALEが高い場合、WE信号の立ち上がりエッジでNANDアドレスレジスタにアドレスがラッチされる.
CLE:コマンドラッチイネーブル(Command Latch Enable,CLE):CLEが高い場合、WE信号の立ち上がりエッジで、コマンドはNANDコマンドレジスタにラッチされる.
BSP:Board Support Package
1、nand_chip構造体分析この構造体定義は./include/linux/mtd/nand.h
struct nand_chip {
	void  __iomem	*IO_ADDR_R;               //   8   I/O    ,     
	void  __iomem	*IO_ADDR_W;               //   8   I/O    ,      

	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);                                    //    AEL/CLE/nCE,            
	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;

	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;

	struct mtd_oob_ops ops;

	uint8_t		*bbt;
	struct nand_bbt_descr	*bbt_td;
	struct nand_bbt_descr	*bbt_md;

	struct nand_bbt_descr	*badblock_pattern;

	void		*priv;
};

MTD使用nand_chipデータ構造はNAND Flashチップを表し、この構造体にはNAND Flashに関するアドレス情報、読み書き方法、ECCモード、ハードウェア制御などの一連の下位メカニズムが含まれている.
2、S3C6410 nand_chip初期化とNANDプローブ
S 3 C 6410のNANDドライバはplatformドライバとして存在し、probe()の実行時にnand_を初期化するchipインスタンスを実行しnand_を実行scanはNANDデバイスをスキャンし、最後にadd_を呼び出すmtd_partitions()マザーボードで定義されたパーティションテーブルを追加します.nand_chipはnanf flash駆動のコアデータ構造であり、この構造体重のメンバーはこのNAND Flashの下位操作に直接対応し、具体的な状況に対するNANDコントローラの状況である.
解析s 3 c_nand_probe関数体対S 3 C 6410 nand_chipの初期化と登録:drivers/mtd/nand/s 3 c_で定義されたファイルnand.cでは、ベースカーネル2.6.36.2のこのファイルはs 3 c 2410である.c
Linux 2.6.36.2のカーネルでS 3 C 6410 nand flashコントローラをサポートしたい場合は、s 3 c_nand.cこのファイルは自分で追加する必要があります.
static int s3c_nand_probe(struct platform_device *pdev, enum s3c_cpu_type cpu_type)
{	
	struct s3c2410_platform_nand *plat = pdev->dev.platform_data;
	struct s3c2410_nand_set *sets;
	struct nand_chip *nand;
	struct resource *res;
	int err = 0;
	int ret = 0;
	int nr_sets;
	int i, j, size;

#if defined(CONFIG_MTD_NAND_S3C_HWECC)
	struct nand_flash_dev *type = NULL;
	u_char tmp;
	u_char dev_id;
#endif

	/* get the clock source and enable it */

	s3c_nand.clk = clk_get(&pdev->dev, "nand");
	if (IS_ERR(s3c_nand.clk)) {
		dev_err(&pdev->dev, "failed to get clock");
		err = -ENOENT;
		goto exit_error;
	}

	clk_enable(s3c_nand.clk);

	/* allocate and map the resource */

	/* currently we assume we have the one resource */
	res  = pdev->resource;
	size = res->end - res->start + 1;

	s3c_nand.area = request_mem_region(res->start, size, pdev->name);

	if (s3c_nand.area == NULL) {
		dev_err(&pdev->dev, "cannot reserve register region
"); err = -ENOENT; goto exit_error; } s3c_nand.cpu_type = cpu_type; s3c_nand.device = &pdev->dev; s3c_nand.regs = ioremap(res->start, size); s3c_nand.platform = plat; if (s3c_nand.regs == NULL) { dev_err(&pdev->dev, "cannot reserve register region
"); err = -EIO; goto exit_error; } sets = (plat != NULL) ? plat->sets : NULL; nr_sets = (plat != NULL) ? plat->nr_sets : 1; s3c_nand.mtd_count = nr_sets; /* allocate memory for MTD device structure and private data */ s3c_mtd = kmalloc(sizeof(struct mtd_info) + sizeof(struct nand_chip), GFP_KERNEL); if (!s3c_mtd) { printk("Unable to allocate NAND MTD dev structure.
"); return -ENOMEM; } /* Get pointer to private data */ nand = (struct nand_chip *) (&s3c_mtd[1]); /* Initialize structures */ memset((char *) s3c_mtd, 0, sizeof(struct mtd_info)); memset((char *) nand, 0, sizeof(struct nand_chip)); /* Link the private data with the MTD structure */ s3c_mtd->priv = nand; for (i = 0; i < sets->nr_chips; i++) { nand->IO_ADDR_R = (char *)(s3c_nand.regs + S3C_NFDATA); // IO_ADDR_R nand->IO_ADDR_W = (char *)(s3c_nand.regs + S3C_NFDATA); // IO_ADDR_W nand->cmd_ctrl = s3c_nand_hwcontrol; // cmd_crtl() nand->dev_ready = s3c_nand_device_ready; // dev_read() nand->scan_bbt = s3c_nand_scan_bbt; // scan_bbt() nand->options = 0; #if defined(CONFIG_MTD_NAND_S3C_CACHEDPROG) nand->options |= NAND_CACHEPRG; #endif #if defined(CONFIG_MTD_NAND_S3C_HWECC) nand->ecc.mode = NAND_ECC_HW; nand->ecc.hwctl = s3c_nand_enable_hwecc; nand->ecc.calculate = s3c_nand_calculate_ecc; nand->ecc.correct = s3c_nand_correct_data; s3c_nand_hwcontrol(0, NAND_CMD_READID, NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE); s3c_nand_hwcontrol(0, 0x00, NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE); s3c_nand_hwcontrol(0, 0x00, NAND_NCE | NAND_ALE); s3c_nand_hwcontrol(0, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE); s3c_nand_device_ready(0); tmp = readb(nand->IO_ADDR_R); /* Maf. ID */ // ID dev_id = tmp = readb(nand->IO_ADDR_R); /* Device ID */ // ID for (j = 0; nand_flash_ids[j].name != NULL; j++) { if (tmp == nand_flash_ids[j].id) { type = &nand_flash_ids[j]; break; } } if (!type) { printk("Unknown NAND Device.
"); goto exit_error; } nand->cellinfo = readb(nand->IO_ADDR_R); /* the 3rd byte */ // 3 tmp = readb(nand->IO_ADDR_R); /* the 4th byte */ // 4 if (!type->pagesize) { if (((nand->cellinfo >> 2) & 0x3) == 0) { nand_type = S3C_NAND_TYPE_MLC_4BIT; nand->options |= NAND_NO_SUBPAGE_WRITE; /* NOP = 1 if MLC */ nand->ecc.read_page = s3c_nand_read_page_4bit; nand->ecc.write_page = s3c_nand_write_page_4bit; nand->ecc.size = 512; nand->ecc.bytes = 8; /* really 7 bytes */ if ((1024 << (tmp & 0x3)) > 512) { nand->ecc.layout = &s3c_nand_oob_mlc_64; } else { nand->ecc.layout = &s3c_nand_oob_16; } /* nand_type = S3C_NAND_TYPE_SLC; nand->ecc.size = 512; nand->ecc.bytes = 4; if ((1024 << (tmp & 0x3)) > 512) { nand->ecc.read_page = s3c_nand_read_page_1bit; nand->ecc.write_page = s3c_nand_write_page_1bit; nand->ecc.read_oob = s3c_nand_read_oob_1bit; nand->ecc.write_oob = s3c_nand_write_oob_1bit; nand->ecc.layout = &s3c_nand_oob_64; } else { nand->ecc.layout = &s3c_nand_oob_16; } */ } else { nand_type = S3C_NAND_TYPE_MLC_4BIT; nand->options |= NAND_NO_SUBPAGE_WRITE; /* NOP = 1 if MLC */ nand->ecc.read_page = s3c_nand_read_page_4bit; nand->ecc.write_page = s3c_nand_write_page_4bit; nand->ecc.size = 512; nand->ecc.bytes = 8; /* really 7 bytes */ nand->ecc.layout = &s3c_nand_oob_mlc_64; if(dev_id == 0xd5) { printk("dev_id == 0xd5 select s3c_nand_oob_mlc_128
"); nand_type = S3C_NAND_TYPE_MLC_8BIT; nand->ecc.read_page = s3c_nand_read_page_8bit; nand->ecc.write_page = s3c_nand_write_page_8bit; nand->ecc.size = 512; nand->ecc.bytes = 13; /* really 7 bytes */ nand->ecc.layout = &s3c_nand_oob_mlc_128_8bit; } } } else { nand_type = S3C_NAND_TYPE_SLC; nand->ecc.size = 512; nand->cellinfo = 0; nand->ecc.bytes = 4; nand->ecc.layout = &s3c_nand_oob_16; } printk("S3C NAND Driver is using hardware ECC.
"); #else nand->ecc.mode = NAND_ECC_SOFT; printk("S3C NAND Driver is using software ECC.
"); #endif if (nand_scan(s3c_mtd, 1)) { ret = -ENXIO; goto exit_error; } /* Register the partitions */ add_mtd_partitions(s3c_mtd, sets->partitions, sets->nr_partitions); // } pr_debug("initialized ok
"); return 0; exit_error: kfree(s3c_mtd); return ret; }
drivers/mtd/nand/s3c_nand.cはplatform駆動であり、我々がOK 6410を移植するNAND Flash駆動を加える必要がある.これは、OK 6410のBSP(ボードレベルサポートパッケージ)にNANDのplatformデバイスとパーティション情報、すなわちarch/arm/mach-s 3 c 64 xx/mach-smdk 6410である.cにこれらの情報を追加すると、上のNAND Flashドライバを移植に成功させることができます.
参考文献:設備駆動開発詳細(第2版)華清遠見宋宝華著
NAND Flash駆動移植方法は、私の前編のブログを参考にすることができます.http://blog.csdn.net/acanoe/article/details/7516341
このブログと前のブログを一緒に読むと、NAND Flashドライブを理解するのが簡単になります.