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