Document the different parameters of the IIO_EVENT_CODE macro and friends. Signed-off-by: Lars-Peter Clausen <lars@xxxxxxxxxx> --- I'm adding this to get a clear definition of what each field is for, because currently there are somewhat contradicting usages of this macro. So I'm not quite sure if this is the correct documentation. --- drivers/staging/iio/events.h | 29 +++++++++++++++++++++++++++++ 1 files changed, 29 insertions(+), 0 deletions(-) diff --git a/drivers/staging/iio/events.h b/drivers/staging/iio/events.h index 389c781..520a20e 100644 --- a/drivers/staging/iio/events.h +++ b/drivers/staging/iio/events.h @@ -40,6 +40,18 @@ enum iio_event_direction { IIO_EV_DIR_FALLING, }; +/** + * 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. + * @direction: Direction of the event. Should be one of enum iio_event_direction. + * @type: Type of the event. Should be one enum iio_event_type. + * @chan: Channel number for non-differential channels. + * @chan1: First channel number for differential channels. + * @chan2: Second channel number for differential channels. + */ + #define IIO_EVENT_CODE(chan_type, diff, modifier, direction, \ type, chan, chan1, chan2) \ (((u64)type << 56) | ((u64)diff << 55) | \ @@ -51,10 +63,27 @@ enum iio_event_direction { #define IIO_EV_BIT(type, direction) \ (1 << (type*IIO_EV_DIR_MAX + direction)) +/** + * IIO_MOD_EVENT_CODE() - create event identifier for modified channels + * @channelclass: Type of the channel. Should be one of enum iio_chan_type. + * @number: Channel number for non-differential channels. + * @modifier: Modifier for the channel. Should be one of enum iio_modifier. + * @type: Type of the event. Should be one enum iio_event_type. + * @direction: Direction of the event. Should be one of enum iio_event_direction. + */ + #define IIO_MOD_EVENT_CODE(channelclass, number, modifier, \ type, direction) \ IIO_EVENT_CODE(channelclass, 0, modifier, direction, type, number, 0, 0) +/** + * IIO_UNMOD_EVENT_CODE() - create event identifier for unmodified channels + * @channelclass: Type of the channel. Should be one of enum iio_chan_type. + * @number: Channel number for non-differential channels. + * @type: Type of the event. Should be one enum iio_event_type. + * @direction: Direction of the event. Should be one of enum iio_event_direction. + */ + #define IIO_UNMOD_EVENT_CODE(channelclass, number, type, direction) \ IIO_EVENT_CODE(channelclass, 0, 0, direction, type, number, 0, 0) -- 1.7.7 -- To unsubscribe from this list: send the line "unsubscribe linux-iio" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html