From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 11/14] media: dmx-get-pes-pids.rst: document the ioctl
Date: Fri, 1 Sep 2017 16:37:47 -0300 [thread overview]
Message-ID: <dbbc595c0a13ca5121ba465b2db9a024584b44d0.1504293108.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1504293108.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1504293108.git.mchehab@s-opensource.com>
This ioctl is supported by the DVB core, but was never
documented.
Add a documentation for it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/media/uapi/dvb/dmx-get-pes-pids.rst | 22 ++++++++++++++++++++--
1 file changed, 20 insertions(+), 2 deletions(-)
diff --git a/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst b/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
index 20288c11d279..fbdbc12869d1 100644
--- a/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
+++ b/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
@@ -25,13 +25,31 @@ Arguments
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
``pids``
- Undocumented.
+ Array used to store 5 Program IDs.
Description
-----------
-.. note:: This ioctl is undocumented. Documentation is welcome.
+This ioctl allows to query a DVB device to return the first PID used
+by audio, video, textext, subtitle and PCR programs on a given service.
+They're stored as:
+
+======================= ======== =======================================
+PID element position content
+======================= ======== =======================================
+pids[DMX_PES_AUDIO] 0 first audio PID
+pids[DMX_PES_VIDEO] 1 first video PID
+pids[DMX_PES_TELETEXT] 2 first teletext PID
+pids[DMX_PES_SUBTITLE] 3 first subtitle PID
+pids[DMX_PES_PCR] 4 first Program Clock Reference PID
+======================= ======== =======================================
+
+
+.. note::
+
+ A value equal to 0xffff means that the PID was not filled by the
+ Kernel.
Return Value
--
2.13.5
next prev parent reply other threads:[~2017-09-01 19:41 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-01 19:37 [PATCH 00/14] Another set of DVB documentation patches Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 01/14] media: dvb uapi docs: better organize header files Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 02/14] media: gen-errors.rst: remove row number comments Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 03/14] media: gen-errors.rst: document ENXIO error code Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 04/14] media: dvb uAPI docs: adjust return value ioctl descriptions Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 05/14] media: ca-fopen.rst: Fixes the device node name for CA Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 06/14] media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 07/14] media: dmx-fread.rst: specify how DMX_CHECK_CRC works Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 08/14] media: dvb-frontend-parameters.rst: fix the name of a struct Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 09/14] media: dvbapi.rst: add an entry to DVB revision history Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 10/14] media: dvb uAPI docs: minor editorial changes Mauro Carvalho Chehab
2017-09-01 19:37 ` Mauro Carvalho Chehab [this message]
2017-09-01 19:37 ` [PATCH 12/14] media: dvbstb.svg: use dots for the optional parts of the hardware Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 13/14] media: intro.rst: don't assume audio and video codecs to be MPEG2 Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 14/14] media: frontend.h: Avoid the term DVB when doesn't refer to a delivery system Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=dbbc595c0a13ca5121ba465b2db9a024584b44d0.1504293108.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®