summaryrefslogtreecommitdiffstats
path: root/Documentation/media/kapi
Commit message (Collapse)AuthorAgeFilesLines
...
* 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: fix media kAPI documentationMauro Carvalho Chehab2016-07-184-35/+1
| | | | | | | | | | | I ended by adding twice each media header, because I saw some missing stuff at the documents. It seems it was my mistake, as everything seems to be there. So, remove those extra stuff, to avoid duplicating the documentation of the functions. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Convert videobuf documentation to ReSTMauro Carvalho Chehab2016-07-171-2/+49
| | | | | | | | | | The videobuf documentation is almost at rst format: we just needed to add titles and add some code-blocks there and that's it. Also, add a notice that this framework is deprecated. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: move videobuf documentation to media/kapiMauro Carvalho Chehab2016-07-172-47/+477
| | | | | | | 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: do a poor man's conversion of v4l2-frameworkMauro Carvalho Chehab2016-07-171-128/+230
| | | | | | | | | | | | | | | | | Make Sphinx happy with v4l2-framework.rst by putting all C code inside code-block. Please note that this is a poor man ReST conversion, as several of those blocks should actually be converted to use :cpp:func:, pointing to the kAPI auto-generated documentation. The problem is that we currently lack kernel-doc documentation for most of the stuff described there. So, let's do a poor man's conversion. We should later address this. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: move framework docs to kAPI documentationMauro Carvalho Chehab2016-07-172-0/+1911
| | | | | | | Those documentation are part of the kAPI one. Move to the right place. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix conversion for dvb-core.rstMauro Carvalho Chehab2016-07-171-13/+27
| | | | | | | | | | | | | | | | | | The conversion from DocBook required some fixes: - Now, the C files with the exported symbols also need to be added. So, all headers need to be included twice: one to get the structs/enums/.. and another one for the functions; - Notes should use the ReST tag, as kernel-doc doesn't recognizes it anymore; - Identation needs to be fixed, as ReST uses it to identify when a format "tag" ends. - Fix the cross-references at the media controller description. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix conversion for MC core functionsMauro Carvalho Chehab2016-07-171-81/+105
| | | | | | | | | | | | | | | | | | | | | | There were lots of issues at the media controller side, after the conversion: - Some documentation at the header files weren't using the kernel-doc start block; - Now, the C files with the exported symbols also need to be added. So, all headers need to be included twice: one to get the structs/enums/.. and another one for the functions; - Notes should use the ReST tag, as kernel-doc doesn't recognizes it anymore; - Identation needs to be fixed, as ReST uses it to identify when a format "tag" ends. - Fix the cross-references at the media controller description. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix conversion for v4l2 core functionsMauro Carvalho Chehab2016-07-171-0/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | The conversion from DocBook lead into some conversion issues, basically due to the lack of proper support at kernel-doc. So, address them: - Now, the C files with the exported symbols also need to be added. So, all headers need to be included twice: one to get the structs/enums/.. and another one for the functions; - Notes should use the ReST tag, as kernel-doc doesn't recognizes it anymore; - Identation needs to be fixed, as ReST uses it to identify when a format "tag" ends. - kernel-doc doesn't escape things like *pointer, so we need to manually add a escape char before it. - On some cases, kernel-doc conversion requires violating the 80-cols, as otherwise it won't properly parse the source code. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix issues with RC documentationMauro Carvalho Chehab2016-07-171-0/+9
| | | | | | | The kernel-doc script is now broken if it doesn't find all exported symbols documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: split media_drivers.rst into one file per API typeMauro Carvalho Chehab2016-07-174-0/+411
Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
OpenPOWER on IntegriCloud