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