[deliverable/linux.git] / arch / arm / mach-omap2 / gpmc-nand.c

/*
 * gpmc-nand.c
 *
 * Copyright (C) 2009 Texas Instruments
 * Vimal Singh <vimalsingh@ti.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <linux/kernel.h>
#include <linux/platform_device.h>
#include <linux/io.h>
#include <linux/omap-gpmc.h>
#include <linux/mtd/nand.h>
#include <linux/platform_data/mtd-nand-omap2.h>

#include <asm/mach/flash.h>

#include "soc.h"

/* minimum size for IO mapping */
#define	NAND_IO_SIZE	4

static bool gpmc_hwecc_bch_capable(enum omap_ecc ecc_opt)
{
	/* platforms which support all ECC schemes */
	if (soc_is_am33xx() || soc_is_am43xx() || cpu_is_omap44xx() ||
		 soc_is_omap54xx() || soc_is_dra7xx())
		return 1;

	if (ecc_opt == OMAP_ECC_BCH4_CODE_HW_DETECTION_SW ||
		 ecc_opt == OMAP_ECC_BCH8_CODE_HW_DETECTION_SW) {
		if (cpu_is_omap24xx())
			return 0;
		else if (cpu_is_omap3630() && (GET_OMAP_REVISION() == 0))
			return 0;
		else
			return 1;
	}

	/* OMAP3xxx do not have ELM engine, so cannot support ECC schemes
	 * which require H/W based ECC error detection */
	if ((cpu_is_omap34xx() || cpu_is_omap3630()) &&
	    ((ecc_opt == OMAP_ECC_BCH4_CODE_HW) ||
		 (ecc_opt == OMAP_ECC_BCH8_CODE_HW)))
		return 0;

	/* legacy platforms support only HAM1 (1-bit Hamming) ECC scheme */
	if (ecc_opt == OMAP_ECC_HAM1_CODE_HW ||
	    ecc_opt == OMAP_ECC_HAM1_CODE_SW)
		return 1;
	else
		return 0;
}

/* This function will go away once the device-tree convertion is complete */
static void gpmc_set_legacy(struct omap_nand_platform_data *gpmc_nand_data,
			    struct gpmc_settings *s)
{
	/* Enable RD PIN Monitoring Reg */
	if (gpmc_nand_data->dev_ready) {
		s->wait_on_read = true;
		s->wait_on_write = true;
	}

	if (gpmc_nand_data->devsize == NAND_BUSWIDTH_16)
		s->device_width = GPMC_DEVWIDTH_16BIT;
	else
		s->device_width = GPMC_DEVWIDTH_8BIT;
}

int gpmc_nand_init(struct omap_nand_platform_data *gpmc_nand_data,
		   struct gpmc_timings *gpmc_t)
{
	int err	= 0;
	struct gpmc_settings s;
	struct platform_device *pdev;
	struct resource gpmc_nand_res[] = {
		{ .flags = IORESOURCE_MEM, },
		{ .flags = IORESOURCE_IRQ, },
		{ .flags = IORESOURCE_IRQ, },
	};

	BUG_ON(gpmc_nand_data->cs >= GPMC_CS_NUM);

	err = gpmc_cs_request(gpmc_nand_data->cs, NAND_IO_SIZE,
			      (unsigned long *)&gpmc_nand_res[0].start);
	if (err < 0) {
		pr_err("omap2-gpmc: Cannot request GPMC CS %d, error %d\n",
		       gpmc_nand_data->cs, err);
		return err;
	}
	gpmc_nand_res[0].end = gpmc_nand_res[0].start + NAND_IO_SIZE - 1;
	gpmc_nand_res[1].start = gpmc_get_client_irq(GPMC_IRQ_FIFOEVENTENABLE);
	gpmc_nand_res[2].start = gpmc_get_client_irq(GPMC_IRQ_COUNT_EVENT);

	memset(&s, 0, sizeof(struct gpmc_settings));
	if (gpmc_nand_data->of_node)
		gpmc_read_settings_dt(gpmc_nand_data->of_node, &s);
	else
		gpmc_set_legacy(gpmc_nand_data, &s);

	s.device_nand = true;

	if (gpmc_t) {
		err = gpmc_cs_set_timings(gpmc_nand_data->cs, gpmc_t, &s);
		if (err < 0) {
			pr_err("omap2-gpmc: Unable to set gpmc timings: %d\n",
			       err);
			return err;
		}
	}

	err = gpmc_cs_program_settings(gpmc_nand_data->cs, &s);
	if (err < 0)
		goto out_free_cs;

	err = gpmc_configure(GPMC_CONFIG_WP, 0);
	if (err < 0)
		goto out_free_cs;

	gpmc_update_nand_reg(&gpmc_nand_data->reg, gpmc_nand_data->cs);

	if (!gpmc_hwecc_bch_capable(gpmc_nand_data->ecc_opt)) {
		pr_err("omap2-nand: Unsupported NAND ECC scheme selected\n");
		err = -EINVAL;
		goto out_free_cs;
	}


	pdev = platform_device_alloc("omap2-nand", gpmc_nand_data->cs);
	if (pdev) {
		err = platform_device_add_resources(pdev, gpmc_nand_res,
						    ARRAY_SIZE(gpmc_nand_res));
		if (!err)
			pdev->dev.platform_data = gpmc_nand_data;
	} else {
		err = -ENOMEM;
	}
	if (err)
		goto out_free_pdev;

	err = platform_device_add(pdev);
	if (err) {
		dev_err(&pdev->dev, "Unable to register NAND device\n");
		goto out_free_pdev;
	}

	return 0;

out_free_pdev:
	platform_device_put(pdev);
out_free_cs:
	gpmc_cs_free(gpmc_nand_data->cs);

	return err;
}
Commit	Line	Data
2f70a1e9 VS	1	/*
	2	* gpmc-nand.c
	3	*
	4	* Copyright (C) 2009 Texas Instruments
	5	* Vimal Singh <vimalsingh@ti.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*/
	11
	12	#include <linux/kernel.h>
	13	#include <linux/platform_device.h>
	14	#include <linux/io.h>
e639cd5b	15	#include <linux/omap-gpmc.h>
d5ce2b65	16	#include <linux/mtd/nand.h>
2203747c	17	#include <linux/platform_data/mtd-nand-omap2.h>
2f70a1e9 VS	18
	19	#include <asm/mach/flash.h>
	20
dbc04161	21	#include "soc.h"
bc3668ea AM	22
	23	/* minimum size for IO mapping */
	24	#define NAND_IO_SIZE 4
dbc04161	25
504f3c6d	26	static bool gpmc_hwecc_bch_capable(enum omap_ecc ecc_opt)
3852ccd6	27	{
0611c419	28	/* platforms which support all ECC schemes */
2e091d13	29	if (soc_is_am33xx() \|\| soc_is_am43xx() \|\| cpu_is_omap44xx() \|\|
0611c419 PG	30	soc_is_omap54xx() \|\| soc_is_dra7xx())
	31	return 1;
	32
33753cd2 CF	33	if (ecc_opt == OMAP_ECC_BCH4_CODE_HW_DETECTION_SW \|\|
	34	ecc_opt == OMAP_ECC_BCH8_CODE_HW_DETECTION_SW) {
	35	if (cpu_is_omap24xx())
	36	return 0;
	37	else if (cpu_is_omap3630() && (GET_OMAP_REVISION() == 0))
	38	return 0;
	39	else
	40	return 1;
	41	}
	42
0611c419 PG	43	/* OMAP3xxx do not have ELM engine, so cannot support ECC schemes
	44	* which require H/W based ECC error detection */
	45	if ((cpu_is_omap34xx() \|\| cpu_is_omap3630()) &&
	46	((ecc_opt == OMAP_ECC_BCH4_CODE_HW) \|\|
	47	(ecc_opt == OMAP_ECC_BCH8_CODE_HW)))
3852ccd6	48	return 0;
3852ccd6	49
0611c419	50	/* legacy platforms support only HAM1 (1-bit Hamming) ECC scheme */
7d5929c1 RQ	51	if (ecc_opt == OMAP_ECC_HAM1_CODE_HW \|\|
7d5929c1 RQ	52	ecc_opt == OMAP_ECC_HAM1_CODE_SW)
0611c419 PG	53	return 1;
	54	else
	55	return 0;
3852ccd6 AM	56	}
3852ccd6 AM	57
d0020cc6 EG	58	/* This function will go away once the device-tree convertion is complete */
	59	static void gpmc_set_legacy(struct omap_nand_platform_data *gpmc_nand_data,
	60	struct gpmc_settings *s)
	61	{
	62	/* Enable RD PIN Monitoring Reg */
	63	if (gpmc_nand_data->dev_ready) {
	64	s->wait_on_read = true;
	65	s->wait_on_write = true;
	66	}
bbc28cdb EG	67
	68	if (gpmc_nand_data->devsize == NAND_BUSWIDTH_16)
	69	s->device_width = GPMC_DEVWIDTH_16BIT;
	70	else
	71	s->device_width = GPMC_DEVWIDTH_8BIT;
d0020cc6 EG	72	}
d0020cc6 EG	73
504f3c6d DM	74	int gpmc_nand_init(struct omap_nand_platform_data *gpmc_nand_data,
504f3c6d DM	75	struct gpmc_timings *gpmc_t)
2f70a1e9	76	{
2f70a1e9	77	int err = 0;
24db7ecc	78	struct gpmc_settings s;
97a288ba RL	79	struct platform_device *pdev;
	80	struct resource gpmc_nand_res[] = {
	81	{ .flags = IORESOURCE_MEM, },
	82	{ .flags = IORESOURCE_IRQ, },
	83	{ .flags = IORESOURCE_IRQ, },
	84	};
24db7ecc	85
97a288ba	86	BUG_ON(gpmc_nand_data->cs >= GPMC_CS_NUM);
2f70a1e9 VS	87
2f70a1e9 VS	88	err = gpmc_cs_request(gpmc_nand_data->cs, NAND_IO_SIZE,
97a288ba	89	(unsigned long *)&gpmc_nand_res[0].start);
2f70a1e9	90	if (err < 0) {
97a288ba RL	91	pr_err("omap2-gpmc: Cannot request GPMC CS %d, error %d\n",
97a288ba RL	92	gpmc_nand_data->cs, err);
2f70a1e9 VS	93	return err;
2f70a1e9 VS	94	}
97a288ba RL	95	gpmc_nand_res[0].end = gpmc_nand_res[0].start + NAND_IO_SIZE - 1;
	96	gpmc_nand_res[1].start = gpmc_get_client_irq(GPMC_IRQ_FIFOEVENTENABLE);
	97	gpmc_nand_res[2].start = gpmc_get_client_irq(GPMC_IRQ_COUNT_EVENT);
bc3668ea	98
97a288ba	99	memset(&s, 0, sizeof(struct gpmc_settings));
d0020cc6	100	if (gpmc_nand_data->of_node)
e2e699b1	101	gpmc_read_settings_dt(gpmc_nand_data->of_node, &s);
d0020cc6 EG	102	else
d0020cc6 EG	103	gpmc_set_legacy(gpmc_nand_data, &s);
24db7ecc	104
e2e699b1	105	s.device_nand = true;
2e676901 RA	106
	107	if (gpmc_t) {
	108	err = gpmc_cs_set_timings(gpmc_nand_data->cs, gpmc_t, &s);
	109	if (err < 0) {
	110	pr_err("omap2-gpmc: Unable to set gpmc timings: %d\n",
	111	err);
	112	return err;
	113	}
	114	}
	115
e2e699b1 EG	116	err = gpmc_cs_program_settings(gpmc_nand_data->cs, &s);
	117	if (err < 0)
	118	goto out_free_cs;
24db7ecc	119
e2e699b1 EG	120	err = gpmc_configure(GPMC_CONFIG_WP, 0);
	121	if (err < 0)
	122	goto out_free_cs;
2f70a1e9	123
d126d015 AM	124	gpmc_update_nand_reg(&gpmc_nand_data->reg, gpmc_nand_data->cs);
d126d015 AM	125
0611c419	126	if (!gpmc_hwecc_bch_capable(gpmc_nand_data->ecc_opt)) {
97a288ba RL	127	pr_err("omap2-nand: Unsupported NAND ECC scheme selected\n");
	128	err = -EINVAL;
	129	goto out_free_cs;
0611c419	130	}
3852ccd6	131
97a288ba RL	132
	133	pdev = platform_device_alloc("omap2-nand", gpmc_nand_data->cs);
	134	if (pdev) {
	135	err = platform_device_add_resources(pdev, gpmc_nand_res,
	136	ARRAY_SIZE(gpmc_nand_res));
	137	if (!err)
	138	pdev->dev.platform_data = gpmc_nand_data;
	139	} else {
	140	err = -ENOMEM;
	141	}
	142	if (err)
	143	goto out_free_pdev;
	144
	145	err = platform_device_add(pdev);
	146	if (err) {
	147	dev_err(&pdev->dev, "Unable to register NAND device\n");
	148	goto out_free_pdev;
2f70a1e9 VS	149	}
	150
	151	return 0;
	152
97a288ba RL	153	out_free_pdev:
97a288ba RL	154	platform_device_put(pdev);
2f70a1e9 VS	155	out_free_cs:
	156	gpmc_cs_free(gpmc_nand_data->cs);
	157
	158	return err;
	159	}