[linux-2.6-block.git] / drivers / mtd / nand / jz4740_nand.c

/*
 *  Copyright (C) 2009-2010, Lars-Peter Clausen <lars@metafoo.de>
 *  JZ4740 SoC NAND controller driver
 *
 *  This program is free software; you can redistribute it and/or modify it
 *  under  the terms of the GNU General  Public License as published by the
 *  Free Software Foundation;  either version 2 of the License, or (at your
 *  option) any later version.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */

#include <linux/ioport.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/slab.h>

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

#include <linux/gpio.h>

#include <asm/mach-jz4740/jz4740_nand.h>

#define JZ_REG_NAND_CTRL	0x50
#define JZ_REG_NAND_ECC_CTRL	0x100
#define JZ_REG_NAND_DATA	0x104
#define JZ_REG_NAND_PAR0	0x108
#define JZ_REG_NAND_PAR1	0x10C
#define JZ_REG_NAND_PAR2	0x110
#define JZ_REG_NAND_IRQ_STAT	0x114
#define JZ_REG_NAND_IRQ_CTRL	0x118
#define JZ_REG_NAND_ERR(x)	(0x11C + ((x) << 2))

#define JZ_NAND_ECC_CTRL_PAR_READY	BIT(4)
#define JZ_NAND_ECC_CTRL_ENCODING	BIT(3)
#define JZ_NAND_ECC_CTRL_RS		BIT(2)
#define JZ_NAND_ECC_CTRL_RESET		BIT(1)
#define JZ_NAND_ECC_CTRL_ENABLE		BIT(0)

#define JZ_NAND_STATUS_ERR_COUNT	(BIT(31) | BIT(30) | BIT(29))
#define JZ_NAND_STATUS_PAD_FINISH	BIT(4)
#define JZ_NAND_STATUS_DEC_FINISH	BIT(3)
#define JZ_NAND_STATUS_ENC_FINISH	BIT(2)
#define JZ_NAND_STATUS_UNCOR_ERROR	BIT(1)
#define JZ_NAND_STATUS_ERROR		BIT(0)

#define JZ_NAND_CTRL_ENABLE_CHIP(x) BIT((x) << 1)
#define JZ_NAND_CTRL_ASSERT_CHIP(x) BIT(((x) << 1) + 1)
#define JZ_NAND_CTRL_ASSERT_CHIP_MASK 0xaa

#define JZ_NAND_MEM_CMD_OFFSET 0x08000
#define JZ_NAND_MEM_ADDR_OFFSET 0x10000

struct jz_nand {
	struct mtd_info mtd;
	struct nand_chip chip;
	void __iomem *base;
	struct resource *mem;

	unsigned char banks[JZ_NAND_NUM_BANKS];
	void __iomem *bank_base[JZ_NAND_NUM_BANKS];
	struct resource *bank_mem[JZ_NAND_NUM_BANKS];

	int selected_bank;

	struct gpio_desc *busy_gpio;
	bool is_reading;
};

static inline struct jz_nand *mtd_to_jz_nand(struct mtd_info *mtd)
{
	return container_of(mtd, struct jz_nand, mtd);
}

static void jz_nand_select_chip(struct mtd_info *mtd, int chipnr)
{
	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	struct nand_chip *chip = mtd->priv;
	uint32_t ctrl;
	int banknr;

	ctrl = readl(nand->base + JZ_REG_NAND_CTRL);
	ctrl &= ~JZ_NAND_CTRL_ASSERT_CHIP_MASK;

	if (chipnr == -1) {
		banknr = -1;
	} else {
		banknr = nand->banks[chipnr] - 1;
		chip->IO_ADDR_R = nand->bank_base[banknr];
		chip->IO_ADDR_W = nand->bank_base[banknr];
	}
	writel(ctrl, nand->base + JZ_REG_NAND_CTRL);

	nand->selected_bank = banknr;
}

static void jz_nand_cmd_ctrl(struct mtd_info *mtd, int dat, unsigned int ctrl)
{
	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	struct nand_chip *chip = mtd->priv;
	uint32_t reg;
	void __iomem *bank_base = nand->bank_base[nand->selected_bank];

	BUG_ON(nand->selected_bank < 0);

	if (ctrl & NAND_CTRL_CHANGE) {
		BUG_ON((ctrl & NAND_ALE) && (ctrl & NAND_CLE));
		if (ctrl & NAND_ALE)
			bank_base += JZ_NAND_MEM_ADDR_OFFSET;
		else if (ctrl & NAND_CLE)
			bank_base += JZ_NAND_MEM_CMD_OFFSET;
		chip->IO_ADDR_W = bank_base;

		reg = readl(nand->base + JZ_REG_NAND_CTRL);
		if (ctrl & NAND_NCE)
			reg |= JZ_NAND_CTRL_ASSERT_CHIP(nand->selected_bank);
		else
			reg &= ~JZ_NAND_CTRL_ASSERT_CHIP(nand->selected_bank);
		writel(reg, nand->base + JZ_REG_NAND_CTRL);
	}
	if (dat != NAND_CMD_NONE)
		writeb(dat, chip->IO_ADDR_W);
}

static int jz_nand_dev_ready(struct mtd_info *mtd)
{
	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	return gpiod_get_value_cansleep(nand->busy_gpio);
}

static void jz_nand_hwctl(struct mtd_info *mtd, int mode)
{
	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	uint32_t reg;

	writel(0, nand->base + JZ_REG_NAND_IRQ_STAT);
	reg = readl(nand->base + JZ_REG_NAND_ECC_CTRL);

	reg |= JZ_NAND_ECC_CTRL_RESET;
	reg |= JZ_NAND_ECC_CTRL_ENABLE;
	reg |= JZ_NAND_ECC_CTRL_RS;

	switch (mode) {
	case NAND_ECC_READ:
		reg &= ~JZ_NAND_ECC_CTRL_ENCODING;
		nand->is_reading = true;
		break;
	case NAND_ECC_WRITE:
		reg |= JZ_NAND_ECC_CTRL_ENCODING;
		nand->is_reading = false;
		break;
	default:
		break;
	}

	writel(reg, nand->base + JZ_REG_NAND_ECC_CTRL);
}

static int jz_nand_calculate_ecc_rs(struct mtd_info *mtd, const uint8_t *dat,
	uint8_t *ecc_code)
{
	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	uint32_t reg, status;
	int i;
	unsigned int timeout = 1000;
	static uint8_t empty_block_ecc[] = {0xcd, 0x9d, 0x90, 0x58, 0xf4,
						0x8b, 0xff, 0xb7, 0x6f};

	if (nand->is_reading)
		return 0;

	do {
		status = readl(nand->base + JZ_REG_NAND_IRQ_STAT);
	} while (!(status & JZ_NAND_STATUS_ENC_FINISH) && --timeout);

	if (timeout == 0)
	    return -1;

	reg = readl(nand->base + JZ_REG_NAND_ECC_CTRL);
	reg &= ~JZ_NAND_ECC_CTRL_ENABLE;
	writel(reg, nand->base + JZ_REG_NAND_ECC_CTRL);

	for (i = 0; i < 9; ++i)
		ecc_code[i] = readb(nand->base + JZ_REG_NAND_PAR0 + i);

	/* If the written data is completly 0xff, we also want to write 0xff as
	 * ecc, otherwise we will get in trouble when doing subpage writes. */
	if (memcmp(ecc_code, empty_block_ecc, 9) == 0)
		memset(ecc_code, 0xff, 9);

	return 0;
}

static void jz_nand_correct_data(uint8_t *dat, int index, int mask)
{
	int offset = index & 0x7;
	uint16_t data;

	index += (index >> 3);

	data = dat[index];
	data |= dat[index+1] << 8;

	mask ^= (data >> offset) & 0x1ff;
	data &= ~(0x1ff << offset);
	data |= (mask << offset);

	dat[index] = data & 0xff;
	dat[index+1] = (data >> 8) & 0xff;
}

static int jz_nand_correct_ecc_rs(struct mtd_info *mtd, uint8_t *dat,
	uint8_t *read_ecc, uint8_t *calc_ecc)
{
	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	int i, error_count, index;
	uint32_t reg, status, error;
	uint32_t t;
	unsigned int timeout = 1000;

	t = read_ecc[0];

	if (t == 0xff) {
		for (i = 1; i < 9; ++i)
			t &= read_ecc[i];

		t &= dat[0];
		t &= dat[nand->chip.ecc.size / 2];
		t &= dat[nand->chip.ecc.size - 1];

		if (t == 0xff) {
			for (i = 1; i < nand->chip.ecc.size - 1; ++i)
				t &= dat[i];
			if (t == 0xff)
				return 0;
		}
	}

	for (i = 0; i < 9; ++i)
		writeb(read_ecc[i], nand->base + JZ_REG_NAND_PAR0 + i);

	reg = readl(nand->base + JZ_REG_NAND_ECC_CTRL);
	reg |= JZ_NAND_ECC_CTRL_PAR_READY;
	writel(reg, nand->base + JZ_REG_NAND_ECC_CTRL);

	do {
		status = readl(nand->base + JZ_REG_NAND_IRQ_STAT);
	} while (!(status & JZ_NAND_STATUS_DEC_FINISH) && --timeout);

	if (timeout == 0)
	    return -1;

	reg = readl(nand->base + JZ_REG_NAND_ECC_CTRL);
	reg &= ~JZ_NAND_ECC_CTRL_ENABLE;
	writel(reg, nand->base + JZ_REG_NAND_ECC_CTRL);

	if (status & JZ_NAND_STATUS_ERROR) {
		if (status & JZ_NAND_STATUS_UNCOR_ERROR)
			return -1;

		error_count = (status & JZ_NAND_STATUS_ERR_COUNT) >> 29;

		for (i = 0; i < error_count; ++i) {
			error = readl(nand->base + JZ_REG_NAND_ERR(i));
			index = ((error >> 16) & 0x1ff) - 1;
			if (index >= 0 && index < 512)
				jz_nand_correct_data(dat, index, error & 0x1ff);
		}

		return error_count;
	}

	return 0;
}

static int jz_nand_ioremap_resource(struct platform_device *pdev,
	const char *name, struct resource **res, void *__iomem *base)
{
	int ret;

	*res = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
	if (!*res) {
		dev_err(&pdev->dev, "Failed to get platform %s memory\n", name);
		ret = -ENXIO;
		goto err;
	}

	*res = request_mem_region((*res)->start, resource_size(*res),
				pdev->name);
	if (!*res) {
		dev_err(&pdev->dev, "Failed to request %s memory region\n", name);
		ret = -EBUSY;
		goto err;
	}

	*base = ioremap((*res)->start, resource_size(*res));
	if (!*base) {
		dev_err(&pdev->dev, "Failed to ioremap %s memory region\n", name);
		ret = -EBUSY;
		goto err_release_mem;
	}

	return 0;

err_release_mem:
	release_mem_region((*res)->start, resource_size(*res));
err:
	*res = NULL;
	*base = NULL;
	return ret;
}

static inline void jz_nand_iounmap_resource(struct resource *res,
					    void __iomem *base)
{
	iounmap(base);
	release_mem_region(res->start, resource_size(res));
}

static int jz_nand_detect_bank(struct platform_device *pdev,
			       struct jz_nand *nand, unsigned char bank,
			       size_t chipnr, uint8_t *nand_maf_id,
			       uint8_t *nand_dev_id)
{
	int ret;
	int gpio;
	char gpio_name[9];
	char res_name[6];
	uint32_t ctrl;
	struct mtd_info *mtd = &nand->mtd;
	struct nand_chip *chip = &nand->chip;

	/* Request GPIO port. */
	gpio = JZ_GPIO_MEM_CS0 + bank - 1;
	sprintf(gpio_name, "NAND CS%d", bank);
	ret = gpio_request(gpio, gpio_name);
	if (ret) {
		dev_warn(&pdev->dev,
			"Failed to request %s gpio %d: %d\n",
			gpio_name, gpio, ret);
		goto notfound_gpio;
	}

	/* Request I/O resource. */
	sprintf(res_name, "bank%d", bank);
	ret = jz_nand_ioremap_resource(pdev, res_name,
					&nand->bank_mem[bank - 1],
					&nand->bank_base[bank - 1]);
	if (ret)
		goto notfound_resource;

	/* Enable chip in bank. */
	jz_gpio_set_function(gpio, JZ_GPIO_FUNC_MEM_CS0);
	ctrl = readl(nand->base + JZ_REG_NAND_CTRL);
	ctrl |= JZ_NAND_CTRL_ENABLE_CHIP(bank - 1);
	writel(ctrl, nand->base + JZ_REG_NAND_CTRL);

	if (chipnr == 0) {
		/* Detect first chip. */
		ret = nand_scan_ident(mtd, 1, NULL);
		if (ret)
			goto notfound_id;

		/* Retrieve the IDs from the first chip. */
		chip->select_chip(mtd, 0);
		chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
		*nand_maf_id = chip->read_byte(mtd);
		*nand_dev_id = chip->read_byte(mtd);
	} else {
		/* Detect additional chip. */
		chip->select_chip(mtd, chipnr);
		chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
		if (*nand_maf_id != chip->read_byte(mtd)
		 || *nand_dev_id != chip->read_byte(mtd)) {
			ret = -ENODEV;
			goto notfound_id;
		}

		/* Update size of the MTD. */
		chip->numchips++;
		mtd->size += chip->chipsize;
	}

	dev_info(&pdev->dev, "Found chip %i on bank %i\n", chipnr, bank);
	return 0;

notfound_id:
	dev_info(&pdev->dev, "No chip found on bank %i\n", bank);
	ctrl &= ~(JZ_NAND_CTRL_ENABLE_CHIP(bank - 1));
	writel(ctrl, nand->base + JZ_REG_NAND_CTRL);
	jz_gpio_set_function(gpio, JZ_GPIO_FUNC_NONE);
	jz_nand_iounmap_resource(nand->bank_mem[bank - 1],
				 nand->bank_base[bank - 1]);
notfound_resource:
	gpio_free(gpio);
notfound_gpio:
	return ret;
}

static int jz_nand_probe(struct platform_device *pdev)
{
	int ret;
	struct jz_nand *nand;
	struct nand_chip *chip;
	struct mtd_info *mtd;
	struct jz_nand_platform_data *pdata = dev_get_platdata(&pdev->dev);
	size_t chipnr, bank_idx;
	uint8_t nand_maf_id = 0, nand_dev_id = 0;

	nand = kzalloc(sizeof(*nand), GFP_KERNEL);
	if (!nand)
		return -ENOMEM;

	ret = jz_nand_ioremap_resource(pdev, "mmio", &nand->mem, &nand->base);
	if (ret)
		goto err_free;

	nand->busy_gpio = devm_gpiod_get_optional(&pdev->dev, "busy", GPIOD_IN);
	if (IS_ERR(nand->busy_gpio)) {
		ret = PTR_ERR(nand->busy_gpio);
		dev_err(&pdev->dev, "Failed to request busy gpio %d\n",
		    ret);
		goto err_iounmap_mmio;
	}

	mtd		= &nand->mtd;
	chip		= &nand->chip;
	mtd->priv	= chip;
	mtd->dev.parent = &pdev->dev;
	mtd->name	= "jz4740-nand";

	chip->ecc.hwctl		= jz_nand_hwctl;
	chip->ecc.calculate	= jz_nand_calculate_ecc_rs;
	chip->ecc.correct	= jz_nand_correct_ecc_rs;
	chip->ecc.mode		= NAND_ECC_HW_OOB_FIRST;
	chip->ecc.size		= 512;
	chip->ecc.bytes		= 9;
	chip->ecc.strength	= 4;

	if (pdata)
		chip->ecc.layout = pdata->ecc_layout;

	chip->chip_delay = 50;
	chip->cmd_ctrl = jz_nand_cmd_ctrl;
	chip->select_chip = jz_nand_select_chip;

	if (nand->busy_gpio)
		chip->dev_ready = jz_nand_dev_ready;

	platform_set_drvdata(pdev, nand);

	/* We are going to autodetect NAND chips in the banks specified in the
	 * platform data. Although nand_scan_ident() can detect multiple chips,
	 * it requires those chips to be numbered consecuitively, which is not
	 * always the case for external memory banks. And a fixed chip-to-bank
	 * mapping is not practical either, since for example Dingoo units
	 * produced at different times have NAND chips in different banks.
	 */
	chipnr = 0;
	for (bank_idx = 0; bank_idx < JZ_NAND_NUM_BANKS; bank_idx++) {
		unsigned char bank;

		/* If there is no platform data, look for NAND in bank 1,
		 * which is the most likely bank since it is the only one
		 * that can be booted from.
		 */
		bank = pdata ? pdata->banks[bank_idx] : bank_idx ^ 1;
		if (bank == 0)
			break;
		if (bank > JZ_NAND_NUM_BANKS) {
			dev_warn(&pdev->dev,
				"Skipping non-existing bank: %d\n", bank);
			continue;
		}
		/* The detection routine will directly or indirectly call
		 * jz_nand_select_chip(), so nand->banks has to contain the
		 * bank we're checking.
		 */
		nand->banks[chipnr] = bank;
		if (jz_nand_detect_bank(pdev, nand, bank, chipnr,
					&nand_maf_id, &nand_dev_id) == 0)
			chipnr++;
		else
			nand->banks[chipnr] = 0;
	}
	if (chipnr == 0) {
		dev_err(&pdev->dev, "No NAND chips found\n");
		goto err_iounmap_mmio;
	}

	if (pdata && pdata->ident_callback) {
		pdata->ident_callback(pdev, chip, &pdata->partitions,
					&pdata->num_partitions);
	}

	ret = nand_scan_tail(mtd);
	if (ret) {
		dev_err(&pdev->dev,  "Failed to scan NAND\n");
		goto err_unclaim_banks;
	}

	ret = mtd_device_parse_register(mtd, NULL, NULL,
					pdata ? pdata->partitions : NULL,
					pdata ? pdata->num_partitions : 0);

	if (ret) {
		dev_err(&pdev->dev, "Failed to add mtd device\n");
		goto err_nand_release;
	}

	dev_info(&pdev->dev, "Successfully registered JZ4740 NAND driver\n");

	return 0;

err_nand_release:
	nand_release(mtd);
err_unclaim_banks:
	while (chipnr--) {
		unsigned char bank = nand->banks[chipnr];
		gpio_free(JZ_GPIO_MEM_CS0 + bank - 1);
		jz_nand_iounmap_resource(nand->bank_mem[bank - 1],
					 nand->bank_base[bank - 1]);
	}
	writel(0, nand->base + JZ_REG_NAND_CTRL);
err_iounmap_mmio:
	jz_nand_iounmap_resource(nand->mem, nand->base);
err_free:
	kfree(nand);
	return ret;
}

static int jz_nand_remove(struct platform_device *pdev)
{
	struct jz_nand *nand = platform_get_drvdata(pdev);
	size_t i;

	nand_release(&nand->mtd);

	/* Deassert and disable all chips */
	writel(0, nand->base + JZ_REG_NAND_CTRL);

	for (i = 0; i < JZ_NAND_NUM_BANKS; ++i) {
		unsigned char bank = nand->banks[i];
		if (bank != 0) {
			jz_nand_iounmap_resource(nand->bank_mem[bank - 1],
						 nand->bank_base[bank - 1]);
			gpio_free(JZ_GPIO_MEM_CS0 + bank - 1);
		}
	}

	jz_nand_iounmap_resource(nand->mem, nand->base);

	kfree(nand);

	return 0;
}

static struct platform_driver jz_nand_driver = {
	.probe = jz_nand_probe,
	.remove = jz_nand_remove,
	.driver = {
		.name = "jz4740-nand",
	},
};

module_platform_driver(jz_nand_driver);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
MODULE_DESCRIPTION("NAND controller driver for JZ4740 SoC");
MODULE_ALIAS("platform:jz4740-nand");
Commit	Line	Data
ba01d6ec LPC	1	/*
	2	* Copyright (C) 2009-2010, Lars-Peter Clausen <lars@metafoo.de>
	3	* JZ4740 SoC NAND controller driver
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License as published by the
	7	* Free Software Foundation; either version 2 of the License, or (at your
	8	* option) any later version.
	9	*
	10	* You should have received a copy of the GNU General Public License along
	11	* with this program; if not, write to the Free Software Foundation, Inc.,
	12	* 675 Mass Ave, Cambridge, MA 02139, USA.
	13	*
	14	*/
	15
	16	#include <linux/ioport.h>
	17	#include <linux/kernel.h>
	18	#include <linux/module.h>
	19	#include <linux/platform_device.h>
	20	#include <linux/slab.h>
	21
	22	#include <linux/mtd/mtd.h>
	23	#include <linux/mtd/nand.h>
	24	#include <linux/mtd/partitions.h>
	25
	26	#include <linux/gpio.h>
	27
	28	#include <asm/mach-jz4740/jz4740_nand.h>
	29
	30	#define JZ_REG_NAND_CTRL 0x50
	31	#define JZ_REG_NAND_ECC_CTRL 0x100
	32	#define JZ_REG_NAND_DATA 0x104
	33	#define JZ_REG_NAND_PAR0 0x108
	34	#define JZ_REG_NAND_PAR1 0x10C
	35	#define JZ_REG_NAND_PAR2 0x110
	36	#define JZ_REG_NAND_IRQ_STAT 0x114
	37	#define JZ_REG_NAND_IRQ_CTRL 0x118
	38	#define JZ_REG_NAND_ERR(x) (0x11C + ((x) << 2))
	39
	40	#define JZ_NAND_ECC_CTRL_PAR_READY BIT(4)
	41	#define JZ_NAND_ECC_CTRL_ENCODING BIT(3)
	42	#define JZ_NAND_ECC_CTRL_RS BIT(2)
	43	#define JZ_NAND_ECC_CTRL_RESET BIT(1)
	44	#define JZ_NAND_ECC_CTRL_ENABLE BIT(0)
	45
	46	#define JZ_NAND_STATUS_ERR_COUNT (BIT(31) \| BIT(30) \| BIT(29))
	47	#define JZ_NAND_STATUS_PAD_FINISH BIT(4)
	48	#define JZ_NAND_STATUS_DEC_FINISH BIT(3)
	49	#define JZ_NAND_STATUS_ENC_FINISH BIT(2)
	50	#define JZ_NAND_STATUS_UNCOR_ERROR BIT(1)
	51	#define JZ_NAND_STATUS_ERROR BIT(0)
	52
	53	#define JZ_NAND_CTRL_ENABLE_CHIP(x) BIT((x) << 1)
	54	#define JZ_NAND_CTRL_ASSERT_CHIP(x) BIT(((x) << 1) + 1)
1471d41a	55	#define JZ_NAND_CTRL_ASSERT_CHIP_MASK 0xaa
ba01d6ec	56
ba01d6ec	57	#define JZ_NAND_MEM_CMD_OFFSET 0x08000
1471d41a	58	#define JZ_NAND_MEM_ADDR_OFFSET 0x10000
ba01d6ec LPC	59
	60	struct jz_nand {
	61	struct mtd_info mtd;
	62	struct nand_chip chip;
	63	void __iomem *base;
	64	struct resource *mem;
	65
1471d41a MH	66	unsigned char banks[JZ_NAND_NUM_BANKS];
	67	void __iomem *bank_base[JZ_NAND_NUM_BANKS];
	68	struct resource *bank_mem[JZ_NAND_NUM_BANKS];
	69
	70	int selected_bank;
ba01d6ec	71
cd145af9	72	struct gpio_desc *busy_gpio;
ba01d6ec LPC	73	bool is_reading;
	74	};
	75
	76	static inline struct jz_nand mtd_to_jz_nand(struct mtd_info mtd)
	77	{
	78	return container_of(mtd, struct jz_nand, mtd);
	79	}
	80
1471d41a MH	81	static void jz_nand_select_chip(struct mtd_info *mtd, int chipnr)
	82	{
	83	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	84	struct nand_chip *chip = mtd->priv;
	85	uint32_t ctrl;
	86	int banknr;
	87
	88	ctrl = readl(nand->base + JZ_REG_NAND_CTRL);
	89	ctrl &= ~JZ_NAND_CTRL_ASSERT_CHIP_MASK;
	90
	91	if (chipnr == -1) {
	92	banknr = -1;
	93	} else {
	94	banknr = nand->banks[chipnr] - 1;
	95	chip->IO_ADDR_R = nand->bank_base[banknr];
	96	chip->IO_ADDR_W = nand->bank_base[banknr];
	97	}
	98	writel(ctrl, nand->base + JZ_REG_NAND_CTRL);
	99
	100	nand->selected_bank = banknr;
	101	}
	102
ba01d6ec LPC	103	static void jz_nand_cmd_ctrl(struct mtd_info *mtd, int dat, unsigned int ctrl)
	104	{
	105	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	106	struct nand_chip *chip = mtd->priv;
	107	uint32_t reg;
1471d41a MH	108	void __iomem *bank_base = nand->bank_base[nand->selected_bank];
	109
	110	BUG_ON(nand->selected_bank < 0);
ba01d6ec LPC	111
	112	if (ctrl & NAND_CTRL_CHANGE) {
	113	BUG_ON((ctrl & NAND_ALE) && (ctrl & NAND_CLE));
	114	if (ctrl & NAND_ALE)
1471d41a	115	bank_base += JZ_NAND_MEM_ADDR_OFFSET;
ba01d6ec	116	else if (ctrl & NAND_CLE)
1471d41a MH	117	bank_base += JZ_NAND_MEM_CMD_OFFSET;
1471d41a MH	118	chip->IO_ADDR_W = bank_base;
ba01d6ec LPC	119
	120	reg = readl(nand->base + JZ_REG_NAND_CTRL);
	121	if (ctrl & NAND_NCE)
1471d41a	122	reg \|= JZ_NAND_CTRL_ASSERT_CHIP(nand->selected_bank);
ba01d6ec	123	else
1471d41a	124	reg &= ~JZ_NAND_CTRL_ASSERT_CHIP(nand->selected_bank);
ba01d6ec LPC	125	writel(reg, nand->base + JZ_REG_NAND_CTRL);
	126	}
	127	if (dat != NAND_CMD_NONE)
	128	writeb(dat, chip->IO_ADDR_W);
	129	}
	130
	131	static int jz_nand_dev_ready(struct mtd_info *mtd)
	132	{
	133	struct jz_nand *nand = mtd_to_jz_nand(mtd);
cd145af9	134	return gpiod_get_value_cansleep(nand->busy_gpio);
ba01d6ec LPC	135	}
	136
	137	static void jz_nand_hwctl(struct mtd_info *mtd, int mode)
	138	{
	139	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	140	uint32_t reg;
	141
	142	writel(0, nand->base + JZ_REG_NAND_IRQ_STAT);
	143	reg = readl(nand->base + JZ_REG_NAND_ECC_CTRL);
	144
	145	reg \|= JZ_NAND_ECC_CTRL_RESET;
	146	reg \|= JZ_NAND_ECC_CTRL_ENABLE;
	147	reg \|= JZ_NAND_ECC_CTRL_RS;
	148
	149	switch (mode) {
	150	case NAND_ECC_READ:
	151	reg &= ~JZ_NAND_ECC_CTRL_ENCODING;
	152	nand->is_reading = true;
	153	break;
	154	case NAND_ECC_WRITE:
	155	reg \|= JZ_NAND_ECC_CTRL_ENCODING;
	156	nand->is_reading = false;
	157	break;
	158	default:
	159	break;
	160	}
	161
	162	writel(reg, nand->base + JZ_REG_NAND_ECC_CTRL);
	163	}
	164
	165	static int jz_nand_calculate_ecc_rs(struct mtd_info mtd, const uint8_t dat,
	166	uint8_t *ecc_code)
	167	{
	168	struct jz_nand *nand = mtd_to_jz_nand(mtd);
	169	uint32_t reg, status;
	170	int i;
	171	unsigned int timeout = 1000;
	172	static uint8_t empty_block_ecc[] = {0xcd, 0x9d, 0x90, 0x58, 0xf4,
	173	0x8b, 0xff, 0xb7, 0x6f};
	174
	175	if (nand->is_reading)
	176	return 0;
	177
	178	do {
	179	status = readl(nand->base + JZ_REG_NAND_IRQ_STAT);
	180	} while (!(status & JZ_NAND_STATUS_ENC_FINISH) && --timeout);
	181
	182	if (timeout == 0)
	183	return -1;
	184
	185	reg = readl(nand->base + JZ_REG_NAND_ECC_CTRL);
	186	reg &= ~JZ_NAND_ECC_CTRL_ENABLE;
	187	writel(reg, nand->base + JZ_REG_NAND_ECC_CTRL);
	188
	189	for (i = 0; i < 9; ++i)
	190	ecc_code[i] = readb(nand->base + JZ_REG_NAND_PAR0 + i);
	191
	192	/* If the written data is completly 0xff, we also want to write 0xff as
	193	* ecc, otherwise we will get in trouble when doing subpage writes. */
	194	if (memcmp(ecc_code, empty_block_ecc, 9) == 0)
	195	memset(ecc_code, 0xff, 9);
	196
	197	return 0;
	198	}
199
200	static void jz_nand_correct_data(uint8_t *dat, int index, int mask)
201	{
202	int offset = index & 0x7;
203	uint16_t data;
204
205	index += (index >> 3);
206
207	data = dat[index];
208	data \|= dat[index+1] << 8;
209
210	mask ^= (data >> offset) & 0x1ff;
211	data &= ~(0x1ff << offset);
212	data \|= (mask << offset);
213
214	dat[index] = data & 0xff;
215	dat[index+1] = (data >> 8) & 0xff;
216	}
217
218	static int jz_nand_correct_ecc_rs(struct mtd_info mtd, uint8_t dat,
219	uint8_t read_ecc, uint8_t calc_ecc)
220	{
221	struct jz_nand *nand = mtd_to_jz_nand(mtd);
222	int i, error_count, index;
223	uint32_t reg, status, error;
224	uint32_t t;
225	unsigned int timeout = 1000;
226
227	t = read_ecc[0];
228
229	if (t == 0xff) {
230	for (i = 1; i < 9; ++i)
231	t &= read_ecc[i];
232
233	t &= dat[0];
234	t &= dat[nand->chip.ecc.size / 2];
235	t &= dat[nand->chip.ecc.size - 1];
236
237	if (t == 0xff) {
238	for (i = 1; i < nand->chip.ecc.size - 1; ++i)
239	t &= dat[i];
240	if (t == 0xff)
241	return 0;
242	}
243	}
244
245	for (i = 0; i < 9; ++i)
246	writeb(read_ecc[i], nand->base + JZ_REG_NAND_PAR0 + i);
247
248	reg = readl(nand->base + JZ_REG_NAND_ECC_CTRL);
249	reg \|= JZ_NAND_ECC_CTRL_PAR_READY;
250	writel(reg, nand->base + JZ_REG_NAND_ECC_CTRL);
251
252	do {
253	status = readl(nand->base + JZ_REG_NAND_IRQ_STAT);
254	} while (!(status & JZ_NAND_STATUS_DEC_FINISH) && --timeout);
255
256	if (timeout == 0)
257	return -1;
258
259	reg = readl(nand->base + JZ_REG_NAND_ECC_CTRL);
260	reg &= ~JZ_NAND_ECC_CTRL_ENABLE;
261	writel(reg, nand->base + JZ_REG_NAND_ECC_CTRL);
262
263	if (status & JZ_NAND_STATUS_ERROR) {
264	if (status & JZ_NAND_STATUS_UNCOR_ERROR)
265	return -1;
266
267	error_count = (status & JZ_NAND_STATUS_ERR_COUNT) >> 29;
268
269	for (i = 0; i < error_count; ++i) {
270	error = readl(nand->base + JZ_REG_NAND_ERR(i));
271	index = ((error >> 16) & 0x1ff) - 1;
272	if (index >= 0 && index < 512)
273	jz_nand_correct_data(dat, index, error & 0x1ff);
274	}
275
276	return error_count;
277	}
278
279	return 0;
280	}
281
ba01d6ec	282	static int jz_nand_ioremap_resource(struct platform_device *pdev,
1471d41a	283	const char name, struct resource res, void __iomem *base)
ba01d6ec LPC	284	{
	285	int ret;
	286
	287	*res = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
	288	if (!*res) {
	289	dev_err(&pdev->dev, "Failed to get platform %s memory\n", name);
	290	ret = -ENXIO;
	291	goto err;
	292	}
	293
	294	res = request_mem_region((res)->start, resource_size(*res),
	295	pdev->name);
	296	if (!*res) {
	297	dev_err(&pdev->dev, "Failed to request %s memory region\n", name);
	298	ret = -EBUSY;
	299	goto err;
	300	}
	301
	302	base = ioremap((res)->start, resource_size(*res));
	303	if (!*base) {
	304	dev_err(&pdev->dev, "Failed to ioremap %s memory region\n", name);
	305	ret = -EBUSY;
	306	goto err_release_mem;
	307	}
	308
	309	return 0;
	310
	311	err_release_mem:
	312	release_mem_region((res)->start, resource_size(res));
	313	err:
	314	*res = NULL;
	315	*base = NULL;
	316	return ret;
	317	}
	318
7bf350b7 AB	319	static inline void jz_nand_iounmap_resource(struct resource *res,
7bf350b7 AB	320	void __iomem *base)
1471d41a MH	321	{
	322	iounmap(base);
	323	release_mem_region(res->start, resource_size(res));
	324	}
	325
7bf350b7 AB	326	static int jz_nand_detect_bank(struct platform_device *pdev,
	327	struct jz_nand *nand, unsigned char bank,
	328	size_t chipnr, uint8_t *nand_maf_id,
d8929942 GKH	329	uint8_t *nand_dev_id)
d8929942 GKH	330	{
1471d41a MH	331	int ret;
	332	int gpio;
	333	char gpio_name[9];
	334	char res_name[6];
	335	uint32_t ctrl;
	336	struct mtd_info *mtd = &nand->mtd;
	337	struct nand_chip *chip = &nand->chip;
	338
	339	/* Request GPIO port. */
	340	gpio = JZ_GPIO_MEM_CS0 + bank - 1;
	341	sprintf(gpio_name, "NAND CS%d", bank);
	342	ret = gpio_request(gpio, gpio_name);
	343	if (ret) {
	344	dev_warn(&pdev->dev,
	345	"Failed to request %s gpio %d: %d\n",
	346	gpio_name, gpio, ret);
	347	goto notfound_gpio;
	348	}
	349
	350	/* Request I/O resource. */
	351	sprintf(res_name, "bank%d", bank);
	352	ret = jz_nand_ioremap_resource(pdev, res_name,
	353	&nand->bank_mem[bank - 1],
	354	&nand->bank_base[bank - 1]);
	355	if (ret)
	356	goto notfound_resource;
	357
	358	/* Enable chip in bank. */
	359	jz_gpio_set_function(gpio, JZ_GPIO_FUNC_MEM_CS0);
	360	ctrl = readl(nand->base + JZ_REG_NAND_CTRL);
	361	ctrl \|= JZ_NAND_CTRL_ENABLE_CHIP(bank - 1);
	362	writel(ctrl, nand->base + JZ_REG_NAND_CTRL);
	363
	364	if (chipnr == 0) {
	365	/* Detect first chip. */
	366	ret = nand_scan_ident(mtd, 1, NULL);
	367	if (ret)
	368	goto notfound_id;
	369
	370	/* Retrieve the IDs from the first chip. */
	371	chip->select_chip(mtd, 0);
	372	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
	373	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
	374	*nand_maf_id = chip->read_byte(mtd);
	375	*nand_dev_id = chip->read_byte(mtd);
	376	} else {
	377	/* Detect additional chip. */
	378	chip->select_chip(mtd, chipnr);
	379	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
	380	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
	381	if (*nand_maf_id != chip->read_byte(mtd)
	382	\|\| *nand_dev_id != chip->read_byte(mtd)) {
	383	ret = -ENODEV;
	384	goto notfound_id;
	385	}
	386
	387	/* Update size of the MTD. */
	388	chip->numchips++;
	389	mtd->size += chip->chipsize;
	390	}
	391
	392	dev_info(&pdev->dev, "Found chip %i on bank %i\n", chipnr, bank);
	393	return 0;
	394
395	notfound_id:
396	dev_info(&pdev->dev, "No chip found on bank %i\n", bank);
397	ctrl &= ~(JZ_NAND_CTRL_ENABLE_CHIP(bank - 1));
398	writel(ctrl, nand->base + JZ_REG_NAND_CTRL);
399	jz_gpio_set_function(gpio, JZ_GPIO_FUNC_NONE);
400	jz_nand_iounmap_resource(nand->bank_mem[bank - 1],
401	nand->bank_base[bank - 1]);
402	notfound_resource:
403	gpio_free(gpio);
404	notfound_gpio:
405	return ret;
406	}
407
06f25510	408	static int jz_nand_probe(struct platform_device *pdev)
ba01d6ec LPC	409	{
	410	int ret;
	411	struct jz_nand *nand;
	412	struct nand_chip *chip;
	413	struct mtd_info *mtd;
453810b7	414	struct jz_nand_platform_data *pdata = dev_get_platdata(&pdev->dev);
1471d41a MH	415	size_t chipnr, bank_idx;
1471d41a MH	416	uint8_t nand_maf_id = 0, nand_dev_id = 0;
ba01d6ec LPC	417
ba01d6ec LPC	418	nand = kzalloc(sizeof(*nand), GFP_KERNEL);
51b37b8a	419	if (!nand)
ba01d6ec	420	return -ENOMEM;
ba01d6ec LPC	421
	422	ret = jz_nand_ioremap_resource(pdev, "mmio", &nand->mem, &nand->base);
	423	if (ret)
	424	goto err_free;
ba01d6ec	425
cd145af9 LPC	426	nand->busy_gpio = devm_gpiod_get_optional(&pdev->dev, "busy", GPIOD_IN);
	427	if (IS_ERR(nand->busy_gpio)) {
	428	ret = PTR_ERR(nand->busy_gpio);
	429	dev_err(&pdev->dev, "Failed to request busy gpio %d\n",
	430	ret);
	431	goto err_iounmap_mmio;
ba01d6ec LPC	432	}
	433
	434	mtd = &nand->mtd;
	435	chip = &nand->chip;
	436	mtd->priv = chip;
249eab69	437	mtd->dev.parent = &pdev->dev;
ba01d6ec LPC	438	mtd->name = "jz4740-nand";
	439
	440	chip->ecc.hwctl = jz_nand_hwctl;
	441	chip->ecc.calculate = jz_nand_calculate_ecc_rs;
	442	chip->ecc.correct = jz_nand_correct_ecc_rs;
	443	chip->ecc.mode = NAND_ECC_HW_OOB_FIRST;
	444	chip->ecc.size = 512;
	445	chip->ecc.bytes = 9;
44df4d11	446	chip->ecc.strength = 4;
ba01d6ec	447
ba01d6ec LPC	448	if (pdata)
	449	chip->ecc.layout = pdata->ecc_layout;
	450
	451	chip->chip_delay = 50;
	452	chip->cmd_ctrl = jz_nand_cmd_ctrl;
1471d41a	453	chip->select_chip = jz_nand_select_chip;
ba01d6ec	454
cd145af9	455	if (nand->busy_gpio)
ba01d6ec LPC	456	chip->dev_ready = jz_nand_dev_ready;
ba01d6ec LPC	457
ba01d6ec LPC	458	platform_set_drvdata(pdev, nand);
ba01d6ec LPC	459
1471d41a MH	460	/* We are going to autodetect NAND chips in the banks specified in the
	461	* platform data. Although nand_scan_ident() can detect multiple chips,
	462	* it requires those chips to be numbered consecuitively, which is not
	463	* always the case for external memory banks. And a fixed chip-to-bank
	464	* mapping is not practical either, since for example Dingoo units
	465	* produced at different times have NAND chips in different banks.
	466	*/
	467	chipnr = 0;
	468	for (bank_idx = 0; bank_idx < JZ_NAND_NUM_BANKS; bank_idx++) {
	469	unsigned char bank;
	470
	471	/* If there is no platform data, look for NAND in bank 1,
	472	* which is the most likely bank since it is the only one
	473	* that can be booted from.
	474	*/
	475	bank = pdata ? pdata->banks[bank_idx] : bank_idx ^ 1;
	476	if (bank == 0)
	477	break;
	478	if (bank > JZ_NAND_NUM_BANKS) {
	479	dev_warn(&pdev->dev,
	480	"Skipping non-existing bank: %d\n", bank);
	481	continue;
	482	}
	483	/* The detection routine will directly or indirectly call
	484	* jz_nand_select_chip(), so nand->banks has to contain the
	485	* bank we're checking.
	486	*/
	487	nand->banks[chipnr] = bank;
	488	if (jz_nand_detect_bank(pdev, nand, bank, chipnr,
	489	&nand_maf_id, &nand_dev_id) == 0)
	490	chipnr++;
	491	else
	492	nand->banks[chipnr] = 0;
	493	}
	494	if (chipnr == 0) {
	495	dev_err(&pdev->dev, "No NAND chips found\n");
cd145af9	496	goto err_iounmap_mmio;
ba01d6ec LPC	497	}
	498
	499	if (pdata && pdata->ident_callback) {
	500	pdata->ident_callback(pdev, chip, &pdata->partitions,
	501	&pdata->num_partitions);
	502	}
	503
	504	ret = nand_scan_tail(mtd);
	505	if (ret) {
1471d41a MH	506	dev_err(&pdev->dev, "Failed to scan NAND\n");
1471d41a MH	507	goto err_unclaim_banks;
ba01d6ec LPC	508	}
ba01d6ec LPC	509
42d7fbe2 AB	510	ret = mtd_device_parse_register(mtd, NULL, NULL,
	511	pdata ? pdata->partitions : NULL,
	512	pdata ? pdata->num_partitions : 0);
ba01d6ec LPC	513
	514	if (ret) {
	515	dev_err(&pdev->dev, "Failed to add mtd device\n");
	516	goto err_nand_release;
	517	}
	518
	519	dev_info(&pdev->dev, "Successfully registered JZ4740 NAND driver\n");
	520
	521	return 0;
	522
	523	err_nand_release:
1471d41a MH	524	nand_release(mtd);
	525	err_unclaim_banks:
	526	while (chipnr--) {
	527	unsigned char bank = nand->banks[chipnr];
	528	gpio_free(JZ_GPIO_MEM_CS0 + bank - 1);
	529	jz_nand_iounmap_resource(nand->bank_mem[bank - 1],
	530	nand->bank_base[bank - 1]);
	531	}
	532	writel(0, nand->base + JZ_REG_NAND_CTRL);
ba01d6ec	533	err_iounmap_mmio:
1471d41a	534	jz_nand_iounmap_resource(nand->mem, nand->base);
ba01d6ec LPC	535	err_free:
	536	kfree(nand);
	537	return ret;
	538	}
	539
810b7e06	540	static int jz_nand_remove(struct platform_device *pdev)
ba01d6ec LPC	541	{
ba01d6ec LPC	542	struct jz_nand *nand = platform_get_drvdata(pdev);
1471d41a	543	size_t i;
ba01d6ec LPC	544
	545	nand_release(&nand->mtd);
	546
	547	/* Deassert and disable all chips */
	548	writel(0, nand->base + JZ_REG_NAND_CTRL);
	549
1471d41a MH	550	for (i = 0; i < JZ_NAND_NUM_BANKS; ++i) {
	551	unsigned char bank = nand->banks[i];
	552	if (bank != 0) {
	553	jz_nand_iounmap_resource(nand->bank_mem[bank - 1],
	554	nand->bank_base[bank - 1]);
	555	gpio_free(JZ_GPIO_MEM_CS0 + bank - 1);
	556	}
	557	}
1471d41a MH	558
1471d41a MH	559	jz_nand_iounmap_resource(nand->mem, nand->base);
ba01d6ec	560
ba01d6ec LPC	561	kfree(nand);
	562
	563	return 0;
	564	}
	565
a338adaf	566	static struct platform_driver jz_nand_driver = {
ba01d6ec	567	.probe = jz_nand_probe,
5153b88c	568	.remove = jz_nand_remove,
ba01d6ec LPC	569	.driver = {
ba01d6ec LPC	570	.name = "jz4740-nand",
ba01d6ec LPC	571	},
	572	};
	573
f99640de	574	module_platform_driver(jz_nand_driver);
ba01d6ec LPC	575
	576	MODULE_LICENSE("GPL");
	577	MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
	578	MODULE_DESCRIPTION("NAND controller driver for JZ4740 SoC");
	579	MODULE_ALIAS("platform:jz4740-nand");