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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_SET_FRONTEND_TUNE_MODE:
   4
   5 *******************************
   6 ioctl FE_SET_FRONTEND_TUNE_MODE
   7 *******************************
   8
   9 Name
  10 ====
  11
  12 FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, FE_SET_FRONTEND_TUNE_MODE, unsigned int flags )
  19     :name: FE_SET_FRONTEND_TUNE_MODE
  20
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :ref:`open() <frontend_f_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
  41 Description
  42 ===========
  43
  44 Allow setting tuner mode flags to the frontend, between 0 (normal) or
  45 ``FE_TUNE_MODE_ONESHOT`` mode
  46
  47
  48 Return Value
  49 ============
  50
  51 On success 0 is returned.
  52
  53 On error -1 is returned, and the ``errno`` variable is set
  54 appropriately.
  55
  56 Generic error codes are described at the
  57 :ref:`Generic Error Codes <gen-errors>` chapter.