summaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media/dvb
Commit message (Collapse)AuthorAgeFilesLines
* doc-rst: Remove the media docbookMauro Carvalho Chehab2016-07-2824-9631/+0
| | | | | | | | | | Now that all media documentation was converted to Sphinx, we should get rid of the old DocBook one, as we don't want people to submit patches against the old stuff. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] Documentation: DocBook: fix spelling mistakeEric Engestrom2016-04-251-1/+1
| | | | | | | | Fix spelling mistake. Signed-off-by: Eric Engestrom <eric@engestrom.ch> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] use https://linuxtv.org for LinuxTV URLsMauro Carvalho Chehab2015-12-043-3/+3
| | | | | | | | | | | While https was always supported on linuxtv.org, only in Dec 3 2015 the website is using valid certificates. As we're planning to drop pure http support on some future, change all references at the media subsystem to point to the https URL instead. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Remove kdapi.xmlMauro Carvalho Chehab2015-10-102-1239/+0
| | | | | | | Now that the Demux kABI is documented at device-drivers.xml, remove it from the API docbook. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] dvb: Remove unused frontend sources at demux.h and sync docMauro Carvalho Chehab2015-10-071-9/+4
| | | | | | | | | | The DVB core has a provision for other frontend sources, but no drivers use it. The kdapi.xml contains provision for some other frontend source types, but it is not in sync with the code. So, remove the unused types and sync both files. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] dvb: get rid of enum dmx_successMauro Carvalho Chehab2015-10-061-39/+5
| | | | | | | | | This enum is not actually used anymore. The only value used from the enum is DMX_OK, passed as a parameter on two callbacks. Yet, this value is not used anywhere. So, just remove it. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Move struct dmx_demux kABI doc to demux.hMauro Carvalho Chehab2015-10-061-1034/+0
| | | | | | | | | | | | | | | | | | | | | | | The DocBook/media/dvb/kdapi.xml contains the description of the kABI for DVB. The problem is that, by being maintained on a separate file and not being updated for years, it got outdated. So, for example, some callback parameters were changed, but the DocBook were still using the old stuff. As a first step to fix it, let's move the documentation of struct dmx_demux into demux.h and fix the parameters used there. For now, don't document any other field nor touch the descriptions that got moved, letting this job to other patches. That makes easier to review the patch. PS.: Please notice that an additional patch will be needed in order to fix the return values (some uses non-existent return codes) and to the functions and callbacks mentioned at the descriptions. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix an unbalanced <para> tagMauro Carvalho Chehab2015-08-221-1/+1
| | | | | | | | The </para> got lost on some change at the DVB docbook, making the tag unbalanced and causing a warning. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com> Acked-by: Jonathan Corbet <corbet@lwn.net>
* [media] DocBook: Fix typo in intro.xmlMasanari Iida2015-08-111-3/+2
| | | | | | | | | | | | This patch fix spelling typos in intro.xml. This xml file is not created from comments within source, I fix the xml file. Signed-off-by: Masanari Iida <standby24x7@gmail.com> [hans.verkuil@cisco.com: removed mention of obsolete devfs] Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Change format for enum dmx_output documentationMauro Carvalho Chehab2015-06-091-20/+37
| | | | | | | Use a table for the Demux output. No new information added here. They were all merged inside the table. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add xrefs for enum fe_typeMauro Carvalho Chehab2015-06-091-4/+4
| | | | | | | The only enum that was missing xrefs at frontend.h is fe_type. Add xrefs for them. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: properly document the delivery systemsMauro Carvalho Chehab2015-06-091-24/+75
| | | | | | | | Use a table for the delivery systems. The table is organized by the type (cable, satellite, terrestrial) and shows what standards are not fully implemented. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document the DVB-S2 rolloff factorMauro Carvalho Chehab2015-06-091-8/+27
| | | | | | | Instead of using a program listing, use a table and make clearer what each define means. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Remove duplicated documentation for SEC_VOLTAGE_*Mauro Carvalho Chehab2015-06-092-35/+26
| | | | | | | | The table were documented at the legacy ioctl call. Move it to the DVBv5 ioctl, and add a cross ref link on the legacy section. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: document DVB-S2 pilot in a tableMauro Carvalho Chehab2015-06-091-7/+24
| | | | | | | | | Putting it into a table allows to comment each possible values, with makes more clear what field means. Also, it allows to do cross-references with the frontend.h. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Add documentation for ATSC M/H propertiesMauro Carvalho Chehab2015-06-091-17/+22
| | | | | | | | Those data were retrieved by looking at A/153: ATSC Mobile DTV Standard and guessing what makes more sense to each field. Cc: Michael Ira Krufky <mkrufky@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add placeholders for ATSC M/H propertiesMauro Carvalho Chehab2015-06-091-71/+129
| | | | | | | | | | | | The ATSC M/H specific properties are not properly documented. This became crearer when converting the existing data into tables and adding cross references. For now, just add placeholders, as a further investigation about the meaning of each parameter is required. Cc: Michael Ira Krufky <mkrufky@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: remove a wrong cut-and-paste dataMauro Carvalho Chehab2015-06-091-5/+0
| | | | | | | | | By cut-and-paste mistake, TRANSMISSION_MODE_AUTO were documented twice, one at the wrong place. Remove the wrong one. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add IDs for enum fe_bandwidthMauro Carvalho Chehab2015-06-091-7/+7
| | | | | | | | | | enum fe_bandwidth is documented at the frontend legacy xml file. Add xrefs for each entry there. This makes the hyperlinks at frontend.h to go directly to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Better document DTMB time interleavingMauro Carvalho Chehab2015-06-091-9/+31
| | | | | | | The DTMB time interleaving was not properly documented. Add a documentation for it. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Add entry IDs for the enums defined at dvbproperty.xmlMauro Carvalho Chehab2015-06-091-60/+60
| | | | | | | | | There are lots of enums that are defined at dvbproperty. Add xrefs for each entry there. This makes the hyperlinks at frontend.h to go directly to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] Docbook: add entry IDs for enum fe_sec_voltageMauro Carvalho Chehab2015-06-091-3/+3
| | | | | | | | | enum fe_sec_voltage is documented together with FE_SET_VOLTAGE. Add xrefs for each entry there. This makes the hyperlinks at frontend.h to go directly to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add entry IDs for enum fe_sec_tone_modeMauro Carvalho Chehab2015-06-091-2/+2
| | | | | | | | | enum fe_sec_tone_mode is documented together with FE_SET_TONE. Add xrefs for each entry there. This makes the hyperlinks at frontend.h to go directly to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add entry IDs for enum fe_statusMauro Carvalho Chehab2015-06-091-7/+7
| | | | | | | | | enum fe_status is documented together with FE_READ_STATUS. Add xrefs for each entry there. This makes the hyperlinks at frontend.h to go directly to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add entry IDs for enum fe_sec_mini_cmdMauro Carvalho Chehab2015-06-091-2/+2
| | | | | | | | | | enum fe_sec_mini_cmd is documented together with FE_DISEQC_SEND_BURST. Add xrefs for each entry there. This makes the hyperlinks at frontend.h to go directly to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Add entry IDs for enum fe_capsMauro Carvalho Chehab2015-06-091-31/+31
| | | | | | | | enum fe_caps is documented at FE_GET_INFO ioctl. Add xrefs for each entry there. This makes the hyperlinks at frontend.h to go directly to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Use constant tag for monospaced fontsMauro Carvalho Chehab2015-06-088-32/+32
| | | | | | | | | | | | | As reminded by Jonathan, several places where emphasys role="tt" were used are actually trying to change the font to monospaced. We do that, on other places, by using the constant tag. So, use it here too. Reported-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix some syntax issues at dvbproperty.xmlMauro Carvalho Chehab2015-06-081-3/+3
| | | | | | | Some minor English syntax fixes. Reported-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] Docbook: typo fix: use note(d) instead of notice(d)Mauro Carvalho Chehab2015-06-082-5/+5
| | | | | | | | | | | | | We don't want to announce anything, but to add a note ;) So: notice -> note notided -> noted While here, fix another typo at media_api.tmpl: with -> which Reported-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: document DVB net APIMauro Carvalho Chehab2015-06-082-147/+229
| | | | | | | | | The DVB network API was not documented. There are just some placeholders there. Replace it by a proper documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix FE_SET_PROPERTY ioctl argumentsMauro Carvalho Chehab2015-06-011-1/+1
| | | | | | | FE_SET_PROPERTY/FE_GET_PROPERTY actually expects a struct dtv_properties argument. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: some fixes for DVB FE open()Mauro Carvalho Chehab2015-06-011-12/+16
| | | | | | | | | | | The changeset dc9ef7d11207 change the open() ioctl documentation to match the V4L2 open(). However, some cut-and-pasted stuff doesn't match what actually happens at the DVB core. So, fix the documentation entry to be more accurate with the DVB frontend open() specifics. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook media: rewrite frontend open/closeHans Verkuil2015-06-011-122/+159
| | | | | | | | To fix the last xmllint errors the open and close function reference description was rewritten based on the v4l2 open and close functions. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook media: xmllint fixesHans Verkuil2015-06-0113-59/+56
| | | | | | | Fixes a large number of xmllint errors. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook media: fix typosHans Verkuil2015-06-014-8/+8
| | | | | | | | satellital -> satellite antena -> antenna Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Update DocBook version and fix a few legacy thingsMauro Carvalho Chehab2015-05-303-10/+30
| | | | | | | | | | | | | | The DVB part of the media API documentation has several legacy things on it: - Examples that don't work; - APIs unused and deprecated; - places mentioning the wrong API version. Fix them and bump the documentation version, in order to reflect the cleanup efforts to make it more consistent with the current status of the API. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Fix arguments on some ioctl documentationMauro Carvalho Chehab2015-05-303-3/+12
| | | | | | | Due to a cut-and-paste error, the argument is missing or wrong on 3 ioctl documentation. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: cleaup the notes about DTV propertiesMauro Carvalho Chehab2015-05-301-9/+15
| | | | | | | | | | | | | | The notes there are somewhat confusing and assumes that the reader would have read the DVBv3 way. This is not true anymore, as the DVBv3 is now on a separate section that is marked as deprecated. So, cleanup the notes. While here, add a note about using libdvbv5, instead of using the DVBv5 API directly. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Add an example for using FE_SET_PROPERTYMauro Carvalho Chehab2015-05-301-0/+40
| | | | | | | | | | In order to make it clearer about how to use the DVBv5 calls, add an example of its usage. That should make it clearer about what's actually required for the DVBv5 calls to work. While here, also mentions the libdvbv5 library. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation of the properties structsMauro Carvalho Chehab2015-05-302-9/+9
| | | | | | | Rename the tytle of the struct documentation to reflect the name of the structures, and use links to do cross-ref. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for hierarchyMauro Carvalho Chehab2015-05-303-28/+38
| | | | | | Format it as a table and links it with the legacy API xml. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for guard intervalMauro Carvalho Chehab2015-05-303-32/+54
| | | | | | | Format it as a table and add more details, in special for DTMB guard intervals. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for FEC fieldsMauro Carvalho Chehab2015-05-303-85/+74
| | | | | | | Format it as a table and add more details. Also, remove the duplicated occurrences. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move fe_bandwidth to the frontend legacy sectionMauro Carvalho Chehab2015-05-302-16/+43
| | | | | | | fe_bandwidth/fe_bandwidth_t is used only on DVBv3 API. So, move it to the frontend legacy xml, and convert it into a table. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for OFDM transmission modeMauro Carvalho Chehab2015-05-303-31/+55
| | | | | | | Format it as a table and add more details, in special, for the DTMB modes. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for DVB spectral inversionMauro Carvalho Chehab2015-05-303-31/+40
| | | | | | Format it as a table and provide more details. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: cross-reference enum fe_modulation where neededMauro Carvalho Chehab2015-05-301-3/+3
| | | | | | | | At frontend legacy API description, there are three places where fe_modulation_t is defined. Cross-reference it to point to the right place at the documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: some fixes at FE_GET_INFOMauro Carvalho Chehab2015-05-301-4/+5
| | | | | | | | | | | There are a few issues at FE_GET_INFO documentation: - name is a string, not a pointer to a string; - the return text should be after the paragraph. While here, better to bold that two fields of the structure used by FE_GET_INFO are actually deprecated. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Better document enum fe_modulationMauro Carvalho Chehab2015-05-302-45/+72
| | | | | | | Instead of using programlisting, use a table, as this provides a better view of the structure. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add a proper description for dvb_frontend_info.fe_typeMauro Carvalho Chehab2015-05-301-3/+13
| | | | | | | | | | | | 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. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
OpenPOWER on IntegriCloud