From patchwork Wed Jun 8 01:45:38 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 860572 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by demeter1.kernel.org (8.14.4/8.14.4) with ESMTP id p581g6Rc015583 for ; Wed, 8 Jun 2011 02:08:46 GMT Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753547Ab1FHBqX (ORCPT ); Tue, 7 Jun 2011 21:46:23 -0400 Received: from mx1.redhat.com ([209.132.183.28]:47251 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754467Ab1FHBqG (ORCPT ); Tue, 7 Jun 2011 21:46:06 -0400 Received: from int-mx02.intmail.prod.int.phx2.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id p581k6Oo030515 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Tue, 7 Jun 2011 21:46:06 -0400 Received: from pedra (vpn-236-210.phx2.redhat.com [10.3.236.210]) by int-mx02.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id p581jncC007506 for ; Tue, 7 Jun 2011 21:46:05 -0400 Date: Tue, 7 Jun 2011 22:45:38 -0300 From: Mauro Carvalho Chehab Cc: Linux Media Mailing List Subject: [PATCH 11/15] [media] DocBook/dvbproperty.xml: Document the terrestrial delivery systems Message-ID: <20110607224538.08b832d9@pedra> In-Reply-To: References: Mime-Version: 1.0 X-Scanned-By: MIMEDefang 2.67 on 10.5.11.12 To: unlisted-recipients:; (no To-header on input) Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Greylist: IP, sender and recipient auto-whitelisted, not delayed by milter-greylist-4.2.6 (demeter1.kernel.org [140.211.167.41]); Wed, 08 Jun 2011 02:08:46 +0000 (UTC) Instead of repeating duplicate parameters to each delivery system, just add a section for each specific delivery system, showing what's applicable to each case. This helps userspace app developers to know what DVB parameters are applicable to each delivery system. Signed-off-by: Mauro Carvalho Chehab diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml index d8a6424..4c45f3c 100644 --- a/Documentation/DocBook/media/dvb/dvbproperty.xml +++ b/Documentation/DocBook/media/dvb/dvbproperty.xml @@ -1,6 +1,12 @@
-FE_GET_PROPERTY/FE_SET_PROPERTY - +<constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant> +This section describes the DVB version 5 extention of the DVB-API, also +called "S2API", as this API were added to provide support for DVB-S2. It was +designed to be able to replace the old frontend API. Yet, the DISEQC and +the capability ioctls weren't implemented yet via the new way. +The typical usage for the FE_GET_PROPERTY/FE_SET_PROPERTY +API is to replace the ioctl's were the +struct dvb_frontend_parameters were used. /* Reserved fields should be set to 0 */ struct dtv_property { @@ -149,52 +155,7 @@ the actual action is determined by the dtv_property cmd/data pairs. With one sin get/set up to 64 properties. The actual meaning of each property is described on the next sections. -The available frontend property types are: - -DTV_UNDEFINED -DTV_TUNE -DTV_CLEAR -DTV_FREQUENCY -DTV_MODULATION -DTV_BANDWIDTH_HZ -DTV_INVERSION -DTV_DISEQC_MASTER -DTV_SYMBOL_RATE -DTV_INNER_FEC -DTV_VOLTAGE -DTV_TONE -DTV_PILOT -DTV_ROLLOFF -DTV_DISEQC_SLAVE_REPLY -DTV_FE_CAPABILITY_COUNT -DTV_FE_CAPABILITY -DTV_DELIVERY_SYSTEM -DTV_ISDBT_PARTIAL_RECEPTION -DTV_ISDBT_SOUND_BROADCASTING -DTV_ISDBT_SB_SUBCHANNEL_ID -DTV_ISDBT_SB_SEGMENT_IDX -DTV_ISDBT_SB_SEGMENT_COUNT -DTV_ISDBT_LAYERA_FEC -DTV_ISDBT_LAYERA_MODULATION -DTV_ISDBT_LAYERA_SEGMENT_COUNT -DTV_ISDBT_LAYERA_TIME_INTERLEAVING -DTV_ISDBT_LAYERB_FEC -DTV_ISDBT_LAYERB_MODULATION -DTV_ISDBT_LAYERB_SEGMENT_COUNT -DTV_ISDBT_LAYERB_TIME_INTERLEAVING -DTV_ISDBT_LAYERC_FEC -DTV_ISDBT_LAYERC_MODULATION -DTV_ISDBT_LAYERC_SEGMENT_COUNT -DTV_ISDBT_LAYERC_TIME_INTERLEAVING -DTV_API_VERSION -DTV_CODE_RATE_HP -DTV_CODE_RATE_LP -DTV_GUARD_INTERVAL -DTV_TRANSMISSION_MODE -DTV_HIERARCHY -DTV_ISDBT_LAYER_ENABLED -DTV_ISDBS_TS_ID -DTV_DVBT2_PLP_ID +The available frontend property types are shown on the next section.
@@ -696,13 +657,53 @@ typedef enum fe_hierarchy { many data types via a single multiplex. The API will soon support this at which point this section will be expanded.
-
- Properties used by each DTV type +
+
+ Properties used on terrestrial delivery systems +
+ DVB-T delivery system + The following parameters are valid for DVB-T: + + DTV_API_VERSION + DTV_TUNE + DTV_CLEAR + DTV_FREQUENCY + DTV_MODULATION + DTV_BANDWIDTH_HZ + DTV_INVERSION + DTV_CODE_RATE_HP + DTV_CODE_RATE_LP + DTV_GUARD_INTERVAL + DTV_TRANSMISSION_MODE + DTV_HIERARCHY + DTV_DELIVERY_SYSTEM + +
+
+ DVB-T2 delivery system + DVB-T2support is currently in the early stages + of development so expect this section to grow and become + more detailed with time. + The following parameters are valid for DVB-T2: + + DTV_API_VERSION + DTV_TUNE + DTV_CLEAR + DTV_FREQUENCY + DTV_MODULATION + DTV_BANDWIDTH_HZ + DTV_INVERSION + DTV_CODE_RATE_HP + DTV_CODE_RATE_LP + DTV_GUARD_INTERVAL + DTV_TRANSMISSION_MODE + DTV_HIERARCHY + DTV_DELIVERY_SYSTEM + DTV_DVBT2_PLP_ID + +
- ISDB-T frontend - This section describes shortly what are the possible parameters in the Linux - DVB-API called "S2API" and now DVB API 5 in order to tune an ISDB-T/ISDB-Tsb - demodulator: + ISDB-T delivery system This ISDB-T/ISDB-Tsb API extension should reflect all information needed to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible that some very sophisticated devices won't need certain parameters to @@ -717,17 +718,54 @@ typedef enum fe_hierarchy { Television Broadcasting" and ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial Television Broadcasting". - In order to read this document one has to have some knowledge the - channel structure in ISDB-T and ISDB-Tsb. I.e. it has to be known to - the reader that an ISDB-T channel consists of 13 segments, that it can - have up to 3 layer sharing those segments, and things like that. -
-
- DVB-T2 parameters - This section covers parameters that apply only to the DVB-T2 delivery method. DVB-T2 - support is currently in the early stages development so expect this section to grow - and become more detailed with time. + In order to understand the ISDB specific parameters, + one has to have some knowledge the channel structure in + ISDB-T and ISDB-Tsb. I.e. it has to be known to + the reader that an ISDB-T channel consists of 13 segments, + that it can have up to 3 layer sharing those segments, + and things like that. + The following parameters are valid for ISDB-T: + + DTV_API_VERSION + DTV_TUNE + DTV_CLEAR + DTV_FREQUENCY + DTV_MODULATION + DTV_BANDWIDTH_HZ + DTV_INVERSION + DTV_CODE_RATE_HP + DTV_CODE_RATE_LP + DTV_GUARD_INTERVAL + DTV_TRANSMISSION_MODE + DTV_HIERARCHY + DTV_DELIVERY_SYSTEM + DTV_ISDBT_LAYER_ENABLED + DTV_ISDBT_PARTIAL_RECEPTION + DTV_ISDBT_SOUND_BROADCASTING + DTV_ISDBT_SB_SUBCHANNEL_ID + DTV_ISDBT_SB_SEGMENT_IDX + DTV_ISDBT_SB_SEGMENT_COUNT + DTV_ISDBT_LAYERA_FEC + DTV_ISDBT_LAYERA_MODULATION + DTV_ISDBT_LAYERA_SEGMENT_COUNT + DTV_ISDBT_LAYERA_TIME_INTERLEAVING + DTV_ISDBT_LAYERB_FEC + DTV_ISDBT_LAYERB_MODULATION + DTV_ISDBT_LAYERB_SEGMENT_COUNT + DTV_ISDBT_LAYERB_TIME_INTERLEAVING + DTV_ISDBT_LAYERC_FEC + DTV_ISDBT_LAYERC_MODULATION + DTV_ISDBT_LAYERC_SEGMENT_COUNT + DTV_ISDBT_LAYERC_TIME_INTERLEAVING +
- +
+ Properties used on cable delivery systems + TODO +
+
+ Properties used on satellital delivery systems + TODO +