Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _FE_READ_SNR: | |
4 | ||
5 | *********** | |
6 | FE_READ_SNR | |
7 | *********** | |
8 | ||
15e7d615 | 9 | Name |
586027ce | 10 | ==== |
5377d91f | 11 | |
586027ce | 12 | FE_READ_SNR |
5377d91f | 13 | |
cf8076c3 | 14 | .. attention:: This ioctl is deprecated. |
15e7d615 MCC |
15 | |
16 | Synopsis | |
586027ce | 17 | ======== |
5377d91f | 18 | |
cf8076c3 MCC |
19 | .. c:function:: int ioctl(int fd, FE_READ_SNR, int16_t *snr) |
20 | :name: FE_READ_SNR | |
5377d91f | 21 | |
5377d91f | 22 | |
15e7d615 | 23 | Arguments |
586027ce | 24 | ========= |
5377d91f | 25 | |
cf8076c3 MCC |
26 | ``fd`` |
27 | File descriptor returned by :c:func:`open() <dvb-fe-open>`. | |
5377d91f | 28 | |
cf8076c3 MCC |
29 | ``snr`` |
30 | The signal-to-noise ratio is stored into \*snr. | |
5377d91f MH |
31 | |
32 | ||
15e7d615 | 33 | Description |
586027ce MCC |
34 | =========== |
35 | ||
36 | This ioctl call returns the signal-to-noise ratio for the signal | |
37 | currently received by the front-end. For this command, read-only access | |
38 | to the device is sufficient. | |
39 | ||
40 | ||
15e7d615 | 41 | Return Value |
586027ce | 42 | ============ |
5377d91f MH |
43 | |
44 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
45 | appropriately. The generic error codes are described at the | |
46 | :ref:`Generic Error Codes <gen-errors>` chapter. |