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;
37 phys_addr_t base_addr;
42 struct list_head list;
43 struct acpi_iort_node *iort_node;
44 struct fwnode_handle *fwnode;
46 static LIST_HEAD(iort_fwnode_list);
47 static DEFINE_SPINLOCK(iort_fwnode_lock);
50 * iort_set_fwnode() - Create iort_fwnode and use it to register
51 * iommu data in the iort_fwnode_list
53 * @node: IORT table node associated with the IOMMU
54 * @fwnode: fwnode associated with the IORT node
56 * Returns: 0 on success
59 static inline int iort_set_fwnode(struct acpi_iort_node *iort_node,
60 struct fwnode_handle *fwnode)
62 struct iort_fwnode *np;
64 np = kzalloc(sizeof(struct iort_fwnode), GFP_ATOMIC);
69 INIT_LIST_HEAD(&np->list);
70 np->iort_node = iort_node;
73 spin_lock(&iort_fwnode_lock);
74 list_add_tail(&np->list, &iort_fwnode_list);
75 spin_unlock(&iort_fwnode_lock);
81 * iort_get_fwnode() - Retrieve fwnode associated with an IORT node
83 * @node: IORT table node to be looked-up
85 * Returns: fwnode_handle pointer on success, NULL on failure
87 static inline struct fwnode_handle *iort_get_fwnode(
88 struct acpi_iort_node *node)
90 struct iort_fwnode *curr;
91 struct fwnode_handle *fwnode = NULL;
93 spin_lock(&iort_fwnode_lock);
94 list_for_each_entry(curr, &iort_fwnode_list, list) {
95 if (curr->iort_node == node) {
96 fwnode = curr->fwnode;
100 spin_unlock(&iort_fwnode_lock);
106 * iort_delete_fwnode() - Delete fwnode associated with an IORT node
108 * @node: IORT table node associated with fwnode to delete
110 static inline void iort_delete_fwnode(struct acpi_iort_node *node)
112 struct iort_fwnode *curr, *tmp;
114 spin_lock(&iort_fwnode_lock);
115 list_for_each_entry_safe(curr, tmp, &iort_fwnode_list, list) {
116 if (curr->iort_node == node) {
117 list_del(&curr->list);
122 spin_unlock(&iort_fwnode_lock);
126 * iort_get_iort_node() - Retrieve iort_node associated with an fwnode
128 * @fwnode: fwnode associated with device to be looked-up
130 * Returns: iort_node pointer on success, NULL on failure
132 static inline struct acpi_iort_node *iort_get_iort_node(
133 struct fwnode_handle *fwnode)
135 struct iort_fwnode *curr;
136 struct acpi_iort_node *iort_node = NULL;
138 spin_lock(&iort_fwnode_lock);
139 list_for_each_entry(curr, &iort_fwnode_list, list) {
140 if (curr->fwnode == fwnode) {
141 iort_node = curr->iort_node;
145 spin_unlock(&iort_fwnode_lock);
150 typedef acpi_status (*iort_find_node_callback)
151 (struct acpi_iort_node *node, void *context);
153 /* Root pointer to the mapped IORT table */
154 static struct acpi_table_header *iort_table;
156 static LIST_HEAD(iort_msi_chip_list);
157 static DEFINE_SPINLOCK(iort_msi_chip_lock);
160 * iort_register_domain_token() - register domain token along with related
161 * ITS ID and base address to the list from where we can get it back later on.
163 * @base: ITS base address.
164 * @fw_node: Domain token.
166 * Returns: 0 on success, -ENOMEM if no memory when allocating list element
168 int iort_register_domain_token(int trans_id, phys_addr_t base,
169 struct fwnode_handle *fw_node)
171 struct iort_its_msi_chip *its_msi_chip;
173 its_msi_chip = kzalloc(sizeof(*its_msi_chip), GFP_KERNEL);
177 its_msi_chip->fw_node = fw_node;
178 its_msi_chip->translation_id = trans_id;
179 its_msi_chip->base_addr = base;
181 spin_lock(&iort_msi_chip_lock);
182 list_add(&its_msi_chip->list, &iort_msi_chip_list);
183 spin_unlock(&iort_msi_chip_lock);
189 * iort_deregister_domain_token() - Deregister domain token based on ITS ID
194 void iort_deregister_domain_token(int trans_id)
196 struct iort_its_msi_chip *its_msi_chip, *t;
198 spin_lock(&iort_msi_chip_lock);
199 list_for_each_entry_safe(its_msi_chip, t, &iort_msi_chip_list, list) {
200 if (its_msi_chip->translation_id == trans_id) {
201 list_del(&its_msi_chip->list);
206 spin_unlock(&iort_msi_chip_lock);
210 * iort_find_domain_token() - Find domain token based on given ITS ID
213 * Returns: domain token when find on the list, NULL otherwise
215 struct fwnode_handle *iort_find_domain_token(int trans_id)
217 struct fwnode_handle *fw_node = NULL;
218 struct iort_its_msi_chip *its_msi_chip;
220 spin_lock(&iort_msi_chip_lock);
221 list_for_each_entry(its_msi_chip, &iort_msi_chip_list, list) {
222 if (its_msi_chip->translation_id == trans_id) {
223 fw_node = its_msi_chip->fw_node;
227 spin_unlock(&iort_msi_chip_lock);
232 static struct acpi_iort_node *iort_scan_node(enum acpi_iort_node_type type,
233 iort_find_node_callback callback,
236 struct acpi_iort_node *iort_node, *iort_end;
237 struct acpi_table_iort *iort;
243 /* Get the first IORT node */
244 iort = (struct acpi_table_iort *)iort_table;
245 iort_node = ACPI_ADD_PTR(struct acpi_iort_node, iort,
247 iort_end = ACPI_ADD_PTR(struct acpi_iort_node, iort_table,
250 for (i = 0; i < iort->node_count; i++) {
251 if (WARN_TAINT(iort_node >= iort_end, TAINT_FIRMWARE_WORKAROUND,
252 "IORT node pointer overflows, bad table!\n"))
255 if (iort_node->type == type &&
256 ACPI_SUCCESS(callback(iort_node, context)))
259 iort_node = ACPI_ADD_PTR(struct acpi_iort_node, iort_node,
266 static acpi_status iort_match_node_callback(struct acpi_iort_node *node,
269 struct device *dev = context;
270 acpi_status status = AE_NOT_FOUND;
272 if (node->type == ACPI_IORT_NODE_NAMED_COMPONENT) {
273 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
274 struct acpi_device *adev = to_acpi_device_node(dev->fwnode);
275 struct acpi_iort_named_component *ncomp;
280 status = acpi_get_name(adev->handle, ACPI_FULL_PATHNAME, &buf);
281 if (ACPI_FAILURE(status)) {
282 dev_warn(dev, "Can't get device full path name\n");
286 ncomp = (struct acpi_iort_named_component *)node->node_data;
287 status = !strcmp(ncomp->device_name, buf.pointer) ?
288 AE_OK : AE_NOT_FOUND;
289 acpi_os_free(buf.pointer);
290 } else if (node->type == ACPI_IORT_NODE_PCI_ROOT_COMPLEX) {
291 struct acpi_iort_root_complex *pci_rc;
294 bus = to_pci_bus(dev);
295 pci_rc = (struct acpi_iort_root_complex *)node->node_data;
298 * It is assumed that PCI segment numbers maps one-to-one
299 * with root complexes. Each segment number can represent only
302 status = pci_rc->pci_segment_number == pci_domain_nr(bus) ?
303 AE_OK : AE_NOT_FOUND;
309 static int iort_id_map(struct acpi_iort_id_mapping *map, u8 type, u32 rid_in,
312 /* Single mapping does not care for input id */
313 if (map->flags & ACPI_IORT_ID_SINGLE_MAPPING) {
314 if (type == ACPI_IORT_NODE_NAMED_COMPONENT ||
315 type == ACPI_IORT_NODE_PCI_ROOT_COMPLEX) {
316 *rid_out = map->output_base;
320 pr_warn(FW_BUG "[map %p] SINGLE MAPPING flag not allowed for node type %d, skipping ID map\n",
325 if (rid_in < map->input_base ||
326 (rid_in >= map->input_base + map->id_count))
329 *rid_out = map->output_base + (rid_in - map->input_base);
333 static struct acpi_iort_node *iort_node_get_id(struct acpi_iort_node *node,
334 u32 *id_out, int index)
336 struct acpi_iort_node *parent;
337 struct acpi_iort_id_mapping *map;
339 if (!node->mapping_offset || !node->mapping_count ||
340 index >= node->mapping_count)
343 map = ACPI_ADD_PTR(struct acpi_iort_id_mapping, node,
344 node->mapping_offset + index * sizeof(*map));
347 if (!map->output_reference) {
348 pr_err(FW_BUG "[node %p type %d] ID map has NULL parent reference\n",
353 parent = ACPI_ADD_PTR(struct acpi_iort_node, iort_table,
354 map->output_reference);
356 if (map->flags & ACPI_IORT_ID_SINGLE_MAPPING) {
357 if (node->type == ACPI_IORT_NODE_NAMED_COMPONENT ||
358 node->type == ACPI_IORT_NODE_PCI_ROOT_COMPLEX ||
359 node->type == ACPI_IORT_NODE_SMMU_V3) {
360 *id_out = map->output_base;
368 static int iort_get_id_mapping_index(struct acpi_iort_node *node)
370 struct acpi_iort_smmu_v3 *smmu;
372 switch (node->type) {
373 case ACPI_IORT_NODE_SMMU_V3:
375 * SMMUv3 dev ID mapping index was introduced in revision 1
376 * table, not available in revision 0
378 if (node->revision < 1)
381 smmu = (struct acpi_iort_smmu_v3 *)node->node_data;
383 * ID mapping index is only ignored if all interrupts are
386 if (smmu->event_gsiv && smmu->pri_gsiv && smmu->gerr_gsiv
390 if (smmu->id_mapping_index >= node->mapping_count) {
391 pr_err(FW_BUG "[node %p type %d] ID mapping index overflows valid mappings\n",
396 return smmu->id_mapping_index;
402 static struct acpi_iort_node *iort_node_map_id(struct acpi_iort_node *node,
403 u32 id_in, u32 *id_out,
408 /* Parse the ID mapping tree to find specified node type */
410 struct acpi_iort_id_mapping *map;
413 if (IORT_TYPE_MASK(node->type) & type_mask) {
419 if (!node->mapping_offset || !node->mapping_count)
422 map = ACPI_ADD_PTR(struct acpi_iort_id_mapping, node,
423 node->mapping_offset);
426 if (!map->output_reference) {
427 pr_err(FW_BUG "[node %p type %d] ID map has NULL parent reference\n",
433 * Get the special ID mapping index (if any) and skip its
434 * associated ID map to prevent erroneous multi-stage
435 * IORT ID translations.
437 index = iort_get_id_mapping_index(node);
439 /* Do the ID translation */
440 for (i = 0; i < node->mapping_count; i++, map++) {
441 /* if it is special mapping index, skip it */
445 if (!iort_id_map(map, node->type, id, &id))
449 if (i == node->mapping_count)
452 node = ACPI_ADD_PTR(struct acpi_iort_node, iort_table,
453 map->output_reference);
457 /* Map input ID to output ID unchanged on mapping failure */
464 static struct acpi_iort_node *iort_node_map_platform_id(
465 struct acpi_iort_node *node, u32 *id_out, u8 type_mask,
468 struct acpi_iort_node *parent;
471 /* step 1: retrieve the initial dev id */
472 parent = iort_node_get_id(node, &id, index);
477 * optional step 2: map the initial dev id if its parent is not
478 * the target type we want, map it again for the use cases such
479 * as NC (named component) -> SMMU -> ITS. If the type is matched,
480 * return the initial dev id and its parent pointer directly.
482 if (!(IORT_TYPE_MASK(parent->type) & type_mask))
483 parent = iort_node_map_id(parent, id, id_out, type_mask);
491 static struct acpi_iort_node *iort_find_dev_node(struct device *dev)
493 struct pci_bus *pbus;
495 if (!dev_is_pci(dev)) {
496 struct acpi_iort_node *node;
498 * scan iort_fwnode_list to see if it's an iort platform
499 * device (such as SMMU, PMCG),its iort node already cached
500 * and associated with fwnode when iort platform devices
503 node = iort_get_iort_node(dev->fwnode);
508 * if not, then it should be a platform device defined in
509 * DSDT/SSDT (with Named Component node in IORT)
511 return iort_scan_node(ACPI_IORT_NODE_NAMED_COMPONENT,
512 iort_match_node_callback, dev);
515 /* Find a PCI root bus */
516 pbus = to_pci_dev(dev)->bus;
517 while (!pci_is_root_bus(pbus))
520 return iort_scan_node(ACPI_IORT_NODE_PCI_ROOT_COMPLEX,
521 iort_match_node_callback, &pbus->dev);
525 * iort_msi_map_rid() - Map a MSI requester ID for a device
526 * @dev: The device for which the mapping is to be done.
527 * @req_id: The device requester ID.
529 * Returns: mapped MSI RID on success, input requester ID otherwise
531 u32 iort_msi_map_rid(struct device *dev, u32 req_id)
533 struct acpi_iort_node *node;
536 node = iort_find_dev_node(dev);
540 iort_node_map_id(node, req_id, &dev_id, IORT_MSI_TYPE);
545 * iort_pmsi_get_dev_id() - Get the device id for a device
546 * @dev: The device for which the mapping is to be done.
547 * @dev_id: The device ID found.
549 * Returns: 0 for successful find a dev id, -ENODEV on error
551 int iort_pmsi_get_dev_id(struct device *dev, u32 *dev_id)
554 struct acpi_iort_node *node;
556 node = iort_find_dev_node(dev);
560 index = iort_get_id_mapping_index(node);
561 /* if there is a valid index, go get the dev_id directly */
563 if (iort_node_get_id(node, dev_id, index))
566 for (i = 0; i < node->mapping_count; i++) {
567 if (iort_node_map_platform_id(node, dev_id,
576 static int __maybe_unused iort_find_its_base(u32 its_id, phys_addr_t *base)
578 struct iort_its_msi_chip *its_msi_chip;
581 spin_lock(&iort_msi_chip_lock);
582 list_for_each_entry(its_msi_chip, &iort_msi_chip_list, list) {
583 if (its_msi_chip->translation_id == its_id) {
584 *base = its_msi_chip->base_addr;
589 spin_unlock(&iort_msi_chip_lock);
595 * iort_dev_find_its_id() - Find the ITS identifier for a device
597 * @req_id: Device's requester ID
598 * @idx: Index of the ITS identifier list.
599 * @its_id: ITS identifier.
601 * Returns: 0 on success, appropriate error value otherwise
603 static int iort_dev_find_its_id(struct device *dev, u32 req_id,
604 unsigned int idx, int *its_id)
606 struct acpi_iort_its_group *its;
607 struct acpi_iort_node *node;
609 node = iort_find_dev_node(dev);
613 node = iort_node_map_id(node, req_id, NULL, IORT_MSI_TYPE);
617 /* Move to ITS specific data */
618 its = (struct acpi_iort_its_group *)node->node_data;
619 if (idx > its->its_count) {
620 dev_err(dev, "requested ITS ID index [%d] is greater than available [%d]\n",
621 idx, its->its_count);
625 *its_id = its->identifiers[idx];
630 * iort_get_device_domain() - Find MSI domain related to a device
632 * @req_id: Requester ID for the device.
634 * Returns: the MSI domain for this device, NULL otherwise
636 struct irq_domain *iort_get_device_domain(struct device *dev, u32 req_id)
638 struct fwnode_handle *handle;
641 if (iort_dev_find_its_id(dev, req_id, 0, &its_id))
644 handle = iort_find_domain_token(its_id);
648 return irq_find_matching_fwnode(handle, DOMAIN_BUS_PCI_MSI);
651 static void iort_set_device_domain(struct device *dev,
652 struct acpi_iort_node *node)
654 struct acpi_iort_its_group *its;
655 struct acpi_iort_node *msi_parent;
656 struct acpi_iort_id_mapping *map;
657 struct fwnode_handle *iort_fwnode;
658 struct irq_domain *domain;
661 index = iort_get_id_mapping_index(node);
665 map = ACPI_ADD_PTR(struct acpi_iort_id_mapping, node,
666 node->mapping_offset + index * sizeof(*map));
669 if (!map->output_reference ||
670 !(map->flags & ACPI_IORT_ID_SINGLE_MAPPING)) {
671 pr_err(FW_BUG "[node %p type %d] Invalid MSI mapping\n",
676 msi_parent = ACPI_ADD_PTR(struct acpi_iort_node, iort_table,
677 map->output_reference);
679 if (!msi_parent || msi_parent->type != ACPI_IORT_NODE_ITS_GROUP)
682 /* Move to ITS specific data */
683 its = (struct acpi_iort_its_group *)msi_parent->node_data;
685 iort_fwnode = iort_find_domain_token(its->identifiers[0]);
689 domain = irq_find_matching_fwnode(iort_fwnode, DOMAIN_BUS_PLATFORM_MSI);
691 dev_set_msi_domain(dev, domain);
695 * iort_get_platform_device_domain() - Find MSI domain related to a
697 * @dev: the dev pointer associated with the platform device
699 * Returns: the MSI domain for this device, NULL otherwise
701 static struct irq_domain *iort_get_platform_device_domain(struct device *dev)
703 struct acpi_iort_node *node, *msi_parent = NULL;
704 struct fwnode_handle *iort_fwnode;
705 struct acpi_iort_its_group *its;
708 /* find its associated iort node */
709 node = iort_scan_node(ACPI_IORT_NODE_NAMED_COMPONENT,
710 iort_match_node_callback, dev);
714 /* then find its msi parent node */
715 for (i = 0; i < node->mapping_count; i++) {
716 msi_parent = iort_node_map_platform_id(node, NULL,
725 /* Move to ITS specific data */
726 its = (struct acpi_iort_its_group *)msi_parent->node_data;
728 iort_fwnode = iort_find_domain_token(its->identifiers[0]);
732 return irq_find_matching_fwnode(iort_fwnode, DOMAIN_BUS_PLATFORM_MSI);
735 void acpi_configure_pmsi_domain(struct device *dev)
737 struct irq_domain *msi_domain;
739 msi_domain = iort_get_platform_device_domain(dev);
741 dev_set_msi_domain(dev, msi_domain);
744 static int __maybe_unused __get_pci_rid(struct pci_dev *pdev, u16 alias,
753 static int arm_smmu_iort_xlate(struct device *dev, u32 streamid,
754 struct fwnode_handle *fwnode,
755 const struct iommu_ops *ops)
757 int ret = iommu_fwspec_init(dev, fwnode, ops);
760 ret = iommu_fwspec_add_ids(dev, &streamid, 1);
765 static inline bool iort_iommu_driver_enabled(u8 type)
768 case ACPI_IORT_NODE_SMMU_V3:
769 return IS_BUILTIN(CONFIG_ARM_SMMU_V3);
770 case ACPI_IORT_NODE_SMMU:
771 return IS_BUILTIN(CONFIG_ARM_SMMU);
773 pr_warn("IORT node type %u does not describe an SMMU\n", type);
778 #ifdef CONFIG_IOMMU_API
779 static struct acpi_iort_node *iort_get_msi_resv_iommu(struct device *dev)
781 struct acpi_iort_node *iommu;
782 struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
784 iommu = iort_get_iort_node(fwspec->iommu_fwnode);
786 if (iommu && (iommu->type == ACPI_IORT_NODE_SMMU_V3)) {
787 struct acpi_iort_smmu_v3 *smmu;
789 smmu = (struct acpi_iort_smmu_v3 *)iommu->node_data;
790 if (smmu->model == ACPI_IORT_SMMU_V3_HISILICON_HI161X)
797 static inline const struct iommu_ops *iort_fwspec_iommu_ops(struct device *dev)
799 struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
801 return (fwspec && fwspec->ops) ? fwspec->ops : NULL;
804 static inline int iort_add_device_replay(const struct iommu_ops *ops,
809 if (dev->bus && !device_iommu_mapped(dev))
810 err = iommu_probe_device(dev);
816 * iort_iommu_msi_get_resv_regions - Reserved region driver helper
817 * @dev: Device from iommu_get_resv_regions()
818 * @head: Reserved region list from iommu_get_resv_regions()
820 * Returns: Number of msi reserved regions on success (0 if platform
821 * doesn't require the reservation or no associated msi regions),
822 * appropriate error value otherwise. The ITS interrupt translation
823 * spaces (ITS_base + SZ_64K, SZ_64K) associated with the device
824 * are the msi reserved regions.
826 int iort_iommu_msi_get_resv_regions(struct device *dev, struct list_head *head)
828 struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
829 struct acpi_iort_its_group *its;
830 struct acpi_iort_node *iommu_node, *its_node = NULL;
833 iommu_node = iort_get_msi_resv_iommu(dev);
838 * Current logic to reserve ITS regions relies on HW topologies
839 * where a given PCI or named component maps its IDs to only one
840 * ITS group; if a PCI or named component can map its IDs to
841 * different ITS groups through IORT mappings this function has
842 * to be reworked to ensure we reserve regions for all ITS groups
843 * a given PCI or named component may map IDs to.
846 for (i = 0; i < fwspec->num_ids; i++) {
847 its_node = iort_node_map_id(iommu_node,
849 NULL, IORT_MSI_TYPE);
857 /* Move to ITS specific data */
858 its = (struct acpi_iort_its_group *)its_node->node_data;
860 for (i = 0; i < its->its_count; i++) {
863 if (!iort_find_its_base(its->identifiers[i], &base)) {
864 int prot = IOMMU_WRITE | IOMMU_NOEXEC | IOMMU_MMIO;
865 struct iommu_resv_region *region;
867 region = iommu_alloc_resv_region(base + SZ_64K, SZ_64K,
868 prot, IOMMU_RESV_MSI);
870 list_add_tail(®ion->list, head);
876 return (resv == its->its_count) ? resv : -ENODEV;
879 static inline const struct iommu_ops *iort_fwspec_iommu_ops(struct device *dev)
881 static inline int iort_add_device_replay(const struct iommu_ops *ops,
884 int iort_iommu_msi_get_resv_regions(struct device *dev, struct list_head *head)
888 static int iort_iommu_xlate(struct device *dev, struct acpi_iort_node *node,
891 const struct iommu_ops *ops;
892 struct fwnode_handle *iort_fwnode;
897 iort_fwnode = iort_get_fwnode(node);
902 * If the ops look-up fails, this means that either
903 * the SMMU drivers have not been probed yet or that
904 * the SMMU drivers are not built in the kernel;
905 * Depending on whether the SMMU drivers are built-in
906 * in the kernel or not, defer the IOMMU configuration
909 ops = iommu_ops_from_fwnode(iort_fwnode);
911 return iort_iommu_driver_enabled(node->type) ?
912 -EPROBE_DEFER : -ENODEV;
914 return arm_smmu_iort_xlate(dev, streamid, iort_fwnode, ops);
917 struct iort_pci_alias_info {
919 struct acpi_iort_node *node;
922 static int iort_pci_iommu_init(struct pci_dev *pdev, u16 alias, void *data)
924 struct iort_pci_alias_info *info = data;
925 struct acpi_iort_node *parent;
928 parent = iort_node_map_id(info->node, alias, &streamid,
930 return iort_iommu_xlate(info->dev, parent, streamid);
933 static int nc_dma_get_range(struct device *dev, u64 *size)
935 struct acpi_iort_node *node;
936 struct acpi_iort_named_component *ncomp;
938 node = iort_scan_node(ACPI_IORT_NODE_NAMED_COMPONENT,
939 iort_match_node_callback, dev);
943 ncomp = (struct acpi_iort_named_component *)node->node_data;
945 *size = ncomp->memory_address_limit >= 64 ? U64_MAX :
946 1ULL<<ncomp->memory_address_limit;
951 static int rc_dma_get_range(struct device *dev, u64 *size)
953 struct acpi_iort_node *node;
954 struct acpi_iort_root_complex *rc;
955 struct pci_bus *pbus = to_pci_dev(dev)->bus;
957 node = iort_scan_node(ACPI_IORT_NODE_PCI_ROOT_COMPLEX,
958 iort_match_node_callback, &pbus->dev);
959 if (!node || node->revision < 1)
962 rc = (struct acpi_iort_root_complex *)node->node_data;
964 *size = rc->memory_address_limit >= 64 ? U64_MAX :
965 1ULL<<rc->memory_address_limit;
971 * iort_dma_setup() - Set-up device DMA parameters.
973 * @dev: device to configure
974 * @dma_addr: device DMA address result pointer
975 * @size: DMA range size result pointer
977 void iort_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size)
979 u64 mask, dmaaddr = 0, size = 0, offset = 0;
983 * If @dev is expected to be DMA-capable then the bus code that created
984 * it should have initialised its dma_mask pointer by this point. For
985 * now, we'll continue the legacy behaviour of coercing it to the
986 * coherent mask if not, but we'll no longer do so quietly.
988 if (!dev->dma_mask) {
989 dev_warn(dev, "DMA mask not set\n");
990 dev->dma_mask = &dev->coherent_dma_mask;
993 if (dev->coherent_dma_mask)
994 size = max(dev->coherent_dma_mask, dev->coherent_dma_mask + 1);
998 if (dev_is_pci(dev)) {
999 ret = acpi_dma_get_range(dev, &dmaaddr, &offset, &size);
1001 ret = rc_dma_get_range(dev, &size);
1003 ret = nc_dma_get_range(dev, &size);
1007 msb = fls64(dmaaddr + size - 1);
1009 * Round-up to the power-of-two mask or set
1010 * the mask to the whole 64-bit address space
1011 * in case the DMA region covers the full
1014 mask = msb == 64 ? U64_MAX : (1ULL << msb) - 1;
1016 * Limit coherent and dma mask based on size
1017 * retrieved from firmware.
1019 dev->bus_dma_mask = mask;
1020 dev->coherent_dma_mask = mask;
1021 *dev->dma_mask = mask;
1024 *dma_addr = dmaaddr;
1027 dev->dma_pfn_offset = PFN_DOWN(offset);
1028 dev_dbg(dev, "dma_pfn_offset(%#08llx)\n", offset);
1032 * iort_iommu_configure - Set-up IOMMU configuration for a device.
1034 * @dev: device to configure
1036 * Returns: iommu_ops pointer on configuration success
1037 * NULL on configuration failure
1039 const struct iommu_ops *iort_iommu_configure(struct device *dev)
1041 struct acpi_iort_node *node, *parent;
1042 const struct iommu_ops *ops;
1047 * If we already translated the fwspec there
1048 * is nothing left to do, return the iommu_ops.
1050 ops = iort_fwspec_iommu_ops(dev);
1054 if (dev_is_pci(dev)) {
1055 struct pci_bus *bus = to_pci_dev(dev)->bus;
1056 struct iort_pci_alias_info info = { .dev = dev };
1058 node = iort_scan_node(ACPI_IORT_NODE_PCI_ROOT_COMPLEX,
1059 iort_match_node_callback, &bus->dev);
1064 err = pci_for_each_dma_alias(to_pci_dev(dev),
1065 iort_pci_iommu_init, &info);
1069 node = iort_scan_node(ACPI_IORT_NODE_NAMED_COMPONENT,
1070 iort_match_node_callback, dev);
1075 parent = iort_node_map_platform_id(node, &streamid,
1080 err = iort_iommu_xlate(dev, parent, streamid);
1081 } while (parent && !err);
1085 * If we have reason to believe the IOMMU driver missed the initial
1086 * add_device callback for dev, replay it to get things in order.
1089 ops = iort_fwspec_iommu_ops(dev);
1090 err = iort_add_device_replay(ops, dev);
1093 /* Ignore all other errors apart from EPROBE_DEFER */
1094 if (err == -EPROBE_DEFER) {
1097 dev_dbg(dev, "Adding to IOMMU failed: %d\n", err);
1104 static void __init acpi_iort_register_irq(int hwirq, const char *name,
1106 struct resource *res)
1108 int irq = acpi_register_gsi(NULL, hwirq, trigger,
1112 pr_err("could not register gsi hwirq %d name [%s]\n", hwirq,
1119 res->flags = IORESOURCE_IRQ;
1123 static int __init arm_smmu_v3_count_resources(struct acpi_iort_node *node)
1125 struct acpi_iort_smmu_v3 *smmu;
1126 /* Always present mem resource */
1129 /* Retrieve SMMUv3 specific data */
1130 smmu = (struct acpi_iort_smmu_v3 *)node->node_data;
1132 if (smmu->event_gsiv)
1138 if (smmu->gerr_gsiv)
1141 if (smmu->sync_gsiv)
1147 static bool arm_smmu_v3_is_combined_irq(struct acpi_iort_smmu_v3 *smmu)
1150 * Cavium ThunderX2 implementation doesn't not support unique
1151 * irq line. Use single irq line for all the SMMUv3 interrupts.
1153 if (smmu->model != ACPI_IORT_SMMU_V3_CAVIUM_CN99XX)
1157 * ThunderX2 doesn't support MSIs from the SMMU, so we're checking
1160 return smmu->event_gsiv == smmu->pri_gsiv &&
1161 smmu->event_gsiv == smmu->gerr_gsiv &&
1162 smmu->event_gsiv == smmu->sync_gsiv;
1165 static unsigned long arm_smmu_v3_resource_size(struct acpi_iort_smmu_v3 *smmu)
1168 * Override the size, for Cavium ThunderX2 implementation
1169 * which doesn't support the page 1 SMMU register space.
1171 if (smmu->model == ACPI_IORT_SMMU_V3_CAVIUM_CN99XX)
1177 static void __init arm_smmu_v3_init_resources(struct resource *res,
1178 struct acpi_iort_node *node)
1180 struct acpi_iort_smmu_v3 *smmu;
1183 /* Retrieve SMMUv3 specific data */
1184 smmu = (struct acpi_iort_smmu_v3 *)node->node_data;
1186 res[num_res].start = smmu->base_address;
1187 res[num_res].end = smmu->base_address +
1188 arm_smmu_v3_resource_size(smmu) - 1;
1189 res[num_res].flags = IORESOURCE_MEM;
1192 if (arm_smmu_v3_is_combined_irq(smmu)) {
1193 if (smmu->event_gsiv)
1194 acpi_iort_register_irq(smmu->event_gsiv, "combined",
1195 ACPI_EDGE_SENSITIVE,
1199 if (smmu->event_gsiv)
1200 acpi_iort_register_irq(smmu->event_gsiv, "eventq",
1201 ACPI_EDGE_SENSITIVE,
1205 acpi_iort_register_irq(smmu->pri_gsiv, "priq",
1206 ACPI_EDGE_SENSITIVE,
1209 if (smmu->gerr_gsiv)
1210 acpi_iort_register_irq(smmu->gerr_gsiv, "gerror",
1211 ACPI_EDGE_SENSITIVE,
1214 if (smmu->sync_gsiv)
1215 acpi_iort_register_irq(smmu->sync_gsiv, "cmdq-sync",
1216 ACPI_EDGE_SENSITIVE,
1221 static bool __init arm_smmu_v3_is_coherent(struct acpi_iort_node *node)
1223 struct acpi_iort_smmu_v3 *smmu;
1225 /* Retrieve SMMUv3 specific data */
1226 smmu = (struct acpi_iort_smmu_v3 *)node->node_data;
1228 return smmu->flags & ACPI_IORT_SMMU_V3_COHACC_OVERRIDE;
1231 #if defined(CONFIG_ACPI_NUMA)
1233 * set numa proximity domain for smmuv3 device
1235 static int __init arm_smmu_v3_set_proximity(struct device *dev,
1236 struct acpi_iort_node *node)
1238 struct acpi_iort_smmu_v3 *smmu;
1240 smmu = (struct acpi_iort_smmu_v3 *)node->node_data;
1241 if (smmu->flags & ACPI_IORT_SMMU_V3_PXM_VALID) {
1242 int node = acpi_map_pxm_to_node(smmu->pxm);
1244 if (node != NUMA_NO_NODE && !node_online(node))
1247 set_dev_node(dev, node);
1248 pr_info("SMMU-v3[%llx] Mapped to Proximity domain %d\n",
1255 #define arm_smmu_v3_set_proximity NULL
1258 static int __init arm_smmu_count_resources(struct acpi_iort_node *node)
1260 struct acpi_iort_smmu *smmu;
1262 /* Retrieve SMMU specific data */
1263 smmu = (struct acpi_iort_smmu *)node->node_data;
1266 * Only consider the global fault interrupt and ignore the
1267 * configuration access interrupt.
1269 * MMIO address and global fault interrupt resources are always
1270 * present so add them to the context interrupt count as a static
1273 return smmu->context_interrupt_count + 2;
1276 static void __init arm_smmu_init_resources(struct resource *res,
1277 struct acpi_iort_node *node)
1279 struct acpi_iort_smmu *smmu;
1280 int i, hw_irq, trigger, num_res = 0;
1281 u64 *ctx_irq, *glb_irq;
1283 /* Retrieve SMMU specific data */
1284 smmu = (struct acpi_iort_smmu *)node->node_data;
1286 res[num_res].start = smmu->base_address;
1287 res[num_res].end = smmu->base_address + smmu->span - 1;
1288 res[num_res].flags = IORESOURCE_MEM;
1291 glb_irq = ACPI_ADD_PTR(u64, node, smmu->global_interrupt_offset);
1293 hw_irq = IORT_IRQ_MASK(glb_irq[0]);
1294 trigger = IORT_IRQ_TRIGGER_MASK(glb_irq[0]);
1296 acpi_iort_register_irq(hw_irq, "arm-smmu-global", trigger,
1300 ctx_irq = ACPI_ADD_PTR(u64, node, smmu->context_interrupt_offset);
1301 for (i = 0; i < smmu->context_interrupt_count; i++) {
1302 hw_irq = IORT_IRQ_MASK(ctx_irq[i]);
1303 trigger = IORT_IRQ_TRIGGER_MASK(ctx_irq[i]);
1305 acpi_iort_register_irq(hw_irq, "arm-smmu-context", trigger,
1310 static bool __init arm_smmu_is_coherent(struct acpi_iort_node *node)
1312 struct acpi_iort_smmu *smmu;
1314 /* Retrieve SMMU specific data */
1315 smmu = (struct acpi_iort_smmu *)node->node_data;
1317 return smmu->flags & ACPI_IORT_SMMU_COHERENT_WALK;
1320 struct iort_dev_config {
1322 int (*dev_init)(struct acpi_iort_node *node);
1323 bool (*dev_is_coherent)(struct acpi_iort_node *node);
1324 int (*dev_count_resources)(struct acpi_iort_node *node);
1325 void (*dev_init_resources)(struct resource *res,
1326 struct acpi_iort_node *node);
1327 int (*dev_set_proximity)(struct device *dev,
1328 struct acpi_iort_node *node);
1331 static const struct iort_dev_config iort_arm_smmu_v3_cfg __initconst = {
1332 .name = "arm-smmu-v3",
1333 .dev_is_coherent = arm_smmu_v3_is_coherent,
1334 .dev_count_resources = arm_smmu_v3_count_resources,
1335 .dev_init_resources = arm_smmu_v3_init_resources,
1336 .dev_set_proximity = arm_smmu_v3_set_proximity,
1339 static const struct iort_dev_config iort_arm_smmu_cfg __initconst = {
1341 .dev_is_coherent = arm_smmu_is_coherent,
1342 .dev_count_resources = arm_smmu_count_resources,
1343 .dev_init_resources = arm_smmu_init_resources
1346 static __init const struct iort_dev_config *iort_get_dev_cfg(
1347 struct acpi_iort_node *node)
1349 switch (node->type) {
1350 case ACPI_IORT_NODE_SMMU_V3:
1351 return &iort_arm_smmu_v3_cfg;
1352 case ACPI_IORT_NODE_SMMU:
1353 return &iort_arm_smmu_cfg;
1360 * iort_add_platform_device() - Allocate a platform device for IORT node
1361 * @node: Pointer to device ACPI IORT node
1363 * Returns: 0 on success, <0 failure
1365 static int __init iort_add_platform_device(struct acpi_iort_node *node,
1366 const struct iort_dev_config *ops)
1368 struct fwnode_handle *fwnode;
1369 struct platform_device *pdev;
1371 enum dev_dma_attr attr;
1374 pdev = platform_device_alloc(ops->name, PLATFORM_DEVID_AUTO);
1378 if (ops->dev_set_proximity) {
1379 ret = ops->dev_set_proximity(&pdev->dev, node);
1384 count = ops->dev_count_resources(node);
1386 r = kcalloc(count, sizeof(*r), GFP_KERNEL);
1392 ops->dev_init_resources(r, node);
1394 ret = platform_device_add_resources(pdev, r, count);
1396 * Resources are duplicated in platform_device_add_resources,
1397 * free their allocated memory
1405 * Add a copy of IORT node pointer to platform_data to
1406 * be used to retrieve IORT data information.
1408 ret = platform_device_add_data(pdev, &node, sizeof(node));
1413 * We expect the dma masks to be equivalent for
1416 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
1418 fwnode = iort_get_fwnode(node);
1425 pdev->dev.fwnode = fwnode;
1427 attr = ops->dev_is_coherent && ops->dev_is_coherent(node) ?
1428 DEV_DMA_COHERENT : DEV_DMA_NON_COHERENT;
1430 /* Configure DMA for the page table walker */
1431 acpi_dma_configure(&pdev->dev, attr);
1433 iort_set_device_domain(&pdev->dev, node);
1435 ret = platform_device_add(pdev);
1437 goto dma_deconfigure;
1442 arch_teardown_dma_ops(&pdev->dev);
1444 platform_device_put(pdev);
1450 static void __init iort_enable_acs(struct acpi_iort_node *iort_node)
1452 static bool acs_enabled __initdata;
1457 if (iort_node->type == ACPI_IORT_NODE_PCI_ROOT_COMPLEX) {
1458 struct acpi_iort_node *parent;
1459 struct acpi_iort_id_mapping *map;
1462 map = ACPI_ADD_PTR(struct acpi_iort_id_mapping, iort_node,
1463 iort_node->mapping_offset);
1465 for (i = 0; i < iort_node->mapping_count; i++, map++) {
1466 if (!map->output_reference)
1469 parent = ACPI_ADD_PTR(struct acpi_iort_node,
1470 iort_table, map->output_reference);
1472 * If we detect a RC->SMMU mapping, make sure
1473 * we enable ACS on the system.
1475 if ((parent->type == ACPI_IORT_NODE_SMMU) ||
1476 (parent->type == ACPI_IORT_NODE_SMMU_V3)) {
1485 static inline void iort_enable_acs(struct acpi_iort_node *iort_node) { }
1488 static void __init iort_init_platform_devices(void)
1490 struct acpi_iort_node *iort_node, *iort_end;
1491 struct acpi_table_iort *iort;
1492 struct fwnode_handle *fwnode;
1494 const struct iort_dev_config *ops;
1497 * iort_table and iort both point to the start of IORT table, but
1498 * have different struct types
1500 iort = (struct acpi_table_iort *)iort_table;
1502 /* Get the first IORT node */
1503 iort_node = ACPI_ADD_PTR(struct acpi_iort_node, iort,
1505 iort_end = ACPI_ADD_PTR(struct acpi_iort_node, iort,
1506 iort_table->length);
1508 for (i = 0; i < iort->node_count; i++) {
1509 if (iort_node >= iort_end) {
1510 pr_err("iort node pointer overflows, bad table\n");
1514 iort_enable_acs(iort_node);
1516 ops = iort_get_dev_cfg(iort_node);
1518 fwnode = acpi_alloc_fwnode_static();
1522 iort_set_fwnode(iort_node, fwnode);
1524 ret = iort_add_platform_device(iort_node, ops);
1526 iort_delete_fwnode(iort_node);
1527 acpi_free_fwnode_static(fwnode);
1532 iort_node = ACPI_ADD_PTR(struct acpi_iort_node, iort_node,
1537 void __init acpi_iort_init(void)
1541 status = acpi_get_table(ACPI_SIG_IORT, 0, &iort_table);
1542 if (ACPI_FAILURE(status)) {
1543 if (status != AE_NOT_FOUND) {
1544 const char *msg = acpi_format_exception(status);
1546 pr_err("Failed to get table, %s\n", msg);
1552 iort_init_platform_devices();