openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
linux/Documentation/media/v4l-drivers/index.rst

70 lines
1.2 KiB
ReStructuredText
Raw Normal View History

media: docs: brainless mass add SPDX headers to all media files 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>
2018-08-30 22:20:04 +08:00
.. SPDX-License-Identifier: GPL-2.0
[media] doc-rst: move cardlists to media/v4l-drivers Convert the cardlists to ReST format and move them to Documentation/media/v4l-drivers/ Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 01:13:28 +08:00
.. include:: <isonum.txt>
[media] v4l: ctrls: Add deinterlacing mode control The menu control selects the operation mode of a video deinterlacer. The menu entries are driver specific. Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran@bingham.xyz> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-05 00:14:02 +08:00
.. _v4l-drivers:
[media] doc-rst: better name the media books 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-19 02:01:20 +08:00
################################################
Video4Linux (V4L) driver-specific documentation
################################################
[media] doc-rst: move cardlists to media/v4l-drivers Convert the cardlists to ReST format and move them to Documentation/media/v4l-drivers/ Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 01:13:28 +08:00
**Copyright** |copy| 1999-2016 : LinuxTV Developers
[media] doc-rst: Fix license for the media books 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-20 22:27:17 +08:00
This documentation is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation version 2 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
For more details see the file COPYING in the source distribution of Linux.
[media] doc-rst: move cardlists to media/v4l-drivers Convert the cardlists to ReST format and move them to Documentation/media/v4l-drivers/ Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 01:13:28 +08:00
media: docs: don't show ToC for each part on PDF output The "Table of Contents" of a PDF file is generated only once, at the beginning fo the output. It doesn't produce it on each part. So, don't output this text on each part of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-03 08:25:36 +08:00
.. only:: html
.. class:: toc-title
[media] doc-rst: backward compatibility with older Sphinx versions 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-19 23:35:08 +08:00
Table of Contents
[media] doc-rst: move cardlists to media/v4l-drivers Convert the cardlists to ReST format and move them to Documentation/media/v4l-drivers/ Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 01:13:28 +08:00
.. toctree::
:maxdepth: 5
[media] doc-rst: add vivid documentation Convert it to ReST and add to media/v4l-drivers book. As the sections here (and on other docs) are numbered, let's also make this book auto-numbered. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 09:07:30 +08:00
:numbered:
[media] doc-rst: move cardlists to media/v4l-drivers Convert the cardlists to ReST format and move them to Documentation/media/v4l-drivers/ Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 01:13:28 +08:00
[media] doc-rst: convert fourcc to rst format Fix fourcc for it to be correcly parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 03:32:38 +08:00
fourcc
[media] doc-rst: add documentation about IR on V4L boards This section is outdated, but let's add it, after converting to ReST, and then fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 09:11:47 +08:00
v4l-with-ir
[media] doc-rst: add documentation for tuners 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 21:38:35 +08:00
tuners
[media] doc-rst: move cardlists to media/v4l-drivers Convert the cardlists to ReST format and move them to Documentation/media/v4l-drivers/ Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 01:13:28 +08:00
cardlist
[media] doc-rst: add documentation for bttv driver 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 21:30:59 +08:00
bttv
[media] doc-rst: convert cafe_ccic file to rst format This file is almost ok, but it needs chapter/sections and a code-block. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 03:32:50 +08:00
cafe_ccic
[media] doc-rst: add documentation for cpia2 driver Convert the documentation to rst, merge the two files and add to the index.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 04:20:26 +08:00
cpia2
cx18
[media] doc-rst: start adding documentation for cx2341x 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 22:03:54 +08:00
cx2341x
[media] doc-rst: Add cx88 documentation to media book Convert the cx88 documentation to rst and add it to the v4l-devices book Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 04:28:40 +08:00
cx88
[media] doc-rst: add davinci-vpbe documentation Convert it to rst format and add it to the v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 04:49:05 +08:00
davinci-vpbe
[media] doc-rst: add documentation for fimc driver Convert the document to rst and add it to the v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 04:57:31 +08:00
fimc
media: imx.rst: add it to v4l-drivers book Avoid the following warning when building documentation: checking consistency... /devel/v4l/patchwork/Documentation/media/v4l-drivers/imx.rst:: WARNING: document isn't included in any toctree While here, avoid placing all driver authors at just one line at the html/pdf output. Acked-by: Steve Longerbeam <steve_longerbeam@mentor.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-06-25 00:15:49 +08:00
imx
media: imx7.rst: add documentation for i.MX7 media driver Add rst document to describe the i.MX7 media driver and also a working example from the Warp7 board usage with a OV2680 sensor. Signed-off-by: Rui Miguel Silva <rui.silva@linaro.org> Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2019-02-06 23:13:25 +08:00
imx7
media: doc-rst: Add Intel IPU3 documentation This patch adds the details about the IPU3 Imaging Unit driver (both CIO2 and IMGU). Signed-off-by: Rajmohan Mani <rajmohan.mani@intel.com> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2018-12-07 09:03:42 +08:00
ipu3
[media] doc-rst: Add ivtv documentation Convert ivtv documentation to rst, update the links there and add to media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 05:13:46 +08:00
ivtv
[media] media: i2c: max2175: Add MAX2175 support This patch adds driver support for the MAX2175 chip. This is Maxim Integrated's RF to Bits tuner front end chip designed for software-defined radio solutions. This driver exposes the tuner as a sub-device instance with standard and custom controls to configure the device. Signed-off-by: Ramesh Shanmugasundaram <ramesh.shanmugasundaram@bp.renesas.com> Signed-off-by: Hans Verkuil <hansverk@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-06-13 20:54:47 +08:00
max2175
[media] doc-rst: add meye documentation Convert the meye documentation to rst and add it to the media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 05:20:51 +08:00
meye
[media] doc-rst: add omap3isp documentation Convert omap3isp documentation to ReST and add it to the media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 05:31:51 +08:00
omap3isp
[media] doc-rst: add omap4_camera documentation Convert the omap4_camera documentation to ReST and add it to the media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 05:38:01 +08:00
omap4_camera
convert philips.txt to ReST and add to media docs The philips.txt file were at the wrong place: it should be, instead, at Documentation/media. Move and convert it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-04-17 08:51:08 +08:00
philips
[media] doc-rst: add documentation for pvrusb2 Convert pvrusb2 documentation to ReST file and removed the note about an html version of the documentation, as it is not shipped inside the Kernel. Add it to media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 05:45:25 +08:00
pvrusb2
[media] doc-rst: add pxa_camera documentation Convert pxa_camera to ReST format and add it to the media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 05:52:53 +08:00
pxa_camera
media: add qcom_camss.rst to v4l-drivers rst file Avoid this warning: /devel/v4l/docs/Documentation/media/v4l-drivers/qcom_camss.rst:: WARNING: document isn't included in any toctree Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-05 19:06:40 +08:00
qcom_camss
[media] doc-rst: add documentation for radiotrack Convert it to ReST and add it to the media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 06:03:53 +08:00
radiotrack
[media] v4l: Add Renesas R-Car FDP1 Driver The FDP1 driver performs advanced de-interlacing on a memory 2 memory based video stream, and supports conversion from YCbCr/YUV to RGB pixel formats Signed-off-by: Kieran Bingham <kieran+renesas@bingham.xyz> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:41:23 +08:00
rcar-fdp1
[media] doc-rst: add documentation for saa7134 Convert it to ReST and add to the media/v4l-device book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 06:26:43 +08:00
saa7134
[media] doc-rst: add sh_mobile_ceu_camera crop documentation 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 06:43:22 +08:00
sh_mobile_ceu_camera
[media] doc-rst: add documentation for si470x Convert it to ReST and add to media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 06:52:48 +08:00
si470x
[media] doc-rst: add documentation for si476x Convert it to ReST and add to media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 07:32:28 +08:00
si4713
si476x
[media] doc-rst: add soc-camera documentation Convert it to ReST format and add it at media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 07:44:13 +08:00
soc-camera
[media] doc-rst: add documentation for uvcvideo Convert it to ReST and add to media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 07:50:45 +08:00
uvcvideo
media: docs: create vimc documentation Create vimc documentation file to explain its basic features, its topology, how to configure it and to document vimc's subdevices. Signed-off-by: André Almeida <andrealmeid@collabora.com> Suggested-by: Helen Koike <helen.koike@collabora.com> [hverkuil-cisco@xs4all.nl: Fix typo: The ``v4l2-utils`` -> The ``v4l-utils`` package] Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2019-06-16 10:09:59 +08:00
vimc
[media] doc-rst: add vivid documentation Convert it to ReST and add to media/v4l-drivers book. As the sections here (and on other docs) are numbered, let's also make this book auto-numbered. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 09:07:30 +08:00
vivid
[media] doc-rst: add Zoran zr364xx documentation Convert the documentation to rst and add it to the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18 04:05:20 +08:00
zr364xx