2 * EBI driver for Atmel chips
3 * inspired by the fsl weim bus driver
5 * Copyright (C) 2013 Jean-Jacques Hiblot <jjhiblot@traphandler.com>
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.
12 #include <linux/clk.h>
14 #include <linux/mfd/syscon.h>
15 #include <linux/mfd/syscon/atmel-matrix.h>
16 #include <linux/mfd/syscon/atmel-smc.h>
17 #include <linux/init.h>
18 #include <linux/of_device.h>
19 #include <linux/regmap.h>
21 struct atmel_ebi_dev_config
{
23 struct atmel_smc_cs_conf smcconf
;
28 struct atmel_ebi_dev
{
29 struct list_head node
;
30 struct atmel_ebi
*ebi
;
33 struct atmel_ebi_dev_config configs
[];
36 struct atmel_ebi_caps
{
37 unsigned int available_cs
;
38 unsigned int ebi_csa_offs
;
39 void (*get_config
)(struct atmel_ebi_dev
*ebid
,
40 struct atmel_ebi_dev_config
*conf
);
41 int (*xlate_config
)(struct atmel_ebi_dev
*ebid
,
42 struct device_node
*configs_np
,
43 struct atmel_ebi_dev_config
*conf
);
44 void (*apply_config
)(struct atmel_ebi_dev
*ebid
,
45 struct atmel_ebi_dev_config
*conf
);
50 struct regmap
*matrix
;
52 struct regmap
*regmap
;
54 const struct atmel_hsmc_reg_layout
*layout
;
58 const struct atmel_ebi_caps
*caps
;
59 struct list_head devs
;
62 struct atmel_smc_timing_xlate
{
64 int (*converter
)(struct atmel_smc_cs_conf
*conf
,
65 unsigned int shift
, unsigned int nycles
);
69 #define ATMEL_SMC_SETUP_XLATE(nm, pos) \
70 { .name = nm, .converter = atmel_smc_cs_conf_set_setup, .shift = pos}
72 #define ATMEL_SMC_PULSE_XLATE(nm, pos) \
73 { .name = nm, .converter = atmel_smc_cs_conf_set_pulse, .shift = pos}
75 #define ATMEL_SMC_CYCLE_XLATE(nm, pos) \
76 { .name = nm, .converter = atmel_smc_cs_conf_set_cycle, .shift = pos}
78 static void at91sam9_ebi_get_config(struct atmel_ebi_dev
*ebid
,
79 struct atmel_ebi_dev_config
*conf
)
81 atmel_smc_cs_conf_get(ebid
->ebi
->smc
.regmap
, conf
->cs
,
85 static void sama5_ebi_get_config(struct atmel_ebi_dev
*ebid
,
86 struct atmel_ebi_dev_config
*conf
)
88 atmel_hsmc_cs_conf_get(ebid
->ebi
->smc
.regmap
, ebid
->ebi
->smc
.layout
,
89 conf
->cs
, &conf
->smcconf
);
92 static const struct atmel_smc_timing_xlate timings_xlate_table
[] = {
93 ATMEL_SMC_SETUP_XLATE("atmel,smc-ncs-rd-setup-ns",
94 ATMEL_SMC_NCS_RD_SHIFT
),
95 ATMEL_SMC_SETUP_XLATE("atmel,smc-ncs-wr-setup-ns",
96 ATMEL_SMC_NCS_WR_SHIFT
),
97 ATMEL_SMC_SETUP_XLATE("atmel,smc-nrd-setup-ns", ATMEL_SMC_NRD_SHIFT
),
98 ATMEL_SMC_SETUP_XLATE("atmel,smc-nwe-setup-ns", ATMEL_SMC_NWE_SHIFT
),
99 ATMEL_SMC_PULSE_XLATE("atmel,smc-ncs-rd-pulse-ns",
100 ATMEL_SMC_NCS_RD_SHIFT
),
101 ATMEL_SMC_PULSE_XLATE("atmel,smc-ncs-wr-pulse-ns",
102 ATMEL_SMC_NCS_WR_SHIFT
),
103 ATMEL_SMC_PULSE_XLATE("atmel,smc-nrd-pulse-ns", ATMEL_SMC_NRD_SHIFT
),
104 ATMEL_SMC_PULSE_XLATE("atmel,smc-nwe-pulse-ns", ATMEL_SMC_NWE_SHIFT
),
105 ATMEL_SMC_CYCLE_XLATE("atmel,smc-nrd-cycle-ns", ATMEL_SMC_NRD_SHIFT
),
106 ATMEL_SMC_CYCLE_XLATE("atmel,smc-nwe-cycle-ns", ATMEL_SMC_NWE_SHIFT
),
109 static int atmel_ebi_xslate_smc_timings(struct atmel_ebi_dev
*ebid
,
110 struct device_node
*np
,
111 struct atmel_smc_cs_conf
*smcconf
)
113 unsigned int clk_rate
= clk_get_rate(ebid
->ebi
->clk
);
114 unsigned int clk_period_ns
= NSEC_PER_SEC
/ clk_rate
;
115 bool required
= false;
116 unsigned int ncycles
;
120 ret
= of_property_read_u32(np
, "atmel,smc-tdf-ns", &val
);
123 ncycles
= DIV_ROUND_UP(val
, clk_period_ns
);
124 if (ncycles
> ATMEL_SMC_MODE_TDF_MAX
) {
129 if (ncycles
< ATMEL_SMC_MODE_TDF_MIN
)
130 ncycles
= ATMEL_SMC_MODE_TDF_MIN
;
132 smcconf
->mode
|= ATMEL_SMC_MODE_TDF(ncycles
);
135 for (i
= 0; i
< ARRAY_SIZE(timings_xlate_table
); i
++) {
136 const struct atmel_smc_timing_xlate
*xlate
;
138 xlate
= &timings_xlate_table
[i
];
140 ret
= of_property_read_u32(np
, xlate
->name
, &val
);
153 ncycles
= DIV_ROUND_UP(val
, clk_period_ns
);
154 ret
= xlate
->converter(smcconf
, xlate
->shift
, ncycles
);
161 dev_err(ebid
->ebi
->dev
,
162 "missing or invalid timings definition in %s",
170 static int atmel_ebi_xslate_smc_config(struct atmel_ebi_dev
*ebid
,
171 struct device_node
*np
,
172 struct atmel_ebi_dev_config
*conf
)
174 struct atmel_smc_cs_conf
*smcconf
= &conf
->smcconf
;
175 bool required
= false;
180 ret
= of_property_read_u32(np
, "atmel,smc-bus-width", &tmp
);
184 smcconf
->mode
|= ATMEL_SMC_MODE_DBW_8
;
188 smcconf
->mode
|= ATMEL_SMC_MODE_DBW_16
;
192 smcconf
->mode
|= ATMEL_SMC_MODE_DBW_32
;
202 if (of_property_read_bool(np
, "atmel,smc-tdf-optimized")) {
203 smcconf
->mode
|= ATMEL_SMC_MODE_TDFMODE_OPTIMIZED
;
208 of_property_read_string(np
, "atmel,smc-byte-access-type", &tmp_str
);
209 if (tmp_str
&& !strcmp(tmp_str
, "write")) {
210 smcconf
->mode
|= ATMEL_SMC_MODE_BAT_WRITE
;
215 of_property_read_string(np
, "atmel,smc-read-mode", &tmp_str
);
216 if (tmp_str
&& !strcmp(tmp_str
, "nrd")) {
217 smcconf
->mode
|= ATMEL_SMC_MODE_READMODE_NRD
;
222 of_property_read_string(np
, "atmel,smc-write-mode", &tmp_str
);
223 if (tmp_str
&& !strcmp(tmp_str
, "nwe")) {
224 smcconf
->mode
|= ATMEL_SMC_MODE_WRITEMODE_NWE
;
229 of_property_read_string(np
, "atmel,smc-exnw-mode", &tmp_str
);
231 if (!strcmp(tmp_str
, "frozen"))
232 smcconf
->mode
|= ATMEL_SMC_MODE_EXNWMODE_FROZEN
;
233 else if (!strcmp(tmp_str
, "ready"))
234 smcconf
->mode
|= ATMEL_SMC_MODE_EXNWMODE_READY
;
235 else if (strcmp(tmp_str
, "disabled"))
241 ret
= of_property_read_u32(np
, "atmel,smc-page-mode", &tmp
);
245 smcconf
->mode
|= ATMEL_SMC_MODE_PS_4
;
249 smcconf
->mode
|= ATMEL_SMC_MODE_PS_8
;
253 smcconf
->mode
|= ATMEL_SMC_MODE_PS_16
;
257 smcconf
->mode
|= ATMEL_SMC_MODE_PS_32
;
264 smcconf
->mode
|= ATMEL_SMC_MODE_PMEN
;
268 ret
= atmel_ebi_xslate_smc_timings(ebid
, np
, &conf
->smcconf
);
272 if ((ret
> 0 && !required
) || (!ret
&& required
)) {
273 dev_err(ebid
->ebi
->dev
, "missing atmel,smc- properties in %s",
281 static void at91sam9_ebi_apply_config(struct atmel_ebi_dev
*ebid
,
282 struct atmel_ebi_dev_config
*conf
)
284 atmel_smc_cs_conf_apply(ebid
->ebi
->smc
.regmap
, conf
->cs
,
288 static void sama5_ebi_apply_config(struct atmel_ebi_dev
*ebid
,
289 struct atmel_ebi_dev_config
*conf
)
291 atmel_hsmc_cs_conf_apply(ebid
->ebi
->smc
.regmap
, ebid
->ebi
->smc
.layout
,
292 conf
->cs
, &conf
->smcconf
);
295 static int atmel_ebi_dev_setup(struct atmel_ebi
*ebi
, struct device_node
*np
,
298 const struct atmel_ebi_caps
*caps
= ebi
->caps
;
299 struct atmel_ebi_dev_config conf
= { };
300 struct device
*dev
= ebi
->dev
;
301 struct atmel_ebi_dev
*ebid
;
302 unsigned long cslines
= 0;
303 int ret
, numcs
= 0, nentries
, i
;
307 nentries
= of_property_count_elems_of_size(np
, "reg",
308 reg_cells
* sizeof(u32
));
309 for (i
= 0; i
< nentries
; i
++) {
310 ret
= of_property_read_u32_index(np
, "reg", i
* reg_cells
,
315 if (cs
>= AT91_MATRIX_EBI_NUM_CS
||
316 !(ebi
->caps
->available_cs
& BIT(cs
))) {
317 dev_err(dev
, "invalid reg property in %s\n",
322 if (!test_and_set_bit(cs
, &cslines
))
327 dev_err(dev
, "invalid reg property in %s\n", np
->full_name
);
331 ebid
= devm_kzalloc(ebi
->dev
,
332 sizeof(*ebid
) + (numcs
* sizeof(*ebid
->configs
)),
340 ret
= caps
->xlate_config(ebid
, np
, &conf
);
347 for_each_set_bit(cs
, &cslines
, AT91_MATRIX_EBI_NUM_CS
) {
348 ebid
->configs
[i
].cs
= cs
;
352 caps
->apply_config(ebid
, &conf
);
355 caps
->get_config(ebid
, &ebid
->configs
[i
]);
358 * Attach the EBI device to the generic SMC logic if at least
359 * one "atmel,smc-" property is present.
361 if (ebi
->caps
->ebi_csa_offs
&& apply
)
362 regmap_update_bits(ebi
->matrix
,
363 ebi
->caps
->ebi_csa_offs
,
369 list_add_tail(&ebid
->node
, &ebi
->devs
);
374 static const struct atmel_ebi_caps at91sam9260_ebi_caps
= {
375 .available_cs
= 0xff,
376 .ebi_csa_offs
= AT91SAM9260_MATRIX_EBICSA
,
377 .get_config
= at91sam9_ebi_get_config
,
378 .xlate_config
= atmel_ebi_xslate_smc_config
,
379 .apply_config
= at91sam9_ebi_apply_config
,
382 static const struct atmel_ebi_caps at91sam9261_ebi_caps
= {
383 .available_cs
= 0xff,
384 .ebi_csa_offs
= AT91SAM9261_MATRIX_EBICSA
,
385 .get_config
= at91sam9_ebi_get_config
,
386 .xlate_config
= atmel_ebi_xslate_smc_config
,
387 .apply_config
= at91sam9_ebi_apply_config
,
390 static const struct atmel_ebi_caps at91sam9263_ebi0_caps
= {
391 .available_cs
= 0x3f,
392 .ebi_csa_offs
= AT91SAM9263_MATRIX_EBI0CSA
,
393 .get_config
= at91sam9_ebi_get_config
,
394 .xlate_config
= atmel_ebi_xslate_smc_config
,
395 .apply_config
= at91sam9_ebi_apply_config
,
398 static const struct atmel_ebi_caps at91sam9263_ebi1_caps
= {
400 .ebi_csa_offs
= AT91SAM9263_MATRIX_EBI1CSA
,
401 .get_config
= at91sam9_ebi_get_config
,
402 .xlate_config
= atmel_ebi_xslate_smc_config
,
403 .apply_config
= at91sam9_ebi_apply_config
,
406 static const struct atmel_ebi_caps at91sam9rl_ebi_caps
= {
407 .available_cs
= 0x3f,
408 .ebi_csa_offs
= AT91SAM9RL_MATRIX_EBICSA
,
409 .get_config
= at91sam9_ebi_get_config
,
410 .xlate_config
= atmel_ebi_xslate_smc_config
,
411 .apply_config
= at91sam9_ebi_apply_config
,
414 static const struct atmel_ebi_caps at91sam9g45_ebi_caps
= {
415 .available_cs
= 0x3f,
416 .ebi_csa_offs
= AT91SAM9G45_MATRIX_EBICSA
,
417 .get_config
= at91sam9_ebi_get_config
,
418 .xlate_config
= atmel_ebi_xslate_smc_config
,
419 .apply_config
= at91sam9_ebi_apply_config
,
422 static const struct atmel_ebi_caps at91sam9x5_ebi_caps
= {
423 .available_cs
= 0x3f,
424 .ebi_csa_offs
= AT91SAM9X5_MATRIX_EBICSA
,
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 sama5d3_ebi_caps
= {
432 .get_config
= sama5_ebi_get_config
,
433 .xlate_config
= atmel_ebi_xslate_smc_config
,
434 .apply_config
= sama5_ebi_apply_config
,
437 static const struct of_device_id atmel_ebi_id_table
[] = {
439 .compatible
= "atmel,at91sam9260-ebi",
440 .data
= &at91sam9260_ebi_caps
,
443 .compatible
= "atmel,at91sam9261-ebi",
444 .data
= &at91sam9261_ebi_caps
,
447 .compatible
= "atmel,at91sam9263-ebi0",
448 .data
= &at91sam9263_ebi0_caps
,
451 .compatible
= "atmel,at91sam9263-ebi1",
452 .data
= &at91sam9263_ebi1_caps
,
455 .compatible
= "atmel,at91sam9rl-ebi",
456 .data
= &at91sam9rl_ebi_caps
,
459 .compatible
= "atmel,at91sam9g45-ebi",
460 .data
= &at91sam9g45_ebi_caps
,
463 .compatible
= "atmel,at91sam9x5-ebi",
464 .data
= &at91sam9x5_ebi_caps
,
467 .compatible
= "atmel,sama5d3-ebi",
468 .data
= &sama5d3_ebi_caps
,
473 static int atmel_ebi_dev_disable(struct atmel_ebi
*ebi
, struct device_node
*np
)
475 struct device
*dev
= ebi
->dev
;
476 struct property
*newprop
;
478 newprop
= devm_kzalloc(dev
, sizeof(*newprop
), GFP_KERNEL
);
482 newprop
->name
= devm_kstrdup(dev
, "status", GFP_KERNEL
);
486 newprop
->value
= devm_kstrdup(dev
, "disabled", GFP_KERNEL
);
490 newprop
->length
= sizeof("disabled");
492 return of_update_property(np
, newprop
);
495 static int atmel_ebi_probe(struct platform_device
*pdev
)
497 struct device
*dev
= &pdev
->dev
;
498 struct device_node
*child
, *np
= dev
->of_node
, *smc_np
;
499 const struct of_device_id
*match
;
500 struct atmel_ebi
*ebi
;
505 match
= of_match_device(atmel_ebi_id_table
, dev
);
506 if (!match
|| !match
->data
)
509 ebi
= devm_kzalloc(dev
, sizeof(*ebi
), GFP_KERNEL
);
513 platform_set_drvdata(pdev
, ebi
);
515 INIT_LIST_HEAD(&ebi
->devs
);
516 ebi
->caps
= match
->data
;
519 clk
= devm_clk_get(dev
, NULL
);
525 smc_np
= of_parse_phandle(dev
->of_node
, "atmel,smc", 0);
527 ebi
->smc
.regmap
= syscon_node_to_regmap(smc_np
);
528 if (IS_ERR(ebi
->smc
.regmap
))
529 return PTR_ERR(ebi
->smc
.regmap
);
531 ebi
->smc
.layout
= atmel_hsmc_get_reg_layout(smc_np
);
532 if (IS_ERR(ebi
->smc
.layout
))
533 return PTR_ERR(ebi
->smc
.layout
);
535 ebi
->smc
.clk
= of_clk_get(smc_np
, 0);
536 if (IS_ERR(ebi
->smc
.clk
)) {
537 if (PTR_ERR(ebi
->smc
.clk
) != -ENOENT
)
538 return PTR_ERR(ebi
->smc
.clk
);
542 ret
= clk_prepare_enable(ebi
->smc
.clk
);
547 * The sama5d3 does not provide an EBICSA register and thus does need
548 * to access the matrix registers.
550 if (ebi
->caps
->ebi_csa_offs
) {
552 syscon_regmap_lookup_by_phandle(np
, "atmel,matrix");
553 if (IS_ERR(ebi
->matrix
))
554 return PTR_ERR(ebi
->matrix
);
557 ret
= of_property_read_u32(np
, "#address-cells", &val
);
559 dev_err(dev
, "missing #address-cells property\n");
565 ret
= of_property_read_u32(np
, "#size-cells", &val
);
567 dev_err(dev
, "missing #address-cells property\n");
573 for_each_available_child_of_node(np
, child
) {
574 if (!of_find_property(child
, "reg", NULL
))
577 ret
= atmel_ebi_dev_setup(ebi
, child
, reg_cells
);
579 dev_err(dev
, "failed to configure EBI bus for %s, disabling the device",
582 ret
= atmel_ebi_dev_disable(ebi
, child
);
588 return of_platform_populate(np
, NULL
, NULL
, dev
);
591 static __maybe_unused
int atmel_ebi_resume(struct device
*dev
)
593 struct atmel_ebi
*ebi
= dev_get_drvdata(dev
);
594 struct atmel_ebi_dev
*ebid
;
596 list_for_each_entry(ebid
, &ebi
->devs
, node
) {
599 for (i
= 0; i
< ebid
->numcs
; i
++)
600 ebid
->ebi
->caps
->apply_config(ebid
, &ebid
->configs
[i
]);
606 static SIMPLE_DEV_PM_OPS(atmel_ebi_pm_ops
, NULL
, atmel_ebi_resume
);
608 static struct platform_driver atmel_ebi_driver
= {
611 .of_match_table
= atmel_ebi_id_table
,
612 .pm
= &atmel_ebi_pm_ops
,
615 builtin_platform_driver_probe(atmel_ebi_driver
, atmel_ebi_probe
);