linux.git/Documentation/media/uapi/dvb, branch v4.15

media: dvb uAPI docs: get rid of examples section

2017-10-11T17:22:55+00:00

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: Mauro Carvalho Chehab

media: dvb-net.rst: document DVB network kAPI interface

2017-10-11T17:22:09+00:00

That's the last DVB kAPI that misses documentation.

Signed-off-by: Mauro Carvalho Chehab

media: dvb_frontend: fix return values for FE_SET_PROPERTY

2017-10-11T16:58:40+00:00

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: Shuah Khan 
Signed-off-by: Mauro Carvalho Chehab

media: dvb uapi: move frontend legacy API to another part of the book

2017-09-05T11:09:57+00:00

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: Mauro Carvalho Chehab

media: docs: don't show ToC for each part on PDF output

2017-09-05T10:27:50+00:00

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: Mauro Carvalho Chehab

media: ca.h: document ca_msg and the corresponding ioctls

2017-09-05T10:23:28+00:00

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: Mauro Carvalho Chehab

media: ca docs: document CA_SET_DESCR ioctl and structs

2017-09-05T10:23:07+00:00

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

Document it.

Thanks-to: Honza Petrouš 
Signed-off-by: Mauro Carvalho Chehab

media: net.h: add kernel-doc and use it at Documentation/

2017-09-05T10:22:42+00:00

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: Mauro Carvalho Chehab

media: intro.rst: don't assume audio and video codecs to be MPEG2

2017-09-05T10:20:28+00:00

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: Mauro Carvalho Chehab

media: dvbstb.svg: use dots for the optional parts of the hardware

2017-09-05T10:20:13+00:00

The hardware description mentions that some parts are optional.
Make it clearer at the drawing.

Signed-off-by: Mauro Carvalho Chehab