1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * V4L2 sub-device support header.
4 *
5 * Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl>
6 */
7
8 #ifndef _V4L2_SUBDEV_H
9 #define _V4L2_SUBDEV_H
10
11 #include <linux/types.h>
12 #include <linux/v4l2-subdev.h>
13 #include <media/media-entity.h>
14 #include <media/v4l2-async.h>
15 #include <media/v4l2-common.h>
16 #include <media/v4l2-dev.h>
17 #include <media/v4l2-fh.h>
18 #include <media/v4l2-mediabus.h>
19
20 /* generic v4l2_device notify callback notification values */
21 #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32)
22 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001
23 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002
24 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004
25 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008
26
27 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32)
28 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001
29
30 #define V4L2_DEVICE_NOTIFY_EVENT _IOW('v', 2, struct v4l2_event)
31
32 struct v4l2_device;
33 struct v4l2_ctrl_handler;
34 struct v4l2_event;
35 struct v4l2_event_subscription;
36 struct v4l2_fh;
37 struct v4l2_subdev;
38 struct v4l2_subdev_fh;
39 struct tuner_setup;
40 struct v4l2_mbus_frame_desc;
41
42 /**
43 * struct v4l2_decode_vbi_line - used to decode_vbi_line
44 *
45 * @is_second_field: Set to 0 for the first (odd) field;
46 * set to 1 for the second (even) field.
47 * @p: Pointer to the sliced VBI data from the decoder. On exit, points to
48 * the start of the payload.
49 * @line: Line number of the sliced VBI data (1-23)
50 * @type: VBI service type (V4L2_SLICED_*). 0 if no service found
51 */
52 struct v4l2_decode_vbi_line {
53 u32 is_second_field;
54 u8 *p;
55 u32 line;
56 u32 type;
57 };
58
59 /*
60 * Sub-devices are devices that are connected somehow to the main bridge
61 * device. These devices are usually audio/video muxers/encoders/decoders or
62 * sensors and webcam controllers.
63 *
64 * Usually these devices are controlled through an i2c bus, but other buses
65 * may also be used.
66 *
67 * The v4l2_subdev struct provides a way of accessing these devices in a
68 * generic manner. Most operations that these sub-devices support fall in
69 * a few categories: core ops, audio ops, video ops and tuner ops.
70 *
71 * More categories can be added if needed, although this should remain a
72 * limited set (no more than approx. 8 categories).
73 *
74 * Each category has its own set of ops that subdev drivers can implement.
75 *
76 * A subdev driver can leave the pointer to the category ops NULL if
77 * it does not implement them (e.g. an audio subdev will generally not
78 * implement the video category ops). The exception is the core category:
79 * this must always be present.
80 *
81 * These ops are all used internally so it is no problem to change, remove
82 * or add ops or move ops from one to another category. Currently these
83 * ops are based on the original ioctls, but since ops are not limited to
84 * one argument there is room for improvement here once all i2c subdev
85 * drivers are converted to use these ops.
86 */
87
88 /*
89 * Core ops: it is highly recommended to implement at least these ops:
90 *
91 * log_status
92 * g_register
93 * s_register
94 *
95 * This provides basic debugging support.
96 *
97 * The ioctl ops is meant for generic ioctl-like commands. Depending on
98 * the use-case it might be better to use subdev-specific ops (currently
99 * not yet implemented) since ops provide proper type-checking.
100 */
101
102 /**
103 * enum v4l2_subdev_io_pin_bits - Subdevice external IO pin configuration
104 * bits
105 *
106 * @V4L2_SUBDEV_IO_PIN_DISABLE: disables a pin config. ENABLE assumed.
107 * @V4L2_SUBDEV_IO_PIN_OUTPUT: set it if pin is an output.
108 * @V4L2_SUBDEV_IO_PIN_INPUT: set it if pin is an input.
109 * @V4L2_SUBDEV_IO_PIN_SET_VALUE: to set the output value via
110 * &struct v4l2_subdev_io_pin_config->value.
111 * @V4L2_SUBDEV_IO_PIN_ACTIVE_LOW: pin active is bit 0.
112 * Otherwise, ACTIVE HIGH is assumed.
113 */
114 enum v4l2_subdev_io_pin_bits {
115 V4L2_SUBDEV_IO_PIN_DISABLE = 0,
116 V4L2_SUBDEV_IO_PIN_OUTPUT = 1,
117 V4L2_SUBDEV_IO_PIN_INPUT = 2,
118 V4L2_SUBDEV_IO_PIN_SET_VALUE = 3,
119 V4L2_SUBDEV_IO_PIN_ACTIVE_LOW = 4,
120 };
121
122 /**
123 * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration
124 *
125 * @flags: bitmask with flags for this pin's config, whose bits are defined by
126 * &enum v4l2_subdev_io_pin_bits.
127 * @pin: Chip external IO pin to configure
128 * @function: Internal signal pad/function to route to IO pin
129 * @value: Initial value for pin - e.g. GPIO output value
130 * @strength: Pin drive strength
131 */
132 struct v4l2_subdev_io_pin_config {
133 u32 flags;
134 u8 pin;
135 u8 function;
136 u8 value;
137 u8 strength;
138 };
139
140 /**
141 * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs
142 *
143 * @log_status: callback for VIDIOC_LOG_STATUS() ioctl handler code.
144 *
145 * @s_io_pin_config: configure one or more chip I/O pins for chips that
146 * multiplex different internal signal pads out to IO pins. This function
147 * takes a pointer to an array of 'n' pin configuration entries, one for
148 * each pin being configured. This function could be called at times
149 * other than just subdevice initialization.
150 *
151 * @init: initialize the sensor registers to some sort of reasonable default
152 * values. Do not use for new drivers and should be removed in existing
153 * drivers.
154 *
155 * @load_fw: load firmware.
156 *
157 * @reset: generic reset command. The argument selects which subsystems to
158 * reset. Passing 0 will always reset the whole chip. Do not use for new
159 * drivers without discussing this first on the linux-media mailinglist.
160 * There should be no reason normally to reset a device.
161 *
162 * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with
163 * a direction argument if needed.
164 *
165 * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core.
166 * used to provide support for private ioctls used on the driver.
167 *
168 * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel,
169 * in order to fix data passed from/to userspace.
170 *
171 * @g_register: callback for VIDIOC_DBG_G_REGISTER() ioctl handler code.
172 *
173 * @s_register: callback for VIDIOC_DBG_S_REGISTER() ioctl handler code.
174 *
175 * @s_power: puts subdevice in power saving mode (on == 0) or normal operation
176 * mode (on == 1).
177 *
178 * @interrupt_service_routine: Called by the bridge chip's interrupt service
179 * handler, when an interrupt status has be raised due to this subdev,
180 * so that this subdev can handle the details. It may schedule work to be
181 * performed later. It must not sleep. **Called from an IRQ context**.
182 *
183 * @subscribe_event: used by the drivers to request the control framework that
184 * for it to be warned when the value of a control changes.
185 *
186 * @unsubscribe_event: remove event subscription from the control framework.
187 */
188 struct v4l2_subdev_core_ops {
189 int (*log_status)(struct v4l2_subdev *sd);
190 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
191 struct v4l2_subdev_io_pin_config *pincfg);
192 int (*init)(struct v4l2_subdev *sd, u32 val);
193 int (*load_fw)(struct v4l2_subdev *sd);
194 int (*reset)(struct v4l2_subdev *sd, u32 val);
195 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
196 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
197 #ifdef CONFIG_COMPAT
198 long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,
199 unsigned long arg);
200 #endif
201 #ifdef CONFIG_VIDEO_ADV_DEBUG
202 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
203 int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg);
204 #endif
205 int (*s_power)(struct v4l2_subdev *sd, int on);
206 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
207 u32 status, bool *handled);
208 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
209 struct v4l2_event_subscription *sub);
210 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
211 struct v4l2_event_subscription *sub);
212 };
213
214 /**
215 * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened
216 * in radio mode.
217 *
218 * @standby: puts the tuner in standby mode. It will be woken up
219 * automatically the next time it is used.
220 *
221 * @s_radio: callback that switches the tuner to radio mode.
222 * drivers should explicitly call it when a tuner ops should
223 * operate on radio mode, before being able to handle it.
224 * Used on devices that have both AM/FM radio receiver and TV.
225 *
226 * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code.
227 *
228 * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code.
229 * freq->type must be filled in. Normally done by video_ioctl2()
230 * or the bridge driver.
231 *
232 * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code.
233 *
234 * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code.
235 *
236 * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be
237 * filled in. Normally done by video_ioctl2 or the
238 * bridge driver.
239 *
240 * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code.
241 *
242 * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code.
243 *
244 * @s_type_addr: sets tuner type and its I2C addr.
245 *
246 * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
247 *
248 * .. note::
249 *
250 * On devices that have both AM/FM and TV, it is up to the driver
251 * to explicitly call s_radio when the tuner should be switched to
252 * radio mode, before handling other &struct v4l2_subdev_tuner_ops
253 * that would require it. An example of such usage is::
254 *
255 * static void s_frequency(void *priv, const struct v4l2_frequency *f)
256 * {
257 * ...
258 * if (f.type == V4L2_TUNER_RADIO)
259 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio);
260 * ...
261 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency);
262 * }
263 */
264 struct v4l2_subdev_tuner_ops {
265 int (*standby)(struct v4l2_subdev *sd);
266 int (*s_radio)(struct v4l2_subdev *sd);
267 int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);
268 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
269 int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);
270 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
271 int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);
272 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
273 int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);
274 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
275 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
276 };
277
278 /**
279 * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
280 *
281 * @s_clock_freq: set the frequency (in Hz) of the audio clock output.
282 * Used to slave an audio processor to the video decoder, ensuring that
283 * audio and video remain synchronized. Usual values for the frequency
284 * are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
285 * -EINVAL is returned.
286 *
287 * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
288 * way to select I2S clock used by driving digital audio streams at some
289 * board designs. Usual values for the frequency are 1024000 and 2048000.
290 * If the frequency is not supported, then %-EINVAL is returned.
291 *
292 * @s_routing: used to define the input and/or output pins of an audio chip,
293 * and any additional configuration data.
294 * Never attempt to use user-level input IDs (e.g. Composite, S-Video,
295 * Tuner) at this level. An i2c device shouldn't know about whether an
296 * input pin is connected to a Composite connector, become on another
297 * board or platform it might be connected to something else entirely.
298 * The calling driver is responsible for mapping a user-level input to
299 * the right pins on the i2c device.
300 *
301 * @s_stream: used to notify the audio code that stream will start or has
302 * stopped.
303 */
304 struct v4l2_subdev_audio_ops {
305 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
306 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
307 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
308 int (*s_stream)(struct v4l2_subdev *sd, int enable);
309 };
310
311 /**
312 * enum v4l2_mbus_frame_desc_entry - media bus frame description flags
313 *
314 * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX:
315 * Indicates that &struct v4l2_mbus_frame_desc_entry->length field
316 * specifies maximum data length.
317 * @V4L2_MBUS_FRAME_DESC_FL_BLOB:
318 * Indicates that the format does not have line offsets, i.e.
319 * the receiver should use 1D DMA.
320 */
321 enum v4l2_mbus_frame_desc_flags {
322 V4L2_MBUS_FRAME_DESC_FL_LEN_MAX = BIT(0),
323 V4L2_MBUS_FRAME_DESC_FL_BLOB = BIT(1),
324 };
325
326 /**
327 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
328 *
329 * @flags: bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags.
330 * @pixelcode: media bus pixel code, valid if @flags
331 * %FRAME_DESC_FL_BLOB is not set.
332 * @length: number of octets per frame, valid if @flags
333 * %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set.
334 */
335 struct v4l2_mbus_frame_desc_entry {
336 enum v4l2_mbus_frame_desc_flags flags;
337 u32 pixelcode;
338 u32 length;
339 };
340
341 #define V4L2_FRAME_DESC_ENTRY_MAX 4
342
343 /**
344 * struct v4l2_mbus_frame_desc - media bus data frame description
345 * @entry: frame descriptors array
346 * @num_entries: number of entries in @entry array
347 */
348 struct v4l2_mbus_frame_desc {
349 struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
350 unsigned short num_entries;
351 };
352
353 /**
354 * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
355 * in video mode.
356 *
357 * @s_routing: see s_routing in audio_ops, except this version is for video
358 * devices.
359 *
360 * @s_crystal_freq: sets the frequency of the crystal used to generate the
361 * clocks in Hz. An extra flags field allows device specific configuration
362 * regarding clock frequency dividers, etc. If not used, then set flags
363 * to 0. If the frequency is not supported, then -EINVAL is returned.
364 *
365 * @g_std: callback for VIDIOC_G_STD() ioctl handler code.
366 *
367 * @s_std: callback for VIDIOC_S_STD() ioctl handler code.
368 *
369 * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
370 * video input devices.
371 *
372 * @g_std_output: get current standard for video OUTPUT devices. This is ignored
373 * by video input devices.
374 *
375 * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code.
376 *
377 * @g_tvnorms: get &v4l2_std_id with all standards supported by the video
378 * CAPTURE device. This is ignored by video output devices.
379 *
380 * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
381 * OUTPUT device. This is ignored by video capture devices.
382 *
383 * @g_input_status: get input status. Same as the status field in the
384 * &struct &v4l2_input
385 *
386 * @s_stream: used to notify the driver that a video stream will start or has
387 * stopped.
388 *
389 * @g_pixelaspect: callback to return the pixelaspect ratio.
390 *
391 * @g_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL()
392 * ioctl handler code.
393 *
394 * @s_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL()
395 * ioctl handler code.
396 *
397 * @s_dv_timings: Set custom dv timings in the sub device. This is used
398 * when sub device is capable of setting detailed timing information
399 * in the hardware to generate/detect the video signal.
400 *
401 * @g_dv_timings: Get custom dv timings in the sub device.
402 *
403 * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code.
404 *
405 * @g_mbus_config: get supported mediabus configurations
406 *
407 * @s_mbus_config: set a certain mediabus configuration. This operation is added
408 * for compatibility with soc-camera drivers and should not be used by new
409 * software.
410 *
411 * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
412 * can adjust @size to a lower value and must not write more data to the
413 * buffer starting at @data than the original value of @size.
414 */
415 struct v4l2_subdev_video_ops {
416 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
417 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
418 int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
419 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
420 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
421 int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
422 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
423 int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
424 int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
425 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
426 int (*s_stream)(struct v4l2_subdev *sd, int enable);
427 int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect);
428 int (*g_frame_interval)(struct v4l2_subdev *sd,
429 struct v4l2_subdev_frame_interval *interval);
430 int (*s_frame_interval)(struct v4l2_subdev *sd,
431 struct v4l2_subdev_frame_interval *interval);
432 int (*s_dv_timings)(struct v4l2_subdev *sd,
433 struct v4l2_dv_timings *timings);
434 int (*g_dv_timings)(struct v4l2_subdev *sd,
435 struct v4l2_dv_timings *timings);
436 int (*query_dv_timings)(struct v4l2_subdev *sd,
437 struct v4l2_dv_timings *timings);
438 int (*g_mbus_config)(struct v4l2_subdev *sd,
439 struct v4l2_mbus_config *cfg);
440 int (*s_mbus_config)(struct v4l2_subdev *sd,
441 const struct v4l2_mbus_config *cfg);
442 int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
443 unsigned int *size);
444 };
445
446 /**
447 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
448 * in video mode via the vbi device node.
449 *
450 * @decode_vbi_line: video decoders that support sliced VBI need to implement
451 * this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the
452 * start of the VBI data that was generated by the decoder. The driver
453 * then parses the sliced VBI data and sets the other fields in the
454 * struct accordingly. The pointer p is updated to point to the start of
455 * the payload which can be copied verbatim into the data field of the
456 * &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the
457 * type field is set to 0 on return.
458 *
459 * @s_vbi_data: used to generate VBI signals on a video signal.
460 * &struct v4l2_sliced_vbi_data is filled with the data packets that
461 * should be output. Note that if you set the line field to 0, then that
462 * VBI signal is disabled. If no valid VBI data was found, then the type
463 * field is set to 0 on return.
464 *
465 * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
466 * Not all video decoders support this. If no data is available because
467 * the readback register contains invalid or erroneous data %-EIO is
468 * returned. Note that you must fill in the 'id' member and the 'field'
469 * member (to determine whether CC data from the first or second field
470 * should be obtained).
471 *
472 * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler
473 * code.
474 *
475 * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
476 *
477 * @g_sliced_fmt: retrieve the current sliced VBI settings.
478 *
479 * @s_sliced_fmt: setup the sliced VBI settings.
480 */
481 struct v4l2_subdev_vbi_ops {
482 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
483 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
484 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
485 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
486 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
487 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
488 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
489 };
490
491 /**
492 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
493 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
494 * This is needed for some sensors, which always corrupt
495 * several top lines of the output image, or which send their
496 * metadata in them.
497 * @g_skip_frames: number of frames to skip at stream start. This is needed for
498 * buggy sensors that generate faulty frames when they are
499 * turned on.
500 */
501 struct v4l2_subdev_sensor_ops {
502 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
503 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
504 };
505
506 /**
507 * enum v4l2_subdev_ir_mode- describes the type of IR supported
508 *
509 * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records
510 */
511 enum v4l2_subdev_ir_mode {
512 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH,
513 };
514
515 /**
516 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
517 *
518 * @bytes_per_data_element: bytes per data element of data in read or
519 * write call.
520 * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode.
521 * @enable: device is active if true
522 * @interrupt_enable: IR interrupts are enabled if true
523 * @shutdown: if true: set hardware to low/no power, false: normal mode
524 *
525 * @modulation: if true, it uses carrier, if false: baseband
526 * @max_pulse_width: maximum pulse width in ns, valid only for baseband signal
527 * @carrier_freq: carrier frequency in Hz, valid only for modulated signal
528 * @duty_cycle: duty cycle percentage, valid only for modulated signal
529 * @invert_level: invert signal level
530 *
531 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX.
532 *
533 * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX.
534 * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated
535 * signal. Used only for RX.
536 * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated
537 * signal. Used only for RX.
538 * @resolution: The receive resolution, in ns . Used only for RX.
539 */
540 struct v4l2_subdev_ir_parameters {
541 unsigned int bytes_per_data_element;
542 enum v4l2_subdev_ir_mode mode;
543
544 bool enable;
545 bool interrupt_enable;
546 bool shutdown;
547
548 bool modulation;
549 u32 max_pulse_width;
550 unsigned int carrier_freq;
551 unsigned int duty_cycle;
552 bool invert_level;
553
554 /* Tx only */
555 bool invert_carrier_sense;
556
557 /* Rx only */
558 u32 noise_filter_min_width;
559 unsigned int carrier_range_lower;
560 unsigned int carrier_range_upper;
561 u32 resolution;
562 };
563
564 /**
565 * struct v4l2_subdev_ir_ops - operations for IR subdevices
566 *
567 * @rx_read: Reads received codes or pulse width data.
568 * The semantics are similar to a non-blocking read() call.
569 * @rx_g_parameters: Get the current operating parameters and state of the
570 * the IR receiver.
571 * @rx_s_parameters: Set the current operating parameters and state of the
572 * the IR receiver. It is recommended to call
573 * [rt]x_g_parameters first to fill out the current state, and only change
574 * the fields that need to be changed. Upon return, the actual device
575 * operating parameters and state will be returned. Note that hardware
576 * limitations may prevent the actual settings from matching the requested
577 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
578 * was requested. An exception is when the shutdown parameter is true.
579 * The last used operational parameters will be returned, but the actual
580 * state of the hardware be different to minimize power consumption and
581 * processing when shutdown is true.
582 *
583 * @tx_write: Writes codes or pulse width data for transmission.
584 * The semantics are similar to a non-blocking write() call.
585 * @tx_g_parameters: Get the current operating parameters and state of the
586 * the IR transmitter.
587 * @tx_s_parameters: Set the current operating parameters and state of the
588 * the IR transmitter. It is recommended to call
589 * [rt]x_g_parameters first to fill out the current state, and only change
590 * the fields that need to be changed. Upon return, the actual device
591 * operating parameters and state will be returned. Note that hardware
592 * limitations may prevent the actual settings from matching the requested
593 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
594 * was requested. An exception is when the shutdown parameter is true.
595 * The last used operational parameters will be returned, but the actual
596 * state of the hardware be different to minimize power consumption and
597 * processing when shutdown is true.
598 */
599 struct v4l2_subdev_ir_ops {
600 /* Receiver */
601 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
602 ssize_t *num);
603
604 int (*rx_g_parameters)(struct v4l2_subdev *sd,
605 struct v4l2_subdev_ir_parameters *params);
606 int (*rx_s_parameters)(struct v4l2_subdev *sd,
607 struct v4l2_subdev_ir_parameters *params);
608
609 /* Transmitter */
610 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
611 ssize_t *num);
612
613 int (*tx_g_parameters)(struct v4l2_subdev *sd,
614 struct v4l2_subdev_ir_parameters *params);
615 int (*tx_s_parameters)(struct v4l2_subdev *sd,
616 struct v4l2_subdev_ir_parameters *params);
617 };
618
619 /**
620 * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
621 *
622 * @try_fmt: &struct v4l2_mbus_framefmt
623 * @try_crop: &struct v4l2_rect to be used for crop
624 * @try_compose: &struct v4l2_rect to be used for compose
625 *
626 * This structure only needs to be passed to the pad op if the 'which' field
627 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
628 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
629 */
630 struct v4l2_subdev_pad_config {
631 struct v4l2_mbus_framefmt try_fmt;
632 struct v4l2_rect try_crop;
633 struct v4l2_rect try_compose;
634 };
635
636 /**
637 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
638 *
639 * @init_cfg: initialize the pad config to default values
640 * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler
641 * code.
642 * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler
643 * code.
644 *
645 * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl
646 * handler code.
647 *
648 * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code.
649 *
650 * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code.
651 *
652 * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code.
653 *
654 * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code.
655 *
656 * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code.
657 *
658 * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code.
659 *
660 * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler
661 * code.
662 *
663 * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler
664 * code.
665 *
666 * @link_validate: used by the media controller code to check if the links
667 * that belongs to a pipeline can be used for stream.
668 *
669 * @get_frame_desc: get the current low level media bus frame parameters.
670 *
671 * @set_frame_desc: set the low level media bus frame parameters, @fd array
672 * may be adjusted by the subdev driver to device capabilities.
673 */
674 struct v4l2_subdev_pad_ops {
675 int (*init_cfg)(struct v4l2_subdev *sd,
676 struct v4l2_subdev_pad_config *cfg);
677 int (*enum_mbus_code)(struct v4l2_subdev *sd,
678 struct v4l2_subdev_pad_config *cfg,
679 struct v4l2_subdev_mbus_code_enum *code);
680 int (*enum_frame_size)(struct v4l2_subdev *sd,
681 struct v4l2_subdev_pad_config *cfg,
682 struct v4l2_subdev_frame_size_enum *fse);
683 int (*enum_frame_interval)(struct v4l2_subdev *sd,
684 struct v4l2_subdev_pad_config *cfg,
685 struct v4l2_subdev_frame_interval_enum *fie);
686 int (*get_fmt)(struct v4l2_subdev *sd,
687 struct v4l2_subdev_pad_config *cfg,
688 struct v4l2_subdev_format *format);
689 int (*set_fmt)(struct v4l2_subdev *sd,
690 struct v4l2_subdev_pad_config *cfg,
691 struct v4l2_subdev_format *format);
692 int (*get_selection)(struct v4l2_subdev *sd,
693 struct v4l2_subdev_pad_config *cfg,
694 struct v4l2_subdev_selection *sel);
695 int (*set_selection)(struct v4l2_subdev *sd,
696 struct v4l2_subdev_pad_config *cfg,
697 struct v4l2_subdev_selection *sel);
698 int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
699 int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
700 int (*dv_timings_cap)(struct v4l2_subdev *sd,
701 struct v4l2_dv_timings_cap *cap);
702 int (*enum_dv_timings)(struct v4l2_subdev *sd,
703 struct v4l2_enum_dv_timings *timings);
704 #ifdef CONFIG_MEDIA_CONTROLLER
705 int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
706 struct v4l2_subdev_format *source_fmt,
707 struct v4l2_subdev_format *sink_fmt);
708 #endif /* CONFIG_MEDIA_CONTROLLER */
709 int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
710 struct v4l2_mbus_frame_desc *fd);
711 int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
712 struct v4l2_mbus_frame_desc *fd);
713 };
714
715 /**
716 * struct v4l2_subdev_ops - Subdev operations
717 *
718 * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL
719 * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL
720 * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL
721 * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL
722 * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL
723 * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL
724 * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL
725 * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL
726 */
727 struct v4l2_subdev_ops {
728 const struct v4l2_subdev_core_ops *core;
729 const struct v4l2_subdev_tuner_ops *tuner;
730 const struct v4l2_subdev_audio_ops *audio;
731 const struct v4l2_subdev_video_ops *video;
732 const struct v4l2_subdev_vbi_ops *vbi;
733 const struct v4l2_subdev_ir_ops *ir;
734 const struct v4l2_subdev_sensor_ops *sensor;
735 const struct v4l2_subdev_pad_ops *pad;
736 };
737
738 /**
739 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
740 *
741 * @registered: called when this subdev is registered. When called the v4l2_dev
742 * field is set to the correct v4l2_device.
743 *
744 * @unregistered: called when this subdev is unregistered. When called the
745 * v4l2_dev field is still set to the correct v4l2_device.
746 *
747 * @open: called when the subdev device node is opened by an application.
748 *
749 * @close: called when the subdev device node is closed. Please note that
750 * it is possible for @close to be called after @unregistered!
751 *
752 * @release: called when the last user of the subdev device is gone. This
753 * happens after the @unregistered callback and when the last open
754 * filehandle to the v4l-subdevX device node was closed. If no device
755 * node was created for this sub-device, then the @release callback
756 * is called right after the @unregistered callback.
757 * The @release callback is typically used to free the memory containing
758 * the v4l2_subdev structure. It is almost certainly required for any
759 * sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag.
760 *
761 * .. note::
762 * Never call this from drivers, only the v4l2 framework can call
763 * these ops.
764 */
765 struct v4l2_subdev_internal_ops {
766 int (*registered)(struct v4l2_subdev *sd);
767 void (*unregistered)(struct v4l2_subdev *sd);
768 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
769 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
770 void (*release)(struct v4l2_subdev *sd);
771 };
772
773 #define V4L2_SUBDEV_NAME_SIZE 32
774
775 /* Set this flag if this subdev is a i2c device. */
776 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
777 /* Set this flag if this subdev is a spi device. */
778 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
779 /* Set this flag if this subdev needs a device node. */
780 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
781 /*
782 * Set this flag if this subdev generates events.
783 * Note controls can send events, thus drivers exposing controls
784 * should set this flag.
785 */
786 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
787
788 struct regulator_bulk_data;
789
790 /**
791 * struct v4l2_subdev_platform_data - regulators config struct
792 *
793 * @regulators: Optional regulators used to power on/off the subdevice
794 * @num_regulators: Number of regululators
795 * @host_priv: Per-subdevice data, specific for a certain video host device
796 */
797 struct v4l2_subdev_platform_data {
798 struct regulator_bulk_data *regulators;
799 int num_regulators;
800
801 void *host_priv;
802 };
803
804 /**
805 * struct v4l2_subdev - describes a V4L2 sub-device
806 *
807 * @entity: pointer to &struct media_entity
808 * @list: List of sub-devices
809 * @owner: The owner is the same as the driver's &struct device owner.
810 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
811 * owner. Initialized by v4l2_device_register_subdev().
812 * @flags: subdev flags. Can be:
813 * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
814 * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
815 * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
816 * device node;
817 * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates
818 * events.
819 *
820 * @v4l2_dev: pointer to struct &v4l2_device
821 * @ops: pointer to struct &v4l2_subdev_ops
822 * @internal_ops: pointer to struct &v4l2_subdev_internal_ops.
823 * Never call these internal ops from within a driver!
824 * @ctrl_handler: The control handler of this subdev. May be NULL.
825 * @name: Name of the sub-device. Please notice that the name must be unique.
826 * @grp_id: can be used to group similar subdevs. Value is driver-specific
827 * @dev_priv: pointer to private data
828 * @host_priv: pointer to private data used by the device where the subdev
829 * is attached.
830 * @devnode: subdev device node
831 * @dev: pointer to the physical device, if any
832 * @fwnode: The fwnode_handle of the subdev, usually the same as
833 * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
834 * @async_list: Links this subdev to a global subdev_list or @notifier->done
835 * list.
836 * @asd: Pointer to respective &struct v4l2_async_subdev.
837 * @notifier: Pointer to the managing notifier.
838 * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
839 * device using v4l2_device_register_sensor_subdev().
840 * @pdata: common part of subdevice platform data
841 *
842 * Each instance of a subdev driver should create this struct, either
843 * stand-alone or embedded in a larger struct.
844 *
845 * This structure should be initialized by v4l2_subdev_init() or one of
846 * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init().
847 */
848 struct v4l2_subdev {
849 #if defined(CONFIG_MEDIA_CONTROLLER)
850 struct media_entity entity;
851 #endif
852 struct list_head list;
853 struct module *owner;
854 bool owner_v4l2_dev;
855 u32 flags;
856 struct v4l2_device *v4l2_dev;
857 const struct v4l2_subdev_ops *ops;
858 const struct v4l2_subdev_internal_ops *internal_ops;
859 struct v4l2_ctrl_handler *ctrl_handler;
860 char name[V4L2_SUBDEV_NAME_SIZE];
861 u32 grp_id;
862 void *dev_priv;
863 void *host_priv;
864 struct video_device *devnode;
865 struct device *dev;
866 struct fwnode_handle *fwnode;
867 struct list_head async_list;
868 struct v4l2_async_subdev *asd;
869 struct v4l2_async_notifier *notifier;
870 struct v4l2_async_notifier *subdev_notifier;
871 struct v4l2_subdev_platform_data *pdata;
872 };
873
874
875 /**
876 * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
877 * the &struct media_entity embedded in it.
878 *
879 * @ent: pointer to &struct media_entity.
880 */
881 #define media_entity_to_v4l2_subdev(ent) \
882 ({ \
883 typeof(ent) __me_sd_ent = (ent); \
884 \
885 __me_sd_ent ? \
886 container_of(__me_sd_ent, struct v4l2_subdev, entity) : \
887 NULL; \
888 })
889
890 /**
891 * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
892 * the &struct video_device embedded on it.
893 *
894 * @vdev: pointer to &struct video_device
895 */
896 #define vdev_to_v4l2_subdev(vdev) \
897 ((struct v4l2_subdev *)video_get_drvdata(vdev))
898
899 /**
900 * struct v4l2_subdev_fh - Used for storing subdev information per file handle
901 *
902 * @vfh: pointer to &struct v4l2_fh
903 * @pad: pointer to &struct v4l2_subdev_pad_config
904 * @owner: module pointer to the owner of this file handle
905 */
906 struct v4l2_subdev_fh {
907 struct v4l2_fh vfh;
908 struct module *owner;
909 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
910 struct v4l2_subdev_pad_config *pad;
911 #endif
912 };
913
914 /**
915 * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
916 * the &struct v4l2_fh embedded on it.
917 *
918 * @fh: pointer to &struct v4l2_fh
919 */
920 #define to_v4l2_subdev_fh(fh) \
921 container_of(fh, struct v4l2_subdev_fh, vfh)
922
923 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
924
925 /**
926 * v4l2_subdev_get_try_format - ancillary routine to call
927 * &struct v4l2_subdev_pad_config->try_fmt
928 *
929 * @sd: pointer to &struct v4l2_subdev
930 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
931 * @pad: index of the pad in the @cfg array.
932 */
933 static inline struct v4l2_mbus_framefmt
934 *v4l2_subdev_get_try_format(struct v4l2_subdev *sd,
935 struct v4l2_subdev_pad_config *cfg,
936 unsigned int pad)
937 {
938 if (WARN_ON(pad >= sd->entity.num_pads))
939 pad = 0;
940 return &cfg[pad].try_fmt;
941 }
942
943 /**
944 * v4l2_subdev_get_try_crop - ancillary routine to call
945 * &struct v4l2_subdev_pad_config->try_crop
946 *
947 * @sd: pointer to &struct v4l2_subdev
948 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
949 * @pad: index of the pad in the @cfg array.
950 */
951 static inline struct v4l2_rect
952 *v4l2_subdev_get_try_crop(struct v4l2_subdev *sd,
953 struct v4l2_subdev_pad_config *cfg,
954 unsigned int pad)
955 {
956 if (WARN_ON(pad >= sd->entity.num_pads))
957 pad = 0;
958 return &cfg[pad].try_crop;
959 }
960
961 /**
962 * v4l2_subdev_get_try_crop - ancillary routine to call
963 * &struct v4l2_subdev_pad_config->try_compose
964 *
965 * @sd: pointer to &struct v4l2_subdev
966 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
967 * @pad: index of the pad in the @cfg array.
968 */
969 static inline struct v4l2_rect
970 *v4l2_subdev_get_try_compose(struct v4l2_subdev *sd,
971 struct v4l2_subdev_pad_config *cfg,
972 unsigned int pad)
973 {
974 if (WARN_ON(pad >= sd->entity.num_pads))
975 pad = 0;
976 return &cfg[pad].try_compose;
977 }
978 #endif
979
980 extern const struct v4l2_file_operations v4l2_subdev_fops;
981
982 /**
983 * v4l2_set_subdevdata - Sets V4L2 dev private device data
984 *
985 * @sd: pointer to &struct v4l2_subdev
986 * @p: pointer to the private device data to be stored.
987 */
988 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
989 {
990 sd->dev_priv = p;
991 }
992
993 /**
994 * v4l2_get_subdevdata - Gets V4L2 dev private device data
995 *
996 * @sd: pointer to &struct v4l2_subdev
997 *
998 * Returns the pointer to the private device data to be stored.
999 */
1000 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
1001 {
1002 return sd->dev_priv;
1003 }
1004
1005 /**
1006 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1007 *
1008 * @sd: pointer to &struct v4l2_subdev
1009 * @p: pointer to the private data to be stored.
1010 */
1011 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
1012 {
1013 sd->host_priv = p;
1014 }
1015
1016 /**
1017 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1018 *
1019 * @sd: pointer to &struct v4l2_subdev
1020 *
1021 * Returns the pointer to the private host data to be stored.
1022 */
1023 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
1024 {
1025 return sd->host_priv;
1026 }
1027
1028 #ifdef CONFIG_MEDIA_CONTROLLER
1029
1030 /**
1031 * v4l2_subdev_link_validate_default - validates a media link
1032 *
1033 * @sd: pointer to &struct v4l2_subdev
1034 * @link: pointer to &struct media_link
1035 * @source_fmt: pointer to &struct v4l2_subdev_format
1036 * @sink_fmt: pointer to &struct v4l2_subdev_format
1037 *
1038 * This function ensures that width, height and the media bus pixel
1039 * code are equal on both source and sink of the link.
1040 */
1041 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
1042 struct media_link *link,
1043 struct v4l2_subdev_format *source_fmt,
1044 struct v4l2_subdev_format *sink_fmt);
1045
1046 /**
1047 * v4l2_subdev_link_validate - validates a media link
1048 *
1049 * @link: pointer to &struct media_link
1050 *
1051 * This function calls the subdev's link_validate ops to validate
1052 * if a media link is valid for streaming. It also internally
1053 * calls v4l2_subdev_link_validate_default() to ensure that
1054 * width, height and the media bus pixel code are equal on both
1055 * source and sink of the link.
1056 */
1057 int v4l2_subdev_link_validate(struct media_link *link);
1058
1059 /**
1060 * v4l2_subdev_alloc_pad_config - Allocates memory for pad config
1061 *
1062 * @sd: pointer to struct v4l2_subdev
1063 */
1064 struct
1065 v4l2_subdev_pad_config *v4l2_subdev_alloc_pad_config(struct v4l2_subdev *sd);
1066
1067 /**
1068 * v4l2_subdev_free_pad_config - Frees memory allocated by
1069 * v4l2_subdev_alloc_pad_config().
1070 *
1071 * @cfg: pointer to &struct v4l2_subdev_pad_config
1072 */
1073 void v4l2_subdev_free_pad_config(struct v4l2_subdev_pad_config *cfg);
1074 #endif /* CONFIG_MEDIA_CONTROLLER */
1075
1076 /**
1077 * v4l2_subdev_init - initializes the sub-device struct
1078 *
1079 * @sd: pointer to the &struct v4l2_subdev to be initialized
1080 * @ops: pointer to &struct v4l2_subdev_ops.
1081 */
1082 void v4l2_subdev_init(struct v4l2_subdev *sd,
1083 const struct v4l2_subdev_ops *ops);
1084
1085 extern const struct v4l2_subdev_ops v4l2_subdev_call_wrappers;
1086
1087 /**
1088 * v4l2_subdev_call - call an operation of a v4l2_subdev.
1089 *
1090 * @sd: pointer to the &struct v4l2_subdev
1091 * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1092 * Each element there groups a set of callbacks functions.
1093 * @f: callback function that will be called if @cond matches.
1094 * The callback functions are defined in groups, according to
1095 * each element at &struct v4l2_subdev_ops.
1096 * @args...: arguments for @f.
1097 *
1098 * Example: err = v4l2_subdev_call(sd, video, s_std, norm);
1099 */
1100 #define v4l2_subdev_call(sd, o, f, args...) \
1101 ({ \
1102 struct v4l2_subdev *__sd = (sd); \
1103 int __result; \
1104 if (!__sd) \
1105 __result = -ENODEV; \
1106 else if (!(__sd->ops->o && __sd->ops->o->f)) \
1107 __result = -ENOIOCTLCMD; \
1108 else if (v4l2_subdev_call_wrappers.o && \
1109 v4l2_subdev_call_wrappers.o->f) \
1110 __result = v4l2_subdev_call_wrappers.o->f( \
1111 __sd, ##args); \
1112 else \
1113 __result = __sd->ops->o->f(__sd, ##args); \
1114 __result; \
1115 })
1116
1117 /**
1118 * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1119 *
1120 * @sd: pointer to the &struct v4l2_subdev
1121 * @o: The group of callback functions in &struct v4l2_subdev_ops
1122 * which @f is a part of.
1123 * @f: callback function to be checked for its existence.
1124 */
1125 #define v4l2_subdev_has_op(sd, o, f) \
1126 ((sd)->ops->o && (sd)->ops->o->f)
1127
1128 /**
1129 * v4l2_subdev_notify_event() - Delivers event notification for subdevice
1130 * @sd: The subdev for which to deliver the event
1131 * @ev: The event to deliver
1132 *
1133 * Will deliver the specified event to all userspace event listeners which are
1134 * subscribed to the v42l subdev event queue as well as to the bridge driver
1135 * using the notify callback. The notification type for the notify callback
1136 * will be %V4L2_DEVICE_NOTIFY_EVENT.
1137 */
1138 void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
1139 const struct v4l2_event *ev);
1140
1141 #endif