Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

media: dmx-get-pes-pids.rst: document the ioctl

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>

+20 -2
+20 -2
Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
··· 25 25 File descriptor returned by :c:func:`open() <dvb-dmx-open>`. 26 26 27 27 ``pids`` 28 - Undocumented. 28 + Array used to store 5 Program IDs. 29 29 30 30 31 31 Description 32 32 ----------- 33 33 34 - .. note:: This ioctl is undocumented. Documentation is welcome. 34 + This ioctl allows to query a DVB device to return the first PID used 35 + by audio, video, textext, subtitle and PCR programs on a given service. 36 + They're stored as: 37 + 38 + ======================= ======== ======================================= 39 + PID element position content 40 + ======================= ======== ======================================= 41 + pids[DMX_PES_AUDIO] 0 first audio PID 42 + pids[DMX_PES_VIDEO] 1 first video PID 43 + pids[DMX_PES_TELETEXT] 2 first teletext PID 44 + pids[DMX_PES_SUBTITLE] 3 first subtitle PID 45 + pids[DMX_PES_PCR] 4 first Program Clock Reference PID 46 + ======================= ======== ======================================= 47 + 48 + 49 + .. note:: 50 + 51 + A value equal to 0xffff means that the PID was not filled by the 52 + Kernel. 35 53 36 54 37 55 Return Value