projects / mirror_ubuntu-artful-kernel.git / blame
| 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 | ||
| 15e7d615 | 9 | Name |
| 586027ce | 10 | ==== |
| 5377d91f | 11 | |
| 586027ce | 12 | FE_READ_SIGNAL_STRENGTH |
| 5377d91f | 13 | |
| 15e7d615 MCC |
14 | |
| 15 | Synopsis | |
| 586027ce | 16 | ======== |
| 5377d91f | 17 | |
| 5929cb17 | 18 | .. cpp:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength) |
| 5377d91f | 19 | |
| 5377d91f | 20 | |
| 15e7d615 | 21 | Arguments |
| 586027ce | 22 | ========= |
| 5377d91f MH |
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 | ||
| 39 | - Equals | |
| 0579e6e3 MCC |
40 | :ref:`FE_READ_SIGNAL_STRENGTH` |
| 41 | for this command. | |
| 5377d91f MH |
42 | |
| 43 | - .. row 3 | |
| 44 | ||
| 5d468e2b | 45 | - uint16_t \*strength |
| 5377d91f | 46 | |
| 5d468e2b | 47 | - The signal strength value is stored into \*strength. |
| 5377d91f MH |
48 | |
| 49 | ||
| 15e7d615 | 50 | Description |
| 586027ce MCC |
51 | =========== |
| 52 | ||
| 53 | This ioctl call returns the signal strength value for the signal | |
| 54 | currently received by the front-end. For this command, read-only access | |
| 55 | to the device is sufficient. | |
| 56 | ||
| 57 | ||
| 15e7d615 | 58 | Return Value |
| 586027ce | 59 | ============ |
| 5377d91f MH |
60 | |
| 61 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 62 | appropriately. The generic error codes are described at the | |
| 63 | :ref:`Generic Error Codes <gen-errors>` chapter. |