media: docs: move user-facing docs to the admin guide

Most of the driver-specific documentation is meant to help
users of the media subsystem.

Move them to the admin-guide.

It should be noticed, however, that several of those files
are outdated and will require further work in order to make
them useful again.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2020-03-04 13:08:03 +01:00
parent 2e9a7e0bc1
commit 32e2eae23f
72 changed files with 136 additions and 101 deletions

View File

@ -93,6 +93,7 @@ configure specific aspects of kernel behavior to your liking.
lockup-watchdogs lockup-watchdogs
LSM/index LSM/index
md md
media/index
mm/index mm/index
module-signing module-signing
mono mono

View File

@ -458,7 +458,7 @@
bttv.card= [HW,V4L] bttv (bt848 + bt878 based grabber cards) bttv.card= [HW,V4L] bttv (bt848 + bt878 based grabber cards)
bttv.radio= Most important insmod options are available as bttv.radio= Most important insmod options are available as
kernel args too. kernel args too.
bttv.pll= See Documentation/media/v4l-drivers/bttv.rst bttv.pll= See Documentation/admin-guide/media/bttv.rst
bttv.tuner= bttv.tuner=
bulk_remove=off [PPC] This parameter disables the use of the pSeries bulk_remove=off [PPC] This parameter disables the use of the pSeries
@ -2705,7 +2705,7 @@
See Documentation/admin-guide/pm/sleep-states.rst. See Documentation/admin-guide/pm/sleep-states.rst.
meye.*= [HW] Set MotionEye Camera parameters meye.*= [HW] Set MotionEye Camera parameters
See Documentation/media/v4l-drivers/meye.rst. See Documentation/admin-guide/media/meye.rst.
mfgpt_irq= [IA-32] Specify the IRQ to use for the mfgpt_irq= [IA-32] Specify the IRQ to use for the
Multi-Function General Purpose Timers on AMD Geode Multi-Function General Purpose Timers on AMD Geode

View File

@ -20,7 +20,7 @@ General information
This class of cards has a bt878a as the PCI interface, and require the bttv driver This class of cards has a bt878a as the PCI interface, and require the bttv driver
for accessing the i2c bus and the gpio pins of the bt8xx chipset. for accessing the i2c bus and the gpio pins of the bt8xx chipset.
Please see Documentation/media/dvb-drivers/cards.rst => o Cards based on the Conexant Bt8xx PCI bridge: Please see Documentation/admin-guide/media/cards.rst => o Cards based on the Conexant Bt8xx PCI bridge:
Compiling kernel please enable: Compiling kernel please enable:
@ -47,7 +47,7 @@ Loading Modules
Regular case: If the bttv driver detects a bt8xx-based DVB card, all frontend and backend modules will be loaded automatically. Regular case: If the bttv driver detects a bt8xx-based DVB card, all frontend and backend modules will be loaded automatically.
Exceptions are: Exceptions are:
- Old TwinHan DST cards or clones with or without CA slot and not containing an Eeprom. - Old TwinHan DST cards or clones with or without CA slot and not containing an Eeprom.
People running udev please see Documentation/media/dvb-drivers/udev.rst. People running udev please see Documentation/admin-guide/media/udev.rst.
In the following cases overriding the PCI type detection for dvb-bt8xx might be necessary: In the following cases overriding the PCI type detection for dvb-bt8xx might be necessary:
@ -74,7 +74,7 @@ Useful parameters for verbosity level and debugging the dst module:
The autodetected values are determined by the cards' "response string". The autodetected values are determined by the cards' "response string".
In your logs see f. ex.: dst_get_device_id: Recognize [DSTMCI]. In your logs see f. ex.: dst_get_device_id: Recognize [DSTMCI].
For bug reports please send in a complete log with verbose=4 activated. For bug reports please send in a complete log with verbose=4 activated.
Please also see Documentation/media/dvb-drivers/ci.rst. Please also see Documentation/admin-guide/media/ci.rst.
Running multiple cards Running multiple cards
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
@ -102,7 +102,7 @@ Examples of card ID's:
$ modprobe bttv card=113 card=135 $ modprobe bttv card=113 card=135
For a full list of card ID's please see Documentation/media/v4l-drivers/bttv-cardlist.rst. For a full list of card ID's please see Documentation/admin-guide/media/bttv-cardlist.rst.
In case of further problems please subscribe and send questions to the mailing list: linux-dvb@linuxtv.org. In case of further problems please subscribe and send questions to the mailing list: linux-dvb@linuxtv.org.
Probing the cards with broken PCI subsystem ID Probing the cards with broken PCI subsystem ID

View File

@ -0,0 +1,104 @@
.. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
**Copyright** |copy| 1999-2020 : LinuxTV Developers
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.
.. _uapi-v4l-drivers:
################################################
Video4Linux (V4L) driver-specific documentation
################################################
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree::
:maxdepth: 5
:numbered:
cardlist
v4l-with-ir
bttv
cafe_ccic
cpia2
cx88
davinci-vpbe
fimc
imx
imx7
ipu3
ivtv
meye
omap3isp
omap4_camera
philips
qcom_camss
rcar-fdp1
saa7134
si470x
si4713
si476x
vimc
vivid
##############################################
Linux Digital TV driver-specific documentation
##############################################
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree::
:maxdepth: 5
:numbered:
intro
cards
ci
faq
avermedia
bt8xx
lmedm04
opera-firmware
technisat
ttusb-dec
udev
zr364xx
#################################
CEC driver-specific documentation
#################################
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree::
:maxdepth: 5
:numbered:
pulse8-cec

View File

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 76 KiB

View File

@ -1,34 +0,0 @@
.. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
.. _cec-drivers:
#################################
CEC driver-specific documentation
#################################
**Copyright** |copy| 2017 : LinuxTV Developers
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.
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree::
:maxdepth: 5
:numbered:
pulse8-cec

View File

@ -29,17 +29,6 @@ For more details see the file COPYING in the source distribution of Linux.
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:
intro
avermedia
bt8xx
cards
ci
dvb-usb dvb-usb
faq
lmedm04
opera-firmware
technisat
ttusb-dec
udev
frontends frontends
contributors contributors

View File

@ -14,9 +14,9 @@ Linux Media Subsystem Documentation
../userspace-api/media/index ../userspace-api/media/index
../driver-api/media/index ../driver-api/media/index
dvb-drivers/index
v4l-drivers/index v4l-drivers/index
cec-drivers/index dvb-drivers/index
.. only:: html and subproject .. only:: html and subproject

View File

@ -31,38 +31,13 @@ For more details see the file COPYING in the source distribution of Linux.
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:
v4l-with-ir
tuners tuners
cardlist
bttv
cafe_ccic
cpia2
cx88
davinci-vpbe
fimc
imx
imx7
ipu3
ivtv
max2175 max2175
meye
omap3isp
omap4_camera
philips
pvrusb2 pvrusb2
pxa_camera pxa_camera
qcom_camss
radiotrack radiotrack
rcar-fdp1
saa7134
sh_mobile_ceu_camera sh_mobile_ceu_camera
si470x
si4713
si476x
uvcvideo uvcvideo
vimc
vivid
zr364xx
bttv-devel bttv-devel
cpia2_devel cpia2_devel

View File

@ -1,4 +1,4 @@
Chinese translated version of Documentation/media/v4l-drivers/omap3isp.rst Chinese translated version of Documentation/admin-guide/media/omap3isp.rst
If you have any comment or update to the content, please contact the If you have any comment or update to the content, please contact the
original document maintainer directly. However, if you have a problem original document maintainer directly. However, if you have a problem
@ -11,7 +11,7 @@ Maintainer: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
David Cohen <dacohen@gmail.com> David Cohen <dacohen@gmail.com>
Chinese maintainer: Fu Wei <tekkamanninja@gmail.com> Chinese maintainer: Fu Wei <tekkamanninja@gmail.com>
--------------------------------------------------------------------- ---------------------------------------------------------------------
Documentation/media/v4l-drivers/omap3isp.rst 的中文翻译 Documentation/admin-guide/media/omap3isp.rst 的中文翻译
如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文
交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻

View File

@ -438,7 +438,7 @@ MPEG stream.
*Historical context*: This format specification originates from a *Historical context*: This format specification originates from a
custom, embedded, sliced VBI data format used by the ``ivtv`` driver. custom, embedded, sliced VBI data format used by the ``ivtv`` driver.
This format has already been informally specified in the kernel sources This format has already been informally specified in the kernel sources
in the file ``Documentation/media/v4l-drivers/cx2341x.rst`` . The in the file ``Documentation/media/v4l-drivers/cx2341x-uapi.rst`` . The
maximum size of the payload and other aspects of this format are driven maximum size of the payload and other aspects of this format are driven
by the CX23415 MPEG decoder's capabilities and limitations with respect by the CX23415 MPEG decoder's capabilities and limitations with respect
to extracting, decoding, and displaying sliced VBI data embedded within to extracting, decoding, and displaying sliced VBI data embedded within

View File

@ -116,7 +116,7 @@ enum v4l2_mpeg_stream_vbi_fmt -
* - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV`` * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV``
- VBI in private packets, IVTV format (documented in the kernel - VBI in private packets, IVTV format (documented in the kernel
sources in the file sources in the file
``Documentation/media/v4l-drivers/cx2341x.rst``) ``Documentation/media/v4l-drivers/cx2341x-uapi.rst``)

View File

@ -53,7 +53,7 @@ Image Process Control IDs
``V4L2_CID_DEINTERLACING_MODE (menu)`` ``V4L2_CID_DEINTERLACING_MODE (menu)``
The video deinterlacing mode (such as Bob, Weave, ...). The menu items are The video deinterlacing mode (such as Bob, Weave, ...). The menu items are
driver specific and are documented in :ref:`v4l-drivers`. driver specific and are documented in :ref:`uapi-v4l-drivers`.
``V4L2_CID_DIGITAL_GAIN (integer)`` ``V4L2_CID_DIGITAL_GAIN (integer)``
Digital gain is the value by which all colour components Digital gain is the value by which all colour components

View File

@ -58,7 +58,7 @@ please make a proposal on the linux-media mailing list.
- YUV 4:2:0 format used by the IVTV driver. - YUV 4:2:0 format used by the IVTV driver.
The format is documented in the kernel sources in the file The format is documented in the kernel sources in the file
``Documentation/media/v4l-drivers/cx2341x.rst`` ``Documentation/media/v4l-drivers/cx2341x-uapi.rst``
* .. _V4L2-PIX-FMT-CPIA1: * .. _V4L2-PIX-FMT-CPIA1:
- ``V4L2_PIX_FMT_CPIA1`` - ``V4L2_PIX_FMT_CPIA1``

View File

@ -3758,7 +3758,7 @@ M: Jonathan Corbet <corbet@lwn.net>
L: linux-media@vger.kernel.org L: linux-media@vger.kernel.org
S: Maintained S: Maintained
T: git git://linuxtv.org/media_tree.git T: git git://linuxtv.org/media_tree.git
F: Documentation/media/v4l-drivers/cafe_ccic* F: Documentation/admin-guide/media/cafe_ccic*
F: drivers/media/platform/marvell-ccic/ F: drivers/media/platform/marvell-ccic/
CAIF NETWORK LAYER CAIF NETWORK LAYER
@ -6234,7 +6234,7 @@ L: linux-media@vger.kernel.org
S: Maintained S: Maintained
W: https://linuxtv.org W: https://linuxtv.org
T: git git://linuxtv.org/media_tree.git T: git git://linuxtv.org/media_tree.git
F: Documentation/media/v4l-drivers/em28xx* F: Documentation/admin-guide/media/em28xx*
F: drivers/media/usb/em28xx/ F: drivers/media/usb/em28xx/
EMBEDDED LINUX EMBEDDED LINUX
@ -8651,8 +8651,8 @@ M: Sakari Ailus <sakari.ailus@linux.intel.com>
L: linux-media@vger.kernel.org L: linux-media@vger.kernel.org
S: Maintained S: Maintained
F: Documentation/userspace-api/media/v4l/pixfmt-meta-intel-ipu3.rst F: Documentation/userspace-api/media/v4l/pixfmt-meta-intel-ipu3.rst
F: Documentation/media/v4l-drivers/ipu3.rst F: Documentation/admin-guide/media/ipu3.rst
F: Documentation/media/v4l-drivers/ipu3_rcb.svg F: Documentation/admin-guide/media/ipu3_rcb.svg
F: drivers/staging/media/ipu3/ F: drivers/staging/media/ipu3/
INTEL IXP4XX QMGR, NPE, ETHERNET and HSS SUPPORT INTEL IXP4XX QMGR, NPE, ETHERNET and HSS SUPPORT
@ -9076,7 +9076,7 @@ L: linux-media@vger.kernel.org
S: Maintained S: Maintained
W: https://linuxtv.org W: https://linuxtv.org
T: git git://linuxtv.org/media_tree.git T: git git://linuxtv.org/media_tree.git
F: Documentation/media/v4l-drivers/ivtv* F: Documentation/admin-guide/media/ivtv*
F: drivers/media/pci/ivtv/ F: drivers/media/pci/ivtv/
F: include/uapi/linux/ivtv* F: include/uapi/linux/ivtv*
@ -10450,7 +10450,7 @@ L: linux-media@vger.kernel.org
S: Maintained S: Maintained
T: git git://linuxtv.org/media_tree.git T: git git://linuxtv.org/media_tree.git
F: Documentation/devicetree/bindings/media/imx.txt F: Documentation/devicetree/bindings/media/imx.txt
F: Documentation/media/v4l-drivers/imx.rst F: Documentation/admin-guide/media/imx.rst
F: drivers/staging/media/imx/ F: drivers/staging/media/imx/
F: include/linux/imx-media.h F: include/linux/imx-media.h
F: include/media/imx.h F: include/media/imx.h
@ -10462,7 +10462,7 @@ S: Maintained
T: git git://linuxtv.org/media_tree.git T: git git://linuxtv.org/media_tree.git
F: Documentation/devicetree/bindings/media/imx7-csi.txt F: Documentation/devicetree/bindings/media/imx7-csi.txt
F: Documentation/devicetree/bindings/media/imx7-mipi-csi2.txt F: Documentation/devicetree/bindings/media/imx7-mipi-csi2.txt
F: Documentation/media/v4l-drivers/imx7.rst F: Documentation/admin-guide/media/imx7.rst
F: drivers/staging/media/imx/imx7-media-csi.c F: drivers/staging/media/imx/imx7-media-csi.c
F: drivers/staging/media/imx/imx7-mipi-csis.c F: drivers/staging/media/imx/imx7-mipi-csis.c
@ -13701,7 +13701,7 @@ M: Hans Verkuil <hverkuil@xs4all.nl>
L: linux-media@vger.kernel.org L: linux-media@vger.kernel.org
S: Maintained S: Maintained
T: git git://linuxtv.org/media_tree.git T: git git://linuxtv.org/media_tree.git
F: Documentation/media/cec-drivers/pulse8-cec.rst F: Documentation/admin-guide/media/pulse8-cec.rst
F: drivers/media/usb/pulse8-cec/* F: drivers/media/usb/pulse8-cec/*
PVRUSB2 VIDEO4LINUX DRIVER PVRUSB2 VIDEO4LINUX DRIVER
@ -13958,7 +13958,7 @@ M: Todor Tomov <todor.too@gmail.com>
L: linux-media@vger.kernel.org L: linux-media@vger.kernel.org
S: Maintained S: Maintained
F: Documentation/devicetree/bindings/media/qcom,camss.txt F: Documentation/devicetree/bindings/media/qcom,camss.txt
F: Documentation/media/v4l-drivers/qcom_camss.rst F: Documentation/admin-guide/media/qcom_camss.rst
F: drivers/media/platform/qcom/camss/ F: drivers/media/platform/qcom/camss/
QUALCOMM CORE POWER REDUCTION (CPR) AVS DRIVER QUALCOMM CORE POWER REDUCTION (CPR) AVS DRIVER
@ -16972,7 +16972,7 @@ L: linux-media@vger.kernel.org
S: Odd fixes S: Odd fixes
W: https://linuxtv.org W: https://linuxtv.org
T: git git://linuxtv.org/media_tree.git T: git git://linuxtv.org/media_tree.git
F: Documentation/media/v4l-drivers/tm6000* F: Documentation/admin-guide/media/tm6000*
F: drivers/media/usb/tm6000/ F: drivers/media/usb/tm6000/
TMIO/SDHI MMC DRIVER TMIO/SDHI MMC DRIVER
@ -17653,7 +17653,7 @@ L: linux-media@vger.kernel.org
S: Maintained S: Maintained
W: http://royale.zerezo.com/zr364xx/ W: http://royale.zerezo.com/zr364xx/
T: git git://linuxtv.org/media_tree.git T: git git://linuxtv.org/media_tree.git
F: Documentation/media/v4l-drivers/zr364xx* F: Documentation/admin-guide/media/zr364xx*
F: drivers/media/usb/zr364xx/ F: drivers/media/usb/zr364xx/
USER-MODE LINUX (UML) USER-MODE LINUX (UML)

View File

@ -16,7 +16,7 @@ config VIDEO_BT848
help help
Support for BT848 based frame grabber/overlay boards. This includes Support for BT848 based frame grabber/overlay boards. This includes
the Miro, Hauppauge and STB boards. Please read the material in the Miro, Hauppauge and STB boards. Please read the material in
<file:Documentation/media/v4l-drivers/bttv.rst> for more information. <file:Documentation/admin-guide/media/bttv.rst> for more information.
To compile this driver as a module, choose M here: the To compile this driver as a module, choose M here: the
module will be called bttv. module will be called bttv.

View File

@ -7,7 +7,7 @@ config VIDEO_MEYE
help help
This is the video4linux driver for the Motion Eye camera found This is the video4linux driver for the Motion Eye camera found
in the Vaio Picturebook laptops. Please read the material in in the Vaio Picturebook laptops. Please read the material in
<file:Documentation/media/v4l-drivers/meye.rst> for more information. <file:Documentation/admin-guide/media/meye.rst> for more information.
If you say Y or M here, you need to say Y or M to "Sony Laptop If you say Y or M here, you need to say Y or M to "Sony Laptop
Extras" in the misc device section. Extras" in the misc device section.

View File

@ -30,7 +30,7 @@ config USB_SI470X
Please have a look at the documentation, especially on how Please have a look at the documentation, especially on how
to redirect the audio stream from the radio to your sound device: to redirect the audio stream from the radio to your sound device:
Documentation/media/v4l-drivers/si470x.rst Documentation/admin-guide/media/si470x.rst
Say Y here if you want to connect this type of radio to your Say Y here if you want to connect this type of radio to your
computer's USB port. computer's USB port.

View File

@ -22,7 +22,7 @@
* *
* LME2510C + M88RS2000 * LME2510C + M88RS2000
* *
* For firmware see Documentation/media/dvb-drivers/lmedm04.rst * For firmware see Documentation/admin-guide/media/lmedm04.rst
* *
* I2C addresses: * I2C addresses:
* 0xd0 - STV0288 - Demodulator * 0xd0 - STV0288 - Demodulator

View File

@ -9,7 +9,7 @@ menuconfig USB_GSPCA
Say Y here if you want to enable selecting webcams based Say Y here if you want to enable selecting webcams based
on the GSPCA framework. on the GSPCA framework.
See <file:Documentation/media/v4l-drivers/gspca-cardlist.rst> for more info. See <file:Documentation/admin-guide/media/gspca-cardlist.rst> for more info.
This driver uses the Video For Linux API. You must say Y or M to This driver uses the Video For Linux API. You must say Y or M to
"Video For Linux" to use this driver. "Video For Linux" to use this driver.

View File

@ -7,7 +7,7 @@ config USB_ZR364XX
help help
Say Y here if you want to connect this type of camera to your Say Y here if you want to connect this type of camera to your
computer's USB port. computer's USB port.
See <file:Documentation/media/v4l-drivers/zr364xx.rst> for more info See <file:Documentation/admin-guide/media/zr364xx.rst> for more info
and list of supported cameras. and list of supported cameras.
To compile this driver as a module, choose M here: the To compile this driver as a module, choose M here: the