Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _FE_READ_SIGNAL_STRENGTH: | |
4 | ||
5 | *********************** | |
6 | FE_READ_SIGNAL_STRENGTH | |
7 | *********************** | |
8 | ||
586027ce MCC |
9 | NAME |
10 | ==== | |
5377d91f | 11 | |
586027ce | 12 | FE_READ_SIGNAL_STRENGTH |
5377d91f | 13 | |
586027ce MCC |
14 | SYNOPSIS |
15 | ======== | |
5377d91f | 16 | |
5d468e2b | 17 | .. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength) |
5377d91f | 18 | |
5377d91f | 19 | |
586027ce MCC |
20 | ARGUMENTS |
21 | ========= | |
5377d91f MH |
22 | |
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 | ||
38 | - Equals | |
0579e6e3 MCC |
39 | :ref:`FE_READ_SIGNAL_STRENGTH` |
40 | for this command. | |
5377d91f MH |
41 | |
42 | - .. row 3 | |
43 | ||
5d468e2b | 44 | - uint16_t \*strength |
5377d91f | 45 | |
5d468e2b | 46 | - The signal strength value is stored into \*strength. |
5377d91f MH |
47 | |
48 | ||
586027ce MCC |
49 | DESCRIPTION |
50 | =========== | |
51 | ||
52 | This ioctl call returns the signal strength value for the signal | |
53 | currently received by the front-end. For this command, read-only access | |
54 | to the device is sufficient. | |
55 | ||
56 | ||
57 | RETURN VALUE | |
58 | ============ | |
5377d91f MH |
59 | |
60 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
61 | appropriately. The generic error codes are described at the | |
62 | :ref:`Generic Error Codes <gen-errors>` chapter. |