V4L/DVB (11367): v4l2-common: remove legacy code
[linux-2.6.git] / include / media / v4l2-subdev.h
1 /*
2     V4L2 sub-device support header.
3
4     Copyright (C) 2008  Hans Verkuil <hverkuil@xs4all.nl>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef _V4L2_SUBDEV_H
22 #define _V4L2_SUBDEV_H
23
24 #include <media/v4l2-common.h>
25
26 struct v4l2_device;
27 struct v4l2_subdev;
28 struct tuner_setup;
29
30 /* decode_vbi_line */
31 struct v4l2_decode_vbi_line {
32         u32 is_second_field;    /* Set to 0 for the first (odd) field,
33                                    set to 1 for the second (even) field. */
34         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
35                                    On exit points to the start of the payload. */
36         u32 line;               /* Line number of the sliced VBI data (1-23) */
37         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
38 };
39
40 /* s_crystal_freq */
41 struct v4l2_crystal_freq {
42         u32 freq;       /* frequency in Hz of the crystal */
43         u32 flags;      /* device specific flags */
44 };
45
46 /* Sub-devices are devices that are connected somehow to the main bridge
47    device. These devices are usually audio/video muxers/encoders/decoders or
48    sensors and webcam controllers.
49
50    Usually these devices are controlled through an i2c bus, but other busses
51    may also be used.
52
53    The v4l2_subdev struct provides a way of accessing these devices in a
54    generic manner. Most operations that these sub-devices support fall in
55    a few categories: core ops, audio ops, video ops and tuner ops.
56
57    More categories can be added if needed, although this should remain a
58    limited set (no more than approx. 8 categories).
59
60    Each category has its own set of ops that subdev drivers can implement.
61
62    A subdev driver can leave the pointer to the category ops NULL if
63    it does not implement them (e.g. an audio subdev will generally not
64    implement the video category ops). The exception is the core category:
65    this must always be present.
66
67    These ops are all used internally so it is no problem to change, remove
68    or add ops or move ops from one to another category. Currently these
69    ops are based on the original ioctls, but since ops are not limited to
70    one argument there is room for improvement here once all i2c subdev
71    drivers are converted to use these ops.
72  */
73
74 /* Core ops: it is highly recommended to implement at least these ops:
75
76    g_chip_ident
77    log_status
78    g_register
79    s_register
80
81    This provides basic debugging support.
82
83    The ioctl ops is meant for generic ioctl-like commands. Depending on
84    the use-case it might be better to use subdev-specific ops (currently
85    not yet implemented) since ops provide proper type-checking.
86  */
87
88 /* init: initialize the sensor registors to some sort of reasonable default
89         values. Do not use for new drivers and should be removed in existing
90         drivers.
91
92   reset: generic reset command. The argument selects which subsystems to
93         reset. Passing 0 will always reset the whole chip. Do not use for new
94         drivers without discussing this first on the linux-media mailinglist.
95         There should be no reason normally to reset a device.
96
97    s_gpio: set GPIO pins. Very simple right now, might need to be extended with
98         a direction argument if needed.
99
100    s_standby: puts tuner on powersaving state, disabling it, except for i2c.
101  */
102 struct v4l2_subdev_core_ops {
103         int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
104         int (*log_status)(struct v4l2_subdev *sd);
105         int (*init)(struct v4l2_subdev *sd, u32 val);
106         int (*s_standby)(struct v4l2_subdev *sd, u32 standby);
107         int (*reset)(struct v4l2_subdev *sd, u32 val);
108         int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
109         int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
110         int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
111         int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
112         int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
113         int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
114         int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
115         int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
116         long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
117 #ifdef CONFIG_VIDEO_ADV_DEBUG
118         int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
119         int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
120 #endif
121 };
122
123 /* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
124
125    s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
126
127    s_type_addr: sets tuner type and its I2C addr.
128
129    s_config: sets tda9887 specific stuff, like port1, port2 and qss
130  */
131 struct v4l2_subdev_tuner_ops {
132         int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
133         int (*s_radio)(struct v4l2_subdev *sd);
134         int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
135         int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
136         int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
137         int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
138         int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
139         int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
140         int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
141 };
142
143 /* s_clock_freq: set the frequency (in Hz) of the audio clock output.
144         Used to slave an audio processor to the video decoder, ensuring that
145         audio and video remain synchronized. Usual values for the frequency
146         are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
147         -EINVAL is returned.
148
149    s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
150         way to select I2S clock used by driving digital audio streams at some
151         board designs. Usual values for the frequency are 1024000 and 2048000.
152         If the frequency is not supported, then -EINVAL is returned.
153
154    s_routing: used to define the input and/or output pins of an audio chip.
155         Never attempt to use user-level input IDs (e.g. Composite, S-Video,
156         Tuner) at this level. An i2c device shouldn't know about whether an
157         input pin is connected to a Composite connector, become on another
158         board or platform it might be connected to something else entirely.
159         The calling driver is responsible for mapping a user-level input to
160         the right pins on the i2c device.
161  */
162 struct v4l2_subdev_audio_ops {
163         int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
164         int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
165         int (*s_routing)(struct v4l2_subdev *sd, const struct v4l2_routing *route);
166 };
167
168 /*
169    decode_vbi_line: video decoders that support sliced VBI need to implement
170         this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
171         start of the VBI data that was generated by the decoder. The driver
172         then parses the sliced VBI data and sets the other fields in the
173         struct accordingly. The pointer p is updated to point to the start of
174         the payload which can be copied verbatim into the data field of the
175         v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
176         type field is set to 0 on return.
177
178   s_vbi_data: used to generate VBI signals on a video signal.
179         v4l2_sliced_vbi_data is filled with the data packets that should be
180         output. Note that if you set the line field to 0, then that VBI signal
181         is disabled. If no valid VBI data was found, then the type field is
182         set to 0 on return.
183
184   g_vbi_data: used to obtain the sliced VBI packet from a readback register.
185         Not all video decoders support this. If no data is available because
186         the readback register contains invalid or erroneous data -EIO is
187         returned. Note that you must fill in the 'id' member and the 'field'
188         member (to determine whether CC data from the first or second field
189         should be obtained).
190
191   s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
192         video input devices.
193
194   s_crystal_freq: sets the frequency of the crystal used to generate the
195         clocks. An extra flags field allows device specific configuration
196         regarding clock frequency dividers, etc. If not used, then set flags
197         to 0. If the frequency is not supported, then -EINVAL is returned.
198
199   g_input_status: get input status. Same as the status field in the v4l2_input
200         struct.
201
202   s_routing: see s_routing in audio_ops, except this version is for video
203         devices.
204  */
205 struct v4l2_subdev_video_ops {
206         int (*s_routing)(struct v4l2_subdev *sd, const struct v4l2_routing *route);
207         int (*s_crystal_freq)(struct v4l2_subdev *sd, struct v4l2_crystal_freq *freq);
208         int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
209         int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
210         int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
211         int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
212         int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
213         int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
214         int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
215         int (*s_stream)(struct v4l2_subdev *sd, int enable);
216         int (*enum_fmt)(struct v4l2_subdev *sd, struct v4l2_fmtdesc *fmtdesc);
217         int (*g_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
218         int (*try_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
219         int (*s_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
220         int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
221         int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
222         int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
223         int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
224 };
225
226 struct v4l2_subdev_ops {
227         const struct v4l2_subdev_core_ops  *core;
228         const struct v4l2_subdev_tuner_ops *tuner;
229         const struct v4l2_subdev_audio_ops *audio;
230         const struct v4l2_subdev_video_ops *video;
231 };
232
233 #define V4L2_SUBDEV_NAME_SIZE 32
234
235 /* Each instance of a subdev driver should create this struct, either
236    stand-alone or embedded in a larger struct.
237  */
238 struct v4l2_subdev {
239         struct list_head list;
240         struct module *owner;
241         struct v4l2_device *v4l2_dev;
242         const struct v4l2_subdev_ops *ops;
243         /* name must be unique */
244         char name[V4L2_SUBDEV_NAME_SIZE];
245         /* can be used to group similar subdevs, value is driver-specific */
246         u32 grp_id;
247         /* pointer to private data */
248         void *priv;
249 };
250
251 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
252 {
253         sd->priv = p;
254 }
255
256 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
257 {
258         return sd->priv;
259 }
260
261 static inline void v4l2_subdev_init(struct v4l2_subdev *sd,
262                                         const struct v4l2_subdev_ops *ops)
263 {
264         INIT_LIST_HEAD(&sd->list);
265         /* ops->core MUST be set */
266         BUG_ON(!ops || !ops->core);
267         sd->ops = ops;
268         sd->v4l2_dev = NULL;
269         sd->name[0] = '\0';
270         sd->grp_id = 0;
271         sd->priv = NULL;
272 }
273
274 /* Call an ops of a v4l2_subdev, doing the right checks against
275    NULL pointers.
276
277    Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
278  */
279 #define v4l2_subdev_call(sd, o, f, args...)                             \
280         (!(sd) ? -ENODEV : (((sd) && (sd)->ops->o && (sd)->ops->o->f) ? \
281                 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
282
283 /* Send a notification to v4l2_device. */
284 #define v4l2_subdev_notify(sd, notification, arg)                          \
285         ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
286          (sd)->v4l2_dev->notify((sd), (notification), (arg)))
287
288 #endif