5fec921f49
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: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
181 lines
5.3 KiB
XML
181 lines
5.3 KiB
XML
<refentry id="media-ioc-enum-entities">
|
|
<refmeta>
|
|
<refentrytitle>ioctl MEDIA_IOC_ENUM_ENTITIES</refentrytitle>
|
|
&manvol;
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>MEDIA_IOC_ENUM_ENTITIES</refname>
|
|
<refpurpose>Enumerate entities and their properties</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>int <function>ioctl</function></funcdef>
|
|
<paramdef>int <parameter>fd</parameter></paramdef>
|
|
<paramdef>int <parameter>request</parameter></paramdef>
|
|
<paramdef>struct media_entity_desc *<parameter>argp</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Arguments</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>fd</parameter></term>
|
|
<listitem>
|
|
<para>File descriptor returned by
|
|
<link linkend='media-func-open'><function>open()</function></link>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>request</parameter></term>
|
|
<listitem>
|
|
<para>MEDIA_IOC_ENUM_ENTITIES</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>argp</parameter></term>
|
|
<listitem>
|
|
<para></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>To query the attributes of an entity, applications set the id field
|
|
of a &media-entity-desc; structure and call the MEDIA_IOC_ENUM_ENTITIES
|
|
ioctl with a pointer to this structure. The driver fills the rest of the
|
|
structure or returns an &EINVAL; when the id is invalid.</para>
|
|
<para>Entities can be enumerated by or'ing the id with the
|
|
<constant>MEDIA_ENT_ID_FLAG_NEXT</constant> flag. The driver will return
|
|
information about the entity with the smallest id strictly larger than the
|
|
requested one ('next entity'), or the &EINVAL; if there is none.</para>
|
|
<para>Entity IDs can be non-contiguous. Applications must
|
|
<emphasis>not</emphasis> try to enumerate entities by calling
|
|
MEDIA_IOC_ENUM_ENTITIES with increasing id's until they get an error.</para>
|
|
|
|
<table pgwide="1" frame="none" id="media-entity-desc">
|
|
<title>struct <structname>media_entity_desc</structname></title>
|
|
<tgroup cols="5">
|
|
<colspec colname="c1" />
|
|
<colspec colname="c2" />
|
|
<colspec colname="c3" />
|
|
<colspec colname="c4" />
|
|
<colspec colname="c5" />
|
|
<tbody valign="top">
|
|
<row>
|
|
<entry>__u32</entry>
|
|
<entry><structfield>id</structfield></entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>Entity id, set by the application. When the id is or'ed with
|
|
<constant>MEDIA_ENT_ID_FLAG_NEXT</constant>, the driver clears the
|
|
flag and returns the first entity with a larger id.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>char</entry>
|
|
<entry><structfield>name</structfield>[32]</entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>Entity name as an UTF-8 NULL-terminated string.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>__u32</entry>
|
|
<entry><structfield>type</structfield></entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>Entity type, see <xref linkend="media-entity-type" /> for details.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>__u32</entry>
|
|
<entry><structfield>revision</structfield></entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>Entity revision. Always zero (obsolete)</entry>
|
|
</row>
|
|
<row>
|
|
<entry>__u32</entry>
|
|
<entry><structfield>flags</structfield></entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>Entity flags, see <xref linkend="media-entity-flag" /> for details.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>__u32</entry>
|
|
<entry><structfield>group_id</structfield></entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>Entity group ID. Always zero (obsolete)</entry>
|
|
</row>
|
|
<row>
|
|
<entry>__u16</entry>
|
|
<entry><structfield>pads</structfield></entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>Number of pads</entry>
|
|
</row>
|
|
<row>
|
|
<entry>__u16</entry>
|
|
<entry><structfield>links</structfield></entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>Total number of outbound links. Inbound links are not counted
|
|
in this field.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>union</entry>
|
|
</row>
|
|
<row>
|
|
<entry></entry>
|
|
<entry>struct</entry>
|
|
<entry><structfield>dev</structfield></entry>
|
|
<entry></entry>
|
|
<entry>Valid for (sub-)devices that create a single device node.</entry>
|
|
</row>
|
|
<row>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>__u32</entry>
|
|
<entry><structfield>major</structfield></entry>
|
|
<entry>Device node major number.</entry>
|
|
</row>
|
|
<row>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
<entry>__u32</entry>
|
|
<entry><structfield>minor</structfield></entry>
|
|
<entry>Device node minor number.</entry>
|
|
</row>
|
|
<row>
|
|
<entry></entry>
|
|
<entry>__u8</entry>
|
|
<entry><structfield>raw</structfield>[184]</entry>
|
|
<entry></entry>
|
|
<entry></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
&return-value;
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><errorcode>EINVAL</errorcode></term>
|
|
<listitem>
|
|
<para>The &media-entity-desc; <structfield>id</structfield> references
|
|
a non-existing entity.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
</refentry>
|