[media] docs-next: stop abusing on the cpp domain
[deliverable/linux.git] / Documentation / media / uapi / dvb / fe-read-ber.rst
CommitLineData
5377d91f
MH
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _FE_READ_BER:
4
5***********
6FE_READ_BER
7***********
8
15e7d615
MCC
9Name
10====
5377d91f 11
15e7d615 12FE_READ_BER
5377d91f 13
15e7d615
MCC
14Synopsis
15========
5377d91f 16
1b81f010 17.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
5377d91f 18
15e7d615 19
9e1f61c0 20Arguments
15e7d615 21=========
5377d91f 22
5377d91f
MH
23.. flat-table::
24 :header-rows: 0
25 :stub-columns: 0
26
27
28 - .. row 1
29
30 - int fd
31
32 - File descriptor returned by a previous call to open().
33
34 - .. row 2
35
36 - int request
37
7347081e 38 - Equals :ref:`FE_READ_BER` for this command.
5377d91f
MH
39
40 - .. row 3
41
9e1f61c0 42 - uint32_t \*ber
5377d91f 43
9e1f61c0 44 - The bit error rate is stored into \*ber.
5377d91f
MH
45
46
15e7d615
MCC
47Description
48===========
49
50This ioctl call returns the bit error rate for the signal currently
51received/demodulated by the front-end. For this command, read-only
52access to the device is sufficient.
53
54
9e1f61c0 55Return Value
15e7d615 56============
5377d91f
MH
57
58On success 0 is returned, on error -1 and the ``errno`` variable is set
59appropriately. The generic error codes are described at the
60:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.059885 seconds and 5 git commands to generate.