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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _FE_SET_FRONTEND_TUNE_MODE:
  11
  12 *******************************
  13 ioctl FE_SET_FRONTEND_TUNE_MODE
  14 *******************************
  15
  16 Name
  17 ====
  18
  19 FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
  20
  21
  22 Synopsis
  23 ========
  24
  25 .. c:function:: int ioctl( int fd, FE_SET_FRONTEND_TUNE_MODE, unsigned int flags )
  26     :name: FE_SET_FRONTEND_TUNE_MODE
  27
  28
  29 Arguments
  30 =========
  31
  32 ``fd``
  33     File descriptor returned by :ref:`open() <frontend_f_open>`.
  34
  35 ``flags``
  36     Valid flags:
  37
  38     -  0 - normal tune mode
  39
  40     -  ``FE_TUNE_MODE_ONESHOT`` - When set, this flag will disable any
  41        zigzagging or other "normal" tuning behaviour. Additionally,
  42        there will be no automatic monitoring of the lock status, and
  43        hence no frontend events will be generated. If a frontend device
  44        is closed, this flag will be automatically turned off when the
  45        device is reopened read-write.
  46
  47
  48 Description
  49 ===========
  50
  51 Allow setting tuner mode flags to the frontend, between 0 (normal) or
  52 ``FE_TUNE_MODE_ONESHOT`` mode
  53
  54
  55 Return Value
  56 ============
  57
  58 On success 0 is returned.
  59
  60 On error -1 is returned, and the ``errno`` variable is set
  61 appropriately.
  62
  63 Generic error codes are described at the
  64 :ref:`Generic Error Codes <gen-errors>` chapter.