summaryrefslogblamecommitdiffstats
path: root/Documentation/media/uapi/dvb/fe-read-signal-strength.rst
blob: 4b13c47577442143a982610f92ca16531d7fa6b4 (plain) (tree)
1
2
3
4
5
6
7
8
9







                                   
    
    
 
                       
 
                                        

        
        
 

                                                                               
 
 
         
         
 

                                                               
 

                                                        

 
           






                                                                       
            
            



                                                                       
.. -*- coding: utf-8; mode: rst -*-

.. _FE_READ_SIGNAL_STRENGTH:

***********************
FE_READ_SIGNAL_STRENGTH
***********************

Name
====

FE_READ_SIGNAL_STRENGTH

.. attention:: This ioctl is deprecated.

Synopsis
========

.. c:function:: int ioctl( int fd, FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
    :name: FE_READ_SIGNAL_STRENGTH


Arguments
=========

``fd``
    File descriptor returned by :c:func:`open() <dvb-fe-open>`.

``strength``
    The signal strength value is stored into \*strength.


Description
===========

This ioctl call returns the signal strength value for the signal
currently received by the front-end. For this command, read-only access
to the device is sufficient.


Return Value
============

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.