aboutsummaryrefslogtreecommitdiff
path: root/Documentation/DocBook/media/dvb
AgeCommit message (Collapse)Author
2012-01-04[media] dvb: deprecate the usage of ops->info.typeMauro Carvalho Chehab
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>
2011-12-20[media] Update documentation to reflect DVB-C Annex A/C supportMauro Carvalho Chehab
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>
2011-12-12[media] DVB: Docbook update for DTV_ENUM_DELSYSManu Abraham
Signed-off-by: Manu Abraham <abraham.manu@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-11-11[media] dvb: Allow select between DVB-C Annex A and Annex CMauro Carvalho Chehab
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>
2011-09-03[media] DVB: Change API version in documentation: 3 -> 5.4Andreas Oberritter
Signed-off-by: Andreas Oberritter <obi@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-09-03[media] DVB: improve documentation for satellite delivery systemsAndreas Oberritter
- 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>
2011-09-03[media] DVB: Add SYS_TURBO for north american turbo code FECAndreas Oberritter
Signed-off-by: Andreas Oberritter <obi@linuxtv.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/dvb: Use generic descriptions for the video APIMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/dvb: Use generic descriptions for the frontend APIMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/demux.xml: Remove generic errorsMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/audio.xml: Remove generic errorsMauro Carvalho Chehab
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>
2011-07-27[media] DVB: Point to the generic error chapterMauro Carvalho Chehab
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>
2011-07-27[media] DVB API: Mention the dvbM deviceBjørn Mork
Signed-off-by: Bjørn Mork <bjorn@mork.no> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook: Use base64 for gif/png filesMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/video.xml: Document the remaining data structuresMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/video.xml: Fix section references with video.h.xmlMauro Carvalho Chehab
Make the reference links at video.h.xml to match the ones at video.xml. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/Makefile: Remove osd.h headerMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/net.xml: Synchronize Network data structureMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/demux.xml: Add the remaining data structures to the API specMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/demux.xml: Fix section references with dmx.h.xmlMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/ca.xml: Describe structure ca_pidMauro Carvalho Chehab
This is the remaining missing structure at ca.xml. The ioctl's are still missing through. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] Docbook/ca.xml: match section ID's with the reference linksMauro Carvalho Chehab
Make sure that both ca.h.xml and ca.xml will match the same names for the sections/links. This way, it is now possible to identify API spec gaps: Error: no ID for constraint linkend: ca-pid. Error: no ID for constraint linkend: ca-pid. Error: no ID for constraint linkend: CA_RESET. Error: no ID for constraint linkend: CA_GET_CAP. Error: no ID for constraint linkend: CA_GET_SLOT_INFO. Error: no ID for constraint linkend: CA_GET_DESCR_INFO. Error: no ID for constraint linkend: CA_GET_MSG. Error: no ID for constraint linkend: CA_SEND_MSG. Error: no ID for constraint linkend: CA_SET_DESCR. Error: no ID for constraint linkend: CA_SET_PID. Basically, in this case, no CA ioctl is described at the specs, and one file structure (ca-pid) is missing. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook: Document AUDIO_CONTINUE ioctlMauro Carvalho Chehab
Although this ioctl is only used at the av7110 driver, it is not described at the API docbook. Yet, AUDIO_PAUSE ioctl description somewhat describes it. Fill the gap by using the information there and by looking inside av7110 implementation. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/audio.xml: synchronize attribute changesMauro Carvalho Chehab
Some attributes suffered some changes since DVBv1. Sync them with the current API header files. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/audio.xml: match section ID's with the reference linksMauro Carvalho Chehab
Make sure that both audio.h.xml and audio.xml will match the same names. This way, it is now possible to identify API spec gaps: Error: no ID for constraint linkend: AUDIO_CONTINUE. Error: no ID for constraint linkend: AUDIO_GET_PTS. Error: no ID for constraint linkend: AUDIO_BILINGUAL_CHANNEL_SELECT. While here, fix the cut-and-paste description error on AUDIO_SET_KARAOKE. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook: Add the other DVB API header filesMauro Carvalho Chehab
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/dvbproperty.xml: Better name the ISDB-T layersMauro Carvalho Chehab
In order to improve the DVB index, replace the title to a better name. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/dvbproperty.xml: Add Satellite standardsMauro Carvalho Chehab
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/dvbproperty.xml: Add ATSC standardMauro Carvalho Chehab
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/dvbproperty.xml: Add Cable standardsMauro Carvalho Chehab
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook: Finish synchronizing the frontend APIMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/dvbproperty.xml: Document the terrestrial delivery systemsMauro Carvalho Chehab
Instead of repeating duplicate parameters to each delivery system, just add a section for each specific delivery system, showing what's applicable to each case. This helps userspace app developers to know what DVB parameters are applicable to each delivery system. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/frontend.xml: Recomend the usage of the new APIMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/dvbproperty.xml: Reorganize the parametersMauro Carvalho Chehab
Put the parameters at the sequencial order as they appear inside the frontend.h header. TODO: fix the per-standard section, to reflect the parameters that should actually be used for each transmission system type. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/dvbproperty.xml: Use links for all parametersMauro Carvalho Chehab
Instead of adding a program listing, just add there all parameters. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/dvbproperty.xml: Document the remaining S2API parametersMauro Carvalho Chehab
There were lots of DVB S2API parameters that were never documented. Let's add a definition for all of them, based on what's currently used inside the core and the drivers. The description here is not complete nor perfect, so patches improving it are welcome. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/frontend.xml: Better describe the frontend parametersMauro Carvalho Chehab
Update the DVB parameter structs to reflect VSB modulation and improve a few descriptions. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/frontend.xml: add references for some missing infoMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/frontend.xml: Correlate dvb delivery systemsMauro Carvalho Chehab
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>
2011-07-27[media] DocBook/frontend.xml: Link DVB S2API parametersMauro Carvalho Chehab
Associate the frontend.h DVB S2API parmeters to the corresponding documentation at the spec. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27[media] DocBook/frontend.xml: Better document fe_type_tMauro Carvalho Chehab
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>
2011-07-27[media] DocBook: Move all media docbook stuff into its own directoryMauro Carvalho Chehab
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>