Documentation/media/uapi/v4l/vidioc-g-frequency.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_G_FREQUENCY:
   4
   5 ********************************************
   6 ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY
   7 ********************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_G_FREQUENCY - VIDIOC_S_FREQUENCY - Get or set tuner or modulator radio frequency
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency *argp )
  19
  20 .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp )
  21
  22
  23 Arguments
  24 =========
  25
  26 ``fd``
  27     File descriptor returned by :ref:`open() <func-open>`.
  28
  29 ``request``
  30     VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY
  31
  32 ``argp``
  33
  34
  35 Description
  36 ===========
  37
  38 To get the current tuner or modulator radio frequency applications set
  39 the ``tuner`` field of a struct
  40 :ref:`v4l2_frequency <v4l2-frequency>` to the respective tuner or
  41 modulator number (only input devices have tuners, only output devices
  42 have modulators), zero out the ``reserved`` array and call the
  43 :ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl with a pointer to this structure. The
  44 driver stores the current frequency in the ``frequency`` field.
  45
  46 To change the current tuner or modulator radio frequency applications
  47 initialize the ``tuner``, ``type`` and ``frequency`` fields, and the
  48 ``reserved`` array of a struct :ref:`v4l2_frequency <v4l2-frequency>`
  49 and call the :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl with a pointer to this
  50 structure. When the requested frequency is not possible the driver
  51 assumes the closest possible value. However :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` is a
  52 write-only ioctl, it does not return the actual new frequency.
  53
  54
  55 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  56
  57 .. _v4l2-frequency:
  58
  59 .. flat-table:: struct v4l2_frequency
  60     :header-rows:  0
  61     :stub-columns: 0
  62     :widths:       1 1 2
  63
  64
  65     -  .. row 1
  66
  67        -  __u32
  68
  69        -  ``tuner``
  70
  71        -  The tuner or modulator index number. This is the same value as in
  72           the struct :ref:`v4l2_input <v4l2-input>` ``tuner`` field and
  73           the struct :ref:`v4l2_tuner <v4l2-tuner>` ``index`` field, or
  74           the struct :ref:`v4l2_output <v4l2-output>` ``modulator`` field
  75           and the struct :ref:`v4l2_modulator <v4l2-modulator>` ``index``
  76           field.
  77
  78     -  .. row 2
  79
  80        -  __u32
  81
  82        -  ``type``
  83
  84        -  The tuner type. This is the same value as in the struct
  85           :ref:`v4l2_tuner <v4l2-tuner>` ``type`` field. The type must be
  86           set to ``V4L2_TUNER_RADIO`` for ``/dev/radioX`` device nodes, and
  87           to ``V4L2_TUNER_ANALOG_TV`` for all others. Set this field to
  88           ``V4L2_TUNER_RADIO`` for modulators (currently only radio
  89           modulators are supported). See :ref:`v4l2-tuner-type`
  90
  91     -  .. row 3
  92
  93        -  __u32
  94
  95        -  ``frequency``
  96
  97        -  Tuning frequency in units of 62.5 kHz, or if the struct
  98           :ref:`v4l2_tuner <v4l2-tuner>` or struct
  99           :ref:`v4l2_modulator <v4l2-modulator>` ``capability`` flag
 100           ``V4L2_TUNER_CAP_LOW`` is set, in units of 62.5 Hz. A 1 Hz unit is
 101           used when the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
 102
 103     -  .. row 4
 104
 105        -  __u32
 106
 107        -  ``reserved``\ [8]
 108
 109        -  Reserved for future extensions. Drivers and applications must set
 110           the array to zero.
 111
 112
 113 Return Value
 114 ============
 115
 116 On success 0 is returned, on error -1 and the ``errno`` variable is set
 117 appropriately. The generic error codes are described at the
 118 :ref:`Generic Error Codes <gen-errors>` chapter.
 119
 120 EINVAL
 121     The ``tuner`` index is out of bounds or the value in the ``type``
 122     field is wrong.
 123
 124 EBUSY
 125     A hardware seek is in progress.