linux-stable.git/Documentation/media/kapi, branch v5.3

media: docs: v4l2-controls: remove outdated paragraph

2019-06-21T21:06:25+00:00

This paragraph was added by commit a42b57f5aacf ("V4L/DVB: Documentation:
add v4l2-controls.txt documenting the new controls API") back in 2010, when
the controls API has been improved. Nowadays it is a bit anachronistic, so
remove it.

The same information is stated in up-to-date wording a few paragraphs later

> You’re done! And this is sufficient for most of the drivers we have. No
> need to do any validation of control values, or implement QUERYCTRL,
> QUERY_EXT_CTRL and QUERYMENU. And G/S_CTRL as well as G/TRY/S_EXT_CTRLS
> are automatically supported.

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

media: docs: v4l2-controls: document file to include

2019-06-21T21:05:18+00:00

The tutorial in this section is almost complete, add the one missing bit.

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

media: docs: v4l2-controls: convert code blocks to C

2019-06-21T21:04:57+00:00

All these code blocks contain C code, enable C formatting for a nicer
reading.

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

media: docs: v4l2-controls: add links to functions

2019-06-21T21:04:25+00:00

This section lacks links to functions. Add one to simplify reading.

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

media: docs: v4l2-controls: rearrange control initialization sequence

2019-06-21T21:04:03+00:00

The code snippet showing how to add controls to the driver’s top-level
struct is present twice, but only the second time it is split in the V4L2
and subdev cases. Consolidate everything at the beginning.

Also remove the "Where foo->bar is of type struct baz" sentences, this
obvious from the code.

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

media: docs: v4l2-controls: add links to structs

2019-06-21T21:03:16+00:00

This section lacks links to struct definitions. Add one where each struct
is introduced.

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

media: docs: fix minor typos

2019-06-05T15:31:51+00:00

Fix minor typos in the DVB demux documentation.

Signed-off-by: Marc Gonzalez 
Signed-off-by: Mauro Carvalho Chehab

media: Media Device Allocator API

2019-04-22T15:18:26+00:00

Media Device Allocator API to allows multiple drivers share a media device.
This API solves a very common use-case for media devices where one physical
device (an USB stick) provides both audio and video. When such media device
exposes a standard USB Audio class, a proprietary Video class, two or more
independent drivers will share a single physical USB bridge. In such cases,
it is necessary to coordinate access to the shared resource.

Using this API, drivers can allocate a media device with the shared struct
device as the key. Once the media device is allocated by a driver, other
drivers can get a reference to it. The media device is released when all
the references are released.

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

media: Documentation: fix several typos

2019-03-01T14:54:06+00:00

Use codespell to fix lots of typos over frontends.

Manually verified to avoid false-positives.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Philipp Zabel 
Signed-off-by: Mauro Carvalho Chehab

media: docs: brainless mass add SPDX headers to all media files

2018-12-05T15:40:34+00:00

All Documentation files outside the uAPI are all licensed with,
at least, GPL 2.0. So, mark them as such.

The ondes at media/uapi are at least GFDL 1.1+.

Signed-off-by: Mauro Carvalho Chehab