Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mszeredi...

[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / dmx-get-pes-pids.rst

diff --git a/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst b/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
index b31634a1cca4722e941e266e9b419a19ed88304d..fbdbc12869d1c7b88433e1226403df58944a510b 100644 (file)
--- a/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
+++ b/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
@@ -25,18 +25,40 @@ 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
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.