Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-btrfs-devel.git] / drivers / staging / iio / Documentation / trigger.txt
blobfc2012ebc100a533af42f1e05095d601adeb2703
1 IIO trigger drivers.
3 Many triggers are provided by hardware that will also be registered as
4 an IIO device.  Whilst this can create device specific complexities
5 such triggers are registered with the core in the same way as
6 stand-alone triggers.
8 struct iio_trig *trig = iio_allocate_trigger("<trigger format string>", ...);
10 allocates a trigger structure.  The key elements to then fill in within
11 a driver are:
13 trig->private_data
14         Device specific private data.
16 trig->owner
17         Typically set to THIS_MODULE. Used to ensure correct
18         ownership of core allocated resources.
20 trig->set_trigger_state:
21         Function that enables / disables the underlying source of the trigger.
23 There is also a
24 trig->alloc_list which is useful for drivers that allocate multiple
25 triggers to keep track of what they have created.
27 When these have been set call:
29 iio_trigger_register(trig);
31 to register the trigger with the core, making it available to trigger
32 consumers.
34 Trigger Consumers
36 Currently triggers are only used for the filling of software
37 buffers and as such any device supporting INDIO_RING_TRIGGERED has the
38 consumer interface automatically created.