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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro 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: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Use the proper format for FE_DISEQC_SEND_BURST documentation
and improve the documentation.
Keep the enum fe_sec_mini_cmd description together with
the ioctl, as both are used together.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Use the proper format for FE_SET_TONE documentation and
improve the documentation.
Keep the enum fe_sec_tone_mode description together with
the ioctl, as both are used together.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Use the proper format for FE_SET_VOLTAGE documentation and fix
the documentation. The description for the enum is not 100%,
and it is missing the voltage off value.
Also, it is better to keep the enum description together with
the ioctl, as both are used together.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
That helps the xref logic at the Makefile to point to the
right place. Also, it becomes more organized and easier to
maintain if each ioctl have its own xml file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
for the xml files describing ioctls, use the same nomenclature
as on V4L2: the ioctl name, in lower case, using - instead of _.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
The new code that detects undocumented ioctls hits some false
positives:
This one is not documented, nor it should, as this is
there just to reserve namespace:
Warning: can't find reference for VIDIOC_RESERVED ioctl
But those are already documented together with other ioctls:
Warning: can't find reference for VIDIOC_UNSUBSCRIBE_EVENT ioctl
Warning: can't find reference for FE_GET_PROPERTY ioctl
Warning: can't find reference for VIDIOC_SUBDEV_G_EDID ioctl
Warning: can't find reference for VIDIOC_SUBDEV_S_EDID ioctl
Warning: can't find reference for VIDIOC_SUBDEV_S_DV_TIMINGS ioctl
Warning: can't find reference for VIDIOC_SUBDEV_G_DV_TIMINGS ioctl
Warning: can't find reference for VIDIOC_SUBDEV_QUERY_DV_TIMINGS ioctl
So, we need to just be sure to point to the right documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Create xref links for all DTV properties and link the frontend.h
to each. Also use them at the DVB frontent API example.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Instead of having two refentries, merge them into just one,
like what's done with other similar ioctls at V4L2 side.
That makes the entry cleaner and will allow to add the associated
structures together with the refentry.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Instead of going to the V4L2 open(), use the xref to the
proper place at the frontend ioctls that were already
reformatted.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
The DVBv5 API uses DVB properties as the main way to set the frontend
and collect statistics. Move the definition to happen earlier, in
order to reflect its importance.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Move the ioctl and enum fe_status to a separate xml file and
put it into a better format.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Keeping everything altogether makes harder to reorganize the
DocBook. So, move the FE_GET_INFO ioctl and the associated structures
into a separate file.
No functional changes.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
The DVB part of the docbook has a completely different format
than the V4L2 part, as it was written as a separate document.
As the V4L2 documentation is on better shape, and its format
allows adding more information, let's use it for FE_GET_INFO
and gradually update the non-legacy DVB ioctls using the new
format.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Although the recommended usage is the DVBv5 API calls, the
documentation doesn't make it clear about what's the recommended
calls and what's legacy.
So, move the legacy API bits to a separate xml, putting them into
a new section.
Please notice that more changes are needed, since some of the
bits there are cross-referenced elsewhere.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Currently, it is using 'role="tt"', but this is not defined at
the DocBook 4.5 spec. The net result is that no emphasis happens.
So, replace them to bold emphasis.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
In comments and in the documentation, the units of properties marked
with the FE_SCALE_DECIBEL scale are specified in terms of 1/1000 dB
or 0.0001 dB. This is inconsistent, however, as 1/1000 is 0.001,
not 0.0001.
Note that the v4l-utils divide the value by 1000 for the signal
strength suggesting that the 1/1000 is correct.
Settle on millidecibels, ie. 1/1000dB or 0.001dB.
Signed-off-by: David Howells <dhowells@redhat.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
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>
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>
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>
Those ioctls were added back in 2009, at changeset 1cb662a314
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>
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>
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>
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>
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>
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>
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>
