1 // SPDX-License-Identifier: GPL-2.0
3 * Tegra20 External Memory Controller driver
9 #include <linux/clk/tegra.h>
10 #include <linux/debugfs.h>
11 #include <linux/err.h>
12 #include <linux/interrupt.h>
14 #include <linux/iopoll.h>
15 #include <linux/kernel.h>
16 #include <linux/module.h>
18 #include <linux/platform_device.h>
19 #include <linux/sort.h>
20 #include <linux/types.h>
22 #include <soc/tegra/fuse.h>
24 #define EMC_INTSTATUS 0x000
25 #define EMC_INTMASK 0x004
27 #define EMC_TIMING_CONTROL 0x028
36 #define EMC_RD_RCD 0x04c
37 #define EMC_WR_RCD 0x050
39 #define EMC_REXT 0x058
41 #define EMC_QUSE 0x060
42 #define EMC_QRST 0x064
43 #define EMC_QSAFE 0x068
45 #define EMC_REFRESH 0x070
46 #define EMC_BURST_REFRESH_NUM 0x074
47 #define EMC_PDEX2WR 0x078
48 #define EMC_PDEX2RD 0x07c
49 #define EMC_PCHG2PDEN 0x080
50 #define EMC_ACT2PDEN 0x084
51 #define EMC_AR2PDEN 0x088
52 #define EMC_RW2PDEN 0x08c
53 #define EMC_TXSR 0x090
54 #define EMC_TCKE 0x094
55 #define EMC_TFAW 0x098
56 #define EMC_TRPAB 0x09c
57 #define EMC_TCLKSTABLE 0x0a0
58 #define EMC_TCLKSTOP 0x0a4
59 #define EMC_TREFBW 0x0a8
60 #define EMC_QUSE_EXTRA 0x0ac
61 #define EMC_ODT_WRITE 0x0b0
62 #define EMC_ODT_READ 0x0b4
63 #define EMC_FBIO_CFG5 0x104
64 #define EMC_FBIO_CFG6 0x114
65 #define EMC_AUTO_CAL_INTERVAL 0x2a8
66 #define EMC_CFG_2 0x2b8
67 #define EMC_CFG_DIG_DLL 0x2bc
68 #define EMC_DLL_XFORM_DQS 0x2c0
69 #define EMC_DLL_XFORM_QUSE 0x2c4
70 #define EMC_ZCAL_REF_CNT 0x2e0
71 #define EMC_ZCAL_WAIT_CNT 0x2e4
72 #define EMC_CFG_CLKTRIM_0 0x2d0
73 #define EMC_CFG_CLKTRIM_1 0x2d4
74 #define EMC_CFG_CLKTRIM_2 0x2d8
76 #define EMC_CLKCHANGE_REQ_ENABLE BIT(0)
77 #define EMC_CLKCHANGE_PD_ENABLE BIT(1)
78 #define EMC_CLKCHANGE_SR_ENABLE BIT(2)
80 #define EMC_TIMING_UPDATE BIT(0)
82 #define EMC_REFRESH_OVERFLOW_INT BIT(3)
83 #define EMC_CLKCHANGE_COMPLETE_INT BIT(4)
85 #define EMC_DBG_READ_MUX_ASSEMBLY BIT(0)
86 #define EMC_DBG_WRITE_MUX_ACTIVE BIT(1)
87 #define EMC_DBG_FORCE_UPDATE BIT(2)
88 #define EMC_DBG_READ_DQM_CTRL BIT(9)
89 #define EMC_DBG_CFG_PRIORITY BIT(24)
91 static const u16 emc_timing_registers[] = {
110 EMC_BURST_REFRESH_NUM,
134 EMC_AUTO_CAL_INTERVAL,
142 u32 data[ARRAY_SIZE(emc_timing_registers)];
147 struct notifier_block clk_nb;
151 struct emc_timing *timings;
152 unsigned int num_timings;
156 unsigned long min_rate;
157 unsigned long max_rate;
161 static irqreturn_t tegra_emc_isr(int irq, void *data)
163 struct tegra_emc *emc = data;
164 u32 intmask = EMC_REFRESH_OVERFLOW_INT;
167 status = readl_relaxed(emc->regs + EMC_INTSTATUS) & intmask;
171 /* notify about HW problem */
172 if (status & EMC_REFRESH_OVERFLOW_INT)
173 dev_err_ratelimited(emc->dev,
174 "refresh request overflow timeout\n");
176 /* clear interrupts */
177 writel_relaxed(status, emc->regs + EMC_INTSTATUS);
182 static struct emc_timing *tegra_emc_find_timing(struct tegra_emc *emc,
185 struct emc_timing *timing = NULL;
188 for (i = 0; i < emc->num_timings; i++) {
189 if (emc->timings[i].rate >= rate) {
190 timing = &emc->timings[i];
196 dev_err(emc->dev, "no timing for rate %lu\n", rate);
203 static int emc_prepare_timing_change(struct tegra_emc *emc, unsigned long rate)
205 struct emc_timing *timing = tegra_emc_find_timing(emc, rate);
211 dev_dbg(emc->dev, "%s: using timing rate %lu for requested rate %lu\n",
212 __func__, timing->rate, rate);
214 /* program shadow registers */
215 for (i = 0; i < ARRAY_SIZE(timing->data); i++)
216 writel_relaxed(timing->data[i],
217 emc->regs + emc_timing_registers[i]);
219 /* wait until programming has settled */
220 readl_relaxed(emc->regs + emc_timing_registers[i - 1]);
225 static int emc_complete_timing_change(struct tegra_emc *emc, bool flush)
230 dev_dbg(emc->dev, "%s: flush %d\n", __func__, flush);
233 /* manually initiate memory timing update */
234 writel_relaxed(EMC_TIMING_UPDATE,
235 emc->regs + EMC_TIMING_CONTROL);
239 err = readl_relaxed_poll_timeout_atomic(emc->regs + EMC_INTSTATUS, v,
240 v & EMC_CLKCHANGE_COMPLETE_INT,
243 dev_err(emc->dev, "emc-car handshake timeout: %d\n", err);
250 static int tegra_emc_clk_change_notify(struct notifier_block *nb,
251 unsigned long msg, void *data)
253 struct tegra_emc *emc = container_of(nb, struct tegra_emc, clk_nb);
254 struct clk_notifier_data *cnd = data;
258 case PRE_RATE_CHANGE:
259 err = emc_prepare_timing_change(emc, cnd->new_rate);
262 case ABORT_RATE_CHANGE:
263 err = emc_prepare_timing_change(emc, cnd->old_rate);
267 err = emc_complete_timing_change(emc, true);
270 case POST_RATE_CHANGE:
271 err = emc_complete_timing_change(emc, false);
278 return notifier_from_errno(err);
281 static int load_one_timing_from_dt(struct tegra_emc *emc,
282 struct emc_timing *timing,
283 struct device_node *node)
288 if (!of_device_is_compatible(node, "nvidia,tegra20-emc-table")) {
289 dev_err(emc->dev, "incompatible DT node: %pOF\n", node);
293 err = of_property_read_u32(node, "clock-frequency", &rate);
295 dev_err(emc->dev, "timing %pOF: failed to read rate: %d\n",
300 err = of_property_read_u32_array(node, "nvidia,emc-registers",
302 ARRAY_SIZE(emc_timing_registers));
305 "timing %pOF: failed to read emc timing data: %d\n",
311 * The EMC clock rate is twice the bus rate, and the bus rate is
314 timing->rate = rate * 2 * 1000;
316 dev_dbg(emc->dev, "%s: %pOF: EMC rate %lu\n",
317 __func__, node, timing->rate);
322 static int cmp_timings(const void *_a, const void *_b)
324 const struct emc_timing *a = _a;
325 const struct emc_timing *b = _b;
327 if (a->rate < b->rate)
330 if (a->rate > b->rate)
336 static int tegra_emc_load_timings_from_dt(struct tegra_emc *emc,
337 struct device_node *node)
339 struct device_node *child;
340 struct emc_timing *timing;
344 child_count = of_get_child_count(node);
346 dev_err(emc->dev, "no memory timings in DT node: %pOF\n", node);
350 emc->timings = devm_kcalloc(emc->dev, child_count, sizeof(*timing),
355 emc->num_timings = child_count;
356 timing = emc->timings;
358 for_each_child_of_node(node, child) {
359 err = load_one_timing_from_dt(emc, timing++, child);
366 sort(emc->timings, emc->num_timings, sizeof(*timing), cmp_timings,
370 "got %u timings for RAM code %u (min %luMHz max %luMHz)\n",
372 tegra_read_ram_code(),
373 emc->timings[0].rate / 1000000,
374 emc->timings[emc->num_timings - 1].rate / 1000000);
379 static struct device_node *
380 tegra_emc_find_node_by_ram_code(struct device *dev)
382 struct device_node *np;
386 if (!of_property_read_bool(dev->of_node, "nvidia,use-ram-code"))
387 return of_node_get(dev->of_node);
389 ram_code = tegra_read_ram_code();
391 for (np = of_find_node_by_name(dev->of_node, "emc-tables"); np;
392 np = of_find_node_by_name(np, "emc-tables")) {
393 err = of_property_read_u32(np, "nvidia,ram-code", &value);
394 if (err || value != ram_code) {
402 dev_err(dev, "no memory timings for RAM code %u found in device tree\n",
408 static int emc_setup_hw(struct tegra_emc *emc)
410 u32 intmask = EMC_REFRESH_OVERFLOW_INT;
411 u32 emc_cfg, emc_dbg;
413 emc_cfg = readl_relaxed(emc->regs + EMC_CFG_2);
416 * Depending on a memory type, DRAM should enter either self-refresh
417 * or power-down state on EMC clock change.
419 if (!(emc_cfg & EMC_CLKCHANGE_PD_ENABLE) &&
420 !(emc_cfg & EMC_CLKCHANGE_SR_ENABLE)) {
422 "bootloader didn't specify DRAM auto-suspend mode\n");
426 /* enable EMC and CAR to handshake on PLL divider/source changes */
427 emc_cfg |= EMC_CLKCHANGE_REQ_ENABLE;
428 writel_relaxed(emc_cfg, emc->regs + EMC_CFG_2);
430 /* initialize interrupt */
431 writel_relaxed(intmask, emc->regs + EMC_INTMASK);
432 writel_relaxed(intmask, emc->regs + EMC_INTSTATUS);
434 /* ensure that unwanted debug features are disabled */
435 emc_dbg = readl_relaxed(emc->regs + EMC_DBG);
436 emc_dbg |= EMC_DBG_CFG_PRIORITY;
437 emc_dbg &= ~EMC_DBG_READ_MUX_ASSEMBLY;
438 emc_dbg &= ~EMC_DBG_WRITE_MUX_ACTIVE;
439 emc_dbg &= ~EMC_DBG_FORCE_UPDATE;
440 writel_relaxed(emc_dbg, emc->regs + EMC_DBG);
445 static long emc_round_rate(unsigned long rate,
446 unsigned long min_rate,
447 unsigned long max_rate,
450 struct emc_timing *timing = NULL;
451 struct tegra_emc *emc = arg;
454 min_rate = min(min_rate, emc->timings[emc->num_timings - 1].rate);
456 for (i = 0; i < emc->num_timings; i++) {
457 if (emc->timings[i].rate < rate && i != emc->num_timings - 1)
460 if (emc->timings[i].rate > max_rate) {
463 if (emc->timings[i].rate < min_rate)
467 if (emc->timings[i].rate < min_rate)
470 timing = &emc->timings[i];
475 dev_err(emc->dev, "no timing for rate %lu min %lu max %lu\n",
476 rate, min_rate, max_rate);
486 * The memory controller driver exposes some files in debugfs that can be used
487 * to control the EMC frequency. The top-level directory can be found here:
489 * /sys/kernel/debug/emc
491 * It contains the following files:
493 * - available_rates: This file contains a list of valid, space-separated
496 * - min_rate: Writing a value to this file sets the given frequency as the
497 * floor of the permitted range. If this is higher than the currently
498 * configured EMC frequency, this will cause the frequency to be
499 * increased so that it stays within the valid range.
501 * - max_rate: Similarily to the min_rate file, writing a value to this file
502 * sets the given frequency as the ceiling of the permitted range. If
503 * the value is lower than the currently configured EMC frequency, this
504 * will cause the frequency to be decreased so that it stays within the
508 static bool tegra_emc_validate_rate(struct tegra_emc *emc, unsigned long rate)
512 for (i = 0; i < emc->num_timings; i++)
513 if (rate == emc->timings[i].rate)
519 static int tegra_emc_debug_available_rates_show(struct seq_file *s, void *data)
521 struct tegra_emc *emc = s->private;
522 const char *prefix = "";
525 for (i = 0; i < emc->num_timings; i++) {
526 seq_printf(s, "%s%lu", prefix, emc->timings[i].rate);
535 static int tegra_emc_debug_available_rates_open(struct inode *inode,
538 return single_open(file, tegra_emc_debug_available_rates_show,
542 static const struct file_operations tegra_emc_debug_available_rates_fops = {
543 .open = tegra_emc_debug_available_rates_open,
546 .release = single_release,
549 static int tegra_emc_debug_min_rate_get(void *data, u64 *rate)
551 struct tegra_emc *emc = data;
553 *rate = emc->debugfs.min_rate;
558 static int tegra_emc_debug_min_rate_set(void *data, u64 rate)
560 struct tegra_emc *emc = data;
563 if (!tegra_emc_validate_rate(emc, rate))
566 err = clk_set_min_rate(emc->clk, rate);
570 emc->debugfs.min_rate = rate;
575 DEFINE_SIMPLE_ATTRIBUTE(tegra_emc_debug_min_rate_fops,
576 tegra_emc_debug_min_rate_get,
577 tegra_emc_debug_min_rate_set, "%llu\n");
579 static int tegra_emc_debug_max_rate_get(void *data, u64 *rate)
581 struct tegra_emc *emc = data;
583 *rate = emc->debugfs.max_rate;
588 static int tegra_emc_debug_max_rate_set(void *data, u64 rate)
590 struct tegra_emc *emc = data;
593 if (!tegra_emc_validate_rate(emc, rate))
596 err = clk_set_max_rate(emc->clk, rate);
600 emc->debugfs.max_rate = rate;
605 DEFINE_SIMPLE_ATTRIBUTE(tegra_emc_debug_max_rate_fops,
606 tegra_emc_debug_max_rate_get,
607 tegra_emc_debug_max_rate_set, "%llu\n");
609 static void tegra_emc_debugfs_init(struct tegra_emc *emc)
611 struct device *dev = emc->dev;
615 emc->debugfs.min_rate = ULONG_MAX;
616 emc->debugfs.max_rate = 0;
618 for (i = 0; i < emc->num_timings; i++) {
619 if (emc->timings[i].rate < emc->debugfs.min_rate)
620 emc->debugfs.min_rate = emc->timings[i].rate;
622 if (emc->timings[i].rate > emc->debugfs.max_rate)
623 emc->debugfs.max_rate = emc->timings[i].rate;
626 if (!emc->num_timings) {
627 emc->debugfs.min_rate = clk_get_rate(emc->clk);
628 emc->debugfs.max_rate = emc->debugfs.min_rate;
631 err = clk_set_rate_range(emc->clk, emc->debugfs.min_rate,
632 emc->debugfs.max_rate);
634 dev_err(dev, "failed to set rate range [%lu-%lu] for %pC\n",
635 emc->debugfs.min_rate, emc->debugfs.max_rate,
639 emc->debugfs.root = debugfs_create_dir("emc", NULL);
640 if (!emc->debugfs.root) {
641 dev_err(emc->dev, "failed to create debugfs directory\n");
645 debugfs_create_file("available_rates", 0444, emc->debugfs.root,
646 emc, &tegra_emc_debug_available_rates_fops);
647 debugfs_create_file("min_rate", 0644, emc->debugfs.root,
648 emc, &tegra_emc_debug_min_rate_fops);
649 debugfs_create_file("max_rate", 0644, emc->debugfs.root,
650 emc, &tegra_emc_debug_max_rate_fops);
653 static int tegra_emc_probe(struct platform_device *pdev)
655 struct device_node *np;
656 struct tegra_emc *emc;
657 struct resource *res;
660 /* driver has nothing to do in a case of memory timing absence */
661 if (of_get_child_count(pdev->dev.of_node) == 0) {
663 "EMC device tree node doesn't have memory timings\n");
667 irq = platform_get_irq(pdev, 0);
669 dev_err(&pdev->dev, "interrupt not specified\n");
670 dev_err(&pdev->dev, "please update your device tree\n");
674 np = tegra_emc_find_node_by_ram_code(&pdev->dev);
678 emc = devm_kzalloc(&pdev->dev, sizeof(*emc), GFP_KERNEL);
684 emc->clk_nb.notifier_call = tegra_emc_clk_change_notify;
685 emc->dev = &pdev->dev;
687 err = tegra_emc_load_timings_from_dt(emc, np);
692 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
693 emc->regs = devm_ioremap_resource(&pdev->dev, res);
694 if (IS_ERR(emc->regs))
695 return PTR_ERR(emc->regs);
697 err = emc_setup_hw(emc);
701 err = devm_request_irq(&pdev->dev, irq, tegra_emc_isr, 0,
702 dev_name(&pdev->dev), emc);
704 dev_err(&pdev->dev, "failed to request IRQ#%u: %d\n", irq, err);
708 tegra20_clk_set_emc_round_callback(emc_round_rate, emc);
710 emc->clk = devm_clk_get(&pdev->dev, "emc");
711 if (IS_ERR(emc->clk)) {
712 err = PTR_ERR(emc->clk);
713 dev_err(&pdev->dev, "failed to get emc clock: %d\n", err);
717 err = clk_notifier_register(emc->clk, &emc->clk_nb);
719 dev_err(&pdev->dev, "failed to register clk notifier: %d\n",
724 platform_set_drvdata(pdev, emc);
725 tegra_emc_debugfs_init(emc);
730 tegra20_clk_set_emc_round_callback(NULL, NULL);
735 static const struct of_device_id tegra_emc_of_match[] = {
736 { .compatible = "nvidia,tegra20-emc", },
740 static struct platform_driver tegra_emc_driver = {
741 .probe = tegra_emc_probe,
743 .name = "tegra20-emc",
744 .of_match_table = tegra_emc_of_match,
745 .suppress_bind_attrs = true,
749 static int __init tegra_emc_init(void)
751 return platform_driver_register(&tegra_emc_driver);
753 subsys_initcall(tegra_emc_init);