linux.git/Documentation/media/kapi, branch v4.19

media: cec: improve cec status documentation

2018-05-25T19:34:50+00:00

Clarify the description of status bits, particularly w.r.t. ERROR and NACK.

Signed-off-by: Hans Verkuil 
Signed-off-by: Hans Verkuil 
Signed-off-by: Mauro Carvalho Chehab

media: doc: fix ReST link syntax

2018-04-04T10:12:52+00:00

There is a ':' in excess, resulting in an unwanted ':' in the rendered
output.

Signed-off-by: Luca Ceresoli 
Signed-off-by: Hans Verkuil 
Signed-off-by: Mauro Carvalho Chehab

media: cec-core.rst: document the error injection ops

2018-03-22T12:00:01+00:00

Document the new core error injection callbacks.

Signed-off-by: Hans Verkuil 
Signed-off-by: Mauro Carvalho Chehab

media: dvb kAPI docs: document dvb_vb2.h

2017-12-29T13:31:25+00:00

Document the data structures and functions inside this kAPI header.

Signed-off-by: Mauro Carvalho Chehab

media: move dvb kAPI headers to include/media

2017-12-28T18:16:01+00:00

Except for DVB, all media kAPI headers are at include/media.

Move the headers to it.

Signed-off-by: Mauro Carvalho Chehab

media: v4l2-dev: convert VFL_TYPE_* into an enum

2017-12-18T16:49:40+00:00

Using enums makes easier to document, as it can use kernel-doc
markups. It also allows cross-referencing, with increases the
kAPI readability.

Please notice that now cx88_querycap() has to have a default for
the VFL type, as there are more types than supported by the driver.

Acked-By: Mike Isely 
Acked-by: Hans Verkuil 
Signed-off-by: Mauro Carvalho Chehab

media: v4l2-event.rst: improve events description

2017-12-18T15:35:46+00:00

Both v4l2-event.rst and v4l2-event.h have an overview of
events, but there are some inconsistencies there:

- at v4l2-event, the event's ring buffer is called kevent. Its
  name is, instead, v4l2_kevent;

- Some things are mentioned on both places (with different words),
  others are either on one of the files.

In order to cleanup this mess, put everything at v4l2-event.rst
and improve it to be a little more coherent and to have cross
references.

Acked-by: Sakari Ailus 
Signed-off-by: Mauro Carvalho Chehab

media: rc-core.rst: add an introduction for RC core

2017-12-18T15:15:29+00:00

The RC core does several assumptions, but those aren't documented
anywhere, with could make harder for ones that want to understand
what's there.

So, add an introduction explaining the basic concepts of RC and
how they're related to the RC core implementation.

Acked-by: Sakari Ailus 
Acked-by: Sean Young 
Signed-off-by: Mauro Carvalho Chehab

media: lirc: remove last remnants of lirc kapi

2017-12-14T15:35:20+00:00

rc-core has replaced the lirc kapi many years ago, and now with the last
driver ported to rc-core, we can finally remove it.

Note this has no effect on userspace.

All future IR drivers should use the rc-core api.

Signed-off-by: Sean Young 
Signed-off-by: Mauro Carvalho Chehab

media: cec-core.rst: document the new adap_monitor_pin_enable op

2017-12-08T16:10:37+00:00

Document what this op does.

Signed-off-by: Hans Verkuil 
Signed-off-by: Mauro Carvalho Chehab