1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (c) 2010-2013, NVIDIA Corporation.
9 #include <linux/delay.h>
10 #include <linux/dma-mapping.h>
12 #include <linux/list.h>
13 #include <linux/module.h>
14 #include <linux/of_device.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/slab.h>
19 #include <soc/tegra/common.h>
21 #define CREATE_TRACE_POINTS
22 #include <trace/events/host1x.h>
23 #undef CREATE_TRACE_POINTS
25 #if IS_ENABLED(CONFIG_ARM_DMA_USE_IOMMU)
26 #include <asm/dma-iommu.h>
36 #include "hw/host1x01.h"
37 #include "hw/host1x02.h"
38 #include "hw/host1x04.h"
39 #include "hw/host1x05.h"
40 #include "hw/host1x06.h"
41 #include "hw/host1x07.h"
42 #include "hw/host1x08.h"
44 void host1x_common_writel(struct host1x *host1x, u32 v, u32 r)
46 writel(v, host1x->common_regs + r);
49 void host1x_hypervisor_writel(struct host1x *host1x, u32 v, u32 r)
51 writel(v, host1x->hv_regs + r);
54 u32 host1x_hypervisor_readl(struct host1x *host1x, u32 r)
56 return readl(host1x->hv_regs + r);
59 void host1x_sync_writel(struct host1x *host1x, u32 v, u32 r)
61 void __iomem *sync_regs = host1x->regs + host1x->info->sync_offset;
63 writel(v, sync_regs + r);
66 u32 host1x_sync_readl(struct host1x *host1x, u32 r)
68 void __iomem *sync_regs = host1x->regs + host1x->info->sync_offset;
70 return readl(sync_regs + r);
73 void host1x_ch_writel(struct host1x_channel *ch, u32 v, u32 r)
75 writel(v, ch->regs + r);
78 u32 host1x_ch_readl(struct host1x_channel *ch, u32 r)
80 return readl(ch->regs + r);
83 static const struct host1x_info host1x01_info = {
88 .init = host1x01_init,
89 .sync_offset = 0x3000,
90 .dma_mask = DMA_BIT_MASK(32),
91 .has_wide_gather = false,
92 .has_hypervisor = false,
95 .reserve_vblank_syncpts = true,
98 static const struct host1x_info host1x02_info = {
103 .init = host1x02_init,
104 .sync_offset = 0x3000,
105 .dma_mask = DMA_BIT_MASK(32),
106 .has_wide_gather = false,
107 .has_hypervisor = false,
108 .num_sid_entries = 0,
110 .reserve_vblank_syncpts = true,
113 static const struct host1x_info host1x04_info = {
118 .init = host1x04_init,
119 .sync_offset = 0x2100,
120 .dma_mask = DMA_BIT_MASK(34),
121 .has_wide_gather = false,
122 .has_hypervisor = false,
123 .num_sid_entries = 0,
125 .reserve_vblank_syncpts = false,
128 static const struct host1x_info host1x05_info = {
133 .init = host1x05_init,
134 .sync_offset = 0x2100,
135 .dma_mask = DMA_BIT_MASK(34),
136 .has_wide_gather = false,
137 .has_hypervisor = false,
138 .num_sid_entries = 0,
140 .reserve_vblank_syncpts = false,
143 static const struct host1x_sid_entry tegra186_sid_table[] = {
158 static const struct host1x_info host1x06_info = {
163 .init = host1x06_init,
165 .dma_mask = DMA_BIT_MASK(40),
166 .has_wide_gather = true,
167 .has_hypervisor = true,
168 .num_sid_entries = ARRAY_SIZE(tegra186_sid_table),
169 .sid_table = tegra186_sid_table,
170 .reserve_vblank_syncpts = false,
173 static const struct host1x_sid_entry tegra194_sid_table[] = {
194 static const struct host1x_info host1x07_info = {
199 .init = host1x07_init,
201 .dma_mask = DMA_BIT_MASK(40),
202 .has_wide_gather = true,
203 .has_hypervisor = true,
204 .num_sid_entries = ARRAY_SIZE(tegra194_sid_table),
205 .sid_table = tegra194_sid_table,
206 .reserve_vblank_syncpts = false,
210 * Tegra234 has two stream ID protection tables, one for setting stream IDs
211 * through the channel path via SETSTREAMID, and one for setting them via
212 * MMIO. We program each engine's data stream ID in the channel path table
213 * and firmware stream ID in the MMIO path table.
215 static const struct host1x_sid_entry tegra234_sid_table[] = {
242 static const struct host1x_info host1x08_info = {
247 .init = host1x08_init,
249 .dma_mask = DMA_BIT_MASK(40),
250 .has_wide_gather = true,
251 .has_hypervisor = true,
253 .num_sid_entries = ARRAY_SIZE(tegra234_sid_table),
254 .sid_table = tegra234_sid_table,
255 .streamid_vm_table = { 0x1004, 128 },
256 .classid_vm_table = { 0x1404, 25 },
257 .mmio_vm_table = { 0x1504, 25 },
258 .reserve_vblank_syncpts = false,
261 static const struct of_device_id host1x_of_match[] = {
262 { .compatible = "nvidia,tegra234-host1x", .data = &host1x08_info, },
263 { .compatible = "nvidia,tegra194-host1x", .data = &host1x07_info, },
264 { .compatible = "nvidia,tegra186-host1x", .data = &host1x06_info, },
265 { .compatible = "nvidia,tegra210-host1x", .data = &host1x05_info, },
266 { .compatible = "nvidia,tegra124-host1x", .data = &host1x04_info, },
267 { .compatible = "nvidia,tegra114-host1x", .data = &host1x02_info, },
268 { .compatible = "nvidia,tegra30-host1x", .data = &host1x01_info, },
269 { .compatible = "nvidia,tegra20-host1x", .data = &host1x01_info, },
272 MODULE_DEVICE_TABLE(of, host1x_of_match);
274 static void host1x_setup_virtualization_tables(struct host1x *host)
276 const struct host1x_info *info = host->info;
279 if (!info->has_hypervisor)
282 for (i = 0; i < info->num_sid_entries; i++) {
283 const struct host1x_sid_entry *entry = &info->sid_table[i];
285 host1x_hypervisor_writel(host, entry->offset, entry->base);
286 host1x_hypervisor_writel(host, entry->limit, entry->base + 4);
289 for (i = 0; i < info->streamid_vm_table.count; i++) {
290 /* Allow access to all stream IDs to all VMs. */
291 host1x_hypervisor_writel(host, 0xff, info->streamid_vm_table.base + 4 * i);
294 for (i = 0; i < info->classid_vm_table.count; i++) {
295 /* Allow access to all classes to all VMs. */
296 host1x_hypervisor_writel(host, 0xff, info->classid_vm_table.base + 4 * i);
299 for (i = 0; i < info->mmio_vm_table.count; i++) {
300 /* Use VM1 (that's us) as originator VMID for engine MMIO accesses. */
301 host1x_hypervisor_writel(host, 0x1, info->mmio_vm_table.base + 4 * i);
305 static bool host1x_wants_iommu(struct host1x *host1x)
307 /* Our IOMMU usage policy doesn't currently play well with GART */
308 if (of_machine_is_compatible("nvidia,tegra20"))
312 * If we support addressing a maximum of 32 bits of physical memory
313 * and if the host1x firewall is enabled, there's no need to enable
314 * IOMMU support. This can happen for example on Tegra20, Tegra30
317 * Tegra124 and later can address up to 34 bits of physical memory and
318 * many platforms come equipped with more than 2 GiB of system memory,
319 * which requires crossing the 4 GiB boundary. But there's a catch: on
320 * SoCs before Tegra186 (i.e. Tegra124 and Tegra210), the host1x can
321 * only address up to 32 bits of memory in GATHER opcodes, which means
322 * that command buffers need to either be in the first 2 GiB of system
323 * memory (which could quickly lead to memory exhaustion), or command
324 * buffers need to be treated differently from other buffers (which is
325 * not possible with the current ABI).
327 * A third option is to use the IOMMU in these cases to make sure all
328 * buffers will be mapped into a 32-bit IOVA space that host1x can
329 * address. This allows all of the system memory to be used and works
330 * within the limitations of the host1x on these SoCs.
332 * In summary, default to enable IOMMU on Tegra124 and later. For any
333 * of the earlier SoCs, only use the IOMMU for additional safety when
334 * the host1x firewall is disabled.
336 if (host1x->info->dma_mask <= DMA_BIT_MASK(32)) {
337 if (IS_ENABLED(CONFIG_TEGRA_HOST1X_FIREWALL))
344 static struct iommu_domain *host1x_iommu_attach(struct host1x *host)
346 struct iommu_domain *domain = iommu_get_domain_for_dev(host->dev);
349 #if IS_ENABLED(CONFIG_ARM_DMA_USE_IOMMU)
350 if (host->dev->archdata.mapping) {
351 struct dma_iommu_mapping *mapping =
352 to_dma_iommu_mapping(host->dev);
353 arm_iommu_detach_device(host->dev);
354 arm_iommu_release_mapping(mapping);
356 domain = iommu_get_domain_for_dev(host->dev);
361 * We may not always want to enable IOMMU support (for example if the
362 * host1x firewall is already enabled and we don't support addressing
363 * more than 32 bits of physical memory), so check for that first.
365 * Similarly, if host1x is already attached to an IOMMU (via the DMA
366 * API), don't try to attach again.
368 if (!host1x_wants_iommu(host) || domain)
371 host->group = iommu_group_get(host->dev);
373 struct iommu_domain_geometry *geometry;
374 dma_addr_t start, end;
377 err = iova_cache_get();
381 host->domain = iommu_domain_alloc(&platform_bus_type);
387 err = iommu_attach_group(host->domain, host->group);
395 geometry = &host->domain->geometry;
396 start = geometry->aperture_start & host->info->dma_mask;
397 end = geometry->aperture_end & host->info->dma_mask;
399 order = __ffs(host->domain->pgsize_bitmap);
400 init_iova_domain(&host->iova, 1UL << order, start >> order);
401 host->iova_end = end;
403 domain = host->domain;
409 iommu_domain_free(host->domain);
414 iommu_group_put(host->group);
420 static int host1x_iommu_init(struct host1x *host)
422 u64 mask = host->info->dma_mask;
423 struct iommu_domain *domain;
426 domain = host1x_iommu_attach(host);
427 if (IS_ERR(domain)) {
428 err = PTR_ERR(domain);
429 dev_err(host->dev, "failed to attach to IOMMU: %d\n", err);
434 * If we're not behind an IOMMU make sure we don't get push buffers
435 * that are allocated outside of the range addressable by the GATHER
438 * Newer generations of Tegra (Tegra186 and later) support a wide
439 * variant of the GATHER opcode that allows addressing more bits.
441 if (!domain && !host->info->has_wide_gather)
442 mask = DMA_BIT_MASK(32);
444 err = dma_coerce_mask_and_coherent(host->dev, mask);
446 dev_err(host->dev, "failed to set DMA mask: %d\n", err);
453 static void host1x_iommu_exit(struct host1x *host)
456 put_iova_domain(&host->iova);
457 iommu_detach_group(host->domain, host->group);
459 iommu_domain_free(host->domain);
464 iommu_group_put(host->group);
469 static int host1x_get_resets(struct host1x *host)
473 host->resets[0].id = "mc";
474 host->resets[1].id = "host1x";
475 host->nresets = ARRAY_SIZE(host->resets);
477 err = devm_reset_control_bulk_get_optional_exclusive_released(
478 host->dev, host->nresets, host->resets);
480 dev_err(host->dev, "failed to get reset: %d\n", err);
487 static int host1x_probe(struct platform_device *pdev)
492 host = devm_kzalloc(&pdev->dev, sizeof(*host), GFP_KERNEL);
496 host->info = of_device_get_match_data(&pdev->dev);
498 if (host->info->has_hypervisor) {
499 host->regs = devm_platform_ioremap_resource_byname(pdev, "vm");
500 if (IS_ERR(host->regs))
501 return PTR_ERR(host->regs);
503 host->hv_regs = devm_platform_ioremap_resource_byname(pdev, "hypervisor");
504 if (IS_ERR(host->hv_regs))
505 return PTR_ERR(host->hv_regs);
507 if (host->info->has_common) {
508 host->common_regs = devm_platform_ioremap_resource_byname(pdev, "common");
509 if (IS_ERR(host->common_regs))
510 return PTR_ERR(host->common_regs);
513 host->regs = devm_platform_ioremap_resource(pdev, 0);
514 if (IS_ERR(host->regs))
515 return PTR_ERR(host->regs);
518 host->syncpt_irq = platform_get_irq(pdev, 0);
519 if (host->syncpt_irq < 0)
520 return host->syncpt_irq;
522 mutex_init(&host->devices_lock);
523 INIT_LIST_HEAD(&host->devices);
524 INIT_LIST_HEAD(&host->list);
525 host->dev = &pdev->dev;
527 /* set common host1x device data */
528 platform_set_drvdata(pdev, host);
530 host->dev->dma_parms = &host->dma_parms;
531 dma_set_max_seg_size(host->dev, UINT_MAX);
533 if (host->info->init) {
534 err = host->info->init(host);
539 host->clk = devm_clk_get(&pdev->dev, NULL);
540 if (IS_ERR(host->clk)) {
541 err = PTR_ERR(host->clk);
543 if (err != -EPROBE_DEFER)
544 dev_err(&pdev->dev, "failed to get clock: %d\n", err);
549 err = host1x_get_resets(host);
553 host1x_bo_cache_init(&host->cache);
555 err = host1x_iommu_init(host);
557 dev_err(&pdev->dev, "failed to setup IOMMU: %d\n", err);
561 err = host1x_channel_list_init(&host->channel_list,
562 host->info->nb_channels);
564 dev_err(&pdev->dev, "failed to initialize channel list\n");
568 err = host1x_memory_context_list_init(host);
570 dev_err(&pdev->dev, "failed to initialize context list\n");
574 err = host1x_syncpt_init(host);
576 dev_err(&pdev->dev, "failed to initialize syncpts\n");
580 err = host1x_intr_init(host);
582 dev_err(&pdev->dev, "failed to initialize interrupts\n");
586 pm_runtime_enable(&pdev->dev);
588 err = devm_tegra_core_dev_init_opp_table_common(&pdev->dev);
592 /* the driver's code isn't ready yet for the dynamic RPM */
593 err = pm_runtime_resume_and_get(&pdev->dev);
597 host1x_debug_init(host);
599 err = host1x_register(host);
603 err = devm_of_platform_populate(&pdev->dev);
610 host1x_unregister(host);
612 host1x_debug_deinit(host);
614 pm_runtime_put_sync_suspend(&pdev->dev);
616 pm_runtime_disable(&pdev->dev);
618 host1x_intr_deinit(host);
620 host1x_syncpt_deinit(host);
622 host1x_memory_context_list_free(&host->context_list);
624 host1x_channel_list_free(&host->channel_list);
626 host1x_iommu_exit(host);
628 host1x_bo_cache_destroy(&host->cache);
633 static int host1x_remove(struct platform_device *pdev)
635 struct host1x *host = platform_get_drvdata(pdev);
637 host1x_unregister(host);
638 host1x_debug_deinit(host);
640 pm_runtime_force_suspend(&pdev->dev);
642 host1x_intr_deinit(host);
643 host1x_syncpt_deinit(host);
644 host1x_memory_context_list_free(&host->context_list);
645 host1x_channel_list_free(&host->channel_list);
646 host1x_iommu_exit(host);
647 host1x_bo_cache_destroy(&host->cache);
652 static int __maybe_unused host1x_runtime_suspend(struct device *dev)
654 struct host1x *host = dev_get_drvdata(dev);
657 host1x_intr_stop(host);
658 host1x_syncpt_save(host);
660 err = reset_control_bulk_assert(host->nresets, host->resets);
662 dev_err(dev, "failed to assert reset: %d\n", err);
666 usleep_range(1000, 2000);
668 clk_disable_unprepare(host->clk);
669 reset_control_bulk_release(host->nresets, host->resets);
674 host1x_setup_virtualization_tables(host);
675 host1x_syncpt_restore(host);
676 host1x_intr_start(host);
681 static int __maybe_unused host1x_runtime_resume(struct device *dev)
683 struct host1x *host = dev_get_drvdata(dev);
686 err = reset_control_bulk_acquire(host->nresets, host->resets);
688 dev_err(dev, "failed to acquire reset: %d\n", err);
692 err = clk_prepare_enable(host->clk);
694 dev_err(dev, "failed to enable clock: %d\n", err);
698 err = reset_control_bulk_deassert(host->nresets, host->resets);
700 dev_err(dev, "failed to deassert reset: %d\n", err);
704 host1x_setup_virtualization_tables(host);
705 host1x_syncpt_restore(host);
706 host1x_intr_start(host);
711 clk_disable_unprepare(host->clk);
713 reset_control_bulk_release(host->nresets, host->resets);
718 static const struct dev_pm_ops host1x_pm_ops = {
719 SET_RUNTIME_PM_OPS(host1x_runtime_suspend, host1x_runtime_resume,
721 /* TODO: add system suspend-resume once driver will be ready for that */
724 static struct platform_driver tegra_host1x_driver = {
726 .name = "tegra-host1x",
727 .of_match_table = host1x_of_match,
728 .pm = &host1x_pm_ops,
730 .probe = host1x_probe,
731 .remove = host1x_remove,
734 static struct platform_driver * const drivers[] = {
735 &tegra_host1x_driver,
739 static int __init tegra_host1x_init(void)
743 err = bus_register(&host1x_bus_type);
747 err = platform_register_drivers(drivers, ARRAY_SIZE(drivers));
749 bus_unregister(&host1x_bus_type);
753 module_init(tegra_host1x_init);
755 static void __exit tegra_host1x_exit(void)
757 platform_unregister_drivers(drivers, ARRAY_SIZE(drivers));
758 bus_unregister(&host1x_bus_type);
760 module_exit(tegra_host1x_exit);
763 * host1x_get_dma_mask() - query the supported DMA mask for host1x
764 * @host1x: host1x instance
766 * Note that this returns the supported DMA mask for host1x, which can be
767 * different from the applicable DMA mask under certain circumstances.
769 u64 host1x_get_dma_mask(struct host1x *host1x)
771 return host1x->info->dma_mask;
773 EXPORT_SYMBOL(host1x_get_dma_mask);
777 MODULE_DESCRIPTION("Host1x driver for Tegra products");
778 MODULE_LICENSE("GPL");