Commit 5fec921f authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: move data types to a separate section 



As MEDIA_IOC_G_TOPOLOGY shares the data types already declared
for entities, pads and links, we should move those to a separate
part of the document, and use cross-references where needed.

So, move the following tables to a separate section at the
DocBook:
	media-entity-type
	media-entity-flag
	media-pad-flag
	media-link-flag

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent b7870d69

Documentation/DocBook/media/v4l/media-controller.xml

+3 −0
Original line number Diff line number Diff line
@@ -85,6 +85,9 @@ 
    Kernel interface and an entity.m</para></listitem>

    </itemizedlist>

  </section>



  <!-- All non-ioctl specific data types go here. -->

  &sub-media-types;

</chapter>



<appendix id="media-user-func">

Documentation/DocBook/media/v4l/media-ioc-enum-entities.xml

+0 −104
Original line number Diff line number Diff line
@@ -162,110 +162,6 @@ 
	</tbody>

      </tgroup>

    </table>



    <table frame="none" pgwide="1" id="media-entity-type">

      <title>Media entity types</title>

      <tgroup cols="2">

        <colspec colname="c1"/>

        <colspec colname="c2"/>

	<tbody valign="top">

	  <row>

	    <entry><constant>MEDIA_ENT_F_UNKNOWN</constant> and <constant>MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN</constant></entry>

	    <entry>Unknown entity. That generally indicates that

	    a driver didn't initialize properly the entity, with is a Kernel bug</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_IO_V4L</constant></entry>

	    <entry>Data streaming input and/or output entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_IO_VBI</constant></entry>

	    <entry>V4L VBI streaming input or output entity</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_IO_SWRADIO</constant></entry>

	    <entry>V4L Software Digital Radio (SDR) streaming input or output entity</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_IO_DTV</constant></entry>

	    <entry>DVB Digital TV streaming input or output entity</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_DTV_DEMOD</constant></entry>

	    <entry>Digital TV demodulator entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_MPEG_TS_DEMUX</constant></entry>

	    <entry>MPEG Transport stream demux entity. Could be implemented on hardware or in Kernelspace by the Linux DVB subsystem.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_DTV_CA</constant></entry>

	    <entry>Digital TV Conditional Access module (CAM) entity</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_DTV_NET_DECAP</constant></entry>

	    <entry>Digital TV network ULE/MLE desencapsulation entity. Could be implemented on hardware or in Kernelspace</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CONN_RF</constant></entry>

	    <entry>Connector for a Radio Frequency (RF) signal.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CONN_SVIDEO</constant></entry>

	    <entry>Connector for a S-Video signal.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CONN_COMPOSITE</constant></entry>

	    <entry>Connector for a RGB composite signal.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CONN_TEST</constant></entry>

	    <entry>Connector for a test generator.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CAM_SENSOR</constant></entry>

	    <entry>Camera video sensor entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_FLASH</constant></entry>

	    <entry>Flash controller entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_LENS</constant></entry>

	    <entry>Lens controller entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_ATV_DECODER</constant></entry>

	    <entry>Analog video decoder, the basic function of the video decoder

	    is to accept analogue video from a wide variety of sources such as

	    broadcast, DVD players, cameras and video cassette recorders, in

	    either NTSC, PAL, SECAM or HD format, separating the stream

	    into its component parts, luminance and chrominance, and output

	    it in some digital video standard, with appropriate timing

	    signals.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_TUNER</constant></entry>

	    <entry>Digital TV, analog TV, radio and/or software radio tuner.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



    <table frame="none" pgwide="1" id="media-entity-flag">

      <title>Media entity flags</title>

      <tgroup cols="2">

        <colspec colname="c1"/>

        <colspec colname="c2"/>

	<tbody valign="top">

	  <row>

	    <entry><constant>MEDIA_ENT_FL_DEFAULT</constant></entry>

	    <entry>Default entity for its type. Used to discover the default

	    audio, VBI and video devices, the default camera sensor, ...</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>

  </refsect1>



  <refsect1>

Documentation/DocBook/media/v4l/media-ioc-enum-links.xml

+0 −56
Original line number Diff line number Diff line
@@ -118,35 +118,6 @@ 
      </tgroup>

    </table>



    <table frame="none" pgwide="1" id="media-pad-flag">

      <title>Media pad flags</title>

      <tgroup cols="2">

        <colspec colname="c1"/>

        <colspec colname="c2"/>

	<tbody valign="top">

	  <row>

	    <entry><constant>MEDIA_PAD_FL_SINK</constant></entry>

	    <entry>Input pad, relative to the entity. Input pads sink data and

	    are targets of links.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_PAD_FL_SOURCE</constant></entry>

	    <entry>Output pad, relative to the entity. Output pads source data

	    and are origins of links.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_PAD_FL_MUST_CONNECT</constant></entry>

	    <entry>If this flag is set and the pad is linked to any other

	    pad, then at least one of those links must be enabled for the

	    entity to be able to stream. There could be temporary reasons

	    (e.g. device configuration dependent) for the pad to need

	    enabled links even when this flag isn't set; the absence of the

	    flag doesn't imply there is none.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



    <table pgwide="1" frame="none" id="media-link-desc">

      <title>struct <structname>media_link_desc</structname></title>

      <tgroup cols="3">
@@ -171,33 +142,6 @@ 
      </tgroup>

    </table>



    <table frame="none" pgwide="1" id="media-link-flag">

      <title>Media link flags</title>

      <tgroup cols="2">

        <colspec colname="c1"/>

        <colspec colname="c2"/>

	<tbody valign="top">

	  <row>

	    <entry><constant>MEDIA_LNK_FL_ENABLED</constant></entry>

	    <entry>The link is enabled and can be used to transfer media data.

	    When two or more links target a sink pad, only one of them can be

	    enabled at a time.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_LNK_FL_IMMUTABLE</constant></entry>

	    <entry>The link enabled state can't be modified at runtime. An

	    immutable link is always enabled.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_LNK_FL_DYNAMIC</constant></entry>

	    <entry>The link enabled state can be modified during streaming. This

	    flag is set by drivers and is read-only for applications.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>

    <para>One and only one of <constant>MEDIA_PAD_FL_SINK</constant> and

    <constant>MEDIA_PAD_FL_SOURCE</constant> must be set for every pad.</para>

  </refsect1>



  <refsect1>

Documentation/DocBook/media/v4l/media-types.xml

0 → 100644
+166 −0
Original line number Diff line number Diff line 
<section id="media-controller-types">

<title>Types and flags used to represent the media graph elements</title>



    <table frame="none" pgwide="1" id="media-entity-type">

      <title>Media entity types</title>

      <tgroup cols="2">

	<colspec colname="c1"/>

	<colspec colname="c2"/>

	<tbody valign="top">

	  <row>

	    <entry><constant>MEDIA_ENT_F_UNKNOWN</constant> and <constant>MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN</constant></entry>

	    <entry>Unknown entity. That generally indicates that

	    a driver didn't initialize properly the entity, with is a Kernel bug</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_IO_V4L</constant></entry>

	    <entry>Data streaming input and/or output entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_IO_VBI</constant></entry>

	    <entry>V4L VBI streaming input or output entity</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_IO_SWRADIO</constant></entry>

	    <entry>V4L Software Digital Radio (SDR) streaming input or output entity</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_IO_DTV</constant></entry>

	    <entry>DVB Digital TV streaming input or output entity</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_DTV_DEMOD</constant></entry>

	    <entry>Digital TV demodulator entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_MPEG_TS_DEMUX</constant></entry>

	    <entry>MPEG Transport stream demux entity. Could be implemented on hardware or in Kernelspace by the Linux DVB subsystem.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_DTV_CA</constant></entry>

	    <entry>Digital TV Conditional Access module (CAM) entity</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_DTV_NET_DECAP</constant></entry>

	    <entry>Digital TV network ULE/MLE desencapsulation entity. Could be implemented on hardware or in Kernelspace</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CONN_RF</constant></entry>

	    <entry>Connector for a Radio Frequency (RF) signal.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CONN_SVIDEO</constant></entry>

	    <entry>Connector for a S-Video signal.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CONN_COMPOSITE</constant></entry>

	    <entry>Connector for a RGB composite signal.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CONN_TEST</constant></entry>

	    <entry>Connector for a test generator.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_CAM_SENSOR</constant></entry>

	    <entry>Camera video sensor entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_FLASH</constant></entry>

	    <entry>Flash controller entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_LENS</constant></entry>

	    <entry>Lens controller entity.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_ATV_DECODER</constant></entry>

	    <entry>Analog video decoder, the basic function of the video decoder

	    is to accept analogue video from a wide variety of sources such as

	    broadcast, DVD players, cameras and video cassette recorders, in

	    either NTSC, PAL, SECAM or HD format, separating the stream

	    into its component parts, luminance and chrominance, and output

	    it in some digital video standard, with appropriate timing

	    signals.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_ENT_F_TUNER</constant></entry>

	    <entry>Digital TV, analog TV, radio and/or software radio tuner.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



    <table frame="none" pgwide="1" id="media-entity-flag">

      <title>Media entity flags</title>

      <tgroup cols="2">

	<colspec colname="c1"/>

	<colspec colname="c2"/>

	<tbody valign="top">

	  <row>

	    <entry><constant>MEDIA_ENT_FL_DEFAULT</constant></entry>

	    <entry>Default entity for its type. Used to discover the default

	    audio, VBI and video devices, the default camera sensor, ...</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



    <table frame="none" pgwide="1" id="media-pad-flag">

      <title>Media pad flags</title>

      <tgroup cols="2">

	<colspec colname="c1"/>

	<colspec colname="c2"/>

	<tbody valign="top">

	  <row>

	    <entry><constant>MEDIA_PAD_FL_SINK</constant></entry>

	    <entry>Input pad, relative to the entity. Input pads sink data and

	    are targets of links.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_PAD_FL_SOURCE</constant></entry>

	    <entry>Output pad, relative to the entity. Output pads source data

	    and are origins of links.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_PAD_FL_MUST_CONNECT</constant></entry>

	    <entry>If this flag is set and the pad is linked to any other

	    pad, then at least one of those links must be enabled for the

	    entity to be able to stream. There could be temporary reasons

	    (e.g. device configuration dependent) for the pad to need

	    enabled links even when this flag isn't set; the absence of the

	    flag doesn't imply there is none.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



    <para>One and only one of <constant>MEDIA_PAD_FL_SINK</constant> and

    <constant>MEDIA_PAD_FL_SOURCE</constant> must be set for every pad.</para>



    <table frame="none" pgwide="1" id="media-link-flag">

      <title>Media link flags</title>

      <tgroup cols="2">

	<colspec colname="c1"/>

	<colspec colname="c2"/>

	<tbody valign="top">

	  <row>

	    <entry><constant>MEDIA_LNK_FL_ENABLED</constant></entry>

	    <entry>The link is enabled and can be used to transfer media data.

	    When two or more links target a sink pad, only one of them can be

	    enabled at a time.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_LNK_FL_IMMUTABLE</constant></entry>

	    <entry>The link enabled state can't be modified at runtime. An

	    immutable link is always enabled.</entry>

	  </row>

	  <row>

	    <entry><constant>MEDIA_LNK_FL_DYNAMIC</constant></entry>

	    <entry>The link enabled state can be modified during streaming. This

	    flag is set by drivers and is read-only for applications.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



</section>

CRA Git | Maintained and supported by SUSTech CRA and CCSE