Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

iio: Improve the kernel-doc of iio_trigger_poll

Move the kernel-doc of the function to industrialio-trigger.c
Add a note on the context where the function is expected to be called.

Signed-off-by: Mehdi Djait <mehdi.djait.k@gmail.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/bd84fc17e9d22eab998bf48720297f9a77689f45.1677761379.git.mehdi.djait.k@gmail.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

authored by

Mehdi Djait and committed by
Jonathan Cameron
4ad682e0 db3c4905

+6 -6
+6
drivers/iio/industrialio-trigger.c
··· 192 192 schedule_work(&trig->reenable_work); 193 193 } 194 194 195 + /** 196 + * iio_trigger_poll() - Call the IRQ trigger handler of the consumers 197 + * @trig: trigger which occurred 198 + * 199 + * This function should only be called from a hard IRQ context. 200 + */ 195 201 void iio_trigger_poll(struct iio_trigger *trig) 196 202 { 197 203 int i;
-6
include/linux/iio/trigger.h
··· 151 151 **/ 152 152 int iio_trigger_set_immutable(struct iio_dev *indio_dev, struct iio_trigger *trig); 153 153 154 - /** 155 - * iio_trigger_poll() - called on a trigger occurring 156 - * @trig: trigger which occurred 157 - * 158 - * Typically called in relevant hardware interrupt handler. 159 - **/ 160 154 void iio_trigger_poll(struct iio_trigger *trig); 161 155 void iio_trigger_poll_chained(struct iio_trigger *trig); 162 156