nandflash驱动

nand.c文件

/*
TQ2440开发板使用的nandflash芯片是 : K9F2G08U0A
nandflash驱动的层次:

内核里面已经自带有nandflash的驱动程序，我们这里重新写一套。
参考源码:\kerner-2.6.30\drivers\mtd\nand\s3c2410.c
        \kerner-2.6.30\drivers\mtd\nand\atmel_nand.c
*/

#include <linux/module.h>
#include <linux/types.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/ioport.h>
#include <linux/platform_device.h>
#include <linux/delay.h>
#include <linux/err.h>
#include <linux/slab.h>
#include <linux/clk.h>
#include <linux/cpufreq.h>

#include <linux/mtd/mtd.h>
#include <linux/mtd/nand.h>
#include <linux/mtd/nand_ecc.h>
#include <linux/mtd/partitions.h>

#include <asm/io.h>

#include <plat/regs-nand.h>
#include <plat/nand.h>

/*定义一个nandflash相关的结构体
写成结构体的原因是:一次内存映射所有的寄存器。
*/
struct nand_regs
{
        unsigned long nfconf ; /*0x4E000000*/
        unsigned long nfcont ;
        unsigned long nfcmd ;
        unsigned long nfaddr ;
        unsigned long nfdata ;
        unsigned long nfeccd0 ;
        unsigned long nfeccd1 ;
        unsigned long nfeccd ;
        unsigned long nfstat ;
        unsigned long nfestat0;
        unsigned long nfestat1;
        unsigned long nfmecc0 ;
        unsigned long nfmecc1 ;
        unsigned long nfsecc ;
        unsigned long nfsblk ;
        unsigned long nfeblk ;
};

static struct nand_chip * my_nand_chip;        /*定义一个nand芯片 的结构体*/
static struct mtd_info * my_mtd_info;            /*定义一个mtd信息 的结构体*/
static struct nand_regs * s3c_nand_regs;    /*定义一个nandflash相关寄存器的结构体*/

static struct mtd_partition my_nand_mtd_parts[] = /*分区表*/
{
    [0] = {
        .name = "bootloader", /*分区名字*/
        .size = 0x00040000,            /*分区大小:4*64K*/
                .offset    = 0,                            /*分区偏移值:相对nand的0地址*/
                /*上面表示:nandflash的0地址到256K的地址，是bootloader分区，是用来存储bootloader的*/
    },
    [1] = {
        .name = "params",
        .offset = MTDPART_OFS_APPEND, /*这个宏表示:偏移值紧跟着上面一个分区的大小*/
        .size = 0x00020000,                    /* 2*64K */
    },
    [2] = {
        .name = "kernel",
        .offset = MTDPART_OFS_APPEND,
        .size = 0x00300000,                    /* 3*1M */
    },
    [3] = {
        .name = "root",                            /*根文件系统*/
        .offset = MTDPART_OFS_APPEND,
        .size = MTDPART_SIZ_FULL,     /*这个宏表示:nandflash剩下的所有的空间都是*/
    }
};

/*
函数功能 : 片选函数
*/
static void nand_select_chip(struct mtd_info *mtd, int chipnr)
{
        if (chipnr == -1)
        {
                /* 取消选中: NFCONT[1]设为1 禁止NANDFLASH*/
                s3c_nand_regs->nfcont |= (1<<1);
        }
        else
        {
                /* 选中: NFCONT[1]设为0 使能NANDFLASH*/
                s3c_nand_regs->nfcont &= ~(1<<1);
        }
}

/*
函数功能 : 发送命令，发送地址
函数参数 : ctrl : 用来区分是命令还是地址
*/
static void nand_cmd_ctrl(struct mtd_info *mtd, int dat, unsigned int ctrl)
{
        if (ctrl & NAND_CLE)
        {
                /* 发命令: 命令寄存器NFCMMD=dat */
                s3c_nand_regs->nfcmd = dat;
        }
        else
        {
                /* 发地址: 地址寄存器NFADDR=dat */
                s3c_nand_regs->nfaddr = dat;
        }
}

/*
函数功能 : 判断NandFlash是否准备就绪(即不忙)
函数参数 :
函数返回值 : 0: 1:
*/
static int nand_dev_ready(struct mtd_info *mtd)
{
        /*状态寄存器NFSTAT*/
        return (s3c_nand_regs->nfstat & (1<<0));
}

static int nand_init(void)
{
    struct clk *clk; /*时钟*/

    /* 1. 分配一个nand_chip结构体 */
    my_nand_chip = kzalloc(sizeof(struct nand_chip), GFP_KERNEL);

    s3c_nand_regs = ioremap(0x4E000000, sizeof(struct nand_regs));

    /* 2. 设置nand_chip */
    /* 设置nand_chip是给nand_scan函数使用的, 如果不知道怎么设置, 先看nand_scan怎么使用
     * 它应该提供:选中,发命令,发地址,发数据,读数据,判断状态的功能
     */
    my_nand_chip->select_chip = nand_select_chip;                    /*片选函数，选中*/
    my_nand_chip->cmd_ctrl = nand_cmd_ctrl;                        /*发命令，发地址函数*/
    my_nand_chip->IO_ADDR_R = &(s3c_nand_regs->nfdata);    /*读数据*/
    my_nand_chip->IO_ADDR_W = &(s3c_nand_regs->nfdata);    /*发数据*/
    my_nand_chip->dev_ready = nand_dev_ready;                        /*判断NandFlash是否准备就绪(即不忙)*/
    my_nand_chip->ecc.mode = NAND_ECC_SOFT;                        /*使用软件生成，ECC校验码*/
    /*nand为什么要进行ECC校验？
    因为nandflash有个缺点:易位反转，所以要引入ECC校验，ECC校验码保存在OOB(out of bank)中，即bank 2K编址区域之外的 64字节区域。
    1，写一页数据时，生成ECC码，把ECC码写入OOB区域。
    2，读一页数据时，读OOB里面的校验码ECC，从读取的一页数据中也算出一个ECC码，再比较这2个ECC码(读出的ECC|算出的ECC)。
    2个ECC比较结果:若相等:则表示读取的数据正确;若不相等:则表示发生了位反转错误。
    */

    /* 3. 硬件相关的设置: 根据NAND FLASH的手册设置时间参数 */
    /* 为了省电，内核会把用不到的模块都关掉，所以，要使能NAND FLASH控制器的时钟
    可以不使用下面的函数，直接ioremap之后，设置寄存器CLKCON的BIT4的值，来开启时钟
    */
    clk = clk_get(NULL, "nand");
    clk_enable(clk); /* CLKCON'bit[4] */
    /*注意 : 只有时钟打开了，才能设置,读/写下面的寄存器*/

    /* HCLK=100MHz,所以一个周期的时间是10ns。
     * TACLS: 发出CLE/ALE之后多长时间才发出nWE信号, 从NAND手册可知CLE/ALE与nWE可以同时发出,所以TACLS=0
     * TWRPH0: nWE的脉冲宽度, HCLK x ( TWRPH0 + 1 ), 从NAND手册可知它要>=12ns, 所以TWRPH0>=1
     * TWRPH1: nWE变为高电平后多长时间CLE/ALE才能变为低电平, 从NAND手册可知它要>=5ns, 所以TWRPH1>=0
     */
#define TACLS    1
#define TWRPH0   3
#define TWRPH1   0
    s3c_nand_regs->nfconf = (TACLS<<12) | (TWRPH0<<8) | (TWRPH1<<4);

    /* NFCONT:
     * BIT1-设为1, 取消片选, 刚开始时，是禁止片选
     * BIT0-设为1, 使能NAND FLASH控制器
     */
    s3c_nand_regs->nfcont = (1<<1) | (1<<0);

    /* 4. 使用: nand_scan */
    my_mtd_info = kzalloc(sizeof(struct mtd_info), GFP_KERNEL);
    my_mtd_info->owner = THIS_MODULE;
    my_mtd_info->priv = my_nand_chip; /*我们定义的nand芯片 赋值给 这里的私有数据*/

    /*nand_scan函数功能 : 扫描,识别内存技术设备nand芯片，第2个参数:最大芯片个数,我们这里只有一个芯片*/
    nand_scan(my_mtd_info, 1); /* 识别NAND FLASH, 构造mtd_info */

    /* 5. 添加分区 */
    /*函数功能 : 通知字符设备，通知块设备;最终，块设备中会分配/注册一个块设备结构体 struct gendisk
    函数参数:第3个参数:表示第2个结构体参数有多少项
    */
    add_mtd_partitions(my_mtd_info, my_nand_mtd_parts, 4);

    /*下面这个函数功能:就是把整个nandflash的空间，当做一个分区。可以部分替代上面的函数。*/
    //add_mtd_device(my_mtd_info);
    return 0;
}

static void nand_exit(void)
{
        del_mtd_partitions(my_mtd_info);    /*对应 : add_mtd_partitions*/
        kfree(my_mtd_info);                                /*对应 : kzalloc my_mtd_info*/
        iounmap(s3c_nand_regs);                        /*对应 : ioremap*/
        kfree(my_nand_chip);                            /*对应 : kzalloc my_nand_chip*/
}

module_init(nand_init);
module_exit(nand_exit);
MODULE_AUTHOR("wangxiancai"); //代码的作者
MODULE_DESCRIPTION("nand driver"); //代码的描述，功能
MODULE_LICENSE("GPL"); //开源协议
MODULE_ALIAS("nand");

/*
测试 :
1，未添加分区，只是识别nand芯片的时候，还不需要把内核自带的nand驱动去掉。
# insmod nand.ko
NAND device: Manufacturer ID: 0xec, Chip ID: 0xda (Samsung NAND 256MiB 3,3V 8-bit)
NAND_ECC_NONE selected by board driver. This is not recommended !! //这个表示:没有使用ECC校验
Scanning device for bad blocks
Bad eraseblock 41 at 0x000000520000 //扫描，识别坏块,确保不再使用它们
Bad eraseblock 42 at 0x000000540000
...................................
Bad eraseblock 363 at 0x000002d60000
Bad eraseblock 364 at 0x000002d80000
Bad eraseblock 750 at 0x000005dc0000
Bad eraseblock 1290 at 0x00000a140000
Bad eraseblock 1816 at 0x00000e300000

2，使用软件生成的ECC校验之后，再测
# insmod nand.ko
NAND device: Manufacturer ID: 0xec, Chip ID: 0xda (Samsung NAND 256MiB 3,3V 8-bit)
Scanning device for bad blocks
Bad eraseblock 41 at 0x000000520000
Bad eraseblock 42 at 0x000000540000
...................................
Bad eraseblock 363 at 0x000002d60000
Bad eraseblock 364 at 0x000002d80000
Bad eraseblock 750 at 0x000005dc0000
Bad eraseblock 1290 at 0x00000a140000
Bad eraseblock 1816 at 0x00000e300000

3,加入nand分区的代码之后，再测
要去掉内核本身自带的nandflash驱动
# make menuconfig
  Device Drivers --->
          <*> Memory Technology Device (MTD) support --->
                      <*> NAND Device Support --->
                                  <*> NAND Flash support for S3C2410/S3C2440 SoC //这个星号要去掉
# make zImage
# ./mkimage.sh
# chmod 777 *

4,使用新内核，启动开发板
# tftp 0x32000000 uImage;
# bootm
开发板启动之后:在开发板目录下:
# ls -lrt /dev/mtd* //说明新内核已经没有nand驱动了
ls: /dev/mtd*: No such file or directory

5,插入模块
# insmod nand.ko
NAND device: Manufacturer ID: 0xec, Chip ID: 0xda (Samsung NAND 256MiB 3,3V 8-bit)
Scanning device for bad blocks
Bad eraseblock 41 at 0x000000520000
Bad eraseblock 42 at 0x000000540000
...................................
Bad eraseblock 363 at 0x000002d60000
Bad eraseblock 364 at 0x000002d80000
Bad eraseblock 750 at 0x000005dc0000
Bad eraseblock 1290 at 0x00000a140000
Bad eraseblock 1816 at 0x00000e300000
Creating 4 MTD partitions on "NAND 256MiB 3,3V 8-bit":
0x000000000000-0x000000040000 : "bootloader"
0x000000040000-0x000000060000 : "params"
0x000000060000-0x000000360000 : "kernel"
0x000000360000-0x000010000000 : "root"

# ls -lrt /dev/mtd* //说明我们写的nand驱动成功了
brw-rw---- 1 root     root       31, 1 Jan  1 00:02 /dev/mtdblock1
brw-rw---- 1 root     root       31, 0 Jan  1 00:02 /dev/mtdblock0
crw-rw---- 1 root     root       90, 7 Jan  1 00:02 /dev/mtd3ro
crw-rw---- 1 root     root       90, 4 Jan  1 00:02 /dev/mtd2
crw-rw---- 1 root     root       90, 3 Jan  1 00:02 /dev/mtd1ro
crw-rw---- 1 root     root       90, 2 Jan  1 00:02 /dev/mtd1
crw-rw---- 1 root     root       90, 1 Jan  1 00:02 /dev/mtd0ro
crw-rw---- 1 root     root       90, 0 Jan  1 00:02 /dev/mtd0
brw-rw---- 1 root     root       31, 3 Jan  1 00:02 /dev/mtdblock3
brw-rw---- 1 root     root       31, 2 Jan  1 00:02 /dev/mtdblock2
crw-rw---- 1 root     root       90, 6 Jan  1 00:02 /dev/mtd3
crw-rw---- 1 root     root       90, 5 Jan  1 00:02 /dev/mtd2ro

说明:创建了4个分区，每个分区又创建了1个只读的字符设备(带ro的)文件+1个可读可写的字符设备文件+1个块设备文件

6，在ubuntu目录下
# tar -xjvf mtd-utils-05.07.23.tar.bz2 //需要使用mtd工具
# cd /home/wangxc/linux/rootfs/mtd-utils-05.07.23
# cd /home/wangxc/linux/rootfs/mtd-utils-05.07.23/util
修改makefile
#CROSS=arm-linux-
修改为
CROSS=arm-linux-

# export PATH=$PATH:/home/wangxc/linux/toolchain/crosstools_4.4.3_softfloat/bin
# make
# ls
# cp /home/wangxc/linux/rootfs/mtd-utils-05.07.23/util/flash_erase /home/wangxc/linux/rootfs/nfs_2.6.30/wxc/driver/blockdriver/nand/
# cp /home/wangxc/linux/rootfs/mtd-utils-05.07.23/util/flash_eraseall /home/wangxc/linux/rootfs/nfs_2.6.30/wxc/driver/blockdriver/nand/
注意:
flash_erase 功能 : 擦除一个扇区
flash_eraseall 功能 : 擦除整个分区
都是操作字符设备的

在开发板目录下，格式化磁盘空间,格式化的时候，用字符设备。
# flash_eraseall /dev/mtd3 //擦除完成之后，它本身就会被格式化成 yaffs 文件系统
Bad eraseblock 41 at 0x000000520000
Bad eraseblock 42 at 0x000000540000
...................................
Bad eraseblock 363 at 0x000002d60000
Bad eraseblock 364 at 0x000002d80000
Bad eraseblock 750 at 0x000005dc0000
Bad eraseblock 1290 at 0x00000a140000
Bad eraseblock 1816 at 0x00000e300000
以上说明:我的nandflash有很多坏块，第1个坏块的编号从41号开始，
因为每一块就有128K字节的空间，之前做nand_read的时候，没有判断坏块，其实是厂家确保了第0块是好块。
正式的代码:nand_read,nand_write,nand_erase的时候，遇到坏块，都会跳过这个坏块。

7, 在开发板目录，挂接 : 挂接的时候用块设备。
# mount -t yaffs /dev/mtdblock3 /mnt/ //把磁盘设备 挂接到 /tmp目录下
yaffs: dev is 32505859 name is "mtdblock3"
yaffs: passed flags ""
yaffs: Attempting MTD mount on 31.3, "mtdblock3"
yaffs: auto selecting yaffs2
yaffs: restored from checkpoint
yaffs_read_super: isCheckpointed 1

# cd /mnt
# ls -lrt
drwx------ 1 root     root          2048 Jan  1 01:00 lost+found //出现这个，表示正常了

8, 在/mnt目录下来创建文件
相当于在分区3，来操作
# mkdir test
# echo “wangxiancai” >> 1.txt
上面的文件数据，都会保存在nandflash的分区3中。
再重新启动内核，不擦除nandflash的时候，重新把nandflash的分区3挂接到/mnt目录，则可以再次看见这写文件数据。

*/

makefile文件

# File: Makefile
# wangxiancai

MODEXT = ko
# INSTALLDIR=/home/wangxc/linux/rootfs/nfs_2.6.13/wxc/driver/chardriver/ko
INSTALLDIR=/home/wangxc/linux/rootfs/nfs_2.6.30/wxc/driver/blockdriver/ko
# CROSS=/home/wangxc/linux/toolchain/crosstools_3.4.1_softfloat/arm-linux/gcc-3.4.1-glibc-2.3.3/bin/arm-linux-
CROSS=/home/wangxc/linux/toolchain/crosstools_4.4.3_softfloat/bin/arm-linux-
# KERNELDIR=/home/wangxc/linux/kernel/kernel-2.6.13
KERNELDIR=/home/wangxc/linux/kernel/kerner-2.6.30

CC= $(CROSS)gcc
LD= $(CROSS)ld

#############################################################################
# Compiler Flags
#############################################################################
EXTRA_CFLAGS += -I$(KERNELDIR)/include
#############################################################################
# Make Targets
#############################################################################
obj-m := nand.o
default:
    $(MAKE) -C $(KERNELDIR) M=$(PWD) modules
# Otherwise we were called directly from the command line; invoke the kernel build system.

install: default
    rm -rf $(INSTALLDIR)/nand.$(MODEXT)
    cp -rf $(PWD)/nand.$(MODEXT) $(INSTALLDIR)

clean:
    rm -rf *.o *~ core .depend .*.cmd *.ko *.mod.c .tmp_versions *.bak modules.order Module.symvers