Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 1 | <section id="FE_GET_SET_PROPERTY"> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 2 | <title><constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></title> |
Masanari Iida | 842059a | 2013-03-24 02:25:56 -0300 | [diff] [blame] | 3 | <para>This section describes the DVB version 5 extension of the DVB-API, also |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 4 | called "S2API", as this API were added to provide support for DVB-S2. It was |
| 5 | designed to be able to replace the old frontend API. Yet, the DISEQC and |
| 6 | the capability ioctls weren't implemented yet via the new way.</para> |
| 7 | <para>The typical usage for the <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant> |
| 8 | API is to replace the ioctl's were the <link linkend="dvb-frontend-parameters"> |
| 9 | struct <constant>dvb_frontend_parameters</constant></link> were used.</para> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 10 | <section id="dtv-stats"> |
| 11 | <title>DTV stats type</title> |
| 12 | <programlisting> |
| 13 | struct dtv_stats { |
| 14 | __u8 scale; /* enum fecap_scale_params type */ |
| 15 | union { |
| 16 | __u64 uvalue; /* for counters and relative scales */ |
| 17 | __s64 svalue; /* for 1/1000 dB measures */ |
| 18 | }; |
| 19 | } __packed; |
| 20 | </programlisting> |
| 21 | </section> |
| 22 | <section id="dtv-fe-stats"> |
| 23 | <title>DTV stats type</title> |
| 24 | <programlisting> |
| 25 | #define MAX_DTV_STATS 4 |
| 26 | |
| 27 | struct dtv_fe_stats { |
| 28 | __u8 len; |
| 29 | struct dtv_stats stat[MAX_DTV_STATS]; |
| 30 | } __packed; |
| 31 | </programlisting> |
| 32 | </section> |
| 33 | |
Mauro Carvalho Chehab | 3272c3e | 2011-06-07 21:40:22 -0300 | [diff] [blame] | 34 | <section id="dtv-property"> |
| 35 | <title>DTV property type</title> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 36 | <programlisting> |
| 37 | /* Reserved fields should be set to 0 */ |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 38 | |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 39 | struct dtv_property { |
| 40 | __u32 cmd; |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 41 | __u32 reserved[3]; |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 42 | union { |
| 43 | __u32 data; |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 44 | struct dtv_fe_stats st; |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 45 | struct { |
| 46 | __u8 data[32]; |
| 47 | __u32 len; |
| 48 | __u32 reserved1[3]; |
| 49 | void *reserved2; |
| 50 | } buffer; |
| 51 | } u; |
| 52 | int result; |
| 53 | } __attribute__ ((packed)); |
| 54 | |
| 55 | /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */ |
| 56 | #define DTV_IOCTL_MAX_MSGS 64 |
Mauro Carvalho Chehab | 3272c3e | 2011-06-07 21:40:22 -0300 | [diff] [blame] | 57 | </programlisting> |
| 58 | </section> |
| 59 | <section id="dtv-properties"> |
| 60 | <title>DTV properties type</title> |
| 61 | <programlisting> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 62 | struct dtv_properties { |
| 63 | __u32 num; |
| 64 | struct dtv_property *props; |
| 65 | }; |
| 66 | </programlisting> |
Mauro Carvalho Chehab | 3272c3e | 2011-06-07 21:40:22 -0300 | [diff] [blame] | 67 | </section> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 68 | |
| 69 | <section id="FE_GET_PROPERTY"> |
| 70 | <title>FE_GET_PROPERTY</title> |
| 71 | <para>DESCRIPTION |
| 72 | </para> |
| 73 | <informaltable><tgroup cols="1"><tbody><row><entry |
| 74 | align="char"> |
| 75 | <para>This ioctl call returns one or more frontend properties. This call only |
| 76 | requires read-only access to the device.</para> |
| 77 | </entry> |
| 78 | </row></tbody></tgroup></informaltable> |
| 79 | <para>SYNOPSIS |
| 80 | </para> |
| 81 | <informaltable><tgroup cols="1"><tbody><row><entry |
| 82 | align="char"> |
| 83 | <para>int ioctl(int fd, int request = <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>, |
| 84 | dtv_properties ⋆props);</para> |
| 85 | </entry> |
| 86 | </row></tbody></tgroup></informaltable> |
| 87 | <para>PARAMETERS |
| 88 | </para> |
| 89 | <informaltable><tgroup cols="2"><tbody><row><entry align="char"> |
| 90 | <para>int fd</para> |
| 91 | </entry><entry |
| 92 | align="char"> |
| 93 | <para>File descriptor returned by a previous call to open().</para> |
| 94 | </entry> |
| 95 | </row><row><entry |
| 96 | align="char"> |
| 97 | <para>int num</para> |
| 98 | </entry><entry |
| 99 | align="char"> |
| 100 | <para>Equals <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link> for this command.</para> |
| 101 | </entry> |
| 102 | </row><row><entry |
| 103 | align="char"> |
| 104 | <para>struct dtv_property *props</para> |
| 105 | </entry><entry |
| 106 | align="char"> |
| 107 | <para>Points to the location where the front-end property commands are stored.</para> |
| 108 | </entry> |
| 109 | </row></tbody></tgroup></informaltable> |
Mauro Carvalho Chehab | 3de530f | 2011-07-05 12:36:01 -0300 | [diff] [blame] | 110 | &return-value-dvb; |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 111 | <informaltable><tgroup cols="2"><tbody><row> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 112 | <entry align="char"><para>EOPNOTSUPP</para></entry> |
| 113 | <entry align="char"><para>Property type not supported.</para></entry> |
| 114 | </row></tbody></tgroup></informaltable> |
| 115 | </section> |
| 116 | |
| 117 | <section id="FE_SET_PROPERTY"> |
| 118 | <title>FE_SET_PROPERTY</title> |
| 119 | <para>DESCRIPTION |
| 120 | </para> |
| 121 | <informaltable><tgroup cols="1"><tbody><row><entry |
| 122 | align="char"> |
Mauro Carvalho Chehab | a47959f | 2014-09-26 15:37:38 -0300 | [diff] [blame] | 123 | <para>This ioctl call sets one or more frontend properties. This call |
| 124 | requires read/write access to the device.</para> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 125 | </entry> |
| 126 | </row></tbody></tgroup></informaltable> |
| 127 | <para>SYNOPSIS |
| 128 | </para> |
| 129 | <informaltable><tgroup cols="1"><tbody><row><entry |
| 130 | align="char"> |
| 131 | <para>int ioctl(int fd, int request = <link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link>, |
| 132 | dtv_properties ⋆props);</para> |
| 133 | </entry> |
| 134 | </row></tbody></tgroup></informaltable> |
| 135 | <para>PARAMETERS |
| 136 | </para> |
| 137 | <informaltable><tgroup cols="2"><tbody><row><entry align="char"> |
| 138 | <para>int fd</para> |
| 139 | </entry><entry |
| 140 | align="char"> |
| 141 | <para>File descriptor returned by a previous call to open().</para> |
| 142 | </entry> |
| 143 | </row><row><entry |
| 144 | align="char"> |
| 145 | <para>int num</para> |
| 146 | </entry><entry |
| 147 | align="char"> |
| 148 | <para>Equals <link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link> for this command.</para> |
| 149 | </entry> |
| 150 | </row><row><entry |
| 151 | align="char"> |
| 152 | <para>struct dtv_property *props</para> |
| 153 | </entry><entry |
| 154 | align="char"> |
| 155 | <para>Points to the location where the front-end property commands are stored.</para> |
| 156 | </entry> |
| 157 | </row></tbody></tgroup></informaltable> |
Mauro Carvalho Chehab | 3de530f | 2011-07-05 12:36:01 -0300 | [diff] [blame] | 158 | &return-value-dvb; |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 159 | <informaltable><tgroup cols="2"><tbody><row> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 160 | <entry align="char"><para>EOPNOTSUPP</para></entry> |
| 161 | <entry align="char"><para>Property type not supported.</para></entry> |
| 162 | </row></tbody></tgroup></informaltable> |
| 163 | </section> |
| 164 | |
Hans Verkuil | 5f1e158 | 2011-05-23 07:12:27 -0300 | [diff] [blame] | 165 | <section> |
| 166 | <title>Property types</title> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 167 | <para> |
| 168 | On <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>/<link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link>, |
| 169 | the actual action is determined by the dtv_property cmd/data pairs. With one single ioctl, is possible to |
| 170 | get/set up to 64 properties. The actual meaning of each property is described on the next sections. |
| 171 | </para> |
| 172 | |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 173 | <para>The available frontend property types are shown on the next section.</para> |
Hans Verkuil | 5f1e158 | 2011-05-23 07:12:27 -0300 | [diff] [blame] | 174 | </section> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 175 | |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 176 | <section id="fe_property_parameters"> |
| 177 | <title>Digital TV property parameters</title> |
Mauro Carvalho Chehab | 04a9207 | 2011-06-07 19:37:47 -0300 | [diff] [blame] | 178 | <section id="DTV-UNDEFINED"> |
| 179 | <title><constant>DTV_UNDEFINED</constant></title> |
| 180 | <para>Used internally. A GET/SET operation for it won't change or return anything.</para> |
| 181 | </section> |
| 182 | <section id="DTV-TUNE"> |
| 183 | <title><constant>DTV_TUNE</constant></title> |
| 184 | <para>Interpret the cache of data, build either a traditional frontend tunerequest so we can pass validation in the <constant>FE_SET_FRONTEND</constant> ioctl.</para> |
| 185 | </section> |
| 186 | <section id="DTV-CLEAR"> |
| 187 | <title><constant>DTV_CLEAR</constant></title> |
| 188 | <para>Reset a cache of data specific to the frontend here. This does not effect hardware.</para> |
| 189 | </section> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 190 | <section id="DTV-FREQUENCY"> |
| 191 | <title><constant>DTV_FREQUENCY</constant></title> |
| 192 | |
Mauro Carvalho Chehab | a34e2a7 | 2012-01-17 09:45:48 -0200 | [diff] [blame] | 193 | <para>Central frequency of the channel.</para> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 194 | |
| 195 | <para>Notes:</para> |
Mauro Carvalho Chehab | a34e2a7 | 2012-01-17 09:45:48 -0200 | [diff] [blame] | 196 | <para>1)For satellital delivery systems, it is measured in kHz. |
| 197 | For the other ones, it is measured in Hz.</para> |
| 198 | <para>2)For ISDB-T, the channels are usually transmitted with an offset of 143kHz. |
Masanari Iida | c4d28cc | 2014-03-12 12:57:22 -0300 | [diff] [blame] | 199 | E.g. a valid frequency could be 474143 kHz. The stepping is bound to the bandwidth of |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 200 | the channel which is 6MHz.</para> |
| 201 | |
Mauro Carvalho Chehab | a34e2a7 | 2012-01-17 09:45:48 -0200 | [diff] [blame] | 202 | <para>3)As in ISDB-Tsb the channel consists of only one or three segments the |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 203 | frequency step is 429kHz, 3*429 respectively. As for ISDB-T the |
| 204 | central frequency of the channel is expected.</para> |
| 205 | </section> |
Mauro Carvalho Chehab | 04a9207 | 2011-06-07 19:37:47 -0300 | [diff] [blame] | 206 | <section id="DTV-MODULATION"> |
| 207 | <title><constant>DTV_MODULATION</constant></title> |
| 208 | <para>Specifies the frontend modulation type for cable and satellite types. The modulation can be one of the types bellow:</para> |
| 209 | <programlisting> |
| 210 | typedef enum fe_modulation { |
| 211 | QPSK, |
| 212 | QAM_16, |
| 213 | QAM_32, |
| 214 | QAM_64, |
| 215 | QAM_128, |
| 216 | QAM_256, |
| 217 | QAM_AUTO, |
| 218 | VSB_8, |
| 219 | VSB_16, |
| 220 | PSK_8, |
| 221 | APSK_16, |
| 222 | APSK_32, |
| 223 | DQPSK, |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 224 | QAM_4_NR, |
Mauro Carvalho Chehab | 04a9207 | 2011-06-07 19:37:47 -0300 | [diff] [blame] | 225 | } fe_modulation_t; |
| 226 | </programlisting> |
| 227 | </section> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 228 | <section id="DTV-BANDWIDTH-HZ"> |
| 229 | <title><constant>DTV_BANDWIDTH_HZ</constant></title> |
| 230 | |
| 231 | <para>Bandwidth for the channel, in HZ.</para> |
| 232 | |
| 233 | <para>Possible values: |
| 234 | <constant>1712000</constant>, |
| 235 | <constant>5000000</constant>, |
| 236 | <constant>6000000</constant>, |
| 237 | <constant>7000000</constant>, |
| 238 | <constant>8000000</constant>, |
| 239 | <constant>10000000</constant>. |
| 240 | </para> |
| 241 | |
| 242 | <para>Notes:</para> |
| 243 | |
| 244 | <para>1) For ISDB-T it should be always 6000000Hz (6MHz)</para> |
| 245 | <para>2) For ISDB-Tsb it can vary depending on the number of connected segments</para> |
| 246 | <para>3) Bandwidth doesn't apply for DVB-C transmissions, as the bandwidth |
| 247 | for DVB-C depends on the symbol rate</para> |
| 248 | <para>4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from |
| 249 | other parameters (DTV_ISDBT_SB_SEGMENT_IDX, |
| 250 | DTV_ISDBT_SB_SEGMENT_COUNT).</para> |
| 251 | <para>5) DVB-T supports 6, 7 and 8MHz.</para> |
| 252 | <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para> |
| 253 | </section> |
Mauro Carvalho Chehab | 04a9207 | 2011-06-07 19:37:47 -0300 | [diff] [blame] | 254 | <section id="DTV-INVERSION"> |
| 255 | <title><constant>DTV_INVERSION</constant></title> |
| 256 | <para>The Inversion field can take one of these values: |
| 257 | </para> |
| 258 | <programlisting> |
| 259 | typedef enum fe_spectral_inversion { |
| 260 | INVERSION_OFF, |
| 261 | INVERSION_ON, |
| 262 | INVERSION_AUTO |
| 263 | } fe_spectral_inversion_t; |
| 264 | </programlisting> |
| 265 | <para>It indicates if spectral inversion should be presumed or not. In the automatic setting |
| 266 | (<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by |
| 267 | itself. |
| 268 | </para> |
| 269 | </section> |
| 270 | <section id="DTV-DISEQC-MASTER"> |
| 271 | <title><constant>DTV_DISEQC_MASTER</constant></title> |
| 272 | <para>Currently not implemented.</para> |
| 273 | </section> |
| 274 | <section id="DTV-SYMBOL-RATE"> |
| 275 | <title><constant>DTV_SYMBOL_RATE</constant></title> |
| 276 | <para>Digital TV symbol rate, in bauds (symbols/second). Used on cable standards.</para> |
| 277 | </section> |
| 278 | <section id="DTV-INNER-FEC"> |
| 279 | <title><constant>DTV_INNER_FEC</constant></title> |
| 280 | <para>Used cable/satellite transmissions. The acceptable values are: |
| 281 | </para> |
| 282 | <programlisting> |
| 283 | typedef enum fe_code_rate { |
| 284 | FEC_NONE = 0, |
| 285 | FEC_1_2, |
| 286 | FEC_2_3, |
| 287 | FEC_3_4, |
| 288 | FEC_4_5, |
| 289 | FEC_5_6, |
| 290 | FEC_6_7, |
| 291 | FEC_7_8, |
| 292 | FEC_8_9, |
| 293 | FEC_AUTO, |
| 294 | FEC_3_5, |
| 295 | FEC_9_10, |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 296 | FEC_2_5, |
Mauro Carvalho Chehab | 04a9207 | 2011-06-07 19:37:47 -0300 | [diff] [blame] | 297 | } fe_code_rate_t; |
| 298 | </programlisting> |
| 299 | <para>which correspond to error correction rates of 1/2, 2/3, etc., |
| 300 | no error correction or auto detection.</para> |
| 301 | </section> |
| 302 | <section id="DTV-VOLTAGE"> |
| 303 | <title><constant>DTV_VOLTAGE</constant></title> |
| 304 | <para>The voltage is usually used with non-DiSEqC capable LNBs to switch |
| 305 | the polarzation (horizontal/vertical). When using DiSEqC epuipment this |
| 306 | voltage has to be switched consistently to the DiSEqC commands as |
| 307 | described in the DiSEqC spec.</para> |
| 308 | <programlisting> |
| 309 | typedef enum fe_sec_voltage { |
| 310 | SEC_VOLTAGE_13, |
| 311 | SEC_VOLTAGE_18 |
| 312 | } fe_sec_voltage_t; |
| 313 | </programlisting> |
| 314 | </section> |
| 315 | <section id="DTV-TONE"> |
| 316 | <title><constant>DTV_TONE</constant></title> |
| 317 | <para>Currently not used.</para> |
| 318 | </section> |
| 319 | <section id="DTV-PILOT"> |
| 320 | <title><constant>DTV_PILOT</constant></title> |
| 321 | <para>Sets DVB-S2 pilot</para> |
| 322 | <section id="fe-pilot-t"> |
| 323 | <title>fe_pilot type</title> |
| 324 | <programlisting> |
| 325 | typedef enum fe_pilot { |
| 326 | PILOT_ON, |
| 327 | PILOT_OFF, |
| 328 | PILOT_AUTO, |
| 329 | } fe_pilot_t; |
| 330 | </programlisting> |
| 331 | </section> |
| 332 | </section> |
| 333 | <section id="DTV-ROLLOFF"> |
| 334 | <title><constant>DTV_ROLLOFF</constant></title> |
| 335 | <para>Sets DVB-S2 rolloff</para> |
| 336 | |
| 337 | <section id="fe-rolloff-t"> |
| 338 | <title>fe_rolloff type</title> |
| 339 | <programlisting> |
| 340 | typedef enum fe_rolloff { |
| 341 | ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */ |
| 342 | ROLLOFF_20, |
| 343 | ROLLOFF_25, |
| 344 | ROLLOFF_AUTO, |
| 345 | } fe_rolloff_t; |
| 346 | </programlisting> |
| 347 | </section> |
| 348 | </section> |
| 349 | <section id="DTV-DISEQC-SLAVE-REPLY"> |
| 350 | <title><constant>DTV_DISEQC_SLAVE_REPLY</constant></title> |
| 351 | <para>Currently not implemented.</para> |
| 352 | </section> |
| 353 | <section id="DTV-FE-CAPABILITY-COUNT"> |
| 354 | <title><constant>DTV_FE_CAPABILITY_COUNT</constant></title> |
| 355 | <para>Currently not implemented.</para> |
| 356 | </section> |
| 357 | <section id="DTV-FE-CAPABILITY"> |
| 358 | <title><constant>DTV_FE_CAPABILITY</constant></title> |
| 359 | <para>Currently not implemented.</para> |
| 360 | </section> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 361 | <section id="DTV-DELIVERY-SYSTEM"> |
| 362 | <title><constant>DTV_DELIVERY_SYSTEM</constant></title> |
| 363 | <para>Specifies the type of Delivery system</para> |
| 364 | <section id="fe-delivery-system-t"> |
| 365 | <title>fe_delivery_system type</title> |
| 366 | <para>Possible values: </para> |
| 367 | <programlisting> |
Mauro Carvalho Chehab | 669a4ba | 2011-12-17 20:36:56 -0300 | [diff] [blame] | 368 | |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 369 | typedef enum fe_delivery_system { |
| 370 | SYS_UNDEFINED, |
Mauro Carvalho Chehab | 669a4ba | 2011-12-17 20:36:56 -0300 | [diff] [blame] | 371 | SYS_DVBC_ANNEX_A, |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 372 | SYS_DVBC_ANNEX_B, |
| 373 | SYS_DVBT, |
| 374 | SYS_DSS, |
| 375 | SYS_DVBS, |
| 376 | SYS_DVBS2, |
| 377 | SYS_DVBH, |
| 378 | SYS_ISDBT, |
| 379 | SYS_ISDBS, |
| 380 | SYS_ISDBC, |
| 381 | SYS_ATSC, |
| 382 | SYS_ATSCMH, |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 383 | SYS_DTMB, |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 384 | SYS_CMMB, |
| 385 | SYS_DAB, |
| 386 | SYS_DVBT2, |
Andreas Oberritter | 83dc314 | 2011-08-08 11:54:35 -0300 | [diff] [blame] | 387 | SYS_TURBO, |
Mauro Carvalho Chehab | 669a4ba | 2011-12-17 20:36:56 -0300 | [diff] [blame] | 388 | SYS_DVBC_ANNEX_C, |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 389 | } fe_delivery_system_t; |
| 390 | </programlisting> |
| 391 | </section> |
| 392 | </section> |
| 393 | <section id="DTV-ISDBT-PARTIAL-RECEPTION"> |
| 394 | <title><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></title> |
| 395 | |
| 396 | <para>If <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '0' this bit-field represents whether |
| 397 | the channel is in partial reception mode or not.</para> |
| 398 | |
| 399 | <para>If '1' <constant>DTV_ISDBT_LAYERA_*</constant> values are assigned to the center segment and |
| 400 | <constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant> has to be '1'.</para> |
| 401 | |
| 402 | <para>If in addition <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1' |
| 403 | <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> represents whether this ISDB-Tsb channel |
| 404 | is consisting of one segment and layer or three segments and two layers.</para> |
| 405 | |
| 406 | <para>Possible values: 0, 1, -1 (AUTO)</para> |
| 407 | </section> |
| 408 | <section id="DTV-ISDBT-SOUND-BROADCASTING"> |
| 409 | <title><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></title> |
| 410 | |
| 411 | <para>This field represents whether the other DTV_ISDBT_*-parameters are |
| 412 | referring to an ISDB-T and an ISDB-Tsb channel. (See also |
| 413 | <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>).</para> |
| 414 | |
| 415 | <para>Possible values: 0, 1, -1 (AUTO)</para> |
| 416 | </section> |
| 417 | <section id="DTV-ISDBT-SB-SUBCHANNEL-ID"> |
| 418 | <title><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></title> |
| 419 | |
| 420 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> |
| 421 | |
| 422 | <para>(Note of the author: This might not be the correct description of the |
| 423 | <constant>SUBCHANNEL-ID</constant> in all details, but it is my understanding of the technical |
| 424 | background needed to program a device)</para> |
| 425 | |
| 426 | <para>An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a |
| 427 | set of connected ISDB-Tsb channels. In this set of channels every |
| 428 | channel can be received independently. The number of connected |
| 429 | ISDB-Tsb segment can vary, e.g. depending on the frequency spectrum |
| 430 | bandwidth available.</para> |
| 431 | |
| 432 | <para>Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The |
| 433 | broadcaster has several possibilities to put those channels in the |
| 434 | air: Assuming a normal 13-segment ISDB-T spectrum he can align the 8 |
| 435 | segments from position 1-8 to 5-13 or anything in between.</para> |
| 436 | |
| 437 | <para>The underlying layer of segments are subchannels: each segment is |
| 438 | consisting of several subchannels with a predefined IDs. A sub-channel |
| 439 | is used to help the demodulator to synchronize on the channel.</para> |
| 440 | |
| 441 | <para>An ISDB-T channel is always centered over all sub-channels. As for |
| 442 | the example above, in ISDB-Tsb it is no longer as simple as that.</para> |
| 443 | |
| 444 | <para><constant>The DTV_ISDBT_SB_SUBCHANNEL_ID</constant> parameter is used to give the |
| 445 | sub-channel ID of the segment to be demodulated.</para> |
| 446 | |
| 447 | <para>Possible values: 0 .. 41, -1 (AUTO)</para> |
| 448 | </section> |
| 449 | <section id="DTV-ISDBT-SB-SEGMENT-IDX"> |
| 450 | <title><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></title> |
| 451 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> |
| 452 | <para><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant> gives the index of the segment to be |
| 453 | demodulated for an ISDB-Tsb channel where several of them are |
| 454 | transmitted in the connected manner.</para> |
| 455 | <para>Possible values: 0 .. <constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> - 1</para> |
| 456 | <para>Note: This value cannot be determined by an automatic channel search.</para> |
| 457 | </section> |
| 458 | <section id="DTV-ISDBT-SB-SEGMENT-COUNT"> |
| 459 | <title><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></title> |
| 460 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> |
| 461 | <para><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> gives the total count of connected ISDB-Tsb |
| 462 | channels.</para> |
| 463 | <para>Possible values: 1 .. 13</para> |
| 464 | <para>Note: This value cannot be determined by an automatic channel search.</para> |
| 465 | </section> |
| 466 | <section id="isdb-hierq-layers"> |
Mauro Carvalho Chehab | 446c18f | 2011-06-07 23:08:19 -0300 | [diff] [blame] | 467 | <title><constant>DTV-ISDBT-LAYER*</constant> parameters</title> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 468 | <para>ISDB-T channels can be coded hierarchically. As opposed to DVB-T in |
| 469 | ISDB-T hierarchical layers can be decoded simultaneously. For that |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 470 | reason a ISDB-T demodulator has 3 Viterbi and 3 Reed-Solomon decoders.</para> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 471 | <para>ISDB-T has 3 hierarchical layers which each can use a part of the |
| 472 | available segments. The total number of segments over all layers has |
| 473 | to 13 in ISDB-T.</para> |
Mauro Carvalho Chehab | 446c18f | 2011-06-07 23:08:19 -0300 | [diff] [blame] | 474 | <para>There are 3 parameter sets, for Layers A, B and C.</para> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 475 | <section id="DTV-ISDBT-LAYER-ENABLED"> |
| 476 | <title><constant>DTV_ISDBT_LAYER_ENABLED</constant></title> |
| 477 | <para>Hierarchical reception in ISDB-T is achieved by enabling or disabling |
| 478 | layers in the decoding process. Setting all bits of |
| 479 | <constant>DTV_ISDBT_LAYER_ENABLED</constant> to '1' forces all layers (if applicable) to be |
| 480 | demodulated. This is the default.</para> |
| 481 | <para>If the channel is in the partial reception mode |
| 482 | (<constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> = 1) the central segment can be decoded |
| 483 | independently of the other 12 segments. In that mode layer A has to |
| 484 | have a <constant>SEGMENT_COUNT</constant> of 1.</para> |
| 485 | <para>In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb |
| 486 | according to <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>. <constant>SEGMENT_COUNT</constant> must be filled |
| 487 | accordingly.</para> |
| 488 | <para>Possible values: 0x1, 0x2, 0x4 (|-able)</para> |
| 489 | <para><constant>DTV_ISDBT_LAYER_ENABLED[0:0]</constant> - layer A</para> |
| 490 | <para><constant>DTV_ISDBT_LAYER_ENABLED[1:1]</constant> - layer B</para> |
| 491 | <para><constant>DTV_ISDBT_LAYER_ENABLED[2:2]</constant> - layer C</para> |
| 492 | <para><constant>DTV_ISDBT_LAYER_ENABLED[31:3]</constant> unused</para> |
| 493 | </section> |
| 494 | <section id="DTV-ISDBT-LAYER-FEC"> |
| 495 | <title><constant>DTV_ISDBT_LAYER*_FEC</constant></title> |
| 496 | <para>Possible values: <constant>FEC_AUTO</constant>, <constant>FEC_1_2</constant>, <constant>FEC_2_3</constant>, <constant>FEC_3_4</constant>, <constant>FEC_5_6</constant>, <constant>FEC_7_8</constant></para> |
| 497 | </section> |
| 498 | <section id="DTV-ISDBT-LAYER-MODULATION"> |
| 499 | <title><constant>DTV_ISDBT_LAYER*_MODULATION</constant></title> |
| 500 | <para>Possible values: <constant>QAM_AUTO</constant>, QP<constant>SK, QAM_16</constant>, <constant>QAM_64</constant>, <constant>DQPSK</constant></para> |
| 501 | <para>Note: If layer C is <constant>DQPSK</constant> layer B has to be <constant>DQPSK</constant>. If layer B is <constant>DQPSK</constant> |
| 502 | and <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>=0 layer has to be <constant>DQPSK</constant>.</para> |
| 503 | </section> |
| 504 | <section id="DTV-ISDBT-LAYER-SEGMENT-COUNT"> |
| 505 | <title><constant>DTV_ISDBT_LAYER*_SEGMENT_COUNT</constant></title> |
| 506 | <para>Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)</para> |
| 507 | <para>Note: Truth table for <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> and |
| 508 | <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> and <constant>LAYER</constant>*_SEGMENT_COUNT</para> |
| 509 | <informaltable id="isdbt-layer_seg-cnt-table"> |
| 510 | <tgroup cols="6"> |
| 511 | <tbody> |
| 512 | <row> |
| 513 | <entry>PR</entry> |
| 514 | <entry>SB</entry> |
| 515 | <entry>Layer A width</entry> |
| 516 | <entry>Layer B width</entry> |
| 517 | <entry>Layer C width</entry> |
| 518 | <entry>total width</entry> |
| 519 | </row> |
| 520 | <row> |
| 521 | <entry>0</entry> |
| 522 | <entry>0</entry> |
| 523 | <entry>1 .. 13</entry> |
| 524 | <entry>1 .. 13</entry> |
| 525 | <entry>1 .. 13</entry> |
| 526 | <entry>13</entry> |
| 527 | </row> |
| 528 | <row> |
| 529 | <entry>1</entry> |
| 530 | <entry>0</entry> |
| 531 | <entry>1</entry> |
| 532 | <entry>1 .. 13</entry> |
| 533 | <entry>1 .. 13</entry> |
| 534 | <entry>13</entry> |
| 535 | </row> |
| 536 | <row> |
| 537 | <entry>0</entry> |
| 538 | <entry>1</entry> |
| 539 | <entry>1</entry> |
| 540 | <entry>0</entry> |
| 541 | <entry>0</entry> |
| 542 | <entry>1</entry> |
| 543 | </row> |
| 544 | <row> |
| 545 | <entry>1</entry> |
| 546 | <entry>1</entry> |
| 547 | <entry>1</entry> |
| 548 | <entry>2</entry> |
| 549 | <entry>0</entry> |
| 550 | <entry>13</entry> |
| 551 | </row> |
| 552 | </tbody> |
| 553 | </tgroup> |
| 554 | </informaltable> |
| 555 | </section> |
| 556 | <section id="DTV-ISDBT-LAYER-TIME-INTERLEAVING"> |
| 557 | <title><constant>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</constant></title> |
Mauro Carvalho Chehab | 18b258d | 2014-07-11 21:37:46 -0300 | [diff] [blame] | 558 | <para>Valid values: 0, 1, 2, 4, -1 (AUTO)</para> |
| 559 | <para>when DTV_ISDBT_SOUND_BROADCASTING is active, value 8 is also valid.</para> |
| 560 | <para>Note: The real time interleaving length depends on the mode (fft-size). The values |
| 561 | here are referring to what can be found in the TMCC-structure, as shown in the table below.</para> |
| 562 | <informaltable id="isdbt-layer-interleaving-table"> |
| 563 | <tgroup cols="4" align="center"> |
| 564 | <tbody> |
| 565 | <row> |
| 566 | <entry>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</entry> |
| 567 | <entry>Mode 1 (2K FFT)</entry> |
| 568 | <entry>Mode 2 (4K FFT)</entry> |
| 569 | <entry>Mode 3 (8K FFT)</entry> |
| 570 | </row> |
| 571 | <row> |
| 572 | <entry>0</entry> |
| 573 | <entry>0</entry> |
| 574 | <entry>0</entry> |
| 575 | <entry>0</entry> |
| 576 | </row> |
| 577 | <row> |
| 578 | <entry>1</entry> |
| 579 | <entry>4</entry> |
| 580 | <entry>2</entry> |
| 581 | <entry>1</entry> |
| 582 | </row> |
| 583 | <row> |
| 584 | <entry>2</entry> |
| 585 | <entry>8</entry> |
| 586 | <entry>4</entry> |
| 587 | <entry>2</entry> |
| 588 | </row> |
| 589 | <row> |
| 590 | <entry>4</entry> |
| 591 | <entry>16</entry> |
| 592 | <entry>8</entry> |
| 593 | <entry>4</entry> |
| 594 | </row> |
| 595 | </tbody> |
| 596 | </tgroup> |
| 597 | </informaltable> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 598 | </section> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 599 | <section id="DTV-ATSCMH-FIC-VER"> |
| 600 | <title><constant>DTV_ATSCMH_FIC_VER</constant></title> |
| 601 | <para>Version number of the FIC (Fast Information Channel) signaling data.</para> |
| 602 | <para>FIC is used for relaying information to allow rapid service acquisition by the receiver.</para> |
| 603 | <para>Possible values: 0, 1, 2, 3, ..., 30, 31</para> |
| 604 | </section> |
| 605 | <section id="DTV-ATSCMH-PARADE-ID"> |
| 606 | <title><constant>DTV_ATSCMH_PARADE_ID</constant></title> |
| 607 | <para>Parade identification number</para> |
| 608 | <para>A parade is a collection of up to eight MH groups, conveying one or two ensembles.</para> |
| 609 | <para>Possible values: 0, 1, 2, 3, ..., 126, 127</para> |
| 610 | </section> |
| 611 | <section id="DTV-ATSCMH-NOG"> |
| 612 | <title><constant>DTV_ATSCMH_NOG</constant></title> |
| 613 | <para>Number of MH groups per MH subframe for a designated parade.</para> |
| 614 | <para>Possible values: 1, 2, 3, 4, 5, 6, 7, 8</para> |
| 615 | </section> |
| 616 | <section id="DTV-ATSCMH-TNOG"> |
| 617 | <title><constant>DTV_ATSCMH_TNOG</constant></title> |
| 618 | <para>Total number of MH groups including all MH groups belonging to all MH parades in one MH subframe.</para> |
| 619 | <para>Possible values: 0, 1, 2, 3, ..., 30, 31</para> |
| 620 | </section> |
| 621 | <section id="DTV-ATSCMH-SGN"> |
| 622 | <title><constant>DTV_ATSCMH_SGN</constant></title> |
| 623 | <para>Start group number.</para> |
| 624 | <para>Possible values: 0, 1, 2, 3, ..., 14, 15</para> |
| 625 | </section> |
| 626 | <section id="DTV-ATSCMH-PRC"> |
| 627 | <title><constant>DTV_ATSCMH_PRC</constant></title> |
| 628 | <para>Parade repetition cycle.</para> |
| 629 | <para>Possible values: 1, 2, 3, 4, 5, 6, 7, 8</para> |
| 630 | </section> |
| 631 | <section id="DTV-ATSCMH-RS-FRAME-MODE"> |
| 632 | <title><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></title> |
| 633 | <para>RS frame mode.</para> |
| 634 | <para>Possible values are:</para> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 635 | <para id="atscmh-rs-frame-mode"> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 636 | <programlisting> |
| 637 | typedef enum atscmh_rs_frame_mode { |
| 638 | ATSCMH_RSFRAME_PRI_ONLY = 0, |
| 639 | ATSCMH_RSFRAME_PRI_SEC = 1, |
| 640 | } atscmh_rs_frame_mode_t; |
| 641 | </programlisting> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 642 | </para> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 643 | </section> |
| 644 | <section id="DTV-ATSCMH-RS-FRAME-ENSEMBLE"> |
| 645 | <title><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></title> |
| 646 | <para>RS frame ensemble.</para> |
| 647 | <para>Possible values are:</para> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 648 | <para id="atscmh-rs-frame-ensemble"> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 649 | <programlisting> |
| 650 | typedef enum atscmh_rs_frame_ensemble { |
| 651 | ATSCMH_RSFRAME_ENS_PRI = 0, |
| 652 | ATSCMH_RSFRAME_ENS_SEC = 1, |
| 653 | } atscmh_rs_frame_ensemble_t; |
| 654 | </programlisting> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 655 | </para> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 656 | </section> |
| 657 | <section id="DTV-ATSCMH-RS-CODE-MODE-PRI"> |
| 658 | <title><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></title> |
| 659 | <para>RS code mode (primary).</para> |
| 660 | <para>Possible values are:</para> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 661 | <para id="atscmh-rs-code-mode"> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 662 | <programlisting> |
| 663 | typedef enum atscmh_rs_code_mode { |
| 664 | ATSCMH_RSCODE_211_187 = 0, |
| 665 | ATSCMH_RSCODE_223_187 = 1, |
| 666 | ATSCMH_RSCODE_235_187 = 2, |
| 667 | } atscmh_rs_code_mode_t; |
| 668 | </programlisting> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 669 | </para> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 670 | </section> |
| 671 | <section id="DTV-ATSCMH-RS-CODE-MODE-SEC"> |
| 672 | <title><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></title> |
| 673 | <para>RS code mode (secondary).</para> |
| 674 | <para>Possible values are:</para> |
| 675 | <programlisting> |
| 676 | typedef enum atscmh_rs_code_mode { |
| 677 | ATSCMH_RSCODE_211_187 = 0, |
| 678 | ATSCMH_RSCODE_223_187 = 1, |
| 679 | ATSCMH_RSCODE_235_187 = 2, |
| 680 | } atscmh_rs_code_mode_t; |
| 681 | </programlisting> |
| 682 | </section> |
| 683 | <section id="DTV-ATSCMH-SCCC-BLOCK-MODE"> |
| 684 | <title><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></title> |
| 685 | <para>Series Concatenated Convolutional Code Block Mode.</para> |
| 686 | <para>Possible values are:</para> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 687 | <para id="atscmh-sccc-block-mode"> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 688 | <programlisting> |
| 689 | typedef enum atscmh_sccc_block_mode { |
| 690 | ATSCMH_SCCC_BLK_SEP = 0, |
| 691 | ATSCMH_SCCC_BLK_COMB = 1, |
| 692 | } atscmh_sccc_block_mode_t; |
| 693 | </programlisting> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 694 | </para> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 695 | </section> |
| 696 | <section id="DTV-ATSCMH-SCCC-CODE-MODE-A"> |
| 697 | <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></title> |
| 698 | <para>Series Concatenated Convolutional Code Rate.</para> |
| 699 | <para>Possible values are:</para> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 700 | <para id="atscmh-sccc-code-mode"> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 701 | <programlisting> |
| 702 | typedef enum atscmh_sccc_code_mode { |
| 703 | ATSCMH_SCCC_CODE_HLF = 0, |
| 704 | ATSCMH_SCCC_CODE_QTR = 1, |
| 705 | } atscmh_sccc_code_mode_t; |
| 706 | </programlisting> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 707 | </para> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 708 | </section> |
| 709 | <section id="DTV-ATSCMH-SCCC-CODE-MODE-B"> |
| 710 | <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></title> |
| 711 | <para>Series Concatenated Convolutional Code Rate.</para> |
| 712 | <para>Possible values are:</para> |
| 713 | <programlisting> |
| 714 | typedef enum atscmh_sccc_code_mode { |
| 715 | ATSCMH_SCCC_CODE_HLF = 0, |
| 716 | ATSCMH_SCCC_CODE_QTR = 1, |
| 717 | } atscmh_sccc_code_mode_t; |
| 718 | </programlisting> |
| 719 | </section> |
| 720 | <section id="DTV-ATSCMH-SCCC-CODE-MODE-C"> |
| 721 | <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></title> |
| 722 | <para>Series Concatenated Convolutional Code Rate.</para> |
| 723 | <para>Possible values are:</para> |
| 724 | <programlisting> |
| 725 | typedef enum atscmh_sccc_code_mode { |
| 726 | ATSCMH_SCCC_CODE_HLF = 0, |
| 727 | ATSCMH_SCCC_CODE_QTR = 1, |
| 728 | } atscmh_sccc_code_mode_t; |
| 729 | </programlisting> |
| 730 | </section> |
| 731 | <section id="DTV-ATSCMH-SCCC-CODE-MODE-D"> |
| 732 | <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></title> |
| 733 | <para>Series Concatenated Convolutional Code Rate.</para> |
| 734 | <para>Possible values are:</para> |
| 735 | <programlisting> |
| 736 | typedef enum atscmh_sccc_code_mode { |
| 737 | ATSCMH_SCCC_CODE_HLF = 0, |
| 738 | ATSCMH_SCCC_CODE_QTR = 1, |
| 739 | } atscmh_sccc_code_mode_t; |
| 740 | </programlisting> |
| 741 | </section> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 742 | </section> |
Mauro Carvalho Chehab | 04a9207 | 2011-06-07 19:37:47 -0300 | [diff] [blame] | 743 | <section id="DTV-API-VERSION"> |
| 744 | <title><constant>DTV_API_VERSION</constant></title> |
| 745 | <para>Returns the major/minor version of the DVB API</para> |
| 746 | </section> |
| 747 | <section id="DTV-CODE-RATE-HP"> |
| 748 | <title><constant>DTV_CODE_RATE_HP</constant></title> |
| 749 | <para>Used on terrestrial transmissions. The acceptable values are: |
| 750 | </para> |
| 751 | <programlisting> |
| 752 | typedef enum fe_code_rate { |
| 753 | FEC_NONE = 0, |
| 754 | FEC_1_2, |
| 755 | FEC_2_3, |
| 756 | FEC_3_4, |
| 757 | FEC_4_5, |
| 758 | FEC_5_6, |
| 759 | FEC_6_7, |
| 760 | FEC_7_8, |
| 761 | FEC_8_9, |
| 762 | FEC_AUTO, |
| 763 | FEC_3_5, |
| 764 | FEC_9_10, |
| 765 | } fe_code_rate_t; |
| 766 | </programlisting> |
| 767 | </section> |
| 768 | <section id="DTV-CODE-RATE-LP"> |
| 769 | <title><constant>DTV_CODE_RATE_LP</constant></title> |
| 770 | <para>Used on terrestrial transmissions. The acceptable values are: |
| 771 | </para> |
| 772 | <programlisting> |
| 773 | typedef enum fe_code_rate { |
| 774 | FEC_NONE = 0, |
| 775 | FEC_1_2, |
| 776 | FEC_2_3, |
| 777 | FEC_3_4, |
| 778 | FEC_4_5, |
| 779 | FEC_5_6, |
| 780 | FEC_6_7, |
| 781 | FEC_7_8, |
| 782 | FEC_8_9, |
| 783 | FEC_AUTO, |
| 784 | FEC_3_5, |
| 785 | FEC_9_10, |
| 786 | } fe_code_rate_t; |
| 787 | </programlisting> |
| 788 | </section> |
Mauro Carvalho Chehab | 95e61e0 | 2011-06-07 16:58:00 -0300 | [diff] [blame] | 789 | <section id="DTV-GUARD-INTERVAL"> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 790 | <title><constant>DTV_GUARD_INTERVAL</constant></title> |
| 791 | |
| 792 | <para>Possible values are:</para> |
| 793 | <programlisting> |
| 794 | typedef enum fe_guard_interval { |
| 795 | GUARD_INTERVAL_1_32, |
| 796 | GUARD_INTERVAL_1_16, |
| 797 | GUARD_INTERVAL_1_8, |
| 798 | GUARD_INTERVAL_1_4, |
Steve Kerrison | cf75f9b | 2011-05-08 16:17:20 -0300 | [diff] [blame] | 799 | GUARD_INTERVAL_AUTO, |
| 800 | GUARD_INTERVAL_1_128, |
| 801 | GUARD_INTERVAL_19_128, |
| 802 | GUARD_INTERVAL_19_256, |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 803 | GUARD_INTERVAL_PN420, |
| 804 | GUARD_INTERVAL_PN595, |
| 805 | GUARD_INTERVAL_PN945, |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 806 | } fe_guard_interval_t; |
| 807 | </programlisting> |
| 808 | |
| 809 | <para>Notes:</para> |
| 810 | <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will |
| 811 | try to find the correct guard interval (if capable) and will use TMCC to fill |
| 812 | in the missing parameters.</para> |
Steve Kerrison | cf75f9b | 2011-05-08 16:17:20 -0300 | [diff] [blame] | 813 | <para>2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at present</para> |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 814 | <para>3) DTMB specifies PN420, PN595 and PN945.</para> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 815 | </section> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 816 | <section id="DTV-TRANSMISSION-MODE"> |
| 817 | <title><constant>DTV_TRANSMISSION_MODE</constant></title> |
Mauro Carvalho Chehab | 0ed08b4 | 2011-05-06 12:32:03 -0300 | [diff] [blame] | 818 | |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 819 | <para>Specifies the number of carriers used by the standard</para> |
Mauro Carvalho Chehab | 453d63c | 2009-09-16 23:22:05 -0300 | [diff] [blame] | 820 | |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 821 | <para>Possible values are:</para> |
| 822 | <programlisting> |
| 823 | typedef enum fe_transmit_mode { |
| 824 | TRANSMISSION_MODE_2K, |
| 825 | TRANSMISSION_MODE_8K, |
| 826 | TRANSMISSION_MODE_AUTO, |
| 827 | TRANSMISSION_MODE_4K, |
| 828 | TRANSMISSION_MODE_1K, |
| 829 | TRANSMISSION_MODE_16K, |
| 830 | TRANSMISSION_MODE_32K, |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 831 | TRANSMISSION_MODE_C1, |
| 832 | TRANSMISSION_MODE_C3780, |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 833 | } fe_transmit_mode_t; |
| 834 | </programlisting> |
| 835 | <para>Notes:</para> |
| 836 | <para>1) ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called |
| 837 | 'mode' in the standard: Mode 1 is 2K, mode 2 is 4K, mode 3 is 8K</para> |
Mauro Carvalho Chehab | 453d63c | 2009-09-16 23:22:05 -0300 | [diff] [blame] | 838 | |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 839 | <para>2) If <constant>DTV_TRANSMISSION_MODE</constant> is set the <constant>TRANSMISSION_MODE_AUTO</constant> the |
| 840 | hardware will try to find the correct FFT-size (if capable) and will |
| 841 | use TMCC to fill in the missing parameters.</para> |
| 842 | <para>3) DVB-T specifies 2K and 8K as valid sizes.</para> |
| 843 | <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para> |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 844 | <para>5) DTMB specifies C1 and C3780.</para> |
Mauro Carvalho Chehab | 453d63c | 2009-09-16 23:22:05 -0300 | [diff] [blame] | 845 | </section> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 846 | <section id="DTV-HIERARCHY"> |
| 847 | <title><constant>DTV_HIERARCHY</constant></title> |
| 848 | <para>Frontend hierarchy</para> |
| 849 | <programlisting> |
| 850 | typedef enum fe_hierarchy { |
| 851 | HIERARCHY_NONE, |
| 852 | HIERARCHY_1, |
| 853 | HIERARCHY_2, |
| 854 | HIERARCHY_4, |
| 855 | HIERARCHY_AUTO |
| 856 | } fe_hierarchy_t; |
| 857 | </programlisting> |
| 858 | </section> |
Evgeny Plehov | 8180015 | 2012-09-13 10:16:28 -0300 | [diff] [blame] | 859 | <section id="DTV-STREAM-ID"> |
| 860 | <title><constant>DTV_STREAM_ID</constant></title> |
| 861 | <para>DVB-S2, DVB-T2 and ISDB-S support the transmission of several |
| 862 | streams on a single transport stream. |
| 863 | This property enables the DVB driver to handle substream filtering, |
| 864 | when supported by the hardware. |
| 865 | By default, substream filtering is disabled. |
| 866 | </para><para> |
| 867 | For DVB-S2 and DVB-T2, the valid substream id range is from 0 to 255. |
| 868 | </para><para> |
| 869 | For ISDB, the valid substream id range is from 1 to 65535. |
| 870 | </para><para> |
| 871 | To disable it, you should use the special macro NO_STREAM_ID_FILTER. |
| 872 | </para><para> |
| 873 | Note: any value outside the id range also disables filtering. |
| 874 | </para> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 875 | </section> |
Evgeny Plehov | 8180015 | 2012-09-13 10:16:28 -0300 | [diff] [blame] | 876 | <section id="DTV-DVBT2-PLP-ID-LEGACY"> |
| 877 | <title><constant>DTV_DVBT2_PLP_ID_LEGACY</constant></title> |
| 878 | <para>Obsolete, replaced with DTV_STREAM_ID.</para> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 879 | </section> |
Hans Verkuil | 510f0a0 | 2012-08-09 06:41:43 -0300 | [diff] [blame] | 880 | <section id="DTV-ENUM-DELSYS"> |
Manu Abraham | 6c7ef54 | 2011-11-16 10:34:24 -0300 | [diff] [blame] | 881 | <title><constant>DTV_ENUM_DELSYS</constant></title> |
| 882 | <para>A Multi standard frontend needs to advertise the delivery systems provided. |
| 883 | Applications need to enumerate the provided delivery systems, before using |
| 884 | any other operation with the frontend. Prior to it's introduction, |
| 885 | FE_GET_INFO was used to determine a frontend type. A frontend which |
| 886 | provides more than a single delivery system, FE_GET_INFO doesn't help much. |
| 887 | Applications which intends to use a multistandard frontend must enumerate |
| 888 | the delivery systems associated with it, rather than trying to use |
| 889 | FE_GET_INFO. In the case of a legacy frontend, the result is just the same |
| 890 | as with FE_GET_INFO, but in a more structured format </para> |
| 891 | </section> |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 892 | <section id="DTV-INTERLEAVING"> |
| 893 | <title><constant>DTV_INTERLEAVING</constant></title> |
Hans Verkuil | 071408b | 2012-08-14 06:10:01 -0300 | [diff] [blame] | 894 | <para id="fe-interleaving">Interleaving mode</para> |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 895 | <programlisting> |
| 896 | enum fe_interleaving { |
| 897 | INTERLEAVING_NONE, |
Antti Palosaari | 8746add | 2012-08-12 22:33:22 -0300 | [diff] [blame] | 898 | INTERLEAVING_AUTO, |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 899 | INTERLEAVING_240, |
| 900 | INTERLEAVING_720, |
| 901 | }; |
| 902 | </programlisting> |
| 903 | </section> |
Antti Palosaari | ee47e2f | 2012-08-16 22:19:29 -0300 | [diff] [blame] | 904 | <section id="DTV-LNA"> |
| 905 | <title><constant>DTV_LNA</constant></title> |
| 906 | <para>Low-noise amplifier.</para> |
| 907 | <para>Hardware might offer controllable LNA which can be set manually |
| 908 | using that parameter. Usually LNA could be found only from |
| 909 | terrestrial devices if at all.</para> |
| 910 | <para>Possible values: 0, 1, LNA_AUTO</para> |
| 911 | <para>0, LNA off</para> |
| 912 | <para>1, LNA on</para> |
| 913 | <para>use the special macro LNA_AUTO to set LNA auto</para> |
| 914 | </section> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 915 | </section> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 916 | |
| 917 | <section id="frontend-stat-properties"> |
| 918 | <title>Frontend statistics indicators</title> |
| 919 | <para>The values are returned via <constant>dtv_property.stat</constant>. |
| 920 | If the property is supported, <constant>dtv_property.stat.len</constant> is bigger than zero.</para> |
| 921 | <para>For most delivery systems, <constant>dtv_property.stat.len</constant> |
| 922 | will be 1 if the stats is supported, and the properties will |
| 923 | return a single value for each parameter.</para> |
| 924 | <para>It should be noticed, however, that new OFDM delivery systems |
| 925 | like ISDB can use different modulation types for each group of |
| 926 | carriers. On such standards, up to 3 groups of statistics can be |
| 927 | provided, and <constant>dtv_property.stat.len</constant> is updated |
| 928 | to reflect the "global" metrics, plus one metric per each carrier |
| 929 | group (called "layer" on ISDB).</para> |
| 930 | <para>So, in order to be consistent with other delivery systems, the first |
| 931 | value at <link linkend="dtv-stats"><constant>dtv_property.stat.dtv_stats</constant></link> |
| 932 | array refers to the global metric. The other elements of the array |
| 933 | represent each layer, starting from layer A(index 1), |
| 934 | layer B (index 2) and so on.</para> |
| 935 | <para>The number of filled elements are stored at <constant>dtv_property.stat.len</constant>.</para> |
| 936 | <para>Each element of the <constant>dtv_property.stat.dtv_stats</constant> array consists on two elements:</para> |
| 937 | <itemizedlist mark='opencircle'> |
| 938 | <listitem><para><constant>svalue</constant> or <constant>uvalue</constant>, where |
| 939 | <constant>svalue</constant> is for signed values of the measure (dB measures) |
| 940 | and <constant>uvalue</constant> is for unsigned values (counters, relative scale)</para></listitem> |
| 941 | <listitem><para><constant>scale</constant> - Scale for the value. It can be:</para> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 942 | <itemizedlist mark='bullet' id="fecap-scale-params"> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 943 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - The parameter is supported by the frontend, but it was not possible to collect it (could be a transitory or permanent condition)</para></listitem> |
| 944 | <listitem><para><constant>FE_SCALE_DECIBEL</constant> - parameter is a signed value, measured in 1/1000 dB</para></listitem> |
| 945 | <listitem><para><constant>FE_SCALE_RELATIVE</constant> - parameter is a unsigned value, where 0 means 0% and 65535 means 100%.</para></listitem> |
| 946 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - parameter is a unsigned value that counts the occurrence of an event, like bit error, block error, or lapsed time.</para></listitem> |
| 947 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 948 | </listitem> |
| 949 | </itemizedlist> |
| 950 | <section id="DTV-STAT-SIGNAL-STRENGTH"> |
| 951 | <title><constant>DTV_STAT_SIGNAL_STRENGTH</constant></title> |
| 952 | <para>Indicates the signal strength level at the analog part of the tuner or of the demod.</para> |
| 953 | <para>Possible scales for this metric are:</para> |
| 954 | <itemizedlist mark='bullet'> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 955 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
| 956 | <listitem><para><constant>FE_SCALE_DECIBEL</constant> - signal strength is in 0.0001 dBm units, power measured in miliwatts. This value is generally negative.</para></listitem> |
| 957 | <listitem><para><constant>FE_SCALE_RELATIVE</constant> - The frontend provides a 0% to 100% measurement for power (actually, 0 to 65535).</para></listitem> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 958 | </itemizedlist> |
| 959 | </section> |
| 960 | <section id="DTV-STAT-CNR"> |
| 961 | <title><constant>DTV_STAT_CNR</constant></title> |
| 962 | <para>Indicates the Signal to Noise ratio for the main carrier.</para> |
| 963 | <para>Possible scales for this metric are:</para> |
| 964 | <itemizedlist mark='bullet'> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 965 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
| 966 | <listitem><para><constant>FE_SCALE_DECIBEL</constant> - Signal/Noise ratio is in 0.0001 dB units.</para></listitem> |
| 967 | <listitem><para><constant>FE_SCALE_RELATIVE</constant> - The frontend provides a 0% to 100% measurement for Signal/Noise (actually, 0 to 65535).</para></listitem> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 968 | </itemizedlist> |
| 969 | </section> |
| 970 | <section id="DTV-STAT-PRE-ERROR-BIT-COUNT"> |
| 971 | <title><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></title> |
| 972 | <para>Measures the number of bit errors before the forward error correction (FEC) on the inner coding block (before Viterbi, LDPC or other inner code).</para> |
| 973 | <para>This measure is taken during the same interval as <constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant>.</para> |
| 974 | <para>In order to get the BER (Bit Error Rate) measurement, it should be divided by |
| 975 | <link linkend="DTV-STAT-PRE-TOTAL-BIT-COUNT"><constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant></link>.</para> |
| 976 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. |
| 977 | The frontend may reset it when a channel/transponder is tuned.</para> |
| 978 | <para>Possible scales for this metric are:</para> |
| 979 | <itemizedlist mark='bullet'> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 980 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
| 981 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error bits counted before the inner coding.</para></listitem> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 982 | </itemizedlist> |
| 983 | </section> |
| 984 | <section id="DTV-STAT-PRE-TOTAL-BIT-COUNT"> |
| 985 | <title><constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant></title> |
| 986 | <para>Measures the amount of bits received before the inner code block, during the same period as |
| 987 | <link linkend="DTV-STAT-PRE-ERROR-BIT-COUNT"><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></link> measurement was taken.</para> |
| 988 | <para>It should be noticed that this measurement can be smaller than the total amount of bits on the transport stream, |
Masanari Iida | 842059a | 2013-03-24 02:25:56 -0300 | [diff] [blame] | 989 | as the frontend may need to manually restart the measurement, losing some data between each measurement interval.</para> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 990 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. |
| 991 | The frontend may reset it when a channel/transponder is tuned.</para> |
| 992 | <para>Possible scales for this metric are:</para> |
| 993 | <itemizedlist mark='bullet'> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 994 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
| 995 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of bits counted while measuring |
| 996 | <link linkend="DTV-STAT-PRE-ERROR-BIT-COUNT"><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></link>.</para></listitem> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 997 | </itemizedlist> |
| 998 | </section> |
| 999 | <section id="DTV-STAT-POST-ERROR-BIT-COUNT"> |
| 1000 | <title><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></title> |
| 1001 | <para>Measures the number of bit errors after the forward error correction (FEC) done by inner code block (after Viterbi, LDPC or other inner code).</para> |
| 1002 | <para>This measure is taken during the same interval as <constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant>.</para> |
| 1003 | <para>In order to get the BER (Bit Error Rate) measurement, it should be divided by |
| 1004 | <link linkend="DTV-STAT-POST-TOTAL-BIT-COUNT"><constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant></link>.</para> |
| 1005 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. |
| 1006 | The frontend may reset it when a channel/transponder is tuned.</para> |
| 1007 | <para>Possible scales for this metric are:</para> |
| 1008 | <itemizedlist mark='bullet'> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 1009 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
| 1010 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error bits counted after the inner coding.</para></listitem> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1011 | </itemizedlist> |
| 1012 | </section> |
| 1013 | <section id="DTV-STAT-POST-TOTAL-BIT-COUNT"> |
| 1014 | <title><constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant></title> |
| 1015 | <para>Measures the amount of bits received after the inner coding, during the same period as |
| 1016 | <link linkend="DTV-STAT-POST-ERROR-BIT-COUNT"><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></link> measurement was taken.</para> |
| 1017 | <para>It should be noticed that this measurement can be smaller than the total amount of bits on the transport stream, |
Masanari Iida | 842059a | 2013-03-24 02:25:56 -0300 | [diff] [blame] | 1018 | as the frontend may need to manually restart the measurement, losing some data between each measurement interval.</para> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1019 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. |
| 1020 | The frontend may reset it when a channel/transponder is tuned.</para> |
| 1021 | <para>Possible scales for this metric are:</para> |
| 1022 | <itemizedlist mark='bullet'> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 1023 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
| 1024 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of bits counted while measuring |
| 1025 | <link linkend="DTV-STAT-POST-ERROR-BIT-COUNT"><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></link>.</para></listitem> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1026 | </itemizedlist> |
| 1027 | </section> |
| 1028 | <section id="DTV-STAT-ERROR-BLOCK-COUNT"> |
| 1029 | <title><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></title> |
| 1030 | <para>Measures the number of block errors after the outer forward error correction coding (after Reed-Solomon or other outer code).</para> |
| 1031 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. |
| 1032 | The frontend may reset it when a channel/transponder is tuned.</para> |
| 1033 | <para>Possible scales for this metric are:</para> |
| 1034 | <itemizedlist mark='bullet'> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 1035 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
| 1036 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error blocks counted after the outer coding.</para></listitem> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1037 | </itemizedlist> |
| 1038 | </section> |
| 1039 | <section id="DTV-STAT-TOTAL-BLOCK-COUNT"> |
| 1040 | <title><constant>DTV-STAT_TOTAL_BLOCK_COUNT</constant></title> |
| 1041 | <para>Measures the total number of blocks received during the same period as |
| 1042 | <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link> measurement was taken.</para> |
| 1043 | <para>It can be used to calculate the PER indicator, by dividing |
| 1044 | <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link> |
| 1045 | by <link linkend="DTV-STAT-TOTAL-BLOCK-COUNT"><constant>DTV-STAT-TOTAL-BLOCK-COUNT</constant></link>.</para> |
| 1046 | <para>Possible scales for this metric are:</para> |
| 1047 | <itemizedlist mark='bullet'> |
Hans Verkuil | 820eac0 | 2013-03-18 13:20:00 -0300 | [diff] [blame] | 1048 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
| 1049 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of blocks counted while measuring |
| 1050 | <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link>.</para></listitem> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1051 | </itemizedlist> |
| 1052 | </section> |
| 1053 | </section> |
| 1054 | |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1055 | <section id="frontend-property-terrestrial-systems"> |
| 1056 | <title>Properties used on terrestrial delivery systems</title> |
| 1057 | <section id="dvbt-params"> |
| 1058 | <title>DVB-T delivery system</title> |
| 1059 | <para>The following parameters are valid for DVB-T:</para> |
| 1060 | <itemizedlist mark='opencircle'> |
| 1061 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1062 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1063 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1064 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1065 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1066 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
| 1067 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> |
| 1068 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> |
| 1069 | <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem> |
| 1070 | <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem> |
| 1071 | <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem> |
| 1072 | <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem> |
| 1073 | <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem> |
Antti Palosaari | ee47e2f | 2012-08-16 22:19:29 -0300 | [diff] [blame] | 1074 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1075 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1076 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1077 | </section> |
| 1078 | <section id="dvbt2-params"> |
| 1079 | <title>DVB-T2 delivery system</title> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1080 | <para>DVB-T2 support is currently in the early stages |
| 1081 | of development, so expect that this section maygrow and become |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1082 | more detailed with time.</para> |
| 1083 | <para>The following parameters are valid for DVB-T2:</para> |
| 1084 | <itemizedlist mark='opencircle'> |
| 1085 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1086 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1087 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1088 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1089 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1090 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
| 1091 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> |
| 1092 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> |
| 1093 | <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem> |
| 1094 | <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem> |
| 1095 | <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem> |
| 1096 | <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem> |
| 1097 | <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem> |
Evgeny Plehov | 8180015 | 2012-09-13 10:16:28 -0300 | [diff] [blame] | 1098 | <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem> |
Antti Palosaari | ee47e2f | 2012-08-16 22:19:29 -0300 | [diff] [blame] | 1099 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1100 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1101 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1102 | </section> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 1103 | <section id="isdbt"> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1104 | <title>ISDB-T delivery system</title> |
Mauro Carvalho Chehab | 17d8bb0 | 2011-06-07 20:05:13 -0300 | [diff] [blame] | 1105 | <para>This ISDB-T/ISDB-Tsb API extension should reflect all information |
| 1106 | needed to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible |
| 1107 | that some very sophisticated devices won't need certain parameters to |
| 1108 | tune.</para> |
| 1109 | <para>The information given here should help application writers to know how |
| 1110 | to handle ISDB-T and ISDB-Tsb hardware using the Linux DVB-API.</para> |
| 1111 | <para>The details given here about ISDB-T and ISDB-Tsb are just enough to |
| 1112 | basically show the dependencies between the needed parameter values, |
| 1113 | but surely some information is left out. For more detailed information |
| 1114 | see the following documents:</para> |
| 1115 | <para>ARIB STD-B31 - "Transmission System for Digital Terrestrial |
| 1116 | Television Broadcasting" and</para> |
| 1117 | <para>ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial |
| 1118 | Television Broadcasting".</para> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1119 | <para>In order to understand the ISDB specific parameters, |
| 1120 | one has to have some knowledge the channel structure in |
| 1121 | ISDB-T and ISDB-Tsb. I.e. it has to be known to |
| 1122 | the reader that an ISDB-T channel consists of 13 segments, |
| 1123 | that it can have up to 3 layer sharing those segments, |
| 1124 | and things like that.</para> |
| 1125 | <para>The following parameters are valid for ISDB-T:</para> |
| 1126 | <itemizedlist mark='opencircle'> |
| 1127 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1128 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1129 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1130 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1131 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1132 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> |
| 1133 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1134 | <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem> |
| 1135 | <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1136 | <listitem><para><link linkend="DTV-ISDBT-LAYER-ENABLED"><constant>DTV_ISDBT_LAYER_ENABLED</constant></link></para></listitem> |
| 1137 | <listitem><para><link linkend="DTV-ISDBT-PARTIAL-RECEPTION"><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></link></para></listitem> |
| 1138 | <listitem><para><link linkend="DTV-ISDBT-SOUND-BROADCASTING"><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></link></para></listitem> |
| 1139 | <listitem><para><link linkend="DTV-ISDBT-SB-SUBCHANNEL-ID"><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></link></para></listitem> |
| 1140 | <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-IDX"><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></link></para></listitem> |
| 1141 | <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-COUNT"><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></link></para></listitem> |
| 1142 | <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERA_FEC</constant></link></para></listitem> |
| 1143 | <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERA_MODULATION</constant></link></para></listitem> |
| 1144 | <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant></link></para></listitem> |
| 1145 | <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERA_TIME_INTERLEAVING</constant></link></para></listitem> |
| 1146 | <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERB_FEC</constant></link></para></listitem> |
| 1147 | <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERB_MODULATION</constant></link></para></listitem> |
| 1148 | <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERB_SEGMENT_COUNT</constant></link></para></listitem> |
| 1149 | <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERB_TIME_INTERLEAVING</constant></link></para></listitem> |
| 1150 | <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERC_FEC</constant></link></para></listitem> |
| 1151 | <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERC_MODULATION</constant></link></para></listitem> |
| 1152 | <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERC_SEGMENT_COUNT</constant></link></para></listitem> |
| 1153 | <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERC_TIME_INTERLEAVING</constant></link></para></listitem> |
| 1154 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1155 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Steve Kerrison | cf75f9b | 2011-05-08 16:17:20 -0300 | [diff] [blame] | 1156 | </section> |
Mauro Carvalho Chehab | 76f9a69 | 2011-06-07 22:08:13 -0300 | [diff] [blame] | 1157 | <section id="atsc-params"> |
| 1158 | <title>ATSC delivery system</title> |
| 1159 | <para>The following parameters are valid for ATSC:</para> |
| 1160 | <itemizedlist mark='opencircle'> |
| 1161 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
| 1162 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
| 1163 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1164 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1165 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1166 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
| 1167 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> |
| 1168 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1169 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Mauro Carvalho Chehab | 76f9a69 | 2011-06-07 22:08:13 -0300 | [diff] [blame] | 1170 | </section> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 1171 | <section id="atscmh-params"> |
| 1172 | <title>ATSC-MH delivery system</title> |
| 1173 | <para>The following parameters are valid for ATSC-MH:</para> |
| 1174 | <itemizedlist mark='opencircle'> |
| 1175 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
| 1176 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
| 1177 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1178 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1179 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1180 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> |
| 1181 | <listitem><para><link linkend="DTV-ATSCMH-FIC-VER"><constant>DTV_ATSCMH_FIC_VER</constant></link></para></listitem> |
| 1182 | <listitem><para><link linkend="DTV-ATSCMH-PARADE-ID"><constant>DTV_ATSCMH_PARADE_ID</constant></link></para></listitem> |
| 1183 | <listitem><para><link linkend="DTV-ATSCMH-NOG"><constant>DTV_ATSCMH_NOG</constant></link></para></listitem> |
| 1184 | <listitem><para><link linkend="DTV-ATSCMH-TNOG"><constant>DTV_ATSCMH_TNOG</constant></link></para></listitem> |
| 1185 | <listitem><para><link linkend="DTV-ATSCMH-SGN"><constant>DTV_ATSCMH_SGN</constant></link></para></listitem> |
| 1186 | <listitem><para><link linkend="DTV-ATSCMH-PRC"><constant>DTV_ATSCMH_PRC</constant></link></para></listitem> |
| 1187 | <listitem><para><link linkend="DTV-ATSCMH-RS-FRAME-MODE"><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></link></para></listitem> |
| 1188 | <listitem><para><link linkend="DTV-ATSCMH-RS-FRAME-ENSEMBLE"><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></link></para></listitem> |
Hans Verkuil | 510f0a0 | 2012-08-09 06:41:43 -0300 | [diff] [blame] | 1189 | <listitem><para><link linkend="DTV-ATSCMH-RS-CODE-MODE-PRI"><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></link></para></listitem> |
| 1190 | <listitem><para><link linkend="DTV-ATSCMH-RS-CODE-MODE-SEC"><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></link></para></listitem> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 1191 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-BLOCK-MODE"><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></link></para></listitem> |
Hans Verkuil | 510f0a0 | 2012-08-09 06:41:43 -0300 | [diff] [blame] | 1192 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-A"><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></link></para></listitem> |
| 1193 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-B"><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></link></para></listitem> |
| 1194 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-C"><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></link></para></listitem> |
| 1195 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-D"><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></link></para></listitem> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 1196 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1197 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Michael Krufky | edaa136 | 2012-04-29 12:59:46 -0300 | [diff] [blame] | 1198 | </section> |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 1199 | <section id="dtmb-params"> |
| 1200 | <title>DTMB delivery system</title> |
| 1201 | <para>The following parameters are valid for DTMB:</para> |
| 1202 | <itemizedlist mark='opencircle'> |
| 1203 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
| 1204 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
| 1205 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1206 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1207 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1208 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
| 1209 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> |
| 1210 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> |
| 1211 | <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem> |
| 1212 | <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem> |
| 1213 | <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem> |
| 1214 | <listitem><para><link linkend="DTV-INTERLEAVING"><constant>DTV_INTERLEAVING</constant></link></para></listitem> |
Antti Palosaari | ee47e2f | 2012-08-16 22:19:29 -0300 | [diff] [blame] | 1215 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 1216 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1217 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Antti Palosaari | 224b664 | 2012-08-12 22:33:21 -0300 | [diff] [blame] | 1218 | </section> |
Steve Kerrison | cf75f9b | 2011-05-08 16:17:20 -0300 | [diff] [blame] | 1219 | </section> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1220 | <section id="frontend-property-cable-systems"> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1221 | <title>Properties used on cable delivery systems</title> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1222 | <section id="dvbc-params"> |
| 1223 | <title>DVB-C delivery system</title> |
Mauro Carvalho Chehab | 669a4ba | 2011-12-17 20:36:56 -0300 | [diff] [blame] | 1224 | <para>The DVB-C Annex-A is the widely used cable standard. Transmission uses QAM modulation.</para> |
| 1225 | <para>The DVB-C Annex-C is optimized for 6MHz, and is used in Japan. It supports a subset of the Annex A modulation types, and a roll-off of 0.13, instead of 0.15</para> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1226 | <para>The following parameters are valid for DVB-C Annex A/C:</para> |
| 1227 | <itemizedlist mark='opencircle'> |
| 1228 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
| 1229 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
| 1230 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1231 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1232 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1233 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
| 1234 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> |
| 1235 | <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem> |
| 1236 | <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem> |
Antti Palosaari | ee47e2f | 2012-08-16 22:19:29 -0300 | [diff] [blame] | 1237 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1238 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1239 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1240 | </section> |
| 1241 | <section id="dvbc-annex-b-params"> |
| 1242 | <title>DVB-C Annex B delivery system</title> |
| 1243 | <para>The DVB-C Annex-B is only used on a few Countries like the United States.</para> |
| 1244 | <para>The following parameters are valid for DVB-C Annex B:</para> |
| 1245 | <itemizedlist mark='opencircle'> |
| 1246 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
| 1247 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
| 1248 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1249 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1250 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1251 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
| 1252 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> |
Antti Palosaari | ee47e2f | 2012-08-16 22:19:29 -0300 | [diff] [blame] | 1253 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1254 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1255 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Mauro Carvalho Chehab | e7da0ae | 2011-06-07 22:02:32 -0300 | [diff] [blame] | 1256 | </section> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1257 | </section> |
| 1258 | <section id="frontend-property-satellital-systems"> |
| 1259 | <title>Properties used on satellital delivery systems</title> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1260 | <section id="dvbs-params"> |
| 1261 | <title>DVB-S delivery system</title> |
| 1262 | <para>The following parameters are valid for DVB-S:</para> |
| 1263 | <itemizedlist mark='opencircle'> |
| 1264 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
| 1265 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
| 1266 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1267 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1268 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1269 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> |
| 1270 | <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem> |
| 1271 | <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem> |
Andreas Oberritter | 7fc9da2 | 2011-09-03 14:26:33 -0300 | [diff] [blame] | 1272 | <listitem><para><link linkend="DTV-VOLTAGE"><constant>DTV_VOLTAGE</constant></link></para></listitem> |
| 1273 | <listitem><para><link linkend="DTV-TONE"><constant>DTV_TONE</constant></link></para></listitem> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1274 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1275 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1276 | <para>Future implementations might add those two missing parameters:</para> |
| 1277 | <itemizedlist mark='opencircle'> |
| 1278 | <listitem><para><link linkend="DTV-DISEQC-MASTER"><constant>DTV_DISEQC_MASTER</constant></link></para></listitem> |
| 1279 | <listitem><para><link linkend="DTV-DISEQC-SLAVE-REPLY"><constant>DTV_DISEQC_SLAVE_REPLY</constant></link></para></listitem> |
| 1280 | </itemizedlist> |
| 1281 | </section> |
| 1282 | <section id="dvbs2-params"> |
| 1283 | <title>DVB-S2 delivery system</title> |
Andreas Oberritter | 7fc9da2 | 2011-09-03 14:26:33 -0300 | [diff] [blame] | 1284 | <para>In addition to all parameters valid for DVB-S, DVB-S2 supports the following parameters:</para> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1285 | <itemizedlist mark='opencircle'> |
Andreas Oberritter | 7fc9da2 | 2011-09-03 14:26:33 -0300 | [diff] [blame] | 1286 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1287 | <listitem><para><link linkend="DTV-PILOT"><constant>DTV_PILOT</constant></link></para></listitem> |
| 1288 | <listitem><para><link linkend="DTV-ROLLOFF"><constant>DTV_ROLLOFF</constant></link></para></listitem> |
Evgeny Plehov | 8180015 | 2012-09-13 10:16:28 -0300 | [diff] [blame] | 1289 | <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1290 | </itemizedlist> |
Mauro Carvalho Chehab | 9569793 | 2013-01-06 12:22:06 -0300 | [diff] [blame] | 1291 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
Andreas Oberritter | 7fc9da2 | 2011-09-03 14:26:33 -0300 | [diff] [blame] | 1292 | </section> |
| 1293 | <section id="turbo-params"> |
| 1294 | <title>Turbo code delivery system</title> |
| 1295 | <para>In addition to all parameters valid for DVB-S, turbo code supports the following parameters:</para> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1296 | <itemizedlist mark='opencircle'> |
Andreas Oberritter | 7fc9da2 | 2011-09-03 14:26:33 -0300 | [diff] [blame] | 1297 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1298 | </itemizedlist> |
| 1299 | </section> |
| 1300 | <section id="isdbs-params"> |
| 1301 | <title>ISDB-S delivery system</title> |
| 1302 | <para>The following parameters are valid for ISDB-S:</para> |
| 1303 | <itemizedlist mark='opencircle'> |
| 1304 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> |
| 1305 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
| 1306 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
| 1307 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> |
| 1308 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> |
| 1309 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> |
| 1310 | <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem> |
| 1311 | <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem> |
| 1312 | <listitem><para><link linkend="DTV-VOLTAGE"><constant>DTV_VOLTAGE</constant></link></para></listitem> |
Evgeny Plehov | 8180015 | 2012-09-13 10:16:28 -0300 | [diff] [blame] | 1313 | <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem> |
Mauro Carvalho Chehab | ff74b8e | 2011-06-07 22:13:35 -0300 | [diff] [blame] | 1314 | </itemizedlist> |
| 1315 | </section> |
Mauro Carvalho Chehab | 994e262 | 2011-06-07 20:52:33 -0300 | [diff] [blame] | 1316 | </section> |
Mauro Carvalho Chehab | 131db3a | 2009-10-24 21:18:46 -0300 | [diff] [blame] | 1317 | </section> |