^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) .. c:namespace:: DTV.fe
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) .. _FE_SET_TONE:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *****************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) ioctl FE_SET_TONE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) *****************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) Name
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) ====
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) Synopsis
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) ========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) .. c:macro:: FE_SET_TONE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) ``int ioctl(int fd, FE_SET_TONE, enum fe_sec_tone_mode tone)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) Arguments
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) =========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) ``fd``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) File descriptor returned by :c:func:`open()`.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) ``tone``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) an integer enumered value described at :c:type:`fe_sec_tone_mode`
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) Description
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) ===========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) This ioctl is used to set the generation of the continuous 22kHz tone.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) This call requires read/write permissions.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) Usually, satellite antenna subsystems require that the digital TV device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) to send a 22kHz tone in order to select between high/low band on some
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) dual-band LNBf. It is also used to send signals to DiSEqC equipment, but
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) this is done using the DiSEqC ioctls.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) .. attention:: If more than one device is connected to the same antenna,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) setting a tone may interfere on other devices, as they may lose the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) capability of selecting the band. So, it is recommended that applications
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) would change to SEC_TONE_OFF when the device is not used.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) Return Value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) ============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) On success 0 is returned.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) On error -1 is returned, and the ``errno`` variable is set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) appropriately.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) Generic error codes are described at the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) :ref:`Generic Error Codes <gen-errors>` chapter.