Documentation/userspace-api/media/dvb/fe-set-frontend-tune-mode.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.fe
   3
   4 .. _FE_SET_FRONTEND_TUNE_MODE:
   5
   6 *******************************
   7 ioctl FE_SET_FRONTEND_TUNE_MODE
   8 *******************************
   9
  10 Name
  11 ====
  12
  13 FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
  14
  15 Synopsis
  16 ========
  17
  18 .. c:macro:: FE_SET_FRONTEND_TUNE_MODE
  19
  20 ``int ioctl(int fd, FE_SET_FRONTEND_TUNE_MODE, unsigned int flags)``
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open()`.
  27
  28 ``flags``
  29     Valid flags:
  30
  31     -  0 - normal tune mode
  32
  33     -  ``FE_TUNE_MODE_ONESHOT`` - When set, this flag will disable any
  34        zigzagging or other "normal" tuning behaviour. Additionally,
  35        there will be no automatic monitoring of the lock status, and
  36        hence no frontend events will be generated. If a frontend device
  37        is closed, this flag will be automatically turned off when the
  38        device is reopened read-write.
  39
  40 Description
  41 ===========
  42
  43 Allow setting tuner mode flags to the frontend, between 0 (normal) or
  44 ``FE_TUNE_MODE_ONESHOT`` mode
  45
  46 Return Value
  47 ============
  48
  49 On success 0 is returned.
  50
  51 On error -1 is returned, and the ``errno`` variable is set
  52 appropriately.
  53
  54 Generic error codes are described at the
  55 :ref:`Generic Error Codes <gen-errors>` chapter.