1<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>ioctl FE_READ_STATUS</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="LINUX MEDIA INFRASTRUCTURE API"><link rel="up" href="frontend_fcalls.html" title="Frontend Function Calls"><link rel="prev" href="FE_GET_INFO.html" title="ioctl FE_GET_INFO"><link rel="next" href="FE_GET_PROPERTY.html" title="ioctl FE_SET_PROPERTY, FE_GET_PROPERTY"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">ioctl FE_READ_STATUS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="FE_GET_INFO.html">Prev</a> </td><th width="60%" align="center">Frontend Function Calls</th><td width="20%" align="right"> <a accesskey="n" href="FE_GET_PROPERTY.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="FE_READ_STATUS"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>FE_READ_STATUS — Returns status information about the front-end. This call only
2 requires read-only access to the device</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">ioctl</b>(</code></td><td>int <var class="pdparam">fd</var>, </td></tr><tr><td> </td><td>int <var class="pdparam">request</var>, </td></tr><tr><td> </td><td>unsigned int *<var class="pdparam">status</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="id-1.5.5.12.5.4"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>fd</code></em></span></dt><dd><p>File descriptor returned by <a class="link" href="frontend_f_open.html" title="DVB frontend open()"><code class="function">open()</code></a>.</p></dd><dt><span class="term"><em class="parameter"><code>request</code></em></span></dt><dd><p>FE_READ_STATUS</p></dd><dt><span class="term"><em class="parameter"><code>status</code></em></span></dt><dd><p>pointer to a bitmask integer filled with the values defined by
3		enum <a class="link" href="FE_READ_STATUS.html#fe-status" title="Table 9.19. enum fe_status">fe_status</a>.</p></dd></dl></div></div><div class="refsect1"><a name="id-1.5.5.12.5.5"></a><h2>Description</h2><p>All DVB frontend devices support the
4<code class="constant">FE_READ_STATUS</code> ioctl. It is used to check about the
5locking status of the frontend after being tuned. The ioctl takes a
6pointer to an integer where the status will be written.
7</p><p>NOTE: the size of status is actually sizeof(enum fe_status), with varies
8    according with the architecture. This needs to be fixed in the future.</p><p>RETURN VALUE</p><p>On success <span class="returnvalue">0</span> is returned, on error <span class="returnvalue">-1</span> and the <code class="varname">errno</code> variable is set appropriately. The generic error codes are described at the <a class="link" href="gen_errors.html#gen-errors" title="Table 17.1. Generic error codes">Generic Error Codes</a> chapter.</p></div><div class="refsect1"><a name="fe-status-t"></a><h2>int fe_status</h2><p>The fe_status parameter is used to indicate the current state
9    and/or state changes of the frontend hardware. It is produced using
10    the enum <a class="link" href="FE_READ_STATUS.html#fe-status" title="Table 9.19. enum fe_status">fe_status</a> values on a bitmask</p><div class="table"><a name="fe-status"></a><p class="title"><b>Table 9.19. enum fe_status</b></p><div class="table-contents"><table summary="enum fe_status" width="100%" border="0"><colgroup><col class="c1"><col class="c2"></colgroup><thead><tr><th>ID</th><th>Description</th></tr></thead><tbody valign="top"><tr><td align="char" valign="top"><a name="FE-HAS-SIGNAL"></a><code class="constant">FE_HAS_SIGNAL</code></td><td align="char" valign="top">The frontend has found something above the noise level</td></tr><tr><td align="char" valign="top"><a name="FE-HAS-CARRIER"></a><code class="constant">FE_HAS_CARRIER</code></td><td align="char" valign="top">The frontend has found a DVB signal</td></tr><tr><td align="char" valign="top"><a name="FE-HAS-VITERBI"></a><code class="constant">FE_HAS_VITERBI</code></td><td align="char" valign="top">The frontend FEC inner coding (Viterbi, LDPC or other inner code) is stable</td></tr><tr><td align="char" valign="top"><a name="FE-HAS-SYNC"></a><code class="constant">FE_HAS_SYNC</code></td><td align="char" valign="top">Synchronization bytes was found</td></tr><tr><td align="char" valign="top"><a name="FE-HAS-LOCK"></a><code class="constant">FE_HAS_LOCK</code></td><td align="char" valign="top">The DVB were locked and everything is working</td></tr><tr><td align="char" valign="top"><a name="FE-TIMEDOUT"></a><code class="constant">FE_TIMEDOUT</code></td><td align="char" valign="top">no lock within the last about 2 seconds</td></tr><tr><td align="char" valign="top"><a name="FE-REINIT"></a><code class="constant">FE_REINIT</code></td><td align="char" valign="top">The frontend was reinitialized, application is
11	    recommended to reset DiSEqC, tone and parameters</td></tr></tbody></table></div></div><br class="table-break"></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="FE_GET_INFO.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="frontend_fcalls.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="FE_GET_PROPERTY.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">ioctl FE_GET_INFO </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> ioctl FE_SET_PROPERTY, FE_GET_PROPERTY</td></tr></table></div></body></html>
12