projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| 5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | ||
| 3 | .. _FE_GET_PROPERTY: | |
| 4 | ||
| 5 | ************************************** | |
| 6 | ioctl FE_SET_PROPERTY, FE_GET_PROPERTY | |
| 7 | ************************************** | |
| 8 | ||
| 15e7d615 | 9 | Name |
| 586027ce | 10 | ==== |
| 5377d91f | 11 | |
| 586027ce | 12 | FE_SET_PROPERTY - FE_GET_PROPERTY - FE_SET_PROPERTY sets one or more frontend properties. - FE_GET_PROPERTY returns one or more frontend properties. |
| 5377d91f | 13 | |
| 15e7d615 MCC |
14 | |
| 15 | Synopsis | |
| 5377d91f MH |
16 | ======== |
| 17 | ||
| 1b81f010 | 18 | .. c:function:: int ioctl( int fd, int request, struct dtv_properties *argp ) |
| 5377d91f | 19 | |
| 586027ce | 20 | |
| 15e7d615 | 21 | Arguments |
| 5377d91f MH |
22 | ========= |
| 23 | ||
| 24 | ``fd`` | |
| 25 | File descriptor returned by :ref:`open() <frontend_f_open>`. | |
| 26 | ||
| 27 | ``request`` | |
| 28 | FE_SET_PROPERTY, FE_GET_PROPERTY | |
| 29 | ||
| 30 | ``argp`` | |
| 31 | pointer to struct :ref:`dtv_properties <dtv-properties>` | |
| 32 | ||
| 33 | ||
| 15e7d615 | 34 | Description |
| 5377d91f MH |
35 | =========== |
| 36 | ||
| 37 | All DVB frontend devices support the ``FE_SET_PROPERTY`` and | |
| 38 | ``FE_GET_PROPERTY`` ioctls. The supported properties and statistics | |
| 39 | depends on the delivery system and on the device: | |
| 40 | ||
| 41 | - ``FE_SET_PROPERTY:`` | |
| 42 | ||
| 43 | - This ioctl is used to set one or more frontend properties. | |
| 44 | ||
| 45 | - This is the basic command to request the frontend to tune into | |
| 46 | some frequency and to start decoding the digital TV signal. | |
| 47 | ||
| 48 | - This call requires read/write access to the device. | |
| 49 | ||
| 50 | - At return, the values are updated to reflect the actual parameters | |
| 51 | used. | |
| 52 | ||
| 53 | - ``FE_GET_PROPERTY:`` | |
| 54 | ||
| 55 | - This ioctl is used to get properties and statistics from the | |
| 56 | frontend. | |
| 57 | ||
| 58 | - No properties are changed, and statistics aren't reset. | |
| 59 | ||
| 60 | - This call only requires read-only access to the device. | |
| 61 | ||
| 586027ce | 62 | |
| 15e7d615 | 63 | Return Value |
| 586027ce | 64 | ============ |
| 5377d91f MH |
65 | |
| 66 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 67 | appropriately. The generic error codes are described at the | |
| 68 | :ref:`Generic Error Codes <gen-errors>` chapter. |