2021-11-27 01:31:57

by Thomas Gleixner

[permalink] [raw]
Subject: [patch 30/32] genirq/msi: Add abuse prevention comment to msi header

Signed-off-by: Thomas Gleixner <[email protected]>
---
include/linux/msi.h | 14 ++++++++++++++
1 file changed, 14 insertions(+)

--- a/include/linux/msi.h
+++ b/include/linux/msi.h
@@ -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/spinlock.h>
#include <linux/mutex.h>
#include <linux/list.h>