iio: events: make IIO_EVENT_CODE macro private
authorDavid Lechner <dlechner@baylibre.com>
Fri, 1 Nov 2024 22:17:10 +0000 (17:17 -0500)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sun, 3 Nov 2024 20:33:45 +0000 (20:33 +0000)
Make IIO_EVENT_CODE "private" by adding a leading underscore.

There are no more users of this macro in the kernel so we can make it
"private" and encourage developers to use the specialized versions of
the macro instead.

Signed-off-by: David Lechner <dlechner@baylibre.com>
Link: https://patch.msgid.link/20241101-iio-fix-event-macro-use-v1-3-0000c5d09f6d@baylibre.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
include/linux/iio/events.h

index eeaba5e..72062a0 100644 (file)
@@ -10,7 +10,7 @@
 #include <uapi/linux/iio/events.h>
 
 /**
- * IIO_EVENT_CODE() - create event identifier
+ * _IIO_EVENT_CODE() - create event identifier
  * @chan_type: Type of the channel. Should be one of enum iio_chan_type.
  * @diff:      Whether the event is for an differential channel or not.
  * @modifier:  Modifier for the channel. Should be one of enum iio_modifier.
  * @chan:      Channel number for non-differential channels.
  * @chan1:     First channel number for differential channels.
  * @chan2:     Second channel number for differential channels.
+ *
+ * Drivers should use the specialized macros below instead of using this one
+ * directly.
  */
 
-#define IIO_EVENT_CODE(chan_type, diff, modifier, direction,           \
-                      type, chan, chan1, chan2)                        \
+#define _IIO_EVENT_CODE(chan_type, diff, modifier, direction,          \
+                       type, chan, chan1, chan2)                       \
        (((u64)type << 56) | ((u64)diff << 55) |                        \
         ((u64)direction << 48) | ((u64)modifier << 40) |               \
         ((u64)chan_type << 32) | (((u16)chan2) << 16) | ((u16)chan1) | \
@@ -41,7 +44,7 @@
 
 #define IIO_MOD_EVENT_CODE(chan_type, number, modifier,                \
                           type, direction)                             \
-       IIO_EVENT_CODE(chan_type, 0, modifier, direction, type, number, 0, 0)
+       _IIO_EVENT_CODE(chan_type, 0, modifier, direction, type, number, 0, 0)
 
 /**
  * IIO_UNMOD_EVENT_CODE() - create event identifier for unmodified (non
@@ -53,7 +56,7 @@
  */
 
 #define IIO_UNMOD_EVENT_CODE(chan_type, number, type, direction)       \
-       IIO_EVENT_CODE(chan_type, 0, 0, direction, type, number, 0, 0)
+       _IIO_EVENT_CODE(chan_type, 0, 0, direction, type, number, 0, 0)
 
 /**
  * IIO_DIFF_EVENT_CODE() - create event identifier for differential channels
@@ -65,6 +68,6 @@
  */
 
 #define IIO_DIFF_EVENT_CODE(chan_type, chan1, chan2, type, direction)  \
-       IIO_EVENT_CODE(chan_type, 1, 0, direction, type, 0, chan1, chan2)
+       _IIO_EVENT_CODE(chan_type, 1, 0, direction, type, 0, chan1, chan2)
 
 #endif