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: NJonathan Corbet <corbet@lwn.net>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Some minor English syntax fixes.
Reported-by: NJonathan Corbet <corbet@lwn.net>
Signed-off-by: NMauro 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: NJonathan Corbet <corbet@lwn.net>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

According with the docs at docbook.org, no backward compatible
changes were done between 4.2 and 4.5 schemas. Some fixes were
added, together with new features. So, let's use the latest
4.x schema.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Define the usage of UTF-8 encoding and let clear that the document
is in English.
Signed-off-by: NMauro 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: NMauro 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: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

This has been on my TODO list for some time now: the control that enables the video
loopback was part of the controls of the video output device instead of the video
capture device. In practice this was quite annoying since you expect it at the capture
side since that's where you want to make the decision whether to use the TPG or looped
video.

This patch moves the control from the output to the capture side.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Document the new Transfer Function control (and fix the documentation for
the other colorspace controls which were not quite correct).

Mention the support for 4:2:0 and more multiplanar formats.

Update the TODO list at the end.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro 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: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

FE_SET_PROPERTY/FE_GET_PROPERTY actually expects a struct dtv_properties
argument.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

The changeset dc9ef7d1 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: NMauro 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: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Fixes a large number of xmllint errors.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

satellital -> satellite
antena -> antenna
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Document this new colorspace define.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Document this new colorspace define.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

This format was added but not documented. Do this now.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Acked-by: NRicardo Ribalda Delgado <ricardo.ribalda@gmail.com>
Signed-off-by: NMauro 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: NMauro 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: NMauro 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: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

In order to make it clearer about how to use the DVBv5 calls,
add an example of its usage. That should make it clearer about
what's actually required for the DVBv5 calls to work.

While here, also mentions the libdvbv5 library.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Rename the tytle of the struct documentation to reflect
the name of the structures, and use links to do cross-ref.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Format it as a table and links it with the legacy API xml.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Format it as a table and add more details, in special for
DTMB guard intervals.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Format it as a table and add more details. Also, remove the
duplicated occurrences.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

fe_bandwidth/fe_bandwidth_t is used only on DVBv3 API. So, move
it to the frontend legacy xml, and convert it into a table.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Format it as a table and add more details, in special, for
the DTMB modes.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Format it as a table and provide more details.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

At frontend legacy API description, there are three places
where fe_modulation_t is defined. Cross-reference it to point
to the right place at the documentation.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

The typedef parser is wrong and doesn't get some of the
types defined at the DVB API. Improve it, as we want to add
cross-references to those types.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

There are a few issues at FE_GET_INFO documentation:
- name is a string, not a pointer to a string;
- the return text should be after the paragraph.

While here, better to bold that two fields of the structure used
by FE_GET_INFO are actually deprecated.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Instead of using programlisting, use a table, as this provides
a better view of the structure.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

The fe_type is deprecated at the DVB API. However, it may still
be used by legacy DVBv3 applications. While this works with old
devices, modern devices may support more than one delivery
system.

Add an explanation about that and a point to what should be
used, instead, in order for legacy apps to support newer hardware.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Instead of just showing ioctls, let's add an introdutory text
briefly explaining the DVB frontend API.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

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: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

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: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Use the new format for the ioctl documentation and put the
struct dvb_diseqc_slave_reply together with the ioctl.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Use the new format for the ioctl documentation and put the
struct dvb_diseqc_slave_reply together with the ioctl.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>

Use the new format for the ioctl documentation and put the
struct dvb_diseqc_slave_reply together with the ioctl.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>