1 // SPDX-License-Identifier: GPL-2.0
3 * EBI driver for Atmel chips
4 * inspired by the fsl weim bus driver
11 #include <linux/mfd/syscon.h>
12 #include <linux/mfd/syscon/atmel-matrix.h>
13 #include <linux/mfd/syscon/atmel-smc.h>
14 #include <linux/init.h>
16 #include <linux/of_platform.h>
17 #include <linux/platform_device.h>
18 #include <linux/property.h>
19 #include <linux/regmap.h>
20 #include <soc/at91/atmel-sfr.h>
22 #define AT91_EBI_NUM_CS 8
24 struct atmel_ebi_dev_config {
26 struct atmel_smc_cs_conf smcconf;
31 struct atmel_ebi_dev {
32 struct list_head node;
33 struct atmel_ebi *ebi;
36 struct atmel_ebi_dev_config configs[] __counted_by(numcs);
39 struct atmel_ebi_caps {
40 unsigned int available_cs;
41 unsigned int ebi_csa_offs;
42 const char *regmap_name;
43 void (*get_config)(struct atmel_ebi_dev *ebid,
44 struct atmel_ebi_dev_config *conf);
45 int (*xlate_config)(struct atmel_ebi_dev *ebid,
46 struct device_node *configs_np,
47 struct atmel_ebi_dev_config *conf);
48 void (*apply_config)(struct atmel_ebi_dev *ebid,
49 struct atmel_ebi_dev_config *conf);
54 struct regmap *regmap;
56 struct regmap *regmap;
58 const struct atmel_hsmc_reg_layout *layout;
62 const struct atmel_ebi_caps *caps;
63 struct list_head devs;
66 struct atmel_smc_timing_xlate {
68 int (*converter)(struct atmel_smc_cs_conf *conf,
69 unsigned int shift, unsigned int nycles);
73 #define ATMEL_SMC_SETUP_XLATE(nm, pos) \
74 { .name = nm, .converter = atmel_smc_cs_conf_set_setup, .shift = pos}
76 #define ATMEL_SMC_PULSE_XLATE(nm, pos) \
77 { .name = nm, .converter = atmel_smc_cs_conf_set_pulse, .shift = pos}
79 #define ATMEL_SMC_CYCLE_XLATE(nm, pos) \
80 { .name = nm, .converter = atmel_smc_cs_conf_set_cycle, .shift = pos}
82 static void at91sam9_ebi_get_config(struct atmel_ebi_dev *ebid,
83 struct atmel_ebi_dev_config *conf)
85 atmel_smc_cs_conf_get(ebid->ebi->smc.regmap, conf->cs,
89 static void sama5_ebi_get_config(struct atmel_ebi_dev *ebid,
90 struct atmel_ebi_dev_config *conf)
92 atmel_hsmc_cs_conf_get(ebid->ebi->smc.regmap, ebid->ebi->smc.layout,
93 conf->cs, &conf->smcconf);
96 static const struct atmel_smc_timing_xlate timings_xlate_table[] = {
97 ATMEL_SMC_SETUP_XLATE("atmel,smc-ncs-rd-setup-ns",
98 ATMEL_SMC_NCS_RD_SHIFT),
99 ATMEL_SMC_SETUP_XLATE("atmel,smc-ncs-wr-setup-ns",
100 ATMEL_SMC_NCS_WR_SHIFT),
101 ATMEL_SMC_SETUP_XLATE("atmel,smc-nrd-setup-ns", ATMEL_SMC_NRD_SHIFT),
102 ATMEL_SMC_SETUP_XLATE("atmel,smc-nwe-setup-ns", ATMEL_SMC_NWE_SHIFT),
103 ATMEL_SMC_PULSE_XLATE("atmel,smc-ncs-rd-pulse-ns",
104 ATMEL_SMC_NCS_RD_SHIFT),
105 ATMEL_SMC_PULSE_XLATE("atmel,smc-ncs-wr-pulse-ns",
106 ATMEL_SMC_NCS_WR_SHIFT),
107 ATMEL_SMC_PULSE_XLATE("atmel,smc-nrd-pulse-ns", ATMEL_SMC_NRD_SHIFT),
108 ATMEL_SMC_PULSE_XLATE("atmel,smc-nwe-pulse-ns", ATMEL_SMC_NWE_SHIFT),
109 ATMEL_SMC_CYCLE_XLATE("atmel,smc-nrd-cycle-ns", ATMEL_SMC_NRD_SHIFT),
110 ATMEL_SMC_CYCLE_XLATE("atmel,smc-nwe-cycle-ns", ATMEL_SMC_NWE_SHIFT),
113 static int atmel_ebi_xslate_smc_timings(struct atmel_ebi_dev *ebid,
114 struct device_node *np,
115 struct atmel_smc_cs_conf *smcconf)
117 unsigned int clk_rate = clk_get_rate(ebid->ebi->clk);
118 unsigned int clk_period_ns = NSEC_PER_SEC / clk_rate;
119 bool required = false;
120 unsigned int ncycles;
124 ret = of_property_read_u32(np, "atmel,smc-tdf-ns", &val);
127 ncycles = DIV_ROUND_UP(val, clk_period_ns);
128 if (ncycles > ATMEL_SMC_MODE_TDF_MAX) {
133 if (ncycles < ATMEL_SMC_MODE_TDF_MIN)
134 ncycles = ATMEL_SMC_MODE_TDF_MIN;
136 smcconf->mode |= ATMEL_SMC_MODE_TDF(ncycles);
139 for (i = 0; i < ARRAY_SIZE(timings_xlate_table); i++) {
140 const struct atmel_smc_timing_xlate *xlate;
142 xlate = &timings_xlate_table[i];
144 ret = of_property_read_u32(np, xlate->name, &val);
157 ncycles = DIV_ROUND_UP(val, clk_period_ns);
158 ret = xlate->converter(smcconf, xlate->shift, ncycles);
165 dev_err(ebid->ebi->dev,
166 "missing or invalid timings definition in %pOF",
174 static int atmel_ebi_xslate_smc_config(struct atmel_ebi_dev *ebid,
175 struct device_node *np,
176 struct atmel_ebi_dev_config *conf)
178 struct atmel_smc_cs_conf *smcconf = &conf->smcconf;
179 bool required = false;
184 ret = of_property_read_u32(np, "atmel,smc-bus-width", &tmp);
188 smcconf->mode |= ATMEL_SMC_MODE_DBW_8;
192 smcconf->mode |= ATMEL_SMC_MODE_DBW_16;
196 smcconf->mode |= ATMEL_SMC_MODE_DBW_32;
206 if (of_property_read_bool(np, "atmel,smc-tdf-optimized")) {
207 smcconf->mode |= ATMEL_SMC_MODE_TDFMODE_OPTIMIZED;
212 of_property_read_string(np, "atmel,smc-byte-access-type", &tmp_str);
213 if (tmp_str && !strcmp(tmp_str, "write")) {
214 smcconf->mode |= ATMEL_SMC_MODE_BAT_WRITE;
219 of_property_read_string(np, "atmel,smc-read-mode", &tmp_str);
220 if (tmp_str && !strcmp(tmp_str, "nrd")) {
221 smcconf->mode |= ATMEL_SMC_MODE_READMODE_NRD;
226 of_property_read_string(np, "atmel,smc-write-mode", &tmp_str);
227 if (tmp_str && !strcmp(tmp_str, "nwe")) {
228 smcconf->mode |= ATMEL_SMC_MODE_WRITEMODE_NWE;
233 of_property_read_string(np, "atmel,smc-exnw-mode", &tmp_str);
235 if (!strcmp(tmp_str, "frozen"))
236 smcconf->mode |= ATMEL_SMC_MODE_EXNWMODE_FROZEN;
237 else if (!strcmp(tmp_str, "ready"))
238 smcconf->mode |= ATMEL_SMC_MODE_EXNWMODE_READY;
239 else if (strcmp(tmp_str, "disabled"))
245 ret = of_property_read_u32(np, "atmel,smc-page-mode", &tmp);
249 smcconf->mode |= ATMEL_SMC_MODE_PS_4;
253 smcconf->mode |= ATMEL_SMC_MODE_PS_8;
257 smcconf->mode |= ATMEL_SMC_MODE_PS_16;
261 smcconf->mode |= ATMEL_SMC_MODE_PS_32;
268 smcconf->mode |= ATMEL_SMC_MODE_PMEN;
272 ret = atmel_ebi_xslate_smc_timings(ebid, np, &conf->smcconf);
276 if ((ret > 0 && !required) || (!ret && required)) {
277 dev_err(ebid->ebi->dev, "missing atmel,smc- properties in %pOF",
285 static void at91sam9_ebi_apply_config(struct atmel_ebi_dev *ebid,
286 struct atmel_ebi_dev_config *conf)
288 atmel_smc_cs_conf_apply(ebid->ebi->smc.regmap, conf->cs,
292 static void sama5_ebi_apply_config(struct atmel_ebi_dev *ebid,
293 struct atmel_ebi_dev_config *conf)
295 atmel_hsmc_cs_conf_apply(ebid->ebi->smc.regmap, ebid->ebi->smc.layout,
296 conf->cs, &conf->smcconf);
299 static int atmel_ebi_dev_setup(struct atmel_ebi *ebi, struct device_node *np,
302 const struct atmel_ebi_caps *caps = ebi->caps;
303 struct atmel_ebi_dev_config conf = { };
304 struct device *dev = ebi->dev;
305 struct atmel_ebi_dev *ebid;
306 unsigned long cslines = 0;
307 int ret, numcs = 0, nentries, i;
311 nentries = of_property_count_elems_of_size(np, "reg",
312 reg_cells * sizeof(u32));
313 for (i = 0; i < nentries; i++) {
314 ret = of_property_read_u32_index(np, "reg", i * reg_cells,
319 if (cs >= AT91_EBI_NUM_CS ||
320 !(ebi->caps->available_cs & BIT(cs))) {
321 dev_err(dev, "invalid reg property in %pOF\n", np);
325 if (!test_and_set_bit(cs, &cslines))
330 dev_err(dev, "invalid reg property in %pOF\n", np);
334 ebid = devm_kzalloc(ebi->dev, struct_size(ebid, configs, numcs),
342 ret = caps->xlate_config(ebid, np, &conf);
349 for_each_set_bit(cs, &cslines, AT91_EBI_NUM_CS) {
350 ebid->configs[i].cs = cs;
354 caps->apply_config(ebid, &conf);
357 caps->get_config(ebid, &ebid->configs[i]);
360 * Attach the EBI device to the generic SMC logic if at least
361 * one "atmel,smc-" property is present.
363 if (ebi->caps->ebi_csa_offs && apply)
364 regmap_update_bits(ebi->regmap,
365 ebi->caps->ebi_csa_offs,
371 list_add_tail(&ebid->node, &ebi->devs);
376 static const struct atmel_ebi_caps at91sam9260_ebi_caps = {
377 .available_cs = 0xff,
378 .ebi_csa_offs = AT91SAM9260_MATRIX_EBICSA,
379 .regmap_name = "atmel,matrix",
380 .get_config = at91sam9_ebi_get_config,
381 .xlate_config = atmel_ebi_xslate_smc_config,
382 .apply_config = at91sam9_ebi_apply_config,
385 static const struct atmel_ebi_caps at91sam9261_ebi_caps = {
386 .available_cs = 0xff,
387 .ebi_csa_offs = AT91SAM9261_MATRIX_EBICSA,
388 .regmap_name = "atmel,matrix",
389 .get_config = at91sam9_ebi_get_config,
390 .xlate_config = atmel_ebi_xslate_smc_config,
391 .apply_config = at91sam9_ebi_apply_config,
394 static const struct atmel_ebi_caps at91sam9263_ebi0_caps = {
395 .available_cs = 0x3f,
396 .ebi_csa_offs = AT91SAM9263_MATRIX_EBI0CSA,
397 .regmap_name = "atmel,matrix",
398 .get_config = at91sam9_ebi_get_config,
399 .xlate_config = atmel_ebi_xslate_smc_config,
400 .apply_config = at91sam9_ebi_apply_config,
403 static const struct atmel_ebi_caps at91sam9263_ebi1_caps = {
405 .ebi_csa_offs = AT91SAM9263_MATRIX_EBI1CSA,
406 .regmap_name = "atmel,matrix",
407 .get_config = at91sam9_ebi_get_config,
408 .xlate_config = atmel_ebi_xslate_smc_config,
409 .apply_config = at91sam9_ebi_apply_config,
412 static const struct atmel_ebi_caps at91sam9rl_ebi_caps = {
413 .available_cs = 0x3f,
414 .ebi_csa_offs = AT91SAM9RL_MATRIX_EBICSA,
415 .regmap_name = "atmel,matrix",
416 .get_config = at91sam9_ebi_get_config,
417 .xlate_config = atmel_ebi_xslate_smc_config,
418 .apply_config = at91sam9_ebi_apply_config,
421 static const struct atmel_ebi_caps at91sam9g45_ebi_caps = {
422 .available_cs = 0x3f,
423 .ebi_csa_offs = AT91SAM9G45_MATRIX_EBICSA,
424 .regmap_name = "atmel,matrix",
425 .get_config = at91sam9_ebi_get_config,
426 .xlate_config = atmel_ebi_xslate_smc_config,
427 .apply_config = at91sam9_ebi_apply_config,
430 static const struct atmel_ebi_caps at91sam9x5_ebi_caps = {
431 .available_cs = 0x3f,
432 .ebi_csa_offs = AT91SAM9X5_MATRIX_EBICSA,
433 .regmap_name = "atmel,matrix",
434 .get_config = at91sam9_ebi_get_config,
435 .xlate_config = atmel_ebi_xslate_smc_config,
436 .apply_config = at91sam9_ebi_apply_config,
439 static const struct atmel_ebi_caps sama5d3_ebi_caps = {
441 .get_config = sama5_ebi_get_config,
442 .xlate_config = atmel_ebi_xslate_smc_config,
443 .apply_config = sama5_ebi_apply_config,
446 static const struct atmel_ebi_caps sam9x60_ebi_caps = {
447 .available_cs = 0x3f,
448 .ebi_csa_offs = AT91_SFR_CCFG_EBICSA,
449 .regmap_name = "microchip,sfr",
450 .get_config = at91sam9_ebi_get_config,
451 .xlate_config = atmel_ebi_xslate_smc_config,
452 .apply_config = at91sam9_ebi_apply_config,
455 static const struct of_device_id atmel_ebi_id_table[] = {
457 .compatible = "atmel,at91sam9260-ebi",
458 .data = &at91sam9260_ebi_caps,
461 .compatible = "atmel,at91sam9261-ebi",
462 .data = &at91sam9261_ebi_caps,
465 .compatible = "atmel,at91sam9263-ebi0",
466 .data = &at91sam9263_ebi0_caps,
469 .compatible = "atmel,at91sam9263-ebi1",
470 .data = &at91sam9263_ebi1_caps,
473 .compatible = "atmel,at91sam9rl-ebi",
474 .data = &at91sam9rl_ebi_caps,
477 .compatible = "atmel,at91sam9g45-ebi",
478 .data = &at91sam9g45_ebi_caps,
481 .compatible = "atmel,at91sam9x5-ebi",
482 .data = &at91sam9x5_ebi_caps,
485 .compatible = "atmel,sama5d3-ebi",
486 .data = &sama5d3_ebi_caps,
489 .compatible = "microchip,sam9x60-ebi",
490 .data = &sam9x60_ebi_caps,
495 static int atmel_ebi_dev_disable(struct atmel_ebi *ebi, struct device_node *np)
497 struct device *dev = ebi->dev;
498 struct property *newprop;
500 newprop = devm_kzalloc(dev, sizeof(*newprop), GFP_KERNEL);
504 newprop->name = devm_kstrdup(dev, "status", GFP_KERNEL);
508 newprop->value = devm_kstrdup(dev, "disabled", GFP_KERNEL);
512 newprop->length = sizeof("disabled");
514 return of_update_property(np, newprop);
517 static int atmel_ebi_probe(struct platform_device *pdev)
519 struct device *dev = &pdev->dev;
520 struct device_node *child, *np = dev->of_node, *smc_np;
521 struct atmel_ebi *ebi;
526 ebi = devm_kzalloc(dev, sizeof(*ebi), GFP_KERNEL);
530 platform_set_drvdata(pdev, ebi);
532 INIT_LIST_HEAD(&ebi->devs);
533 ebi->caps = device_get_match_data(dev);
538 clk = devm_clk_get(dev, NULL);
544 smc_np = of_parse_phandle(dev->of_node, "atmel,smc", 0);
546 ebi->smc.regmap = syscon_node_to_regmap(smc_np);
547 if (IS_ERR(ebi->smc.regmap)) {
548 ret = PTR_ERR(ebi->smc.regmap);
552 ebi->smc.layout = atmel_hsmc_get_reg_layout(smc_np);
553 if (IS_ERR(ebi->smc.layout)) {
554 ret = PTR_ERR(ebi->smc.layout);
558 ebi->smc.clk = of_clk_get(smc_np, 0);
559 if (IS_ERR(ebi->smc.clk)) {
560 if (PTR_ERR(ebi->smc.clk) != -ENOENT) {
561 ret = PTR_ERR(ebi->smc.clk);
568 ret = clk_prepare_enable(ebi->smc.clk);
573 * The sama5d3 does not provide an EBICSA register and thus does need
576 if (ebi->caps->ebi_csa_offs) {
578 syscon_regmap_lookup_by_phandle(np,
579 ebi->caps->regmap_name);
580 if (IS_ERR(ebi->regmap))
581 return PTR_ERR(ebi->regmap);
584 ret = of_property_read_u32(np, "#address-cells", &val);
586 dev_err(dev, "missing #address-cells property\n");
592 ret = of_property_read_u32(np, "#size-cells", &val);
594 dev_err(dev, "missing #address-cells property\n");
600 for_each_available_child_of_node(np, child) {
601 if (!of_property_present(child, "reg"))
604 ret = atmel_ebi_dev_setup(ebi, child, reg_cells);
606 dev_err(dev, "failed to configure EBI bus for %pOF, disabling the device",
609 ret = atmel_ebi_dev_disable(ebi, child);
617 return of_platform_populate(np, NULL, NULL, dev);
624 static __maybe_unused int atmel_ebi_resume(struct device *dev)
626 struct atmel_ebi *ebi = dev_get_drvdata(dev);
627 struct atmel_ebi_dev *ebid;
629 list_for_each_entry(ebid, &ebi->devs, node) {
632 for (i = 0; i < ebid->numcs; i++)
633 ebid->ebi->caps->apply_config(ebid, &ebid->configs[i]);
639 static SIMPLE_DEV_PM_OPS(atmel_ebi_pm_ops, NULL, atmel_ebi_resume);
641 static struct platform_driver atmel_ebi_driver = {
644 .of_match_table = atmel_ebi_id_table,
645 .pm = &atmel_ebi_pm_ops,
648 builtin_platform_driver_probe(atmel_ebi_driver, atmel_ebi_probe);