From patchwork Sun Mar 26 21:34:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Stefan Herdler X-Patchwork-Id: 667265 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id D9D85C7619A for ; Sun, 26 Mar 2023 21:34:38 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229606AbjCZVeh (ORCPT ); Sun, 26 Mar 2023 17:34:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52528 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229475AbjCZVef (ORCPT ); Sun, 26 Mar 2023 17:34:35 -0400 Received: from mout.gmx.net (mout.gmx.net [212.227.17.20]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 508EF59DB for ; Sun, 26 Mar 2023 14:34:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=nurfuerspam.de; s=s31663417; t=1679866457; i=herdler@nurfuerspam.de; bh=f9Y0ABzZjF5RWLTaR6CBwzGsxsiUjVE7ieBcPW8La0M=; h=X-UI-Sender-Class:Date:Subject:From:To:Cc:References:In-Reply-To; b=MlMAOKai008XY7MCMcFdJ1ScFmtznw5nNvTtZcn/s0xoYiIVFpYthG1Yvv2ZjmVBB 8esVI4ygzYjNmngv5u7C06q6MoclBWsL1XpZAM0tDtgn8SQ7JbGHNBhnN1t2i89pz0 pjpIrQLMdjs0cViNIG+YGcpu7llXAl9DB/wWu+4Vsweh14dmHIZ6bx//5g+2dBKujG vNpZhymbLZcHL5VuVucGDejQqu/oy2vxrupDWaVBvXUvtj2V/OzxufO0gCYvUgvHz5 VmaJr1qoULoJrPsYt1WgQ0yof5i+9oYOe4RRJ8Cy/2ZXHh/xZn8bXhY+wVtjCd8ESy tmh30Hpi3W95A== X-UI-Sender-Class: 724b4f7f-cbec-4199-ad4e-598c01a50d3a Received: from [127.0.0.1] ([91.132.220.84]) by mail.gmx.net (mrgmx104 [212.227.17.168]) with ESMTPSA (Nemesis) id 1MbAci-1qHnd23qBc-00bbrf; Sun, 26 Mar 2023 23:34:17 +0200 Message-ID: Date: Sun, 26 Mar 2023 23:34:16 +0200 MIME-Version: 1.0 Subject: [PATCH v2] Legacy DVB API: completion of documentation From: Stefan Herdler To: Mauro Carvalho Chehab , Hans Verkuil Cc: linux-media@vger.kernel.org, Manu Abraham , Tomasz Maciej Nowak , Corinna Vinschen , Soeren Moch References: <20ceeb7f-336a-b51c-8cc8-128cc9ebcd2e@xs4all.nl> <014db0ee-55fe-2966-a531-b8c23e97b402@web.de> <8fb1799b-5ed1-9d26-54fc-b47abe0c13cf@nurfuerspam.de> <014a6ade-dddb-6c0d-a59a-186e0b0aa3c2@nurfuerspam.de> <44cc2154-9224-510d-1f9c-34ae49f01c73@nurfuerspam.de> <026b1342-2b0f-f61d-ea33-63f3992d1473@nurfuerspam.de> <20230208100847.3ec87576@coco.lan> <99397771-409b-e487-e429-d5c9feb82209@nurfuerspam.de> <50f69514-abbb-2dfb-6060-889aa2c6e02c@nurfuerspam.de> Content-Language: de-DE, en-US In-Reply-To: <50f69514-abbb-2dfb-6060-889aa2c6e02c@nurfuerspam.de> X-Provags-ID: V03:K1:7fJr/JEcaGqz9wyNMsjuXBUILqrVYD6h73BQkTldbdfVRJj7pM0 akLUkP9nhHRbVFQY+mDUMpXeKQr660L1BXMg9+6saAHFTzCuBprxBb4pELUsPkt37i9UjQ0 ALaNmwZSM7U5shH6UydxnfpjBYUjQONhIEZaT4/9uuTXVHl/eeKq0z3CV+QvzTNody631w7 i28+LR5GUvtz0fZ5nua9w== UI-OutboundReport: notjunk:1;M01:P0:sATRVSB2kV8=;5iYn3XAGJShy8FUSnugbG67yTRj 1GVPcTnzlR6l4UHReVEzETSM0UVC4yaTBc/Sb8HcIXXgUKbd3wlvfl7kYcUeH5TSgMXPp2vzm Spe0vE+ByCuCGFw/cLeRcX9fyfjN1aGo0tXIlwgzXcaUDpVqfWKrBKUVFztmfZxxYeN6Pilkg eIzUqbDpF2EMWy4osnHS15xica7XEkZbbjevFytUfUYwhJH8PGTFJWp2n7zY1dF2F9chLQuld ciQFItwKdA67lckRegYwfSvjq05qZd7JrsoLGwCuw45EYlRTs5vrQQm3m1Io8SZmq7HQktu7E cKTyxtXrj79OLOkSuVkaRdbIo9j94R93GXBpFv2BXGMAlF9y2TWyqbxXYcWNH4fzR2k16Pbf+ XOWni5RxmlNiKhI9l91SnrLBB9J0ToHKibBUHP3VqPYaSggYDLIvBFQIKDYhYXtXPDQIO4jIn irDiHP5dA+S/7MzFwCCW9Ov9jny3NXreI9byAIZHsDMQm7kEMaNGSuZddWlpTe8m/2FTAqEJq 4HeaADgyEJoljZ6AVxCSV+Q98f+dXVQmyXfuyJn45bCv+EISYSh777BBlSfMoSiXRrRR7LShn 0cAXL9F9VklfUpNgDoJh3Zjhi/51+2rR80Cn7R8V2ceLoV5E3GeldjL4hOI3jaNq7kS4d5v5z vpDkm41/ZTIpXxvJC+l0ATcmGdZr+G84A30TC9YnO5GEg3jyGnLTpT0XNO7EIs+tPUqeZOLTr YzLU6A3iCx8LAEQ3lj9lJJYeh2psiCb6nvMMLRSgfff2n8pO9pecnoV3zHoSGT0hkwABUL+QI 9QHEL36mukTVcGU4nY0z64XkHOI6dCaNpDoF8vibh2ik+p6TjyFbFEBlByatXcSQp16Jz5gXG i9AluZh5WpDwDJS5hOTxoDQY2/ho9xa4F5WQKemusceb9EPmzx0wlu122yRKah6VpO0qHI+Dc 2S6LvSyijqPw2y9duhnFLikHreY= Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org On 25/03/23 02:44, Stefan Herdler wrote: > Hi Mauro and Hans, > > it took a little longer then anticipated, but I think I was able to fill the gaps in the documentation. > At least everything in the header-files is in the documentation now. I hope, I have done it sufficiently. > > Some remarks: > > I considered the existing documentation to be trustworthy. > Existing things like returntypes, errnos, ... haven't been touched by me. > There are only a few minor modifications to reflect the data formats actually used for playback. > > The documentation has been merged into one file per header-file. Entries have been sorted equally. > For me it is much better arranged this way, the mass of different files where just to confusing and the > original files have already been removed anyway. > But I may revert that if necessary. > > Title and chapter-styles has been changed to the suggested ones in "/doc-guide/sphinx.html#writing-documentation". > > There are still some "Duplicate C++ declaration, ..." warnings. Renaming doesn't work either: 'unknown option: "name"' > I haven't found any useful hint how to get rid of them. > Should I switch to "code-block:: c" instead? > But there are a lot of this warnings from other files too. It seems I'm mot the only one with this problem. I switched to "code-block". Now there are no warnings anymore. This functions shouldn't be referenced from outside this document anyway. Lets hope, the robot likes it better this way :-). Regards Stefan > > > Please point out, if something is missing, wrong or need to be improved. I will try to fix it. > > Regards > Stefan > > p.s. It is my first try to submit a patch this way. I hope my mail-client doesn't mess it up. > This patch is largely based on the already existing documentation and the header files | Reported-by: kernel test robot | Link: https://lore.kernel.org/oe-kbuild-all/202303251637.x35nzuXi-lkp@intel.com/ Signed-off-by: Stefan Herdler diff --git a/Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst b/Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst index b97d56ee543c..ffe8325749e5 100644 --- a/Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst +++ b/Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst @@ -23,3 +23,4 @@ DVB-S2, DVB-T2, ISDB, etc. :maxdepth: 1 frontend_legacy_dvbv3_api + legacy_dvb_decoder_api diff --git a/Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst b/Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst new file mode 100644 index 000000000000..b4f75643c21f --- /dev/null +++ b/Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst @@ -0,0 +1,1280 @@ +.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + +.. _dvb_audio: + +================ +DVB Audio Device +================ + +.. attention:: Do **not** use in new drivers! + See: :ref:`legacy_dvb_decoder_notes` + +The DVB audio device controls the MPEG2 audio decoder of the DVB +hardware. It can be accessed through ``/dev/dvb/adapter?/audio?``. Data +types and ioctl definitions can be accessed by including +``linux/dvb/audio.h`` in your application. + +Please note that most DVB cards don’t have their own MPEG decoder, which +results in the omission of the audio and video device. + +These ioctls were also used by V4L2 to control MPEG decoders implemented +in V4L2. The use of these ioctls for that purpose has been made obsolete +and proper V4L2 ioctls or controls have been created to replace that +functionality. Use :ref:`V4L2 ioctls