genirq/msi: Add abuse prevention comment to msi header
authorThomas Gleixner <tglx@linutronix.de>
Mon, 6 Dec 2021 22:51:49 +0000 (23:51 +0100)
committerThomas Gleixner <tglx@linutronix.de>
Thu, 16 Dec 2021 21:22:20 +0000 (22:22 +0100)
Hope dies last.

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Reviewed-by: Jason Gunthorpe <jgg@nvidia.com>
Link: https://lore.kernel.org/r/20211206210749.170847844@linutronix.de
include/linux/msi.h

index b54010b..70cc6a5 100644 (file)
@@ -2,6 +2,20 @@
 #ifndef LINUX_MSI_H
 #define LINUX_MSI_H
 
+/*
+ * This header file contains MSI data structures and functions which are
+ * only relevant for:
+ *     - Interrupt core code
+ *     - PCI/MSI core code
+ *     - MSI interrupt domain implementations
+ *     - IOMMU, low level VFIO, NTB and other justified exceptions
+ *       dealing with low level MSI details.
+ *
+ * Regular device drivers have no business with any of these functions and
+ * especially storing MSI descriptor pointers in random code is considered
+ * abuse. The only function which is relevant for drivers is msi_get_virq().
+ */
+
 #include <linux/cpumask.h>
 #include <linux/mutex.h>
 #include <linux/list.h>