xref: /OK3568_Linux_fs/kernel/drivers/mtd/rknand/rknand_base_ko.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  linux/drivers/mtd/rknand/rknand_base.c
 *
 *  Copyright (C) 2005-2009 Fuzhou Rockchip Electronics
 *  ZYF <zyf@rock-chips.com>
 *
 *
 */
#include <linux/version.h>
#include <linux/module.h>
#include <linux/sched.h>
#include <linux/delay.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/platform_device.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/partitions.h>
#include <linux/mutex.h>
#include <linux/kthread.h>
#include <linux/dma-mapping.h>
#include <asm/dma.h>
#include <asm/cacheflush.h>
#include <linux/irq.h>
#include <linux/interrupt.h>
#include <linux/reboot.h>
#include <asm/io.h>
#include <asm/mach/flash.h>
//#include "api_flash.h"
#include "rknand_base.h"
#include "../mtdcore.h"
#include <linux/clk.h>
#include <linux/cpufreq.h>
#ifdef CONFIG_OF
#include <linux/of.h>
#endif

#define DRIVER_NAME	"rk29xxnand"

const char rknand_base_version[] = "rknand_base.c version: 4.38 20120717";
#define NAND_DEBUG_LEVEL0 0
#define NAND_DEBUG_LEVEL1 1
#define NAND_DEBUG_LEVEL2 2
#define NAND_DEBUG_LEVEL3 3

int g_num_partitions = 0;
unsigned long SysImageWriteEndAdd = 0;
struct mtd_info		rknand_mtd;
struct mtd_partition *rknand_parts;
struct rknand_info * gpNandInfo;

#ifdef CONFIG_MTD_NAND_RK29XX_DEBUG
static int s_debug = CONFIG_MTD_NAND_RK29XX_DEBUG_VERBOSE;
#undef NAND_DEBUG
#define NAND_DEBUG(n, format, arg...) \
	if (n <= s_debug) {	 \
		printk(format,##arg); \
	}
#else
#undef NAND_DEBUG
#define NAND_DEBUG(n, arg...)
static const int s_debug = 0;
#endif

#include <linux/proc_fs.h>
#include <linux/version.h>
#if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 26))
#define NANDPROC_ROOT  (&proc_root)
#else
#define NANDPROC_ROOT  NULL
#endif

//#define RKNAND_TRAC_EN
#ifdef RKNAND_TRAC_EN
static struct proc_dir_entry *my_trac_proc_entry;
#define MAX_TRAC_BUFFER_SIZE     (long)(2048 * 8 * 512) //sector
static char grknand_trac_buf[MAX_TRAC_BUFFER_SIZE];
static char *ptrac_buf = grknand_trac_buf;
void trac_log(long lba,int len, int mod)
{
	unsigned long long t;
    unsigned long nanosec_rem;
    t = cpu_clock(UINT_MAX);
    nanosec_rem = do_div(t, 1000000000);
    if(mod)
        ptrac_buf += sprintf(ptrac_buf,"[%5lu.%06lu] W %d %d \n",(unsigned long) t, nanosec_rem / 1000,lba,len);
    else
        ptrac_buf += sprintf(ptrac_buf,"[%5lu.%06lu] R %d %d \n",(unsigned long) t, nanosec_rem / 1000,lba,len);
}

void trac_logs(char *s)
{
	unsigned long long t;
    unsigned long nanosec_rem;
    t = cpu_clock(UINT_MAX);
    nanosec_rem = do_div(t, 1000000000);
	ptrac_buf += sprintf(ptrac_buf,"[%5lu.%06lu] %s\n",(unsigned long) t, nanosec_rem / 1000,s);
}

static int rkNand_trac_read(char *page, char **start, off_t off, int count, int *eof,
		    void *data)
{
	char *p = page;
	int len;

	 len = ptrac_buf - grknand_trac_buf - off;
     //printk("rkNand_trac_read: page=%x,off=%x,count=%x ,len=%x \n",(int)page,(int)off,count,len);

	if (len < 0)
		len = 0;

	 if(len > count)
	    len = count;

	 memcpy(p,grknand_trac_buf + off,len);

	*eof = (len <  count) ? 1 : 0;
	*start = page;
	if(len < count)
        ptrac_buf = grknand_trac_buf;
	return len;
}

#endif

#define     DATA_LEN            (1024*8*2/4)              //���ݿ鵥λword
#define     SPARE_LEN           (32*8*2/4)               //У�����ݳ���
#define     PAGE_LEN            (DATA_LEN+SPARE_LEN)    //ÿ�����ݵ�λ�ij���
#define     MAX_BUFFER_SIZE     (long)(2048 * 8) //sector
//long grknand_buf[MAX_BUFFER_SIZE * 512/4] __attribute__((aligned(4096)));
//long grknand_dma_buf[PAGE_LEN*4*5] __attribute__((aligned(4096)));
static struct proc_dir_entry *my_proc_entry;
extern int rkNand_proc_ftlread(char *page);
extern int rkNand_proc_bufread(char *page);
static int rkNand_proc_read(char *page,
			   char **start,
			   off_t offset, int count, int *eof, void *data)
{
	char *buf = page;
	int step = offset;
	*(int *)start = 1;
	if(step == 0)
	{
        buf += sprintf(buf, "%s\n", rknand_base_version);
        if(gpNandInfo->proc_ftlread)
            buf += gpNandInfo->proc_ftlread(buf);
        if(gpNandInfo->proc_bufread)
            buf += gpNandInfo->proc_bufread(buf);
#ifdef RKNAND_TRAC_EN
        buf += sprintf(buf, "trac data len:%d\n", ptrac_buf - grknand_trac_buf);
#endif
    }
	return buf - page < count ? buf - page : count;
}

#if 0// (LINUX_VERSION_CODE < KERNEL_VERSION(3, 10, 0))
static void rknand_create_procfs(void)
{
    /* Install the proc_fs entry */
    my_proc_entry = create_proc_entry("rknand",
                           S_IRUGO | S_IFREG,
                           NANDPROC_ROOT);

    if (my_proc_entry) {
        my_proc_entry->write_proc = NULL;
        my_proc_entry->read_proc = rkNand_proc_read;
        my_proc_entry->data = NULL;
    }
#ifdef RKNAND_TRAC_EN
    /* Install the proc_fs entry */
    my_trac_proc_entry = create_proc_entry("rknand_trac",
                           S_IRUGO | S_IFREG,
                           NANDPROC_ROOT);
    if (my_trac_proc_entry) {
        my_trac_proc_entry->write_proc = NULL;
        my_trac_proc_entry->read_proc = rkNand_trac_read;
        my_trac_proc_entry->data = NULL;
    }
#endif
}
#else
static const struct file_operations my_proc_fops = {
.owner = THIS_MODULE,
.read = rkNand_proc_read,
.write = NULL,
};

static void rknand_create_procfs(void)
{
    /* Install the proc_fs entry */
    my_proc_entry = proc_create("rknand",
                           S_IRUGO | S_IFREG,
                           NANDPROC_ROOT,&my_proc_fops);
}
#endif
void printk_write_log(long lba,int len, const u_char *pbuf)
{
    char debug_buf[100];
    int i;
    for(i=0;i<len;i++)
    {
        sprintf(debug_buf,"%lx :",lba+i);
        print_hex_dump(KERN_WARNING, debug_buf, DUMP_PREFIX_NONE, 16,4, &pbuf[512*i], 8, 0);
    }
}

static int rknand_read(struct mtd_info *mtd, loff_t from, size_t len,
	size_t *retlen, u_char *buf)
{
	int ret = 0;
	int sector = len>>9;
	int LBA = (int)(from>>9);
#ifdef RKNAND_TRAC_EN
    //trac_log(LBA,sector,0);
#endif
	//printk("R %d %d \n",(int)LBA,sector);
	//if(rknand_debug)
    //   printk("rk28xxnand_read: from=%x,sector=%x,\n",(int)LBA,sector);
    if(sector && gpNandInfo->ftl_read)
    {
		ret = gpNandInfo->ftl_read(LBA, sector, buf);
		if(ret)
		   *retlen = 0;
    }
	return ret;
}

static int rknand_write(struct mtd_info *mtd, loff_t from, size_t len,
	size_t *retlen, const u_char *buf)
{
	int ret = 0;
	int sector = len>>9;
	int LBA = (int)(from>>9);
#ifdef RKNAND_TRAC_EN
    trac_log(LBA,sector,1);
#endif
	//printk("W %d %d \n",(int)LBA,sector);
    //return 0;
	//printk("*");
	//if(rknand_debug)
    //    printk(KERN_NOTICE "write: from=%lx,sector=%x\n",(int)LBA,sector);
    //printk_write_log(LBA,sector,buf);
	if(sector && gpNandInfo->ftl_write)// cmy
	{
		if(LBA < SysImageWriteEndAdd)//0x4E000)
		{
			//NAND_DEBUG(NAND_DEBUG_LEVEL0,">>> FtlWriteImage: LBA=0x%08X  sector=%d\n",LBA, sector);
            ret = gpNandInfo->ftl_write(LBA, sector, (void *)buf,1);
        }
		else
        {
            ret = gpNandInfo->ftl_write(LBA, sector, (void *)buf,0);
        }
	}
	*retlen = len;
	return 0;
}

static int rknand_diacard(struct mtd_info *mtd, loff_t from, size_t len)
{
	int ret = 0;
	int sector = len>>9;
	int LBA = (int)(from>>9);
	//printk("rknand_diacard: from=%x,sector=%x,\n",(int)LBA,sector);
    if(sector && gpNandInfo->ftl_discard)
    {
		ret = gpNandInfo->ftl_discard(LBA, sector);
    }
	return ret;
}

static int rknand_erase(struct mtd_info *mtd, struct erase_info *instr)
{
	int ret = 0;
    if (instr->callback)
		instr->callback(instr);
	return ret;
}

static void rknand_sync(struct mtd_info *mtd)
{
	NAND_DEBUG(NAND_DEBUG_LEVEL0,"rk_nand_sync: \n");
    if(gpNandInfo->ftl_sync)
        gpNandInfo->ftl_sync();
}

extern void FtlWriteCacheEn(int);
static int rknand_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf)
{
	int sector = len >> 9;
	int LBA = (int)(to >> 9);

	if (sector && gpNandInfo->ftl_write_panic) {
	    if(gpNandInfo->ftl_cache_en)
		    gpNandInfo->ftl_cache_en(0);
		gpNandInfo->ftl_write_panic(LBA, sector, (void *)buf);
	    if(gpNandInfo->ftl_cache_en)
		    gpNandInfo->ftl_cache_en(1);
	}
	*retlen = len;
	return 0;
}


int GetIdBlockSysData(char * buf, int Sector)
{
    if(gpNandInfo->GetIdBlockSysData)
	   return( gpNandInfo->GetIdBlockSysData( buf,  Sector));
    return 0;
}

char GetSNSectorInfoBeforeNandInit(char * pbuf)
{
    char * sn_addr = ioremap(0x10501600,0x200);
    memcpy(pbuf,sn_addr,0x200);
    iounmap(sn_addr);
	//print_hex_dump(KERN_WARNING, "sn:", DUMP_PREFIX_NONE, 16,1, sn_addr, 16, 0);
    return 0;
}

char GetSNSectorInfo(char * pbuf)
{
    if(gpNandInfo->GetSNSectorInfo)
	   return( gpNandInfo->GetSNSectorInfo( pbuf));
	else
	   return GetSNSectorInfoBeforeNandInit(pbuf);
    return 0;
}


char GetVendor0InfoBeforeNandInit(char * pbuf)
{
    char * sn_addr = ioremap(0x10501400,0x200);
    memcpy(pbuf,sn_addr + 8,504);
    iounmap(sn_addr);
	//print_hex_dump(KERN_WARNING, "sn:", DUMP_PREFIX_NONE, 16,1, sn_addr, 16, 0);
    return 0;
}

char GetChipSectorInfo(char * pbuf)
{
    if(gpNandInfo->GetChipSectorInfo)
	   return( gpNandInfo->GetChipSectorInfo( pbuf));
    return 0;
}

int  GetParamterInfo(char * pbuf , int len)
{
    int ret = -1;
	int sector = (len)>>9;
	int LBA = 0;
	if(sector && gpNandInfo->ftl_read)
	{
		ret = gpNandInfo->ftl_read(LBA, sector, pbuf);
	}
	return ret?-1:(sector<<9);
}

int  GetflashDataByLba(int lba,char * pbuf , int len)
{
    int ret = -1;
	int sector = (len)>>9;
	int LBA = lba;
	if(sector && gpNandInfo->ftl_read)
	{
		ret = gpNandInfo->ftl_read(LBA, sector, pbuf);
	}
	return ret?-1:(sector<<9);
}

void rknand_dev_cache_flush(void)
{
    if(gpNandInfo->rknand_dev_cache_flush)
        gpNandInfo->rknand_dev_cache_flush();
}


static int rknand_block_isbad(struct mtd_info *mtd, loff_t ofs)
{
	return 0;
}

static int rknand_block_markbad(struct mtd_info *mtd, loff_t ofs)
{
	return 0;
}


static struct clk			*nandc_clk;
static unsigned long		 nandc_clk_rate = 0;
static struct notifier_block   nandc_freq_transition;
/* cpufreq driver support */
static int rknand_nand_timing_cfg(void)
{
	unsigned long newclk;
	newclk = clk_get_rate(nandc_clk);
	//printk("rknand_nand_timing_cfg %d",newclk);
	if (newclk != nandc_clk_rate)
	{
        if(gpNandInfo->nand_timing_config)
        {
            nandc_clk_rate = newclk;
            //gpNandInfo->nand_timing_config( nandc_clk_rate / 1000); // KHz
        }
	}
	return 0;
}

static int rknand_info_init(struct rknand_info *nand_info)
{
	struct mtd_info	   *mtd = &rknand_mtd;
	struct rknand_chip *rknand = &nand_info->rknand;

	rknand->state = FL_READY;
	rknand->rknand_schedule_enable = 1;
	rknand->pFlashCallBack = NULL;
	init_waitqueue_head(&rknand->wq);

    mtd->oobsize = 0;
    mtd->oobavail = 0;
    mtd->ecclayout = 0;
    mtd->erasesize = 32*0x200;
    mtd->writesize = 8*0x200;

	// Fill in remaining MTD driver data
	mtd->type = MTD_NANDFLASH;
	mtd->flags = (MTD_WRITEABLE|MTD_NO_ERASE);//
	mtd->_erase = rknand_erase;
	mtd->_point = NULL;
	mtd->_unpoint = NULL;
	mtd->_read = rknand_read;
	mtd->_write = rknand_write;
	//mtd->discard = rknand_diacard;
	mtd->_read_oob = NULL;
	mtd->_write_oob = NULL;
	mtd->_panic_write = rknand_panic_write;

	mtd->_sync = rknand_sync;
	mtd->_lock = NULL;
	mtd->_unlock = NULL;
	mtd->_suspend = NULL;
	mtd->_resume = NULL;
	mtd->_block_isbad = rknand_block_isbad;
	mtd->_block_markbad = rknand_block_markbad;
	mtd->owner = THIS_MODULE;
    return 0;
}


/*
 * CMY: �����˶������з�����Ϣ��֧��
 *		��cmdline���ṩ������Ϣ����ʹ��cmdline�ķ�����Ϣ���з���
 *		��cmdlineû���ṩ������Ϣ����ʹ��Ĭ�ϵķ�����Ϣ(rk28_partition_info)���з���
 */

#ifdef CONFIG_MTD_CMDLINE_PARTS
const char *part_probes[] = { "cmdlinepart", NULL };
#endif

static int rknand_add_partitions(struct rknand_info *nand_info)
{
#ifdef CONFIG_MTD_CMDLINE_PARTS
    int num_partitions = 0;

	// �������н�����������Ϣ
    num_partitions = parse_mtd_partitions(&(rknand_mtd), part_probes, &rknand_parts, 0);
    NAND_DEBUG(NAND_DEBUG_LEVEL0,"num_partitions = %d\n",num_partitions);
	printk("num_partitions = %d\n",num_partitions);
    if(num_partitions > 0) {
    	int i;
    	for (i = 0; i < num_partitions; i++)
        {
            rknand_parts[i].offset *= 0x200;
            rknand_parts[i].size   *=0x200;
    	}
        rknand_parts[num_partitions - 1].size = rknand_mtd.size - rknand_parts[num_partitions - 1].offset;

		g_num_partitions = num_partitions;
//#if (LINUX_VERSION_CODE >= KERNEL_VERSION(3, 0, 0))
//		return mtd_device_register(&rknand_mtd, rknand_parts, num_partitions);
//#else
		return add_mtd_partitions(&(rknand_mtd), rknand_parts, num_partitions);
//#endif
    }
#endif
    g_num_partitions = 0;
	return 0;
}

int add_rknand_device(struct rknand_info * prknand_Info)
{
    struct mtd_partition *parts;
    int i;
    NAND_DEBUG(NAND_DEBUG_LEVEL0,"add_rknand_device: \n");
    printk("gpNandInfo->nandCapacity = %lx\n",gpNandInfo->nandCapacity);
    rknand_mtd.size = (uint64_t)gpNandInfo->nandCapacity*0x200;

    rknand_add_partitions(prknand_Info);

    parts = rknand_parts;
	SysImageWriteEndAdd = 0;
    for(i=0;i<g_num_partitions;i++)
    {
        //printk(">>> part[%d]: name=%s offset=0x%012llx\n", i, parts[i].name, parts[i].offset);
        if(strcmp(parts[i].name,"backup") == 0)
        {
            SysImageWriteEndAdd = (unsigned long)(parts[i].offset + parts[i].size)>>9;//sector
            //printk(">>> SysImageWriteEndAdd=0x%lx\n", SysImageWriteEndAdd);
            break;
        }
    }
	if(SysImageWriteEndAdd)
    	gpNandInfo->SysImageWriteEndAdd = SysImageWriteEndAdd;

	//nandc_clk = clk_get(NULL, "nandc");
	//clk_enable(nandc_clk);
    //rknand_nand_timing_cfg();

    return 0;
}

int get_rknand_device(struct rknand_info ** prknand_Info)
{
    *prknand_Info = gpNandInfo;
    return 0;
}

EXPORT_SYMBOL(get_rknand_device);

int rknand_dma_map_single(unsigned long ptr,int size,int dir)
{
    return dma_map_single(NULL, ptr,size, dir?DMA_TO_DEVICE:DMA_FROM_DEVICE);
}
EXPORT_SYMBOL(rknand_dma_map_single);

void rknand_dma_unmap_single(unsigned long ptr,int size,int dir)
{
    dma_unmap_single(NULL, ptr,size, dir?DMA_TO_DEVICE:DMA_FROM_DEVICE);
}
EXPORT_SYMBOL(rknand_dma_unmap_single);

int rknand_flash_cs_init(void)
{

}
EXPORT_SYMBOL(rknand_flash_cs_init);


int rknand_get_reg_addr(int *pNandc,int *pSDMMC0,int *pSDMMC1,int *pSDMMC2)
{
    //*pNandc = ioremap(RK30_NANDC_PHYS,RK30_NANDC_SIZE);
    //*pSDMMC0 = ioremap(SDMMC0_BASE_ADDR, 0x4000);
    //*pSDMMC1 = ioremap(SDMMC1_BASE_ADDR, 0x4000);
    //*pSDMMC2 = ioremap(EMMC_BASE_ADDR,   0x4000);
	*pNandc = ioremap(0x10500000,0x4000);
}
EXPORT_SYMBOL(rknand_get_reg_addr);

static int g_nandc_irq = 27;
int rknand_nandc_irq_init(int mode,void * pfun)
{
    int ret = 0;
    if(mode) //init
    {
        ret = request_irq(g_nandc_irq, pfun, 0, "nandc", NULL);
        if(ret)
            printk("request IRQ_NANDC irq , ret=%x.........\n", ret);
    }
    else //deinit
    {
        free_irq(g_nandc_irq,  NULL);
    }
    return ret;
}
EXPORT_SYMBOL(rknand_nandc_irq_init);
static int rknand_probe(struct platform_device *pdev)
{
	struct rknand_info *nand_info;
	int err = 0;
	NAND_DEBUG(NAND_DEBUG_LEVEL0,"rk_nand_probe: \n");
	gpNandInfo = kzalloc(sizeof(struct rknand_info), GFP_KERNEL);
	if (!gpNandInfo)
		return -ENOMEM;

    nand_info = gpNandInfo;
	printk("rknand_probe: \n");

	g_nandc_irq = platform_get_irq(pdev, 0);
	if (g_nandc_irq < 0) {
		dev_err(&pdev->dev, "no irq resource?\n");
		return g_nandc_irq;
	}

    memset(gpNandInfo,0,sizeof(struct rknand_info));

    gpNandInfo->bufSize = MAX_BUFFER_SIZE * 512;
    gpNandInfo->pbuf = (char *)NULL;//grknand_buf;
    gpNandInfo->pdmaBuf = (char *)NULL;//grknand_dma_buf;
    //printk(" gpNandInfo->pdmaBuf=0x%x\n",  gpNandInfo->pdmaBuf);
#ifdef CONFIG_MTD_EMMC_CLK_POWER_SAVE
    gpNandInfo->emmc_clk_power_save_en = 1;
#endif

	rknand_mtd.name = DRIVER_NAME;//dev_name(&pdev->dev);
	rknand_mtd.priv = &nand_info->rknand;
	rknand_mtd.owner = THIS_MODULE;

	if(rknand_info_init(nand_info))
	{
		err = -ENXIO;
		goto  exit_free;
	}

	nand_info->add_rknand_device = add_rknand_device;
	nand_info->get_rknand_device = get_rknand_device;

	rknand_create_procfs();
	return 0;

exit_free:
	if(nand_info)
      	kfree(nand_info);

	return err;
}

static int rknand_suspend(struct platform_device *pdev, pm_message_t state)
{
    gpNandInfo->rknand.rknand_schedule_enable = 0;
   // if(gpNandInfo->rknand_suspend)
     //   gpNandInfo->rknand_suspend();
	NAND_DEBUG(NAND_DEBUG_LEVEL0,"rknand_suspend: \n");
	return 0;
}

static int rknand_resume(struct platform_device *pdev)
{
    //if(gpNandInfo->rknand_resume)
      // gpNandInfo->rknand_resume();
    gpNandInfo->rknand.rknand_schedule_enable = 1;
	NAND_DEBUG(NAND_DEBUG_LEVEL0,"rknand_resume: \n");
	return 0;
}

void rknand_shutdown(struct platform_device *pdev)
{
    printk("rknand_shutdown...\n");
    gpNandInfo->rknand.rknand_schedule_enable = 0;
    if(gpNandInfo->rknand_buffer_shutdown)
        gpNandInfo->rknand_buffer_shutdown();
}

#ifdef CONFIG_OF
static const struct of_device_id of_rk_nandc_match[] = {
	{ .compatible = "rockchip,rk-nandc" },
	{ /* Sentinel */ }
};
#endif

static struct platform_driver rknand_driver = {
	.probe		= rknand_probe,
	.suspend	= rknand_suspend,
	.resume		= rknand_resume,
	.shutdown   = rknand_shutdown,
	.driver		= {
		.name	= DRIVER_NAME,
#ifdef CONFIG_OF
    	.of_match_table	= of_rk_nandc_match,
#endif
		.owner	= THIS_MODULE,
	},
};


MODULE_ALIAS(DRIVER_NAME);

static int __init rknand_init(void)
{
	int ret;
	NAND_DEBUG(NAND_DEBUG_LEVEL0,"rknand_init: \n");
	ret = platform_driver_register(&rknand_driver);
	NAND_DEBUG(NAND_DEBUG_LEVEL0,"platform_driver_register:ret = %x \n",ret);
	return ret;
}

static void __exit rknand_exit(void)
{
    platform_driver_unregister(&rknand_driver);
}

module_init(rknand_init);
module_exit(rknand_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("ZYF <zyf@rock-chips.com>");
MODULE_DESCRIPTION("rknand driver.");