| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | |
| 3 | .. _FE_READ_SIGNAL_STRENGTH: |
| 4 | |
| 5 | *********************** |
| 6 | FE_READ_SIGNAL_STRENGTH |
| 7 | *********************** |
| 8 | |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 9 | NAME |
| 10 | ==== |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 11 | |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 12 | FE_READ_SIGNAL_STRENGTH |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 13 | |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 14 | SYNOPSIS |
| 15 | ======== |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 16 | |
| Mauro Carvalho Chehab | 5d468e2 | 2016-07-04 12:31:15 -0300 | [diff] [blame] | 17 | .. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength) |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 18 | |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 19 | |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 20 | ARGUMENTS |
| 21 | ========= |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 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 |
| Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 39 | :ref:`FE_READ_SIGNAL_STRENGTH` |
| 40 | for this command. |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 41 | |
| 42 | - .. row 3 |
| 43 | |
| Mauro Carvalho Chehab | 5d468e2 | 2016-07-04 12:31:15 -0300 | [diff] [blame] | 44 | - uint16_t \*strength |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 45 | |
| Mauro Carvalho Chehab | 5d468e2 | 2016-07-04 12:31:15 -0300 | [diff] [blame] | 46 | - The signal strength value is stored into \*strength. |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 47 | |
| 48 | |
| Mauro Carvalho Chehab | 586027c | 2016-07-05 07:58:48 -0300 | [diff] [blame] | 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 | ============ |
| Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 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. |