Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d27518ca authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: fix FE_READ_STATUS argument description 



What's written there about the arguments for this ioctl
is bogus: it doesn't return an enum (or a typedef)
for enum fe_status. Instead, it returns a bitmask with the
values defined by enum fe_status.

Also, the size of the integer returned is not 16 bits, but,
instead, sizeof(fe_status_t), e. g. sizeof(enum), with is
arch-dependent.

This should of course be fixed, but this should be done on
a separate patch.

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

Documentation/DocBook/media/dvb/fe-read-status.xml

+12 −8
Original line number Original line Diff line number Diff line
@@ -16,7 +16,7 @@ 
	<funcdef>int <function>ioctl</function></funcdef>

	<funcdef>int <function>ioctl</function></funcdef>

	<paramdef>int <parameter>fd</parameter></paramdef>

	<paramdef>int <parameter>fd</parameter></paramdef>

	<paramdef>int <parameter>request</parameter></paramdef>

	<paramdef>int <parameter>request</parameter></paramdef>

	<paramdef>&fe-status; *<parameter>argp</parameter></paramdef>

	<paramdef>unsigned int *<parameter>status</parameter></paramdef>

      </funcprototype>

      </funcprototype>

    </funcsynopsis>

    </funcsynopsis>

  </refsynopsisdiv>

  </refsynopsisdiv>
@@ -37,9 +37,10 @@ 
	</listitem>

	</listitem>

      </varlistentry>

      </varlistentry>

      <varlistentry>

      <varlistentry>

	<term><parameter>argp</parameter></term>

	<term><parameter>status</parameter></term>

	<listitem>

	<listitem>

	    <para>pointer to &fe-status;</para>

	    <para>pointer to a bitmask integer filled with the values defined by

		&fe-status;.</para>

	</listitem>

	</listitem>

      </varlistentry>

      </varlistentry>

    </variablelist>

    </variablelist>
@@ -51,16 +52,19 @@ 
    <para>All DVB frontend devices support the

    <para>All DVB frontend devices support the

<constant>FE_READ_STATUS</constant> ioctl. It is used to check about the

<constant>FE_READ_STATUS</constant> ioctl. It is used to check about the

locking status of the frontend after being tuned. The ioctl takes a

locking status of the frontend after being tuned. The ioctl takes a

pointer to a 16-bits number where the status will be written.

pointer to an integer where the status will be written.

&return-value-dvb;.

</para>

</para>

<para>NOTE: the size of status is actually sizeof(enum fe_status), with varies

    according with the architecture. This needs to be fixed in the future.</para>

&return-value-dvb;

</refsect1>

</refsect1>





<section id="fe-status-t">

<section id="fe-status-t">

<title>enum fe_status</title>

<title>int fe_status</title>





<para>The enum fe_status is used to indicate the current state

<para>The fe_status parameter is used to indicate the current state

    and/or state changes of the frontend hardware.</para>

    and/or state changes of the frontend hardware. It is produced using

    the &fe-status; values on a bitmask</para>





<table pgwide="1" frame="none" id="fe-status">

<table pgwide="1" frame="none" id="fe-status">

    <title>enum fe_status</title>

    <title>enum fe_status</title>