2 * Copyright (C) 2016, Semihalf
3 * Author: Tomasz Nowicki <tn@semihalf.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * This file implements early detection/parsing of I/O mapping
15 * reported to OS through firmware via I/O Remapping Table (IORT)
16 * IORT document number: ARM DEN 0049A
19 #define pr_fmt(fmt) "ACPI: IORT: " fmt
21 #include <linux/acpi_iort.h>
22 #include <linux/iommu.h>
23 #include <linux/kernel.h>
24 #include <linux/list.h>
25 #include <linux/pci.h>
26 #include <linux/platform_device.h>
27 #include <linux/slab.h>
29 #define IORT_TYPE_MASK(type) (1 << (type))
30 #define IORT_MSI_TYPE (1 << ACPI_IORT_NODE_ITS_GROUP)
31 #define IORT_IOMMU_TYPE ((1 << ACPI_IORT_NODE_SMMU) | \
32 (1 << ACPI_IORT_NODE_SMMU_V3))
34 struct iort_its_msi_chip {
35 struct list_head list;
36 struct fwnode_handle *fw_node;
41 struct list_head list;
42 struct acpi_iort_node *iort_node;
43 struct fwnode_handle *fwnode;
45 static LIST_HEAD(iort_fwnode_list);
46 static DEFINE_SPINLOCK(iort_fwnode_lock);
49 * iort_set_fwnode() - Create iort_fwnode and use it to register
50 * iommu data in the iort_fwnode_list
52 * @node: IORT table node associated with the IOMMU
53 * @fwnode: fwnode associated with the IORT node
55 * Returns: 0 on success
58 static inline int iort_set_fwnode(struct acpi_iort_node *iort_node,
59 struct fwnode_handle *fwnode)
61 struct iort_fwnode *np;
63 np = kzalloc(sizeof(struct iort_fwnode), GFP_ATOMIC);
68 INIT_LIST_HEAD(&np->list);
69 np->iort_node = iort_node;
72 spin_lock(&iort_fwnode_lock);
73 list_add_tail(&np->list, &iort_fwnode_list);
74 spin_unlock(&iort_fwnode_lock);
80 * iort_get_fwnode() - Retrieve fwnode associated with an IORT node
82 * @node: IORT table node to be looked-up
84 * Returns: fwnode_handle pointer on success, NULL on failure
87 struct fwnode_handle *iort_get_fwnode(struct acpi_iort_node *node)
89 struct iort_fwnode *curr;
90 struct fwnode_handle *fwnode = NULL;
92 spin_lock(&iort_fwnode_lock);
93 list_for_each_entry(curr, &iort_fwnode_list, list) {
94 if (curr->iort_node == node) {
95 fwnode = curr->fwnode;
99 spin_unlock(&iort_fwnode_lock);
105 * iort_delete_fwnode() - Delete fwnode associated with an IORT node
107 * @node: IORT table node associated with fwnode to delete
109 static inline void iort_delete_fwnode(struct acpi_iort_node *node)
111 struct iort_fwnode *curr, *tmp;
113 spin_lock(&iort_fwnode_lock);
114 list_for_each_entry_safe(curr, tmp, &iort_fwnode_list, list) {
115 if (curr->iort_node == node) {
116 list_del(&curr->list);
121 spin_unlock(&iort_fwnode_lock);
124 typedef acpi_status (*iort_find_node_callback)
125 (struct acpi_iort_node *node, void *context);
127 /* Root pointer to the mapped IORT table */
128 static struct acpi_table_header *iort_table;
130 static LIST_HEAD(iort_msi_chip_list);
131 static DEFINE_SPINLOCK(iort_msi_chip_lock);
134 * iort_register_domain_token() - register domain token and related ITS ID
135 * to the list from where we can get it back later on.
137 * @fw_node: Domain token.
139 * Returns: 0 on success, -ENOMEM if no memory when allocating list element
141 int iort_register_domain_token(int trans_id, struct fwnode_handle *fw_node)
143 struct iort_its_msi_chip *its_msi_chip;
145 its_msi_chip = kzalloc(sizeof(*its_msi_chip), GFP_KERNEL);
149 its_msi_chip->fw_node = fw_node;
150 its_msi_chip->translation_id = trans_id;
152 spin_lock(&iort_msi_chip_lock);
153 list_add(&its_msi_chip->list, &iort_msi_chip_list);
154 spin_unlock(&iort_msi_chip_lock);
160 * iort_deregister_domain_token() - Deregister domain token based on ITS ID
165 void iort_deregister_domain_token(int trans_id)
167 struct iort_its_msi_chip *its_msi_chip, *t;
169 spin_lock(&iort_msi_chip_lock);
170 list_for_each_entry_safe(its_msi_chip, t, &iort_msi_chip_list, list) {
171 if (its_msi_chip->translation_id == trans_id) {
172 list_del(&its_msi_chip->list);
177 spin_unlock(&iort_msi_chip_lock);
181 * iort_find_domain_token() - Find domain token based on given ITS ID
184 * Returns: domain token when find on the list, NULL otherwise
186 struct fwnode_handle *iort_find_domain_token(int trans_id)
188 struct fwnode_handle *fw_node = NULL;
189 struct iort_its_msi_chip *its_msi_chip;
191 spin_lock(&iort_msi_chip_lock);
192 list_for_each_entry(its_msi_chip, &iort_msi_chip_list, list) {
193 if (its_msi_chip->translation_id == trans_id) {
194 fw_node = its_msi_chip->fw_node;
198 spin_unlock(&iort_msi_chip_lock);
203 static struct acpi_iort_node *iort_scan_node(enum acpi_iort_node_type type,
204 iort_find_node_callback callback,
207 struct acpi_iort_node *iort_node, *iort_end;
208 struct acpi_table_iort *iort;
214 /* Get the first IORT node */
215 iort = (struct acpi_table_iort *)iort_table;
216 iort_node = ACPI_ADD_PTR(struct acpi_iort_node, iort,
218 iort_end = ACPI_ADD_PTR(struct acpi_iort_node, iort_table,
221 for (i = 0; i < iort->node_count; i++) {
222 if (WARN_TAINT(iort_node >= iort_end, TAINT_FIRMWARE_WORKAROUND,
223 "IORT node pointer overflows, bad table!\n"))
226 if (iort_node->type == type &&
227 ACPI_SUCCESS(callback(iort_node, context)))
230 iort_node = ACPI_ADD_PTR(struct acpi_iort_node, iort_node,
238 iort_match_type_callback(struct acpi_iort_node *node, void *context)
243 bool iort_node_match(u8 type)
245 struct acpi_iort_node *node;
247 node = iort_scan_node(type, iort_match_type_callback, NULL);
252 static acpi_status iort_match_node_callback(struct acpi_iort_node *node,
255 struct device *dev = context;
258 if (node->type == ACPI_IORT_NODE_NAMED_COMPONENT) {
259 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
260 struct acpi_device *adev = to_acpi_device_node(dev->fwnode);
261 struct acpi_iort_named_component *ncomp;
264 status = AE_NOT_FOUND;
268 status = acpi_get_name(adev->handle, ACPI_FULL_PATHNAME, &buf);
269 if (ACPI_FAILURE(status)) {
270 dev_warn(dev, "Can't get device full path name\n");
274 ncomp = (struct acpi_iort_named_component *)node->node_data;
275 status = !strcmp(ncomp->device_name, buf.pointer) ?
276 AE_OK : AE_NOT_FOUND;
277 acpi_os_free(buf.pointer);
278 } else if (node->type == ACPI_IORT_NODE_PCI_ROOT_COMPLEX) {
279 struct acpi_iort_root_complex *pci_rc;
282 bus = to_pci_bus(dev);
283 pci_rc = (struct acpi_iort_root_complex *)node->node_data;
286 * It is assumed that PCI segment numbers maps one-to-one
287 * with root complexes. Each segment number can represent only
290 status = pci_rc->pci_segment_number == pci_domain_nr(bus) ?
291 AE_OK : AE_NOT_FOUND;
293 status = AE_NOT_FOUND;
299 static int iort_id_map(struct acpi_iort_id_mapping *map, u8 type, u32 rid_in,
302 /* Single mapping does not care for input id */
303 if (map->flags & ACPI_IORT_ID_SINGLE_MAPPING) {
304 if (type == ACPI_IORT_NODE_NAMED_COMPONENT ||
305 type == ACPI_IORT_NODE_PCI_ROOT_COMPLEX) {
306 *rid_out = map->output_base;
310 pr_warn(FW_BUG "[map %p] SINGLE MAPPING flag not allowed for node type %d, skipping ID map\n",
315 if (rid_in < map->input_base ||
316 (rid_in >= map->input_base + map->id_count))
319 *rid_out = map->output_base + (rid_in - map->input_base);
324 struct acpi_iort_node *iort_node_get_id(struct acpi_iort_node *node,
325 u32 *id_out, u8 type_mask,
328 struct acpi_iort_node *parent;
329 struct acpi_iort_id_mapping *map;
331 if (!node->mapping_offset || !node->mapping_count ||
332 index >= node->mapping_count)
335 map = ACPI_ADD_PTR(struct acpi_iort_id_mapping, node,
336 node->mapping_offset);
339 if (!map->output_reference) {
340 pr_err(FW_BUG "[node %p type %d] ID map has NULL parent reference\n",
345 parent = ACPI_ADD_PTR(struct acpi_iort_node, iort_table,
346 map->output_reference);
348 if (!(IORT_TYPE_MASK(parent->type) & type_mask))
351 if (map[index].flags & ACPI_IORT_ID_SINGLE_MAPPING) {
352 if (node->type == ACPI_IORT_NODE_NAMED_COMPONENT ||
353 node->type == ACPI_IORT_NODE_PCI_ROOT_COMPLEX) {
354 *id_out = map[index].output_base;
362 static struct acpi_iort_node *iort_node_map_rid(struct acpi_iort_node *node,
363 u32 rid_in, u32 *rid_out,
368 /* Parse the ID mapping tree to find specified node type */
370 struct acpi_iort_id_mapping *map;
373 if (IORT_TYPE_MASK(node->type) & type_mask) {
379 if (!node->mapping_offset || !node->mapping_count)
382 map = ACPI_ADD_PTR(struct acpi_iort_id_mapping, node,
383 node->mapping_offset);
386 if (!map->output_reference) {
387 pr_err(FW_BUG "[node %p type %d] ID map has NULL parent reference\n",
392 /* Do the RID translation */
393 for (i = 0; i < node->mapping_count; i++, map++) {
394 if (!iort_id_map(map, node->type, rid, &rid))
398 if (i == node->mapping_count)
401 node = ACPI_ADD_PTR(struct acpi_iort_node, iort_table,
402 map->output_reference);
406 /* Map input RID to output RID unchanged on mapping failure*/
413 static struct acpi_iort_node *iort_find_dev_node(struct device *dev)
415 struct pci_bus *pbus;
417 if (!dev_is_pci(dev))
418 return iort_scan_node(ACPI_IORT_NODE_NAMED_COMPONENT,
419 iort_match_node_callback, dev);
421 /* Find a PCI root bus */
422 pbus = to_pci_dev(dev)->bus;
423 while (!pci_is_root_bus(pbus))
426 return iort_scan_node(ACPI_IORT_NODE_PCI_ROOT_COMPLEX,
427 iort_match_node_callback, &pbus->dev);
431 * iort_msi_map_rid() - Map a MSI requester ID for a device
432 * @dev: The device for which the mapping is to be done.
433 * @req_id: The device requester ID.
435 * Returns: mapped MSI RID on success, input requester ID otherwise
437 u32 iort_msi_map_rid(struct device *dev, u32 req_id)
439 struct acpi_iort_node *node;
442 node = iort_find_dev_node(dev);
446 iort_node_map_rid(node, req_id, &dev_id, IORT_MSI_TYPE);
451 * iort_dev_find_its_id() - Find the ITS identifier for a device
453 * @idx: Index of the ITS identifier list.
454 * @its_id: ITS identifier.
456 * Returns: 0 on success, appropriate error value otherwise
458 static int iort_dev_find_its_id(struct device *dev, u32 req_id,
459 unsigned int idx, int *its_id)
461 struct acpi_iort_its_group *its;
462 struct acpi_iort_node *node;
464 node = iort_find_dev_node(dev);
468 node = iort_node_map_rid(node, req_id, NULL, IORT_MSI_TYPE);
472 /* Move to ITS specific data */
473 its = (struct acpi_iort_its_group *)node->node_data;
474 if (idx > its->its_count) {
475 dev_err(dev, "requested ITS ID index [%d] is greater than available [%d]\n",
476 idx, its->its_count);
480 *its_id = its->identifiers[idx];
485 * iort_get_device_domain() - Find MSI domain related to a device
487 * @req_id: Requester ID for the device.
489 * Returns: the MSI domain for this device, NULL otherwise
491 struct irq_domain *iort_get_device_domain(struct device *dev, u32 req_id)
493 struct fwnode_handle *handle;
496 if (iort_dev_find_its_id(dev, req_id, 0, &its_id))
499 handle = iort_find_domain_token(its_id);
503 return irq_find_matching_fwnode(handle, DOMAIN_BUS_PCI_MSI);
506 static int __get_pci_rid(struct pci_dev *pdev, u16 alias, void *data)
514 static int arm_smmu_iort_xlate(struct device *dev, u32 streamid,
515 struct fwnode_handle *fwnode,
516 const struct iommu_ops *ops)
518 int ret = iommu_fwspec_init(dev, fwnode, ops);
521 ret = iommu_fwspec_add_ids(dev, &streamid, 1);
526 static const struct iommu_ops *iort_iommu_xlate(struct device *dev,
527 struct acpi_iort_node *node,
530 const struct iommu_ops *ops = NULL;
532 struct fwnode_handle *iort_fwnode;
535 iort_fwnode = iort_get_fwnode(node);
539 ops = iommu_get_instance(iort_fwnode);
543 ret = arm_smmu_iort_xlate(dev, streamid, iort_fwnode, ops);
546 return ret ? NULL : ops;
550 * iort_iommu_configure - Set-up IOMMU configuration for a device.
552 * @dev: device to configure
554 * Returns: iommu_ops pointer on configuration success
555 * NULL on configuration failure
557 const struct iommu_ops *iort_iommu_configure(struct device *dev)
559 struct acpi_iort_node *node, *parent;
560 const struct iommu_ops *ops = NULL;
563 if (dev_is_pci(dev)) {
564 struct pci_bus *bus = to_pci_dev(dev)->bus;
567 pci_for_each_dma_alias(to_pci_dev(dev), __get_pci_rid,
570 node = iort_scan_node(ACPI_IORT_NODE_PCI_ROOT_COMPLEX,
571 iort_match_node_callback, &bus->dev);
575 parent = iort_node_map_rid(node, rid, &streamid,
578 ops = iort_iommu_xlate(dev, parent, streamid);
583 node = iort_scan_node(ACPI_IORT_NODE_NAMED_COMPONENT,
584 iort_match_node_callback, dev);
588 parent = iort_node_get_id(node, &streamid,
589 IORT_IOMMU_TYPE, i++);
592 ops = iort_iommu_xlate(dev, parent, streamid);
594 parent = iort_node_get_id(node, &streamid,
595 IORT_IOMMU_TYPE, i++);
602 static void __init acpi_iort_register_irq(int hwirq, const char *name,
604 struct resource *res)
606 int irq = acpi_register_gsi(NULL, hwirq, trigger,
610 pr_err("could not register gsi hwirq %d name [%s]\n", hwirq,
617 res->flags = IORESOURCE_IRQ;
621 static int __init arm_smmu_v3_count_resources(struct acpi_iort_node *node)
623 struct acpi_iort_smmu_v3 *smmu;
624 /* Always present mem resource */
627 /* Retrieve SMMUv3 specific data */
628 smmu = (struct acpi_iort_smmu_v3 *)node->node_data;
630 if (smmu->event_gsiv)
645 static void __init arm_smmu_v3_init_resources(struct resource *res,
646 struct acpi_iort_node *node)
648 struct acpi_iort_smmu_v3 *smmu;
651 /* Retrieve SMMUv3 specific data */
652 smmu = (struct acpi_iort_smmu_v3 *)node->node_data;
654 res[num_res].start = smmu->base_address;
655 res[num_res].end = smmu->base_address + SZ_128K - 1;
656 res[num_res].flags = IORESOURCE_MEM;
660 if (smmu->event_gsiv)
661 acpi_iort_register_irq(smmu->event_gsiv, "eventq",
666 acpi_iort_register_irq(smmu->pri_gsiv, "priq",
671 acpi_iort_register_irq(smmu->gerr_gsiv, "gerror",
676 acpi_iort_register_irq(smmu->sync_gsiv, "cmdq-sync",
681 static bool __init arm_smmu_v3_is_coherent(struct acpi_iort_node *node)
683 struct acpi_iort_smmu_v3 *smmu;
685 /* Retrieve SMMUv3 specific data */
686 smmu = (struct acpi_iort_smmu_v3 *)node->node_data;
688 return smmu->flags & ACPI_IORT_SMMU_V3_COHACC_OVERRIDE;
691 static int __init arm_smmu_count_resources(struct acpi_iort_node *node)
693 struct acpi_iort_smmu *smmu;
695 /* Retrieve SMMU specific data */
696 smmu = (struct acpi_iort_smmu *)node->node_data;
699 * Only consider the global fault interrupt and ignore the
700 * configuration access interrupt.
702 * MMIO address and global fault interrupt resources are always
703 * present so add them to the context interrupt count as a static
706 return smmu->context_interrupt_count + 2;
709 static void __init arm_smmu_init_resources(struct resource *res,
710 struct acpi_iort_node *node)
712 struct acpi_iort_smmu *smmu;
713 int i, hw_irq, trigger, num_res = 0;
714 u64 *ctx_irq, *glb_irq;
716 /* Retrieve SMMU specific data */
717 smmu = (struct acpi_iort_smmu *)node->node_data;
719 res[num_res].start = smmu->base_address;
720 res[num_res].end = smmu->base_address + smmu->span - 1;
721 res[num_res].flags = IORESOURCE_MEM;
724 glb_irq = ACPI_ADD_PTR(u64, node, smmu->global_interrupt_offset);
726 hw_irq = IORT_IRQ_MASK(glb_irq[0]);
727 trigger = IORT_IRQ_TRIGGER_MASK(glb_irq[0]);
729 acpi_iort_register_irq(hw_irq, "arm-smmu-global", trigger,
733 ctx_irq = ACPI_ADD_PTR(u64, node, smmu->context_interrupt_offset);
734 for (i = 0; i < smmu->context_interrupt_count; i++) {
735 hw_irq = IORT_IRQ_MASK(ctx_irq[i]);
736 trigger = IORT_IRQ_TRIGGER_MASK(ctx_irq[i]);
738 acpi_iort_register_irq(hw_irq, "arm-smmu-context", trigger,
743 static bool __init arm_smmu_is_coherent(struct acpi_iort_node *node)
745 struct acpi_iort_smmu *smmu;
747 /* Retrieve SMMU specific data */
748 smmu = (struct acpi_iort_smmu *)node->node_data;
750 return smmu->flags & ACPI_IORT_SMMU_COHERENT_WALK;
753 struct iort_iommu_config {
755 int (*iommu_init)(struct acpi_iort_node *node);
756 bool (*iommu_is_coherent)(struct acpi_iort_node *node);
757 int (*iommu_count_resources)(struct acpi_iort_node *node);
758 void (*iommu_init_resources)(struct resource *res,
759 struct acpi_iort_node *node);
762 static const struct iort_iommu_config iort_arm_smmu_v3_cfg __initconst = {
763 .name = "arm-smmu-v3",
764 .iommu_is_coherent = arm_smmu_v3_is_coherent,
765 .iommu_count_resources = arm_smmu_v3_count_resources,
766 .iommu_init_resources = arm_smmu_v3_init_resources
769 static const struct iort_iommu_config iort_arm_smmu_cfg __initconst = {
771 .iommu_is_coherent = arm_smmu_is_coherent,
772 .iommu_count_resources = arm_smmu_count_resources,
773 .iommu_init_resources = arm_smmu_init_resources
777 const struct iort_iommu_config *iort_get_iommu_cfg(struct acpi_iort_node *node)
779 switch (node->type) {
780 case ACPI_IORT_NODE_SMMU_V3:
781 return &iort_arm_smmu_v3_cfg;
782 case ACPI_IORT_NODE_SMMU:
783 return &iort_arm_smmu_cfg;
790 * iort_add_smmu_platform_device() - Allocate a platform device for SMMU
791 * @node: Pointer to SMMU ACPI IORT node
793 * Returns: 0 on success, <0 failure
795 static int __init iort_add_smmu_platform_device(struct acpi_iort_node *node)
797 struct fwnode_handle *fwnode;
798 struct platform_device *pdev;
800 enum dev_dma_attr attr;
802 const struct iort_iommu_config *ops = iort_get_iommu_cfg(node);
807 pdev = platform_device_alloc(ops->name, PLATFORM_DEVID_AUTO);
809 return PTR_ERR(pdev);
811 count = ops->iommu_count_resources(node);
813 r = kcalloc(count, sizeof(*r), GFP_KERNEL);
819 ops->iommu_init_resources(r, node);
821 ret = platform_device_add_resources(pdev, r, count);
823 * Resources are duplicated in platform_device_add_resources,
824 * free their allocated memory
832 * Add a copy of IORT node pointer to platform_data to
833 * be used to retrieve IORT data information.
835 ret = platform_device_add_data(pdev, &node, sizeof(node));
840 * We expect the dma masks to be equivalent for
843 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
845 fwnode = iort_get_fwnode(node);
852 pdev->dev.fwnode = fwnode;
854 attr = ops->iommu_is_coherent(node) ?
855 DEV_DMA_COHERENT : DEV_DMA_NON_COHERENT;
857 /* Configure DMA for the page table walker */
858 acpi_dma_configure(&pdev->dev, attr);
860 ret = platform_device_add(pdev);
862 goto dma_deconfigure;
867 acpi_dma_deconfigure(&pdev->dev);
869 platform_device_put(pdev);
874 static void __init iort_init_platform_devices(void)
876 struct acpi_iort_node *iort_node, *iort_end;
877 struct acpi_table_iort *iort;
878 struct fwnode_handle *fwnode;
882 * iort_table and iort both point to the start of IORT table, but
883 * have different struct types
885 iort = (struct acpi_table_iort *)iort_table;
887 /* Get the first IORT node */
888 iort_node = ACPI_ADD_PTR(struct acpi_iort_node, iort,
890 iort_end = ACPI_ADD_PTR(struct acpi_iort_node, iort,
893 for (i = 0; i < iort->node_count; i++) {
894 if (iort_node >= iort_end) {
895 pr_err("iort node pointer overflows, bad table\n");
899 if ((iort_node->type == ACPI_IORT_NODE_SMMU) ||
900 (iort_node->type == ACPI_IORT_NODE_SMMU_V3)) {
902 fwnode = acpi_alloc_fwnode_static();
906 iort_set_fwnode(iort_node, fwnode);
908 ret = iort_add_smmu_platform_device(iort_node);
910 iort_delete_fwnode(iort_node);
911 acpi_free_fwnode_static(fwnode);
916 iort_node = ACPI_ADD_PTR(struct acpi_iort_node, iort_node,
921 void __init acpi_iort_init(void)
925 status = acpi_get_table(ACPI_SIG_IORT, 0, &iort_table);
926 if (ACPI_FAILURE(status)) {
927 if (status != AE_NOT_FOUND) {
928 const char *msg = acpi_format_exception(status);
930 pr_err("Failed to get table, %s\n", msg);
936 iort_init_platform_devices();
938 acpi_probe_device_table(iort);