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

[media] DocBook: update descriptions for the media controller entities

Cleanup the media controller entities description:
- remove MEDIA_ENT_T_DEVNODE and MEDIA_ENT_T_V4L2_SUBDEV entity
types, as they don't mean anything;
- add MEDIA_ENT_T_UNKNOWN with a proper description;
- remove ALSA and FB entity types. Those should not be used, as
the types are deprecated. We'll soon be adidng ALSA, but with
a different entity namespace;
- improve the description of some entities.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

+22 -25
+22 -25
Documentation/DocBook/media/v4l/media-ioc-enum-entities.xml
··· 179 179 <colspec colname="c2"/> 180 180 <tbody valign="top"> 181 181 <row> 182 - <entry><constant>MEDIA_ENT_T_DEVNODE</constant></entry> 183 - <entry>Unknown device node</entry> 182 + <entry><constant>MEDIA_ENT_T_UNKNOWN</constant> and <constant>MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN</constant></entry> 183 + <entry>Unknown entity. That generally indicates that 184 + a driver didn't initialize properly the entity, with is a Kernel bug</entry> 184 185 </row> 185 186 <row> 186 187 <entry><constant>MEDIA_ENT_T_V4L2_VIDEO</constant></entry> 187 - <entry>V4L video, radio or vbi device node</entry> 188 + <entry>V4L video streaming input or output entity</entry> 188 189 </row> 189 190 <row> 190 - <entry><constant>MEDIA_ENT_T_DEVNODE_FB</constant></entry> 191 - <entry>Frame buffer device node</entry> 191 + <entry><constant>MEDIA_ENT_T_V4L2_VBI</constant></entry> 192 + <entry>V4L VBI streaming input or output entity</entry> 192 193 </row> 193 194 <row> 194 - <entry><constant>MEDIA_ENT_T_DEVNODE_ALSA</constant></entry> 195 - <entry>ALSA card</entry> 195 + <entry><constant>MEDIA_ENT_T_V4L2_SWRADIO</constant></entry> 196 + <entry>V4L Software Digital Radio (SDR) streaming input or output entity</entry> 196 197 </row> 197 198 <row> 198 199 <entry><constant>MEDIA_ENT_T_DVB_DEMOD</constant></entry> 199 - <entry>DVB frontend devnode</entry> 200 + <entry>DVB demodulator entity</entry> 200 201 </row> 201 202 <row> 202 203 <entry><constant>MEDIA_ENT_T_DVB_DEMUX</constant></entry> 203 - <entry>DVB demux devnode</entry> 204 + <entry>DVB demux entity. Can be implemented in hardware or in Kernelspace</entry> 204 205 </row> 205 206 <row> 206 207 <entry><constant>MEDIA_ENT_T_DVB_TSOUT</constant></entry> 207 - <entry>DVB DVR devnode</entry> 208 + <entry>DVB Transport Stream output entity</entry> 208 209 </row> 209 210 <row> 210 211 <entry><constant>MEDIA_ENT_T_DVB_CA</constant></entry> 211 - <entry>DVB CAM devnode</entry> 212 + <entry>DVB Conditional Access module (CAM) entity</entry> 212 213 </row> 213 214 <row> 214 215 <entry><constant>MEDIA_ENT_T_DVB_DEMOD_NET_DECAP</constant></entry> 215 - <entry>DVB network devnode</entry> 216 - </row> 217 - <row> 218 - <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV</constant></entry> 219 - <entry>Unknown V4L sub-device</entry> 216 + <entry>DVB network ULE/MLE de-encapsulation entity. Can be implemented in hardware or in Kernelspace</entry> 220 217 </row> 221 218 <row> 222 219 <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_SENSOR</constant></entry> 223 - <entry>Video sensor</entry> 220 + <entry>Camera image sensor entity</entry> 224 221 </row> 225 222 <row> 226 223 <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_FLASH</constant></entry> 227 - <entry>Flash controller</entry> 224 + <entry>Flash controller entity</entry> 228 225 </row> 229 226 <row> 230 227 <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_LENS</constant></entry> 231 - <entry>Lens controller</entry> 228 + <entry>Lens controller entity</entry> 232 229 </row> 233 230 <row> 234 231 <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_DECODER</constant></entry> 235 - <entry>Video decoder, the basic function of the video decoder is to 236 - accept analogue video from a wide variety of sources such as 232 + <entry>Analog video decoder, the basic function of the video decoder 233 + is to accept analogue video from a wide variety of sources such as 237 234 broadcast, DVD players, cameras and video cassette recorders, in 238 - either NTSC, PAL or HD format and still occasionally SECAM, separate 239 - it into its component parts, luminance and chrominance, and output 240 - it in some digital video standard, with appropriate embedded timing 235 + either NTSC, PAL, SECAM or HD format, separating the stream 236 + into its component parts, luminance and chrominance, and output 237 + it in some digital video standard, with appropriate timing 241 238 signals.</entry> 242 239 </row> 243 240 <row> 244 241 <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_TUNER</constant></entry> 245 - <entry>TV and/or radio tuner</entry> 242 + <entry>Digital TV, analog TV, radio and/or software radio tuner</entry> 246 243 </row> 247 244 </tbody> 248 245 </tgroup>