]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
media: docs: add an uAPI chapter for driver-specific stuff
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 6 Mar 2020 07:50:46 +0000 (08:50 +0100)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 14 Apr 2020 08:36:50 +0000 (10:36 +0200)
There are some uAPI stuff that are driver-specific. Add them
to the main media uAPI body.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
14 files changed:
Documentation/media/index.rst
Documentation/userspace-api/media/drivers/cx2341x-uapi.rst [moved from Documentation/media/v4l-drivers/cx2341x-uapi.rst with 100% similarity]
Documentation/userspace-api/media/drivers/imx-uapi.rst [moved from Documentation/media/v4l-drivers/imx-uapi.rst with 100% similarity]
Documentation/userspace-api/media/drivers/index.rst [moved from Documentation/media/v4l-drivers/index.rst with 97% similarity]
Documentation/userspace-api/media/drivers/max2175.rst [moved from Documentation/media/v4l-drivers/max2175.rst with 100% similarity]
Documentation/userspace-api/media/drivers/meye-uapi.rst [moved from Documentation/media/v4l-drivers/meye-uapi.rst with 100% similarity]
Documentation/userspace-api/media/drivers/omap3isp-uapi.rst [moved from Documentation/media/v4l-drivers/omap3isp-uapi.rst with 100% similarity]
Documentation/userspace-api/media/drivers/uvcvideo.rst [moved from Documentation/media/v4l-drivers/uvcvideo.rst with 100% similarity]
Documentation/userspace-api/media/index.rst
Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
Documentation/userspace-api/media/v4l/pixfmt-reserved.rst
MAINTAINERS
drivers/media/i2c/max2175.c

index a5cd600e0b049bfffe0dd4587c1451561a4d2c4d..e93fd88881af38b19332285f7a0cc50cc144b3c1 100644 (file)
@@ -15,8 +15,6 @@ Linux Media Subsystem Documentation
    ../userspace-api/media/index
    ../driver-api/media/index
 
-   v4l-drivers/index
-
 .. only:: html and subproject
 
    Indices
similarity index 97%
rename from Documentation/media/v4l-drivers/index.rst
rename to Documentation/userspace-api/media/drivers/index.rst
index ee7faff88a33c0a2c9487df098d816834c5e019c..05a82f8c0c9935541ecac580026f6521a10929bc 100644 (file)
@@ -2,7 +2,7 @@
 
 .. include:: <isonum.txt>
 
-.. _v4l-drivers:
+.. _v4l-drivers_uapi:
 
 ################################################
 Video4Linux (V4L)  driver-specific documentation
@@ -31,10 +31,9 @@ For more details see the file COPYING in the source distribution of Linux.
        :maxdepth: 5
        :numbered:
 
-       max2175
-       uvcvideo
-
        cx2341x-uapi
        imx-uapi
+       max2175
        meye-uapi
        omap3isp-uapi
+       uvcvideo
index 614310f8239555d6b9042e1bc83c17ae6b98f917..bcfdd1a5caa025cdfc46f5852478e3eacaafc703 100644 (file)
@@ -31,3 +31,5 @@ entitled "GNU Free Documentation License".
     cec/cec-api
     gen-errors
     fdl-appendix
+
+    drivers/index
index 751c6590e77467628f29062c4e67027ac9abf4af..dd0b6646beb53d2640c2a053fe491fb1070da08b 100644 (file)
@@ -438,7 +438,7 @@ MPEG stream.
 *Historical context*: This format specification originates from a
 custom, embedded, sliced VBI data format used by the ``ivtv`` driver.
 This format has already been informally specified in the kernel sources
-in the file ``Documentation/media/v4l-drivers/cx2341x-uapi.rst`` . The
+in the file ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst`` . The
 maximum size of the payload and other aspects of this format are driven
 by the CX23415 MPEG decoder's capabilities and limitations with respect
 to extracting, decoding, and displaying sliced VBI data embedded within
index f81016c97a0d37ae6fda77d7c8430b42242f8ddb..9b48338fb7838a52555eaa199e5c24c32284f30f 100644 (file)
@@ -116,7 +116,7 @@ enum v4l2_mpeg_stream_vbi_fmt -
     * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV``
       - VBI in private packets, IVTV format (documented in the kernel
        sources in the file
-       ``Documentation/media/v4l-drivers/cx2341x-uapi.rst``)
+       ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst``)
 
 
 
index dbdcf6c9f0729c3a2cd26b645d656ef9a905d373..59b9e7238f90f38bebc5ef551c1866add6922570 100644 (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.
 
        The format is documented in the kernel sources in the file
-       ``Documentation/media/v4l-drivers/cx2341x-uapi.rst``
+       ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst``
     * .. _V4L2-PIX-FMT-CPIA1:
 
       - ``V4L2_PIX_FMT_CPIA1``
index e0a0a3fbfe212c4aea11d5aef64c36dee38a3cd9..f0e7b4d17fcc59ecedef0fa804984d165e8921fc 100644 (file)
@@ -10249,7 +10249,7 @@ L:      linux-media@vger.kernel.org
 S:     Maintained
 T:     git git://linuxtv.org/media_tree.git
 F:     Documentation/devicetree/bindings/media/i2c/max2175.txt
-F:     Documentation/media/v4l-drivers/max2175.rst
+F:     Documentation/userspace-api/media/drivers/max2175.rst
 F:     drivers/media/i2c/max2175*
 F:     include/uapi/linux/max2175.h
 
@@ -11389,7 +11389,7 @@ F:      drivers/regulator/mpq7920.h
 MOTION EYE VAIO PICTUREBOOK CAMERA DRIVER
 S:     Orphan
 W:     http://popies.net/meye/
-F:     Documentation/media/v4l-drivers/meye*
+F:     Documentation/userspace-api/media/drivers/meye*
 F:     drivers/media/pci/meye/
 F:     include/uapi/linux/meye.h
 
index 506a30e69ced45c4cf99a1f6b7d0cf1f3822db5c..03b4ed3a61b837bd7a128ef7cd0b32db806ed314 100644 (file)
@@ -1194,7 +1194,7 @@ static const struct v4l2_ctrl_ops max2175_ctrl_ops = {
 
 /*
  * I2S output enable/disable configuration. This is a private control.
- * Refer to Documentation/media/v4l-drivers/max2175.rst for more details.
+ * Refer to Documentation/userspace-api/media/drivers/max2175.rst for more details.
  */
 static const struct v4l2_ctrl_config max2175_i2s_en = {
        .ops = &max2175_ctrl_ops,
@@ -1210,7 +1210,7 @@ static const struct v4l2_ctrl_config max2175_i2s_en = {
 
 /*
  * HSLS value control LO freq adjacent location configuration.
- * Refer to Documentation/media/v4l-drivers/max2175.rst for more details.
+ * Refer to Documentation/userspace-api/media/drivers/max2175.rst for more details.
  */
 static const struct v4l2_ctrl_config max2175_hsls = {
        .ops = &max2175_ctrl_ops,
@@ -1226,7 +1226,7 @@ static const struct v4l2_ctrl_config max2175_hsls = {
 /*
  * Rx modes below are a set of preset configurations that decides the tuner's
  * sck and sample rate of transmission. They are separate for EU & NA regions.
- * Refer to Documentation/media/v4l-drivers/max2175.rst for more details.
+ * Refer to Documentation/userspace-api/media/drivers/max2175.rst for more details.
  */
 static const char * const max2175_ctrl_eu_rx_modes[] = {
        [MAX2175_EU_FM_1_2]     = "EU FM 1.2",