summaryrefslogtreecommitdiff
path: root/Documentation/media
AgeCommit message (Collapse)Author
2016-07-23[media] cx23885-cardlist.rst: add a new cardMauro Carvalho Chehab
add card Hauppauge WinTV-QuadHD-DVB to the list. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: kapi: use :c:func: instead of :cpp:funcMauro Carvalho Chehab
References at the rst files for C functions generated via kernel-doc should use :c:func:. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-ioctl.h add debug info for struct v4l2_ioctl_opsMauro Carvalho Chehab
This struct is mentioned at the kAPI docbook. So, let's document it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: reorganize the kAPI v4l2 chaptersMauro Carvalho Chehab
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>
2016-07-23[media] rename v4l2-framework.rst to v4l2-intro.rstMauro Carvalho Chehab
Now that the only remaining chapters at v4l2-framework are the introduction ones, let' s rename the file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] move V4L2 clocks to a separate .rst fileMauro Carvalho Chehab
Move the v4l2 clocks stuff from v4l2-framework to a separate file and adds an attention that came from the v4l2-clk.h. Note: as this is meant to be a temporary kAPI, and it is used only by two drivers (soc_camera and em28xx), where the first one is in deprecation process, it probably not a worth effort to document its header. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-fh.rst: add cross references and markupsMauro Carvalho Chehab
Add cross-references with the kernel-doc functions/structs and improve the markups. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-fh.rst: add fh contents from v4l2-framework.rstMauro Carvalho Chehab
Move the v4l2_fh specific content from v4l2-framework.rst to v4l2-fh.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-fh.h: add documentation for itMauro Carvalho Chehab
This header file was undocumented. Add documentation for it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-event.rst: add cross-references and markupsMauro Carvalho Chehab
Improve events documentation by adding cross references, sub-titles and other markup elements. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-event.rst: add text from v4l2-framework.rstMauro Carvalho Chehab
Move the v4l2 event-specific text from v4l2-framework.rst to v4l2-event.rst. That helps to keep the text together with the functions it describes, and makes easier to identify documentation gaps. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-framework.rst: remove videobuf quick chapterMauro Carvalho Chehab
As we merged the videobuf chapter at the kABI section, and it is a way more complete, just remove the small videobuf chapter that came from framework.txt. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-dev: add cross-references and improve markupMauro Carvalho Chehab
Add cross-references for the functions/structs and add the markup tags to improve its display. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: move v4l2-dev doc to a separate fileMauro Carvalho Chehab
Move the documentation for video device node creation to a separate file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: document v4l2-dev.hMauro Carvalho Chehab
Add documentation for v4l2-dev.h, and put it at v4l2-framework.rst, where struct video_device is currently documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] mc-core: Fix a cross-referenceMauro Carvalho Chehab
The v4l2_subdev reference was using the wrong tag. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-common.h: document the subdev functionsMauro Carvalho Chehab
There are some subdev-specific functions at v4l2-common.h that are mentioned at v4l2-subdev.rst. Document them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-subdev.rst: add cross references to new sectionsMauro Carvalho Chehab
The two new sections were missing cross-references, and had some other minor issues with the markups. Add such things. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-subdev.rst: add two sections from v4l2-framework.rstMauro Carvalho Chehab
There are two additional subdev-specific sections at the v4l2-framework file. Move them to the subdev chapter, in order to better organize the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: merge v4l2-async.rst with v4l2-subdev.rstMauro Carvalho Chehab
The Async API is actually part of the v4l2 subdev. Move its declarations to it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-subdev.rst: add cross-referencesMauro Carvalho Chehab
Enrich the subdevice description by linking it to the functions and structs from v4l2-subdev.h. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-subdev.rst: add documentation from v4l2-framework.rstMauro Carvalho Chehab
There are lots of documentation about V4L2 subdevices at v4l2-framework.rst. Move them to its specific chapter at v4l2-subdev.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-device.rst: do cross references with kernel-docMauro Carvalho Chehab
This document describes the main kAPI interfaces for the v4l2-device.h header. Add cross references to the documentation produced via kernel-doc. While here, also use monotonic font for constants. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] v4l2-device.rst: add contents from v4l2-frameworkMauro Carvalho Chehab
Part of the contents of v4l2-framework is related to the kAPI defined by v4l2-device. Move such contents to the v4l2-device.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: Split v4l-core into one file per kAPIMauro Carvalho Chehab
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>
2016-07-23[media] v4l2-device.h: document functionsMauro Carvalho Chehab
The functions at v4l2-device.h are not using the proper markups. Add it, and include at the v4l2-core.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: Fix license for the media booksMauro Carvalho Chehab
The kAPI, v4l-drivers and dvb-drivers never used the GNU FDL license. The addition of such license header were just due to copy-and-paste. So, let's fix it. As the media_kapi were part of device-drivers.tmp, it is under GPL v2+. The other two books is an agregation of files without any license explicitly specified. So, they're all bound to the Kernel's COPYING license. So, they're GPL v2 only. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: better organize the media booksMauro Carvalho Chehab
The uAPI book has 5 parts, but they lost numeration after conversion to rst. Manually number those parts, and make the main index with 1 depth, to only show the parts and the annexes. At each part, use :maxwidth: 5, in order to show a more complete index. While here, fix the cross-references between different books. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: Fix some Sphinx warningsMauro Carvalho Chehab
Fix all remaining media warnings with ReST that are fixable without changing at the Sphinx code. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23Merge branch 'patchwork' into topic/docs-nextMauro Carvalho Chehab
* 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>
2016-07-19[media] doc-rst: cec: update documentationHans Verkuil
Update and expand the CEC documentation. Especially w.r.t. non-blocking mode. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-19[media] doc-rst: backward compatibility with older Sphinx versionsMauro Carvalho Chehab
Sphinx is really evil when an older version finds an extra attribute for the :toctree: tag: it simply ignores everything and produce documents without any chapter inside! As we're now using tags available only on Sphinx 1.4.x, we need to use some creative ways to add a title before the table of contents. Do that by using a css class. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] doc-rst: better name the media booksMauro Carvalho Chehab
The titles at the media books were misleading, and some books were not numbered. Rename the kAPI book to better reflect its contents, be more consistent on the initial rst file for each book and better name them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] doc-rst: fix media kAPI documentationMauro Carvalho Chehab
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>
2016-07-18[media] get rid of Documentation/video4linux/lifeview.txtMauro Carvalho Chehab
Move the contents of this file to bttv.rst and saa7134.rst. With that, we can finally remove Documentation/video4linux. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx88.rst: add contents of hauppauge-wintv-cx88-ir.txtMauro Carvalho Chehab
Import the contents of hauppauge-wintv-cx88-ir.txt, after converted to ReST into cx88.rst file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx88.rst: add contents from not-in-cx2388x-datasheet.txtMauro Carvalho Chehab
There are some information about missing/wrong documentation at cx231xx datasheet. Add it to the cx88 chapter. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x.rst: add contents of README.vbiMauro Carvalho Chehab
Finally, adds the content of README.vbi at cx2341x.rst after its conversion to ReST format. Now, add information about this chipset and its driver is inside a single chapter at the media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x: add contents of README.hm12Mauro Carvalho Chehab
The README.hm12 file describes the proprietary format used by this driver for raw format, called HM12. Add its description at the document, after converted to ReST. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x.rst: add contents of fw-osd-api.txtMauro Carvalho Chehab
Convert it to ReST format and add to cx2341x.rst file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x.rst: add the contents of fw-upload.txtMauro Carvalho Chehab
Add the contents of fw-upload.txt, after converting it to ReST format. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x.rst: add contents of fw-memory.txtMauro Carvalho Chehab
Convert the content to ReST and add it at the cx231xx.rst file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x.rst: add contents of fw-dma.txtMauro Carvalho Chehab
Add the contents of fw-dma.txt, converted to ReST, and drop the old file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x.rst: add the contents of fw-calling.txtMauro Carvalho Chehab
Convert it to ReST and add its contents at this file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x.rst: Add the contents of fw-encoder-api.txtMauro Carvalho Chehab
Convert its contents to ReST and add to cx2341x.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] cx2341x.rst: add fw-decoder-registers.txt contentMauro Carvalho Chehab
Convert the contents of fw-decoder-registers.txt to ReST and add it to cx2341x.rst file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] doc-rst: start adding documentation for cx2341xMauro Carvalho Chehab
move the contents of fw-decoder-api.txt to cx2341x and convert it to ReST file, adding it to media/v4l-drivers Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] doc-rst: add documentation for tunersMauro Carvalho Chehab
Convert bttv/Tuners to ReST and add it to the media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] doc-rst: add documentation for bttv driverMauro Carvalho Chehab
Convert it to ReST and add it to media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] doc-rst: move bttv documentation to bttv.rst fileMauro Carvalho Chehab
There were several files under Documentation/video4linux/bttv. Instead of simply copying them to the rst folder, I opted to merge into a single document and adjust the headers to adjust the section levels and fix the cards tables. There are two exceptions on the merge: - The Tuners were renamed as a separate document, as they describe a separate driver; - I removed the PROBLEMS section. It describes problems with the very first generation of 3D boards (Mistique/S3). It sounds very unlikely that someone would still need to install a bttv board on such hardware. Also, it is not very well written, IMHO. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>