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

[media] DocBook: document DVB DMX_[ADD|REMOVE]_PID

Those ioctls were added back in 2009, at changeset 1cb662a3144
but were never documented. Fortunately, the original commit is
good enough to serve as the basis for documenting it. Also, the
support for it is done by dmxdev implementation.

So, add a proper documentation for it, based on the description
of the original changeset.

Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>

Mauro Carvalho Chehab 4872b46b e6876692

+19 -4
+19 -4
Documentation/DocBook/media/dvb/demux.xml
··· 1042 1042 </para> 1043 1043 <informaltable><tgroup cols="1"><tbody><row><entry 1044 1044 align="char"> 1045 - <para>This ioctl is undocumented. Documentation is welcome.</para> 1045 + <para>This ioctl call allows to add multiple PIDs to a transport stream filter 1046 + previously set up with DMX_SET_PES_FILTER and output equal to DMX_OUT_TSDEMUX_TAP. 1047 + </para></entry></row><row><entry align="char"><para> 1048 + It is used by readers of /dev/dvb/adapterX/demuxY. 1049 + </para></entry></row><row><entry align="char"><para> 1050 + It may be called at any time, i.e. before or after the first filter on the 1051 + shared file descriptor was started. It makes it possible to record multiple 1052 + services without the need to de-multiplex or re-multiplex TS packets.</para> 1046 1053 </entry> 1047 1054 </row></tbody></tgroup></informaltable> 1048 1055 <para>SYNOPSIS ··· 1082 1075 </para> 1083 1076 </entry><entry 1084 1077 align="char"> 1085 - <para>Undocumented.</para> 1078 + <para>PID number to be filtered.</para> 1086 1079 </entry> 1087 1080 </row></tbody></tgroup></informaltable> 1088 1081 &return-value-dvb; ··· 1094 1087 </para> 1095 1088 <informaltable><tgroup cols="1"><tbody><row><entry 1096 1089 align="char"> 1097 - <para>This ioctl is undocumented. Documentation is welcome.</para> 1090 + <para>This ioctl call allows to remove a PID when multiple PIDs are set on a 1091 + transport stream filter, e. g. a filter previously set up with output equal to 1092 + DMX_OUT_TSDEMUX_TAP, created via either DMX_SET_PES_FILTER or DMX_ADD_PID. 1093 + </para></entry></row><row><entry align="char"><para> 1094 + It is used by readers of /dev/dvb/adapterX/demuxY. 1095 + </para></entry></row><row><entry align="char"><para> 1096 + It may be called at any time, i.e. before or after the first filter on the 1097 + shared file descriptor was started. It makes it possible to record multiple 1098 + services without the need to de-multiplex or re-multiplex TS packets.</para> 1098 1099 </entry> 1099 1100 </row></tbody></tgroup></informaltable> 1100 1101 <para>SYNOPSIS ··· 1135 1120 </para> 1136 1121 </entry><entry 1137 1122 align="char"> 1138 - <para>Undocumented.</para> 1123 + <para>PID of the PES filter to be removed.</para> 1139 1124 </entry> 1140 1125 </row></tbody></tgroup></informaltable> 1141 1126 &return-value-dvb;