From f336c3f072216a16187b22069681d014dcb43db6 Mon Sep 17 00:00:00 2001 From: Takashi Iwai Date: Thu, 10 Nov 2016 17:36:09 +0100 Subject: 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 --- Documentation/sound/alsa/img,spdif-in.txt | 49 --------------------------- Documentation/sound/cards/img-spdif-in.rst | 53 ++++++++++++++++++++++++++++++ Documentation/sound/cards/index.rst | 1 + 3 files changed, 54 insertions(+), 49 deletions(-) delete mode 100644 Documentation/sound/alsa/img,spdif-in.txt create mode 100644 Documentation/sound/cards/img-spdif-in.rst diff --git a/Documentation/sound/alsa/img,spdif-in.txt b/Documentation/sound/alsa/img,spdif-in.txt deleted file mode 100644 index 8b7505785fa6..000000000000 --- a/Documentation/sound/alsa/img,spdif-in.txt +++ /dev/null @@ -1,49 +0,0 @@ -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. 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. diff --git a/Documentation/sound/cards/index.rst b/Documentation/sound/cards/index.rst index 976ef5eb8f89..c016f8c3b88b 100644 --- a/Documentation/sound/cards/index.rst +++ b/Documentation/sound/cards/index.rst @@ -16,3 +16,4 @@ Card-Specific Information maya44 hdspm serial-u16550 + img-spdif-in -- cgit v1.2.3