blob: d4d3653426a9598bfe92e495192c9c04625ccf9c [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 Pinchart61f5db52009-12-09 08:40:08 -030024#include <media/media-entity.h>
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030025#include <media/v4l2-common.h>
Laurent Pinchart2096a5d2009-12-09 08:38:49 -030026#include <media/v4l2-dev.h>
Stanimir Varbanov7cd5a162010-05-21 06:04:24 -030027#include <media/v4l2-fh.h>
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -030028#include <media/v4l2-mediabus.h>
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030029
Andy Walls1d986ad2009-09-27 17:50:04 -030030/* generic v4l2_device notify callback notification values */
31#define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32)
32#define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001
33#define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002
34#define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004
35#define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008
36
37#define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32)
38#define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001
39
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030040struct v4l2_device;
Hans Verkuil09965172010-08-01 14:32:42 -030041struct v4l2_ctrl_handler;
Sakari Ailus02adb1c2010-03-03 12:49:38 -030042struct v4l2_event_subscription;
43struct v4l2_fh;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030044struct v4l2_subdev;
Laurent Pinchartf0beea82010-08-01 19:05:09 -030045struct v4l2_subdev_fh;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030046struct tuner_setup;
47
Hans Verkuil78a3b4d2009-04-01 03:41:09 -030048/* decode_vbi_line */
49struct v4l2_decode_vbi_line {
50 u32 is_second_field; /* Set to 0 for the first (odd) field,
51 set to 1 for the second (even) field. */
52 u8 *p; /* Pointer to the sliced VBI data from the decoder.
53 On exit points to the start of the payload. */
54 u32 line; /* Line number of the sliced VBI data (1-23) */
55 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
56};
57
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030058/* Sub-devices are devices that are connected somehow to the main bridge
59 device. These devices are usually audio/video muxers/encoders/decoders or
60 sensors and webcam controllers.
61
62 Usually these devices are controlled through an i2c bus, but other busses
63 may also be used.
64
65 The v4l2_subdev struct provides a way of accessing these devices in a
66 generic manner. Most operations that these sub-devices support fall in
67 a few categories: core ops, audio ops, video ops and tuner ops.
68
69 More categories can be added if needed, although this should remain a
70 limited set (no more than approx. 8 categories).
71
72 Each category has its own set of ops that subdev drivers can implement.
73
74 A subdev driver can leave the pointer to the category ops NULL if
75 it does not implement them (e.g. an audio subdev will generally not
76 implement the video category ops). The exception is the core category:
77 this must always be present.
78
79 These ops are all used internally so it is no problem to change, remove
80 or add ops or move ops from one to another category. Currently these
81 ops are based on the original ioctls, but since ops are not limited to
82 one argument there is room for improvement here once all i2c subdev
83 drivers are converted to use these ops.
84 */
85
86/* Core ops: it is highly recommended to implement at least these ops:
87
88 g_chip_ident
89 log_status
90 g_register
91 s_register
92
93 This provides basic debugging support.
94
95 The ioctl ops is meant for generic ioctl-like commands. Depending on
96 the use-case it might be better to use subdev-specific ops (currently
97 not yet implemented) since ops provide proper type-checking.
98 */
Hans Verkuil78a3b4d2009-04-01 03:41:09 -030099
Andy Walls66752f82010-07-18 18:51:10 -0300100/* Subdevice external IO pin configuration */
101#define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */
102#define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1)
103#define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2)
104#define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */
105#define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */
106
107struct v4l2_subdev_io_pin_config {
108 u32 flags; /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */
109 u8 pin; /* Chip external IO pin to configure */
110 u8 function; /* Internal signal pad/function to route to IO pin */
111 u8 value; /* Initial value for pin - e.g. GPIO output value */
112 u8 strength; /* Pin drive strength */
113};
114
Hans Verkuil3c7c9372011-01-08 07:08:02 -0300115/*
Andy Walls66752f82010-07-18 18:51:10 -0300116 s_io_pin_config: configure one or more chip I/O pins for chips that
117 multiplex different internal signal pads out to IO pins. This function
118 takes a pointer to an array of 'n' pin configuration entries, one for
119 each pin being configured. This function could be called at times
120 other than just subdevice initialization.
121
Hans Verkuilf0222c72009-06-09 17:12:33 -0300122 init: initialize the sensor registors to some sort of reasonable default
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300123 values. Do not use for new drivers and should be removed in existing
124 drivers.
125
Hans Verkuilcc26b072009-03-29 19:20:26 -0300126 load_fw: load firmware.
127
128 reset: generic reset command. The argument selects which subsystems to
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300129 reset. Passing 0 will always reset the whole chip. Do not use for new
130 drivers without discussing this first on the linux-media mailinglist.
131 There should be no reason normally to reset a device.
132
133 s_gpio: set GPIO pins. Very simple right now, might need to be extended with
134 a direction argument if needed.
Laurent Pinchart622b8282009-10-05 10:48:17 -0300135
136 s_power: puts subdevice in power saving mode (on == 0) or normal operation
137 mode (on == 1).
Andy Walls260e689b2010-07-18 20:54:52 -0300138
139 interrupt_service_routine: Called by the bridge chip's interrupt service
140 handler, when an interrupt status has be raised due to this subdev,
141 so that this subdev can handle the details. It may schedule work to be
142 performed later. It must not sleep. *Called from an IRQ context*.
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300143 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300144struct v4l2_subdev_core_ops {
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300145 int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300146 int (*log_status)(struct v4l2_subdev *sd);
Andy Walls66752f82010-07-18 18:51:10 -0300147 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
148 struct v4l2_subdev_io_pin_config *pincfg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300149 int (*init)(struct v4l2_subdev *sd, u32 val);
Hans Verkuilcc26b072009-03-29 19:20:26 -0300150 int (*load_fw)(struct v4l2_subdev *sd);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300151 int (*reset)(struct v4l2_subdev *sd, u32 val);
152 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
153 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
154 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
155 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
Hans Verkuil952617f2009-01-12 18:17:14 -0300156 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
157 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
158 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300159 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
Hans Verkuilf41737e2009-04-01 03:52:39 -0300160 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
Hans Verkuil069b7472008-12-30 07:04:34 -0300161 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300162#ifdef CONFIG_VIDEO_ADV_DEBUG
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300163 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
164 int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300165#endif
Laurent Pinchart622b8282009-10-05 10:48:17 -0300166 int (*s_power)(struct v4l2_subdev *sd, int on);
Andy Walls260e689b2010-07-18 20:54:52 -0300167 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
168 u32 status, bool *handled);
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300169 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
170 struct v4l2_event_subscription *sub);
171 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
172 struct v4l2_event_subscription *sub);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300173};
174
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300175/* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
176
177 s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
178
179 s_type_addr: sets tuner type and its I2C addr.
180
181 s_config: sets tda9887 specific stuff, like port1, port2 and qss
182 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300183struct v4l2_subdev_tuner_ops {
184 int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
185 int (*s_radio)(struct v4l2_subdev *sd);
186 int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
187 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
188 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
189 int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
Eduardo Valentind6bacea2009-08-08 08:34:18 -0300190 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
191 int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300192 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
193 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
194};
195
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300196/* s_clock_freq: set the frequency (in Hz) of the audio clock output.
197 Used to slave an audio processor to the video decoder, ensuring that
198 audio and video remain synchronized. Usual values for the frequency
199 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
200 -EINVAL is returned.
201
202 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
203 way to select I2S clock used by driving digital audio streams at some
204 board designs. Usual values for the frequency are 1024000 and 2048000.
205 If the frequency is not supported, then -EINVAL is returned.
206
Hans Verkuil5325b422009-04-02 11:26:22 -0300207 s_routing: used to define the input and/or output pins of an audio chip,
208 and any additional configuration data.
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300209 Never attempt to use user-level input IDs (e.g. Composite, S-Video,
210 Tuner) at this level. An i2c device shouldn't know about whether an
211 input pin is connected to a Composite connector, become on another
212 board or platform it might be connected to something else entirely.
213 The calling driver is responsible for mapping a user-level input to
214 the right pins on the i2c device.
215 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300216struct v4l2_subdev_audio_ops {
217 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
218 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
Hans Verkuil5325b422009-04-02 11:26:22 -0300219 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
Andy Walls3ccc6462009-12-24 13:06:08 -0300220 int (*s_stream)(struct v4l2_subdev *sd, int enable);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300221};
222
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300223/*
Hans Verkuilcc26b072009-03-29 19:20:26 -0300224 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300225 video input devices.
226
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300227 s_crystal_freq: sets the frequency of the crystal used to generate the
Hans Verkuil3ff4ad82009-04-01 03:15:52 -0300228 clocks in Hz. An extra flags field allows device specific configuration
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300229 regarding clock frequency dividers, etc. If not used, then set flags
230 to 0. If the frequency is not supported, then -EINVAL is returned.
231
Hans Verkuilcc26b072009-03-29 19:20:26 -0300232 g_input_status: get input status. Same as the status field in the v4l2_input
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300233 struct.
234
Hans Verkuilcc26b072009-03-29 19:20:26 -0300235 s_routing: see s_routing in audio_ops, except this version is for video
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300236 devices.
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300237
238 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
239 s_std()
240
241 query_dv_preset: query dv preset in the sub device. This is similar to
242 querystd()
243
244 s_dv_timings(): Set custom dv timings in the sub device. This is used
245 when sub device is capable of setting detailed timing information
246 in the hardware to generate/detect the video signal.
247
248 g_dv_timings(): Get custom dv timings in the sub device.
249
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300250 enum_mbus_fmt: enumerate pixel formats, provided by a video data source
251
252 g_mbus_fmt: get the current pixel format, provided by a video data source
253
254 try_mbus_fmt: try to set a pixel format on a video data source
255
256 s_mbus_fmt: set a pixel format on a video data source
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300257 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300258struct v4l2_subdev_video_ops {
Hans Verkuil5325b422009-04-02 11:26:22 -0300259 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
Hans Verkuil3ff4ad82009-04-01 03:15:52 -0300260 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300261 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
Hans Verkuil1b6f1d92009-02-13 07:48:21 -0300262 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
263 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300264 int (*s_stream)(struct v4l2_subdev *sd, int enable);
Guennadi Liakhovetskib7f2cef2009-06-24 10:31:25 -0300265 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
266 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
267 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
Hans Verkuil2da94792009-02-06 18:59:35 -0300268 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
269 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
Hans Verkuil4b2ce112009-03-29 19:23:16 -0300270 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
271 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
Mats Randgaard6003b5c2010-05-05 05:08:22 -0300272 int (*enum_dv_presets) (struct v4l2_subdev *sd,
273 struct v4l2_dv_enum_preset *preset);
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300274 int (*s_dv_preset)(struct v4l2_subdev *sd,
275 struct v4l2_dv_preset *preset);
276 int (*query_dv_preset)(struct v4l2_subdev *sd,
277 struct v4l2_dv_preset *preset);
278 int (*s_dv_timings)(struct v4l2_subdev *sd,
279 struct v4l2_dv_timings *timings);
280 int (*g_dv_timings)(struct v4l2_subdev *sd,
281 struct v4l2_dv_timings *timings);
Hans Verkuil3805f202010-05-08 17:55:00 -0300282 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index,
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300283 enum v4l2_mbus_pixelcode *code);
Qing Xu03519b72011-01-20 05:19:40 -0300284 int (*enum_mbus_fsizes)(struct v4l2_subdev *sd,
285 struct v4l2_frmsizeenum *fsize);
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300286 int (*g_mbus_fmt)(struct v4l2_subdev *sd,
287 struct v4l2_mbus_framefmt *fmt);
288 int (*try_mbus_fmt)(struct v4l2_subdev *sd,
289 struct v4l2_mbus_framefmt *fmt);
290 int (*s_mbus_fmt)(struct v4l2_subdev *sd,
291 struct v4l2_mbus_framefmt *fmt);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300292};
293
Hans Verkuil32cd5272010-03-14 09:57:30 -0300294/*
295 decode_vbi_line: video decoders that support sliced VBI need to implement
296 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
297 start of the VBI data that was generated by the decoder. The driver
298 then parses the sliced VBI data and sets the other fields in the
299 struct accordingly. The pointer p is updated to point to the start of
300 the payload which can be copied verbatim into the data field of the
301 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
302 type field is set to 0 on return.
303
304 s_vbi_data: used to generate VBI signals on a video signal.
305 v4l2_sliced_vbi_data is filled with the data packets that should be
306 output. Note that if you set the line field to 0, then that VBI signal
307 is disabled. If no valid VBI data was found, then the type field is
308 set to 0 on return.
309
310 g_vbi_data: used to obtain the sliced VBI packet from a readback register.
311 Not all video decoders support this. If no data is available because
312 the readback register contains invalid or erroneous data -EIO is
313 returned. Note that you must fill in the 'id' member and the 'field'
314 member (to determine whether CC data from the first or second field
315 should be obtained).
Hans Verkuil54aefaf2010-03-14 10:02:50 -0300316
317 s_raw_fmt: setup the video encoder/decoder for raw VBI.
318
319 g_sliced_fmt: retrieve the current sliced VBI settings.
320
321 s_sliced_fmt: setup the sliced VBI settings.
Hans Verkuil32cd5272010-03-14 09:57:30 -0300322 */
323struct v4l2_subdev_vbi_ops {
324 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
325 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
326 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
327 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
Hans Verkuil54aefaf2010-03-14 10:02:50 -0300328 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
329 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
330 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
Hans Verkuil32cd5272010-03-14 09:57:30 -0300331};
332
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300333/**
334 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
335 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
336 * This is needed for some sensors, which always corrupt
337 * several top lines of the output image, or which send their
338 * metadata in them.
339 */
340struct v4l2_subdev_sensor_ops {
341 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
342};
343
Andy Walls1d986ad2009-09-27 17:50:04 -0300344/*
Andy Walls1d986ad2009-09-27 17:50:04 -0300345 [rt]x_g_parameters: Get the current operating parameters and state of the
346 the IR receiver or transmitter.
347
348 [rt]x_s_parameters: Set the current operating parameters and state of the
349 the IR receiver or transmitter. It is recommended to call
350 [rt]x_g_parameters first to fill out the current state, and only change
351 the fields that need to be changed. Upon return, the actual device
352 operating parameters and state will be returned. Note that hardware
353 limitations may prevent the actual settings from matching the requested
354 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
355 was requested. An exception is when the shutdown parameter is true.
356 The last used operational parameters will be returned, but the actual
357 state of the hardware be different to minimize power consumption and
358 processing when shutdown is true.
359
360 rx_read: Reads received codes or pulse width data.
361 The semantics are similar to a non-blocking read() call.
362
363 tx_write: Writes codes or pulse width data for transmission.
364 The semantics are similar to a non-blocking write() call.
365 */
366
367enum v4l2_subdev_ir_mode {
Andy Wallsd69e85b2010-08-01 02:36:20 -0300368 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
Andy Walls1d986ad2009-09-27 17:50:04 -0300369};
370
Andy Walls1d986ad2009-09-27 17:50:04 -0300371struct v4l2_subdev_ir_parameters {
372 /* Either Rx or Tx */
373 unsigned int bytes_per_data_element; /* of data in read or write call */
374 enum v4l2_subdev_ir_mode mode;
375
376 bool enable;
377 bool interrupt_enable;
378 bool shutdown; /* true: set hardware to low/no power, false: normal */
379
380 bool modulation; /* true: uses carrier, false: baseband */
381 u32 max_pulse_width; /* ns, valid only for baseband signal */
382 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
383 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
Andy Walls5a28d9a2010-07-18 19:57:25 -0300384 bool invert_level; /* invert signal level */
385
386 /* Tx only */
387 bool invert_carrier_sense; /* Send 0/space as a carrier burst */
Andy Walls1d986ad2009-09-27 17:50:04 -0300388
389 /* Rx only */
390 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
391 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
392 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
393 u32 resolution; /* ns */
394};
395
396struct v4l2_subdev_ir_ops {
Andy Walls1d986ad2009-09-27 17:50:04 -0300397 /* Receiver */
398 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
399 ssize_t *num);
400
401 int (*rx_g_parameters)(struct v4l2_subdev *sd,
402 struct v4l2_subdev_ir_parameters *params);
403 int (*rx_s_parameters)(struct v4l2_subdev *sd,
404 struct v4l2_subdev_ir_parameters *params);
405
406 /* Transmitter */
407 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
408 ssize_t *num);
409
410 int (*tx_g_parameters)(struct v4l2_subdev *sd,
411 struct v4l2_subdev_ir_parameters *params);
412 int (*tx_s_parameters)(struct v4l2_subdev *sd,
413 struct v4l2_subdev_ir_parameters *params);
414};
415
Laurent Pincharteb08f352009-12-09 08:39:52 -0300416struct v4l2_subdev_pad_ops {
417};
418
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300419struct v4l2_subdev_ops {
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300420 const struct v4l2_subdev_core_ops *core;
421 const struct v4l2_subdev_tuner_ops *tuner;
422 const struct v4l2_subdev_audio_ops *audio;
423 const struct v4l2_subdev_video_ops *video;
Hans Verkuil32cd5272010-03-14 09:57:30 -0300424 const struct v4l2_subdev_vbi_ops *vbi;
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300425 const struct v4l2_subdev_ir_ops *ir;
426 const struct v4l2_subdev_sensor_ops *sensor;
Laurent Pincharteb08f352009-12-09 08:39:52 -0300427 const struct v4l2_subdev_pad_ops *pad;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300428};
429
Hans Verkuil45f6f842011-01-08 07:15:53 -0300430/*
431 * Internal ops. Never call this from drivers, only the v4l2 framework can call
432 * these ops.
433 *
434 * registered: called when this subdev is registered. When called the v4l2_dev
435 * field is set to the correct v4l2_device.
436 *
437 * unregistered: called when this subdev is unregistered. When called the
438 * v4l2_dev field is still set to the correct v4l2_device.
Laurent Pinchartf0beea82010-08-01 19:05:09 -0300439 *
440 * open: called when the subdev device node is opened by an application.
441 *
442 * close: called when the subdev device node is closed.
Hans Verkuil45f6f842011-01-08 07:15:53 -0300443 */
444struct v4l2_subdev_internal_ops {
445 int (*registered)(struct v4l2_subdev *sd);
446 void (*unregistered)(struct v4l2_subdev *sd);
Laurent Pinchartf0beea82010-08-01 19:05:09 -0300447 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
448 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
Hans Verkuil45f6f842011-01-08 07:15:53 -0300449};
450
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300451#define V4L2_SUBDEV_NAME_SIZE 32
452
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300453/* Set this flag if this subdev is a i2c device. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300454#define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
Dmitri Belimov85e09212010-03-23 11:23:29 -0300455/* Set this flag if this subdev is a spi device. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300456#define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
457/* Set this flag if this subdev needs a device node. */
458#define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300459/* Set this flag if this subdev generates events. */
460#define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300461
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300462/* Each instance of a subdev driver should create this struct, either
463 stand-alone or embedded in a larger struct.
464 */
465struct v4l2_subdev {
Laurent Pinchart61f5db52009-12-09 08:40:08 -0300466#if defined(CONFIG_MEDIA_CONTROLLER)
467 struct media_entity entity;
468#endif
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300469 struct list_head list;
470 struct module *owner;
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300471 u32 flags;
Hans Verkuilb0167602009-02-14 12:00:53 -0300472 struct v4l2_device *v4l2_dev;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300473 const struct v4l2_subdev_ops *ops;
Hans Verkuil45f6f842011-01-08 07:15:53 -0300474 /* Never call these internal ops from within a driver! */
475 const struct v4l2_subdev_internal_ops *internal_ops;
Hans Verkuil09965172010-08-01 14:32:42 -0300476 /* The control handler of this subdev. May be NULL. */
477 struct v4l2_ctrl_handler *ctrl_handler;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300478 /* name must be unique */
479 char name[V4L2_SUBDEV_NAME_SIZE];
480 /* can be used to group similar subdevs, value is driver-specific */
481 u32 grp_id;
482 /* pointer to private data */
Laurent Pinchart692d55222010-07-30 17:24:55 -0300483 void *dev_priv;
484 void *host_priv;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300485 /* subdev device node */
486 struct video_device devnode;
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300487 /* number of events to be allocated on open */
488 unsigned int nevents;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300489};
490
Laurent Pinchart61f5db52009-12-09 08:40:08 -0300491#define media_entity_to_v4l2_subdev(ent) \
492 container_of(ent, struct v4l2_subdev, entity)
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300493#define vdev_to_v4l2_subdev(vdev) \
494 container_of(vdev, struct v4l2_subdev, devnode)
495
Stanimir Varbanov7cd5a162010-05-21 06:04:24 -0300496/*
497 * Used for storing subdev information per file handle
498 */
499struct v4l2_subdev_fh {
500 struct v4l2_fh vfh;
501#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
502 struct v4l2_mbus_framefmt *try_fmt;
503 struct v4l2_rect *try_crop;
504#endif
505};
506
507#define to_v4l2_subdev_fh(fh) \
508 container_of(fh, struct v4l2_subdev_fh, vfh)
509
510#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
511static inline struct v4l2_mbus_framefmt *
512v4l2_subdev_get_try_format(struct v4l2_subdev_fh *fh, unsigned int pad)
513{
514 return &fh->try_fmt[pad];
515}
516
517static inline struct v4l2_rect *
518v4l2_subdev_get_try_crop(struct v4l2_subdev_fh *fh, unsigned int pad)
519{
520 return &fh->try_crop[pad];
521}
522#endif
523
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300524extern const struct v4l2_file_operations v4l2_subdev_fops;
525
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300526static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
527{
Laurent Pinchart692d55222010-07-30 17:24:55 -0300528 sd->dev_priv = p;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300529}
530
531static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
532{
Laurent Pinchart692d55222010-07-30 17:24:55 -0300533 return sd->dev_priv;
534}
535
536static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
537{
538 sd->host_priv = p;
539}
540
541static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
542{
543 return sd->host_priv;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300544}
545
Laurent Pinchart3dd5ee02009-12-09 08:38:52 -0300546void v4l2_subdev_init(struct v4l2_subdev *sd,
547 const struct v4l2_subdev_ops *ops);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300548
549/* Call an ops of a v4l2_subdev, doing the right checks against
550 NULL pointers.
551
552 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
553 */
554#define v4l2_subdev_call(sd, o, f, args...) \
Hans Verkuildbc8e342009-06-09 17:34:01 -0300555 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300556 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
557
Hans Verkuil98ec6332009-03-08 17:02:10 -0300558/* Send a notification to v4l2_device. */
559#define v4l2_subdev_notify(sd, notification, arg) \
560 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
561 (sd)->v4l2_dev->notify((sd), (notification), (arg)))
562
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300563#endif