blob: 224502067c431fba34b606ca21883610d637c496 [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
Laurent Pinchart333c8b92010-03-15 20:26:04 -030024#include <linux/v4l2-subdev.h>
Laurent Pinchart61f5db52009-12-09 08:40:08 -030025#include <media/media-entity.h>
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030026#include <media/v4l2-common.h>
Laurent Pinchart2096a5d2009-12-09 08:38:49 -030027#include <media/v4l2-dev.h>
Stanimir Varbanov7cd5a162010-05-21 06:04:24 -030028#include <media/v4l2-fh.h>
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -030029#include <media/v4l2-mediabus.h>
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030030
Andy Walls1d986ad2009-09-27 17:50:04 -030031/* generic v4l2_device notify callback notification values */
32#define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32)
33#define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001
34#define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002
35#define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004
36#define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008
37
38#define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32)
39#define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001
40
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030041struct v4l2_device;
Hans Verkuil09965172010-08-01 14:32:42 -030042struct v4l2_ctrl_handler;
Sakari Ailus02adb1c2010-03-03 12:49:38 -030043struct v4l2_event_subscription;
44struct v4l2_fh;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030045struct v4l2_subdev;
Laurent Pinchartf0beea82010-08-01 19:05:09 -030046struct v4l2_subdev_fh;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030047struct tuner_setup;
48
Hans Verkuil78a3b4d2009-04-01 03:41:09 -030049/* decode_vbi_line */
50struct v4l2_decode_vbi_line {
51 u32 is_second_field; /* Set to 0 for the first (odd) field,
52 set to 1 for the second (even) field. */
53 u8 *p; /* Pointer to the sliced VBI data from the decoder.
54 On exit points to the start of the payload. */
55 u32 line; /* Line number of the sliced VBI data (1-23) */
56 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
57};
58
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030059/* Sub-devices are devices that are connected somehow to the main bridge
60 device. These devices are usually audio/video muxers/encoders/decoders or
61 sensors and webcam controllers.
62
63 Usually these devices are controlled through an i2c bus, but other busses
64 may also be used.
65
66 The v4l2_subdev struct provides a way of accessing these devices in a
67 generic manner. Most operations that these sub-devices support fall in
68 a few categories: core ops, audio ops, video ops and tuner ops.
69
70 More categories can be added if needed, although this should remain a
71 limited set (no more than approx. 8 categories).
72
73 Each category has its own set of ops that subdev drivers can implement.
74
75 A subdev driver can leave the pointer to the category ops NULL if
76 it does not implement them (e.g. an audio subdev will generally not
77 implement the video category ops). The exception is the core category:
78 this must always be present.
79
80 These ops are all used internally so it is no problem to change, remove
81 or add ops or move ops from one to another category. Currently these
82 ops are based on the original ioctls, but since ops are not limited to
83 one argument there is room for improvement here once all i2c subdev
84 drivers are converted to use these ops.
85 */
86
87/* Core ops: it is highly recommended to implement at least these ops:
88
89 g_chip_ident
90 log_status
91 g_register
92 s_register
93
94 This provides basic debugging support.
95
96 The ioctl ops is meant for generic ioctl-like commands. Depending on
97 the use-case it might be better to use subdev-specific ops (currently
98 not yet implemented) since ops provide proper type-checking.
99 */
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300100
Andy Walls66752f82010-07-18 18:51:10 -0300101/* Subdevice external IO pin configuration */
102#define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */
103#define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1)
104#define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2)
105#define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */
106#define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */
107
108struct v4l2_subdev_io_pin_config {
109 u32 flags; /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */
110 u8 pin; /* Chip external IO pin to configure */
111 u8 function; /* Internal signal pad/function to route to IO pin */
112 u8 value; /* Initial value for pin - e.g. GPIO output value */
113 u8 strength; /* Pin drive strength */
114};
115
Hans Verkuil3c7c9372011-01-08 07:08:02 -0300116/*
Andy Walls66752f82010-07-18 18:51:10 -0300117 s_io_pin_config: configure one or more chip I/O pins for chips that
118 multiplex different internal signal pads out to IO pins. This function
119 takes a pointer to an array of 'n' pin configuration entries, one for
120 each pin being configured. This function could be called at times
121 other than just subdevice initialization.
122
Hans Verkuilf0222c72009-06-09 17:12:33 -0300123 init: initialize the sensor registors to some sort of reasonable default
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300124 values. Do not use for new drivers and should be removed in existing
125 drivers.
126
Hans Verkuilcc26b072009-03-29 19:20:26 -0300127 load_fw: load firmware.
128
129 reset: generic reset command. The argument selects which subsystems to
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300130 reset. Passing 0 will always reset the whole chip. Do not use for new
131 drivers without discussing this first on the linux-media mailinglist.
132 There should be no reason normally to reset a device.
133
134 s_gpio: set GPIO pins. Very simple right now, might need to be extended with
135 a direction argument if needed.
Laurent Pinchart622b8282009-10-05 10:48:17 -0300136
137 s_power: puts subdevice in power saving mode (on == 0) or normal operation
138 mode (on == 1).
Andy Walls260e689b2010-07-18 20:54:52 -0300139
140 interrupt_service_routine: Called by the bridge chip's interrupt service
141 handler, when an interrupt status has be raised due to this subdev,
142 so that this subdev can handle the details. It may schedule work to be
143 performed later. It must not sleep. *Called from an IRQ context*.
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300144 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300145struct v4l2_subdev_core_ops {
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300146 int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300147 int (*log_status)(struct v4l2_subdev *sd);
Andy Walls66752f82010-07-18 18:51:10 -0300148 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
149 struct v4l2_subdev_io_pin_config *pincfg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300150 int (*init)(struct v4l2_subdev *sd, u32 val);
Hans Verkuilcc26b072009-03-29 19:20:26 -0300151 int (*load_fw)(struct v4l2_subdev *sd);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300152 int (*reset)(struct v4l2_subdev *sd, u32 val);
153 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
154 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
155 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
156 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
Hans Verkuil952617f2009-01-12 18:17:14 -0300157 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
158 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
159 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300160 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
Hans Verkuilf41737e2009-04-01 03:52:39 -0300161 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
Hans Verkuil069b7472008-12-30 07:04:34 -0300162 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300163#ifdef CONFIG_VIDEO_ADV_DEBUG
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300164 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
165 int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300166#endif
Laurent Pinchart622b8282009-10-05 10:48:17 -0300167 int (*s_power)(struct v4l2_subdev *sd, int on);
Andy Walls260e689b2010-07-18 20:54:52 -0300168 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
169 u32 status, bool *handled);
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300170 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
171 struct v4l2_event_subscription *sub);
172 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
173 struct v4l2_event_subscription *sub);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300174};
175
Hans Verkuile206fc52011-06-13 09:34:56 -0300176/* s_radio: v4l device was opened in radio mode.
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300177
178 s_type_addr: sets tuner type and its I2C addr.
179
180 s_config: sets tda9887 specific stuff, like port1, port2 and qss
181 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300182struct v4l2_subdev_tuner_ops {
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300183 int (*s_radio)(struct v4l2_subdev *sd);
184 int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
185 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
186 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
187 int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
Eduardo Valentind6bacea2009-08-08 08:34:18 -0300188 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
189 int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300190 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
191 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
192};
193
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300194/* s_clock_freq: set the frequency (in Hz) of the audio clock output.
195 Used to slave an audio processor to the video decoder, ensuring that
196 audio and video remain synchronized. Usual values for the frequency
197 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
198 -EINVAL is returned.
199
200 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
201 way to select I2S clock used by driving digital audio streams at some
202 board designs. Usual values for the frequency are 1024000 and 2048000.
203 If the frequency is not supported, then -EINVAL is returned.
204
Hans Verkuil5325b422009-04-02 11:26:22 -0300205 s_routing: used to define the input and/or output pins of an audio chip,
206 and any additional configuration data.
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300207 Never attempt to use user-level input IDs (e.g. Composite, S-Video,
208 Tuner) at this level. An i2c device shouldn't know about whether an
209 input pin is connected to a Composite connector, become on another
210 board or platform it might be connected to something else entirely.
211 The calling driver is responsible for mapping a user-level input to
212 the right pins on the i2c device.
213 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300214struct v4l2_subdev_audio_ops {
215 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
216 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
Hans Verkuil5325b422009-04-02 11:26:22 -0300217 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
Andy Walls3ccc6462009-12-24 13:06:08 -0300218 int (*s_stream)(struct v4l2_subdev *sd, int enable);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300219};
220
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300221/*
Hans Verkuilcc26b072009-03-29 19:20:26 -0300222 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300223 video input devices.
224
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300225 s_crystal_freq: sets the frequency of the crystal used to generate the
Hans Verkuil3ff4ad82009-04-01 03:15:52 -0300226 clocks in Hz. An extra flags field allows device specific configuration
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300227 regarding clock frequency dividers, etc. If not used, then set flags
228 to 0. If the frequency is not supported, then -EINVAL is returned.
229
Hans Verkuilcc26b072009-03-29 19:20:26 -0300230 g_input_status: get input status. Same as the status field in the v4l2_input
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300231 struct.
232
Hans Verkuilcc26b072009-03-29 19:20:26 -0300233 s_routing: see s_routing in audio_ops, except this version is for video
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300234 devices.
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300235
236 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
237 s_std()
238
239 query_dv_preset: query dv preset in the sub device. This is similar to
240 querystd()
241
242 s_dv_timings(): Set custom dv timings in the sub device. This is used
243 when sub device is capable of setting detailed timing information
244 in the hardware to generate/detect the video signal.
245
246 g_dv_timings(): Get custom dv timings in the sub device.
247
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300248 enum_mbus_fmt: enumerate pixel formats, provided by a video data source
249
250 g_mbus_fmt: get the current pixel format, provided by a video data source
251
252 try_mbus_fmt: try to set a pixel format on a video data source
253
254 s_mbus_fmt: set a pixel format on a video data source
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300255 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300256struct v4l2_subdev_video_ops {
Hans Verkuil5325b422009-04-02 11:26:22 -0300257 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
Hans Verkuil3ff4ad82009-04-01 03:15:52 -0300258 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300259 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
Hans Verkuil1b6f1d92009-02-13 07:48:21 -0300260 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
261 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300262 int (*s_stream)(struct v4l2_subdev *sd, int enable);
Guennadi Liakhovetskib7f2cef2009-06-24 10:31:25 -0300263 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
264 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
265 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
Hans Verkuil2da94792009-02-06 18:59:35 -0300266 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
267 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
Laurent Pinchart35c30172010-05-05 11:38:35 -0300268 int (*g_frame_interval)(struct v4l2_subdev *sd,
269 struct v4l2_subdev_frame_interval *interval);
270 int (*s_frame_interval)(struct v4l2_subdev *sd,
271 struct v4l2_subdev_frame_interval *interval);
Hans Verkuil4b2ce112009-03-29 19:23:16 -0300272 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
273 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
Mats Randgaard6003b5c2010-05-05 05:08:22 -0300274 int (*enum_dv_presets) (struct v4l2_subdev *sd,
275 struct v4l2_dv_enum_preset *preset);
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300276 int (*s_dv_preset)(struct v4l2_subdev *sd,
277 struct v4l2_dv_preset *preset);
278 int (*query_dv_preset)(struct v4l2_subdev *sd,
279 struct v4l2_dv_preset *preset);
280 int (*s_dv_timings)(struct v4l2_subdev *sd,
281 struct v4l2_dv_timings *timings);
282 int (*g_dv_timings)(struct v4l2_subdev *sd,
283 struct v4l2_dv_timings *timings);
Hans Verkuil3805f202010-05-08 17:55:00 -0300284 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index,
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300285 enum v4l2_mbus_pixelcode *code);
Qing Xu03519b72011-01-20 05:19:40 -0300286 int (*enum_mbus_fsizes)(struct v4l2_subdev *sd,
287 struct v4l2_frmsizeenum *fsize);
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300288 int (*g_mbus_fmt)(struct v4l2_subdev *sd,
289 struct v4l2_mbus_framefmt *fmt);
290 int (*try_mbus_fmt)(struct v4l2_subdev *sd,
291 struct v4l2_mbus_framefmt *fmt);
292 int (*s_mbus_fmt)(struct v4l2_subdev *sd,
293 struct v4l2_mbus_framefmt *fmt);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300294};
295
Hans Verkuil32cd5272010-03-14 09:57:30 -0300296/*
297 decode_vbi_line: video decoders that support sliced VBI need to implement
298 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
299 start of the VBI data that was generated by the decoder. The driver
300 then parses the sliced VBI data and sets the other fields in the
301 struct accordingly. The pointer p is updated to point to the start of
302 the payload which can be copied verbatim into the data field of the
303 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
304 type field is set to 0 on return.
305
306 s_vbi_data: used to generate VBI signals on a video signal.
307 v4l2_sliced_vbi_data is filled with the data packets that should be
308 output. Note that if you set the line field to 0, then that VBI signal
309 is disabled. If no valid VBI data was found, then the type field is
310 set to 0 on return.
311
312 g_vbi_data: used to obtain the sliced VBI packet from a readback register.
313 Not all video decoders support this. If no data is available because
314 the readback register contains invalid or erroneous data -EIO is
315 returned. Note that you must fill in the 'id' member and the 'field'
316 member (to determine whether CC data from the first or second field
317 should be obtained).
Hans Verkuil54aefaf2010-03-14 10:02:50 -0300318
319 s_raw_fmt: setup the video encoder/decoder for raw VBI.
320
321 g_sliced_fmt: retrieve the current sliced VBI settings.
322
323 s_sliced_fmt: setup the sliced VBI settings.
Hans Verkuil32cd5272010-03-14 09:57:30 -0300324 */
325struct v4l2_subdev_vbi_ops {
326 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
327 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
328 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
329 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
Hans Verkuil54aefaf2010-03-14 10:02:50 -0300330 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
331 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
332 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
Hans Verkuil32cd5272010-03-14 09:57:30 -0300333};
334
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300335/**
336 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
337 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
338 * This is needed for some sensors, which always corrupt
339 * several top lines of the output image, or which send their
340 * metadata in them.
Laurent Pinchartf80a3ab2010-11-16 01:21:06 -0300341 * @g_skip_frames: number of frames to skip at stream start. This is needed for
342 * buggy sensors that generate faulty frames when they are
343 * turned on.
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300344 */
345struct v4l2_subdev_sensor_ops {
346 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
Laurent Pinchartf80a3ab2010-11-16 01:21:06 -0300347 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300348};
349
Andy Walls1d986ad2009-09-27 17:50:04 -0300350/*
Andy Walls1d986ad2009-09-27 17:50:04 -0300351 [rt]x_g_parameters: Get the current operating parameters and state of the
352 the IR receiver or transmitter.
353
354 [rt]x_s_parameters: Set the current operating parameters and state of the
355 the IR receiver or transmitter. It is recommended to call
356 [rt]x_g_parameters first to fill out the current state, and only change
357 the fields that need to be changed. Upon return, the actual device
358 operating parameters and state will be returned. Note that hardware
359 limitations may prevent the actual settings from matching the requested
360 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
361 was requested. An exception is when the shutdown parameter is true.
362 The last used operational parameters will be returned, but the actual
363 state of the hardware be different to minimize power consumption and
364 processing when shutdown is true.
365
366 rx_read: Reads received codes or pulse width data.
367 The semantics are similar to a non-blocking read() call.
368
369 tx_write: Writes codes or pulse width data for transmission.
370 The semantics are similar to a non-blocking write() call.
371 */
372
373enum v4l2_subdev_ir_mode {
Andy Wallsd69e85b2010-08-01 02:36:20 -0300374 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
Andy Walls1d986ad2009-09-27 17:50:04 -0300375};
376
Andy Walls1d986ad2009-09-27 17:50:04 -0300377struct v4l2_subdev_ir_parameters {
378 /* Either Rx or Tx */
379 unsigned int bytes_per_data_element; /* of data in read or write call */
380 enum v4l2_subdev_ir_mode mode;
381
382 bool enable;
383 bool interrupt_enable;
384 bool shutdown; /* true: set hardware to low/no power, false: normal */
385
386 bool modulation; /* true: uses carrier, false: baseband */
387 u32 max_pulse_width; /* ns, valid only for baseband signal */
388 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
389 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
Andy Walls5a28d9a2010-07-18 19:57:25 -0300390 bool invert_level; /* invert signal level */
391
392 /* Tx only */
393 bool invert_carrier_sense; /* Send 0/space as a carrier burst */
Andy Walls1d986ad2009-09-27 17:50:04 -0300394
395 /* Rx only */
396 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
397 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
398 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
399 u32 resolution; /* ns */
400};
401
402struct v4l2_subdev_ir_ops {
Andy Walls1d986ad2009-09-27 17:50:04 -0300403 /* Receiver */
404 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
405 ssize_t *num);
406
407 int (*rx_g_parameters)(struct v4l2_subdev *sd,
408 struct v4l2_subdev_ir_parameters *params);
409 int (*rx_s_parameters)(struct v4l2_subdev *sd,
410 struct v4l2_subdev_ir_parameters *params);
411
412 /* Transmitter */
413 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
414 ssize_t *num);
415
416 int (*tx_g_parameters)(struct v4l2_subdev *sd,
417 struct v4l2_subdev_ir_parameters *params);
418 int (*tx_s_parameters)(struct v4l2_subdev *sd,
419 struct v4l2_subdev_ir_parameters *params);
420};
421
Laurent Pincharteb08f352009-12-09 08:39:52 -0300422struct v4l2_subdev_pad_ops {
Laurent Pinchart333c8b92010-03-15 20:26:04 -0300423 int (*enum_mbus_code)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
424 struct v4l2_subdev_mbus_code_enum *code);
425 int (*enum_frame_size)(struct v4l2_subdev *sd,
426 struct v4l2_subdev_fh *fh,
427 struct v4l2_subdev_frame_size_enum *fse);
Laurent Pinchart35c30172010-05-05 11:38:35 -0300428 int (*enum_frame_interval)(struct v4l2_subdev *sd,
429 struct v4l2_subdev_fh *fh,
430 struct v4l2_subdev_frame_interval_enum *fie);
Laurent Pinchart333c8b92010-03-15 20:26:04 -0300431 int (*get_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
432 struct v4l2_subdev_format *format);
433 int (*set_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
434 struct v4l2_subdev_format *format);
Antti Koskipaaf6a5cb12010-06-23 05:03:42 -0300435 int (*set_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
436 struct v4l2_subdev_crop *crop);
437 int (*get_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
438 struct v4l2_subdev_crop *crop);
Laurent Pincharteb08f352009-12-09 08:39:52 -0300439};
440
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300441struct v4l2_subdev_ops {
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300442 const struct v4l2_subdev_core_ops *core;
443 const struct v4l2_subdev_tuner_ops *tuner;
444 const struct v4l2_subdev_audio_ops *audio;
445 const struct v4l2_subdev_video_ops *video;
Hans Verkuil32cd5272010-03-14 09:57:30 -0300446 const struct v4l2_subdev_vbi_ops *vbi;
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300447 const struct v4l2_subdev_ir_ops *ir;
448 const struct v4l2_subdev_sensor_ops *sensor;
Laurent Pincharteb08f352009-12-09 08:39:52 -0300449 const struct v4l2_subdev_pad_ops *pad;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300450};
451
Hans Verkuil45f6f842011-01-08 07:15:53 -0300452/*
453 * Internal ops. Never call this from drivers, only the v4l2 framework can call
454 * these ops.
455 *
456 * registered: called when this subdev is registered. When called the v4l2_dev
457 * field is set to the correct v4l2_device.
458 *
459 * unregistered: called when this subdev is unregistered. When called the
460 * v4l2_dev field is still set to the correct v4l2_device.
Laurent Pinchartf0beea82010-08-01 19:05:09 -0300461 *
462 * open: called when the subdev device node is opened by an application.
463 *
464 * close: called when the subdev device node is closed.
Hans Verkuil45f6f842011-01-08 07:15:53 -0300465 */
466struct v4l2_subdev_internal_ops {
467 int (*registered)(struct v4l2_subdev *sd);
468 void (*unregistered)(struct v4l2_subdev *sd);
Laurent Pinchartf0beea82010-08-01 19:05:09 -0300469 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
470 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
Hans Verkuil45f6f842011-01-08 07:15:53 -0300471};
472
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300473#define V4L2_SUBDEV_NAME_SIZE 32
474
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300475/* Set this flag if this subdev is a i2c device. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300476#define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
Dmitri Belimov85e09212010-03-23 11:23:29 -0300477/* Set this flag if this subdev is a spi device. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300478#define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
479/* Set this flag if this subdev needs a device node. */
480#define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300481/* Set this flag if this subdev generates events. */
482#define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300483
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300484/* Each instance of a subdev driver should create this struct, either
485 stand-alone or embedded in a larger struct.
486 */
487struct v4l2_subdev {
Laurent Pinchart61f5db52009-12-09 08:40:08 -0300488#if defined(CONFIG_MEDIA_CONTROLLER)
489 struct media_entity entity;
490#endif
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300491 struct list_head list;
492 struct module *owner;
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300493 u32 flags;
Hans Verkuilb0167602009-02-14 12:00:53 -0300494 struct v4l2_device *v4l2_dev;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300495 const struct v4l2_subdev_ops *ops;
Hans Verkuil45f6f842011-01-08 07:15:53 -0300496 /* Never call these internal ops from within a driver! */
497 const struct v4l2_subdev_internal_ops *internal_ops;
Hans Verkuil09965172010-08-01 14:32:42 -0300498 /* The control handler of this subdev. May be NULL. */
499 struct v4l2_ctrl_handler *ctrl_handler;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300500 /* name must be unique */
501 char name[V4L2_SUBDEV_NAME_SIZE];
502 /* can be used to group similar subdevs, value is driver-specific */
503 u32 grp_id;
504 /* pointer to private data */
Laurent Pinchart692d55222010-07-30 17:24:55 -0300505 void *dev_priv;
506 void *host_priv;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300507 /* subdev device node */
508 struct video_device devnode;
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300509 /* number of events to be allocated on open */
510 unsigned int nevents;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300511};
512
Laurent Pinchart61f5db52009-12-09 08:40:08 -0300513#define media_entity_to_v4l2_subdev(ent) \
514 container_of(ent, struct v4l2_subdev, entity)
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300515#define vdev_to_v4l2_subdev(vdev) \
516 container_of(vdev, struct v4l2_subdev, devnode)
517
Stanimir Varbanov7cd5a162010-05-21 06:04:24 -0300518/*
519 * Used for storing subdev information per file handle
520 */
521struct v4l2_subdev_fh {
522 struct v4l2_fh vfh;
523#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
524 struct v4l2_mbus_framefmt *try_fmt;
525 struct v4l2_rect *try_crop;
526#endif
527};
528
529#define to_v4l2_subdev_fh(fh) \
530 container_of(fh, struct v4l2_subdev_fh, vfh)
531
532#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
533static inline struct v4l2_mbus_framefmt *
534v4l2_subdev_get_try_format(struct v4l2_subdev_fh *fh, unsigned int pad)
535{
536 return &fh->try_fmt[pad];
537}
538
539static inline struct v4l2_rect *
540v4l2_subdev_get_try_crop(struct v4l2_subdev_fh *fh, unsigned int pad)
541{
542 return &fh->try_crop[pad];
543}
544#endif
545
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300546extern const struct v4l2_file_operations v4l2_subdev_fops;
547
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300548static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
549{
Laurent Pinchart692d55222010-07-30 17:24:55 -0300550 sd->dev_priv = p;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300551}
552
553static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
554{
Laurent Pinchart692d55222010-07-30 17:24:55 -0300555 return sd->dev_priv;
556}
557
558static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
559{
560 sd->host_priv = p;
561}
562
563static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
564{
565 return sd->host_priv;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300566}
567
Laurent Pinchart3dd5ee02009-12-09 08:38:52 -0300568void v4l2_subdev_init(struct v4l2_subdev *sd,
569 const struct v4l2_subdev_ops *ops);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300570
571/* Call an ops of a v4l2_subdev, doing the right checks against
572 NULL pointers.
573
574 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
575 */
576#define v4l2_subdev_call(sd, o, f, args...) \
Hans Verkuildbc8e342009-06-09 17:34:01 -0300577 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300578 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
579
Hans Verkuil98ec6332009-03-08 17:02:10 -0300580/* Send a notification to v4l2_device. */
581#define v4l2_subdev_notify(sd, notification, arg) \
582 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
583 (sd)->v4l2_dev->notify((sd), (notification), (arg)))
584
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300585#endif