include/linux/iio/trigger.h

   1 /* The industrial I/O core, trigger handling functions
   2  *
   3  * Copyright (c) 2008 Jonathan Cameron
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published by
   7  * the Free Software Foundation.
   8  */
   9 #include <linux/irq.h>
  10 #include <linux/module.h>
  11
  12 #ifndef _IIO_TRIGGER_H_
  13 #define _IIO_TRIGGER_H_
  14
  15 #ifdef CONFIG_IIO_TRIGGER
  16 struct iio_subirq {
  17         bool enabled;
  18 };
  19
  20 /**
  21  * struct iio_trigger_ops - operations structure for an iio_trigger.
  22  * @owner:              used to monitor usage count of the trigger.
  23  * @set_trigger_state:  switch on/off the trigger on demand
  24  * @try_reenable:       function to reenable the trigger when the
  25  *                      use count is zero (may be NULL)
  26  * @validate_device:    function to validate the device when the
  27  *                      current trigger gets changed.
  28  *
  29  * This is typically static const within a driver and shared by
  30  * instances of a given device.
  31  **/
  32 struct iio_trigger_ops {
  33         struct module *owner;
  34         int (*set_trigger_state)(struct iio_trigger *trig, bool state);
  35         int (*try_reenable)(struct iio_trigger *trig);
  36         int (*validate_device)(struct iio_trigger *trig,
  37                                struct iio_dev *indio_dev);
  38 };
  39
  40
  41 /**
  42  * struct iio_trigger - industrial I/O trigger device
  43  * @ops:                [DRIVER] operations structure
  44  * @id:                 [INTERN] unique id number
  45  * @name:               [DRIVER] unique name
  46  * @dev:                [DRIVER] associated device (if relevant)
  47  * @list:               [INTERN] used in maintenance of global trigger list
  48  * @alloc_list:         [DRIVER] used for driver specific trigger list
  49  * @use_count:          use count for the trigger
  50  * @subirq_chip:        [INTERN] associate 'virtual' irq chip.
  51  * @subirq_base:        [INTERN] base number for irqs provided by trigger.
  52  * @subirqs:            [INTERN] information about the 'child' irqs.
  53  * @pool:               [INTERN] bitmap of irqs currently in use.
  54  * @pool_lock:          [INTERN] protection of the irq pool.
  55  **/
  56 struct iio_trigger {
  57         const struct iio_trigger_ops    *ops;
  58         int                             id;
  59         const char                      *name;
  60         struct device                   dev;
  61
  62         struct list_head                list;
  63         struct list_head                alloc_list;
  64         int use_count;
  65
  66         struct irq_chip                 subirq_chip;
  67         int                             subirq_base;
  68
  69         struct iio_subirq subirqs[CONFIG_IIO_CONSUMERS_PER_TRIGGER];
  70         unsigned long pool[BITS_TO_LONGS(CONFIG_IIO_CONSUMERS_PER_TRIGGER)];
  71         struct mutex                    pool_lock;
  72 };
  73
  74
  75 static inline struct iio_trigger *to_iio_trigger(struct device *d)
  76 {
  77         return container_of(d, struct iio_trigger, dev);
  78 }
  79
  80 static inline void iio_trigger_put(struct iio_trigger *trig)
  81 {
  82         module_put(trig->ops->owner);
  83         put_device(&trig->dev);
  84 }
  85
  86 static inline void iio_trigger_get(struct iio_trigger *trig)
  87 {
  88         get_device(&trig->dev);
  89         __module_get(trig->ops->owner);
  90 }
  91
  92 /**
  93  * iio_device_set_drvdata() - Set trigger driver data
  94  * @trig: IIO trigger structure
  95  * @data: Driver specific data
  96  *
  97  * Allows to attach an arbitrary pointer to an IIO trigger, which can later be
  98  * retrieved by iio_trigger_get_drvdata().
  99  */
 100 static inline void iio_trigger_set_drvdata(struct iio_trigger *trig, void *data)
 101 {
 102         dev_set_drvdata(&trig->dev, data);
 103 }
 104
 105 /**
 106  * iio_trigger_get_drvdata() - Get trigger driver data
 107  * @trig: IIO trigger structure
 108  *
 109  * Returns the data previously set with iio_trigger_set_drvdata()
 110  */
 111 static inline void *iio_trigger_get_drvdata(struct iio_trigger *trig)
 112 {
 113         return dev_get_drvdata(&trig->dev);
 114 }
 115
 116 /**
 117  * iio_trigger_register() - register a trigger with the IIO core
 118  * @trig_info:  trigger to be registered
 119  **/
 120 int iio_trigger_register(struct iio_trigger *trig_info);
 121
 122 /**
 123  * iio_trigger_unregister() - unregister a trigger from the core
 124  * @trig_info:  trigger to be unregistered
 125  **/
 126 void iio_trigger_unregister(struct iio_trigger *trig_info);
 127
 128 /**
 129  * iio_trigger_poll() - called on a trigger occurring
 130  * @trig:       trigger which occurred
 131  * @time:       timestamp when trigger occurred
 132  *
 133  * Typically called in relevant hardware interrupt handler.
 134  **/
 135 void iio_trigger_poll(struct iio_trigger *trig, s64 time);
 136 void iio_trigger_poll_chained(struct iio_trigger *trig, s64 time);
 137
 138 irqreturn_t iio_trigger_generic_data_rdy_poll(int irq, void *private);
 139
 140 __printf(1, 2) struct iio_trigger *iio_trigger_alloc(const char *fmt, ...);
 141 void iio_trigger_free(struct iio_trigger *trig);
 142
 143 #else
 144 struct iio_trigger;
 145 struct iio_trigger_ops;
 146 #endif
 147 #endif /* _IIO_TRIGGER_H_ */