doc-rst: linux_tv: simplify references
[deliverable/linux.git] / Documentation / linux_tv / media / 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
9DESCRIPTION
10
11This ioctl call returns the bit error rate for the signal currently
12received/demodulated by the front-end. For this command, read-only
13access to the device is sufficient.
14
15SYNOPSIS
16
7347081e 17int ioctl(int fd, int request = :ref:`FE_READ_BER`,
5377d91f
MH
18uint32_t *ber);
19
20PARAMETERS
21
22
23
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
7347081e 39 - Equals :ref:`FE_READ_BER` for this command.
5377d91f
MH
40
41 - .. row 3
42
43 - uint32_t *ber
44
45 - The bit error rate is stored into *ber.
46
47
48RETURN VALUE
49
50On success 0 is returned, on error -1 and the ``errno`` variable is set
51appropriately. The generic error codes are described at the
52:ref:`Generic Error Codes <gen-errors>` chapter.
53
54
55.. ------------------------------------------------------------------------------
56.. This file was automatically converted from DocBook-XML with the dbxml
57.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
58.. from the linux kernel, refer to:
59..
60.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
61.. ------------------------------------------------------------------------------
This page took 0.026824 seconds and 5 git commands to generate.