fe-set-tone.rst 1.4 KB

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