[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>
This commit is contained in:
Mauro Carvalho Chehab 2015-05-07 22:12:40 -03:00
parent 4376679a34
commit 4ae1723af8

View file

@ -179,70 +179,67 @@
<colspec colname="c2"/> <colspec colname="c2"/>
<tbody valign="top"> <tbody valign="top">
<row> <row>
<entry><constant>MEDIA_ENT_T_DEVNODE</constant></entry> <entry><constant>MEDIA_ENT_T_UNKNOWN</constant> and <constant>MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN</constant></entry>
<entry>Unknown device node</entry> <entry>Unknown entity. That generally indicates that
a driver didn't initialize properly the entity, with is a Kernel bug</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_V4L2_VIDEO</constant></entry> <entry><constant>MEDIA_ENT_T_V4L2_VIDEO</constant></entry>
<entry>V4L video, radio or vbi device node</entry> <entry>V4L video streaming input or output entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_DEVNODE_FB</constant></entry> <entry><constant>MEDIA_ENT_T_V4L2_VBI</constant></entry>
<entry>Frame buffer device node</entry> <entry>V4L VBI streaming input or output entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_DEVNODE_ALSA</constant></entry> <entry><constant>MEDIA_ENT_T_V4L2_SWRADIO</constant></entry>
<entry>ALSA card</entry> <entry>V4L Software Digital Radio (SDR) streaming input or output entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_DVB_DEMOD</constant></entry> <entry><constant>MEDIA_ENT_T_DVB_DEMOD</constant></entry>
<entry>DVB frontend devnode</entry> <entry>DVB demodulator entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_DVB_DEMUX</constant></entry> <entry><constant>MEDIA_ENT_T_DVB_DEMUX</constant></entry>
<entry>DVB demux devnode</entry> <entry>DVB demux entity. Can be implemented in hardware or in Kernelspace</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_DVB_TSOUT</constant></entry> <entry><constant>MEDIA_ENT_T_DVB_TSOUT</constant></entry>
<entry>DVB DVR devnode</entry> <entry>DVB Transport Stream output entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_DVB_CA</constant></entry> <entry><constant>MEDIA_ENT_T_DVB_CA</constant></entry>
<entry>DVB CAM devnode</entry> <entry>DVB Conditional Access module (CAM) entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_DVB_DEMOD_NET_DECAP</constant></entry> <entry><constant>MEDIA_ENT_T_DVB_DEMOD_NET_DECAP</constant></entry>
<entry>DVB network devnode</entry> <entry>DVB network ULE/MLE de-encapsulation entity. Can be implemented in hardware or in Kernelspace</entry>
</row>
<row>
<entry><constant>MEDIA_ENT_T_V4L2_SUBDEV</constant></entry>
<entry>Unknown V4L sub-device</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_SENSOR</constant></entry> <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_SENSOR</constant></entry>
<entry>Video sensor</entry> <entry>Camera image sensor entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_FLASH</constant></entry> <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_FLASH</constant></entry>
<entry>Flash controller</entry> <entry>Flash controller entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_LENS</constant></entry> <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_LENS</constant></entry>
<entry>Lens controller</entry> <entry>Lens controller entity</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_DECODER</constant></entry> <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_DECODER</constant></entry>
<entry>Video decoder, the basic function of the video decoder is to <entry>Analog video decoder, the basic function of the video decoder
accept analogue video from a wide variety of sources such as is to accept analogue video from a wide variety of sources such as
broadcast, DVD players, cameras and video cassette recorders, in broadcast, DVD players, cameras and video cassette recorders, in
either NTSC, PAL or HD format and still occasionally SECAM, separate either NTSC, PAL, SECAM or HD format, separating the stream
it into its component parts, luminance and chrominance, and output into its component parts, luminance and chrominance, and output
it in some digital video standard, with appropriate embedded timing it in some digital video standard, with appropriate timing
signals.</entry> signals.</entry>
</row> </row>
<row> <row>
<entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_TUNER</constant></entry> <entry><constant>MEDIA_ENT_T_V4L2_SUBDEV_TUNER</constant></entry>
<entry>TV and/or radio tuner</entry> <entry>Digital TV, analog TV, radio and/or software radio tuner</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>