Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _FE_SET_TONE: | |
4 | ||
5 | ***************** | |
6 | ioctl FE_SET_TONE | |
7 | ***************** | |
8 | ||
15e7d615 | 9 | Name |
586027ce | 10 | ==== |
5377d91f | 11 | |
586027ce | 12 | FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone. |
5377d91f | 13 | |
15e7d615 MCC |
14 | |
15 | Synopsis | |
5377d91f MH |
16 | ======== |
17 | ||
cf8076c3 MCC |
18 | .. c:function:: int ioctl( int fd, FE_SET_TONE, enum fe_sec_tone_mode *tone ) |
19 | :name: FE_SET_TONE | |
5377d91f | 20 | |
586027ce | 21 | |
15e7d615 | 22 | Arguments |
5377d91f MH |
23 | ========= |
24 | ||
25 | ``fd`` | |
26 | File descriptor returned by :ref:`open() <frontend_f_open>`. | |
27 | ||
5377d91f | 28 | ``tone`` |
836cf1db | 29 | pointer to enum :c:type:`fe_sec_tone_mode` |
5377d91f MH |
30 | |
31 | ||
15e7d615 | 32 | Description |
5377d91f MH |
33 | =========== |
34 | ||
35 | This ioctl is used to set the generation of the continuous 22kHz tone. | |
36 | This call requires read/write permissions. | |
37 | ||
38 | Usually, satellite antenna subsystems require that the digital TV device | |
39 | to send a 22kHz tone in order to select between high/low band on some | |
40 | dual-band LNBf. It is also used to send signals to DiSEqC equipment, but | |
41 | this is done using the DiSEqC ioctls. | |
42 | ||
706f8a99 MCC |
43 | .. attention:: If more than one device is connected to the same antenna, |
44 | setting a tone may interfere on other devices, as they may lose the | |
45 | capability of selecting the band. So, it is recommended that applications | |
46 | would change to SEC_TONE_OFF when the device is not used. | |
5377d91f | 47 | |
836cf1db | 48 | .. c:type:: fe_sec_tone_mode |
5377d91f MH |
49 | |
50 | .. flat-table:: enum fe_sec_tone_mode | |
51 | :header-rows: 1 | |
52 | :stub-columns: 0 | |
53 | ||
54 | ||
55 | - .. row 1 | |
56 | ||
57 | - ID | |
58 | ||
59 | - Description | |
60 | ||
61 | - .. row 2 | |
62 | ||
6aeb3f67 | 63 | - .. _SEC-TONE-ON: |
5377d91f | 64 | |
0579e6e3 | 65 | ``SEC_TONE_ON`` |
5377d91f MH |
66 | |
67 | - Sends a 22kHz tone burst to the antenna | |
68 | ||
69 | - .. row 3 | |
70 | ||
6aeb3f67 | 71 | - .. _SEC-TONE-OFF: |
5377d91f | 72 | |
0579e6e3 | 73 | ``SEC_TONE_OFF`` |
5377d91f MH |
74 | |
75 | - Don't send a 22kHz tone to the antenna (except if the | |
0579e6e3 | 76 | FE_DISEQC_* ioctls are called) |
fc833980 | 77 | |
15e7d615 MCC |
78 | |
79 | Return Value | |
fc833980 MCC |
80 | ============ |
81 | ||
82 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
83 | appropriately. The generic error codes are described at the | |
84 | :ref:`Generic Error Codes <gen-errors>` chapter. |