blob: 72f49eb3002babbab1e69a8aa49a68768c96037d [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;
45struct tuner_setup;
46
Hans Verkuil78a3b4d2009-04-01 03:41:09 -030047/* decode_vbi_line */
48struct v4l2_decode_vbi_line {
49 u32 is_second_field; /* Set to 0 for the first (odd) field,
50 set to 1 for the second (even) field. */
51 u8 *p; /* Pointer to the sliced VBI data from the decoder.
52 On exit points to the start of the payload. */
53 u32 line; /* Line number of the sliced VBI data (1-23) */
54 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
55};
56
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -030057/* Sub-devices are devices that are connected somehow to the main bridge
58 device. These devices are usually audio/video muxers/encoders/decoders or
59 sensors and webcam controllers.
60
61 Usually these devices are controlled through an i2c bus, but other busses
62 may also be used.
63
64 The v4l2_subdev struct provides a way of accessing these devices in a
65 generic manner. Most operations that these sub-devices support fall in
66 a few categories: core ops, audio ops, video ops and tuner ops.
67
68 More categories can be added if needed, although this should remain a
69 limited set (no more than approx. 8 categories).
70
71 Each category has its own set of ops that subdev drivers can implement.
72
73 A subdev driver can leave the pointer to the category ops NULL if
74 it does not implement them (e.g. an audio subdev will generally not
75 implement the video category ops). The exception is the core category:
76 this must always be present.
77
78 These ops are all used internally so it is no problem to change, remove
79 or add ops or move ops from one to another category. Currently these
80 ops are based on the original ioctls, but since ops are not limited to
81 one argument there is room for improvement here once all i2c subdev
82 drivers are converted to use these ops.
83 */
84
85/* Core ops: it is highly recommended to implement at least these ops:
86
87 g_chip_ident
88 log_status
89 g_register
90 s_register
91
92 This provides basic debugging support.
93
94 The ioctl ops is meant for generic ioctl-like commands. Depending on
95 the use-case it might be better to use subdev-specific ops (currently
96 not yet implemented) since ops provide proper type-checking.
97 */
Hans Verkuil78a3b4d2009-04-01 03:41:09 -030098
Andy Walls66752f82010-07-18 18:51:10 -030099/* Subdevice external IO pin configuration */
100#define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */
101#define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1)
102#define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2)
103#define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */
104#define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */
105
106struct v4l2_subdev_io_pin_config {
107 u32 flags; /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */
108 u8 pin; /* Chip external IO pin to configure */
109 u8 function; /* Internal signal pad/function to route to IO pin */
110 u8 value; /* Initial value for pin - e.g. GPIO output value */
111 u8 strength; /* Pin drive strength */
112};
113
Hans Verkuil3c7c9372011-01-08 07:08:02 -0300114/*
Andy Walls66752f82010-07-18 18:51:10 -0300115 s_io_pin_config: configure one or more chip I/O pins for chips that
116 multiplex different internal signal pads out to IO pins. This function
117 takes a pointer to an array of 'n' pin configuration entries, one for
118 each pin being configured. This function could be called at times
119 other than just subdevice initialization.
120
Hans Verkuilf0222c72009-06-09 17:12:33 -0300121 init: initialize the sensor registors to some sort of reasonable default
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300122 values. Do not use for new drivers and should be removed in existing
123 drivers.
124
Hans Verkuilcc26b072009-03-29 19:20:26 -0300125 load_fw: load firmware.
126
127 reset: generic reset command. The argument selects which subsystems to
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300128 reset. Passing 0 will always reset the whole chip. Do not use for new
129 drivers without discussing this first on the linux-media mailinglist.
130 There should be no reason normally to reset a device.
131
132 s_gpio: set GPIO pins. Very simple right now, might need to be extended with
133 a direction argument if needed.
Laurent Pinchart622b8282009-10-05 10:48:17 -0300134
135 s_power: puts subdevice in power saving mode (on == 0) or normal operation
136 mode (on == 1).
Andy Walls260e689b2010-07-18 20:54:52 -0300137
138 interrupt_service_routine: Called by the bridge chip's interrupt service
139 handler, when an interrupt status has be raised due to this subdev,
140 so that this subdev can handle the details. It may schedule work to be
141 performed later. It must not sleep. *Called from an IRQ context*.
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300142 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300143struct v4l2_subdev_core_ops {
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300144 int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300145 int (*log_status)(struct v4l2_subdev *sd);
Andy Walls66752f82010-07-18 18:51:10 -0300146 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
147 struct v4l2_subdev_io_pin_config *pincfg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300148 int (*init)(struct v4l2_subdev *sd, u32 val);
Hans Verkuilcc26b072009-03-29 19:20:26 -0300149 int (*load_fw)(struct v4l2_subdev *sd);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300150 int (*reset)(struct v4l2_subdev *sd, u32 val);
151 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
152 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
153 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
154 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
Hans Verkuil952617f2009-01-12 18:17:14 -0300155 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
156 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
157 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300158 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
Hans Verkuilf41737e2009-04-01 03:52:39 -0300159 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
Hans Verkuil069b7472008-12-30 07:04:34 -0300160 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300161#ifdef CONFIG_VIDEO_ADV_DEBUG
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300162 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
163 int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300164#endif
Laurent Pinchart622b8282009-10-05 10:48:17 -0300165 int (*s_power)(struct v4l2_subdev *sd, int on);
Andy Walls260e689b2010-07-18 20:54:52 -0300166 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
167 u32 status, bool *handled);
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300168 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
169 struct v4l2_event_subscription *sub);
170 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
171 struct v4l2_event_subscription *sub);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300172};
173
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300174/* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
175
176 s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
177
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 {
183 int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
184 int (*s_radio)(struct v4l2_subdev *sd);
185 int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
186 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
187 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
188 int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
Eduardo Valentind6bacea2009-08-08 08:34:18 -0300189 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
190 int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300191 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
192 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
193};
194
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300195/* s_clock_freq: set the frequency (in Hz) of the audio clock output.
196 Used to slave an audio processor to the video decoder, ensuring that
197 audio and video remain synchronized. Usual values for the frequency
198 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
199 -EINVAL is returned.
200
201 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
202 way to select I2S clock used by driving digital audio streams at some
203 board designs. Usual values for the frequency are 1024000 and 2048000.
204 If the frequency is not supported, then -EINVAL is returned.
205
Hans Verkuil5325b422009-04-02 11:26:22 -0300206 s_routing: used to define the input and/or output pins of an audio chip,
207 and any additional configuration data.
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300208 Never attempt to use user-level input IDs (e.g. Composite, S-Video,
209 Tuner) at this level. An i2c device shouldn't know about whether an
210 input pin is connected to a Composite connector, become on another
211 board or platform it might be connected to something else entirely.
212 The calling driver is responsible for mapping a user-level input to
213 the right pins on the i2c device.
214 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300215struct v4l2_subdev_audio_ops {
216 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
217 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
Hans Verkuil5325b422009-04-02 11:26:22 -0300218 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
Andy Walls3ccc6462009-12-24 13:06:08 -0300219 int (*s_stream)(struct v4l2_subdev *sd, int enable);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300220};
221
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300222/*
Hans Verkuilcc26b072009-03-29 19:20:26 -0300223 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300224 video input devices.
225
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300226 s_crystal_freq: sets the frequency of the crystal used to generate the
Hans Verkuil3ff4ad82009-04-01 03:15:52 -0300227 clocks in Hz. An extra flags field allows device specific configuration
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300228 regarding clock frequency dividers, etc. If not used, then set flags
229 to 0. If the frequency is not supported, then -EINVAL is returned.
230
Hans Verkuilcc26b072009-03-29 19:20:26 -0300231 g_input_status: get input status. Same as the status field in the v4l2_input
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300232 struct.
233
Hans Verkuilcc26b072009-03-29 19:20:26 -0300234 s_routing: see s_routing in audio_ops, except this version is for video
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300235 devices.
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300236
237 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
238 s_std()
239
240 query_dv_preset: query dv preset in the sub device. This is similar to
241 querystd()
242
243 s_dv_timings(): Set custom dv timings in the sub device. This is used
244 when sub device is capable of setting detailed timing information
245 in the hardware to generate/detect the video signal.
246
247 g_dv_timings(): Get custom dv timings in the sub device.
248
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300249 enum_mbus_fmt: enumerate pixel formats, provided by a video data source
250
251 g_mbus_fmt: get the current pixel format, provided by a video data source
252
253 try_mbus_fmt: try to set a pixel format on a video data source
254
255 s_mbus_fmt: set a pixel format on a video data source
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300256 */
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300257struct v4l2_subdev_video_ops {
Hans Verkuil5325b422009-04-02 11:26:22 -0300258 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
Hans Verkuil3ff4ad82009-04-01 03:15:52 -0300259 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300260 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
Hans Verkuil1b6f1d92009-02-13 07:48:21 -0300261 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
262 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300263 int (*s_stream)(struct v4l2_subdev *sd, int enable);
Guennadi Liakhovetskib7f2cef2009-06-24 10:31:25 -0300264 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
265 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
266 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
Hans Verkuil2da94792009-02-06 18:59:35 -0300267 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
268 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
Hans Verkuil4b2ce112009-03-29 19:23:16 -0300269 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
270 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
Mats Randgaard6003b5c2010-05-05 05:08:22 -0300271 int (*enum_dv_presets) (struct v4l2_subdev *sd,
272 struct v4l2_dv_enum_preset *preset);
Muralidharan Karicherib6456c02009-11-19 12:00:31 -0300273 int (*s_dv_preset)(struct v4l2_subdev *sd,
274 struct v4l2_dv_preset *preset);
275 int (*query_dv_preset)(struct v4l2_subdev *sd,
276 struct v4l2_dv_preset *preset);
277 int (*s_dv_timings)(struct v4l2_subdev *sd,
278 struct v4l2_dv_timings *timings);
279 int (*g_dv_timings)(struct v4l2_subdev *sd,
280 struct v4l2_dv_timings *timings);
Hans Verkuil3805f202010-05-08 17:55:00 -0300281 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index,
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300282 enum v4l2_mbus_pixelcode *code);
Qing Xu03519b72011-01-20 05:19:40 -0300283 int (*enum_mbus_fsizes)(struct v4l2_subdev *sd,
284 struct v4l2_frmsizeenum *fsize);
Guennadi Liakhovetski9a742512009-12-11 11:41:28 -0300285 int (*g_mbus_fmt)(struct v4l2_subdev *sd,
286 struct v4l2_mbus_framefmt *fmt);
287 int (*try_mbus_fmt)(struct v4l2_subdev *sd,
288 struct v4l2_mbus_framefmt *fmt);
289 int (*s_mbus_fmt)(struct v4l2_subdev *sd,
290 struct v4l2_mbus_framefmt *fmt);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300291};
292
Hans Verkuil32cd5272010-03-14 09:57:30 -0300293/*
294 decode_vbi_line: video decoders that support sliced VBI need to implement
295 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
296 start of the VBI data that was generated by the decoder. The driver
297 then parses the sliced VBI data and sets the other fields in the
298 struct accordingly. The pointer p is updated to point to the start of
299 the payload which can be copied verbatim into the data field of the
300 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
301 type field is set to 0 on return.
302
303 s_vbi_data: used to generate VBI signals on a video signal.
304 v4l2_sliced_vbi_data is filled with the data packets that should be
305 output. Note that if you set the line field to 0, then that VBI signal
306 is disabled. If no valid VBI data was found, then the type field is
307 set to 0 on return.
308
309 g_vbi_data: used to obtain the sliced VBI packet from a readback register.
310 Not all video decoders support this. If no data is available because
311 the readback register contains invalid or erroneous data -EIO is
312 returned. Note that you must fill in the 'id' member and the 'field'
313 member (to determine whether CC data from the first or second field
314 should be obtained).
Hans Verkuil54aefaf2010-03-14 10:02:50 -0300315
316 s_raw_fmt: setup the video encoder/decoder for raw VBI.
317
318 g_sliced_fmt: retrieve the current sliced VBI settings.
319
320 s_sliced_fmt: setup the sliced VBI settings.
Hans Verkuil32cd5272010-03-14 09:57:30 -0300321 */
322struct v4l2_subdev_vbi_ops {
323 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
324 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
325 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
326 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
Hans Verkuil54aefaf2010-03-14 10:02:50 -0300327 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
328 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
329 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
Hans Verkuil32cd5272010-03-14 09:57:30 -0300330};
331
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300332/**
333 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
334 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
335 * This is needed for some sensors, which always corrupt
336 * several top lines of the output image, or which send their
337 * metadata in them.
338 */
339struct v4l2_subdev_sensor_ops {
340 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
341};
342
Andy Walls1d986ad2009-09-27 17:50:04 -0300343/*
Andy Walls1d986ad2009-09-27 17:50:04 -0300344 [rt]x_g_parameters: Get the current operating parameters and state of the
345 the IR receiver or transmitter.
346
347 [rt]x_s_parameters: Set the current operating parameters and state of the
348 the IR receiver or transmitter. It is recommended to call
349 [rt]x_g_parameters first to fill out the current state, and only change
350 the fields that need to be changed. Upon return, the actual device
351 operating parameters and state will be returned. Note that hardware
352 limitations may prevent the actual settings from matching the requested
353 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
354 was requested. An exception is when the shutdown parameter is true.
355 The last used operational parameters will be returned, but the actual
356 state of the hardware be different to minimize power consumption and
357 processing when shutdown is true.
358
359 rx_read: Reads received codes or pulse width data.
360 The semantics are similar to a non-blocking read() call.
361
362 tx_write: Writes codes or pulse width data for transmission.
363 The semantics are similar to a non-blocking write() call.
364 */
365
366enum v4l2_subdev_ir_mode {
Andy Wallsd69e85b2010-08-01 02:36:20 -0300367 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
Andy Walls1d986ad2009-09-27 17:50:04 -0300368};
369
Andy Walls1d986ad2009-09-27 17:50:04 -0300370struct v4l2_subdev_ir_parameters {
371 /* Either Rx or Tx */
372 unsigned int bytes_per_data_element; /* of data in read or write call */
373 enum v4l2_subdev_ir_mode mode;
374
375 bool enable;
376 bool interrupt_enable;
377 bool shutdown; /* true: set hardware to low/no power, false: normal */
378
379 bool modulation; /* true: uses carrier, false: baseband */
380 u32 max_pulse_width; /* ns, valid only for baseband signal */
381 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
382 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
Andy Walls5a28d9a2010-07-18 19:57:25 -0300383 bool invert_level; /* invert signal level */
384
385 /* Tx only */
386 bool invert_carrier_sense; /* Send 0/space as a carrier burst */
Andy Walls1d986ad2009-09-27 17:50:04 -0300387
388 /* Rx only */
389 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
390 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
391 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
392 u32 resolution; /* ns */
393};
394
395struct v4l2_subdev_ir_ops {
Andy Walls1d986ad2009-09-27 17:50:04 -0300396 /* Receiver */
397 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
398 ssize_t *num);
399
400 int (*rx_g_parameters)(struct v4l2_subdev *sd,
401 struct v4l2_subdev_ir_parameters *params);
402 int (*rx_s_parameters)(struct v4l2_subdev *sd,
403 struct v4l2_subdev_ir_parameters *params);
404
405 /* Transmitter */
406 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
407 ssize_t *num);
408
409 int (*tx_g_parameters)(struct v4l2_subdev *sd,
410 struct v4l2_subdev_ir_parameters *params);
411 int (*tx_s_parameters)(struct v4l2_subdev *sd,
412 struct v4l2_subdev_ir_parameters *params);
413};
414
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300415struct v4l2_subdev_ops {
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300416 const struct v4l2_subdev_core_ops *core;
417 const struct v4l2_subdev_tuner_ops *tuner;
418 const struct v4l2_subdev_audio_ops *audio;
419 const struct v4l2_subdev_video_ops *video;
Hans Verkuil32cd5272010-03-14 09:57:30 -0300420 const struct v4l2_subdev_vbi_ops *vbi;
Guennadi Liakhovetski32536102009-12-11 11:14:46 -0300421 const struct v4l2_subdev_ir_ops *ir;
422 const struct v4l2_subdev_sensor_ops *sensor;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300423};
424
Hans Verkuil45f6f842011-01-08 07:15:53 -0300425/*
426 * Internal ops. Never call this from drivers, only the v4l2 framework can call
427 * these ops.
428 *
429 * registered: called when this subdev is registered. When called the v4l2_dev
430 * field is set to the correct v4l2_device.
431 *
432 * unregistered: called when this subdev is unregistered. When called the
433 * v4l2_dev field is still set to the correct v4l2_device.
434 */
435struct v4l2_subdev_internal_ops {
436 int (*registered)(struct v4l2_subdev *sd);
437 void (*unregistered)(struct v4l2_subdev *sd);
438};
439
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300440#define V4L2_SUBDEV_NAME_SIZE 32
441
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300442/* Set this flag if this subdev is a i2c device. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300443#define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
Dmitri Belimov85e09212010-03-23 11:23:29 -0300444/* Set this flag if this subdev is a spi device. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300445#define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
446/* Set this flag if this subdev needs a device node. */
447#define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300448/* Set this flag if this subdev generates events. */
449#define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300450
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300451/* Each instance of a subdev driver should create this struct, either
452 stand-alone or embedded in a larger struct.
453 */
454struct v4l2_subdev {
Laurent Pinchart61f5db52009-12-09 08:40:08 -0300455#if defined(CONFIG_MEDIA_CONTROLLER)
456 struct media_entity entity;
457#endif
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300458 struct list_head list;
459 struct module *owner;
Hans Verkuilb5b2b7e2009-05-02 10:58:51 -0300460 u32 flags;
Hans Verkuilb0167602009-02-14 12:00:53 -0300461 struct v4l2_device *v4l2_dev;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300462 const struct v4l2_subdev_ops *ops;
Hans Verkuil45f6f842011-01-08 07:15:53 -0300463 /* Never call these internal ops from within a driver! */
464 const struct v4l2_subdev_internal_ops *internal_ops;
Hans Verkuil09965172010-08-01 14:32:42 -0300465 /* The control handler of this subdev. May be NULL. */
466 struct v4l2_ctrl_handler *ctrl_handler;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300467 /* name must be unique */
468 char name[V4L2_SUBDEV_NAME_SIZE];
469 /* can be used to group similar subdevs, value is driver-specific */
470 u32 grp_id;
471 /* pointer to private data */
Laurent Pinchart692d55222010-07-30 17:24:55 -0300472 void *dev_priv;
473 void *host_priv;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300474 /* subdev device node */
475 struct video_device devnode;
Sakari Ailus02adb1c2010-03-03 12:49:38 -0300476 /* number of events to be allocated on open */
477 unsigned int nevents;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300478};
479
Laurent Pinchart61f5db52009-12-09 08:40:08 -0300480#define media_entity_to_v4l2_subdev(ent) \
481 container_of(ent, struct v4l2_subdev, entity)
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300482#define vdev_to_v4l2_subdev(vdev) \
483 container_of(vdev, struct v4l2_subdev, devnode)
484
Stanimir Varbanov7cd5a162010-05-21 06:04:24 -0300485/*
486 * Used for storing subdev information per file handle
487 */
488struct v4l2_subdev_fh {
489 struct v4l2_fh vfh;
490#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
491 struct v4l2_mbus_framefmt *try_fmt;
492 struct v4l2_rect *try_crop;
493#endif
494};
495
496#define to_v4l2_subdev_fh(fh) \
497 container_of(fh, struct v4l2_subdev_fh, vfh)
498
499#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
500static inline struct v4l2_mbus_framefmt *
501v4l2_subdev_get_try_format(struct v4l2_subdev_fh *fh, unsigned int pad)
502{
503 return &fh->try_fmt[pad];
504}
505
506static inline struct v4l2_rect *
507v4l2_subdev_get_try_crop(struct v4l2_subdev_fh *fh, unsigned int pad)
508{
509 return &fh->try_crop[pad];
510}
511#endif
512
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300513extern const struct v4l2_file_operations v4l2_subdev_fops;
514
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300515static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
516{
Laurent Pinchart692d55222010-07-30 17:24:55 -0300517 sd->dev_priv = p;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300518}
519
520static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
521{
Laurent Pinchart692d55222010-07-30 17:24:55 -0300522 return sd->dev_priv;
523}
524
525static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
526{
527 sd->host_priv = p;
528}
529
530static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
531{
532 return sd->host_priv;
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300533}
534
Laurent Pinchart3dd5ee02009-12-09 08:38:52 -0300535void v4l2_subdev_init(struct v4l2_subdev *sd,
536 const struct v4l2_subdev_ops *ops);
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300537
538/* Call an ops of a v4l2_subdev, doing the right checks against
539 NULL pointers.
540
541 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
542 */
543#define v4l2_subdev_call(sd, o, f, args...) \
Hans Verkuildbc8e342009-06-09 17:34:01 -0300544 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300545 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
546
Hans Verkuil98ec6332009-03-08 17:02:10 -0300547/* Send a notification to v4l2_device. */
548#define v4l2_subdev_notify(sd, notification, arg) \
549 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
550 (sd)->v4l2_dev->notify((sd), (notification), (arg)))
551
Hans Verkuil2a1fcdf2008-11-29 21:36:58 -0300552#endif