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