From: Johannes Berg <johannes.berg@intel.com>
Date: Fri, 27 Feb 2015 14:32:43 +0000 (+0100)
Subject: nl80211: add notes about userspace API/ABI modifications
X-Git-Tag: firefly_0821_release~176^2~1974^2~105^2~57
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=5fc7432991a86678b38a2d700edbe8bcd29cc579;p=firefly-linux-kernel-4.4.55.git

nl80211: add notes about userspace API/ABI modifications

Add notes about userspace ABI/API modifications, including the
fact that we decided that API submissions should come with a
driver implementation.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
---

diff --git a/include/uapi/linux/nl80211.h b/include/uapi/linux/nl80211.h
index 8ee31f108407..90c5aeb3cca7 100644
--- a/include/uapi/linux/nl80211.h
+++ b/include/uapi/linux/nl80211.h
@@ -25,6 +25,19 @@
  *
  */
 
+/*
+ * This header file defines the userspace API to the wireless stack. Please
+ * be careful not to break things - i.e. don't move anything around or so
+ * unless you can demonstrate that it breaks neither API nor ABI.
+ *
+ * Additions to the API should be accompanied by actual implementations in
+ * an upstream driver, so that example implementations exist in case there
+ * are ever concerns about the precise semantics of the API or changes are
+ * needed, and to ensure that code for dead (no longer implemented) API
+ * can actually be identified and removed.
+ * Nonetheless, semantics should also be documented carefully in this file.
+ */
+
 #include <linux/types.h>
 
 #define NL80211_GENL_NAME "nl80211"