blob: a88889355ae0a4bb6edb6e4fc05893eab551d029 [file] [log] [blame]
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -03001/*
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>
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -030025#include <media/v4l2-mediabus.h>
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030026
Andy Walls1d986ad2009-09-27 17:50:04 -030027/* generic v4l2_device notify callback notification values */
28#define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32)
29#define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001
30#define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002
31#define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004
32#define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008
33
34#define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32)
35#define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001
36
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030037struct v4l2_device;
38struct v4l2_subdev;
39struct tuner_setup;
40
Hans Verkuil78a3b4d2009-04-01 03:41:09 -030041/* decode_vbi_line */
42struct v4l2_decode_vbi_line {
43 u32 is_second_field; /* Set to 0 for the first (odd) field,
44 set to 1 for the second (even) field. */
45 u8 *p; /* Pointer to the sliced VBI data from the decoder.
46 On exit points to the start of the payload. */
47 u32 line; /* Line number of the sliced VBI data (1-23) */
48 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
49};
50
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030051/* Sub-devices are devices that are connected somehow to the main bridge
52 device. These devices are usually audio/video muxers/encoders/decoders or
53 sensors and webcam controllers.
54
55 Usually these devices are controlled through an i2c bus, but other busses
56 may also be used.
57
58 The v4l2_subdev struct provides a way of accessing these devices in a
59 generic manner. Most operations that these sub-devices support fall in
60 a few categories: core ops, audio ops, video ops and tuner ops.
61
62 More categories can be added if needed, although this should remain a
63 limited set (no more than approx. 8 categories).
64
65 Each category has its own set of ops that subdev drivers can implement.
66
67 A subdev driver can leave the pointer to the category ops NULL if
68 it does not implement them (e.g. an audio subdev will generally not
69 implement the video category ops). The exception is the core category:
70 this must always be present.
71
72 These ops are all used internally so it is no problem to change, remove
73 or add ops or move ops from one to another category. Currently these
74 ops are based on the original ioctls, but since ops are not limited to
75 one argument there is room for improvement here once all i2c subdev
76 drivers are converted to use these ops.
77 */
78
79/* Core ops: it is highly recommended to implement at least these ops:
80
81 g_chip_ident
82 log_status
83 g_register
84 s_register
85
86 This provides basic debugging support.
87
88 The ioctl ops is meant for generic ioctl-like commands. Depending on
89 the use-case it might be better to use subdev-specific ops (currently
90 not yet implemented) since ops provide proper type-checking.
91 */
Hans Verkuil78a3b4d2009-04-01 03:41:09 -030092
Hans Verkuilf0222c72009-06-09 17:12:33 -030093/* s_config: if set, then it is always called by the v4l2_i2c_new_subdev*
94 functions after the v4l2_subdev was registered. It is used to pass
95 platform data to the subdev which can be used during initialization.
96
97 init: initialize the sensor registors to some sort of reasonable default
Hans Verkuil78a3b4d2009-04-01 03:41:09 -030098 values. Do not use for new drivers and should be removed in existing
99 drivers.
100
Hans Verkuilcc26b072009-03-29 19:20:26 -0300101 load_fw: load firmware.
102
103 reset: generic reset command. The argument selects which subsystems to
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300104 reset. Passing 0 will always reset the whole chip. Do not use for new
105 drivers without discussing this first on the linux-media mailinglist.
106 There should be no reason normally to reset a device.
107
108 s_gpio: set GPIO pins. Very simple right now, might need to be extended with
109 a direction argument if needed.
Laurent Pinchart622b8282009-10-05 10:48:17 -0300110
111 s_power: puts subdevice in power saving mode (on == 0) or normal operation
112 mode (on == 1).
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300113 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300114struct v4l2_subdev_core_ops {
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300115 int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300116 int (*log_status)(struct v4l2_subdev *sd);
Hans Verkuilf0222c72009-06-09 17:12:33 -0300117 int (*s_config)(struct v4l2_subdev *sd, int irq, void *platform_data);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300118 int (*init)(struct v4l2_subdev *sd, u32 val);
Hans Verkuilcc26b072009-03-29 19:20:26 -0300119 int (*load_fw)(struct v4l2_subdev *sd);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300120 int (*reset)(struct v4l2_subdev *sd, u32 val);
121 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
122 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
123 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
124 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
Hans Verkuil952617f2009-01-12 18:17:14 -0300125 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
126 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
127 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300128 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
Hans Verkuilf41737e2009-04-01 03:52:39 -0300129 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
Hans Verkuil069b7472008-12-30 07:04:34 -0300130 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300131#ifdef CONFIG_VIDEO_ADV_DEBUG
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300132 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
133 int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300134#endif
Laurent Pinchart622b8282009-10-05 10:48:17 -0300135 int (*s_power)(struct v4l2_subdev *sd, int on);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300136};
137
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300138/* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
139
140 s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
141
142 s_type_addr: sets tuner type and its I2C addr.
143
144 s_config: sets tda9887 specific stuff, like port1, port2 and qss
145 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300146struct v4l2_subdev_tuner_ops {
147 int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
148 int (*s_radio)(struct v4l2_subdev *sd);
149 int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
150 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
151 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
152 int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
Eduardo Valentind6bacea2009-08-08 08:34:18 -0300153 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
154 int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300155 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
156 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
157};
158
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300159/* s_clock_freq: set the frequency (in Hz) of the audio clock output.
160 Used to slave an audio processor to the video decoder, ensuring that
161 audio and video remain synchronized. Usual values for the frequency
162 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
163 -EINVAL is returned.
164
165 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
166 way to select I2S clock used by driving digital audio streams at some
167 board designs. Usual values for the frequency are 1024000 and 2048000.
168 If the frequency is not supported, then -EINVAL is returned.
169
Hans Verkuil5325b422009-04-02 11:26:22 -0300170 s_routing: used to define the input and/or output pins of an audio chip,
171 and any additional configuration data.
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300172 Never attempt to use user-level input IDs (e.g. Composite, S-Video,
173 Tuner) at this level. An i2c device shouldn't know about whether an
174 input pin is connected to a Composite connector, become on another
175 board or platform it might be connected to something else entirely.
176 The calling driver is responsible for mapping a user-level input to
177 the right pins on the i2c device.
178 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300179struct v4l2_subdev_audio_ops {
180 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
181 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
Hans Verkuil5325b422009-04-02 11:26:22 -0300182 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
Andy Walls3ccc6462009-12-24 13:06:08 -0300183 int (*s_stream)(struct v4l2_subdev *sd, int enable);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300184};
185
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300186/*
Hans Verkuilcc26b072009-03-29 19:20:26 -0300187 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300188 video input devices.
189
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300190 s_crystal_freq: sets the frequency of the crystal used to generate the
Hans Verkuil3ff4ad82009-04-01 03:15:52 -0300191 clocks in Hz. An extra flags field allows device specific configuration
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300192 regarding clock frequency dividers, etc. If not used, then set flags
193 to 0. If the frequency is not supported, then -EINVAL is returned.
194
Hans Verkuilcc26b072009-03-29 19:20:26 -0300195 g_input_status: get input status. Same as the status field in the v4l2_input
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300196 struct.
197
Hans Verkuilcc26b072009-03-29 19:20:26 -0300198 s_routing: see s_routing in audio_ops, except this version is for video
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300199 devices.
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300200
201 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
202 s_std()
203
204 query_dv_preset: query dv preset in the sub device. This is similar to
205 querystd()
206
207 s_dv_timings(): Set custom dv timings in the sub device. This is used
208 when sub device is capable of setting detailed timing information
209 in the hardware to generate/detect the video signal.
210
211 g_dv_timings(): Get custom dv timings in the sub device.
212
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300213 enum_mbus_fmt: enumerate pixel formats, provided by a video data source
214
215 g_mbus_fmt: get the current pixel format, provided by a video data source
216
217 try_mbus_fmt: try to set a pixel format on a video data source
218
219 s_mbus_fmt: set a pixel format on a video data source
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300220 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300221struct v4l2_subdev_video_ops {
Hans Verkuil5325b422009-04-02 11:26:22 -0300222 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
Hans Verkuil3ff4ad82009-04-01 03:15:52 -0300223 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300224 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
Hans Verkuil1b6f1d92009-02-13 07:48:21 -0300225 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
226 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300227 int (*s_stream)(struct v4l2_subdev *sd, int enable);
Hans Verkuil2da94792009-02-06 18:59:35 -0300228 int (*enum_fmt)(struct v4l2_subdev *sd, struct v4l2_fmtdesc *fmtdesc);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300229 int (*g_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
Hans Verkuil2da94792009-02-06 18:59:35 -0300230 int (*try_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
231 int (*s_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
Guennadi Liakhovetskib7f2cef2009-06-24 10:31:25 -0300232 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
233 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
234 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
Hans Verkuil2da94792009-02-06 18:59:35 -0300235 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
236 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
Hans Verkuil4b2ce112009-03-29 19:23:16 -0300237 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
238 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
Mats Randgaard6003b5c2010-05-05 05:08:22 -0300239 int (*enum_dv_presets) (struct v4l2_subdev *sd,
240 struct v4l2_dv_enum_preset *preset);
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300241 int (*s_dv_preset)(struct v4l2_subdev *sd,
242 struct v4l2_dv_preset *preset);
243 int (*query_dv_preset)(struct v4l2_subdev *sd,
244 struct v4l2_dv_preset *preset);
245 int (*s_dv_timings)(struct v4l2_subdev *sd,
246 struct v4l2_dv_timings *timings);
247 int (*g_dv_timings)(struct v4l2_subdev *sd,
248 struct v4l2_dv_timings *timings);
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300249 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, int index,
250 enum v4l2_mbus_pixelcode *code);
251 int (*g_mbus_fmt)(struct v4l2_subdev *sd,
252 struct v4l2_mbus_framefmt *fmt);
253 int (*try_mbus_fmt)(struct v4l2_subdev *sd,
254 struct v4l2_mbus_framefmt *fmt);
255 int (*s_mbus_fmt)(struct v4l2_subdev *sd,
256 struct v4l2_mbus_framefmt *fmt);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300257};
258
Hans Verkuil32cd5272010-03-14 09:57:30 -0300259/*
260 decode_vbi_line: video decoders that support sliced VBI need to implement
261 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
262 start of the VBI data that was generated by the decoder. The driver
263 then parses the sliced VBI data and sets the other fields in the
264 struct accordingly. The pointer p is updated to point to the start of
265 the payload which can be copied verbatim into the data field of the
266 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
267 type field is set to 0 on return.
268
269 s_vbi_data: used to generate VBI signals on a video signal.
270 v4l2_sliced_vbi_data is filled with the data packets that should be
271 output. Note that if you set the line field to 0, then that VBI signal
272 is disabled. If no valid VBI data was found, then the type field is
273 set to 0 on return.
274
275 g_vbi_data: used to obtain the sliced VBI packet from a readback register.
276 Not all video decoders support this. If no data is available because
277 the readback register contains invalid or erroneous data -EIO is
278 returned. Note that you must fill in the 'id' member and the 'field'
279 member (to determine whether CC data from the first or second field
280 should be obtained).
Hans Verkuil54aefaf2010-03-14 10:02:50 -0300281
282 s_raw_fmt: setup the video encoder/decoder for raw VBI.
283
284 g_sliced_fmt: retrieve the current sliced VBI settings.
285
286 s_sliced_fmt: setup the sliced VBI settings.
Hans Verkuil32cd5272010-03-14 09:57:30 -0300287 */
288struct v4l2_subdev_vbi_ops {
289 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
290 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
291 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
292 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
Hans Verkuil54aefaf2010-03-14 10:02:50 -0300293 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
294 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
295 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
Hans Verkuil32cd5272010-03-14 09:57:30 -0300296};
297
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300298/**
299 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
300 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
301 * This is needed for some sensors, which always corrupt
302 * several top lines of the output image, or which send their
303 * metadata in them.
304 */
305struct v4l2_subdev_sensor_ops {
306 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
307};
308
Andy Walls1d986ad2009-09-27 17:50:04 -0300309/*
310 interrupt_service_routine: Called by the bridge chip's interrupt service
311 handler, when an IR interrupt status has be raised due to this subdev,
312 so that this subdev can handle the details. It may schedule work to be
313 performed later. It must not sleep. *Called from an IRQ context*.
314
315 [rt]x_g_parameters: Get the current operating parameters and state of the
316 the IR receiver or transmitter.
317
318 [rt]x_s_parameters: Set the current operating parameters and state of the
319 the IR receiver or transmitter. It is recommended to call
320 [rt]x_g_parameters first to fill out the current state, and only change
321 the fields that need to be changed. Upon return, the actual device
322 operating parameters and state will be returned. Note that hardware
323 limitations may prevent the actual settings from matching the requested
324 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
325 was requested. An exception is when the shutdown parameter is true.
326 The last used operational parameters will be returned, but the actual
327 state of the hardware be different to minimize power consumption and
328 processing when shutdown is true.
329
330 rx_read: Reads received codes or pulse width data.
331 The semantics are similar to a non-blocking read() call.
332
333 tx_write: Writes codes or pulse width data for transmission.
334 The semantics are similar to a non-blocking write() call.
335 */
336
337enum v4l2_subdev_ir_mode {
338 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* space & mark widths in nanosecs */
339};
340
341/* Data format of data read or written for V4L2_SUBDEV_IR_MODE_PULSE_WIDTH */
342#define V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS 0x7fffffff
343#define V4L2_SUBDEV_IR_PULSE_LEVEL_MASK 0x80000000
344#define V4L2_SUBDEV_IR_PULSE_RX_SEQ_END 0xffffffff
345
346struct v4l2_subdev_ir_parameters {
347 /* Either Rx or Tx */
348 unsigned int bytes_per_data_element; /* of data in read or write call */
349 enum v4l2_subdev_ir_mode mode;
350
351 bool enable;
352 bool interrupt_enable;
353 bool shutdown; /* true: set hardware to low/no power, false: normal */
354
355 bool modulation; /* true: uses carrier, false: baseband */
356 u32 max_pulse_width; /* ns, valid only for baseband signal */
357 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
358 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
359 bool invert; /* logically invert sense of mark/space */
360
361 /* Rx only */
362 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
363 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
364 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
365 u32 resolution; /* ns */
366};
367
368struct v4l2_subdev_ir_ops {
369 /* Common to receiver and transmitter */
370 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
371 u32 status, bool *handled);
372
373 /* Receiver */
374 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
375 ssize_t *num);
376
377 int (*rx_g_parameters)(struct v4l2_subdev *sd,
378 struct v4l2_subdev_ir_parameters *params);
379 int (*rx_s_parameters)(struct v4l2_subdev *sd,
380 struct v4l2_subdev_ir_parameters *params);
381
382 /* Transmitter */
383 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
384 ssize_t *num);
385
386 int (*tx_g_parameters)(struct v4l2_subdev *sd,
387 struct v4l2_subdev_ir_parameters *params);
388 int (*tx_s_parameters)(struct v4l2_subdev *sd,
389 struct v4l2_subdev_ir_parameters *params);
390};
391
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300392struct v4l2_subdev_ops {
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300393 const struct v4l2_subdev_core_ops *core;
394 const struct v4l2_subdev_tuner_ops *tuner;
395 const struct v4l2_subdev_audio_ops *audio;
396 const struct v4l2_subdev_video_ops *video;
Hans Verkuil32cd5272010-03-14 09:57:30 -0300397 const struct v4l2_subdev_vbi_ops *vbi;
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300398 const struct v4l2_subdev_ir_ops *ir;
399 const struct v4l2_subdev_sensor_ops *sensor;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300400};
401
402#define V4L2_SUBDEV_NAME_SIZE 32
403
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300404/* Set this flag if this subdev is a i2c device. */
405#define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
Dmitri Belimov85e09212010-03-23 11:23:29 -0300406/* Set this flag if this subdev is a spi device. */
407#define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300408
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300409/* Each instance of a subdev driver should create this struct, either
410 stand-alone or embedded in a larger struct.
411 */
412struct v4l2_subdev {
413 struct list_head list;
414 struct module *owner;
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300415 u32 flags;
Hans Verkuilb0167602009-02-14 12:00:53 -0300416 struct v4l2_device *v4l2_dev;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300417 const struct v4l2_subdev_ops *ops;
418 /* name must be unique */
419 char name[V4L2_SUBDEV_NAME_SIZE];
420 /* can be used to group similar subdevs, value is driver-specific */
421 u32 grp_id;
422 /* pointer to private data */
423 void *priv;
424};
425
426static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
427{
428 sd->priv = p;
429}
430
431static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
432{
433 return sd->priv;
434}
435
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300436static inline void v4l2_subdev_init(struct v4l2_subdev *sd,
437 const struct v4l2_subdev_ops *ops)
438{
439 INIT_LIST_HEAD(&sd->list);
440 /* ops->core MUST be set */
441 BUG_ON(!ops || !ops->core);
442 sd->ops = ops;
Hans Verkuilb0167602009-02-14 12:00:53 -0300443 sd->v4l2_dev = NULL;
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300444 sd->flags = 0;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300445 sd->name[0] = '\0';
446 sd->grp_id = 0;
447 sd->priv = NULL;
448}
449
450/* Call an ops of a v4l2_subdev, doing the right checks against
451 NULL pointers.
452
453 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
454 */
455#define v4l2_subdev_call(sd, o, f, args...) \
Hans Verkuildbc8e342009-06-09 17:34:01 -0300456 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300457 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
458
Hans Verkuil98ec6332009-03-08 17:02:10 -0300459/* Send a notification to v4l2_device. */
460#define v4l2_subdev_notify(sd, notification, arg) \
461 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
462 (sd)->v4l2_dev->notify((sd), (notification), (arg)))
463
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300464#endif