Merge tag 'for-linus-4.10-rc4-tag' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / Documentation / sound / cards / img-spdif-in.rst
1 ================================================
2 Imagination Technologies SPDIF Input Controllers
3 ================================================
4
5 The Imagination Technologies SPDIF Input controller contains the following
6 controls:
7
8 * name='IEC958 Capture Mask',index=0
9
10 This control returns a mask that shows which of the IEC958 status bits
11 can be read using the 'IEC958 Capture Default' control.
12
13 * name='IEC958 Capture Default',index=0
14
15 This control returns the status bits contained within the SPDIF stream that
16 is being received. The 'IEC958 Capture Mask' shows which bits can be read
17 from this control.
18
19 * name='SPDIF In Multi Frequency Acquire',index=0
20 * name='SPDIF In Multi Frequency Acquire',index=1
21 * name='SPDIF In Multi Frequency Acquire',index=2
22 * name='SPDIF In Multi Frequency Acquire',index=3
23
24 This control is used to attempt acquisition of up to four different sample
25 rates. The active rate can be obtained by reading the 'SPDIF In Lock Frequency'
26 control.
27
28 When the value of this control is set to {0,0,0,0}, the rate given to hw_params
29 will determine the single rate the block will capture. Else, the rate given to
30 hw_params will be ignored, and the block will attempt capture for each of the
31 four sample rates set here.
32
33 If less than four rates are required, the same rate can be specified more than
34 once
35
36 * name='SPDIF In Lock Frequency',index=0
37
38 This control returns the active capture rate, or 0 if a lock has not been
39 acquired
40
41 * name='SPDIF In Lock TRK',index=0
42
43 This control is used to modify the locking/jitter rejection characteristics
44 of the block. Larger values increase the locking range, but reduce jitter
45 rejection.
46
47 * name='SPDIF In Lock Acquire Threshold',index=0
48
49 This control is used to change the threshold at which a lock is acquired.
50
51 * name='SPDIF In Lock Release Threshold',index=0
52
53 This control is used to change the threshold at which a lock is released.