From patchwork Tue Mar 10 13:43:06 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11429373 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 5F2A092A for ; Tue, 10 Mar 2020 13:43:27 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 371D624649 for ; Tue, 10 Mar 2020 13:43:27 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="HMoVbRrk"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="1fsorBq9" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 371D624649 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=GYHcYPCTalxgrPT8dLIwb4ZpJn3Xw0QwFTVdPI9G8S4=; b=HMoVbRrkMGYTwN OOXaC+iuB2ksv/H1o+NzhP8F1UxIdF6vHwuyWTquAfqLyr8fqd+fxDcKdXY2mFAzFMuyvvJU/Y9u3 SS+gKHDGMqgIHJ5dMKaGB6qHmVv0Dij9Oje8rCcf/iEJC7gpV49IfR/SMHZhb9tEKrHlqBVKwu/lI dZ800IJERWhw9bxlAVm9aJHYgCQ/MH5SFwJwQZOS/PtsZWZ3we77paL7pLUCPBHjccdp7tVTdGs6a HaClk9mW0/tJ5cm7CrFB1TKJdUVNM9CCCsbR+cG3RPD4jNzoGqHgeJdWu2RDw8xg45646tfgvPz/p rW8gy6K50c1/vAjvbXpw==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jBfAK-0001SK-9j; Tue, 10 Mar 2020 13:43:24 +0000 Received: from mail.kernel.org ([198.145.29.99]) by bombadil.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jBfAE-0001QQ-F7 for linux-arm-kernel@lists.infradead.org; Tue, 10 Mar 2020 13:43:21 +0000 Received: from mail.kernel.org (ip5f5ad4e9.dynamic.kabel-deutschland.de [95.90.212.233]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 68419246AA; Tue, 10 Mar 2020 13:43:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1583847797; bh=E8QkjHVkzOcpMzAbxGJQTzkpHIqmt5HiFJokGy90umg=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=1fsorBq9m4u8TSGUhgE7YDg4bocLSDsZCkOBBLiKF7xc0o4IUXDlUrth4mwUpCTB7 nwDVR3Og3/3jap8Yq4/BNLay6ifrDiRXwDqSDHFVH5RR7pMJl14Xs8sjkriSZqjYu2 zIIQSbKzlahHqKg2MDkaNZiXku9SpxfJCKf3GJlY= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jBfAB-0005wK-EA; Tue, 10 Mar 2020 14:43:15 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v2 15/22] media: docs: split uAPI info from imx.rst Date: Tue, 10 Mar 2020 14:43:06 +0100 Message-Id: X-Mailer: git-send-email 2.24.1 In-Reply-To: References: MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200310_064318_554959_D06B9417 X-CRM114-Status: GOOD ( 21.19 ) X-Spam-Score: -5.2 (-----) X-Spam-Report: SpamAssassin version 3.4.3 on bombadil.infradead.org summary: Content analysis details: (-5.2 points) pts rule name description ---- ---------------------- -------------------------------------------------- -5.0 RCVD_IN_DNSWL_HI RBL: Sender listed at https://www.dnswl.org/, high trust [198.145.29.99 listed in list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.0 DKIMWL_WL_HIGH DKIMwl.org - Whitelisted High sender X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Jonathan Corbet , Mauro Carvalho Chehab , Fabio Estevam , Sascha Hauer , linux-kernel@vger.kernel.org, NXP Linux Team , Pengutronix Kernel Team , Shawn Guo , linux-arm-kernel@lists.infradead.org, linux-media@vger.kernel.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org This file contains both driver develompent documentation and userspace API. Split on two, as they're usually read by different audiences. Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/v4l-drivers/imx-uapi.rst | 125 +++++++++++++++++++ Documentation/media/v4l-drivers/imx.rst | 88 +------------ Documentation/media/v4l-drivers/index.rst | 1 + 3 files changed, 128 insertions(+), 86 deletions(-) create mode 100644 Documentation/media/v4l-drivers/imx-uapi.rst diff --git a/Documentation/media/v4l-drivers/imx-uapi.rst b/Documentation/media/v4l-drivers/imx-uapi.rst new file mode 100644 index 000000000000..8d47712dea9f --- /dev/null +++ b/Documentation/media/v4l-drivers/imx-uapi.rst @@ -0,0 +1,125 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========================= +i.MX Video Capture Driver +========================= + +Events +====== + +.. _imx_api_ipuX_csiY: + +ipuX_csiY +--------- + +This subdev can generate the following event when enabling the second +IDMAC source pad: + +- V4L2_EVENT_IMX_FRAME_INTERVAL_ERROR + +The user application can subscribe to this event from the ipuX_csiY +subdev node. This event is generated by the Frame Interval Monitor +(see below for more on the FIM). + +Controls +======== + +.. _imx_api_FIM: + +Frame Interval Monitor in ipuX_csiY +----------------------------------- + +The adv718x decoders can occasionally send corrupt fields during +NTSC/PAL signal re-sync (too little or too many video lines). When +this happens, the IPU triggers a mechanism to re-establish vertical +sync by adding 1 dummy line every frame, which causes a rolling effect +from image to image, and can last a long time before a stable image is +recovered. Or sometimes the mechanism doesn't work at all, causing a +permanent split image (one frame contains lines from two consecutive +captured images). + +From experiment it was found that during image rolling, the frame +intervals (elapsed time between two EOF's) drop below the nominal +value for the current standard, by about one frame time (60 usec), +and remain at that value until rolling stops. + +While the reason for this observation isn't known (the IPU dummy +line mechanism should show an increase in the intervals by 1 line +time every frame, not a fixed value), we can use it to detect the +corrupt fields using a frame interval monitor. If the FIM detects a +bad frame interval, the ipuX_csiY subdev will send the event +V4L2_EVENT_IMX_FRAME_INTERVAL_ERROR. Userland can register with +the FIM event notification on the ipuX_csiY subdev device node. +Userland can issue a streaming restart when this event is received +to correct the rolling/split image. + +The ipuX_csiY subdev includes custom controls to tweak some dials for +FIM. If one of these controls is changed during streaming, the FIM will +be reset and will continue at the new settings. + +- V4L2_CID_IMX_FIM_ENABLE + +Enable/disable the FIM. + +- V4L2_CID_IMX_FIM_NUM + +How many frame interval measurements to average before comparing against +the nominal frame interval reported by the sensor. This can reduce noise +caused by interrupt latency. + +- V4L2_CID_IMX_FIM_TOLERANCE_MIN + +If the averaged intervals fall outside nominal by this amount, in +microseconds, the V4L2_EVENT_IMX_FRAME_INTERVAL_ERROR event is sent. + +- V4L2_CID_IMX_FIM_TOLERANCE_MAX + +If any intervals are higher than this value, those samples are +discarded and do not enter into the average. This can be used to +discard really high interval errors that might be due to interrupt +latency from high system load. + +- V4L2_CID_IMX_FIM_NUM_SKIP + +How many frames to skip after a FIM reset or stream restart before +FIM begins to average intervals. + +- V4L2_CID_IMX_FIM_ICAP_CHANNEL / V4L2_CID_IMX_FIM_ICAP_EDGE + +These controls will configure an input capture channel as the method +for measuring frame intervals. This is superior to the default method +of measuring frame intervals via EOF interrupt, since it is not subject +to uncertainty errors introduced by interrupt latency. + +Input capture requires hardware support. A VSYNC signal must be routed +to one of the i.MX6 input capture channel pads. + +V4L2_CID_IMX_FIM_ICAP_CHANNEL configures which i.MX6 input capture +channel to use. This must be 0 or 1. + +V4L2_CID_IMX_FIM_ICAP_EDGE configures which signal edge will trigger +input capture events. By default the input capture method is disabled +with a value of IRQ_TYPE_NONE. Set this control to IRQ_TYPE_EDGE_RISING, +IRQ_TYPE_EDGE_FALLING, or IRQ_TYPE_EDGE_BOTH to enable input capture, +triggered on the given signal edge(s). + +When input capture is disabled, frame intervals will be measured via +EOF interrupt. + + +File list +--------- + +drivers/staging/media/imx/ +include/media/imx.h +include/linux/imx-media.h + + +Authors +------- + +- Steve Longerbeam +- Philipp Zabel +- Russell King + +Copyright (C) 2012-2017 Mentor Graphics Inc. diff --git a/Documentation/media/v4l-drivers/imx.rst b/Documentation/media/v4l-drivers/imx.rst index 1246573c1019..3182951c7651 100644 --- a/Documentation/media/v4l-drivers/imx.rst +++ b/Documentation/media/v4l-drivers/imx.rst @@ -191,14 +191,7 @@ or unqualified interlaced). The capture interface will enforce the same field order as the source pad field order (interlaced-bt if source pad is seq-bt, interlaced-tb if source pad is seq-tb). -This subdev can generate the following event when enabling the second -IDMAC source pad: - -- V4L2_EVENT_IMX_FRAME_INTERVAL_ERROR - -The user application can subscribe to this event from the ipuX_csiY -subdev node. This event is generated by the Frame Interval Monitor -(see below for more on the FIM). +For events produced by ipuX_csiY, see ref:`imx_api_ipuX_csiY`. Cropping in ipuX_csiY --------------------- @@ -247,84 +240,7 @@ rate by half at the IDMAC output source pad: Frame Interval Monitor in ipuX_csiY ----------------------------------- -The adv718x decoders can occasionally send corrupt fields during -NTSC/PAL signal re-sync (too little or too many video lines). When -this happens, the IPU triggers a mechanism to re-establish vertical -sync by adding 1 dummy line every frame, which causes a rolling effect -from image to image, and can last a long time before a stable image is -recovered. Or sometimes the mechanism doesn't work at all, causing a -permanent split image (one frame contains lines from two consecutive -captured images). - -From experiment it was found that during image rolling, the frame -intervals (elapsed time between two EOF's) drop below the nominal -value for the current standard, by about one frame time (60 usec), -and remain at that value until rolling stops. - -While the reason for this observation isn't known (the IPU dummy -line mechanism should show an increase in the intervals by 1 line -time every frame, not a fixed value), we can use it to detect the -corrupt fields using a frame interval monitor. If the FIM detects a -bad frame interval, the ipuX_csiY subdev will send the event -V4L2_EVENT_IMX_FRAME_INTERVAL_ERROR. Userland can register with -the FIM event notification on the ipuX_csiY subdev device node. -Userland can issue a streaming restart when this event is received -to correct the rolling/split image. - -The ipuX_csiY subdev includes custom controls to tweak some dials for -FIM. If one of these controls is changed during streaming, the FIM will -be reset and will continue at the new settings. - -- V4L2_CID_IMX_FIM_ENABLE - -Enable/disable the FIM. - -- V4L2_CID_IMX_FIM_NUM - -How many frame interval measurements to average before comparing against -the nominal frame interval reported by the sensor. This can reduce noise -caused by interrupt latency. - -- V4L2_CID_IMX_FIM_TOLERANCE_MIN - -If the averaged intervals fall outside nominal by this amount, in -microseconds, the V4L2_EVENT_IMX_FRAME_INTERVAL_ERROR event is sent. - -- V4L2_CID_IMX_FIM_TOLERANCE_MAX - -If any intervals are higher than this value, those samples are -discarded and do not enter into the average. This can be used to -discard really high interval errors that might be due to interrupt -latency from high system load. - -- V4L2_CID_IMX_FIM_NUM_SKIP - -How many frames to skip after a FIM reset or stream restart before -FIM begins to average intervals. - -- V4L2_CID_IMX_FIM_ICAP_CHANNEL -- V4L2_CID_IMX_FIM_ICAP_EDGE - -These controls will configure an input capture channel as the method -for measuring frame intervals. This is superior to the default method -of measuring frame intervals via EOF interrupt, since it is not subject -to uncertainty errors introduced by interrupt latency. - -Input capture requires hardware support. A VSYNC signal must be routed -to one of the i.MX6 input capture channel pads. - -V4L2_CID_IMX_FIM_ICAP_CHANNEL configures which i.MX6 input capture -channel to use. This must be 0 or 1. - -V4L2_CID_IMX_FIM_ICAP_EDGE configures which signal edge will trigger -input capture events. By default the input capture method is disabled -with a value of IRQ_TYPE_NONE. Set this control to IRQ_TYPE_EDGE_RISING, -IRQ_TYPE_EDGE_FALLING, or IRQ_TYPE_EDGE_BOTH to enable input capture, -triggered on the given signal edge(s). - -When input capture is disabled, frame intervals will be measured via -EOF interrupt. - +See ref:`imx_api_FIM`. ipuX_vdic --------- diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst index 364c65ea86fb..67665a8abe02 100644 --- a/Documentation/media/v4l-drivers/index.rst +++ b/Documentation/media/v4l-drivers/index.rst @@ -75,5 +75,6 @@ For more details see the file COPYING in the source distribution of Linux. vimc-devel cx2341x-uapi + imx-uapi meye-uapi omap3isp-uapi From patchwork Tue Mar 10 13:43:10 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11429413 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 7FE96139A for ; Tue, 10 Mar 2020 13:44:18 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 193362468D for ; Tue, 10 Mar 2020 13:44:18 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="dOVZW+cc"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="q4fyPIev" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 193362468D Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=ofMY3LupcMHh1Y3kldri/YPuMVb0YBYcx1I5kqFEnhc=; b=dOVZW+ccplOAYh vtEskLyhP2DN8YocITB7kXPVT2SZ+3V7GPpDyc3MT92zY5YAbEsRT46aUis0gdK4A6noatmt4RF3m 8+D+1ZTru+Tp1njjaJPnj/ee2KxXHjCZTBcraXJ5IcsLxG2RfgfUyPzYO+wcNUsRzX9877NxXJO3o culAmAQIn4TuHgIHxSkPOFf7tVOpebwQwXK8r2pwOziMBdZxqCGFNnOyad+lrR7wYFODaMnfqRmko 8zSzMG3jwnLtj4yyyTWquRIoNrju36HcDe8UAqD/Loj1kmpFe2bf1oDtvo9NtOteMRymx9krC3zhe 8oZYvkqywgj+hUieuKVQ==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jBfB5-0002EL-Hp; Tue, 10 Mar 2020 13:44:12 +0000 Received: from mail.kernel.org ([198.145.29.99]) by bombadil.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jBfAE-0001Qn-Ph for linux-arm-kernel@lists.infradead.org; Tue, 10 Mar 2020 13:43:25 +0000 Received: from mail.kernel.org (ip5f5ad4e9.dynamic.kabel-deutschland.de [95.90.212.233]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id E50CF24649; Tue, 10 Mar 2020 13:43:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1583847798; bh=V7cceSSoCF2KsdsgBD+w34oyy1JwtT7BfYLJBKM7Dao=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=q4fyPIevNS45LO+fjGDbAsojAX3+uKt8whJXa/fu1hZW0hqC4h4aAXPqapstoBQsr ALorAer46HFnrwn3ui77m4ZEP9nfVMyjeLWQJLjLls/yWPLtsA0ML4vmyXGLmy8sCK QCrVrNc8Rmk+XzHLCt8Zb1NR4TuNzB13jEc3sfdA= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jBfAB-0005wh-Lp; Tue, 10 Mar 2020 14:43:15 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v2 19/22] media: docs: move user-facing docs to the admin guide Date: Tue, 10 Mar 2020 14:43:10 +0100 Message-Id: <05c08367b2c6a5b3f8f29499093d34b1f0d864fe.1583847557.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.24.1 In-Reply-To: References: MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200310_064318_910163_42B0CC81 X-CRM114-Status: GOOD ( 15.18 ) X-Spam-Score: -5.2 (-----) X-Spam-Report: SpamAssassin version 3.4.3 on bombadil.infradead.org summary: Content analysis details: (-5.2 points) pts rule name description ---- ---------------------- -------------------------------------------------- -5.0 RCVD_IN_DNSWL_HI RBL: Sender listed at https://www.dnswl.org/, high trust [198.145.29.99 listed in list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.0 DKIMWL_WL_HIGH DKIMwl.org - Whitelisted High sender X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Todor Tomov , Hans Verkuil , Harry Wei , Alex Shi , Fabio Estevam , Jonathan Corbet , Mauro Carvalho Chehab , NXP Linux Team , Steve Longerbeam , Philipp Zabel , linux-media@vger.kernel.org, Sakari Ailus , Malcolm Priestley , Sascha Hauer , Rui Miguel Silva , linux-arm-kernel@lists.infradead.org, Antoine Jacquet , Andy Walls , linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, Pengutronix Kernel Team , Shawn Guo Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org 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 --- Documentation/admin-guide/index.rst | 1 + .../admin-guide/kernel-parameters.txt | 4 +- .../media}/au0828-cardlist.rst | 0 .../media}/avermedia.rst | 0 .../media}/bt8xx.rst | 8 +- .../media}/bttv-cardlist.rst | 0 .../media}/bttv.rst | 0 .../media}/cafe_ccic.rst | 0 .../media}/cardlist.rst | 0 .../media}/cards.rst | 0 .../dvb-drivers => admin-guide/media}/ci.rst | 0 .../media}/cpia2.rst | 0 .../media}/cx23885-cardlist.rst | 0 .../media}/cx88-cardlist.rst | 0 .../media}/cx88.rst | 0 .../media}/davinci-vpbe.rst | 0 .../media}/em28xx-cardlist.rst | 0 .../dvb-drivers => admin-guide/media}/faq.rst | 0 .../media}/fimc.rst | 0 .../media}/gspca-cardlist.rst | 0 .../v4l-drivers => admin-guide/media}/imx.rst | 0 .../media}/imx7.rst | 0 Documentation/admin-guide/media/index.rst | 104 ++++++++++++++++++ .../media}/intro.rst | 0 .../media}/ipu3.rst | 0 .../media}/ipu3_rcb.svg | 0 .../media}/ivtv-cardlist.rst | 0 .../media}/ivtv.rst | 0 .../media}/lmedm04.rst | 0 .../media}/meye.rst | 0 .../media}/omap3isp.rst | 0 .../media}/omap4_camera.rst | 0 .../media}/opera-firmware.rst | 0 .../media}/philips.rst | 0 .../media}/pulse8-cec.rst | 0 .../media}/qcom_camss.rst | 0 .../media}/qcom_camss_8x96_graph.dot | 0 .../media}/qcom_camss_graph.dot | 0 .../media}/rcar-fdp1.rst | 0 .../media}/saa7134-cardlist.rst | 0 .../media}/saa7134.rst | 0 .../media}/saa7164-cardlist.rst | 0 .../media}/si470x.rst | 0 .../media}/si4713.rst | 0 .../media}/si476x.rst | 0 .../media}/technisat.rst | 0 .../media}/tm6000-cardlist.rst | 0 .../media}/ttusb-dec.rst | 0 .../media}/tuner-cardlist.rst | 0 .../media}/udev.rst | 0 .../media}/usbvision-cardlist.rst | 0 .../media}/v4l-with-ir.rst | 0 .../media}/vimc.dot | 0 .../media}/vimc.rst | 0 .../media}/vivid.rst | 0 .../media}/zr364xx.rst | 0 Documentation/media/cec-drivers/index.rst | 34 ------ Documentation/media/dvb-drivers/index.rst | 11 -- Documentation/media/index.rst | 4 +- Documentation/media/v4l-drivers/index.rst | 25 ----- .../zh_CN/video4linux/omap3isp.txt | 4 +- .../media/v4l/dev-sliced-vbi.rst | 2 +- .../media/v4l/ext-ctrls-codec.rst | 2 +- .../media/v4l/ext-ctrls-image-process.rst | 2 +- .../media/v4l/pixfmt-reserved.rst | 2 +- MAINTAINERS | 22 ++-- drivers/media/pci/bt8xx/Kconfig | 2 +- drivers/media/pci/meye/Kconfig | 2 +- drivers/media/radio/si470x/Kconfig | 2 +- drivers/media/usb/dvb-usb-v2/lmedm04.c | 2 +- drivers/media/usb/gspca/Kconfig | 2 +- drivers/media/usb/zr364xx/Kconfig | 2 +- 72 files changed, 136 insertions(+), 101 deletions(-) rename Documentation/{media/v4l-drivers => admin-guide/media}/au0828-cardlist.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/avermedia.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/bt8xx.rst (93%) rename Documentation/{media/v4l-drivers => admin-guide/media}/bttv-cardlist.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/bttv.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/cafe_ccic.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/cardlist.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/cards.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/ci.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/cpia2.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/cx23885-cardlist.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/cx88-cardlist.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/cx88.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/davinci-vpbe.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/em28xx-cardlist.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/faq.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/fimc.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/gspca-cardlist.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/imx.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/imx7.rst (100%) create mode 100644 Documentation/admin-guide/media/index.rst rename Documentation/{media/dvb-drivers => admin-guide/media}/intro.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/ipu3.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/ipu3_rcb.svg (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/ivtv-cardlist.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/ivtv.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/lmedm04.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/meye.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/omap3isp.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/omap4_camera.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/opera-firmware.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/philips.rst (100%) rename Documentation/{media/cec-drivers => admin-guide/media}/pulse8-cec.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/qcom_camss.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/qcom_camss_8x96_graph.dot (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/qcom_camss_graph.dot (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/rcar-fdp1.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/saa7134-cardlist.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/saa7134.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/saa7164-cardlist.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/si470x.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/si4713.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/si476x.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/technisat.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/tm6000-cardlist.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/ttusb-dec.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/tuner-cardlist.rst (100%) rename Documentation/{media/dvb-drivers => admin-guide/media}/udev.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/usbvision-cardlist.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/v4l-with-ir.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/vimc.dot (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/vimc.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/vivid.rst (100%) rename Documentation/{media/v4l-drivers => admin-guide/media}/zr364xx.rst (100%) delete mode 100644 Documentation/media/cec-drivers/index.rst diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index f1d0ccffbe72..29a1355d0bed 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -92,6 +92,7 @@ configure specific aspects of kernel behavior to your liking. lockup-watchdogs LSM/index md + media/index mm/index module-signing mono diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index dbc22d684627..b12e9904a320 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -449,7 +449,7 @@ bttv.card= [HW,V4L] bttv (bt848 + bt878 based grabber cards) bttv.radio= Most important insmod options are available as kernel args too. - bttv.pll= See Documentation/media/v4l-drivers/bttv.rst + bttv.pll= See Documentation/admin-guide/media/bttv.rst bttv.tuner= bulk_remove=off [PPC] This parameter disables the use of the pSeries @@ -2658,7 +2658,7 @@ See Documentation/admin-guide/pm/sleep-states.rst. 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 Multi-Function General Purpose Timers on AMD Geode diff --git a/Documentation/media/v4l-drivers/au0828-cardlist.rst b/Documentation/admin-guide/media/au0828-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/au0828-cardlist.rst rename to Documentation/admin-guide/media/au0828-cardlist.rst diff --git a/Documentation/media/dvb-drivers/avermedia.rst b/Documentation/admin-guide/media/avermedia.rst similarity index 100% rename from Documentation/media/dvb-drivers/avermedia.rst rename to Documentation/admin-guide/media/avermedia.rst diff --git a/Documentation/media/dvb-drivers/bt8xx.rst b/Documentation/admin-guide/media/bt8xx.rst similarity index 93% rename from Documentation/media/dvb-drivers/bt8xx.rst rename to Documentation/admin-guide/media/bt8xx.rst index 7936cd96fc8f..d800f7791ada 100644 --- a/Documentation/media/dvb-drivers/bt8xx.rst +++ b/Documentation/admin-guide/media/bt8xx.rst @@ -20,7 +20,7 @@ General information 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. -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: @@ -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. Exceptions are: - 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: @@ -74,7 +74,7 @@ Useful parameters for verbosity level and debugging the dst module: The autodetected values are determined by the cards' "response string". 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. -Please also see Documentation/media/dvb-drivers/ci.rst. +Please also see Documentation/admin-guide/media/ci.rst. Running multiple cards ~~~~~~~~~~~~~~~~~~~~~~ @@ -102,7 +102,7 @@ Examples of card ID's: $ 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. Probing the cards with broken PCI subsystem ID diff --git a/Documentation/media/v4l-drivers/bttv-cardlist.rst b/Documentation/admin-guide/media/bttv-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/bttv-cardlist.rst rename to Documentation/admin-guide/media/bttv-cardlist.rst diff --git a/Documentation/media/v4l-drivers/bttv.rst b/Documentation/admin-guide/media/bttv.rst similarity index 100% rename from Documentation/media/v4l-drivers/bttv.rst rename to Documentation/admin-guide/media/bttv.rst diff --git a/Documentation/media/v4l-drivers/cafe_ccic.rst b/Documentation/admin-guide/media/cafe_ccic.rst similarity index 100% rename from Documentation/media/v4l-drivers/cafe_ccic.rst rename to Documentation/admin-guide/media/cafe_ccic.rst diff --git a/Documentation/media/v4l-drivers/cardlist.rst b/Documentation/admin-guide/media/cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/cardlist.rst rename to Documentation/admin-guide/media/cardlist.rst diff --git a/Documentation/media/dvb-drivers/cards.rst b/Documentation/admin-guide/media/cards.rst similarity index 100% rename from Documentation/media/dvb-drivers/cards.rst rename to Documentation/admin-guide/media/cards.rst diff --git a/Documentation/media/dvb-drivers/ci.rst b/Documentation/admin-guide/media/ci.rst similarity index 100% rename from Documentation/media/dvb-drivers/ci.rst rename to Documentation/admin-guide/media/ci.rst diff --git a/Documentation/media/v4l-drivers/cpia2.rst b/Documentation/admin-guide/media/cpia2.rst similarity index 100% rename from Documentation/media/v4l-drivers/cpia2.rst rename to Documentation/admin-guide/media/cpia2.rst diff --git a/Documentation/media/v4l-drivers/cx23885-cardlist.rst b/Documentation/admin-guide/media/cx23885-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/cx23885-cardlist.rst rename to Documentation/admin-guide/media/cx23885-cardlist.rst diff --git a/Documentation/media/v4l-drivers/cx88-cardlist.rst b/Documentation/admin-guide/media/cx88-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/cx88-cardlist.rst rename to Documentation/admin-guide/media/cx88-cardlist.rst diff --git a/Documentation/media/v4l-drivers/cx88.rst b/Documentation/admin-guide/media/cx88.rst similarity index 100% rename from Documentation/media/v4l-drivers/cx88.rst rename to Documentation/admin-guide/media/cx88.rst diff --git a/Documentation/media/v4l-drivers/davinci-vpbe.rst b/Documentation/admin-guide/media/davinci-vpbe.rst similarity index 100% rename from Documentation/media/v4l-drivers/davinci-vpbe.rst rename to Documentation/admin-guide/media/davinci-vpbe.rst diff --git a/Documentation/media/v4l-drivers/em28xx-cardlist.rst b/Documentation/admin-guide/media/em28xx-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/em28xx-cardlist.rst rename to Documentation/admin-guide/media/em28xx-cardlist.rst diff --git a/Documentation/media/dvb-drivers/faq.rst b/Documentation/admin-guide/media/faq.rst similarity index 100% rename from Documentation/media/dvb-drivers/faq.rst rename to Documentation/admin-guide/media/faq.rst diff --git a/Documentation/media/v4l-drivers/fimc.rst b/Documentation/admin-guide/media/fimc.rst similarity index 100% rename from Documentation/media/v4l-drivers/fimc.rst rename to Documentation/admin-guide/media/fimc.rst diff --git a/Documentation/media/v4l-drivers/gspca-cardlist.rst b/Documentation/admin-guide/media/gspca-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/gspca-cardlist.rst rename to Documentation/admin-guide/media/gspca-cardlist.rst diff --git a/Documentation/media/v4l-drivers/imx.rst b/Documentation/admin-guide/media/imx.rst similarity index 100% rename from Documentation/media/v4l-drivers/imx.rst rename to Documentation/admin-guide/media/imx.rst diff --git a/Documentation/media/v4l-drivers/imx7.rst b/Documentation/admin-guide/media/imx7.rst similarity index 100% rename from Documentation/media/v4l-drivers/imx7.rst rename to Documentation/admin-guide/media/imx7.rst diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst new file mode 100644 index 000000000000..5b355c327be1 --- /dev/null +++ b/Documentation/admin-guide/media/index.rst @@ -0,0 +1,104 @@ +.. SPDX-License-Identifier: GPL-2.0 + +.. include:: + +**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 diff --git a/Documentation/media/dvb-drivers/intro.rst b/Documentation/admin-guide/media/intro.rst similarity index 100% rename from Documentation/media/dvb-drivers/intro.rst rename to Documentation/admin-guide/media/intro.rst diff --git a/Documentation/media/v4l-drivers/ipu3.rst b/Documentation/admin-guide/media/ipu3.rst similarity index 100% rename from Documentation/media/v4l-drivers/ipu3.rst rename to Documentation/admin-guide/media/ipu3.rst diff --git a/Documentation/media/v4l-drivers/ipu3_rcb.svg b/Documentation/admin-guide/media/ipu3_rcb.svg similarity index 100% rename from Documentation/media/v4l-drivers/ipu3_rcb.svg rename to Documentation/admin-guide/media/ipu3_rcb.svg diff --git a/Documentation/media/v4l-drivers/ivtv-cardlist.rst b/Documentation/admin-guide/media/ivtv-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/ivtv-cardlist.rst rename to Documentation/admin-guide/media/ivtv-cardlist.rst diff --git a/Documentation/media/v4l-drivers/ivtv.rst b/Documentation/admin-guide/media/ivtv.rst similarity index 100% rename from Documentation/media/v4l-drivers/ivtv.rst rename to Documentation/admin-guide/media/ivtv.rst diff --git a/Documentation/media/dvb-drivers/lmedm04.rst b/Documentation/admin-guide/media/lmedm04.rst similarity index 100% rename from Documentation/media/dvb-drivers/lmedm04.rst rename to Documentation/admin-guide/media/lmedm04.rst diff --git a/Documentation/media/v4l-drivers/meye.rst b/Documentation/admin-guide/media/meye.rst similarity index 100% rename from Documentation/media/v4l-drivers/meye.rst rename to Documentation/admin-guide/media/meye.rst diff --git a/Documentation/media/v4l-drivers/omap3isp.rst b/Documentation/admin-guide/media/omap3isp.rst similarity index 100% rename from Documentation/media/v4l-drivers/omap3isp.rst rename to Documentation/admin-guide/media/omap3isp.rst diff --git a/Documentation/media/v4l-drivers/omap4_camera.rst b/Documentation/admin-guide/media/omap4_camera.rst similarity index 100% rename from Documentation/media/v4l-drivers/omap4_camera.rst rename to Documentation/admin-guide/media/omap4_camera.rst diff --git a/Documentation/media/dvb-drivers/opera-firmware.rst b/Documentation/admin-guide/media/opera-firmware.rst similarity index 100% rename from Documentation/media/dvb-drivers/opera-firmware.rst rename to Documentation/admin-guide/media/opera-firmware.rst diff --git a/Documentation/media/v4l-drivers/philips.rst b/Documentation/admin-guide/media/philips.rst similarity index 100% rename from Documentation/media/v4l-drivers/philips.rst rename to Documentation/admin-guide/media/philips.rst diff --git a/Documentation/media/cec-drivers/pulse8-cec.rst b/Documentation/admin-guide/media/pulse8-cec.rst similarity index 100% rename from Documentation/media/cec-drivers/pulse8-cec.rst rename to Documentation/admin-guide/media/pulse8-cec.rst diff --git a/Documentation/media/v4l-drivers/qcom_camss.rst b/Documentation/admin-guide/media/qcom_camss.rst similarity index 100% rename from Documentation/media/v4l-drivers/qcom_camss.rst rename to Documentation/admin-guide/media/qcom_camss.rst diff --git a/Documentation/media/v4l-drivers/qcom_camss_8x96_graph.dot b/Documentation/admin-guide/media/qcom_camss_8x96_graph.dot similarity index 100% rename from Documentation/media/v4l-drivers/qcom_camss_8x96_graph.dot rename to Documentation/admin-guide/media/qcom_camss_8x96_graph.dot diff --git a/Documentation/media/v4l-drivers/qcom_camss_graph.dot b/Documentation/admin-guide/media/qcom_camss_graph.dot similarity index 100% rename from Documentation/media/v4l-drivers/qcom_camss_graph.dot rename to Documentation/admin-guide/media/qcom_camss_graph.dot diff --git a/Documentation/media/v4l-drivers/rcar-fdp1.rst b/Documentation/admin-guide/media/rcar-fdp1.rst similarity index 100% rename from Documentation/media/v4l-drivers/rcar-fdp1.rst rename to Documentation/admin-guide/media/rcar-fdp1.rst diff --git a/Documentation/media/v4l-drivers/saa7134-cardlist.rst b/Documentation/admin-guide/media/saa7134-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/saa7134-cardlist.rst rename to Documentation/admin-guide/media/saa7134-cardlist.rst diff --git a/Documentation/media/v4l-drivers/saa7134.rst b/Documentation/admin-guide/media/saa7134.rst similarity index 100% rename from Documentation/media/v4l-drivers/saa7134.rst rename to Documentation/admin-guide/media/saa7134.rst diff --git a/Documentation/media/v4l-drivers/saa7164-cardlist.rst b/Documentation/admin-guide/media/saa7164-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/saa7164-cardlist.rst rename to Documentation/admin-guide/media/saa7164-cardlist.rst diff --git a/Documentation/media/v4l-drivers/si470x.rst b/Documentation/admin-guide/media/si470x.rst similarity index 100% rename from Documentation/media/v4l-drivers/si470x.rst rename to Documentation/admin-guide/media/si470x.rst diff --git a/Documentation/media/v4l-drivers/si4713.rst b/Documentation/admin-guide/media/si4713.rst similarity index 100% rename from Documentation/media/v4l-drivers/si4713.rst rename to Documentation/admin-guide/media/si4713.rst diff --git a/Documentation/media/v4l-drivers/si476x.rst b/Documentation/admin-guide/media/si476x.rst similarity index 100% rename from Documentation/media/v4l-drivers/si476x.rst rename to Documentation/admin-guide/media/si476x.rst diff --git a/Documentation/media/dvb-drivers/technisat.rst b/Documentation/admin-guide/media/technisat.rst similarity index 100% rename from Documentation/media/dvb-drivers/technisat.rst rename to Documentation/admin-guide/media/technisat.rst diff --git a/Documentation/media/v4l-drivers/tm6000-cardlist.rst b/Documentation/admin-guide/media/tm6000-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/tm6000-cardlist.rst rename to Documentation/admin-guide/media/tm6000-cardlist.rst diff --git a/Documentation/media/dvb-drivers/ttusb-dec.rst b/Documentation/admin-guide/media/ttusb-dec.rst similarity index 100% rename from Documentation/media/dvb-drivers/ttusb-dec.rst rename to Documentation/admin-guide/media/ttusb-dec.rst diff --git a/Documentation/media/v4l-drivers/tuner-cardlist.rst b/Documentation/admin-guide/media/tuner-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/tuner-cardlist.rst rename to Documentation/admin-guide/media/tuner-cardlist.rst diff --git a/Documentation/media/dvb-drivers/udev.rst b/Documentation/admin-guide/media/udev.rst similarity index 100% rename from Documentation/media/dvb-drivers/udev.rst rename to Documentation/admin-guide/media/udev.rst diff --git a/Documentation/media/v4l-drivers/usbvision-cardlist.rst b/Documentation/admin-guide/media/usbvision-cardlist.rst similarity index 100% rename from Documentation/media/v4l-drivers/usbvision-cardlist.rst rename to Documentation/admin-guide/media/usbvision-cardlist.rst diff --git a/Documentation/media/v4l-drivers/v4l-with-ir.rst b/Documentation/admin-guide/media/v4l-with-ir.rst similarity index 100% rename from Documentation/media/v4l-drivers/v4l-with-ir.rst rename to Documentation/admin-guide/media/v4l-with-ir.rst diff --git a/Documentation/media/v4l-drivers/vimc.dot b/Documentation/admin-guide/media/vimc.dot similarity index 100% rename from Documentation/media/v4l-drivers/vimc.dot rename to Documentation/admin-guide/media/vimc.dot diff --git a/Documentation/media/v4l-drivers/vimc.rst b/Documentation/admin-guide/media/vimc.rst similarity index 100% rename from Documentation/media/v4l-drivers/vimc.rst rename to Documentation/admin-guide/media/vimc.rst diff --git a/Documentation/media/v4l-drivers/vivid.rst b/Documentation/admin-guide/media/vivid.rst similarity index 100% rename from Documentation/media/v4l-drivers/vivid.rst rename to Documentation/admin-guide/media/vivid.rst diff --git a/Documentation/media/v4l-drivers/zr364xx.rst b/Documentation/admin-guide/media/zr364xx.rst similarity index 100% rename from Documentation/media/v4l-drivers/zr364xx.rst rename to Documentation/admin-guide/media/zr364xx.rst diff --git a/Documentation/media/cec-drivers/index.rst b/Documentation/media/cec-drivers/index.rst deleted file mode 100644 index 2b7fcaa4311b..000000000000 --- a/Documentation/media/cec-drivers/index.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0 - -.. include:: - -.. _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 diff --git a/Documentation/media/dvb-drivers/index.rst b/Documentation/media/dvb-drivers/index.rst index 9d3fce544f85..7a870ee7ac7d 100644 --- a/Documentation/media/dvb-drivers/index.rst +++ b/Documentation/media/dvb-drivers/index.rst @@ -29,17 +29,6 @@ For more details see the file COPYING in the source distribution of Linux. :maxdepth: 5 :numbered: - intro - avermedia - bt8xx - cards - ci dvb-usb - faq - lmedm04 - opera-firmware - technisat - ttusb-dec - udev frontends contributors diff --git a/Documentation/media/index.rst b/Documentation/media/index.rst index 308f6a396d1c..0f75280b8c43 100644 --- a/Documentation/media/index.rst +++ b/Documentation/media/index.rst @@ -14,9 +14,9 @@ Linux Media Subsystem Documentation ../userspace-api/media/index ../driver-api/media/index - dvb-drivers/index + v4l-drivers/index - cec-drivers/index + dvb-drivers/index .. only:: html and subproject diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst index 8962a86dad70..aef375cfb05a 100644 --- a/Documentation/media/v4l-drivers/index.rst +++ b/Documentation/media/v4l-drivers/index.rst @@ -31,38 +31,13 @@ For more details see the file COPYING in the source distribution of Linux. :maxdepth: 5 :numbered: - v4l-with-ir tuners - cardlist - bttv - cafe_ccic - cpia2 - cx88 - davinci-vpbe - fimc - imx - imx7 - ipu3 - ivtv max2175 - meye - omap3isp - omap4_camera - philips pvrusb2 pxa_camera - qcom_camss radiotrack - rcar-fdp1 - saa7134 sh_mobile_ceu_camera - si470x - si4713 - si476x uvcvideo - vimc - vivid - zr364xx bttv-devel cpia2_devel diff --git a/Documentation/translations/zh_CN/video4linux/omap3isp.txt b/Documentation/translations/zh_CN/video4linux/omap3isp.txt index e9f29375aa95..75e481985630 100644 --- a/Documentation/translations/zh_CN/video4linux/omap3isp.txt +++ b/Documentation/translations/zh_CN/video4linux/omap3isp.txt @@ -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 original document maintainer directly. However, if you have a problem @@ -11,7 +11,7 @@ Maintainer: Laurent Pinchart David Cohen Chinese maintainer: Fu Wei --------------------------------------------------------------------- -Documentation/media/v4l-drivers/omap3isp.rst 的中文翻译 +Documentation/admin-guide/media/omap3isp.rst 的中文翻译 如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文 交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻 diff --git a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst index 0767299e9105..751c6590e774 100644 --- a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst +++ b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst @@ -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.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 by the CX23415 MPEG decoder's capabilities and limitations with respect to extracting, decoding, and displaying sliced VBI data embedded within diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst index f64f6fc4fd75..f81016c97a0d 100644 --- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst @@ -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.rst``) + ``Documentation/media/v4l-drivers/cx2341x-uapi.rst``) diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst index e47103aa32ed..bb9d484c25e4 100644 --- a/Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst @@ -53,7 +53,7 @@ Image Process Control IDs ``V4L2_CID_DEINTERLACING_MODE (menu)`` 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)`` Digital gain is the value by which all colour components diff --git a/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst b/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst index 8ef90b0df864..dbdcf6c9f072 100644 --- a/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst @@ -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.rst`` + ``Documentation/media/v4l-drivers/cx2341x-uapi.rst`` * .. _V4L2-PIX-FMT-CPIA1: - ``V4L2_PIX_FMT_CPIA1`` diff --git a/MAINTAINERS b/MAINTAINERS index b5af1feb5ba1..fbb8b1f13cb8 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3711,7 +3711,7 @@ M: Jonathan Corbet L: linux-media@vger.kernel.org T: git git://linuxtv.org/media_tree.git S: Maintained -F: Documentation/media/v4l-drivers/cafe_ccic* +F: Documentation/admin-guide/media/cafe_ccic* F: drivers/media/platform/marvell-ccic/ CAIF NETWORK LAYER @@ -6180,7 +6180,7 @@ W: https://linuxtv.org T: git git://linuxtv.org/media_tree.git S: Maintained F: drivers/media/usb/em28xx/ -F: Documentation/media/v4l-drivers/em28xx* +F: Documentation/admin-guide/media/em28xx* EMBEDDED LINUX M: Paul Gortmaker @@ -8529,8 +8529,8 @@ L: linux-media@vger.kernel.org S: Maintained F: drivers/staging/media/ipu3/ F: Documentation/userspace-api/media/v4l/pixfmt-meta-intel-ipu3.rst -F: Documentation/media/v4l-drivers/ipu3.rst -F: Documentation/media/v4l-drivers/ipu3_rcb.svg +F: Documentation/admin-guide/media/ipu3.rst +F: Documentation/admin-guide/media/ipu3_rcb.svg INTEL IXP4XX QMGR, NPE, ETHERNET and HSS SUPPORT M: Krzysztof Halasa @@ -8953,7 +8953,7 @@ L: linux-media@vger.kernel.org T: git git://linuxtv.org/media_tree.git W: https://linuxtv.org S: Maintained -F: Documentation/media/v4l-drivers/ivtv* +F: Documentation/admin-guide/media/ivtv* F: drivers/media/pci/ivtv/ F: include/uapi/linux/ivtv* @@ -10322,7 +10322,7 @@ L: linux-media@vger.kernel.org T: git git://linuxtv.org/media_tree.git S: Maintained 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: include/linux/imx-media.h F: include/media/imx.h @@ -10341,7 +10341,7 @@ T: git git://linuxtv.org/media_tree.git S: Maintained F: Documentation/devicetree/bindings/media/imx7-csi.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-mipi-csis.c @@ -13570,7 +13570,7 @@ L: linux-media@vger.kernel.org T: git git://linuxtv.org/media_tree.git S: Maintained F: drivers/media/usb/pulse8-cec/* -F: Documentation/media/cec-drivers/pulse8-cec.rst +F: Documentation/admin-guide/media/pulse8-cec.rst PVRUSB2 VIDEO4LINUX DRIVER M: Mike Isely @@ -13820,7 +13820,7 @@ M: Todor Tomov L: linux-media@vger.kernel.org S: Maintained 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/ QUALCOMM CPUFREQ DRIVER MSM8996/APQ8096 @@ -16828,7 +16828,7 @@ W: https://linuxtv.org T: git git://linuxtv.org/media_tree.git S: Odd fixes F: drivers/media/usb/tm6000/ -F: Documentation/media/v4l-drivers/tm6000* +F: Documentation/admin-guide/media/tm6000* TMIO/SDHI MMC DRIVER M: Wolfram Sang @@ -17502,7 +17502,7 @@ L: linux-media@vger.kernel.org T: git git://linuxtv.org/media_tree.git W: http://royale.zerezo.com/zr364xx/ S: Maintained -F: Documentation/media/v4l-drivers/zr364xx* +F: Documentation/admin-guide/media/zr364xx* F: drivers/media/usb/zr364xx/ USER-MODE LINUX (UML) diff --git a/drivers/media/pci/bt8xx/Kconfig b/drivers/media/pci/bt8xx/Kconfig index 75d172a6f54c..3f56decbb681 100644 --- a/drivers/media/pci/bt8xx/Kconfig +++ b/drivers/media/pci/bt8xx/Kconfig @@ -17,7 +17,7 @@ config VIDEO_BT848 help Support for BT848 based frame grabber/overlay boards. This includes the Miro, Hauppauge and STB boards. Please read the material in - for more information. + for more information. To compile this driver as a module, choose M here: the module will be called bttv. diff --git a/drivers/media/pci/meye/Kconfig b/drivers/media/pci/meye/Kconfig index b37da612dd0c..fed1f4a01817 100644 --- a/drivers/media/pci/meye/Kconfig +++ b/drivers/media/pci/meye/Kconfig @@ -7,7 +7,7 @@ config VIDEO_MEYE help This is the video4linux driver for the Motion Eye camera found in the Vaio Picturebook laptops. Please read the material in - for more information. + for more information. If you say Y or M here, you need to say Y or M to "Sony Laptop Extras" in the misc device section. diff --git a/drivers/media/radio/si470x/Kconfig b/drivers/media/radio/si470x/Kconfig index a1ba8bc54b62..7161bd6cd13c 100644 --- a/drivers/media/radio/si470x/Kconfig +++ b/drivers/media/radio/si470x/Kconfig @@ -30,7 +30,7 @@ config USB_SI470X Please have a look at the documentation, especially on how 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 computer's USB port. diff --git a/drivers/media/usb/dvb-usb-v2/lmedm04.c b/drivers/media/usb/dvb-usb-v2/lmedm04.c index 62d3566bf7ee..4cf09c5c8216 100644 --- a/drivers/media/usb/dvb-usb-v2/lmedm04.c +++ b/drivers/media/usb/dvb-usb-v2/lmedm04.c @@ -22,7 +22,7 @@ * * LME2510C + M88RS2000 * - * For firmware see Documentation/media/dvb-drivers/lmedm04.rst + * For firmware see Documentation/admin-guide/media/lmedm04.rst * * I2C addresses: * 0xd0 - STV0288 - Demodulator diff --git a/drivers/media/usb/gspca/Kconfig b/drivers/media/usb/gspca/Kconfig index 77a360958239..0283e3b908e4 100644 --- a/drivers/media/usb/gspca/Kconfig +++ b/drivers/media/usb/gspca/Kconfig @@ -9,7 +9,7 @@ menuconfig USB_GSPCA Say Y here if you want to enable selecting webcams based on the GSPCA framework. - See for more info. + See for more info. This driver uses the Video For Linux API. You must say Y or M to "Video For Linux" to use this driver. diff --git a/drivers/media/usb/zr364xx/Kconfig b/drivers/media/usb/zr364xx/Kconfig index 55b06c833667..49b4257487bb 100644 --- a/drivers/media/usb/zr364xx/Kconfig +++ b/drivers/media/usb/zr364xx/Kconfig @@ -7,7 +7,7 @@ config USB_ZR364XX help Say Y here if you want to connect this type of camera to your computer's USB port. - See for more info + See for more info and list of supported cameras. To compile this driver as a module, choose M here: the From patchwork Tue Mar 10 13:43:12 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11429379 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 65B0992A for ; Tue, 10 Mar 2020 13:43:38 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 380F324677 for ; Tue, 10 Mar 2020 13:43:38 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="qvljP3bu"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="wmFV3lvw" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 380F324677 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=R8Nk1EiEMHoCjpoMdGlvDFV9qCQfQpv3qIUnfwjNui0=; b=qvljP3buJ9a79N X1v1VRNChhmSr/0+kz2VWlY01S9xqXlKBo9nfSB84aMgb/SmDZMrrY155yl17MhaKnMfCMtjY7wE+ oilgX/X9pWLeRwkc0VlK2jjI8ZezhoAvNb5kDYE7hMjyjMhWlp6sVJngRNdGKL4u9tcp/RmTPCBfP jNIlVYyqgEnI+wj0fFylS7IS+oqXhPGM+z8DdnFBy58bGny85q/xxa6gfW9EGofsIf4Z9rKRMKoKK 5beep+kEYXwW6+bLezLhwKliVpoRb0VdrmG30M3CXsvJh1VGzyTOKTR5JImusTET4uhKk3mSKBrlg wn/tOSFqdyvzMLnDOZSg==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jBfAS-0001b7-4Q; Tue, 10 Mar 2020 13:43:32 +0000 Received: from mail.kernel.org ([198.145.29.99]) by bombadil.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jBfAE-0001QR-JD for linux-arm-kernel@lists.infradead.org; Tue, 10 Mar 2020 13:43:21 +0000 Received: from mail.kernel.org (ip5f5ad4e9.dynamic.kabel-deutschland.de [95.90.212.233]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id AF5B8246BB; Tue, 10 Mar 2020 13:43:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1583847797; bh=5PlHhPzSK+0l2GtUGdprWuSb0TB3BTurH4keibjpyJM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=wmFV3lvweOaILFZqknun7j+8CoR8I/MGrnJJKsNcNuyiCJXCnUW2Y3yR2JpMjEELP j24EIT55wol3D/NdfnIl6HHHWbB+X2LUaGATA4ZAn4Mh40hi/h9Dupt25XftTcXPfK JuJtn6+0hYM26qlxxA3VBmMCdWbERLYKlfxXTGxM= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jBfAB-0005wo-OR; Tue, 10 Mar 2020 14:43:15 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v2 21/22] media: docs: add an uAPI chapter for driver-specific stuff Date: Tue, 10 Mar 2020 14:43:12 +0100 Message-Id: X-Mailer: git-send-email 2.24.1 In-Reply-To: References: MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200310_064318_676034_CF8BC8AB X-CRM114-Status: GOOD ( 15.35 ) X-Spam-Score: -5.2 (-----) X-Spam-Report: SpamAssassin version 3.4.3 on bombadil.infradead.org summary: Content analysis details: (-5.2 points) pts rule name description ---- ---------------------- -------------------------------------------------- -5.0 RCVD_IN_DNSWL_HI RBL: Sender listed at https://www.dnswl.org/, high trust [198.145.29.99 listed in list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.0 DKIMWL_WL_HIGH DKIMwl.org - Whitelisted High sender X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Jonathan Corbet , Mauro Carvalho Chehab , Fabio Estevam , Sascha Hauer , linux-kernel@vger.kernel.org, Ramesh Shanmugasundaram , NXP Linux Team , Pengutronix Kernel Team , Shawn Guo , linux-arm-kernel@lists.infradead.org, linux-media@vger.kernel.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org There are some uAPI stuff that are driver-specific. Add them to the main media uAPI body. Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/index.rst | 2 -- .../media/drivers}/cx2341x-uapi.rst | 0 .../media/drivers}/imx-uapi.rst | 0 .../v4l-drivers => userspace-api/media/drivers}/index.rst | 7 +++---- .../media/drivers}/max2175.rst | 0 .../media/drivers}/meye-uapi.rst | 0 .../media/drivers}/omap3isp-uapi.rst | 0 .../media/drivers}/uvcvideo.rst | 0 Documentation/userspace-api/media/index.rst | 2 ++ Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst | 2 +- Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst | 2 +- Documentation/userspace-api/media/v4l/pixfmt-reserved.rst | 2 +- MAINTAINERS | 4 ++-- drivers/media/i2c/max2175.c | 6 +++--- 14 files changed, 13 insertions(+), 14 deletions(-) rename Documentation/{media/v4l-drivers => userspace-api/media/drivers}/cx2341x-uapi.rst (100%) rename Documentation/{media/v4l-drivers => userspace-api/media/drivers}/imx-uapi.rst (100%) rename Documentation/{media/v4l-drivers => userspace-api/media/drivers}/index.rst (97%) rename Documentation/{media/v4l-drivers => userspace-api/media/drivers}/max2175.rst (100%) rename Documentation/{media/v4l-drivers => userspace-api/media/drivers}/meye-uapi.rst (100%) rename Documentation/{media/v4l-drivers => userspace-api/media/drivers}/omap3isp-uapi.rst (100%) rename Documentation/{media/v4l-drivers => userspace-api/media/drivers}/uvcvideo.rst (100%) diff --git a/Documentation/media/index.rst b/Documentation/media/index.rst index a5cd600e0b04..e93fd88881af 100644 --- a/Documentation/media/index.rst +++ b/Documentation/media/index.rst @@ -15,8 +15,6 @@ Linux Media Subsystem Documentation ../userspace-api/media/index ../driver-api/media/index - v4l-drivers/index - .. only:: html and subproject Indices diff --git a/Documentation/media/v4l-drivers/cx2341x-uapi.rst b/Documentation/userspace-api/media/drivers/cx2341x-uapi.rst similarity index 100% rename from Documentation/media/v4l-drivers/cx2341x-uapi.rst rename to Documentation/userspace-api/media/drivers/cx2341x-uapi.rst diff --git a/Documentation/media/v4l-drivers/imx-uapi.rst b/Documentation/userspace-api/media/drivers/imx-uapi.rst similarity index 100% rename from Documentation/media/v4l-drivers/imx-uapi.rst rename to Documentation/userspace-api/media/drivers/imx-uapi.rst diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/userspace-api/media/drivers/index.rst similarity index 97% rename from Documentation/media/v4l-drivers/index.rst rename to Documentation/userspace-api/media/drivers/index.rst index ee7faff88a33..05a82f8c0c99 100644 --- a/Documentation/media/v4l-drivers/index.rst +++ b/Documentation/userspace-api/media/drivers/index.rst @@ -2,7 +2,7 @@ .. include:: -.. _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 diff --git a/Documentation/media/v4l-drivers/max2175.rst b/Documentation/userspace-api/media/drivers/max2175.rst similarity index 100% rename from Documentation/media/v4l-drivers/max2175.rst rename to Documentation/userspace-api/media/drivers/max2175.rst diff --git a/Documentation/media/v4l-drivers/meye-uapi.rst b/Documentation/userspace-api/media/drivers/meye-uapi.rst similarity index 100% rename from Documentation/media/v4l-drivers/meye-uapi.rst rename to Documentation/userspace-api/media/drivers/meye-uapi.rst diff --git a/Documentation/media/v4l-drivers/omap3isp-uapi.rst b/Documentation/userspace-api/media/drivers/omap3isp-uapi.rst similarity index 100% rename from Documentation/media/v4l-drivers/omap3isp-uapi.rst rename to Documentation/userspace-api/media/drivers/omap3isp-uapi.rst diff --git a/Documentation/media/v4l-drivers/uvcvideo.rst b/Documentation/userspace-api/media/drivers/uvcvideo.rst similarity index 100% rename from Documentation/media/v4l-drivers/uvcvideo.rst rename to Documentation/userspace-api/media/drivers/uvcvideo.rst diff --git a/Documentation/userspace-api/media/index.rst b/Documentation/userspace-api/media/index.rst index 614310f82395..bcfdd1a5caa0 100644 --- a/Documentation/userspace-api/media/index.rst +++ b/Documentation/userspace-api/media/index.rst @@ -31,3 +31,5 @@ entitled "GNU Free Documentation License". cec/cec-api gen-errors fdl-appendix + + drivers/index diff --git a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst index 751c6590e774..dd0b6646beb5 100644 --- a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst +++ b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst @@ -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 diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst index f81016c97a0d..9b48338fb783 100644 --- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst @@ -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``) diff --git a/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst b/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst index dbdcf6c9f072..59b9e7238f90 100644 --- a/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst @@ -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`` diff --git a/MAINTAINERS b/MAINTAINERS index cf4fd454e053..a883c2e53b86 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -10135,7 +10135,7 @@ L: linux-media@vger.kernel.org T: git git://linuxtv.org/media_tree.git S: Maintained 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 @@ -11251,7 +11251,7 @@ F: kernel/module.c MOTION EYE VAIO PICTUREBOOK CAMERA DRIVER W: http://popies.net/meye/ S: Orphan -F: Documentation/media/v4l-drivers/meye* +F: Documentation/userspace-api/media/drivers/meye* F: drivers/media/pci/meye/ F: include/uapi/linux/meye.h diff --git a/drivers/media/i2c/max2175.c b/drivers/media/i2c/max2175.c index 506a30e69ced..03b4ed3a61b8 100644 --- a/drivers/media/i2c/max2175.c +++ b/drivers/media/i2c/max2175.c @@ -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",