diff options
Diffstat (limited to 'Documentation/media/uapi/dvb/fe-read-signal-strength.rst')
| -rw-r--r-- | Documentation/media/uapi/dvb/fe-read-signal-strength.rst | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/Documentation/media/uapi/dvb/fe-read-signal-strength.rst b/Documentation/media/uapi/dvb/fe-read-signal-strength.rst new file mode 100644 index 000000000000..0cdee2effc97 --- /dev/null +++ b/Documentation/media/uapi/dvb/fe-read-signal-strength.rst @@ -0,0 +1,63 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _FE_READ_SIGNAL_STRENGTH: + +*********************** +FE_READ_SIGNAL_STRENGTH +*********************** + +Name +==== + +FE_READ_SIGNAL_STRENGTH + + +Synopsis +======== + +.. cpp:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength) + + +Arguments +========= + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + + - .. row 1 + + - int fd + + - File descriptor returned by a previous call to open(). + + - .. row 2 + + - int request + + - Equals + :ref:`FE_READ_SIGNAL_STRENGTH` + for this command. + + - .. row 3 + + - uint16_t \*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. |