summaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media/dvb
Commit message (Collapse)AuthorAgeFilesLines
...
* [media] DocBook: Provide a high-level description for DVB frontendMauro Carvalho Chehab2015-05-301-6/+16
| | | | | | | Instead of just showing ioctls, let's add an introdutory text briefly explaining the DVB frontend API. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix FE_READ_STATUS argument descriptionMauro Carvalho Chehab2015-05-301-8/+12
| | | | | | | | | | | | | | | | What's written there about the arguments for this ioctl is bogus: it doesn't return an enum (or a typedef) for enum fe_status. Instead, it returns a bitmask with the values defined by enum fe_status. Also, the size of the integer returned is not 16 bits, but, instead, sizeof(fe_status_t), e. g. sizeof(enum), with is arch-dependent. This should of course be fixed, but this should be done on a separate patch. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better organize the function descriptions for frontendMauro Carvalho Chehab2015-05-302-6/+3
| | | | | | | | | | | | | | | | | | | | | | Move the function ioctl definitions to the end of the chapter, at their importance. That makes the document better organized, as the DVB frontend system call index will look like: open() close() ioctl FE_GET_INFO — Query DVB frontend capabilities and returns information about the front-end. This call only requires read-only access to the device ioctl FE_READ_STATUS — Returns status information about the front-end. This call only requires read-only access to the device ioctl FE_SET_PROPERTY, FE_GET_PROPERTY — FE_SET_PROPERTY sets one or more frontend properties. FE_GET_PROPERTY returns one or more frontend properties. ioctl FE_DISEQC_RESET_OVERLOAD — Restores the power to the antenna subsystem, if it was powered off due to power overload. ioctl FE_DISEQC_SEND_MASTER_CMD — Sends a DiSEqC command ioctl FE_DISEQC_RECV_SLAVE_REPLY — Receives reply from a DiSEqC 2.0 command ioctl FE_DISEQC_SEND_BURST — Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection. ioctl FE_SET_TONE — Sets/resets the generation of the continuous 22kHz tone. ioctl FE_SET_VOLTAGE — Allow setting the DC level sent to the antenna subsystem. ioctl FE_ENABLE_HIGH_LNB_VOLTAGE — Select output DC level between normal LNBf voltages or higher LNBf voltages. ioctl FE_SET_FRONTEND_TUNE_MODE — Allow setting tuner mode flags to the frontend. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_DISEQC_RESET_OVERLOADMauro Carvalho Chehab2015-05-302-44/+52
| | | | | | | Use the new format for the ioctl documentation and put the struct dvb_diseqc_slave_reply together with the ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_DISEQC_SEND_MASTER_CMDMauro Carvalho Chehab2015-05-302-62/+73
| | | | | | | Use the new format for the ioctl documentation and put the struct dvb_diseqc_slave_reply together with the ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_DISEQC_RECV_SLAVE_REPLYMauro Carvalho Chehab2015-05-302-63/+79
| | | | | | | Use the new format for the ioctl documentation and put the struct dvb_diseqc_slave_reply together with the ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_DISEQC_SEND_BURST ioctlMauro Carvalho Chehab2015-05-302-66/+87
| | | | | | | | | | Use the proper format for FE_DISEQC_SEND_BURST documentation and improve the documentation. Keep the enum fe_sec_mini_cmd description together with the ioctl, as both are used together. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_SET_TONE ioctlMauro Carvalho Chehab2015-05-302-60/+89
| | | | | | | | | | Use the proper format for FE_SET_TONE documentation and improve the documentation. Keep the enum fe_sec_tone_mode description together with the ioctl, as both are used together. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_SET_VOLTAGE ioctlMauro Carvalho Chehab2015-05-302-61/+95
| | | | | | | | | | | Use the proper format for FE_SET_VOLTAGE documentation and fix the documentation. The description for the enum is not 100%, and it is missing the voltage off value. Also, it is better to keep the enum description together with the ioctl, as both are used together. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: reformat FE_ENABLE_HIGH_LNB_VOLTAGE ioctlMauro Carvalho Chehab2015-05-302-49/+62
| | | | | | Use the proper format for FE_ENABLE_HIGH_LNB_VOLTAGE documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: reformat FE_SET_FRONTEND_TUNE_MODE ioctlMauro Carvalho Chehab2015-05-302-31/+65
| | | | | | Use the proper format for FE_SET_FRONTEND_TUNE_MODE documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move FE_GET_PROPERTY to its own xml fileMauro Carvalho Chehab2015-05-302-82/+83
| | | | | | | | That helps the xref logic at the Makefile to point to the right place. Also, it becomes more organized and easier to maintain if each ioctl have its own xml file. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Rename ioctl xml filesMauro Carvalho Chehab2015-05-303-2/+2
| | | | | | | for the xml files describing ioctls, use the same nomenclature as on V4L2: the ioctl name, in lower case, using - instead of _. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Fix false positive undefined ioctl referencesMauro Carvalho Chehab2015-05-301-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | The new code that detects undocumented ioctls hits some false positives: This one is not documented, nor it should, as this is there just to reserve namespace: Warning: can't find reference for VIDIOC_RESERVED ioctl But those are already documented together with other ioctls: Warning: can't find reference for VIDIOC_UNSUBSCRIBE_EVENT ioctl Warning: can't find reference for FE_GET_PROPERTY ioctl Warning: can't find reference for VIDIOC_SUBDEV_G_EDID ioctl Warning: can't find reference for VIDIOC_SUBDEV_S_EDID ioctl Warning: can't find reference for VIDIOC_SUBDEV_S_DV_TIMINGS ioctl Warning: can't find reference for VIDIOC_SUBDEV_G_DV_TIMINGS ioctl Warning: can't find reference for VIDIOC_SUBDEV_QUERY_DV_TIMINGS ioctl So, we need to just be sure to point to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Add xref links for DTV propetiesMauro Carvalho Chehab2015-05-301-6/+6
| | | | | | | Create xref links for all DTV properties and link the frontend.h to each. Also use them at the DVB frontent API example. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Improve the description of the properties APIMauro Carvalho Chehab2015-05-301-5/+32
| | | | | | Make the text clearer about what the properties API does. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Merge FE_SET_PROPERTY/FE_GET_PROPERTY ioctl descriptionMauro Carvalho Chehab2015-05-302-71/+35
| | | | | | | | | | Instead of having two refentries, merge them into just one, like what's done with other similar ioctls at V4L2 side. That makes the entry cleaner and will allow to add the associated structures together with the refentry. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix xref to the FE open() functionMauro Carvalho Chehab2015-05-303-4/+4
| | | | | | | | Instead of going to the V4L2 open(), use the xref to the proper place at the frontend ioctls that were already reformatted. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: rewrite FE_GET_PROPERTY/FE_SET_PROPERTY to use the std wayMauro Carvalho Chehab2015-05-301-96/+118
| | | | | | | Use the standard way of documenting ioctls for FE_GET_PROPERTY and FE_SET_PROPERTY. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move DVB properties to happen earlier at the documentMauro Carvalho Chehab2015-05-301-2/+2
| | | | | | | | The DVBv5 API uses DVB properties as the main way to set the frontend and collect statistics. Move the definition to happen earlier, in order to reflect its importance. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for FE_READ_STATUSMauro Carvalho Chehab2015-05-302-109/+113
| | | | | | | Move the ioctl and enum fe_status to a separate xml file and put it into a better format. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move FE_GET_INFO to a separate xml fileMauro Carvalho Chehab2015-05-302-265/+266
| | | | | | | | | | Keeping everything altogether makes harder to reorganize the DocBook. So, move the FE_GET_INFO ioctl and the associated structures into a separate file. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: reformat FE_GET_INFO ioctl documentationMauro Carvalho Chehab2015-05-301-107/+267
| | | | | | | | | | | | The DVB part of the docbook has a completely different format than the V4L2 part, as it was written as a separate document. As the V4L2 documentation is on better shape, and its format allows adding more information, let's use it for FE_GET_INFO and gradually update the non-legacy DVB ioctls using the new format. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move DVBv3 frontend bits to a separate sectionMauro Carvalho Chehab2015-05-302-590/+618
| | | | | | | | | | | | | | Although the recommended usage is the DVBv5 API calls, the documentation doesn't make it clear about what's the recommended calls and what's legacy. So, move the legacy API bits to a separate xml, putting them into a new section. Please notice that more changes are needed, since some of the bits there are cross-referenced elsewhere. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Improve DVB frontend descriptionMauro Carvalho Chehab2015-05-301-17/+29
| | | | | | The DVB frontend API got bitrotten. Update it. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix emphasis at the DVB documentationMauro Carvalho Chehab2015-05-308-34/+34
| | | | | | | | | Currently, it is using 'role="tt"', but this is not defined at the DocBook 4.5 spec. The net result is that no emphasis happens. So, replace them to bold emphasis. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] dvb: Document FE_SCALE_DECIBEL units consistentlyDavid Howells2015-05-141-2/+2
| | | | | | | | | | | | | | | In comments and in the documentation, the units of properties marked with the FE_SCALE_DECIBEL scale are specified in terms of 1/1000 dB or 0.0001 dB. This is inconsistent, however, as 1/1000 is 0.001, not 0.0001. Note that the v4l-utils divide the value by 1000 for the signal strength suggesting that the 1/1000 is correct. Settle on millidecibels, ie. 1/1000dB or 0.001dB. Signed-off-by: David Howells <dhowells@redhat.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] Documentation: FE_SET_PROPERTY requires R/WMauro Carvalho Chehab2014-10-301-2/+2
| | | | | | | FE_SET_PROPERTY requires to open the devnode on R/W mode, or otherwise it will fail. Document it. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Fix ISDB-T Interleaving propertyMauro Carvalho Chehab2014-07-221-4/+40
| | | | | | | | The DocBook documentation is incorrect: on ISDB-T, interleaving time is always a power of 2. Fix it and provides a table showing the actual interleaving length for each mode. Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
* [media] DocBook: Fix typo in xml and template fileMasanari Iida2014-03-131-1/+1
| | | | | | | | | | Fix spelling typo under Documentation/DocBook/media. It is because these files are NOT generated by "make htmldocs", I have to fix the files. [m.chehab@samsung.com: fix a merge conflict] Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
* [media] DocBook: document DVB DMX_[ADD|REMOVE]_PIDMauro Carvalho Chehab2014-03-041-4/+19
| | | | | | | | | | | | Those ioctls were added back in 2009, at changeset 1cb662a3144 but were never documented. Fortunately, the original commit is good enough to serve as the basis for documenting it. Also, the support for it is done by dmxdev implementation. So, add a proper documentation for it, based on the description of the original changeset. Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
* [media] FE_READ_SNR and FE_READ_SIGNAL_STRENGTH docsGeorgi Chorbadzhiyski2014-02-041-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Around 01/14/2014 06:07 PM, Mauro Carvalho Chehab scribbled: > Em Tue, 14 Jan 2014 17:55:19 +0200 > Georgi Chorbadzhiyski <gf@unixsol.org> escreveu: >> Around 01/14/2014 05:30 PM, Mauro Carvalho Chehab scribbled: >>> Em Tue, 14 Jan 2014 17:16:10 +0200 >>> Georgi Chorbadzhiyski <gf@unixsol.org> escreveu: >>> >>>> Hi guys, I'm confused the documentation on: >>>> >>>> http://linuxtv.org/downloads/v4l-dvb-apis/frontend_fcalls.html#FE_READ_SNR >>>> http://linuxtv.org/downloads/v4l-dvb-apis/frontend_fcalls.html#FE_READ_SIGNAL_STRENGTH >>>> >>>> states that these ioctls return int16_t values but frontend.h states: >>>> >>>> https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/dvb/frontend.h >>>> >>>> #define FE_READ_SIGNAL_STRENGTH _IOR('o', 71, __u16) >>>> #define FE_READ_SNR _IOR('o', 72, __u16) >>>> >>>> So which one is true? >>> >>> Documentation is wrong. The returned values are unsigned. Would you mind send >>> us a patch fixing it? >> >> I would be happy to, but I can't find the repo that holds the documentation. > > It is in the Kernel tree, under Documentation/DocBook/media/dvb. The attached file contains the discussed documentation fixes. Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
* [media] DocBook media: update copyright years and IntroductionHans Verkuil2014-02-041-1/+1
| | | | | | | | | It's now 2014, so update those copyright years. Also fix a typo in the introduction and mention that this document also covers output, codec and remote control devices. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
* [media] DocBook media: fix email addressesHans Verkuil2014-02-041-1/+1
| | | | | | | | Mauro's old redhat email address is no longer valid, update to the current email address. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
* doc: fix misspellings with 'codespell' toolAnatol Pomozov2013-05-281-1/+1
| | | | | Signed-off-by: Anatol Pomozov <anatol.pomozov@gmail.com> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
* [media] DocBook media: fix syntax problems in dvbproperty.xmlHans Verkuil2013-03-251-24/+22
| | | | | | | Caught by xmllint. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] documentation: DocBook/media : Fix typo in dvbproperty.xmlMasanari Iida2013-03-241-3/+3
| | | | | | | Correct spelling typos. Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] dvb: Add DVBv5 statistics propertiesMauro Carvalho Chehab2013-01-233-3/+181
| | | | | | | | | | | | | | | | | | The DVBv3 statistics parameters are limited on several ways: - It doesn't provide any way to indicate the used measure, so userspace need to guess how to calculate/use it; - Only a limited set of stats are supported; - Can't be called in a way to require them to be filled all at once (atomic reads from the hardware), with may cause troubles on interpreting them on userspace; - On some OFDM delivery systems, the carriers can be independently modulated, having different properties. Currently, there's no way to report per-layer stats. To address the above issues, adding a new DVBv5-based stats API. While here, correct inner code nomenclature on a few places. Reviewed-by: Antti Palosaari <crope@iki.fi> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB API: LNA documentationAntti Palosaari2012-09-271-0/+16
| | | | | Signed-off-by: Antti Palosaari <crope@iki.fi> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: Multistream supportEvgeny Plehov2012-09-234-12/+25
| | | | | | | | | | | | Document the multistream support at the DVBAPI, describing what delivery systems currently support it (DVB-T2, DVB-S2, ISDB-S). DVBAPI version increased to 5.8. [mchehab@redhat.com: Made some corrections - mostly language] Signed-off-by: Evgeny Plehov <EvgenyPlehov@ukr.net> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook validation fixesHans Verkuil2012-08-152-20/+22
| | | | | | | | | More validation fixes as reported by xmllint. There are still three xmllint errors after this remaining regarding SVG file support. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] Rename media/dvb as media/pciMauro Carvalho Chehab2012-08-131-1/+1
| | | | | | | The remaining dvb drivers are pci, so rename them to match the bus. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] frontend.h, Docbook: Improve status documentationMauro Carvalho Chehab2012-08-131-11/+37
| | | | | | | | No functional changes. It just improves the description of the frontend status, using Documentation/kernel-doc-nano-HOWTO.txt for the status enumeration, and a table inside the DocBook. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB API: add INTERLEAVING_AUTOAntti Palosaari2012-08-131-0/+1
| | | | | | | | | | | After thinking twice, I ended up adding own value for AUTO interleaving instead of using NONE. API minor number is not needed to increase as that patch should be the same Kernel as interleaving parameter is initially added. Signed-off-by: Antti Palosaari <crope@iki.fi> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] add DTMB support for DVB APIAntti Palosaari2012-08-131-1/+39
| | | | | | | | | Cc: Patrick Boettcher <pboettcher@kernellabs.com> Cc: Andreas Oberritter <obi@linuxtv.org> Cc: Mauro Carvalho Chehab <mchehab@redhat.com> Acked-by: Patrick Boettcher <pboettcher@kernellabs.com> Signed-off-by: Antti Palosaari <crope@iki.fi> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: add stubs for missing DVB CA ioctlsHans Verkuil2012-08-111-0/+353
| | | | | Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: add stubs for missing DVB DMX ioctlsHans Verkuil2012-08-111-1/+229
| | | | | Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: add stubs for the undocumented DVB net ioctlsHans Verkuil2012-08-111-0/+127
| | | | | Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: add missing DVB video ioctlsHans Verkuil2012-08-111-11/+322
| | | | | Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: add missing AUDIO_* ioctlsHans Verkuil2012-08-111-1/+112
| | | | | | | | Add the missing AUDIO_* ioctls and document the V4L2 replacements for the various DVB AUDIO ioctls that were (ab)used by V4L2. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
OpenPOWER on IntegriCloud