Linux-libre 4.19.116-gnu
[librecmc/linux-libre.git] / drivers / staging / iio / Documentation / trigger.txt
1 IIO trigger drivers.
2
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.
7
8 struct iio_trig *trig = iio_trigger_alloc("<trigger format string>", ...);
9
10 allocates a trigger structure.  The key elements to then fill in within
11 a driver are:
12
13 trig->set_trigger_state:
14         Function that enables / disables the underlying source of the trigger.
15
16 There is also a
17 trig->alloc_list which is useful for drivers that allocate multiple
18 triggers to keep track of what they have created.
19
20 When these have been set call:
21
22 iio_trigger_register(trig);
23
24 to register the trigger with the core, making it available to trigger
25 consumers.
26
27 Trigger Consumers
28
29 Currently triggers are only used for the filling of software
30 buffers and as such any device supporting INDIO_BUFFER_TRIGGERED has the
31 consumer interface automatically created.