[mirror_ubuntu-bionic-kernel.git] / drivers / memory / atmel-ebi.c

/*
 * EBI driver for Atmel chips
 * inspired by the fsl weim bus driver
 *
 * Copyright (C) 2013 Jean-Jacques Hiblot <jjhiblot@traphandler.com>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2. This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 */

#include <linux/clk.h>
#include <linux/io.h>
#include <linux/mfd/syscon.h>
#include <linux/mfd/syscon/atmel-matrix.h>
#include <linux/mfd/syscon/atmel-smc.h>
#include <linux/init.h>
#include <linux/of_device.h>
#include <linux/regmap.h>

struct at91_ebi_dev_config {
	int cs;
	struct atmel_smc_cs_conf smcconf;
};

struct at91_ebi;

struct at91_ebi_dev {
	struct list_head node;
	struct at91_ebi *ebi;
	u32 mode;
	int numcs;
	struct at91_ebi_dev_config configs[];
};

struct at91_ebi_caps {
	unsigned int available_cs;
	unsigned int ebi_csa_offs;
	void (*get_config)(struct at91_ebi_dev *ebid,
			   struct at91_ebi_dev_config *conf);
	int (*xlate_config)(struct at91_ebi_dev *ebid,
			    struct device_node *configs_np,
			    struct at91_ebi_dev_config *conf);
	void (*apply_config)(struct at91_ebi_dev *ebid,
			     struct at91_ebi_dev_config *conf);
};

struct at91_ebi {
	struct clk *clk;
	struct regmap *matrix;
	struct  {
		struct regmap *regmap;
		struct clk *clk;
	} smc;

	struct device *dev;
	const struct at91_ebi_caps *caps;
	struct list_head devs;
};

struct atmel_smc_timing_xlate {
	const char *name;
	int (*converter)(struct atmel_smc_cs_conf *conf,
			 unsigned int shift, unsigned int nycles);
	unsigned int shift;
};

#define ATMEL_SMC_SETUP_XLATE(nm, pos)	\
	{ .name = nm, .converter = atmel_smc_cs_conf_set_setup, .shift = pos}

#define ATMEL_SMC_PULSE_XLATE(nm, pos)	\
	{ .name = nm, .converter = atmel_smc_cs_conf_set_pulse, .shift = pos}

#define ATMEL_SMC_CYCLE_XLATE(nm, pos)	\
	{ .name = nm, .converter = atmel_smc_cs_conf_set_setup, .shift = pos}

static void at91sam9_ebi_get_config(struct at91_ebi_dev *ebid,
				    struct at91_ebi_dev_config *conf)
{
	atmel_smc_cs_conf_get(ebid->ebi->smc.regmap, conf->cs,
			      &conf->smcconf);
}

static void sama5_ebi_get_config(struct at91_ebi_dev *ebid,
				 struct at91_ebi_dev_config *conf)
{
	atmel_hsmc_cs_conf_get(ebid->ebi->smc.regmap, conf->cs,
			       &conf->smcconf);
}

static const struct atmel_smc_timing_xlate timings_xlate_table[] = {
	ATMEL_SMC_SETUP_XLATE("atmel,smc-ncs-rd-setup-ns",
			      ATMEL_SMC_NCS_RD_SHIFT),
	ATMEL_SMC_SETUP_XLATE("atmel,smc-ncs-wr-setup-ns",
			      ATMEL_SMC_NCS_WR_SHIFT),
	ATMEL_SMC_SETUP_XLATE("atmel,smc-nrd-setup-ns", ATMEL_SMC_NRD_SHIFT),
	ATMEL_SMC_SETUP_XLATE("atmel,smc-nwe-setup-ns", ATMEL_SMC_NWE_SHIFT),
	ATMEL_SMC_PULSE_XLATE("atmel,smc-ncs-rd-pulse-ns",
			      ATMEL_SMC_NCS_RD_SHIFT),
	ATMEL_SMC_PULSE_XLATE("atmel,smc-ncs-wr-pulse-ns",
			      ATMEL_SMC_NCS_WR_SHIFT),
	ATMEL_SMC_PULSE_XLATE("atmel,smc-nrd-pulse-ns", ATMEL_SMC_NRD_SHIFT),
	ATMEL_SMC_PULSE_XLATE("atmel,smc-nwe-pulse-ns", ATMEL_SMC_NWE_SHIFT),
	ATMEL_SMC_CYCLE_XLATE("atmel,smc-nrd-cycle-ns", ATMEL_SMC_NRD_SHIFT),
	ATMEL_SMC_CYCLE_XLATE("atmel,smc-nwe-cycle-ns", ATMEL_SMC_NWE_SHIFT),
};

static int at91_ebi_xslate_smc_timings(struct at91_ebi_dev *ebid,
				       struct device_node *np,
				       struct atmel_smc_cs_conf *smcconf)
{
	unsigned int clk_rate = clk_get_rate(ebid->ebi->clk);
	unsigned int clk_period_ns = NSEC_PER_SEC / clk_rate;
	bool required = false;
	unsigned int ncycles;
	int ret, i;
	u32 val;

	ret = of_property_read_u32(np, "atmel,smc-tdf-ns", &val);
	if (!ret) {
		required = true;
		ncycles = DIV_ROUND_UP(val, clk_period_ns);
		if (ncycles > ATMEL_SMC_MODE_TDF_MAX ||
		    ncycles < ATMEL_SMC_MODE_TDF_MIN) {
			ret = -EINVAL;
			goto out;
		}

		smcconf->mode |= ATMEL_SMC_MODE_TDF(ncycles);
	}

	for (i = 0; i < ARRAY_SIZE(timings_xlate_table); i++) {
		const struct atmel_smc_timing_xlate *xlate;

		xlate = &timings_xlate_table[i];

		ret = of_property_read_u32(np, xlate->name, &val);
		if (ret) {
			if (!required)
				continue;
			else
				break;
		}

		if (!required) {
			ret = -EINVAL;
			break;
		}

		ncycles = DIV_ROUND_UP(val, clk_period_ns);
		ret = xlate->converter(smcconf, xlate->shift, ncycles);
		if (ret)
			goto out;
	}

out:
	if (ret) {
		dev_err(ebid->ebi->dev,
			"missing or invalid timings definition in %s",
			np->full_name);
		return ret;
	}

	return required;
}

static int at91_ebi_xslate_smc_config(struct at91_ebi_dev *ebid,
				      struct device_node *np,
				      struct at91_ebi_dev_config *conf)
{
	struct atmel_smc_cs_conf *smcconf = &conf->smcconf;
	bool required = false;
	const char *tmp_str;
	u32 tmp;
	int ret;

	ret = of_property_read_u32(np, "atmel,smc-bus-width", &tmp);
	if (!ret) {
		switch (tmp) {
		case 8:
			smcconf->mode |= ATMEL_SMC_MODE_DBW_8;
			break;

		case 16:
			smcconf->mode |= ATMEL_SMC_MODE_DBW_16;
			break;

		case 32:
			smcconf->mode |= ATMEL_SMC_MODE_DBW_32;
			break;

		default:
			return -EINVAL;
		}

		required = true;
	}

	if (of_property_read_bool(np, "atmel,smc-tdf-optimized")) {
		smcconf->mode |= ATMEL_SMC_MODE_TDFMODE_OPTIMIZED;
		required = true;
	}

	tmp_str = NULL;
	of_property_read_string(np, "atmel,smc-byte-access-type", &tmp_str);
	if (tmp_str && !strcmp(tmp_str, "write")) {
		smcconf->mode |= ATMEL_SMC_MODE_BAT_WRITE;
		required = true;
	}

	tmp_str = NULL;
	of_property_read_string(np, "atmel,smc-read-mode", &tmp_str);
	if (tmp_str && !strcmp(tmp_str, "nrd")) {
		smcconf->mode |= ATMEL_SMC_MODE_READMODE_NRD;
		required = true;
	}

	tmp_str = NULL;
	of_property_read_string(np, "atmel,smc-write-mode", &tmp_str);
	if (tmp_str && !strcmp(tmp_str, "nwe")) {
		smcconf->mode |= ATMEL_SMC_MODE_WRITEMODE_NWE;
		required = true;
	}

	tmp_str = NULL;
	of_property_read_string(np, "atmel,smc-exnw-mode", &tmp_str);
	if (tmp_str) {
		if (!strcmp(tmp_str, "frozen"))
			smcconf->mode |= ATMEL_SMC_MODE_EXNWMODE_FROZEN;
		else if (!strcmp(tmp_str, "ready"))
			smcconf->mode |= ATMEL_SMC_MODE_EXNWMODE_READY;
		else if (strcmp(tmp_str, "disabled"))
			return -EINVAL;

		required = true;
	}

	ret = of_property_read_u32(np, "atmel,smc-page-mode", &tmp);
	if (!ret) {
		switch (tmp) {
		case 4:
			smcconf->mode |= ATMEL_SMC_MODE_PS_4;
			break;

		case 8:
			smcconf->mode |= ATMEL_SMC_MODE_PS_8;
			break;

		case 16:
			smcconf->mode |= ATMEL_SMC_MODE_PS_16;
			break;

		case 32:
			smcconf->mode |= ATMEL_SMC_MODE_PS_32;
			break;

		default:
			return -EINVAL;
		}

		smcconf->mode |= ATMEL_SMC_MODE_PMEN;
		required = true;
	}

	ret = at91_ebi_xslate_smc_timings(ebid, np, &conf->smcconf);
	if (ret)
		return -EINVAL;

	if ((ret > 0 && !required) || (!ret && required)) {
		dev_err(ebid->ebi->dev, "missing atmel,smc- properties in %s",
			np->full_name);
		return -EINVAL;
	}

	return required;
}

static void at91sam9_ebi_apply_config(struct at91_ebi_dev *ebid,
				      struct at91_ebi_dev_config *conf)
{
	atmel_smc_cs_conf_apply(ebid->ebi->smc.regmap, conf->cs,
				&conf->smcconf);
}

static void sama5_ebi_apply_config(struct at91_ebi_dev *ebid,
				   struct at91_ebi_dev_config *conf)
{
	atmel_hsmc_cs_conf_apply(ebid->ebi->smc.regmap, conf->cs,
				 &conf->smcconf);
}

static int at91_ebi_dev_setup(struct at91_ebi *ebi, struct device_node *np,
			      int reg_cells)
{
	const struct at91_ebi_caps *caps = ebi->caps;
	struct at91_ebi_dev_config conf = { };
	struct device *dev = ebi->dev;
	struct at91_ebi_dev *ebid;
	unsigned long cslines = 0;
	int ret, numcs = 0, nentries, i;
	bool apply = false;
	u32 cs;

	nentries = of_property_count_elems_of_size(np, "reg",
						   reg_cells * sizeof(u32));
	for (i = 0; i < nentries; i++) {
		ret = of_property_read_u32_index(np, "reg", i * reg_cells,
						 &cs);
		if (ret)
			return ret;

		if (cs >= AT91_MATRIX_EBI_NUM_CS ||
		    !(ebi->caps->available_cs & BIT(cs))) {
			dev_err(dev, "invalid reg property in %s\n",
				np->full_name);
			return -EINVAL;
		}

		if (!test_and_set_bit(cs, &cslines))
			numcs++;
	}

	if (!numcs) {
		dev_err(dev, "invalid reg property in %s\n", np->full_name);
		return -EINVAL;
	}

	ebid = devm_kzalloc(ebi->dev,
			    sizeof(*ebid) + (numcs * sizeof(*ebid->configs)),
			    GFP_KERNEL);
	if (!ebid)
		return -ENOMEM;

	ebid->ebi = ebi;

	ret = caps->xlate_config(ebid, np, &conf);
	if (ret < 0)
		return ret;
	else if (ret)
		apply = true;

	i = 0;
	for_each_set_bit(cs, &cslines, AT91_MATRIX_EBI_NUM_CS) {
		ebid->configs[i].cs = cs;

		if (apply) {
			conf.cs = cs;
			caps->apply_config(ebid, &conf);
		}

		caps->get_config(ebid, &ebid->configs[i]);

		/*
		 * Attach the EBI device to the generic SMC logic if at least
		 * one "atmel,smc-" property is present.
		 */
		if (ebi->caps->ebi_csa_offs && apply)
			regmap_update_bits(ebi->matrix,
					   ebi->caps->ebi_csa_offs,
					   BIT(cs), 0);

		i++;
	}

	list_add_tail(&ebid->node, &ebi->devs);

	return 0;
}

static const struct at91_ebi_caps at91sam9260_ebi_caps = {
	.available_cs = 0xff,
	.ebi_csa_offs = AT91SAM9260_MATRIX_EBICSA,
	.get_config = at91sam9_ebi_get_config,
	.xlate_config = at91_ebi_xslate_smc_config,
	.apply_config = at91sam9_ebi_apply_config,
};

static const struct at91_ebi_caps at91sam9261_ebi_caps = {
	.available_cs = 0xff,
	.ebi_csa_offs = AT91SAM9261_MATRIX_EBICSA,
	.get_config = at91sam9_ebi_get_config,
	.xlate_config = at91_ebi_xslate_smc_config,
	.apply_config = at91sam9_ebi_apply_config,
};

static const struct at91_ebi_caps at91sam9263_ebi0_caps = {
	.available_cs = 0x3f,
	.ebi_csa_offs = AT91SAM9263_MATRIX_EBI0CSA,
	.get_config = at91sam9_ebi_get_config,
	.xlate_config = at91_ebi_xslate_smc_config,
	.apply_config = at91sam9_ebi_apply_config,
};

static const struct at91_ebi_caps at91sam9263_ebi1_caps = {
	.available_cs = 0x7,
	.ebi_csa_offs = AT91SAM9263_MATRIX_EBI1CSA,
	.get_config = at91sam9_ebi_get_config,
	.xlate_config = at91_ebi_xslate_smc_config,
	.apply_config = at91sam9_ebi_apply_config,
};

static const struct at91_ebi_caps at91sam9rl_ebi_caps = {
	.available_cs = 0x3f,
	.ebi_csa_offs = AT91SAM9RL_MATRIX_EBICSA,
	.get_config = at91sam9_ebi_get_config,
	.xlate_config = at91_ebi_xslate_smc_config,
	.apply_config = at91sam9_ebi_apply_config,
};

static const struct at91_ebi_caps at91sam9g45_ebi_caps = {
	.available_cs = 0x3f,
	.ebi_csa_offs = AT91SAM9G45_MATRIX_EBICSA,
	.get_config = at91sam9_ebi_get_config,
	.xlate_config = at91_ebi_xslate_smc_config,
	.apply_config = at91sam9_ebi_apply_config,
};

static const struct at91_ebi_caps at91sam9x5_ebi_caps = {
	.available_cs = 0x3f,
	.ebi_csa_offs = AT91SAM9X5_MATRIX_EBICSA,
	.get_config = at91sam9_ebi_get_config,
	.xlate_config = at91_ebi_xslate_smc_config,
	.apply_config = at91sam9_ebi_apply_config,
};

static const struct at91_ebi_caps sama5d3_ebi_caps = {
	.available_cs = 0xf,
	.get_config = sama5_ebi_get_config,
	.xlate_config = at91_ebi_xslate_smc_config,
	.apply_config = sama5_ebi_apply_config,
};

static const struct of_device_id at91_ebi_id_table[] = {
	{
		.compatible = "atmel,at91sam9260-ebi",
		.data = &at91sam9260_ebi_caps,
	},
	{
		.compatible = "atmel,at91sam9261-ebi",
		.data = &at91sam9261_ebi_caps,
	},
	{
		.compatible = "atmel,at91sam9263-ebi0",
		.data = &at91sam9263_ebi0_caps,
	},
	{
		.compatible = "atmel,at91sam9263-ebi1",
		.data = &at91sam9263_ebi1_caps,
	},
	{
		.compatible = "atmel,at91sam9rl-ebi",
		.data = &at91sam9rl_ebi_caps,
	},
	{
		.compatible = "atmel,at91sam9g45-ebi",
		.data = &at91sam9g45_ebi_caps,
	},
	{
		.compatible = "atmel,at91sam9x5-ebi",
		.data = &at91sam9x5_ebi_caps,
	},
	{
		.compatible = "atmel,sama5d3-ebi",
		.data = &sama5d3_ebi_caps,
	},
	{ /* sentinel */ }
};

static int at91_ebi_dev_disable(struct at91_ebi *ebi, struct device_node *np)
{
	struct device *dev = ebi->dev;
	struct property *newprop;

	newprop = devm_kzalloc(dev, sizeof(*newprop), GFP_KERNEL);
	if (!newprop)
		return -ENOMEM;

	newprop->name = devm_kstrdup(dev, "status", GFP_KERNEL);
	if (!newprop->name)
		return -ENOMEM;

	newprop->value = devm_kstrdup(dev, "disabled", GFP_KERNEL);
	if (!newprop->value)
		return -ENOMEM;

	newprop->length = sizeof("disabled");

	return of_update_property(np, newprop);
}

static int at91_ebi_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct device_node *child, *np = dev->of_node, *smc_np;
	const struct of_device_id *match;
	struct at91_ebi *ebi;
	int ret, reg_cells;
	struct clk *clk;
	u32 val;

	match = of_match_device(at91_ebi_id_table, dev);
	if (!match || !match->data)
		return -EINVAL;

	ebi = devm_kzalloc(dev, sizeof(*ebi), GFP_KERNEL);
	if (!ebi)
		return -ENOMEM;

	INIT_LIST_HEAD(&ebi->devs);
	ebi->caps = match->data;
	ebi->dev = dev;

	clk = devm_clk_get(dev, NULL);
	if (IS_ERR(clk))
		return PTR_ERR(clk);

	ebi->clk = clk;

	smc_np = of_parse_phandle(dev->of_node, "atmel,smc", 0);

	ebi->smc.regmap = syscon_node_to_regmap(smc_np);
	if (IS_ERR(ebi->smc.regmap))
		return PTR_ERR(ebi->smc.regmap);

	ebi->smc.clk = of_clk_get(smc_np, 0);
	if (IS_ERR(ebi->smc.clk)) {
		if (PTR_ERR(ebi->smc.clk) != -ENOENT)
			return PTR_ERR(ebi->smc.clk);

		ebi->smc.clk = NULL;
	}
	ret = clk_prepare_enable(ebi->smc.clk);
	if (ret)
		return ret;

	/*
	 * The sama5d3 does not provide an EBICSA register and thus does need
	 * to access the matrix registers.
	 */
	if (ebi->caps->ebi_csa_offs) {
		ebi->matrix =
			syscon_regmap_lookup_by_phandle(np, "atmel,matrix");
		if (IS_ERR(ebi->matrix))
			return PTR_ERR(ebi->matrix);
	}

	ret = of_property_read_u32(np, "#address-cells", &val);
	if (ret) {
		dev_err(dev, "missing #address-cells property\n");
		return ret;
	}

	reg_cells = val;

	ret = of_property_read_u32(np, "#size-cells", &val);
	if (ret) {
		dev_err(dev, "missing #address-cells property\n");
		return ret;
	}

	reg_cells += val;

	for_each_available_child_of_node(np, child) {
		if (!of_find_property(child, "reg", NULL))
			continue;

		ret = at91_ebi_dev_setup(ebi, child, reg_cells);
		if (ret) {
			dev_err(dev, "failed to configure EBI bus for %s, disabling the device",
				child->full_name);

			ret = at91_ebi_dev_disable(ebi, child);
			if (ret)
				return ret;
		}
	}

	return of_platform_populate(np, NULL, NULL, dev);
}

static struct platform_driver at91_ebi_driver = {
	.driver = {
		.name = "atmel-ebi",
		.of_match_table	= at91_ebi_id_table,
	},
};
builtin_platform_driver_probe(at91_ebi_driver, at91_ebi_probe);
Commit	Line	Data
6a4ec4cd BB	1	/*
	2	* EBI driver for Atmel chips
	3	* inspired by the fsl weim bus driver
	4	*
	5	* Copyright (C) 2013 Jean-Jacques Hiblot <jjhiblot@traphandler.com>
	6	*
	7	* This file is licensed under the terms of the GNU General Public
	8	* License version 2. This program is licensed "as is" without any
	9	* warranty of any kind, whether express or implied.
	10	*/
	11
	12	#include <linux/clk.h>
	13	#include <linux/io.h>
	14	#include <linux/mfd/syscon.h>
	15	#include <linux/mfd/syscon/atmel-matrix.h>
	16	#include <linux/mfd/syscon/atmel-smc.h>
8a86a093	17	#include <linux/init.h>
6a4ec4cd BB	18	#include <linux/of_device.h>
	19	#include <linux/regmap.h>
	20
6a4ec4cd BB	21	struct at91_ebi_dev_config {
6a4ec4cd BB	22	int cs;
8eb8c7d8	23	struct atmel_smc_cs_conf smcconf;
6a4ec4cd BB	24	};
	25
	26	struct at91_ebi;
	27
	28	struct at91_ebi_dev {
	29	struct list_head node;
	30	struct at91_ebi *ebi;
	31	u32 mode;
	32	int numcs;
	33	struct at91_ebi_dev_config configs[];
	34	};
	35
	36	struct at91_ebi_caps {
	37	unsigned int available_cs;
d9f81dad	38	unsigned int ebi_csa_offs;
6a4ec4cd BB	39	void (get_config)(struct at91_ebi_dev ebid,
	40	struct at91_ebi_dev_config *conf);
	41	int (xlate_config)(struct at91_ebi_dev ebid,
	42	struct device_node *configs_np,
	43	struct at91_ebi_dev_config *conf);
8eb8c7d8 BB	44	void (apply_config)(struct at91_ebi_dev ebid,
8eb8c7d8 BB	45	struct at91_ebi_dev_config *conf);
6a4ec4cd BB	46	};
	47
	48	struct at91_ebi {
	49	struct clk *clk;
6a4ec4cd	50	struct regmap *matrix;
87108dc7 BB	51	struct {
	52	struct regmap *regmap;
	53	struct clk *clk;
	54	} smc;
6a4ec4cd BB	55
	56	struct device *dev;
	57	const struct at91_ebi_caps *caps;
	58	struct list_head devs;
6a4ec4cd BB	59	};
6a4ec4cd BB	60
8eb8c7d8 BB	61	struct atmel_smc_timing_xlate {
	62	const char *name;
	63	int (converter)(struct atmel_smc_cs_conf conf,
	64	unsigned int shift, unsigned int nycles);
	65	unsigned int shift;
	66	};
	67
	68	#define ATMEL_SMC_SETUP_XLATE(nm, pos) \
	69	{ .name = nm, .converter = atmel_smc_cs_conf_set_setup, .shift = pos}
	70
	71	#define ATMEL_SMC_PULSE_XLATE(nm, pos) \
	72	{ .name = nm, .converter = atmel_smc_cs_conf_set_pulse, .shift = pos}
	73
	74	#define ATMEL_SMC_CYCLE_XLATE(nm, pos) \
	75	{ .name = nm, .converter = atmel_smc_cs_conf_set_setup, .shift = pos}
	76
6a4ec4cd BB	77	static void at91sam9_ebi_get_config(struct at91_ebi_dev *ebid,
	78	struct at91_ebi_dev_config *conf)
	79	{
8eb8c7d8 BB	80	atmel_smc_cs_conf_get(ebid->ebi->smc.regmap, conf->cs,
8eb8c7d8 BB	81	&conf->smcconf);
6a4ec4cd BB	82	}
6a4ec4cd BB	83
8eb8c7d8 BB	84	static void sama5_ebi_get_config(struct at91_ebi_dev *ebid,
8eb8c7d8 BB	85	struct at91_ebi_dev_config *conf)
6a4ec4cd	86	{
8eb8c7d8 BB	87	atmel_hsmc_cs_conf_get(ebid->ebi->smc.regmap, conf->cs,
8eb8c7d8 BB	88	&conf->smcconf);
6a4ec4cd BB	89	}
6a4ec4cd BB	90
8eb8c7d8 BB	91	static const struct atmel_smc_timing_xlate timings_xlate_table[] = {
	92	ATMEL_SMC_SETUP_XLATE("atmel,smc-ncs-rd-setup-ns",
	93	ATMEL_SMC_NCS_RD_SHIFT),
	94	ATMEL_SMC_SETUP_XLATE("atmel,smc-ncs-wr-setup-ns",
	95	ATMEL_SMC_NCS_WR_SHIFT),
	96	ATMEL_SMC_SETUP_XLATE("atmel,smc-nrd-setup-ns", ATMEL_SMC_NRD_SHIFT),
	97	ATMEL_SMC_SETUP_XLATE("atmel,smc-nwe-setup-ns", ATMEL_SMC_NWE_SHIFT),
	98	ATMEL_SMC_PULSE_XLATE("atmel,smc-ncs-rd-pulse-ns",
	99	ATMEL_SMC_NCS_RD_SHIFT),
	100	ATMEL_SMC_PULSE_XLATE("atmel,smc-ncs-wr-pulse-ns",
	101	ATMEL_SMC_NCS_WR_SHIFT),
	102	ATMEL_SMC_PULSE_XLATE("atmel,smc-nrd-pulse-ns", ATMEL_SMC_NRD_SHIFT),
	103	ATMEL_SMC_PULSE_XLATE("atmel,smc-nwe-pulse-ns", ATMEL_SMC_NWE_SHIFT),
	104	ATMEL_SMC_CYCLE_XLATE("atmel,smc-nrd-cycle-ns", ATMEL_SMC_NRD_SHIFT),
	105	ATMEL_SMC_CYCLE_XLATE("atmel,smc-nwe-cycle-ns", ATMEL_SMC_NWE_SHIFT),
	106	};
	107
	108	static int at91_ebi_xslate_smc_timings(struct at91_ebi_dev *ebid,
6a4ec4cd	109	struct device_node *np,
8eb8c7d8	110	struct atmel_smc_cs_conf *smcconf)
6a4ec4cd	111	{
8eb8c7d8 BB	112	unsigned int clk_rate = clk_get_rate(ebid->ebi->clk);
	113	unsigned int clk_period_ns = NSEC_PER_SEC / clk_rate;
	114	bool required = false;
	115	unsigned int ncycles;
	116	int ret, i;
	117	u32 val;
6a4ec4cd	118
8eb8c7d8 BB	119	ret = of_property_read_u32(np, "atmel,smc-tdf-ns", &val);
	120	if (!ret) {
	121	required = true;
	122	ncycles = DIV_ROUND_UP(val, clk_period_ns);
	123	if (ncycles > ATMEL_SMC_MODE_TDF_MAX \|\|
	124	ncycles < ATMEL_SMC_MODE_TDF_MIN) {
	125	ret = -EINVAL;
	126	goto out;
	127	}
6a4ec4cd	128
8eb8c7d8 BB	129	smcconf->mode \|= ATMEL_SMC_MODE_TDF(ncycles);
8eb8c7d8 BB	130	}
6a4ec4cd	131
8eb8c7d8 BB	132	for (i = 0; i < ARRAY_SIZE(timings_xlate_table); i++) {
8eb8c7d8 BB	133	const struct atmel_smc_timing_xlate *xlate;
6a4ec4cd	134
8eb8c7d8	135	xlate = &timings_xlate_table[i];
6a4ec4cd	136
8eb8c7d8 BB	137	ret = of_property_read_u32(np, xlate->name, &val);
	138	if (ret) {
	139	if (!required)
	140	continue;
	141	else
	142	break;
	143	}
6a4ec4cd	144
8eb8c7d8 BB	145	if (!required) {
	146	ret = -EINVAL;
	147	break;
	148	}
6a4ec4cd	149
8eb8c7d8 BB	150	ncycles = DIV_ROUND_UP(val, clk_period_ns);
	151	ret = xlate->converter(smcconf, xlate->shift, ncycles);
	152	if (ret)
	153	goto out;
	154	}
6a4ec4cd BB	155
6a4ec4cd BB	156	out:
8eb8c7d8	157	if (ret) {
6a4ec4cd BB	158	dev_err(ebid->ebi->dev,
	159	"missing or invalid timings definition in %s",
	160	np->full_name);
8eb8c7d8 BB	161	return ret;
8eb8c7d8 BB	162	}
6a4ec4cd	163
8eb8c7d8	164	return required;
6a4ec4cd BB	165	}
6a4ec4cd BB	166
8eb8c7d8	167	static int at91_ebi_xslate_smc_config(struct at91_ebi_dev *ebid,
6a4ec4cd BB	168	struct device_node *np,
	169	struct at91_ebi_dev_config *conf)
	170	{
8eb8c7d8	171	struct atmel_smc_cs_conf *smcconf = &conf->smcconf;
6a4ec4cd BB	172	bool required = false;
	173	const char *tmp_str;
	174	u32 tmp;
	175	int ret;
	176
	177	ret = of_property_read_u32(np, "atmel,smc-bus-width", &tmp);
	178	if (!ret) {
	179	switch (tmp) {
	180	case 8:
8eb8c7d8	181	smcconf->mode \|= ATMEL_SMC_MODE_DBW_8;
6a4ec4cd BB	182	break;
	183
	184	case 16:
8eb8c7d8	185	smcconf->mode \|= ATMEL_SMC_MODE_DBW_16;
6a4ec4cd BB	186	break;
	187
	188	case 32:
8eb8c7d8	189	smcconf->mode \|= ATMEL_SMC_MODE_DBW_32;
6a4ec4cd BB	190	break;
	191
	192	default:
	193	return -EINVAL;
	194	}
	195
	196	required = true;
	197	}
	198
	199	if (of_property_read_bool(np, "atmel,smc-tdf-optimized")) {
8eb8c7d8	200	smcconf->mode \|= ATMEL_SMC_MODE_TDFMODE_OPTIMIZED;
6a4ec4cd BB	201	required = true;
	202	}
	203
	204	tmp_str = NULL;
	205	of_property_read_string(np, "atmel,smc-byte-access-type", &tmp_str);
	206	if (tmp_str && !strcmp(tmp_str, "write")) {
8eb8c7d8	207	smcconf->mode \|= ATMEL_SMC_MODE_BAT_WRITE;
6a4ec4cd BB	208	required = true;
	209	}
	210
	211	tmp_str = NULL;
	212	of_property_read_string(np, "atmel,smc-read-mode", &tmp_str);
	213	if (tmp_str && !strcmp(tmp_str, "nrd")) {
8eb8c7d8	214	smcconf->mode \|= ATMEL_SMC_MODE_READMODE_NRD;
6a4ec4cd BB	215	required = true;
	216	}
	217
	218	tmp_str = NULL;
	219	of_property_read_string(np, "atmel,smc-write-mode", &tmp_str);
	220	if (tmp_str && !strcmp(tmp_str, "nwe")) {
8eb8c7d8	221	smcconf->mode \|= ATMEL_SMC_MODE_WRITEMODE_NWE;
6a4ec4cd BB	222	required = true;
	223	}
	224
	225	tmp_str = NULL;
	226	of_property_read_string(np, "atmel,smc-exnw-mode", &tmp_str);
	227	if (tmp_str) {
	228	if (!strcmp(tmp_str, "frozen"))
8eb8c7d8	229	smcconf->mode \|= ATMEL_SMC_MODE_EXNWMODE_FROZEN;
6a4ec4cd	230	else if (!strcmp(tmp_str, "ready"))
8eb8c7d8	231	smcconf->mode \|= ATMEL_SMC_MODE_EXNWMODE_READY;
6a4ec4cd BB	232	else if (strcmp(tmp_str, "disabled"))
	233	return -EINVAL;
	234
	235	required = true;
	236	}
	237
	238	ret = of_property_read_u32(np, "atmel,smc-page-mode", &tmp);
	239	if (!ret) {
	240	switch (tmp) {
	241	case 4:
8eb8c7d8	242	smcconf->mode \|= ATMEL_SMC_MODE_PS_4;
6a4ec4cd BB	243	break;
	244
	245	case 8:
8eb8c7d8	246	smcconf->mode \|= ATMEL_SMC_MODE_PS_8;
6a4ec4cd BB	247	break;
	248
	249	case 16:
8eb8c7d8	250	smcconf->mode \|= ATMEL_SMC_MODE_PS_16;
6a4ec4cd BB	251	break;
	252
	253	case 32:
8eb8c7d8	254	smcconf->mode \|= ATMEL_SMC_MODE_PS_32;
6a4ec4cd BB	255	break;
	256
	257	default:
	258	return -EINVAL;
	259	}
	260
8eb8c7d8	261	smcconf->mode \|= ATMEL_SMC_MODE_PMEN;
6a4ec4cd BB	262	required = true;
	263	}
	264
8eb8c7d8	265	ret = at91_ebi_xslate_smc_timings(ebid, np, &conf->smcconf);
6a4ec4cd	266	if (ret)
8eb8c7d8	267	return -EINVAL;
6a4ec4cd	268
8eb8c7d8 BB	269	if ((ret > 0 && !required) \|\| (!ret && required)) {
	270	dev_err(ebid->ebi->dev, "missing atmel,smc- properties in %s",
	271	np->full_name);
	272	return -EINVAL;
	273	}
6a4ec4cd	274
8eb8c7d8	275	return required;
6a4ec4cd BB	276	}
6a4ec4cd BB	277
8eb8c7d8 BB	278	static void at91sam9_ebi_apply_config(struct at91_ebi_dev *ebid,
8eb8c7d8 BB	279	struct at91_ebi_dev_config *conf)
6a4ec4cd	280	{
8eb8c7d8 BB	281	atmel_smc_cs_conf_apply(ebid->ebi->smc.regmap, conf->cs,
8eb8c7d8 BB	282	&conf->smcconf);
6a4ec4cd BB	283	}
6a4ec4cd BB	284
8eb8c7d8 BB	285	static void sama5_ebi_apply_config(struct at91_ebi_dev *ebid,
8eb8c7d8 BB	286	struct at91_ebi_dev_config *conf)
6a4ec4cd	287	{
8eb8c7d8 BB	288	atmel_hsmc_cs_conf_apply(ebid->ebi->smc.regmap, conf->cs,
8eb8c7d8 BB	289	&conf->smcconf);
6a4ec4cd BB	290	}
	291
	292	static int at91_ebi_dev_setup(struct at91_ebi ebi, struct device_node np,
	293	int reg_cells)
	294	{
	295	const struct at91_ebi_caps *caps = ebi->caps;
	296	struct at91_ebi_dev_config conf = { };
	297	struct device *dev = ebi->dev;
	298	struct at91_ebi_dev *ebid;
987e079e BB	299	unsigned long cslines = 0;
987e079e BB	300	int ret, numcs = 0, nentries, i;
6a4ec4cd	301	bool apply = false;
987e079e	302	u32 cs;
6a4ec4cd	303
987e079e BB	304	nentries = of_property_count_elems_of_size(np, "reg",
	305	reg_cells * sizeof(u32));
	306	for (i = 0; i < nentries; i++) {
	307	ret = of_property_read_u32_index(np, "reg", i * reg_cells,
	308	&cs);
	309	if (ret)
	310	return ret;
	311
	312	if (cs >= AT91_MATRIX_EBI_NUM_CS \|\|
	313	!(ebi->caps->available_cs & BIT(cs))) {
	314	dev_err(dev, "invalid reg property in %s\n",
	315	np->full_name);
	316	return -EINVAL;
	317	}
	318
	319	if (!test_and_set_bit(cs, &cslines))
	320	numcs++;
	321	}
	322
	323	if (!numcs) {
6a4ec4cd BB	324	dev_err(dev, "invalid reg property in %s\n", np->full_name);
	325	return -EINVAL;
	326	}
	327
	328	ebid = devm_kzalloc(ebi->dev,
	329	sizeof(ebid) + (numcs sizeof(*ebid->configs)),
	330	GFP_KERNEL);
	331	if (!ebid)
	332	return -ENOMEM;
	333
	334	ebid->ebi = ebi;
	335
	336	ret = caps->xlate_config(ebid, np, &conf);
	337	if (ret < 0)
	338	return ret;
	339	else if (ret)
	340	apply = true;
	341
987e079e BB	342	i = 0;
987e079e BB	343	for_each_set_bit(cs, &cslines, AT91_MATRIX_EBI_NUM_CS) {
6a4ec4cd BB	344	ebid->configs[i].cs = cs;
	345
	346	if (apply) {
	347	conf.cs = cs;
8eb8c7d8	348	caps->apply_config(ebid, &conf);
6a4ec4cd BB	349	}
	350
	351	caps->get_config(ebid, &ebid->configs[i]);
	352
	353	/*
	354	* Attach the EBI device to the generic SMC logic if at least
	355	* one "atmel,smc-" property is present.
	356	*/
d9f81dad BB	357	if (ebi->caps->ebi_csa_offs && apply)
	358	regmap_update_bits(ebi->matrix,
	359	ebi->caps->ebi_csa_offs,
	360	BIT(cs), 0);
987e079e BB	361
987e079e BB	362	i++;
6a4ec4cd BB	363	}
	364
	365	list_add_tail(&ebid->node, &ebi->devs);
	366
	367	return 0;
	368	}
	369
6a4ec4cd BB	370	static const struct at91_ebi_caps at91sam9260_ebi_caps = {
6a4ec4cd BB	371	.available_cs = 0xff,
d9f81dad	372	.ebi_csa_offs = AT91SAM9260_MATRIX_EBICSA,
6a4ec4cd	373	.get_config = at91sam9_ebi_get_config,
8eb8c7d8	374	.xlate_config = at91_ebi_xslate_smc_config,
6a4ec4cd	375	.apply_config = at91sam9_ebi_apply_config,
6a4ec4cd BB	376	};
6a4ec4cd BB	377
6a4ec4cd BB	378	static const struct at91_ebi_caps at91sam9261_ebi_caps = {
6a4ec4cd BB	379	.available_cs = 0xff,
d9f81dad	380	.ebi_csa_offs = AT91SAM9261_MATRIX_EBICSA,
6a4ec4cd	381	.get_config = at91sam9_ebi_get_config,
8eb8c7d8	382	.xlate_config = at91_ebi_xslate_smc_config,
6a4ec4cd	383	.apply_config = at91sam9_ebi_apply_config,
6a4ec4cd BB	384	};
6a4ec4cd BB	385
6a4ec4cd BB	386	static const struct at91_ebi_caps at91sam9263_ebi0_caps = {
6a4ec4cd BB	387	.available_cs = 0x3f,
d9f81dad	388	.ebi_csa_offs = AT91SAM9263_MATRIX_EBI0CSA,
6a4ec4cd	389	.get_config = at91sam9_ebi_get_config,
8eb8c7d8	390	.xlate_config = at91_ebi_xslate_smc_config,
6a4ec4cd	391	.apply_config = at91sam9_ebi_apply_config,
6a4ec4cd BB	392	};
6a4ec4cd BB	393
6a4ec4cd BB	394	static const struct at91_ebi_caps at91sam9263_ebi1_caps = {
6a4ec4cd BB	395	.available_cs = 0x7,
d9f81dad	396	.ebi_csa_offs = AT91SAM9263_MATRIX_EBI1CSA,
6a4ec4cd	397	.get_config = at91sam9_ebi_get_config,
8eb8c7d8	398	.xlate_config = at91_ebi_xslate_smc_config,
6a4ec4cd	399	.apply_config = at91sam9_ebi_apply_config,
6a4ec4cd BB	400	};
6a4ec4cd BB	401
6a4ec4cd BB	402	static const struct at91_ebi_caps at91sam9rl_ebi_caps = {
6a4ec4cd BB	403	.available_cs = 0x3f,
d9f81dad	404	.ebi_csa_offs = AT91SAM9RL_MATRIX_EBICSA,
6a4ec4cd	405	.get_config = at91sam9_ebi_get_config,
8eb8c7d8	406	.xlate_config = at91_ebi_xslate_smc_config,
6a4ec4cd	407	.apply_config = at91sam9_ebi_apply_config,
6a4ec4cd BB	408	};
6a4ec4cd BB	409
6a4ec4cd BB	410	static const struct at91_ebi_caps at91sam9g45_ebi_caps = {
6a4ec4cd BB	411	.available_cs = 0x3f,
d9f81dad	412	.ebi_csa_offs = AT91SAM9G45_MATRIX_EBICSA,
6a4ec4cd	413	.get_config = at91sam9_ebi_get_config,
8eb8c7d8	414	.xlate_config = at91_ebi_xslate_smc_config,
6a4ec4cd	415	.apply_config = at91sam9_ebi_apply_config,
6a4ec4cd BB	416	};
	417
	418	static const struct at91_ebi_caps at91sam9x5_ebi_caps = {
	419	.available_cs = 0x3f,
d9f81dad	420	.ebi_csa_offs = AT91SAM9X5_MATRIX_EBICSA,
6a4ec4cd	421	.get_config = at91sam9_ebi_get_config,
8eb8c7d8	422	.xlate_config = at91_ebi_xslate_smc_config,
6a4ec4cd	423	.apply_config = at91sam9_ebi_apply_config,
6a4ec4cd BB	424	};
	425
	426	static const struct at91_ebi_caps sama5d3_ebi_caps = {
	427	.available_cs = 0xf,
8eb8c7d8 BB	428	.get_config = sama5_ebi_get_config,
	429	.xlate_config = at91_ebi_xslate_smc_config,
	430	.apply_config = sama5_ebi_apply_config,
6a4ec4cd BB	431	};
	432
	433	static const struct of_device_id at91_ebi_id_table[] = {
	434	{
	435	.compatible = "atmel,at91sam9260-ebi",
	436	.data = &at91sam9260_ebi_caps,
	437	},
	438	{
	439	.compatible = "atmel,at91sam9261-ebi",
	440	.data = &at91sam9261_ebi_caps,
	441	},
	442	{
	443	.compatible = "atmel,at91sam9263-ebi0",
	444	.data = &at91sam9263_ebi0_caps,
	445	},
	446	{
	447	.compatible = "atmel,at91sam9263-ebi1",
	448	.data = &at91sam9263_ebi1_caps,
	449	},
	450	{
	451	.compatible = "atmel,at91sam9rl-ebi",
	452	.data = &at91sam9rl_ebi_caps,
	453	},
	454	{
	455	.compatible = "atmel,at91sam9g45-ebi",
	456	.data = &at91sam9g45_ebi_caps,
	457	},
	458	{
	459	.compatible = "atmel,at91sam9x5-ebi",
	460	.data = &at91sam9x5_ebi_caps,
	461	},
	462	{
	463	.compatible = "atmel,sama5d3-ebi",
	464	.data = &sama5d3_ebi_caps,
	465	},
	466	{ /* sentinel */ }
	467	};
6a4ec4cd BB	468
	469	static int at91_ebi_dev_disable(struct at91_ebi ebi, struct device_node np)
	470	{
	471	struct device *dev = ebi->dev;
	472	struct property *newprop;
	473
	474	newprop = devm_kzalloc(dev, sizeof(*newprop), GFP_KERNEL);
	475	if (!newprop)
	476	return -ENOMEM;
	477
	478	newprop->name = devm_kstrdup(dev, "status", GFP_KERNEL);
	479	if (!newprop->name)
	480	return -ENOMEM;
	481
	482	newprop->value = devm_kstrdup(dev, "disabled", GFP_KERNEL);
ecc2d430	483	if (!newprop->value)
6a4ec4cd BB	484	return -ENOMEM;
	485
	486	newprop->length = sizeof("disabled");
	487
	488	return of_update_property(np, newprop);
	489	}
	490
	491	static int at91_ebi_probe(struct platform_device *pdev)
	492	{
	493	struct device *dev = &pdev->dev;
87108dc7	494	struct device_node child, np = dev->of_node, *smc_np;
6a4ec4cd BB	495	const struct of_device_id *match;
	496	struct at91_ebi *ebi;
	497	int ret, reg_cells;
	498	struct clk *clk;
	499	u32 val;
	500
	501	match = of_match_device(at91_ebi_id_table, dev);
	502	if (!match \|\| !match->data)
	503	return -EINVAL;
	504
	505	ebi = devm_kzalloc(dev, sizeof(*ebi), GFP_KERNEL);
	506	if (!ebi)
	507	return -ENOMEM;
	508
	509	INIT_LIST_HEAD(&ebi->devs);
	510	ebi->caps = match->data;
	511	ebi->dev = dev;
	512
	513	clk = devm_clk_get(dev, NULL);
	514	if (IS_ERR(clk))
	515	return PTR_ERR(clk);
	516
	517	ebi->clk = clk;
	518
87108dc7 BB	519	smc_np = of_parse_phandle(dev->of_node, "atmel,smc", 0);
	520
	521	ebi->smc.regmap = syscon_node_to_regmap(smc_np);
	522	if (IS_ERR(ebi->smc.regmap))
	523	return PTR_ERR(ebi->smc.regmap);
	524
	525	ebi->smc.clk = of_clk_get(smc_np, 0);
	526	if (IS_ERR(ebi->smc.clk)) {
	527	if (PTR_ERR(ebi->smc.clk) != -ENOENT)
	528	return PTR_ERR(ebi->smc.clk);
	529
	530	ebi->smc.clk = NULL;
	531	}
	532	ret = clk_prepare_enable(ebi->smc.clk);
	533	if (ret)
	534	return ret;
6a4ec4cd BB	535
	536	/*
	537	* The sama5d3 does not provide an EBICSA register and thus does need
	538	* to access the matrix registers.
	539	*/
d9f81dad	540	if (ebi->caps->ebi_csa_offs) {
6a4ec4cd BB	541	ebi->matrix =
	542	syscon_regmap_lookup_by_phandle(np, "atmel,matrix");
	543	if (IS_ERR(ebi->matrix))
	544	return PTR_ERR(ebi->matrix);
6a4ec4cd BB	545	}
6a4ec4cd BB	546
6a4ec4cd BB	547	ret = of_property_read_u32(np, "#address-cells", &val);
	548	if (ret) {
	549	dev_err(dev, "missing #address-cells property\n");
	550	return ret;
	551	}
	552
	553	reg_cells = val;
	554
	555	ret = of_property_read_u32(np, "#size-cells", &val);
	556	if (ret) {
	557	dev_err(dev, "missing #address-cells property\n");
	558	return ret;
	559	}
	560
	561	reg_cells += val;
	562
	563	for_each_available_child_of_node(np, child) {
	564	if (!of_find_property(child, "reg", NULL))
	565	continue;
	566
	567	ret = at91_ebi_dev_setup(ebi, child, reg_cells);
	568	if (ret) {
	569	dev_err(dev, "failed to configure EBI bus for %s, disabling the device",
	570	child->full_name);
	571
	572	ret = at91_ebi_dev_disable(ebi, child);
	573	if (ret)
	574	return ret;
	575	}
	576	}
	577
	578	return of_platform_populate(np, NULL, NULL, dev);
	579	}
	580
	581	static struct platform_driver at91_ebi_driver = {
	582	.driver = {
	583	.name = "atmel-ebi",
	584	.of_match_table = at91_ebi_id_table,
	585	},
	586	};
8a86a093	587	builtin_platform_driver_probe(at91_ebi_driver, at91_ebi_probe);