summaryrefslogtreecommitdiff
path: root/Documentation/sound/cards/img-spdif-in.rst
diff options
context:
space:
mode:
authorTakashi Iwai <tiwai@suse.de>2016-11-10 19:36:09 +0300
committerTakashi Iwai <tiwai@suse.de>2016-11-11 00:33:31 +0300
commitf336c3f072216a16187b22069681d014dcb43db6 (patch)
tree76057d35a7d1eb989de3cc5fcb85ac6d202dd3f5 /Documentation/sound/cards/img-spdif-in.rst
parentbb02859cd3448f31e00c47c1277e27be0cee7d2a (diff)
downloadlinux-f336c3f072216a16187b22069681d014dcb43db6.tar.xz
ALSA: doc: ReSTize img,spdif-in.txt
Yet another simple conversion from a plain text file. Put to cards directory. Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'Documentation/sound/cards/img-spdif-in.rst')
-rw-r--r--Documentation/sound/cards/img-spdif-in.rst53
1 files changed, 53 insertions, 0 deletions
diff --git a/Documentation/sound/cards/img-spdif-in.rst b/Documentation/sound/cards/img-spdif-in.rst
new file mode 100644
index 000000000000..7df9f5ae2609
--- /dev/null
+++ b/Documentation/sound/cards/img-spdif-in.rst
@@ -0,0 +1,53 @@
+================================================
+Imagination Technologies SPDIF Input Controllers
+================================================
+
+The Imagination Technologies SPDIF Input controller contains the following
+controls:
+
+* name='IEC958 Capture Mask',index=0
+
+This control returns a mask that shows which of the IEC958 status bits
+can be read using the 'IEC958 Capture Default' control.
+
+* name='IEC958 Capture Default',index=0
+
+This control returns the status bits contained within the SPDIF stream that
+is being received. The 'IEC958 Capture Mask' shows which bits can be read
+from this control.
+
+* name='SPDIF In Multi Frequency Acquire',index=0
+* name='SPDIF In Multi Frequency Acquire',index=1
+* name='SPDIF In Multi Frequency Acquire',index=2
+* name='SPDIF In Multi Frequency Acquire',index=3
+
+This control is used to attempt acquisition of up to four different sample
+rates. The active rate can be obtained by reading the 'SPDIF In Lock Frequency'
+control.
+
+When the value of this control is set to {0,0,0,0}, the rate given to hw_params
+will determine the single rate the block will capture. Else, the rate given to
+hw_params will be ignored, and the block will attempt capture for each of the
+four sample rates set here.
+
+If less than four rates are required, the same rate can be specified more than
+once
+
+* name='SPDIF In Lock Frequency',index=0
+
+This control returns the active capture rate, or 0 if a lock has not been
+acquired
+
+* name='SPDIF In Lock TRK',index=0
+
+This control is used to modify the locking/jitter rejection characteristics
+of the block. Larger values increase the locking range, but reduce jitter
+rejection.
+
+* name='SPDIF In Lock Acquire Threshold',index=0
+
+This control is used to change the threshold at which a lock is acquired.
+
+* name='SPDIF In Lock Release Threshold',index=0
+
+This control is used to change the threshold at which a lock is released.