diff mbox series

[v11,1/6] iommu: Add note about struct iommu_fwspec usage

Message ID 20221117182720.2290761-2-thierry.reding@gmail.com (mailing list archive)
State New, archived
Headers show
Series mmc: sdhci: Add Tegra234 support | expand

Commit Message

Thierry Reding Nov. 17, 2022, 6:27 p.m. UTC 
From: Thierry Reding <treding@nvidia.com>

This structure is to be considered private to the IOMMU API. Except for
very few exceptions, IOMMU consumer drivers should treat this as opaque
data.

Signed-off-by: Thierry Reding <treding@nvidia.com>
---
 include/linux/iommu.h | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Joerg Roedel Nov. 19, 2022, 9:51 a.m. UTC | #1 
On Thu, Nov 17, 2022 at 07:27:15PM +0100, Thierry Reding wrote:
> From: Thierry Reding <treding@nvidia.com>
> 
> This structure is to be considered private to the IOMMU API. Except for
> very few exceptions, IOMMU consumer drivers should treat this as opaque
> data.
> 
> Signed-off-by: Thierry Reding <treding@nvidia.com>
> ---
>  include/linux/iommu.h | 4 ++++
>  1 file changed, 4 insertions(+)

We should probably hiding the structure outside the IOMMU world then.
But that's another path to go, so

Acked-by: Joerg Roedel <jroedel@suse.de>
diff mbox series

Patch

diff --git a/include/linux/iommu.h b/include/linux/iommu.h
index 1690c334e516..dc5e6f5c14fc 100644
--- a/include/linux/iommu.h
+++ b/include/linux/iommu.h
@@ -641,6 +641,10 @@  struct iommu_group *fsl_mc_device_group(struct device *dev);
  * @flags: IOMMU_FWSPEC_* flags
  * @num_ids: number of associated device IDs
  * @ids: IDs which this device may present to the IOMMU
+ *
+ * Note that the IDs (and any other information, really) stored in this structure should be
+ * considered private to the IOMMU device driver and are not to be used directly by IOMMU
+ * consumers.
  */
 struct iommu_fwspec {
 	const struct iommu_ops	*ops;