linux-toradex.git/Documentation/media/uapi/dvb/fe_property_parameters.rst, branch master

media: docs: move uAPI book to userspace-api/media

2020-04-14T08:31:49+00:00

Since 2017, there is an space reserved for userspace API,
created by changeset 1d596dee3862 ("docs: Create a user-space API guide").

As the media subsystem was one of the first subsystems to use
Sphinx, until this patch, we were keeping things on a separate
place.

Let's just use the new location, as having all uAPI altogether
will likely make things easier for developers.

Signed-off-by: Mauro Carvalho Chehab

media: add SPDX header to media uAPI files

2018-12-05T15:39:18+00:00

All those files are under GFDL 1.1 or later, with no invariant sections.
Tag them as such.

Signed-off-by: Mauro Carvalho Chehab

media: remove text encoding from rst files

2018-12-05T15:37:18+00:00

This is not needed there. Also, the same UTF-8 encoding should
be used on all documents.

Signed-off-by: Mauro Carvalho Chehab

media: dvb_frontend: add physical layer scrambling support

2017-12-19T12:08:12+00:00

This commit adds a new property DTV_SCRAMBLING_SEQUENCE_INDEX.

This 18 bit field, when present, carries the index of the DVB-S2 physical
layer scrambling sequence as defined in clause 5.5.4 of EN 302 307.
There is no explicit signalling method to convey scrambling sequence index
to the receiver. If S2 satellite delivery system descriptor is available
it can be used to read the scrambling sequence index (EN 300 468 table 41).

By default, gold scrambling sequence index 0 is used. The valid scrambling
sequence index range is from 0 to 262142.

Increase the DVB API version in order userspace to be aware of the changes.

Signed-off-by: Athanasios Oikonomou 
Acked-by: Ralph Metzler 
Signed-off-by: Mauro Carvalho Chehab

media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB"

2017-09-05T10:18:03+00:00

The usage of the term "DVB" at the dvb API docs is confusing,
as, right now, it can refer to either the European digital TV
standard or to the subsystem.

So, prefer calling it as "Digital TV" on most places, to avoid
ambiguity.

Signed-off-by: Mauro Carvalho Chehab

media: fe_property_parameters.rst: better document bandwidth

2017-09-05T09:59:23+00:00

Use a table to document the supported bandwidths. That makes
it clearer to readers.

Signed-off-by: Mauro Carvalho Chehab

media: fe_property_parameters.rst: better define properties usage

2017-09-05T09:58:00+00:00

Several frontend properties are specific to a subset of the
delivery systems. Make it clearer when describing each
property.

Signed-off-by: Mauro Carvalho Chehab

media: dvb frontend docs: use kernel-doc documentation

2017-09-05T09:57:35+00:00

Now that frontend.h contains most documentation for the frontend,
remove the duplicated information from Documentation/ and use the
kernel-doc auto-generated one instead.

That should simplify maintainership of DVB frontend uAPI, as most
of the documentation will stick with the header file.

Signed-off-by: Mauro Carvalho Chehab

[media] docs-rst exceptions: use C domain references for DVB headers

2016-09-09T12:45:24+00:00

Now that we moved away from the :ref: type of references,
we need to update the exceptions lists.

Signed-off-by: Mauro Carvalho Chehab

[media] Fix a few additional tables at uAPI for LaTeX output

2016-08-22T13:32:16+00:00

There are still a few tables with wrong columns at the uAPI
docs. Fix them.

Signed-off-by: Mauro Carvalho Chehab