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