summaryrefslogtreecommitdiff
path: root/Documentation/DocBook/media/dvb (follow)
Commit message (Collapse)AuthorAge
* [media] Documentation: FE_SET_PROPERTY requires R/WMauro Carvalho Chehab2014-10-30
| | | | | | | 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-22
| | | | | | | | 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-13
| | | | | | | | | | 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-04
| | | | | | | | | | | | 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-04
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-04
| | | | | | | | | 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-04
| | | | | | | | 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-28
| | | | | 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-25
| | | | | | | 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-24
| | | | | | | 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-23
| | | | | | | | | | | | | | | | | | 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-27
| | | | | Signed-off-by: Antti Palosaari <crope@iki.fi> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: Multistream supportEvgeny Plehov2012-09-23
| | | | | | | | | | | | 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-15
| | | | | | | | | 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-13
| | | | | | | 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-13
| | | | | | | | 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-13
| | | | | | | | | | | 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-13
| | | | | | | | | 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-11
| | | | | 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-11
| | | | | 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-11
| | | | | 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-11
| | | | | 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-11
| | | | | | | | 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>
* [media] DocBook: fix incorrect or missing linksHans Verkuil2012-08-11
| | | | | Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: various version/copyright year updatesHans Verkuil2012-08-11
| | | | | | | | | | | - update 2011 to 2012 for copyrights - update V4L2 spec version to 3.6 - update the intro to also refer to part four: the Media Controller - fix an incorrect revision section - fix an incorrect 3.6 kernel changes section Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB: remove "stats" property bits from ATSC-MH API property additionsMichael Krufky2012-05-20
| | | | | | | | Mauro is proposing a new API to handle statistics. This functionality will be returned after the statistics API is ready. Just remove them for now. Signed-off-by: Michael Krufky <mkrufky@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: document new DTV Properties for ATSC-MH delivery systemMichael Krufky2012-05-20
| | | | | | | | | | | | | | | | | | | | | | | | | | Document the following properties for controlling an ATSC-MH frontend: DTV_ATSCMH_FIC_VER - Version number of the FIC signaling data DTV_ATSCMH_PARADE_ID - Parade identification number DTV_ATSCMH_NOG - Number of MH groups per MH subframe for a designated parade DTV_ATSCMH_TNOG - Total number of MH groups in all parades in one subframe DTV_ATSCMH_SGN - Start group number DTV_ATSCMH_PRC - Parade repetition cycle DTV_ATSCMH_RS_FRAME_MODE - RS frame mode DTV_ATSCMH_RS_FRAME_ENSEMBLE - RS frame ensemble DTV_ATSCMH_RS_CODE_MODE_PRI - RS code mode (primary) DTV_ATSCMH_RS_CODE_MODE_SEC - RS code mode (secondary) DTV_ATSCMH_SCCC_BLOCK_MODE - Series Concatenated Convolutional Code Block Mode DTV_ATSCMH_SCCC_CODE_MODE_A - Series Concatenated Convolutional Code Rate A DTV_ATSCMH_SCCC_CODE_MODE_B - Series Concatenated Convolutional Code Rate B DTV_ATSCMH_SCCC_CODE_MODE_C - Series Concatenated Convolutional Code Rate C DTV_ATSCMH_SCCC_CODE_MODE_D - Series Concatenated Convolutional Code Rate D DTV_ATSCMH_FIC_ERR - FIC error count DTV_ATSCMH_CRC_ERR - CRC error count DTV_ATSCMH_RS_ERR - RS error count Signed-off-by: Michael Krufky <mkrufky@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/dvbproperty.xml: Remove DTV_MODULATION from ISDB-TMauro Carvalho Chehab2012-01-17
| | | | | | | | | On ISDB-T, each layer can have its own independent modulation, applied to the carriers that belong to the segments associated with them. So, there's no sense to define a global modulation parameter. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/dvbproperty.xml: Fix ISDB-T delivery system parametersMauro Carvalho Chehab2012-01-17
| | | | | | | | | | The ISDB-T differs on its way to implement the hierarchical transmissions: instead of using a low-priority/high-priority FEC codes, it does that by using different layers, each layer with their groups of segments. So, those parameters don't make sense for ISDB-T. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/dvbproperty.xml: Fix the units for DTV_FREQUENCYMauro Carvalho Chehab2012-01-17
| | | | | | | The units for DTV_FREQUENCY are kHz for satellital delivery systems (DVB-S/DVB-S2/DVB-TURBO/ISDB-S). Fix it at the API spec. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] dvb: deprecate the usage of ops->info.typeMauro Carvalho Chehab2012-01-04
| | | | | | | Mark info.type as deprecated inside the header, recommending the usage of DTV_ENUM_DELSYS DVBv5 command instead. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] Update documentation to reflect DVB-C Annex A/C supportMauro Carvalho Chehab2011-12-20
| | | | | | | | Instead of using the same delivery system for both Annex A and Annex C, split them into two separate ones. This helps to support devices that only support Annex A. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB: Docbook update for DTV_ENUM_DELSYSManu Abraham2011-12-12
| | | | | Signed-off-by: Manu Abraham <abraham.manu@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] dvb: Allow select between DVB-C Annex A and Annex CMauro Carvalho Chehab2011-11-11
| | | | | | | | | | | | | DVB-C, as defined by ITU-T J.83 has 3 annexes. The differences between Annex A and Annex C is that Annex C uses a subset of the modulation types, and uses a different rolloff factor. A different rolloff means that the bandwidth required is slicely different, and may affect the saw filter configuration at the tuners. Also, some demods have different configurations, depending on using Annex A or Annex C. So, allow userspace to specify it, by changing the rolloff factor. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB: Change API version in documentation: 3 -> 5.4Andreas Oberritter2011-09-03
| | | | | Signed-off-by: Andreas Oberritter <obi@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB: improve documentation for satellite delivery systemsAndreas Oberritter2011-09-03
| | | | | | | | | | | - Move voltage and tone to DVB-S. - Add turbo code. - In DVB-S2 and turbo code sections, refer to DVB-S, as both are extensions to DVB-S. - Add modulation to DVB-S2. Signed-off-by: Andreas Oberritter <obi@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB: Add SYS_TURBO for north american turbo code FECAndreas Oberritter2011-09-03
| | | | | Signed-off-by: Andreas Oberritter <obi@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/dvb: Use generic descriptions for the video APIMauro Carvalho Chehab2011-07-27
| | | | | | | While here, removes the bogus EINTERNAL error codes. Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/dvb: Use generic descriptions for the frontend APIMauro Carvalho Chehab2011-07-27
| | | | | | | | | Move generic stuff into gen-errors.xml, and remove them from DVB API. While here, removes two bogus error codes that aren't supported or used on Linux: EINTERNAL and ENOSIGNAL. Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/demux.xml: Remove generic errorsMauro Carvalho Chehab2011-07-27
| | | | | | | | Remove generic errors from ioctl() descriptions. For other ioctl's, there's no generic section. So, just keep whatever is there. Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/audio.xml: Remove generic errorsMauro Carvalho Chehab2011-07-27
| | | | | | | | | | Remove generic errors from ioctl() descriptions. For other ioctl's, there's no generic section. So, just keep whatever is there. Also remove the EINTERNAL error code, as no DVB driver returns it, and this error code is not defined on POSIX or on Linux. Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB: Point to the generic error chapterMauro Carvalho Chehab2011-07-27
| | | | | | | | | | | | Just like the V4L, MC and LIRC API's, point to the generic error chapter for ioctl's. This will allow moving generic error codes to just one place inside all media API's. A latter patch will remove the generic errors from each specific ioctl. Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DVB API: Mention the dvbM deviceBjørn Mork2011-07-27
| | | | | Signed-off-by: Bjørn Mork <bjorn@mork.no> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: Use base64 for gif/png filesMauro Carvalho Chehab2011-07-27
| | | | | | | | | | | | | | The patch utility doesn't work with non-binary files. This causes some tools to break, like generating tarball targets and the scripts that generate diff patches at http://www.kernel.org/pub/linux/kernel/v2.6/. So, let's convert all binaries to ascii using base64, and add a logic at Makefile to convert them back into binaries at runtime. Reported-by: Randy Dunlap <randy.dunlap@oracle.com> Reported-by: Andrew Morton <akpm@linux-foundation.org> Reviewed-by: Michal Marek <mmarek@suse.cz> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/video.xml: Document the remaining data structuresMauro Carvalho Chehab2011-07-27
| | | | | | | | | | | | | Now, all data structures are commented. A few ioctls remain undocumented: Error: no ID for constraint linkend: VIDEO_GET_SIZE. Error: no ID for constraint linkend: VIDEO_GET_FRAME_RATE. Error: no ID for constraint linkend: VIDEO_GET_PTS. Error: no ID for constraint linkend: VIDEO_GET_FRAME_COUNT. Error: no ID for constraint linkend: VIDEO_COMMAND. Error: no ID for constraint linkend: VIDEO_TRY_COMMAND. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/video.xml: Fix section references with video.h.xmlMauro Carvalho Chehab2011-07-27
| | | | | | Make the reference links at video.h.xml to match the ones at video.xml. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/Makefile: Remove osd.h headerMauro Carvalho Chehab2011-07-27
| | | | | | | | | | | | The av7110 uses an OSD API. Such API is not documented at all. Also, the osd.h API uses camelCase and some other weird stuff. Also, dvb-core doesn't recognize it. I don't see any good reason why we should document it. It seems better to just let it as-is. If ever needed, it is probably better to write a different API for dvb-core. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/net.xml: Synchronize Network data structureMauro Carvalho Chehab2011-07-27
| | | | | | | | There's no documentation at all for the DVB net API. Still, better to remove a few warnings about the missing symbols. So, add the net data structure inside the net.xml. Now, only the ioctl documentation is missed. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/demux.xml: Add the remaining data structures to the API specMauro Carvalho Chehab2011-07-27
| | | | | | | | | | | | Still, there are a few ioctl's not documented: Error: no ID for constraint linkend: DMX_GET_PES_PIDS. Error: no ID for constraint linkend: DMX_GET_CAPS. Error: no ID for constraint linkend: DMX_SET_SOURCE. Error: no ID for constraint linkend: DMX_ADD_PID. Error: no ID for constraint linkend: DMX_REMOVE_PID. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/demux.xml: Fix section references with dmx.h.xmlMauro Carvalho Chehab2011-07-27
| | | | | | | | | Make the reference links at dmx.h.xml to match the ones at demux.xml. While here, also syncronizes the structures defined inside the API, in order to match the current API. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>