From mboxrd@z Thu Jan 1 00:00:00 1970 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 657D1C6FD1C for ; Sat, 25 Mar 2023 01:44:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231327AbjCYBoi (ORCPT ); Fri, 24 Mar 2023 21:44:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34790 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229623AbjCYBoh (ORCPT ); Fri, 24 Mar 2023 21:44:37 -0400 Received: from mout.gmx.net (mout.gmx.net [212.227.15.15]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 608A31555E for ; Fri, 24 Mar 2023 18:44:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=nurfuerspam.de; s=s31663417; t=1679708657; i=herdler@nurfuerspam.de; bh=gn0c/f3+yi6QPN36aklrsb4Ze5lmUkS+1187lfvD4Uk=; h=X-UI-Sender-Class:Date:Subject:From:To:Cc:References:In-Reply-To; b=Gg/ljT8mh+z5aG9H/ogS645nzCuRol+viZIBs2WyaC5Wz6lRt7yP7Bb1+xnYuIkBF 7t11teRmlisfP36fKjUV2mU/AYwNYioR9Wo7HUsIkfVhDati56OTTQuhxMohdEcvj6 9oqjuc2/WfSR4n61+4NeHbBsHNvnMBupgfzfPnAWyHUWU2im/PyGmBtdlEqmqYbbaI 93+NF64qH58M4dOq3efaBwoWaqXAd6VMJhBMegkyAvt8NwRUSOQ9oyHEd0TB8tVq/e ciIZ2jrXkdEQdHUvPABMomSvQEoZRu0dWd1SrMkP0EQzeCdj2rd5a2o9KQoZ4j96MF WoN1zMudRSiDw== X-UI-Sender-Class: 724b4f7f-cbec-4199-ad4e-598c01a50d3a Received: from [127.0.0.1] ([217.113.187.204]) by mail.gmx.net (mrgmx004 [212.227.17.190]) with ESMTPSA (Nemesis) id 1MZCfD-1q26cb42y1-00V5Me; Sat, 25 Mar 2023 02:44:17 +0100 Message-ID: <50f69514-abbb-2dfb-6060-889aa2c6e02c@nurfuerspam.de> Date: Sat, 25 Mar 2023 02:44:16 +0100 MIME-Version: 1.0 Subject: [PATCH] Legacy DVB API: completion of documentation Content-Language: de-DE, en-US 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> In-Reply-To: <99397771-409b-e487-e429-d5c9feb82209@nurfuerspam.de> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Provags-ID: V03:K1:ckw320O9cFcx3IpBnfLOCLtfcHPwOtZ4L1hOyyeenlb+B/9BgCh q2H1BPMt3YGQRcA8h301jIWJOkBfuOfh6qtCahAOd+sFL3/xN5D2txDsex/F8yXkD2w5l2Z kIHkAELOZtU+YDM4NwpQzStasvIWZjJj0mKKo8l13pAp44uib6n282pudNxWlfj7q/RY6KH pALKbNuJYUXcTaXHpt94Q== UI-OutboundReport: notjunk:1;M01:P0:Ho33PChKcVI=;Gaaojzx+6wXwBj3VgXpoP6a4WA9 qtBKJELFaMkY+PSeVWY2BOQVuWVgy1Wq4wtsB5XEs2Z+KwveY8jEsHNOBr8zG0fTQHAYp/p1+ kiIwpojIwc+r/oZJSMBQvZavGvavQ0Pq3eG/F4Pg8/wjAlalYR8J6iP+BVkhl0Mnx9Pq/iwdn 7FeDugx3VXAOYnywyE6ZgoWetZUli+tFaOfGPi2SnR4cOhwWBhRx5rMkS7Xo+i5CBWCrbzrk/ XBveW7b3JAHCh1F3oByyB+RhT2fSztUu4LQVltVPN2AMU6LhL6nDeEQhhVJrEnYn1+mtEqt/Y TPOVn45C0fk8WzpM8VVyM9UUvJ9bgMEFy+yAs8nio+DVXWgQ2XYK05kYD58puy7fRlPQoD7mw ScOTSMyKWcUvZkPh+a7JPO8G4T6HzfTLvdaGd1V9gW9/7xudyqIoMObwjoiGCh0k6KTFfcNXK nSSKrzoQi5ZJXGrkyOQrJQMsFji42P5XHuDMFZ/njUZXRZhWIP48FdwHyDIaBEdUvnehlAV7i GshUH3bk0Cr92bi9JrYKGZOyK+PAH1chQDo+HnI84MOr1T1WGSuv7rlQV/TAVwyrK/eACVdDj hU9UKBOXInJsJ4nBypkOYe7WkYESXmog5IJyqfUIDFA6/zF9GWhrxqkpSw+PmyrHOw57Crid2 oPpU//rcUW9OeZLpNlxmbXIv/djXLDmafuI60tUwORpEn6q8wp/2VTdUy/iShLYOV5o9KJddu cIqBugw9uKxE04doko+4apo2/2wGRj3+FCJ46vwKD0zpNz+mFvCj8QWMrQoIp2zi66kUX8Qsk h1XQk6XuL6RxWP3PIkO6StaDyefXiIhiuCtTIXJLlhG9bzXRMQTFMc5af104qwPopNOnvLxbe ZdgdlVlqQRj3sLOYZjLfIkkjcb3nOHT78imSzlmA1RLKpCNbJv9E9DtGxsUoP78RME23YoDEQ yK0s09Dv4CLE/3vrLOZHFJRHg/U= Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org Hi Mauro and Hans, it took a little longer then anticipated, but I think I was able to fill t= he gaps in the documentation. At least everything in the header-files is in the documentation now. I hop= e, 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 actua= lly used for playback. The documentation has been merged into one file per header-file. Entries h= ave been sorted equally. For me it is much better arranged this way, the mass of different files wh= ere 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-g= uide/sphinx.html#writing-documentation". There are still some "Duplicate C++ declaration, ..." warnings. Renaming d= oesn'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 mo= t the only one with this problem. 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. Signed-off-by: Stefan Herdler diff --git a/Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst b/D= ocumentation/userspace-api/media/dvb/legacy_dvb_apis.rst index b97d56ee543c..ffe8325749e5 100644 =2D-- 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..3197b29df2fa =2D-- /dev/null +++ b/Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst @@ -0,0 +1,1242 @@ +.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + +.. _dvb_audio: + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +DVB Audio Device +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. 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=E2=80=99t 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