5 new ioctls were added to the DVB demux API, in order to
handle memory maped I/O. Add documentation for them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

With the new dmx mmap interface, those two syscalls are now
handled by the subsystem. Document them.

This patch is based on the V4L2 text for those ioctls.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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: NAthanasios Oikonomou <athoik@gmail.com>
Acked-by: NRalph Metzler <rjkm@metzlerbros.de>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

That section is too outdated and got superseded by DVBv5 and
by libdvbv5.

Maybe some day we'll end adding updated examples there, but
while nobody has time or interest of doing that, just mention
that there and get rid of the current examples for good.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

That's the last DVB kAPI that misses documentation.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are several problems with regards to the return of
FE_SET_PROPERTY. The original idea were to return per-property
return codes via tvp->result field, and to return an updated
set of values.

However, that never worked. What's actually implemented is:

- the FE_SET_PROPERTY implementation doesn't call .get_frontend
  callback in order to get the actual parameters after return;

- the tvp->result field is only filled if there's no error.
  So, it is always filled with zero;

- FE_SET_PROPERTY doesn't call memdup_user() nor any other
  copy_to_user() function. So, any changes to the properties
  will be lost;

- FE_SET_PROPERTY is declared as a write-only ioctl (IOW).

While we could fix the above, it could cause regressions.

So, let's just assume what the code really does, updating
the documentation accordingly and removing the logic that
would update the discarded tvp->result.
Reviewed-by: NShuah Khan <shuahkh@osg.samsung.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There's a chapter for the legacy APIs. Move the frontend DVBv3
API to it, and update the chapter's introduction accordingly.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The "Table of Contents" of a PDF file is generated only once,
at the beginning fo the output. It doesn't produce it on
each part.

So, don't output this text on each part of the document.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Usually, CA messages are sent/received via reading/writing at
the CA device node. However, two drivers (dst_ca and firedtv-ci)
also implement it via ioctls.

Apparently, on both cases, the net result is the same.

Anyway, let's document it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The av7110 driver uses CA_SET_DESCR to store the descrambler
control words at the CA descrambler slots.

Document it.

Thanks-to: Honza Petrouš <jpetrous@gmail.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

As we did with frontend.h, ca.h and dmx.h, move the struct
definition to net.h.

That should help to keep it updated, as more stuff gets
added there.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Originally, when DVB was introduced, all codecs would be part of
MPEG2 standard. That's not true anymore, as there are a large
number of codec standards used on digital TV nowadays.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The hardware description mentions that some parts are optional.
Make it clearer at the drawing.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This ioctl is supported by the DVB core, but was never
documented.

Add a documentation for it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Do minor editorial changes to improve documentation readability:

- mark literals as such;
- add table markups to hint sizes;
- define what PES means;
- instead of hardcoding devnode numbers to zero (like adapter0/) use a
  question mark, to indicate that multiple devnodes may exist;
- add cross-references where useful.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are several missing items at the API history. Yet,
as we're doing a significant change there, add a new entry.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The struct that contains an union of DVB parameters is
called dvb_frontend_parameters (and not FrontendParameters).

Fix it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

In the past, the documentation used to say that, if a CRC error
was found, a "-ECRC" error would be returned. That's not true:
the DVB core will just silently ignore such errors.

So, add an explicit note about that.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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

The device node name for CA is wrong since ever. I suspect
that the name there was before DVBv3 (with was the first API
introduced at the Kernel).

Anyway, use the right name there.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are several issues on the return value for ioctls:

- Text is confusing;
- Some error codes don't exist;
- The non-generic error codes should come before the text
  that points to the generic error codes;
- Tables don't contain column size hints;
- Some references are not marked as such.

Correct them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of having one chapter per file, place all of them at
the same chapter. That better organize the chapters at the uAPI
documentation.

As a side effect, now all uAPI headers are at the same page,
at the html output, with makes easier to use it as a reference
index for the spec.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Now that DVB spec is almost in sync, document what's missing.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Right now, the same undocumented structs are on two places:
at ca_data_types.rst and together with their ioctls.

Move them to just one place and use the standard way to
represent them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of a generic boilerplate, fill it with relevant
information about this ioctl.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of a generic boilerplate, fill it with relevant
information about this ioctl.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of a generic boilerplate, fill it with relevant
information about this ioctl.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

While we don't have any documentation for it, based on what's
there at Kaffeine and VDR, it seems that this command should
be issued before start using CA. So, document it as such.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

For most of the stuff there, documenting is easy, as the
header file contains information.

Yet, I was unable to document two data structs:
	ca_msg and ca_descr

As those two structs are used by a few drivers, keep them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This ioctl seems to be some attempt to support a feature
at the bt8xx dst_ca driver. Yet, as said there, it
"needs more work". Right now, the code there is just
a boilerplate.

At the end of the day, no driver uses this ioctl, nor it is
documented anywhere (except for "needs more work").

So, get rid of it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Due to a mistake, the DVB net chapter was actually broken
into two different chapters. Fix it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The demux documentation is pretty poor nowadays: most of the
structs and enums aren't documented at all.

Add proper kernel-doc markups for them and use it.

Now, the demux API data structures are fully documented :-)
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This seems to be a pure fictional API :-)

It only exists at the DVB book, with no code implemeting it.

So, just get rid of it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

No driver uses this ioctl, nor it is documented anywhere.

So, get rid of it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There's no driver currently using it; it is also not
documented about what it would be supposed to do.

So, get rid of it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There's a flag defined for Digital TV demux that is not used
anywhere, called DMX_KERNEL_CLIENT. Get rid of it.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Use a table to document the supported bandwidths. That makes
it clearer to readers.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Several frontend properties are specific to a subset of the
delivery systems. Make it clearer when describing each
property.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

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

Both CA and decoders are optional. Also, the presence or
absence has nothing to do on being a PCI card or not.

Nowadays, most hardware leaves the decoders to either the
GPU or to some ISP inside the SoC, instead of implementing
it inside the Digital TV part of the device.

So, change the wording to reflect the hardware changes.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>