diff options
| author | Damien.Horsley <Damien.Horsley@imgtec.com> | 2015-11-04 14:40:55 +0000 |
|---|---|---|
| committer | Mark Brown <broonie@kernel.org> | 2015-11-16 10:06:58 +0000 |
| commit | 8f6eec13b1e2aca7eb3e383bc4db9ad22e26a704 (patch) | |
| tree | 90802b672497274f8ba40e00cdfd678c85d2d2cb /Documentation/sound | |
| parent | c4458b740e6b7a0d9ccf680ac81c05a99f602b79 (diff) | |
| download | linux-8f6eec13b1e2aca7eb3e383bc4db9ad22e26a704.tar.bz2 | |
ASoC: img: Add documentation for SPDIF in controls
Add documentation for the controls present in the SPDIF input
controller driver
Signed-off-by: Damien.Horsley <Damien.Horsley@imgtec.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
Diffstat (limited to 'Documentation/sound')
| -rw-r--r-- | Documentation/sound/alsa/img,spdif-in.txt | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/Documentation/sound/alsa/img,spdif-in.txt b/Documentation/sound/alsa/img,spdif-in.txt new file mode 100644 index 000000000000..8b7505785fa6 --- /dev/null +++ b/Documentation/sound/alsa/img,spdif-in.txt @@ -0,0 +1,49 @@ +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. |