summaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media/dvb/frontend.xml
Commit message (Collapse)AuthorAgeFilesLines
* [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>
* 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] dvb: Add DVBv5 statistics propertiesMauro Carvalho Chehab2013-01-231-1/+1
| | | | | | | | | | | | | | | | | | 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] DocBook: Multistream supportEvgeny Plehov2012-09-231-0/+1
| | | | | | | | | | | | 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-151-9/+11
| | | | | | | | | 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] 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] DocBook: fix incorrect or missing linksHans Verkuil2012-08-111-1/+1
| | | | | Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] dvb: deprecate the usage of ops->info.typeMauro Carvalho Chehab2012-01-041-0/+4
| | | | | | | 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-201-2/+2
| | | | | | | | 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] DocBook/dvb: Use generic descriptions for the frontend APIMauro Carvalho Chehab2011-07-271-426/+5
| | | | | | | | | 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] DVB: Point to the generic error chapterMauro Carvalho Chehab2011-07-271-38/+20
| | | | | | | | | | | | 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] DocBook/dvbproperty.xml: Add ATSC standardMauro Carvalho Chehab2011-07-271-1/+1
| | | | Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: Finish synchronizing the frontend APIMauro Carvalho Chehab2011-07-271-1/+1
| | | | | | | | | | Remove the remaining: Error: no ID for constraint linkend: With this patch, the dvb frontend API matches the current dvb core implementation. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/frontend.xml: Recomend the usage of the new APIMauro Carvalho Chehab2011-07-271-2/+14
| | | | | | | | | The old way of setting delivery system parameters were to use an union with specific per-system parameters. However, as newer delivery systems required more data, the structure size weren't enough to fit. So, recomend using the DVBS2API instead. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/frontend.xml: Better describe the frontend parametersMauro Carvalho Chehab2011-07-271-14/+19
| | | | | | | Update the DVB parameter structs to reflect VSB modulation and improve a few descriptions. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/frontend.xml: add references for some missing infoMauro Carvalho Chehab2011-07-271-74/+130
| | | | | | | | | | | The frontend.h.xml now references to the main document. However, several references are missed. Links the trivial ones with the corresponding API descriptions. While here, updates the main API to reflect the API improvements. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/frontend.xml: Correlate dvb delivery systemsMauro Carvalho Chehab2011-07-271-6/+11
| | | | | | | As the DVB API provides two ways to specify the delivery systems, correlate both ways into a table. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook/frontend.xml: Better document fe_type_tMauro Carvalho Chehab2011-07-271-11/+36
| | | | | | | | | | The fe_type_t documentation was incomplete and not linked to the dvb/frontend.h.xml. Properly document it. Also, drop a note that newer formats are only supported via FE_GET_PROPERTY/FE_GET_SET_PROPERTY ioctls. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
* [media] DocBook: Move all media docbook stuff into its own directoryMauro Carvalho Chehab2011-07-271-0/+1851
This patch addresses several issues pointed by Randy Dunlap <rdunlap@xenotime.net> at changeset ece722c: - In the generated index.html file, "media" is listed first, but it should be listed in alphabetical order, not first. - The generated files are (hidden) in .tmpmedia/ - The link from the top-level index.html file to "media" is to media/index.html, but the file is actually in .tmpmedia/media/index.html - Please build docs with and without using "O=builddir" and test that. - Would it be possible for media to have its own Makefile instead of merging into this one? Due to the way cleandocs target works, I had to rename the media DocBook to media_api, otherwise cleandocs would remove the /media directory. Thanks-to: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
OpenPOWER on IntegriCloud