1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2014 NVIDIA CORPORATION. All rights reserved.
7 #include <linux/delay.h>
8 #include <linux/dma-mapping.h>
9 #include <linux/export.h>
10 #include <linux/interrupt.h>
11 #include <linux/kernel.h>
12 #include <linux/module.h>
14 #include <linux/of_device.h>
15 #include <linux/platform_device.h>
16 #include <linux/slab.h>
17 #include <linux/sort.h>
19 #include <soc/tegra/fuse.h>
23 static const struct of_device_id tegra_mc_of_match[] = {
24 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
25 { .compatible = "nvidia,tegra20-mc-gart", .data = &tegra20_mc_soc },
27 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
28 { .compatible = "nvidia,tegra30-mc", .data = &tegra30_mc_soc },
30 #ifdef CONFIG_ARCH_TEGRA_114_SOC
31 { .compatible = "nvidia,tegra114-mc", .data = &tegra114_mc_soc },
33 #ifdef CONFIG_ARCH_TEGRA_124_SOC
34 { .compatible = "nvidia,tegra124-mc", .data = &tegra124_mc_soc },
36 #ifdef CONFIG_ARCH_TEGRA_132_SOC
37 { .compatible = "nvidia,tegra132-mc", .data = &tegra132_mc_soc },
39 #ifdef CONFIG_ARCH_TEGRA_210_SOC
40 { .compatible = "nvidia,tegra210-mc", .data = &tegra210_mc_soc },
42 #ifdef CONFIG_ARCH_TEGRA_186_SOC
43 { .compatible = "nvidia,tegra186-mc", .data = &tegra186_mc_soc },
45 #ifdef CONFIG_ARCH_TEGRA_194_SOC
46 { .compatible = "nvidia,tegra194-mc", .data = &tegra194_mc_soc },
50 MODULE_DEVICE_TABLE(of, tegra_mc_of_match);
52 static void tegra_mc_devm_action_put_device(void *data)
54 struct tegra_mc *mc = data;
60 * devm_tegra_memory_controller_get() - get Tegra Memory Controller handle
61 * @dev: device pointer for the consumer device
63 * This function will search for the Memory Controller node in a device-tree
64 * and retrieve the Memory Controller handle.
66 * Return: ERR_PTR() on error or a valid pointer to a struct tegra_mc.
68 struct tegra_mc *devm_tegra_memory_controller_get(struct device *dev)
70 struct platform_device *pdev;
71 struct device_node *np;
75 np = of_parse_phandle(dev->of_node, "nvidia,memory-controller", 0);
77 return ERR_PTR(-ENOENT);
79 pdev = of_find_device_by_node(np);
82 return ERR_PTR(-ENODEV);
84 mc = platform_get_drvdata(pdev);
86 put_device(&pdev->dev);
87 return ERR_PTR(-EPROBE_DEFER);
90 err = devm_add_action(dev, tegra_mc_devm_action_put_device, mc);
98 EXPORT_SYMBOL_GPL(devm_tegra_memory_controller_get);
100 int tegra_mc_probe_device(struct tegra_mc *mc, struct device *dev)
102 if (mc->soc->ops && mc->soc->ops->probe_device)
103 return mc->soc->ops->probe_device(mc, dev);
107 EXPORT_SYMBOL_GPL(tegra_mc_probe_device);
109 static int tegra_mc_block_dma_common(struct tegra_mc *mc,
110 const struct tegra_mc_reset *rst)
115 spin_lock_irqsave(&mc->lock, flags);
117 value = mc_readl(mc, rst->control) | BIT(rst->bit);
118 mc_writel(mc, value, rst->control);
120 spin_unlock_irqrestore(&mc->lock, flags);
125 static bool tegra_mc_dma_idling_common(struct tegra_mc *mc,
126 const struct tegra_mc_reset *rst)
128 return (mc_readl(mc, rst->status) & BIT(rst->bit)) != 0;
131 static int tegra_mc_unblock_dma_common(struct tegra_mc *mc,
132 const struct tegra_mc_reset *rst)
137 spin_lock_irqsave(&mc->lock, flags);
139 value = mc_readl(mc, rst->control) & ~BIT(rst->bit);
140 mc_writel(mc, value, rst->control);
142 spin_unlock_irqrestore(&mc->lock, flags);
147 static int tegra_mc_reset_status_common(struct tegra_mc *mc,
148 const struct tegra_mc_reset *rst)
150 return (mc_readl(mc, rst->control) & BIT(rst->bit)) != 0;
153 const struct tegra_mc_reset_ops tegra_mc_reset_ops_common = {
154 .block_dma = tegra_mc_block_dma_common,
155 .dma_idling = tegra_mc_dma_idling_common,
156 .unblock_dma = tegra_mc_unblock_dma_common,
157 .reset_status = tegra_mc_reset_status_common,
160 static inline struct tegra_mc *reset_to_mc(struct reset_controller_dev *rcdev)
162 return container_of(rcdev, struct tegra_mc, reset);
165 static const struct tegra_mc_reset *tegra_mc_reset_find(struct tegra_mc *mc,
170 for (i = 0; i < mc->soc->num_resets; i++)
171 if (mc->soc->resets[i].id == id)
172 return &mc->soc->resets[i];
177 static int tegra_mc_hotreset_assert(struct reset_controller_dev *rcdev,
180 struct tegra_mc *mc = reset_to_mc(rcdev);
181 const struct tegra_mc_reset_ops *rst_ops;
182 const struct tegra_mc_reset *rst;
186 rst = tegra_mc_reset_find(mc, id);
190 rst_ops = mc->soc->reset_ops;
194 /* DMA flushing will fail if reset is already asserted */
195 if (rst_ops->reset_status) {
196 /* check whether reset is asserted */
197 if (rst_ops->reset_status(mc, rst))
201 if (rst_ops->block_dma) {
202 /* block clients DMA requests */
203 err = rst_ops->block_dma(mc, rst);
205 dev_err(mc->dev, "failed to block %s DMA: %d\n",
211 if (rst_ops->dma_idling) {
212 /* wait for completion of the outstanding DMA requests */
213 while (!rst_ops->dma_idling(mc, rst)) {
215 dev_err(mc->dev, "failed to flush %s DMA\n",
220 usleep_range(10, 100);
224 if (rst_ops->hotreset_assert) {
225 /* clear clients DMA requests sitting before arbitration */
226 err = rst_ops->hotreset_assert(mc, rst);
228 dev_err(mc->dev, "failed to hot reset %s: %d\n",
237 static int tegra_mc_hotreset_deassert(struct reset_controller_dev *rcdev,
240 struct tegra_mc *mc = reset_to_mc(rcdev);
241 const struct tegra_mc_reset_ops *rst_ops;
242 const struct tegra_mc_reset *rst;
245 rst = tegra_mc_reset_find(mc, id);
249 rst_ops = mc->soc->reset_ops;
253 if (rst_ops->hotreset_deassert) {
254 /* take out client from hot reset */
255 err = rst_ops->hotreset_deassert(mc, rst);
257 dev_err(mc->dev, "failed to deassert hot reset %s: %d\n",
263 if (rst_ops->unblock_dma) {
264 /* allow new DMA requests to proceed to arbitration */
265 err = rst_ops->unblock_dma(mc, rst);
267 dev_err(mc->dev, "failed to unblock %s DMA : %d\n",
276 static int tegra_mc_hotreset_status(struct reset_controller_dev *rcdev,
279 struct tegra_mc *mc = reset_to_mc(rcdev);
280 const struct tegra_mc_reset_ops *rst_ops;
281 const struct tegra_mc_reset *rst;
283 rst = tegra_mc_reset_find(mc, id);
287 rst_ops = mc->soc->reset_ops;
291 return rst_ops->reset_status(mc, rst);
294 static const struct reset_control_ops tegra_mc_reset_ops = {
295 .assert = tegra_mc_hotreset_assert,
296 .deassert = tegra_mc_hotreset_deassert,
297 .status = tegra_mc_hotreset_status,
300 static int tegra_mc_reset_setup(struct tegra_mc *mc)
304 mc->reset.ops = &tegra_mc_reset_ops;
305 mc->reset.owner = THIS_MODULE;
306 mc->reset.of_node = mc->dev->of_node;
307 mc->reset.of_reset_n_cells = 1;
308 mc->reset.nr_resets = mc->soc->num_resets;
310 err = reset_controller_register(&mc->reset);
317 int tegra_mc_write_emem_configuration(struct tegra_mc *mc, unsigned long rate)
320 struct tegra_mc_timing *timing = NULL;
322 for (i = 0; i < mc->num_timings; i++) {
323 if (mc->timings[i].rate == rate) {
324 timing = &mc->timings[i];
330 dev_err(mc->dev, "no memory timing registered for rate %lu\n",
335 for (i = 0; i < mc->soc->num_emem_regs; ++i)
336 mc_writel(mc, timing->emem_data[i], mc->soc->emem_regs[i]);
340 EXPORT_SYMBOL_GPL(tegra_mc_write_emem_configuration);
342 unsigned int tegra_mc_get_emem_device_count(struct tegra_mc *mc)
346 dram_count = mc_readl(mc, MC_EMEM_ADR_CFG);
347 dram_count &= MC_EMEM_ADR_CFG_EMEM_NUMDEV;
352 EXPORT_SYMBOL_GPL(tegra_mc_get_emem_device_count);
354 #if defined(CONFIG_ARCH_TEGRA_3x_SOC) || \
355 defined(CONFIG_ARCH_TEGRA_114_SOC) || \
356 defined(CONFIG_ARCH_TEGRA_124_SOC) || \
357 defined(CONFIG_ARCH_TEGRA_132_SOC) || \
358 defined(CONFIG_ARCH_TEGRA_210_SOC)
359 static int tegra_mc_setup_latency_allowance(struct tegra_mc *mc)
361 unsigned long long tick;
365 /* compute the number of MC clock cycles per tick */
366 tick = (unsigned long long)mc->tick * clk_get_rate(mc->clk);
367 do_div(tick, NSEC_PER_SEC);
369 value = mc_readl(mc, MC_EMEM_ARB_CFG);
370 value &= ~MC_EMEM_ARB_CFG_CYCLES_PER_UPDATE_MASK;
371 value |= MC_EMEM_ARB_CFG_CYCLES_PER_UPDATE(tick);
372 mc_writel(mc, value, MC_EMEM_ARB_CFG);
374 /* write latency allowance defaults */
375 for (i = 0; i < mc->soc->num_clients; i++) {
376 const struct tegra_mc_client *client = &mc->soc->clients[i];
379 value = mc_readl(mc, client->regs.la.reg);
380 value &= ~(client->regs.la.mask << client->regs.la.shift);
381 value |= (client->regs.la.def & client->regs.la.mask) << client->regs.la.shift;
382 mc_writel(mc, value, client->regs.la.reg);
385 /* latch new values */
386 mc_writel(mc, MC_TIMING_UPDATE, MC_TIMING_CONTROL);
391 static int load_one_timing(struct tegra_mc *mc,
392 struct tegra_mc_timing *timing,
393 struct device_node *node)
398 err = of_property_read_u32(node, "clock-frequency", &tmp);
401 "timing %pOFn: failed to read rate\n", node);
406 timing->emem_data = devm_kcalloc(mc->dev, mc->soc->num_emem_regs,
407 sizeof(u32), GFP_KERNEL);
408 if (!timing->emem_data)
411 err = of_property_read_u32_array(node, "nvidia,emem-configuration",
413 mc->soc->num_emem_regs);
416 "timing %pOFn: failed to read EMEM configuration\n",
424 static int load_timings(struct tegra_mc *mc, struct device_node *node)
426 struct device_node *child;
427 struct tegra_mc_timing *timing;
428 int child_count = of_get_child_count(node);
431 mc->timings = devm_kcalloc(mc->dev, child_count, sizeof(*timing),
436 mc->num_timings = child_count;
438 for_each_child_of_node(node, child) {
439 timing = &mc->timings[i++];
441 err = load_one_timing(mc, timing, child);
451 static int tegra_mc_setup_timings(struct tegra_mc *mc)
453 struct device_node *node;
454 u32 ram_code, node_ram_code;
457 ram_code = tegra_read_ram_code();
461 for_each_child_of_node(mc->dev->of_node, node) {
462 err = of_property_read_u32(node, "nvidia,ram-code",
464 if (err || (node_ram_code != ram_code))
467 err = load_timings(mc, node);
474 if (mc->num_timings == 0)
476 "no memory timings for RAM code %u registered\n",
482 int tegra30_mc_probe(struct tegra_mc *mc)
486 mc->clk = devm_clk_get_optional(mc->dev, "mc");
487 if (IS_ERR(mc->clk)) {
488 dev_err(mc->dev, "failed to get MC clock: %ld\n", PTR_ERR(mc->clk));
489 return PTR_ERR(mc->clk);
492 /* ensure that debug features are disabled */
493 mc_writel(mc, 0x00000000, MC_TIMING_CONTROL_DBG);
495 err = tegra_mc_setup_latency_allowance(mc);
497 dev_err(mc->dev, "failed to setup latency allowance: %d\n", err);
501 err = tegra_mc_setup_timings(mc);
503 dev_err(mc->dev, "failed to setup timings: %d\n", err);
510 static irqreturn_t tegra30_mc_handle_irq(int irq, void *data)
512 struct tegra_mc *mc = data;
513 unsigned long status;
516 /* mask all interrupts to avoid flooding */
517 status = mc_readl(mc, MC_INTSTATUS) & mc->soc->intmask;
521 for_each_set_bit(bit, &status, 32) {
522 const char *error = tegra_mc_status_names[bit] ?: "unknown";
523 const char *client = "unknown", *desc;
524 const char *direction, *secure;
525 phys_addr_t addr = 0;
531 value = mc_readl(mc, MC_ERR_STATUS);
533 #ifdef CONFIG_PHYS_ADDR_T_64BIT
534 if (mc->soc->num_address_bits > 32) {
535 addr = ((value >> MC_ERR_STATUS_ADR_HI_SHIFT) &
536 MC_ERR_STATUS_ADR_HI_MASK);
541 if (value & MC_ERR_STATUS_RW)
546 if (value & MC_ERR_STATUS_SECURITY)
551 id = value & mc->soc->client_id_mask;
553 for (i = 0; i < mc->soc->num_clients; i++) {
554 if (mc->soc->clients[i].id == id) {
555 client = mc->soc->clients[i].name;
560 type = (value & MC_ERR_STATUS_TYPE_MASK) >>
561 MC_ERR_STATUS_TYPE_SHIFT;
562 desc = tegra_mc_error_names[type];
564 switch (value & MC_ERR_STATUS_TYPE_MASK) {
565 case MC_ERR_STATUS_TYPE_INVALID_SMMU_PAGE:
569 if (value & MC_ERR_STATUS_READABLE)
574 if (value & MC_ERR_STATUS_WRITABLE)
579 if (value & MC_ERR_STATUS_NONSECURE)
593 value = mc_readl(mc, MC_ERR_ADR);
596 dev_err_ratelimited(mc->dev, "%s: %s%s @%pa: %s (%s%s)\n",
597 client, secure, direction, &addr, error,
601 /* clear interrupts */
602 mc_writel(mc, status, MC_INTSTATUS);
607 const struct tegra_mc_ops tegra30_mc_ops = {
608 .probe = tegra30_mc_probe,
609 .handle_irq = tegra30_mc_handle_irq,
613 const char *const tegra_mc_status_names[32] = {
614 [ 1] = "External interrupt",
615 [ 6] = "EMEM address decode error",
616 [ 7] = "GART page fault",
617 [ 8] = "Security violation",
618 [ 9] = "EMEM arbitration error",
620 [11] = "Invalid APB ASID update",
621 [12] = "VPR violation",
622 [13] = "Secure carveout violation",
623 [16] = "MTS carveout violation",
626 const char *const tegra_mc_error_names[8] = {
627 [2] = "EMEM decode error",
628 [3] = "TrustZone violation",
629 [4] = "Carveout violation",
630 [6] = "SMMU translation error",
634 * Memory Controller (MC) has few Memory Clients that are issuing memory
635 * bandwidth allocation requests to the MC interconnect provider. The MC
636 * provider aggregates the requests and then sends the aggregated request
637 * up to the External Memory Controller (EMC) interconnect provider which
638 * re-configures hardware interface to External Memory (EMEM) in accordance
639 * to the required bandwidth. Each MC interconnect node represents an
640 * individual Memory Client.
642 * Memory interconnect topology:
648 * | | +-----+ +------+
649 * ... | MC +--->+ EMC +--->+ EMEM |
650 * | | +-----+ +------+
656 static int tegra_mc_interconnect_setup(struct tegra_mc *mc)
658 struct icc_node *node;
662 /* older device-trees don't have interconnect properties */
663 if (!device_property_present(mc->dev, "#interconnect-cells") ||
667 mc->provider.dev = mc->dev;
668 mc->provider.data = &mc->provider;
669 mc->provider.set = mc->soc->icc_ops->set;
670 mc->provider.aggregate = mc->soc->icc_ops->aggregate;
671 mc->provider.xlate_extended = mc->soc->icc_ops->xlate_extended;
673 err = icc_provider_add(&mc->provider);
677 /* create Memory Controller node */
678 node = icc_node_create(TEGRA_ICC_MC);
684 node->name = "Memory Controller";
685 icc_node_add(node, &mc->provider);
687 /* link Memory Controller to External Memory Controller */
688 err = icc_link_create(node, TEGRA_ICC_EMC);
692 for (i = 0; i < mc->soc->num_clients; i++) {
693 /* create MC client node */
694 node = icc_node_create(mc->soc->clients[i].id);
700 node->name = mc->soc->clients[i].name;
701 icc_node_add(node, &mc->provider);
703 /* link Memory Client to Memory Controller */
704 err = icc_link_create(node, TEGRA_ICC_MC);
710 * MC driver is registered too early, so early that generic driver
711 * syncing doesn't work for the MC. But it doesn't really matter
712 * since syncing works for the EMC drivers, hence we can sync the
713 * MC driver by ourselves and then EMC will complete syncing of
714 * the whole ICC state.
716 icc_sync_state(mc->dev);
721 icc_nodes_remove(&mc->provider);
723 icc_provider_del(&mc->provider);
728 static int tegra_mc_probe(struct platform_device *pdev)
730 struct resource *res;
735 mc = devm_kzalloc(&pdev->dev, sizeof(*mc), GFP_KERNEL);
739 platform_set_drvdata(pdev, mc);
740 spin_lock_init(&mc->lock);
741 mc->soc = of_device_get_match_data(&pdev->dev);
742 mc->dev = &pdev->dev;
744 mask = DMA_BIT_MASK(mc->soc->num_address_bits);
746 err = dma_coerce_mask_and_coherent(&pdev->dev, mask);
748 dev_err(&pdev->dev, "failed to set DMA mask: %d\n", err);
752 /* length of MC tick in nanoseconds */
755 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
756 mc->regs = devm_ioremap_resource(&pdev->dev, res);
757 if (IS_ERR(mc->regs))
758 return PTR_ERR(mc->regs);
760 mc->debugfs.root = debugfs_create_dir("mc", NULL);
762 if (mc->soc->ops && mc->soc->ops->probe) {
763 err = mc->soc->ops->probe(mc);
768 if (mc->soc->ops && mc->soc->ops->handle_irq) {
769 mc->irq = platform_get_irq(pdev, 0);
773 WARN(!mc->soc->client_id_mask, "missing client ID mask for this SoC\n");
775 mc_writel(mc, mc->soc->intmask, MC_INTMASK);
777 err = devm_request_irq(&pdev->dev, mc->irq, mc->soc->ops->handle_irq, 0,
778 dev_name(&pdev->dev), mc);
780 dev_err(&pdev->dev, "failed to request IRQ#%u: %d\n", mc->irq,
786 if (mc->soc->reset_ops) {
787 err = tegra_mc_reset_setup(mc);
789 dev_err(&pdev->dev, "failed to register reset controller: %d\n", err);
792 err = tegra_mc_interconnect_setup(mc);
794 dev_err(&pdev->dev, "failed to initialize interconnect: %d\n",
797 if (IS_ENABLED(CONFIG_TEGRA_IOMMU_SMMU) && mc->soc->smmu) {
798 mc->smmu = tegra_smmu_probe(&pdev->dev, mc->soc->smmu, mc);
799 if (IS_ERR(mc->smmu)) {
800 dev_err(&pdev->dev, "failed to probe SMMU: %ld\n",
806 if (IS_ENABLED(CONFIG_TEGRA_IOMMU_GART) && !mc->soc->smmu) {
807 mc->gart = tegra_gart_probe(&pdev->dev, mc);
808 if (IS_ERR(mc->gart)) {
809 dev_err(&pdev->dev, "failed to probe GART: %ld\n",
818 static int __maybe_unused tegra_mc_suspend(struct device *dev)
820 struct tegra_mc *mc = dev_get_drvdata(dev);
822 if (mc->soc->ops && mc->soc->ops->suspend)
823 return mc->soc->ops->suspend(mc);
828 static int __maybe_unused tegra_mc_resume(struct device *dev)
830 struct tegra_mc *mc = dev_get_drvdata(dev);
832 if (mc->soc->ops && mc->soc->ops->resume)
833 return mc->soc->ops->resume(mc);
838 static const struct dev_pm_ops tegra_mc_pm_ops = {
839 SET_SYSTEM_SLEEP_PM_OPS(tegra_mc_suspend, tegra_mc_resume)
842 static struct platform_driver tegra_mc_driver = {
845 .of_match_table = tegra_mc_of_match,
846 .pm = &tegra_mc_pm_ops,
847 .suppress_bind_attrs = true,
849 .prevent_deferred_probe = true,
850 .probe = tegra_mc_probe,
853 static int tegra_mc_init(void)
855 return platform_driver_register(&tegra_mc_driver);
857 arch_initcall(tegra_mc_init);
859 MODULE_AUTHOR("Thierry Reding <treding@nvidia.com>");
860 MODULE_DESCRIPTION("NVIDIA Tegra Memory Controller driver");
861 MODULE_LICENSE("GPL v2");