summaryrefslogtreecommitdiffstats
path: root/Documentation/media/kapi/v4l2-controls.rst
Commit message (Collapse)AuthorAgeFilesLines
* media: Documentation: v4l2_ctrl_new_std_compoundRicardo Ribalda Delgado2019-10-101-0/+9
| | | | | | | | | | Function for initializing compound controls with a default value. Suggested-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org> Signed-off-by: Ricardo Ribalda Delgado <ribalda@kernel.org> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* media: docs: v4l2-controls: remove outdated paragraphLuca Ceresoli2019-06-211-5/+0
| | | | | | | | | | | | | | | | | | 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 <luca@lucaceresoli.net> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* media: docs: v4l2-controls: document file to includeLuca Ceresoli2019-06-211-0/+4
| | | | | | | | The tutorial in this section is almost complete, add the one missing bit. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* media: docs: v4l2-controls: convert code blocks to CLuca Ceresoli2019-06-211-37/+37
| | | | | | | | | All these code blocks contain C code, enable C formatting for a nicer reading. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* media: docs: v4l2-controls: add links to functionsLuca Ceresoli2019-06-211-32/+35
| | | | | | | | This section lacks links to functions. Add one to simplify reading. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* media: docs: v4l2-controls: rearrange control initialization sequenceLuca Ceresoli2019-06-211-23/+17
| | | | | | | | | | | | | 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 <luca@lucaceresoli.net> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* media: docs: v4l2-controls: add links to structsLuca Ceresoli2019-06-211-8/+10
| | | | | | | | | This section lacks links to struct definitions. Add one where each struct is introduced. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* media: docs: brainless mass add SPDX headers to all media filesMauro Carvalho Chehab2018-12-051-0/+2
| | | | | | | | | 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 <mchehab+samsung@kernel.org>
* [media] doc-rst: reorganize the kAPI v4l2 chaptersMauro Carvalho Chehab2016-07-231-2/+2
| | | | | | | Reorganize the order of the document, putting the chapters on a more logical order and renaming some sections. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Split v4l-core into one file per kAPIMauro Carvalho Chehab2016-07-231-0/+5
| | | | | | | | | | | Sphinx produce a 1:1 mapping between a rst file and an html file. So, we need to split the kernel-doc tags on multiple documents. A side effect is that we're now having a better name for each section of the kAPI documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* Merge branch 'patchwork' into topic/docs-nextMauro Carvalho Chehab2016-07-231-17/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | * patchwork: (1492 commits) [media] cec: always check all_device_types and features [media] cec: poll should check if there is room in the tx queue [media] vivid: support monitor all mode [media] cec: fix test for unconfigured adapter in main message loop [media] cec: limit the size of the transmit queue [media] cec: zero unused msg part after msg->len [media] cec: don't set fh to NULL in CEC_TRANSMIT [media] cec: clear all status fields before transmit and always fill in sequence [media] cec: CEC_RECEIVE overwrote the timeout field [media] cxd2841er: Reading SNR for DVB-C added [media] cxd2841er: Reading BER and UCB for DVB-C added [media] cxd2841er: fix switch-case for DVB-C [media] cxd2841er: fix signal strength scale for ISDB-T [media] cxd2841er: adjust the dB scale for DVB-C [media] cxd2841er: provide signal strength for DVB-C [media] cxd2841er: fix BER report via DVBv5 stats API [media] mb86a20s: apply mask to val after checking for read failure [media] airspy: fix error logic during device register [media] s5p-cec/TODO: add TODO item [media] cec/TODO: drop comment about sphinx documentation ... Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: move videobuf documentation to media/kapiMauro Carvalho Chehab2016-07-171-47/+122
| | | | | | | This document describes a kapi framework. Move it to the right place. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: move framework docs to kAPI documentationMauro Carvalho Chehab2016-07-171-0/+751
Those documentation are part of the kAPI one. Move to the right place. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>