History

[media] DocBook: add a proper description for dvb_frontend_info.fe_type

The fe_type is deprecated at the DVB API. However, it may still be used by legacy DVBv3 applications. While this works with old devices, modern devices may support more than one delivery system. Add an explanation about that and a point to what should be used, instead, in order for legacy apps to support newer hardware.

Mauro Carvalho Chehab committed 11 years ago

Commit 2c2bc8f1 parent be1ad6e1 file · +13 −3Browse files

Unified · Split

Documentation/DocBook/media/dvb/frontend_legacy_api.xml+13−3
@@ -45,9 +45,19 @@ · 44 unmodified lines
4545 supported via the new <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY/FE_GET_SET_PROPERTY</link> ioctl's, using the <link linkend="DTV-DELIVERY-SYSTEM">DTV_DELIVERY_SYSTEM</link> parameter.
4646 </para>
4747
48−<para>The usage of this field is deprecated, as it doesn't report all supported standards, and
49−will provide an incomplete information for frontends that support multiple delivery systems.
50−Please use <link linkend="DTV-ENUM-DELSYS">DTV_ENUM_DELSYS</link> instead.</para>
48+<para>In the old days, &dvb-frontend-info; used to contain
49+ <constant>fe_type_t</constant> field to indicate the delivery systems,
50+ filled with either FE_QPSK, FE_QAM, FE_OFDM or FE_ATSC. While this is
51+ still filled to keep backward compatibility, the usage of this
52+ field is deprecated, as it can report just one delivery system, but some
53+ devices support multiple delivery systems. Please use
54+ <link linkend="DTV-ENUM-DELSYS">DTV_ENUM_DELSYS</link> instead.
55+</para>
56+<para>On devices that support multiple delivery systems,
57+ &dvb-frontend-info;::<constant>fe_type_t</constant> is filled with the
58+ currently standard, as selected by the last call to
59+ <link linkend="FE_GET_PROPERTY">FE_SET_PROPERTY</link>
60+ using the &DTV-DELIVERY-SYSTEM; property.</para>
5161 </section>
5262
5363