9e1f61c057
Parsing this file were causing lots of warnings with sphinx, due to the c function prototypes. Fix that by prepending them with .. c:function:: While here, use the same way we document man-like pages, at the V4L side of the book and add escapes to asterisks. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
55 lines
961 B
ReStructuredText
55 lines
961 B
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _FE_READ_BER:
|
|
|
|
***********
|
|
FE_READ_BER
|
|
***********
|
|
|
|
Description
|
|
-----------
|
|
|
|
This ioctl call returns the bit error rate for the signal currently
|
|
received/demodulated by the front-end. For this command, read-only
|
|
access to the device is sufficient.
|
|
|
|
SYNOPSIS
|
|
|
|
.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
|
|
|
|
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_BER` for this command.
|
|
|
|
- .. row 3
|
|
|
|
- uint32_t \*ber
|
|
|
|
- The bit error rate is stored into \*ber.
|
|
|
|
|
|
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.
|