* [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps
@ 2026-02-26 7:42 Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 1/3] of: Add convenience wrappers for of_map_id() Vijayanand Jitta
` (3 more replies)
0 siblings, 4 replies; 6+ messages in thread
From: Vijayanand Jitta @ 2026-02-26 7:42 UTC (permalink / raw)
To: robin.murphy, will, joro, robh, dmitry.baryshkov, konrad.dybcio,
bjorn.andersson, bod, conor+dt, krzk+dt, prakash.gupta,
vikash.garodia
Cc: iommu, linux-kernel, devicetree, Vijayanand Jitta
So far our parsing of {iommu,msi}-map properites has always blindly
assumed that the output specifiers will always have exactly 1 cell.
This typically does happen to be the case, but is not actually enforced
(and the PCI msi-map binding even explicitly states support for 0 or 1
cells) - as a result we've now ended up with dodgy DTs out in the field
which depend on this behaviour to map a 1-cell specifier for a 2-cell
provider, despite that being bogus per the bindings themselves.
Since there is some potential use[1] in being able to map at least
single input IDs to multi-cell output specifiers (and properly support
0-cell outputs as well), add support for properly parsing and using the
target nodes' #cells values, albeit with the unfortunate complication of
still having to work around expectations of the old behaviour too.
-- Robin.
Unlike single #{}-cell, it is complex to establish a linear relation
between input 'id' and output specifier for multi-cell properties, thus
it is always expected that len never going to be > 1.
These changes have been tested on QEMU for the arm64 architecture.
[1] https://lore.kernel.org/all/20250627-video_cb-v3-0-51e18c0ffbce@quicinc.com/
V8:
Removed mentions of of_map_args from commit message to match code.
Link to V7:
https://lore.kernel.org/all/20260210101157.2145113-1-vijayanand.jitta@oss.qualcomm.com/
V7:
Removed of_map_id_args structure and replaced it with of_phandle_args as
suggested by Dmitry.
Link to V6:
https://lore.kernel.org/all/20260121055400.937856-1-vijayanand.jitta@oss.qualcomm.com/
V6:
Fixed build error reported by kernel test bot.
Link to V5:
https://lore.kernel.org/all/20260118181125.1436036-1-vijayanand.jitta@oss.qualcomm.com/
V5:
Fixed Build Warnings.
Raised PR for iommu-map dtschema:
https://github.com/devicetree-org/dt-schema/pull/184
Link to V4:
https://lore.kernel.org/all/20251231114257.2382820-1-vijayanand.jitta@oss.qualcomm.com/
V4:
1) Added Reviewed-by tag.
2) Resolved warnings reported by kernel test bot, minor code
reorganization.
Link to V3:
https://lore.kernel.org/all/20251221213602.2413124-1-vijayanand.jitta@oss.qualcomm.com/
V3:
1) Added Reviewed-by tag.
2) Updated of_map_id_args struct as a wrapper to of_phandle_args and
added comment description as suggested by Rob Herring.
Link to V2:
https://lore.kernel.org/all/20251204095530.8627-1-vijayanand.jitta@oss.qualcomm.com/
V2:
1) Incorporated the patches from Robin that does the clean implementation.
2) Dropped the patches the were adding multi-map support from this series
as suggested.
V1:
https://lore.kernel.org/all/cover.1762235099.git.charan.kalla@oss.qualcomm.com/
RFC:
https://lore.kernel.org/all/20250928171718.436440-1-charan.kalla@oss.qualcomm.com/#r
Charan Teja Kalla (1):
of: factor arguments passed to of_map_id() into a struct
Robin Murphy (2):
of: Add convenience wrappers for of_map_id()
of: Respect #{iommu,msi}-cells in maps
drivers/cdx/cdx_msi.c | 3 +-
drivers/iommu/of_iommu.c | 6 +-
drivers/irqchip/irq-gic-its-msi-parent.c | 2 +-
drivers/of/base.c | 148 +++++++++++++++++------
drivers/of/irq.c | 3 +-
drivers/pci/controller/dwc/pci-imx6.c | 12 +-
drivers/pci/controller/pcie-apple.c | 5 +-
drivers/xen/grant-dma-ops.c | 3 +-
include/linux/of.h | 33 ++++-
9 files changed, 152 insertions(+), 63 deletions(-)
--
2.34.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* [RESEND,v8 1/3] of: Add convenience wrappers for of_map_id()
2026-02-26 7:42 [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps Vijayanand Jitta
@ 2026-02-26 7:42 ` Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 2/3] of: factor arguments passed to of_map_id() into a struct Vijayanand Jitta
` (2 subsequent siblings)
3 siblings, 0 replies; 6+ messages in thread
From: Vijayanand Jitta @ 2026-02-26 7:42 UTC (permalink / raw)
To: robin.murphy, will, joro, robh, dmitry.baryshkov, konrad.dybcio,
bjorn.andersson, bod, conor+dt, krzk+dt, prakash.gupta,
vikash.garodia
Cc: iommu, linux-kernel, devicetree, Frank Li, Vijayanand Jitta
From: Robin Murphy <robin.murphy@arm.com>
Since we now have quite a few users parsing "iommu-map" and "msi-map"
properties, give them some wrappers to conveniently encapsulate the
appropriate sets of property names. This will also make it easier to
then change of_map_id() to correctly account for specifier cells.
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
Reviewed-by: Frank Li <Frank.Li@nxp.com>
Signed-off-by: Robin Murphy <robin.murphy@arm.com>
Signed-off-by: Vijayanand Jitta <vijayanand.jitta@oss.qualcomm.com>
---
drivers/cdx/cdx_msi.c | 3 +--
drivers/iommu/of_iommu.c | 4 +---
drivers/irqchip/irq-gic-its-msi-parent.c | 2 +-
drivers/of/irq.c | 3 +--
drivers/pci/controller/dwc/pci-imx6.c | 6 ++----
drivers/pci/controller/pcie-apple.c | 3 +--
drivers/xen/grant-dma-ops.c | 3 +--
include/linux/of.h | 14 ++++++++++++++
8 files changed, 22 insertions(+), 16 deletions(-)
diff --git a/drivers/cdx/cdx_msi.c b/drivers/cdx/cdx_msi.c
index 91b95422b263..63b3544ec997 100644
--- a/drivers/cdx/cdx_msi.c
+++ b/drivers/cdx/cdx_msi.c
@@ -128,8 +128,7 @@ static int cdx_msi_prepare(struct irq_domain *msi_domain,
int ret;
/* Retrieve device ID from requestor ID using parent device */
- ret = of_map_id(parent->of_node, cdx_dev->msi_dev_id, "msi-map", "msi-map-mask",
- NULL, &dev_id);
+ ret = of_map_msi_id(parent->of_node, cdx_dev->msi_dev_id, NULL, &dev_id);
if (ret) {
dev_err(dev, "of_map_id failed for MSI: %d\n", ret);
return ret;
diff --git a/drivers/iommu/of_iommu.c b/drivers/iommu/of_iommu.c
index 6b989a62def2..a511ecf21fcd 100644
--- a/drivers/iommu/of_iommu.c
+++ b/drivers/iommu/of_iommu.c
@@ -48,9 +48,7 @@ static int of_iommu_configure_dev_id(struct device_node *master_np,
struct of_phandle_args iommu_spec = { .args_count = 1 };
int err;
- err = of_map_id(master_np, *id, "iommu-map",
- "iommu-map-mask", &iommu_spec.np,
- iommu_spec.args);
+ err = of_map_iommu_id(master_np, *id, &iommu_spec.np, iommu_spec.args);
if (err)
return err;
diff --git a/drivers/irqchip/irq-gic-its-msi-parent.c b/drivers/irqchip/irq-gic-its-msi-parent.c
index a832cdb2e697..b30d0dc0a1aa 100644
--- a/drivers/irqchip/irq-gic-its-msi-parent.c
+++ b/drivers/irqchip/irq-gic-its-msi-parent.c
@@ -179,7 +179,7 @@ static int of_pmsi_get_msi_info(struct irq_domain *domain, struct device *dev, u
struct device_node *msi_ctrl __free(device_node) = NULL;
- return of_map_id(dev->of_node, dev->id, "msi-map", "msi-map-mask", &msi_ctrl, dev_id);
+ return of_map_msi_id(dev->of_node, dev->id, &msi_ctrl, dev_id);
}
static int its_pmsi_prepare(struct irq_domain *domain, struct device *dev,
diff --git a/drivers/of/irq.c b/drivers/of/irq.c
index f374d8b212b8..ddd046de70de 100644
--- a/drivers/of/irq.c
+++ b/drivers/of/irq.c
@@ -817,8 +817,7 @@ u32 of_msi_xlate(struct device *dev, struct device_node **msi_np, u32 id_in)
* "msi-map" or an "msi-parent" property.
*/
for (parent_dev = dev; parent_dev; parent_dev = parent_dev->parent) {
- if (!of_map_id(parent_dev->of_node, id_in, "msi-map",
- "msi-map-mask", msi_np, &id_out))
+ if (!of_map_msi_id(parent_dev->of_node, id_in, msi_np, &id_out))
break;
if (!of_check_msi_parent(parent_dev->of_node, msi_np))
break;
diff --git a/drivers/pci/controller/dwc/pci-imx6.c b/drivers/pci/controller/dwc/pci-imx6.c
index a5b8d0b71677..bff8289f804a 100644
--- a/drivers/pci/controller/dwc/pci-imx6.c
+++ b/drivers/pci/controller/dwc/pci-imx6.c
@@ -1144,8 +1144,7 @@ static int imx_pcie_add_lut_by_rid(struct imx_pcie *imx_pcie, u32 rid)
u32 sid = 0;
target = NULL;
- err_i = of_map_id(dev->of_node, rid, "iommu-map", "iommu-map-mask",
- &target, &sid_i);
+ err_i = of_map_iommu_id(dev->of_node, rid, &target, &sid_i);
if (target) {
of_node_put(target);
} else {
@@ -1158,8 +1157,7 @@ static int imx_pcie_add_lut_by_rid(struct imx_pcie *imx_pcie, u32 rid)
}
target = NULL;
- err_m = of_map_id(dev->of_node, rid, "msi-map", "msi-map-mask",
- &target, &sid_m);
+ err_m = of_map_msi_id(dev->of_node, rid, &target, &sid_m);
/*
* err_m target
diff --git a/drivers/pci/controller/pcie-apple.c b/drivers/pci/controller/pcie-apple.c
index 2d92fc79f6dd..a0937b7b3c4d 100644
--- a/drivers/pci/controller/pcie-apple.c
+++ b/drivers/pci/controller/pcie-apple.c
@@ -764,8 +764,7 @@ static int apple_pcie_enable_device(struct pci_host_bridge *bridge, struct pci_d
dev_dbg(&pdev->dev, "added to bus %s, index %d\n",
pci_name(pdev->bus->self), port->idx);
- err = of_map_id(port->pcie->dev->of_node, rid, "iommu-map",
- "iommu-map-mask", NULL, &sid);
+ err = of_map_iommu_id(port->pcie->dev->of_node, rid, NULL, &sid);
if (err)
return err;
diff --git a/drivers/xen/grant-dma-ops.c b/drivers/xen/grant-dma-ops.c
index c2603e700178..1b7696b2d762 100644
--- a/drivers/xen/grant-dma-ops.c
+++ b/drivers/xen/grant-dma-ops.c
@@ -325,8 +325,7 @@ static int xen_dt_grant_init_backend_domid(struct device *dev,
struct pci_dev *pdev = to_pci_dev(dev);
u32 rid = PCI_DEVID(pdev->bus->number, pdev->devfn);
- if (of_map_id(np, rid, "iommu-map", "iommu-map-mask", &iommu_spec.np,
- iommu_spec.args)) {
+ if (of_map_iommu_id(np, rid, &iommu_spec.np, iommu_spec.args)) {
dev_dbg(dev, "Cannot translate ID\n");
return -ESRCH;
}
diff --git a/include/linux/of.h b/include/linux/of.h
index be6ec4916adf..824649867810 100644
--- a/include/linux/of.h
+++ b/include/linux/of.h
@@ -1457,6 +1457,20 @@ static inline int of_property_read_s32(const struct device_node *np,
return of_property_read_u32(np, propname, (u32*) out_value);
}
+static inline int of_map_iommu_id(const struct device_node *np, u32 id,
+ struct device_node **target, u32 *id_out)
+{
+ return of_map_id(np, id, "iommu-map", "iommu-map-mask",
+ target, id_out);
+}
+
+static inline int of_map_msi_id(const struct device_node *np, u32 id,
+ struct device_node **target, u32 *id_out)
+{
+ return of_map_id(np, id, "msi-map", "msi-map-mask",
+ target, id_out);
+}
+
#define of_for_each_phandle(it, err, np, ln, cn, cc) \
for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
err = of_phandle_iterator_next(it); \
--
2.34.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [RESEND,v8 2/3] of: factor arguments passed to of_map_id() into a struct
2026-02-26 7:42 [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 1/3] of: Add convenience wrappers for of_map_id() Vijayanand Jitta
@ 2026-02-26 7:42 ` Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 3/3] of: Respect #{iommu,msi}-cells in maps Vijayanand Jitta
2026-02-27 22:29 ` [RESEND,v8 0/3] of: parsing of multi " Bryan O'Donoghue
3 siblings, 0 replies; 6+ messages in thread
From: Vijayanand Jitta @ 2026-02-26 7:42 UTC (permalink / raw)
To: robin.murphy, will, joro, robh, dmitry.baryshkov, konrad.dybcio,
bjorn.andersson, bod, conor+dt, krzk+dt, prakash.gupta,
vikash.garodia
Cc: iommu, linux-kernel, devicetree, Charan Teja Kalla,
Vijayanand Jitta
From: Charan Teja Kalla <charan.kalla@oss.qualcomm.com>
Change of_map_id() to take a pointer to struct of_phandle_args
instead of passing target device node and translated IDs separately.
Update all callers accordingly.
Subsequent patch will make use of the args_count field in
struct of_phandle_args.
Suggested-by: Rob Herring (Arm) <robh@kernel.org>
Signed-off-by: Charan Teja Kalla <charan.kalla@oss.qualcomm.com>
Signed-off-by: Vijayanand Jitta <vijayanand.jitta@oss.qualcomm.com>
---
drivers/iommu/of_iommu.c | 2 +-
drivers/of/base.c | 37 +++++++++++++--------------
drivers/pci/controller/dwc/pci-imx6.c | 8 +++++-
drivers/pci/controller/pcie-apple.c | 4 ++-
drivers/xen/grant-dma-ops.c | 2 +-
include/linux/of.h | 21 ++++++++++-----
6 files changed, 44 insertions(+), 30 deletions(-)
diff --git a/drivers/iommu/of_iommu.c b/drivers/iommu/of_iommu.c
index a511ecf21fcd..d255d0f58e8c 100644
--- a/drivers/iommu/of_iommu.c
+++ b/drivers/iommu/of_iommu.c
@@ -48,7 +48,7 @@ static int of_iommu_configure_dev_id(struct device_node *master_np,
struct of_phandle_args iommu_spec = { .args_count = 1 };
int err;
- err = of_map_iommu_id(master_np, *id, &iommu_spec.np, iommu_spec.args);
+ err = of_map_iommu_id(master_np, *id, &iommu_spec);
if (err)
return err;
diff --git a/drivers/of/base.c b/drivers/of/base.c
index 57420806c1a2..6c3628255908 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -2102,8 +2102,11 @@ int of_find_last_cache_level(unsigned int cpu)
* @id: device ID to map.
* @map_name: property name of the map to use.
* @map_mask_name: optional property name of the mask to use.
- * @target: optional pointer to a target device node.
- * @id_out: optional pointer to receive the translated ID.
+ * @arg: of_phandle_args structure,
+ * which includes:
+ * np: pointer to the target device node
+ * args_count: number of arguments
+ * args[]: array to receive the translated ID(s).
*
* Given a device ID, look up the appropriate implementation-defined
* platform ID and/or the target device which receives transactions on that
@@ -2117,21 +2120,21 @@ int of_find_last_cache_level(unsigned int cpu)
*/
int of_map_id(const struct device_node *np, u32 id,
const char *map_name, const char *map_mask_name,
- struct device_node **target, u32 *id_out)
+ struct of_phandle_args *arg)
{
u32 map_mask, masked_id;
int map_len;
const __be32 *map = NULL;
- if (!np || !map_name || (!target && !id_out))
+ if (!np || !map_name || !arg)
return -EINVAL;
map = of_get_property(np, map_name, &map_len);
if (!map) {
- if (target)
+ if (arg->np)
return -ENODEV;
/* Otherwise, no map implies no translation */
- *id_out = id;
+ arg->args[0] = id;
return 0;
}
@@ -2173,18 +2176,15 @@ int of_map_id(const struct device_node *np, u32 id,
if (!phandle_node)
return -ENODEV;
- if (target) {
- if (*target)
- of_node_put(phandle_node);
- else
- *target = phandle_node;
+ if (arg->np)
+ of_node_put(phandle_node);
+ else
+ arg->np = phandle_node;
- if (*target != phandle_node)
- continue;
- }
+ if (arg->np != phandle_node)
+ continue;
- if (id_out)
- *id_out = masked_id - id_base + out_base;
+ arg->args[0] = masked_id - id_base + out_base;
pr_debug("%pOF: %s, using mask %08x, id-base: %08x, out-base: %08x, length: %08x, id: %08x -> %08x\n",
np, map_name, map_mask, id_base, out_base,
@@ -2193,11 +2193,10 @@ int of_map_id(const struct device_node *np, u32 id,
}
pr_info("%pOF: no %s translation for id 0x%x on %pOF\n", np, map_name,
- id, target && *target ? *target : NULL);
+ id, arg->np ? arg->np : NULL);
/* Bypasses translation */
- if (id_out)
- *id_out = id;
+ arg->args[0] = id;
return 0;
}
EXPORT_SYMBOL_GPL(of_map_id);
diff --git a/drivers/pci/controller/dwc/pci-imx6.c b/drivers/pci/controller/dwc/pci-imx6.c
index bff8289f804a..74fc603b3f84 100644
--- a/drivers/pci/controller/dwc/pci-imx6.c
+++ b/drivers/pci/controller/dwc/pci-imx6.c
@@ -1139,12 +1139,18 @@ static int imx_pcie_add_lut_by_rid(struct imx_pcie *imx_pcie, u32 rid)
{
struct device *dev = imx_pcie->pci->dev;
struct device_node *target;
+ struct of_phandle_args iommu_spec = { .args_count = 1 };
u32 sid_i, sid_m;
int err_i, err_m;
u32 sid = 0;
target = NULL;
- err_i = of_map_iommu_id(dev->of_node, rid, &target, &sid_i);
+ err_i = of_map_iommu_id(dev->of_node, rid, &iommu_spec);
+ if (!err_i) {
+ target = iommu_spec.np;
+ sid_i = iommu_spec.args[0];
+ }
+
if (target) {
of_node_put(target);
} else {
diff --git a/drivers/pci/controller/pcie-apple.c b/drivers/pci/controller/pcie-apple.c
index a0937b7b3c4d..e1d4b37d200d 100644
--- a/drivers/pci/controller/pcie-apple.c
+++ b/drivers/pci/controller/pcie-apple.c
@@ -755,6 +755,7 @@ static int apple_pcie_enable_device(struct pci_host_bridge *bridge, struct pci_d
{
u32 sid, rid = pci_dev_id(pdev);
struct apple_pcie_port *port;
+ struct of_phandle_args iommu_spec = { .args_count = 1 };
int idx, err;
port = apple_pcie_get_port(pdev);
@@ -764,10 +765,11 @@ static int apple_pcie_enable_device(struct pci_host_bridge *bridge, struct pci_d
dev_dbg(&pdev->dev, "added to bus %s, index %d\n",
pci_name(pdev->bus->self), port->idx);
- err = of_map_iommu_id(port->pcie->dev->of_node, rid, NULL, &sid);
+ err = of_map_iommu_id(port->pcie->dev->of_node, rid, &iommu_spec);
if (err)
return err;
+ sid = iommu_spec.args[0];
mutex_lock(&port->pcie->lock);
idx = bitmap_find_free_region(port->sid_map, port->sid_map_sz, 0);
diff --git a/drivers/xen/grant-dma-ops.c b/drivers/xen/grant-dma-ops.c
index 1b7696b2d762..5f1d6540049a 100644
--- a/drivers/xen/grant-dma-ops.c
+++ b/drivers/xen/grant-dma-ops.c
@@ -325,7 +325,7 @@ static int xen_dt_grant_init_backend_domid(struct device *dev,
struct pci_dev *pdev = to_pci_dev(dev);
u32 rid = PCI_DEVID(pdev->bus->number, pdev->devfn);
- if (of_map_iommu_id(np, rid, &iommu_spec.np, iommu_spec.args)) {
+ if (of_map_iommu_id(np, rid, &iommu_spec)) {
dev_dbg(dev, "Cannot translate ID\n");
return -ESRCH;
}
diff --git a/include/linux/of.h b/include/linux/of.h
index 824649867810..9d72d76f909d 100644
--- a/include/linux/of.h
+++ b/include/linux/of.h
@@ -463,7 +463,7 @@ bool of_console_check(const struct device_node *dn, char *name, int index);
int of_map_id(const struct device_node *np, u32 id,
const char *map_name, const char *map_mask_name,
- struct device_node **target, u32 *id_out);
+ struct of_phandle_args *arg);
phys_addr_t of_dma_get_max_cpu_address(struct device_node *np);
@@ -929,7 +929,7 @@ static inline void of_property_clear_flag(struct property *p, unsigned long flag
static inline int of_map_id(const struct device_node *np, u32 id,
const char *map_name, const char *map_mask_name,
- struct device_node **target, u32 *id_out)
+ struct of_phandle_args *arg)
{
return -EINVAL;
}
@@ -1458,17 +1458,24 @@ static inline int of_property_read_s32(const struct device_node *np,
}
static inline int of_map_iommu_id(const struct device_node *np, u32 id,
- struct device_node **target, u32 *id_out)
+ struct of_phandle_args *arg)
{
- return of_map_id(np, id, "iommu-map", "iommu-map-mask",
- target, id_out);
+ return of_map_id(np, id, "iommu-map", "iommu-map-mask", arg);
}
static inline int of_map_msi_id(const struct device_node *np, u32 id,
struct device_node **target, u32 *id_out)
{
- return of_map_id(np, id, "msi-map", "msi-map-mask",
- target, id_out);
+ struct of_phandle_args msi_spec = { .np = *target, .args_count = 1 };
+ int ret;
+
+ ret = of_map_id(np, id, "msi-map", "msi-map-mask", &msi_spec);
+ if (!ret) {
+ *target = msi_spec.np;
+ *id_out = msi_spec.args[0];
+ }
+
+ return ret;
}
#define of_for_each_phandle(it, err, np, ln, cn, cc) \
--
2.34.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [RESEND,v8 3/3] of: Respect #{iommu,msi}-cells in maps
2026-02-26 7:42 [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 1/3] of: Add convenience wrappers for of_map_id() Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 2/3] of: factor arguments passed to of_map_id() into a struct Vijayanand Jitta
@ 2026-02-26 7:42 ` Vijayanand Jitta
2026-02-27 22:29 ` [RESEND,v8 0/3] of: parsing of multi " Bryan O'Donoghue
3 siblings, 0 replies; 6+ messages in thread
From: Vijayanand Jitta @ 2026-02-26 7:42 UTC (permalink / raw)
To: robin.murphy, will, joro, robh, dmitry.baryshkov, konrad.dybcio,
bjorn.andersson, bod, conor+dt, krzk+dt, prakash.gupta,
vikash.garodia
Cc: iommu, linux-kernel, devicetree, Charan Teja Kalla,
Vijayanand Jitta
From: Robin Murphy <robin.murphy@arm.com>
So far our parsing of {iommu,msi}-map properites has always blindly
assumed that the output specifiers will always have exactly 1 cell.
This typically does happen to be the case, but is not actually enforced
(and the PCI msi-map binding even explicitly states support for 0 or 1
cells) - as a result we've now ended up with dodgy DTs out in the field
which depend on this behaviour to map a 1-cell specifier for a 2-cell
provider, despite that being bogus per the bindings themselves.
Since there is some potential use in being able to map at least single
input IDs to multi-cell output specifiers (and properly support 0-cell
outputs as well), add support for properly parsing and using the target
nodes' #cells values, albeit with the unfortunate complication of still
having to work around expectations of the old behaviour too.
Since there are multi-cell output specifiers, the callers of of_map_id()
may need to get the exact cell output value for further processing.
Added support for that part --charan
Signed-off-by: Robin Murphy <robin.murphy@arm.com>
Signed-off-by: Charan Teja Kalla <charan.kalla@oss.qualcomm.com>
Signed-off-by: Vijayanand Jitta <vijayanand.jitta@oss.qualcomm.com>
---
drivers/iommu/of_iommu.c | 2 +-
drivers/of/base.c | 117 +++++++++++++++++++++++++++++++--------
include/linux/of.h | 16 +++---
3 files changed, 102 insertions(+), 33 deletions(-)
diff --git a/drivers/iommu/of_iommu.c b/drivers/iommu/of_iommu.c
index d255d0f58e8c..a18bb60f6f3d 100644
--- a/drivers/iommu/of_iommu.c
+++ b/drivers/iommu/of_iommu.c
@@ -45,7 +45,7 @@ static int of_iommu_configure_dev_id(struct device_node *master_np,
struct device *dev,
const u32 *id)
{
- struct of_phandle_args iommu_spec = { .args_count = 1 };
+ struct of_phandle_args iommu_spec = {};
int err;
err = of_map_iommu_id(master_np, *id, &iommu_spec);
diff --git a/drivers/of/base.c b/drivers/of/base.c
index 6c3628255908..596bcf993dcb 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -2096,11 +2096,38 @@ int of_find_last_cache_level(unsigned int cpu)
return cache_level;
}
+/*
+ * Some DTs have an iommu-map targeting a 2-cell IOMMU node while
+ * specifying only 1 cell. Fortunately they all consist of value '1'
+ * as the 2nd cell entry with the same target, so check for that pattern.
+ *
+ * Example:
+ * IOMMU node:
+ * #iommu-cells = <2>;
+ *
+ * Device node:
+ * iommu-map = <0x0000 &smmu 0x0000 0x1>,
+ * <0x0100 &smmu 0x0100 0x1>;
+ */
+static bool of_check_bad_map(const __be32 *map, int len)
+{
+ __be32 phandle = map[1];
+
+ if (len % 4)
+ return false;
+ for (int i = 0; i < len; i += 4) {
+ if (map[i + 1] != phandle || map[i + 3] != cpu_to_be32(1))
+ return false;
+ }
+ return true;
+}
+
/**
* of_map_id - Translate an ID through a downstream mapping.
* @np: root complex device node.
* @id: device ID to map.
* @map_name: property name of the map to use.
+ * @cells_name: property name of target specifier cells.
* @map_mask_name: optional property name of the mask to use.
* @arg: of_phandle_args structure,
* which includes:
@@ -2118,18 +2145,19 @@ int of_find_last_cache_level(unsigned int cpu)
*
* Return: 0 on success or a standard error code on failure.
*/
-int of_map_id(const struct device_node *np, u32 id,
- const char *map_name, const char *map_mask_name,
- struct of_phandle_args *arg)
+int of_map_id(const struct device_node *np, u32 id, const char *map_name,
+ const char *cells_name, const char *map_mask_name,
+ struct of_phandle_args *arg)
{
u32 map_mask, masked_id;
- int map_len;
+ int map_bytes, map_len, offset = 0;
+ bool bad_map = false;
const __be32 *map = NULL;
if (!np || !map_name || !arg)
return -EINVAL;
- map = of_get_property(np, map_name, &map_len);
+ map = of_get_property(np, map_name, &map_bytes);
if (!map) {
if (arg->np)
return -ENODEV;
@@ -2138,11 +2166,9 @@ int of_map_id(const struct device_node *np, u32 id,
return 0;
}
- if (!map_len || map_len % (4 * sizeof(*map))) {
- pr_err("%pOF: Error: Bad %s length: %d\n", np,
- map_name, map_len);
- return -EINVAL;
- }
+ if (map_bytes % sizeof(*map))
+ goto err_map_len;
+ map_len = map_bytes / sizeof(*map);
/* The default is to select all bits. */
map_mask = 0xffffffff;
@@ -2155,27 +2181,63 @@ int of_map_id(const struct device_node *np, u32 id,
of_property_read_u32(np, map_mask_name, &map_mask);
masked_id = map_mask & id;
- for ( ; map_len > 0; map_len -= 4 * sizeof(*map), map += 4) {
+
+ while (offset < map_len) {
struct device_node *phandle_node;
- u32 id_base = be32_to_cpup(map + 0);
- u32 phandle = be32_to_cpup(map + 1);
- u32 out_base = be32_to_cpup(map + 2);
- u32 id_len = be32_to_cpup(map + 3);
+ u32 id_base, phandle, id_len, id_off, cells = 0;
+ const __be32 *out_base;
+
+ if (map_len - offset < 2)
+ goto err_map_len;
+
+ id_base = be32_to_cpup(map + offset);
if (id_base & ~map_mask) {
- pr_err("%pOF: Invalid %s translation - %s-mask (0x%x) ignores id-base (0x%x)\n",
- np, map_name, map_name,
- map_mask, id_base);
+ pr_err("%pOF: Invalid %s translation - %s (0x%x) ignores id-base (0x%x)\n",
+ np, map_name, map_mask_name, map_mask, id_base);
return -EFAULT;
}
- if (masked_id < id_base || masked_id >= id_base + id_len)
- continue;
-
+ phandle = be32_to_cpup(map + offset + 1);
phandle_node = of_find_node_by_phandle(phandle);
if (!phandle_node)
return -ENODEV;
+ if (!bad_map && of_property_read_u32(phandle_node, cells_name, &cells)) {
+ pr_err("%pOF: missing %s property\n", phandle_node, cells_name);
+ return -EINVAL;
+ }
+
+ if (map_len - offset < 3 + cells)
+ goto err_map_len;
+
+ if (offset == 0 && cells == 2) {
+ bad_map = of_check_bad_map(map, map_len);
+ if (bad_map) {
+ pr_warn_once("%pOF: %s mismatches target %s, assuming extra cell of 0\n",
+ np, map_name, cells_name);
+ cells = 1;
+ }
+ }
+
+ out_base = map + offset + 2;
+ offset += 3 + cells;
+
+ id_len = be32_to_cpup(map + offset - 1);
+ if (id_len > 1 && cells > 1) {
+ /*
+ * With 1 output cell we reasonably assume its value
+ * has a linear relationship to the input; with more,
+ * we'd need help from the provider to know what to do.
+ */
+ pr_err("%pOF: Unsupported %s - cannot handle %d-ID range with %d-cell output specifier\n",
+ np, map_name, id_len, cells);
+ return -EINVAL;
+ }
+ id_off = masked_id - id_base;
+ if (masked_id < id_base || id_off >= id_len)
+ continue;
+
if (arg->np)
of_node_put(phandle_node);
else
@@ -2184,11 +2246,14 @@ int of_map_id(const struct device_node *np, u32 id,
if (arg->np != phandle_node)
continue;
- arg->args[0] = masked_id - id_base + out_base;
+ for (int i = 0; i < cells; i++)
+ arg->args[i] = (id_off + be32_to_cpu(out_base[i]));
+
+ arg->args_count = cells;
pr_debug("%pOF: %s, using mask %08x, id-base: %08x, out-base: %08x, length: %08x, id: %08x -> %08x\n",
- np, map_name, map_mask, id_base, out_base,
- id_len, id, masked_id - id_base + out_base);
+ np, map_name, map_mask, id_base, be32_to_cpup(out_base),
+ id_len, id, id_off + be32_to_cpup(out_base));
return 0;
}
@@ -2198,5 +2263,9 @@ int of_map_id(const struct device_node *np, u32 id,
/* Bypasses translation */
arg->args[0] = id;
return 0;
+
+err_map_len:
+ pr_err("%pOF: Error: Bad %s length: %d\n", np, map_name, map_bytes);
+ return -EINVAL;
}
EXPORT_SYMBOL_GPL(of_map_id);
diff --git a/include/linux/of.h b/include/linux/of.h
index 9d72d76f909d..5b5b5dc2d3f3 100644
--- a/include/linux/of.h
+++ b/include/linux/of.h
@@ -461,9 +461,9 @@ const char *of_prop_next_string(const struct property *prop, const char *cur);
bool of_console_check(const struct device_node *dn, char *name, int index);
-int of_map_id(const struct device_node *np, u32 id,
- const char *map_name, const char *map_mask_name,
- struct of_phandle_args *arg);
+int of_map_id(const struct device_node *np, u32 id, const char *map_name,
+ const char *cells_name, const char *map_mask_name,
+ struct of_phandle_args *arg);
phys_addr_t of_dma_get_max_cpu_address(struct device_node *np);
@@ -927,9 +927,9 @@ static inline void of_property_clear_flag(struct property *p, unsigned long flag
{
}
-static inline int of_map_id(const struct device_node *np, u32 id,
- const char *map_name, const char *map_mask_name,
- struct of_phandle_args *arg)
+static inline int of_map_id(const struct device_node *np, u32 id, const char *map_name,
+ const char *cells_name, const char *map_mask_name,
+ struct of_phandle_args *arg)
{
return -EINVAL;
}
@@ -1460,7 +1460,7 @@ static inline int of_property_read_s32(const struct device_node *np,
static inline int of_map_iommu_id(const struct device_node *np, u32 id,
struct of_phandle_args *arg)
{
- return of_map_id(np, id, "iommu-map", "iommu-map-mask", arg);
+ return of_map_id(np, id, "iommu-map", "#iommu-cells", "iommu-map-mask", arg);
}
static inline int of_map_msi_id(const struct device_node *np, u32 id,
@@ -1469,7 +1469,7 @@ static inline int of_map_msi_id(const struct device_node *np, u32 id,
struct of_phandle_args msi_spec = { .np = *target, .args_count = 1 };
int ret;
- ret = of_map_id(np, id, "msi-map", "msi-map-mask", &msi_spec);
+ ret = of_map_id(np, id, "msi-map", "#msi-cells", "msi-map-mask", &msi_spec);
if (!ret) {
*target = msi_spec.np;
*id_out = msi_spec.args[0];
--
2.34.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps
2026-02-26 7:42 [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps Vijayanand Jitta
` (2 preceding siblings ...)
2026-02-26 7:42 ` [RESEND,v8 3/3] of: Respect #{iommu,msi}-cells in maps Vijayanand Jitta
@ 2026-02-27 22:29 ` Bryan O'Donoghue
2026-03-01 8:39 ` Vijayanand Jitta
3 siblings, 1 reply; 6+ messages in thread
From: Bryan O'Donoghue @ 2026-02-27 22:29 UTC (permalink / raw)
To: vijayanand.jitta, robin.murphy, will, joro, robh,
dmitry.baryshkov, konrad.dybcio, bjorn.andersson, bod, conor+dt,
krzk+dt, prakash.gupta, vikash.garodia
Cc: iommu, linux-kernel, devicetree
You're missing a significant number of maintainers.
https://lore.kernel.org/all/20260226074245.3098486-1-vijayanand.jitta@oss.qualcomm.com/
From: Vijayanand Jitta <vijayanand.jitta@oss.qualcomm.com>
To: robin.murphy@arm.com, will@kernel.org, joro@8bytes.org,
robh@kernel.org, dmitry.baryshkov@oss.qualcomm.com,
konrad.dybcio@oss.qualcomm.com, bjorn.andersson@oss.qualcomm.com,
bod@kernel.org, conor+dt@kernel.org, krzk+dt@kernel.org,
prakash.gupta@oss.qualcomm.com, vikash.garodia@oss.qualcomm.com
Cc: iommu@lists.linux.dev, linux-kernel@vger.kernel.org,
devicetree@vger.kernel.org,
Vijayanand Jitta <vijayanand.jitta@oss.qualcomm.com>
Subject: [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps
Date: Thu, 26 Feb 2026 13:12:42 +0530 [thread overview]
Message-ID: <20260226074245.3098486-1-vijayanand.jitta@oss.qualcomm.com>
(raw)
There's no point in resending since you aren't mailing the right list of
people right now
deckard@sagittarius-a:~/Development/worktree/reviews/linux-next-reviews
(linux-next-reviews) $ scripts/get_maintainer.pl
0001-of-Add-convenience-wrappers-for-of_map_id.patch
Nipun Gupta <nipun.gupta@amd.com> (maintainer:AMD CDX BUS DRIVER)
Nikhil Agarwal <nikhil.agarwal@amd.com> (maintainer:AMD CDX BUS DRIVER)
<snip>
Please run scripts/get_maintainer.pl on each of your patches and include
the right set.
---
bod
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps
2026-02-27 22:29 ` [RESEND,v8 0/3] of: parsing of multi " Bryan O'Donoghue
@ 2026-03-01 8:39 ` Vijayanand Jitta
0 siblings, 0 replies; 6+ messages in thread
From: Vijayanand Jitta @ 2026-03-01 8:39 UTC (permalink / raw)
To: Bryan O'Donoghue, robin.murphy, will, joro, robh,
dmitry.baryshkov, konrad.dybcio, bjorn.andersson, conor+dt,
krzk+dt, prakash.gupta, vikash.garodia
Cc: iommu, linux-kernel, devicetree
On 2/28/2026 3:59 AM, Bryan O'Donoghue wrote:
>
> You're missing a significant number of maintainers.
>
> https://lore.kernel.org/all/20260226074245.3098486-1-vijayanand.jitta@oss.qualcomm.com/
>
> From: Vijayanand Jitta <vijayanand.jitta@oss.qualcomm.com>
> To: robin.murphy@arm.com, will@kernel.org, joro@8bytes.org,
> robh@kernel.org, dmitry.baryshkov@oss.qualcomm.com,
> konrad.dybcio@oss.qualcomm.com, bjorn.andersson@oss.qualcomm.com,
> bod@kernel.org, conor+dt@kernel.org, krzk+dt@kernel.org,
> prakash.gupta@oss.qualcomm.com, vikash.garodia@oss.qualcomm.com
> Cc: iommu@lists.linux.dev, linux-kernel@vger.kernel.org,
> devicetree@vger.kernel.org,
> Vijayanand Jitta <vijayanand.jitta@oss.qualcomm.com>
> Subject: [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps
> Date: Thu, 26 Feb 2026 13:12:42 +0530 [thread overview]
> Message-ID: <20260226074245.3098486-1-vijayanand.jitta@oss.qualcomm.com> (raw)
>
> There's no point in resending since you aren't mailing the right list of people right now
>
> deckard@sagittarius-a:~/Development/worktree/reviews/linux-next-reviews (linux-next-reviews) $ scripts/get_maintainer.pl 0001-of-Add-convenience-wrappers-for-of_map_id.patch
> Nipun Gupta <nipun.gupta@amd.com> (maintainer:AMD CDX BUS DRIVER)
> Nikhil Agarwal <nikhil.agarwal@amd.com> (maintainer:AMD CDX BUS DRIVER)
>
> <snip>
>
> Please run scripts/get_maintainer.pl on each of your patches and include the right set.
>
> ---
> bod
Thanks for pointing this out.
I have sent v9 including all the relevant maintainers.
Thanks,
Vijay
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2026-03-01 8:39 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-02-26 7:42 [RESEND,v8 0/3] of: parsing of multi #{iommu,msi}-cells in maps Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 1/3] of: Add convenience wrappers for of_map_id() Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 2/3] of: factor arguments passed to of_map_id() into a struct Vijayanand Jitta
2026-02-26 7:42 ` [RESEND,v8 3/3] of: Respect #{iommu,msi}-cells in maps Vijayanand Jitta
2026-02-27 22:29 ` [RESEND,v8 0/3] of: parsing of multi " Bryan O'Donoghue
2026-03-01 8:39 ` Vijayanand Jitta
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox