[media] v4l: v4l2_subdev userspace frame interval API
[deliverable/linux.git] / include / media / v4l2-subdev.h
CommitLineData
2a1fcdf0
HV
1/*
2 V4L2 sub-device support header.
3
4 Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21#ifndef _V4L2_SUBDEV_H
22#define _V4L2_SUBDEV_H
23
333c8b97 24#include <linux/v4l2-subdev.h>
61f5db54 25#include <media/media-entity.h>
2a1fcdf0 26#include <media/v4l2-common.h>
2096a5dc 27#include <media/v4l2-dev.h>
7cd5a16b 28#include <media/v4l2-fh.h>
9a74251d 29#include <media/v4l2-mediabus.h>
2a1fcdf0 30
1d986add
AW
31/* 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
2a1fcdf0 41struct v4l2_device;
0996517c 42struct v4l2_ctrl_handler;
02adb1cc
SA
43struct v4l2_event_subscription;
44struct v4l2_fh;
2a1fcdf0 45struct v4l2_subdev;
f0beea8f 46struct v4l2_subdev_fh;
2a1fcdf0
HV
47struct tuner_setup;
48
78a3b4db
HV
49/* 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
2a1fcdf0
HV
59/* 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 */
78a3b4db 100
66752f83
AW
101/* 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
3c7c9370 116/*
66752f83
AW
117 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
f0222c7d 123 init: initialize the sensor registors to some sort of reasonable default
78a3b4db
HV
124 values. Do not use for new drivers and should be removed in existing
125 drivers.
126
cc26b076
HV
127 load_fw: load firmware.
128
129 reset: generic reset command. The argument selects which subsystems to
78a3b4db
HV
130 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.
622b828a
LP
136
137 s_power: puts subdevice in power saving mode (on == 0) or normal operation
138 mode (on == 1).
260e689b
AW
139
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*.
78a3b4db 144 */
2a1fcdf0 145struct v4l2_subdev_core_ops {
aecde8b5 146 int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
2a1fcdf0 147 int (*log_status)(struct v4l2_subdev *sd);
66752f83
AW
148 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
149 struct v4l2_subdev_io_pin_config *pincfg);
2a1fcdf0 150 int (*init)(struct v4l2_subdev *sd, u32 val);
cc26b076 151 int (*load_fw)(struct v4l2_subdev *sd);
2a1fcdf0
HV
152 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);
952617f2
HV
157 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);
2a1fcdf0 160 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
f41737ec 161 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
069b7479 162 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
2a1fcdf0 163#ifdef CONFIG_VIDEO_ADV_DEBUG
aecde8b5
HV
164 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);
2a1fcdf0 166#endif
622b828a 167 int (*s_power)(struct v4l2_subdev *sd, int on);
260e689b
AW
168 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
169 u32 status, bool *handled);
02adb1cc
SA
170 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);
2a1fcdf0
HV
174};
175
78a3b4db
HV
176/* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
177
178 s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
179
180 s_type_addr: sets tuner type and its I2C addr.
181
182 s_config: sets tda9887 specific stuff, like port1, port2 and qss
183 */
2a1fcdf0
HV
184struct v4l2_subdev_tuner_ops {
185 int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
186 int (*s_radio)(struct v4l2_subdev *sd);
187 int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
188 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
189 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
190 int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
d6bacea6
EV
191 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
192 int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
2a1fcdf0
HV
193 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
194 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
195};
196
78a3b4db
HV
197/* s_clock_freq: set the frequency (in Hz) of the audio clock output.
198 Used to slave an audio processor to the video decoder, ensuring that
199 audio and video remain synchronized. Usual values for the frequency
200 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
201 -EINVAL is returned.
202
203 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
204 way to select I2S clock used by driving digital audio streams at some
205 board designs. Usual values for the frequency are 1024000 and 2048000.
206 If the frequency is not supported, then -EINVAL is returned.
207
5325b427
HV
208 s_routing: used to define the input and/or output pins of an audio chip,
209 and any additional configuration data.
78a3b4db
HV
210 Never attempt to use user-level input IDs (e.g. Composite, S-Video,
211 Tuner) at this level. An i2c device shouldn't know about whether an
212 input pin is connected to a Composite connector, become on another
213 board or platform it might be connected to something else entirely.
214 The calling driver is responsible for mapping a user-level input to
215 the right pins on the i2c device.
216 */
2a1fcdf0
HV
217struct v4l2_subdev_audio_ops {
218 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
219 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
5325b427 220 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
3ccc646b 221 int (*s_stream)(struct v4l2_subdev *sd, int enable);
2a1fcdf0
HV
222};
223
78a3b4db 224/*
cc26b076 225 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
78a3b4db
HV
226 video input devices.
227
9a74251d 228 s_crystal_freq: sets the frequency of the crystal used to generate the
3ff4ad81 229 clocks in Hz. An extra flags field allows device specific configuration
78a3b4db
HV
230 regarding clock frequency dividers, etc. If not used, then set flags
231 to 0. If the frequency is not supported, then -EINVAL is returned.
232
cc26b076 233 g_input_status: get input status. Same as the status field in the v4l2_input
78a3b4db
HV
234 struct.
235
cc26b076 236 s_routing: see s_routing in audio_ops, except this version is for video
78a3b4db 237 devices.
b6456c0c
MK
238
239 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
240 s_std()
241
242 query_dv_preset: query dv preset in the sub device. This is similar to
243 querystd()
244
245 s_dv_timings(): Set custom dv timings in the sub device. This is used
246 when sub device is capable of setting detailed timing information
247 in the hardware to generate/detect the video signal.
248
249 g_dv_timings(): Get custom dv timings in the sub device.
250
9a74251d
GL
251 enum_mbus_fmt: enumerate pixel formats, provided by a video data source
252
253 g_mbus_fmt: get the current pixel format, provided by a video data source
254
255 try_mbus_fmt: try to set a pixel format on a video data source
256
257 s_mbus_fmt: set a pixel format on a video data source
78a3b4db 258 */
2a1fcdf0 259struct v4l2_subdev_video_ops {
5325b427 260 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
3ff4ad81 261 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
2a1fcdf0 262 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
1b6f1d96
HV
263 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
264 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
2a1fcdf0 265 int (*s_stream)(struct v4l2_subdev *sd, int enable);
b7f2cef0
GL
266 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
267 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
268 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
2da9479a
HV
269 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
270 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
35c3017a
LP
271 int (*g_frame_interval)(struct v4l2_subdev *sd,
272 struct v4l2_subdev_frame_interval *interval);
273 int (*s_frame_interval)(struct v4l2_subdev *sd,
274 struct v4l2_subdev_frame_interval *interval);
4b2ce11a
HV
275 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
276 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
6003b5c7
MR
277 int (*enum_dv_presets) (struct v4l2_subdev *sd,
278 struct v4l2_dv_enum_preset *preset);
b6456c0c
MK
279 int (*s_dv_preset)(struct v4l2_subdev *sd,
280 struct v4l2_dv_preset *preset);
281 int (*query_dv_preset)(struct v4l2_subdev *sd,
282 struct v4l2_dv_preset *preset);
283 int (*s_dv_timings)(struct v4l2_subdev *sd,
284 struct v4l2_dv_timings *timings);
285 int (*g_dv_timings)(struct v4l2_subdev *sd,
286 struct v4l2_dv_timings *timings);
3805f201 287 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index,
9a74251d 288 enum v4l2_mbus_pixelcode *code);
03519b7e
QX
289 int (*enum_mbus_fsizes)(struct v4l2_subdev *sd,
290 struct v4l2_frmsizeenum *fsize);
9a74251d
GL
291 int (*g_mbus_fmt)(struct v4l2_subdev *sd,
292 struct v4l2_mbus_framefmt *fmt);
293 int (*try_mbus_fmt)(struct v4l2_subdev *sd,
294 struct v4l2_mbus_framefmt *fmt);
295 int (*s_mbus_fmt)(struct v4l2_subdev *sd,
296 struct v4l2_mbus_framefmt *fmt);
2a1fcdf0
HV
297};
298
32cd527f
HV
299/*
300 decode_vbi_line: video decoders that support sliced VBI need to implement
301 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
302 start of the VBI data that was generated by the decoder. The driver
303 then parses the sliced VBI data and sets the other fields in the
304 struct accordingly. The pointer p is updated to point to the start of
305 the payload which can be copied verbatim into the data field of the
306 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
307 type field is set to 0 on return.
308
309 s_vbi_data: used to generate VBI signals on a video signal.
310 v4l2_sliced_vbi_data is filled with the data packets that should be
311 output. Note that if you set the line field to 0, then that VBI signal
312 is disabled. If no valid VBI data was found, then the type field is
313 set to 0 on return.
314
315 g_vbi_data: used to obtain the sliced VBI packet from a readback register.
316 Not all video decoders support this. If no data is available because
317 the readback register contains invalid or erroneous data -EIO is
318 returned. Note that you must fill in the 'id' member and the 'field'
319 member (to determine whether CC data from the first or second field
320 should be obtained).
54aefafb
HV
321
322 s_raw_fmt: setup the video encoder/decoder for raw VBI.
323
324 g_sliced_fmt: retrieve the current sliced VBI settings.
325
326 s_sliced_fmt: setup the sliced VBI settings.
32cd527f
HV
327 */
328struct v4l2_subdev_vbi_ops {
329 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
330 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
331 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
332 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
54aefafb
HV
333 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
334 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
335 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
32cd527f
HV
336};
337
32536108
GL
338/**
339 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
340 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
341 * This is needed for some sensors, which always corrupt
342 * several top lines of the output image, or which send their
343 * metadata in them.
344 */
345struct v4l2_subdev_sensor_ops {
346 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
347};
348
1d986add 349/*
1d986add
AW
350 [rt]x_g_parameters: Get the current operating parameters and state of the
351 the IR receiver or transmitter.
352
353 [rt]x_s_parameters: Set the current operating parameters and state of the
354 the IR receiver or transmitter. It is recommended to call
355 [rt]x_g_parameters first to fill out the current state, and only change
356 the fields that need to be changed. Upon return, the actual device
357 operating parameters and state will be returned. Note that hardware
358 limitations may prevent the actual settings from matching the requested
359 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
360 was requested. An exception is when the shutdown parameter is true.
361 The last used operational parameters will be returned, but the actual
362 state of the hardware be different to minimize power consumption and
363 processing when shutdown is true.
364
365 rx_read: Reads received codes or pulse width data.
366 The semantics are similar to a non-blocking read() call.
367
368 tx_write: Writes codes or pulse width data for transmission.
369 The semantics are similar to a non-blocking write() call.
370 */
371
372enum v4l2_subdev_ir_mode {
d69e85b6 373 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
1d986add
AW
374};
375
1d986add
AW
376struct v4l2_subdev_ir_parameters {
377 /* Either Rx or Tx */
378 unsigned int bytes_per_data_element; /* of data in read or write call */
379 enum v4l2_subdev_ir_mode mode;
380
381 bool enable;
382 bool interrupt_enable;
383 bool shutdown; /* true: set hardware to low/no power, false: normal */
384
385 bool modulation; /* true: uses carrier, false: baseband */
386 u32 max_pulse_width; /* ns, valid only for baseband signal */
387 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
388 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
5a28d9a3
AW
389 bool invert_level; /* invert signal level */
390
391 /* Tx only */
392 bool invert_carrier_sense; /* Send 0/space as a carrier burst */
1d986add
AW
393
394 /* Rx only */
395 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
396 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
397 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
398 u32 resolution; /* ns */
399};
400
401struct v4l2_subdev_ir_ops {
1d986add
AW
402 /* Receiver */
403 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
404 ssize_t *num);
405
406 int (*rx_g_parameters)(struct v4l2_subdev *sd,
407 struct v4l2_subdev_ir_parameters *params);
408 int (*rx_s_parameters)(struct v4l2_subdev *sd,
409 struct v4l2_subdev_ir_parameters *params);
410
411 /* Transmitter */
412 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
413 ssize_t *num);
414
415 int (*tx_g_parameters)(struct v4l2_subdev *sd,
416 struct v4l2_subdev_ir_parameters *params);
417 int (*tx_s_parameters)(struct v4l2_subdev *sd,
418 struct v4l2_subdev_ir_parameters *params);
419};
420
eb08f354 421struct v4l2_subdev_pad_ops {
333c8b97
LP
422 int (*enum_mbus_code)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
423 struct v4l2_subdev_mbus_code_enum *code);
424 int (*enum_frame_size)(struct v4l2_subdev *sd,
425 struct v4l2_subdev_fh *fh,
426 struct v4l2_subdev_frame_size_enum *fse);
35c3017a
LP
427 int (*enum_frame_interval)(struct v4l2_subdev *sd,
428 struct v4l2_subdev_fh *fh,
429 struct v4l2_subdev_frame_interval_enum *fie);
333c8b97
LP
430 int (*get_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
431 struct v4l2_subdev_format *format);
432 int (*set_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
433 struct v4l2_subdev_format *format);
eb08f354
LP
434};
435
2a1fcdf0 436struct v4l2_subdev_ops {
32536108
GL
437 const struct v4l2_subdev_core_ops *core;
438 const struct v4l2_subdev_tuner_ops *tuner;
439 const struct v4l2_subdev_audio_ops *audio;
440 const struct v4l2_subdev_video_ops *video;
32cd527f 441 const struct v4l2_subdev_vbi_ops *vbi;
32536108
GL
442 const struct v4l2_subdev_ir_ops *ir;
443 const struct v4l2_subdev_sensor_ops *sensor;
eb08f354 444 const struct v4l2_subdev_pad_ops *pad;
2a1fcdf0
HV
445};
446
45f6f84a
HV
447/*
448 * Internal ops. Never call this from drivers, only the v4l2 framework can call
449 * these ops.
450 *
451 * registered: called when this subdev is registered. When called the v4l2_dev
452 * field is set to the correct v4l2_device.
453 *
454 * unregistered: called when this subdev is unregistered. When called the
455 * v4l2_dev field is still set to the correct v4l2_device.
f0beea8f
LP
456 *
457 * open: called when the subdev device node is opened by an application.
458 *
459 * close: called when the subdev device node is closed.
45f6f84a
HV
460 */
461struct v4l2_subdev_internal_ops {
462 int (*registered)(struct v4l2_subdev *sd);
463 void (*unregistered)(struct v4l2_subdev *sd);
f0beea8f
LP
464 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
465 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
45f6f84a
HV
466};
467
2a1fcdf0
HV
468#define V4L2_SUBDEV_NAME_SIZE 32
469
b5b2b7ed 470/* Set this flag if this subdev is a i2c device. */
2096a5dc 471#define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
85e09219 472/* Set this flag if this subdev is a spi device. */
2096a5dc
LP
473#define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
474/* Set this flag if this subdev needs a device node. */
475#define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
02adb1cc
SA
476/* Set this flag if this subdev generates events. */
477#define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
b5b2b7ed 478
2a1fcdf0
HV
479/* Each instance of a subdev driver should create this struct, either
480 stand-alone or embedded in a larger struct.
481 */
482struct v4l2_subdev {
61f5db54
LP
483#if defined(CONFIG_MEDIA_CONTROLLER)
484 struct media_entity entity;
485#endif
2a1fcdf0
HV
486 struct list_head list;
487 struct module *owner;
b5b2b7ed 488 u32 flags;
b0167600 489 struct v4l2_device *v4l2_dev;
2a1fcdf0 490 const struct v4l2_subdev_ops *ops;
45f6f84a
HV
491 /* Never call these internal ops from within a driver! */
492 const struct v4l2_subdev_internal_ops *internal_ops;
0996517c
HV
493 /* The control handler of this subdev. May be NULL. */
494 struct v4l2_ctrl_handler *ctrl_handler;
2a1fcdf0
HV
495 /* name must be unique */
496 char name[V4L2_SUBDEV_NAME_SIZE];
497 /* can be used to group similar subdevs, value is driver-specific */
498 u32 grp_id;
499 /* pointer to private data */
692d5522
LP
500 void *dev_priv;
501 void *host_priv;
2096a5dc
LP
502 /* subdev device node */
503 struct video_device devnode;
02adb1cc
SA
504 /* number of events to be allocated on open */
505 unsigned int nevents;
2a1fcdf0
HV
506};
507
61f5db54
LP
508#define media_entity_to_v4l2_subdev(ent) \
509 container_of(ent, struct v4l2_subdev, entity)
2096a5dc
LP
510#define vdev_to_v4l2_subdev(vdev) \
511 container_of(vdev, struct v4l2_subdev, devnode)
512
7cd5a16b
SV
513/*
514 * Used for storing subdev information per file handle
515 */
516struct v4l2_subdev_fh {
517 struct v4l2_fh vfh;
518#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
519 struct v4l2_mbus_framefmt *try_fmt;
520 struct v4l2_rect *try_crop;
521#endif
522};
523
524#define to_v4l2_subdev_fh(fh) \
525 container_of(fh, struct v4l2_subdev_fh, vfh)
526
527#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
528static inline struct v4l2_mbus_framefmt *
529v4l2_subdev_get_try_format(struct v4l2_subdev_fh *fh, unsigned int pad)
530{
531 return &fh->try_fmt[pad];
532}
533
534static inline struct v4l2_rect *
535v4l2_subdev_get_try_crop(struct v4l2_subdev_fh *fh, unsigned int pad)
536{
537 return &fh->try_crop[pad];
538}
539#endif
540
2096a5dc
LP
541extern const struct v4l2_file_operations v4l2_subdev_fops;
542
2a1fcdf0
HV
543static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
544{
692d5522 545 sd->dev_priv = p;
2a1fcdf0
HV
546}
547
548static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
549{
692d5522
LP
550 return sd->dev_priv;
551}
552
553static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
554{
555 sd->host_priv = p;
556}
557
558static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
559{
560 return sd->host_priv;
2a1fcdf0
HV
561}
562
3dd5ee08
LP
563void v4l2_subdev_init(struct v4l2_subdev *sd,
564 const struct v4l2_subdev_ops *ops);
2a1fcdf0
HV
565
566/* Call an ops of a v4l2_subdev, doing the right checks against
567 NULL pointers.
568
569 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
570 */
571#define v4l2_subdev_call(sd, o, f, args...) \
dbc8e34a 572 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
2a1fcdf0
HV
573 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
574
98ec6339
HV
575/* Send a notification to v4l2_device. */
576#define v4l2_subdev_notify(sd, notification, arg) \
577 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
578 (sd)->v4l2_dev->notify((sd), (notification), (arg)))
579
2a1fcdf0 580#endif
This page took 0.229788 seconds and 5 git commands to generate.