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>
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>
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>
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>
- Add missing V4L2_CTRL_TYPE_U32 documentation
- Remove 'which are actually different on the hardware' sentence which
is confusing. I think the idea was to let the user know that the step can
be different for different hardware, but that's obvious because otherwise
you wouldn't need to specify the step value.
- Clarify that V4L2_CTRL_COMPOUND_TYPES also applies to arrays.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Document this new transfer function used by High Dynamic Range content.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This patch fix spelling typo "the the" found in controls.xml
and vidioc-g-param.xml.
These xml files are'nt generated from any source files, so I have
to fix these xml files directly.
Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
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>
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>
Fix small typo (missing 'it') in the documentation for
V4L2_CTRL_FLAG_EXECUTE_ON_WRITE.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Acked-by: Ricardo Ribalda Delgado <ricardo.ribalda@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
The documentation had two media_version entries. The second one was a typo and
it should be driver_version instead. Correct this.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
The VIDIOC_EXPBUF documentation had spurious spaces that made it irritating
to read. Fix this.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
In order to be sure that all enum definitions will be documented,
let's parse the enum values and add xref links to them.
Lots of missing references will be risen as we miss adding
id's to those symbols at the documentation. Next patches will
fix this.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
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>
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>
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>
Make sure that the documentation clearly states who is zeroing reserved
fields: drivers and/or applications.
This patch syncs the documentation with the checks that v4l2-compliance
and valgrind do.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Document the new field and defines to set the transfer function needed
to correctly decode the colors of an image.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
The changeset dc9ef7d112 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>
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>
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>
Document this new colorspace define.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Document this new colorspace define.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This format was added but not documented. Do this now.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Acked-by: Ricardo Ribalda Delgado <ricardo.ribalda@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
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>
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>
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>
