hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[media] DocBook: improve documentation for DVB spectral inversion 

Format it as a table and provide more details.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab 2015-05-28 20:00:43 -03:00
parent 01f18d9633
commit 58e11cc3c1
4 changed files with 43 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
Documentation/DocBook/media/dvb/dvbproperty.xml
View File

@ -238,19 +238,45 @@ get/set up to 64 properties. The actual meaning of each property is described on
</section> </section>
<section id="DTV-INVERSION"> <section id="DTV-INVERSION">
<title><constant>DTV_INVERSION</constant></title> <title><constant>DTV_INVERSION</constant></title>
<para>The Inversion field can take one of these values:
</para> <para>Specifies if the frontend should do spectral inversion or not.</para>
<programlisting>
typedef enum fe_spectral_inversion { <section id="fe-spectral-inversion-t">
INVERSION_OFF, <title>enum fe_modulation: Frontend spectral inversion</title>
INVERSION_ON,
INVERSION_AUTO <para>This parameter indicates if spectral inversion should be presumed or not.
} fe_spectral_inversion_t; In the automatic setting (<constant>INVERSION_AUTO</constant>) the hardware
</programlisting> will try to figure out the correct setting by itself. If the hardware
<para>It indicates if spectral inversion should be presumed or not. In the automatic setting doesn't support, the DVB core will try to lock at the carrier first with
(<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by inversion off. If it fails, it will try to enable inversion.
itself. </para>
</para>
<table pgwide="1" frame="none" id="fe-spectral-inversion">
<title>enum fe_modulation</title>
<tgroup cols="2">
&cs-def;
<thead>
<row>
<entry>ID</entry>
<entry>Description</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry>INVERSION_OFF</entry>
<entry>Don't do spectral band inversion.</entry>
</row><row>
<entry>INVERSION_ON</entry>
<entry>Do spectral band inversion.</entry>
</row><row>
<entry>INVERSION_AUTO</entry>
<entry>Autodetect spectral band inversion.</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</section> </section>
<section id="DTV-DISEQC-MASTER"> <section id="DTV-DISEQC-MASTER">
<title><constant>DTV_DISEQC_MASTER</constant></title> <title><constant>DTV_DISEQC_MASTER</constant></title>

17
Documentation/DocBook/media/dvb/frontend.xml
View File

@ -56,23 +56,6 @@ specification is available at
&sub-dvbproperty; &sub-dvbproperty;
<section id="fe-spectral-inversion-t">
<title>frontend spectral inversion</title>
<para>The Inversion field can take one of these values:
</para>
<programlisting>
typedef enum fe_spectral_inversion {
INVERSION_OFF,
INVERSION_ON,
INVERSION_AUTO
} fe_spectral_inversion_t;
</programlisting>
<para>It indicates if spectral inversion should be presumed or not. In the automatic setting
(<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by
itself.
</para>
</section>
<section id="fe-code-rate-t"> <section id="fe-code-rate-t">
<title>frontend code rate</title> <title>frontend code rate</title>
<para>The possible values for the <constant>fec_inner</constant> field used on <para>The possible values for the <constant>fec_inner</constant> field used on

2
Documentation/DocBook/media/dvb/frontend_legacy_api.xml
View File

@ -82,7 +82,7 @@ DVB-C2, ISDB, etc.</para>
struct dvb_frontend_parameters { struct dvb_frontend_parameters {
uint32_t frequency; /&#x22C6; (absolute) frequency in Hz for QAM/OFDM &#x22C6;/ uint32_t frequency; /&#x22C6; (absolute) frequency in Hz for QAM/OFDM &#x22C6;/
/&#x22C6; intermediate frequency in kHz for QPSK &#x22C6;/ /&#x22C6; intermediate frequency in kHz for QPSK &#x22C6;/
fe_spectral_inversion_t inversion; &fe-spectral-inversion-t; inversion;
union { union {
struct dvb_qpsk_parameters qpsk; struct dvb_qpsk_parameters qpsk;
struct dvb_qam_parameters qam; struct dvb_qam_parameters qam;

5
include/uapi/linux/dvb/frontend.h
View File

@ -154,12 +154,13 @@ enum fe_status {
typedef enum fe_status fe_status_t; typedef enum fe_status fe_status_t;
typedef enum fe_spectral_inversion { enum fe_spectral_inversion {
INVERSION_OFF, INVERSION_OFF,
INVERSION_ON, INVERSION_ON,
INVERSION_AUTO INVERSION_AUTO
} fe_spectral_inversion_t; };
typedef enum fe_spectral_inversion fe_spectral_inversion_t;
typedef enum fe_code_rate { typedef enum fe_code_rate {
FEC_NONE = 0, FEC_NONE = 0,