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 struct led_classdev;
42 
43 /**
44  * struct v4l2_decode_vbi_line - used to decode_vbi_line
45  *
46  * @is_second_field: Set to 0 for the first (odd) field;
47  *	set to 1 for the second (even) field.
48  * @p: Pointer to the sliced VBI data from the decoder. On exit, points to
49  *	the start of the payload.
50  * @line: Line number of the sliced VBI data (1-23)
51  * @type: VBI service type (V4L2_SLICED_*). 0 if no service found
52  */
53 struct v4l2_decode_vbi_line {
54 	u32 is_second_field;
55 	u8 *p;
56 	u32 line;
57 	u32 type;
58 };
59 
60 /*
61  * Sub-devices are devices that are connected somehow to the main bridge
62  * device. These devices are usually audio/video muxers/encoders/decoders or
63  * sensors and webcam controllers.
64  *
65  * Usually these devices are controlled through an i2c bus, but other buses
66  * may also be used.
67  *
68  * The v4l2_subdev struct provides a way of accessing these devices in a
69  * generic manner. Most operations that these sub-devices support fall in
70  * a few categories: core ops, audio ops, video ops and tuner ops.
71  *
72  * More categories can be added if needed, although this should remain a
73  * limited set (no more than approx. 8 categories).
74  *
75  * Each category has its own set of ops that subdev drivers can implement.
76  *
77  * A subdev driver can leave the pointer to the category ops NULL if
78  * it does not implement them (e.g. an audio subdev will generally not
79  * implement the video category ops). The exception is the core category:
80  * this must always be present.
81  *
82  * These ops are all used internally so it is no problem to change, remove
83  * or add ops or move ops from one to another category. Currently these
84  * ops are based on the original ioctls, but since ops are not limited to
85  * one argument there is room for improvement here once all i2c subdev
86  * drivers are converted to use these ops.
87  */
88 
89 /*
90  * Core ops: it is highly recommended to implement at least these ops:
91  *
92  * log_status
93  * g_register
94  * s_register
95  *
96  * This provides basic debugging support.
97  *
98  * The ioctl ops is meant for generic ioctl-like commands. Depending on
99  * the use-case it might be better to use subdev-specific ops (currently
100  * not yet implemented) since ops provide proper type-checking.
101  */
102 
103 /**
104  * enum v4l2_subdev_io_pin_bits - Subdevice external IO pin configuration
105  *	bits
106  *
107  * @V4L2_SUBDEV_IO_PIN_DISABLE: disables a pin config. ENABLE assumed.
108  * @V4L2_SUBDEV_IO_PIN_OUTPUT: set it if pin is an output.
109  * @V4L2_SUBDEV_IO_PIN_INPUT: set it if pin is an input.
110  * @V4L2_SUBDEV_IO_PIN_SET_VALUE: to set the output value via
111  *				  &struct v4l2_subdev_io_pin_config->value.
112  * @V4L2_SUBDEV_IO_PIN_ACTIVE_LOW: pin active is bit 0.
113  *				   Otherwise, ACTIVE HIGH is assumed.
114  */
115 enum v4l2_subdev_io_pin_bits {
116 	V4L2_SUBDEV_IO_PIN_DISABLE	= 0,
117 	V4L2_SUBDEV_IO_PIN_OUTPUT	= 1,
118 	V4L2_SUBDEV_IO_PIN_INPUT	= 2,
119 	V4L2_SUBDEV_IO_PIN_SET_VALUE	= 3,
120 	V4L2_SUBDEV_IO_PIN_ACTIVE_LOW	= 4,
121 };
122 
123 /**
124  * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration
125  *
126  * @flags: bitmask with flags for this pin's config, whose bits are defined by
127  *	   &enum v4l2_subdev_io_pin_bits.
128  * @pin: Chip external IO pin to configure
129  * @function: Internal signal pad/function to route to IO pin
130  * @value: Initial value for pin - e.g. GPIO output value
131  * @strength: Pin drive strength
132  */
133 struct v4l2_subdev_io_pin_config {
134 	u32 flags;
135 	u8 pin;
136 	u8 function;
137 	u8 value;
138 	u8 strength;
139 };
140 
141 /**
142  * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs
143  *
144  * @log_status: callback for VIDIOC_LOG_STATUS() ioctl handler code.
145  *
146  * @s_io_pin_config: configure one or more chip I/O pins for chips that
147  *	multiplex different internal signal pads out to IO pins.  This function
148  *	takes a pointer to an array of 'n' pin configuration entries, one for
149  *	each pin being configured.  This function could be called at times
150  *	other than just subdevice initialization.
151  *
152  * @init: initialize the sensor registers to some sort of reasonable default
153  *	values. Do not use for new drivers and should be removed in existing
154  *	drivers.
155  *
156  * @load_fw: load firmware.
157  *
158  * @reset: generic reset command. The argument selects which subsystems to
159  *	reset. Passing 0 will always reset the whole chip. Do not use for new
160  *	drivers without discussing this first on the linux-media mailinglist.
161  *	There should be no reason normally to reset a device.
162  *
163  * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with
164  *	a direction argument if needed.
165  *
166  * @command: called by in-kernel drivers in order to call functions internal
167  *	   to subdev drivers driver that have a separate callback.
168  *
169  * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core.
170  *	   used to provide support for private ioctls used on the driver.
171  *
172  * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel,
173  *		    in order to fix data passed from/to userspace.
174  *
175  * @g_register: callback for VIDIOC_DBG_G_REGISTER() ioctl handler code.
176  *
177  * @s_register: callback for VIDIOC_DBG_S_REGISTER() ioctl handler code.
178  *
179  * @s_power: puts subdevice in power saving mode (on == 0) or normal operation
180  *	mode (on == 1). DEPRECATED. See
181  *	Documentation/driver-api/media/camera-sensor.rst . pre_streamon and
182  *	post_streamoff callbacks can be used for e.g. setting the bus to LP-11
183  *	mode before s_stream is called.
184  *
185  * @interrupt_service_routine: Called by the bridge chip's interrupt service
186  *	handler, when an interrupt status has be raised due to this subdev,
187  *	so that this subdev can handle the details.  It may schedule work to be
188  *	performed later.  It must not sleep. **Called from an IRQ context**.
189  *
190  * @subscribe_event: used by the drivers to request the control framework that
191  *		     for it to be warned when the value of a control changes.
192  *
193  * @unsubscribe_event: remove event subscription from the control framework.
194  */
195 struct v4l2_subdev_core_ops {
196 	int (*log_status)(struct v4l2_subdev *sd);
197 	int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
198 				      struct v4l2_subdev_io_pin_config *pincfg);
199 	int (*init)(struct v4l2_subdev *sd, u32 val);
200 	int (*load_fw)(struct v4l2_subdev *sd);
201 	int (*reset)(struct v4l2_subdev *sd, u32 val);
202 	int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
203 	long (*command)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
204 	long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
205 #ifdef CONFIG_COMPAT
206 	long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,
207 			       unsigned long arg);
208 #endif
209 #ifdef CONFIG_VIDEO_ADV_DEBUG
210 	int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
211 	int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg);
212 #endif
213 	int (*s_power)(struct v4l2_subdev *sd, int on);
214 	int (*interrupt_service_routine)(struct v4l2_subdev *sd,
215 						u32 status, bool *handled);
216 	int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
217 			       struct v4l2_event_subscription *sub);
218 	int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
219 				 struct v4l2_event_subscription *sub);
220 };
221 
222 /**
223  * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened
224  *	in radio mode.
225  *
226  * @standby: puts the tuner in standby mode. It will be woken up
227  *	     automatically the next time it is used.
228  *
229  * @s_radio: callback that switches the tuner to radio mode.
230  *	     drivers should explicitly call it when a tuner ops should
231  *	     operate on radio mode, before being able to handle it.
232  *	     Used on devices that have both AM/FM radio receiver and TV.
233  *
234  * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code.
235  *
236  * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code.
237  *		 freq->type must be filled in. Normally done by video_ioctl2()
238  *		 or the bridge driver.
239  *
240  * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code.
241  *
242  * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code.
243  *
244  * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be
245  *	     filled in. Normally done by video_ioctl2 or the
246  *	     bridge driver.
247  *
248  * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code.
249  *
250  * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code.
251  *
252  * @s_type_addr: sets tuner type and its I2C addr.
253  *
254  * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
255  *
256  * .. note::
257  *
258  *	On devices that have both AM/FM and TV, it is up to the driver
259  *	to explicitly call s_radio when the tuner should be switched to
260  *	radio mode, before handling other &struct v4l2_subdev_tuner_ops
261  *	that would require it. An example of such usage is::
262  *
263  *	  static void s_frequency(void *priv, const struct v4l2_frequency *f)
264  *	  {
265  *		...
266  *		if (f.type == V4L2_TUNER_RADIO)
267  *			v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio);
268  *		...
269  *		v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency);
270  *	  }
271  */
272 struct v4l2_subdev_tuner_ops {
273 	int (*standby)(struct v4l2_subdev *sd);
274 	int (*s_radio)(struct v4l2_subdev *sd);
275 	int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);
276 	int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
277 	int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);
278 	int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
279 	int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);
280 	int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
281 	int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);
282 	int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
283 	int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
284 };
285 
286 /**
287  * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
288  *
289  * @s_clock_freq: set the frequency (in Hz) of the audio clock output.
290  *	Used to slave an audio processor to the video decoder, ensuring that
291  *	audio and video remain synchronized. Usual values for the frequency
292  *	are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
293  *	-EINVAL is returned.
294  *
295  * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
296  *	way to select I2S clock used by driving digital audio streams at some
297  *	board designs. Usual values for the frequency are 1024000 and 2048000.
298  *	If the frequency is not supported, then %-EINVAL is returned.
299  *
300  * @s_routing: used to define the input and/or output pins of an audio chip,
301  *	and any additional configuration data.
302  *	Never attempt to use user-level input IDs (e.g. Composite, S-Video,
303  *	Tuner) at this level. An i2c device shouldn't know about whether an
304  *	input pin is connected to a Composite connector, become on another
305  *	board or platform it might be connected to something else entirely.
306  *	The calling driver is responsible for mapping a user-level input to
307  *	the right pins on the i2c device.
308  *
309  * @s_stream: used to notify the audio code that stream will start or has
310  *	stopped.
311  */
312 struct v4l2_subdev_audio_ops {
313 	int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
314 	int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
315 	int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
316 	int (*s_stream)(struct v4l2_subdev *sd, int enable);
317 };
318 
319 /**
320  * struct v4l2_mbus_frame_desc_entry_csi2
321  *
322  * @vc: CSI-2 virtual channel
323  * @dt: CSI-2 data type ID
324  */
325 struct v4l2_mbus_frame_desc_entry_csi2 {
326 	u8 vc;
327 	u8 dt;
328 };
329 
330 /**
331  * enum v4l2_mbus_frame_desc_flags - media bus frame description flags
332  *
333  * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX:
334  *	Indicates that &struct v4l2_mbus_frame_desc_entry->length field
335  *	specifies maximum data length.
336  * @V4L2_MBUS_FRAME_DESC_FL_BLOB:
337  *	Indicates that the format does not have line offsets, i.e.
338  *	the receiver should use 1D DMA.
339  */
340 enum v4l2_mbus_frame_desc_flags {
341 	V4L2_MBUS_FRAME_DESC_FL_LEN_MAX	= BIT(0),
342 	V4L2_MBUS_FRAME_DESC_FL_BLOB	= BIT(1),
343 };
344 
345 /**
346  * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
347  *
348  * @flags:	bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags.
349  * @stream:	stream in routing configuration
350  * @pixelcode:	media bus pixel code, valid if @flags
351  *		%FRAME_DESC_FL_BLOB is not set.
352  * @length:	number of octets per frame, valid if @flags
353  *		%V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set.
354  * @bus:	Bus-specific frame descriptor parameters
355  * @bus.csi2:	CSI-2-specific bus configuration
356  */
357 struct v4l2_mbus_frame_desc_entry {
358 	enum v4l2_mbus_frame_desc_flags flags;
359 	u32 stream;
360 	u32 pixelcode;
361 	u32 length;
362 	union {
363 		struct v4l2_mbus_frame_desc_entry_csi2 csi2;
364 	} bus;
365 };
366 
367  /*
368   * If this number is too small, it should be dropped altogether and the
369   * API switched to a dynamic number of frame descriptor entries.
370   */
371 #define V4L2_FRAME_DESC_ENTRY_MAX	8
372 
373 /**
374  * enum v4l2_mbus_frame_desc_type - media bus frame description type
375  *
376  * @V4L2_MBUS_FRAME_DESC_TYPE_UNDEFINED:
377  *	Undefined frame desc type. Drivers should not use this, it is
378  *	for backwards compatibility.
379  * @V4L2_MBUS_FRAME_DESC_TYPE_PARALLEL:
380  *	Parallel media bus.
381  * @V4L2_MBUS_FRAME_DESC_TYPE_CSI2:
382  *	CSI-2 media bus. Frame desc parameters must be set in
383  *	&struct v4l2_mbus_frame_desc_entry->csi2.
384  */
385 enum v4l2_mbus_frame_desc_type {
386 	V4L2_MBUS_FRAME_DESC_TYPE_UNDEFINED = 0,
387 	V4L2_MBUS_FRAME_DESC_TYPE_PARALLEL,
388 	V4L2_MBUS_FRAME_DESC_TYPE_CSI2,
389 };
390 
391 /**
392  * struct v4l2_mbus_frame_desc - media bus data frame description
393  * @type: type of the bus (enum v4l2_mbus_frame_desc_type)
394  * @entry: frame descriptors array
395  * @num_entries: number of entries in @entry array
396  */
397 struct v4l2_mbus_frame_desc {
398 	enum v4l2_mbus_frame_desc_type type;
399 	struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
400 	unsigned short num_entries;
401 };
402 
403 /**
404  * enum v4l2_subdev_pre_streamon_flags - Flags for pre_streamon subdev core op
405  *
406  * @V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP: Set the transmitter to either LP-11
407  *	or LP-111 mode before call to s_stream().
408  */
409 enum v4l2_subdev_pre_streamon_flags {
410 	V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP = BIT(0),
411 };
412 
413 /**
414  * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
415  *				  in video mode.
416  *
417  * @s_routing: see s_routing in audio_ops, except this version is for video
418  *	devices.
419  *
420  * @s_crystal_freq: sets the frequency of the crystal used to generate the
421  *	clocks in Hz. An extra flags field allows device specific configuration
422  *	regarding clock frequency dividers, etc. If not used, then set flags
423  *	to 0. If the frequency is not supported, then -EINVAL is returned.
424  *
425  * @g_std: callback for VIDIOC_G_STD() ioctl handler code.
426  *
427  * @s_std: callback for VIDIOC_S_STD() ioctl handler code.
428  *
429  * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
430  *	video input devices.
431  *
432  * @g_std_output: get current standard for video OUTPUT devices. This is ignored
433  *	by video input devices.
434  *
435  * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code.
436  *
437  * @g_tvnorms: get &v4l2_std_id with all standards supported by the video
438  *	CAPTURE device. This is ignored by video output devices.
439  *
440  * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
441  *	OUTPUT device. This is ignored by video capture devices.
442  *
443  * @g_input_status: get input status. Same as the status field in the
444  *	&struct v4l2_input
445  *
446  * @s_stream: start (enabled == 1) or stop (enabled == 0) streaming on the
447  *	sub-device. Failure on stop will remove any resources acquired in
448  *	streaming start, while the error code is still returned by the driver.
449  *	Also see call_s_stream wrapper in v4l2-subdev.c.
450  *
451  * @g_pixelaspect: callback to return the pixelaspect ratio.
452  *
453  * @g_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL()
454  *		      ioctl handler code.
455  *
456  * @s_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL()
457  *		      ioctl handler code.
458  *
459  * @s_dv_timings: Set custom dv timings in the sub device. This is used
460  *	when sub device is capable of setting detailed timing information
461  *	in the hardware to generate/detect the video signal.
462  *
463  * @g_dv_timings: Get custom dv timings in the sub device.
464  *
465  * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code.
466  *
467  * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
468  *	can adjust @size to a lower value and must not write more data to the
469  *	buffer starting at @data than the original value of @size.
470  *
471  * @pre_streamon: May be called before streaming is actually started, to help
472  *	initialising the bus. Current usage is to set a CSI-2 transmitter to
473  *	LP-11 or LP-111 mode before streaming. See &enum
474  *	v4l2_subdev_pre_streamon_flags.
475  *
476  *	pre_streamon shall return error if it cannot perform the operation as
477  *	indicated by the flags argument. In particular, -EACCES indicates lack
478  *	of support for the operation. The caller shall call post_streamoff for
479  *	each successful call of pre_streamon.
480  *
481  * @post_streamoff: Called after streaming is stopped, but if and only if
482  *	pre_streamon was called earlier.
483  */
484 struct v4l2_subdev_video_ops {
485 	int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
486 	int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
487 	int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
488 	int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
489 	int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
490 	int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
491 	int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
492 	int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
493 	int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
494 	int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
495 	int (*s_stream)(struct v4l2_subdev *sd, int enable);
496 	int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect);
497 	int (*g_frame_interval)(struct v4l2_subdev *sd,
498 				struct v4l2_subdev_frame_interval *interval);
499 	int (*s_frame_interval)(struct v4l2_subdev *sd,
500 				struct v4l2_subdev_frame_interval *interval);
501 	int (*s_dv_timings)(struct v4l2_subdev *sd,
502 			struct v4l2_dv_timings *timings);
503 	int (*g_dv_timings)(struct v4l2_subdev *sd,
504 			struct v4l2_dv_timings *timings);
505 	int (*query_dv_timings)(struct v4l2_subdev *sd,
506 			struct v4l2_dv_timings *timings);
507 	int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
508 			   unsigned int *size);
509 	int (*pre_streamon)(struct v4l2_subdev *sd, u32 flags);
510 	int (*post_streamoff)(struct v4l2_subdev *sd);
511 };
512 
513 /**
514  * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
515  *				  in video mode via the vbi device node.
516  *
517  *  @decode_vbi_line: video decoders that support sliced VBI need to implement
518  *	this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the
519  *	start of the VBI data that was generated by the decoder. The driver
520  *	then parses the sliced VBI data and sets the other fields in the
521  *	struct accordingly. The pointer p is updated to point to the start of
522  *	the payload which can be copied verbatim into the data field of the
523  *	&struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the
524  *	type field is set to 0 on return.
525  *
526  * @s_vbi_data: used to generate VBI signals on a video signal.
527  *	&struct v4l2_sliced_vbi_data is filled with the data packets that
528  *	should be output. Note that if you set the line field to 0, then that
529  *	VBI signal is disabled. If no valid VBI data was found, then the type
530  *	field is set to 0 on return.
531  *
532  * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
533  *	Not all video decoders support this. If no data is available because
534  *	the readback register contains invalid or erroneous data %-EIO is
535  *	returned. Note that you must fill in the 'id' member and the 'field'
536  *	member (to determine whether CC data from the first or second field
537  *	should be obtained).
538  *
539  * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler
540  *		      code.
541  *
542  * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
543  *
544  * @g_sliced_fmt: retrieve the current sliced VBI settings.
545  *
546  * @s_sliced_fmt: setup the sliced VBI settings.
547  */
548 struct v4l2_subdev_vbi_ops {
549 	int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
550 	int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
551 	int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
552 	int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
553 	int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
554 	int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
555 	int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
556 };
557 
558 /**
559  * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
560  * @g_skip_top_lines: number of lines at the top of the image to be skipped.
561  *		      This is needed for some sensors, which always corrupt
562  *		      several top lines of the output image, or which send their
563  *		      metadata in them.
564  * @g_skip_frames: number of frames to skip at stream start. This is needed for
565  *		   buggy sensors that generate faulty frames when they are
566  *		   turned on.
567  */
568 struct v4l2_subdev_sensor_ops {
569 	int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
570 	int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
571 };
572 
573 /**
574  * enum v4l2_subdev_ir_mode- describes the type of IR supported
575  *
576  * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records
577  */
578 enum v4l2_subdev_ir_mode {
579 	V4L2_SUBDEV_IR_MODE_PULSE_WIDTH,
580 };
581 
582 /**
583  * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
584  *
585  * @bytes_per_data_element: bytes per data element of data in read or
586  *	write call.
587  * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode.
588  * @enable: device is active if true
589  * @interrupt_enable: IR interrupts are enabled if true
590  * @shutdown: if true: set hardware to low/no power, false: normal mode
591  *
592  * @modulation: if true, it uses carrier, if false: baseband
593  * @max_pulse_width:  maximum pulse width in ns, valid only for baseband signal
594  * @carrier_freq: carrier frequency in Hz, valid only for modulated signal
595  * @duty_cycle: duty cycle percentage, valid only for modulated signal
596  * @invert_level: invert signal level
597  *
598  * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX.
599  *
600  * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX.
601  * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated
602  *	signal. Used only for RX.
603  * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated
604  *	signal. Used only for RX.
605  * @resolution: The receive resolution, in ns . Used only for RX.
606  */
607 struct v4l2_subdev_ir_parameters {
608 	unsigned int bytes_per_data_element;
609 	enum v4l2_subdev_ir_mode mode;
610 
611 	bool enable;
612 	bool interrupt_enable;
613 	bool shutdown;
614 
615 	bool modulation;
616 	u32 max_pulse_width;
617 	unsigned int carrier_freq;
618 	unsigned int duty_cycle;
619 	bool invert_level;
620 
621 	/* Tx only */
622 	bool invert_carrier_sense;
623 
624 	/* Rx only */
625 	u32 noise_filter_min_width;
626 	unsigned int carrier_range_lower;
627 	unsigned int carrier_range_upper;
628 	u32 resolution;
629 };
630 
631 /**
632  * struct v4l2_subdev_ir_ops - operations for IR subdevices
633  *
634  * @rx_read: Reads received codes or pulse width data.
635  *	The semantics are similar to a non-blocking read() call.
636  * @rx_g_parameters: Get the current operating parameters and state of
637  *	the IR receiver.
638  * @rx_s_parameters: Set the current operating parameters and state of
639  *	the IR receiver.  It is recommended to call
640  *	[rt]x_g_parameters first to fill out the current state, and only change
641  *	the fields that need to be changed.  Upon return, the actual device
642  *	operating parameters and state will be returned.  Note that hardware
643  *	limitations may prevent the actual settings from matching the requested
644  *	settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
645  *	was requested.  An exception is when the shutdown parameter is true.
646  *	The last used operational parameters will be returned, but the actual
647  *	state of the hardware be different to minimize power consumption and
648  *	processing when shutdown is true.
649  *
650  * @tx_write: Writes codes or pulse width data for transmission.
651  *	The semantics are similar to a non-blocking write() call.
652  * @tx_g_parameters: Get the current operating parameters and state of
653  *	the IR transmitter.
654  * @tx_s_parameters: Set the current operating parameters and state of
655  *	the IR transmitter.  It is recommended to call
656  *	[rt]x_g_parameters first to fill out the current state, and only change
657  *	the fields that need to be changed.  Upon return, the actual device
658  *	operating parameters and state will be returned.  Note that hardware
659  *	limitations may prevent the actual settings from matching the requested
660  *	settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
661  *	was requested.  An exception is when the shutdown parameter is true.
662  *	The last used operational parameters will be returned, but the actual
663  *	state of the hardware be different to minimize power consumption and
664  *	processing when shutdown is true.
665  */
666 struct v4l2_subdev_ir_ops {
667 	/* Receiver */
668 	int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
669 				ssize_t *num);
670 
671 	int (*rx_g_parameters)(struct v4l2_subdev *sd,
672 				struct v4l2_subdev_ir_parameters *params);
673 	int (*rx_s_parameters)(struct v4l2_subdev *sd,
674 				struct v4l2_subdev_ir_parameters *params);
675 
676 	/* Transmitter */
677 	int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
678 				ssize_t *num);
679 
680 	int (*tx_g_parameters)(struct v4l2_subdev *sd,
681 				struct v4l2_subdev_ir_parameters *params);
682 	int (*tx_s_parameters)(struct v4l2_subdev *sd,
683 				struct v4l2_subdev_ir_parameters *params);
684 };
685 
686 /**
687  * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
688  *
689  * @try_fmt: &struct v4l2_mbus_framefmt
690  * @try_crop: &struct v4l2_rect to be used for crop
691  * @try_compose: &struct v4l2_rect to be used for compose
692  *
693  * This structure only needs to be passed to the pad op if the 'which' field
694  * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
695  * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
696  *
697  * Note: This struct is also used in active state, and the 'try' prefix is
698  * historical and to be removed.
699  */
700 struct v4l2_subdev_pad_config {
701 	struct v4l2_mbus_framefmt try_fmt;
702 	struct v4l2_rect try_crop;
703 	struct v4l2_rect try_compose;
704 };
705 
706 /**
707  * struct v4l2_subdev_stream_config - Used for storing stream configuration.
708  *
709  * @pad: pad number
710  * @stream: stream number
711  * @enabled: has the stream been enabled with v4l2_subdev_enable_stream()
712  * @fmt: &struct v4l2_mbus_framefmt
713  * @crop: &struct v4l2_rect to be used for crop
714  * @compose: &struct v4l2_rect to be used for compose
715  *
716  * This structure stores configuration for a stream.
717  */
718 struct v4l2_subdev_stream_config {
719 	u32 pad;
720 	u32 stream;
721 	bool enabled;
722 
723 	struct v4l2_mbus_framefmt fmt;
724 	struct v4l2_rect crop;
725 	struct v4l2_rect compose;
726 };
727 
728 /**
729  * struct v4l2_subdev_stream_configs - A collection of stream configs.
730  *
731  * @num_configs: number of entries in @config.
732  * @configs: an array of &struct v4l2_subdev_stream_configs.
733  */
734 struct v4l2_subdev_stream_configs {
735 	u32 num_configs;
736 	struct v4l2_subdev_stream_config *configs;
737 };
738 
739 /**
740  * struct v4l2_subdev_krouting - subdev routing table
741  *
742  * @num_routes: number of routes
743  * @routes: &struct v4l2_subdev_route
744  *
745  * This structure contains the routing table for a subdev.
746  */
747 struct v4l2_subdev_krouting {
748 	unsigned int num_routes;
749 	struct v4l2_subdev_route *routes;
750 };
751 
752 /**
753  * struct v4l2_subdev_state - Used for storing subdev state information.
754  *
755  * @_lock: default for 'lock'
756  * @lock: mutex for the state. May be replaced by the user.
757  * @pads: &struct v4l2_subdev_pad_config array
758  * @routing: routing table for the subdev
759  * @stream_configs: stream configurations (only for V4L2_SUBDEV_FL_STREAMS)
760  *
761  * This structure only needs to be passed to the pad op if the 'which' field
762  * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
763  * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
764  */
765 struct v4l2_subdev_state {
766 	/* lock for the struct v4l2_subdev_state fields */
767 	struct mutex _lock;
768 	struct mutex *lock;
769 	struct v4l2_subdev_pad_config *pads;
770 	struct v4l2_subdev_krouting routing;
771 	struct v4l2_subdev_stream_configs stream_configs;
772 };
773 
774 /**
775  * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
776  *
777  * @init_cfg: initialize the pad config to default values
778  * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler
779  *		    code.
780  * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler
781  *		     code.
782  *
783  * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl
784  *			 handler code.
785  *
786  * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code.
787  *
788  * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code.
789  *
790  * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code.
791  *
792  * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code.
793  *
794  * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code.
795  *
796  * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code.
797  *
798  * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler
799  *		    code.
800  *
801  * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler
802  *		     code.
803  *
804  * @link_validate: used by the media controller code to check if the links
805  *		   that belongs to a pipeline can be used for stream.
806  *
807  * @get_frame_desc: get the current low level media bus frame parameters.
808  *
809  * @set_frame_desc: set the low level media bus frame parameters, @fd array
810  *                  may be adjusted by the subdev driver to device capabilities.
811  *
812  * @get_mbus_config: get the media bus configuration of a remote sub-device.
813  *		     The media bus configuration is usually retrieved from the
814  *		     firmware interface at sub-device probe time, immediately
815  *		     applied to the hardware and eventually adjusted by the
816  *		     driver. Remote sub-devices (usually video receivers) shall
817  *		     use this operation to query the transmitting end bus
818  *		     configuration in order to adjust their own one accordingly.
819  *		     Callers should make sure they get the most up-to-date as
820  *		     possible configuration from the remote end, likely calling
821  *		     this operation as close as possible to stream on time. The
822  *		     operation shall fail if the pad index it has been called on
823  *		     is not valid or in case of unrecoverable failures.
824  *
825  * @set_routing: enable or disable data connection routes described in the
826  *		 subdevice routing table.
827  *
828  * @enable_streams: Enable the streams defined in streams_mask on the given
829  *	source pad. Subdevs that implement this operation must use the active
830  *	state management provided by the subdev core (enabled through a call to
831  *	v4l2_subdev_init_finalize() at initialization time). Do not call
832  *	directly, use v4l2_subdev_enable_streams() instead.
833  *
834  * @disable_streams: Disable the streams defined in streams_mask on the given
835  *	source pad. Subdevs that implement this operation must use the active
836  *	state management provided by the subdev core (enabled through a call to
837  *	v4l2_subdev_init_finalize() at initialization time). Do not call
838  *	directly, use v4l2_subdev_disable_streams() instead.
839  */
840 struct v4l2_subdev_pad_ops {
841 	int (*init_cfg)(struct v4l2_subdev *sd,
842 			struct v4l2_subdev_state *state);
843 	int (*enum_mbus_code)(struct v4l2_subdev *sd,
844 			      struct v4l2_subdev_state *state,
845 			      struct v4l2_subdev_mbus_code_enum *code);
846 	int (*enum_frame_size)(struct v4l2_subdev *sd,
847 			       struct v4l2_subdev_state *state,
848 			       struct v4l2_subdev_frame_size_enum *fse);
849 	int (*enum_frame_interval)(struct v4l2_subdev *sd,
850 				   struct v4l2_subdev_state *state,
851 				   struct v4l2_subdev_frame_interval_enum *fie);
852 	int (*get_fmt)(struct v4l2_subdev *sd,
853 		       struct v4l2_subdev_state *state,
854 		       struct v4l2_subdev_format *format);
855 	int (*set_fmt)(struct v4l2_subdev *sd,
856 		       struct v4l2_subdev_state *state,
857 		       struct v4l2_subdev_format *format);
858 	int (*get_selection)(struct v4l2_subdev *sd,
859 			     struct v4l2_subdev_state *state,
860 			     struct v4l2_subdev_selection *sel);
861 	int (*set_selection)(struct v4l2_subdev *sd,
862 			     struct v4l2_subdev_state *state,
863 			     struct v4l2_subdev_selection *sel);
864 	int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
865 	int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
866 	int (*dv_timings_cap)(struct v4l2_subdev *sd,
867 			      struct v4l2_dv_timings_cap *cap);
868 	int (*enum_dv_timings)(struct v4l2_subdev *sd,
869 			       struct v4l2_enum_dv_timings *timings);
870 #ifdef CONFIG_MEDIA_CONTROLLER
871 	int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
872 			     struct v4l2_subdev_format *source_fmt,
873 			     struct v4l2_subdev_format *sink_fmt);
874 #endif /* CONFIG_MEDIA_CONTROLLER */
875 	int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
876 			      struct v4l2_mbus_frame_desc *fd);
877 	int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
878 			      struct v4l2_mbus_frame_desc *fd);
879 	int (*get_mbus_config)(struct v4l2_subdev *sd, unsigned int pad,
880 			       struct v4l2_mbus_config *config);
881 	int (*set_routing)(struct v4l2_subdev *sd,
882 			   struct v4l2_subdev_state *state,
883 			   enum v4l2_subdev_format_whence which,
884 			   struct v4l2_subdev_krouting *route);
885 	int (*enable_streams)(struct v4l2_subdev *sd,
886 			      struct v4l2_subdev_state *state, u32 pad,
887 			      u64 streams_mask);
888 	int (*disable_streams)(struct v4l2_subdev *sd,
889 			       struct v4l2_subdev_state *state, u32 pad,
890 			       u64 streams_mask);
891 };
892 
893 /**
894  * struct v4l2_subdev_ops - Subdev operations
895  *
896  * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL
897  * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL
898  * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL
899  * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL
900  * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL
901  * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL
902  * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL
903  * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL
904  */
905 struct v4l2_subdev_ops {
906 	const struct v4l2_subdev_core_ops	*core;
907 	const struct v4l2_subdev_tuner_ops	*tuner;
908 	const struct v4l2_subdev_audio_ops	*audio;
909 	const struct v4l2_subdev_video_ops	*video;
910 	const struct v4l2_subdev_vbi_ops	*vbi;
911 	const struct v4l2_subdev_ir_ops		*ir;
912 	const struct v4l2_subdev_sensor_ops	*sensor;
913 	const struct v4l2_subdev_pad_ops	*pad;
914 };
915 
916 /**
917  * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
918  *
919  * @registered: called when this subdev is registered. When called the v4l2_dev
920  *	field is set to the correct v4l2_device.
921  *
922  * @unregistered: called when this subdev is unregistered. When called the
923  *	v4l2_dev field is still set to the correct v4l2_device.
924  *
925  * @open: called when the subdev device node is opened by an application.
926  *
927  * @close: called when the subdev device node is closed. Please note that
928  *	it is possible for @close to be called after @unregistered!
929  *
930  * @release: called when the last user of the subdev device is gone. This
931  *	happens after the @unregistered callback and when the last open
932  *	filehandle to the v4l-subdevX device node was closed. If no device
933  *	node was created for this sub-device, then the @release callback
934  *	is called right after the @unregistered callback.
935  *	The @release callback is typically used to free the memory containing
936  *	the v4l2_subdev structure. It is almost certainly required for any
937  *	sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag.
938  *
939  * .. note::
940  *	Never call this from drivers, only the v4l2 framework can call
941  *	these ops.
942  */
943 struct v4l2_subdev_internal_ops {
944 	int (*registered)(struct v4l2_subdev *sd);
945 	void (*unregistered)(struct v4l2_subdev *sd);
946 	int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
947 	int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
948 	void (*release)(struct v4l2_subdev *sd);
949 };
950 
951 #define V4L2_SUBDEV_NAME_SIZE 32
952 
953 /* Set this flag if this subdev is a i2c device. */
954 #define V4L2_SUBDEV_FL_IS_I2C			(1U << 0)
955 /* Set this flag if this subdev is a spi device. */
956 #define V4L2_SUBDEV_FL_IS_SPI			(1U << 1)
957 /* Set this flag if this subdev needs a device node. */
958 #define V4L2_SUBDEV_FL_HAS_DEVNODE		(1U << 2)
959 /*
960  * Set this flag if this subdev generates events.
961  * Note controls can send events, thus drivers exposing controls
962  * should set this flag.
963  */
964 #define V4L2_SUBDEV_FL_HAS_EVENTS		(1U << 3)
965 /*
966  * Set this flag if this subdev supports multiplexed streams. This means
967  * that the driver supports routing and handles the stream parameter in its
968  * v4l2_subdev_pad_ops handlers. More specifically, this means:
969  *
970  * - Centrally managed subdev active state is enabled
971  * - Legacy pad config is _not_ supported (state->pads is NULL)
972  * - Routing ioctls are available
973  * - Multiple streams per pad are supported
974  */
975 #define V4L2_SUBDEV_FL_STREAMS			(1U << 4)
976 
977 struct regulator_bulk_data;
978 
979 /**
980  * struct v4l2_subdev_platform_data - regulators config struct
981  *
982  * @regulators: Optional regulators used to power on/off the subdevice
983  * @num_regulators: Number of regululators
984  * @host_priv: Per-subdevice data, specific for a certain video host device
985  */
986 struct v4l2_subdev_platform_data {
987 	struct regulator_bulk_data *regulators;
988 	int num_regulators;
989 
990 	void *host_priv;
991 };
992 
993 /**
994  * struct v4l2_subdev - describes a V4L2 sub-device
995  *
996  * @entity: pointer to &struct media_entity
997  * @list: List of sub-devices
998  * @owner: The owner is the same as the driver's &struct device owner.
999  * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
1000  *	owner. Initialized by v4l2_device_register_subdev().
1001  * @flags: subdev flags. Can be:
1002  *   %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
1003  *   %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
1004  *   %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
1005  *   device node;
1006  *   %V4L2_SUBDEV_FL_HAS_EVENTS -  Set this flag if this subdev generates
1007  *   events.
1008  *
1009  * @v4l2_dev: pointer to struct &v4l2_device
1010  * @ops: pointer to struct &v4l2_subdev_ops
1011  * @internal_ops: pointer to struct &v4l2_subdev_internal_ops.
1012  *	Never call these internal ops from within a driver!
1013  * @ctrl_handler: The control handler of this subdev. May be NULL.
1014  * @name: Name of the sub-device. Please notice that the name must be unique.
1015  * @grp_id: can be used to group similar subdevs. Value is driver-specific
1016  * @dev_priv: pointer to private data
1017  * @host_priv: pointer to private data used by the device where the subdev
1018  *	is attached.
1019  * @devnode: subdev device node
1020  * @dev: pointer to the physical device, if any
1021  * @fwnode: The fwnode_handle of the subdev, usually the same as
1022  *	    either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
1023  * @async_list: Links this subdev to a global subdev_list or
1024  *		@notifier->done_list list.
1025  * @async_subdev_endpoint_list: List entry in async_subdev_endpoint_entry of
1026  *				&struct v4l2_async_subdev_endpoint.
1027  * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
1028  *		     device using v4l2_async_register_subdev_sensor().
1029  * @asc_list: Async connection list, of &struct
1030  *	      v4l2_async_connection.subdev_entry.
1031  * @pdata: common part of subdevice platform data
1032  * @state_lock: A pointer to a lock used for all the subdev's states, set by the
1033  *		driver. This is	optional. If NULL, each state instance will get
1034  *		a lock of its own.
1035  * @privacy_led: Optional pointer to a LED classdev for the privacy LED for sensors.
1036  * @active_state: Active state for the subdev (NULL for subdevs tracking the
1037  *		  state internally). Initialized by calling
1038  *		  v4l2_subdev_init_finalize().
1039  * @enabled_streams: Bitmask of enabled streams used by
1040  *		     v4l2_subdev_enable_streams() and
1041  *		     v4l2_subdev_disable_streams() helper functions for fallback
1042  *		     cases.
1043  *
1044  * Each instance of a subdev driver should create this struct, either
1045  * stand-alone or embedded in a larger struct.
1046  *
1047  * This structure should be initialized by v4l2_subdev_init() or one of
1048  * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init().
1049  */
1050 struct v4l2_subdev {
1051 #if defined(CONFIG_MEDIA_CONTROLLER)
1052 	struct media_entity entity;
1053 #endif
1054 	struct list_head list;
1055 	struct module *owner;
1056 	bool owner_v4l2_dev;
1057 	u32 flags;
1058 	struct v4l2_device *v4l2_dev;
1059 	const struct v4l2_subdev_ops *ops;
1060 	const struct v4l2_subdev_internal_ops *internal_ops;
1061 	struct v4l2_ctrl_handler *ctrl_handler;
1062 	char name[V4L2_SUBDEV_NAME_SIZE];
1063 	u32 grp_id;
1064 	void *dev_priv;
1065 	void *host_priv;
1066 	struct video_device *devnode;
1067 	struct device *dev;
1068 	struct fwnode_handle *fwnode;
1069 	struct list_head async_list;
1070 	struct list_head async_subdev_endpoint_list;
1071 	struct v4l2_async_notifier *subdev_notifier;
1072 	struct list_head asc_list;
1073 	struct v4l2_subdev_platform_data *pdata;
1074 	struct mutex *state_lock;
1075 
1076 	/*
1077 	 * The fields below are private, and should only be accessed via
1078 	 * appropriate functions.
1079 	 */
1080 
1081 	struct led_classdev *privacy_led;
1082 
1083 	/*
1084 	 * TODO: active_state should most likely be changed from a pointer to an
1085 	 * embedded field. For the time being it's kept as a pointer to more
1086 	 * easily catch uses of active_state in the cases where the driver
1087 	 * doesn't support it.
1088 	 */
1089 	struct v4l2_subdev_state *active_state;
1090 	u64 enabled_streams;
1091 };
1092 
1093 
1094 /**
1095  * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1096  *    the &struct media_entity embedded in it.
1097  *
1098  * @ent: pointer to &struct media_entity.
1099  */
1100 #define media_entity_to_v4l2_subdev(ent)				\
1101 ({									\
1102 	typeof(ent) __me_sd_ent = (ent);				\
1103 									\
1104 	__me_sd_ent ?							\
1105 		container_of(__me_sd_ent, struct v4l2_subdev, entity) :	\
1106 		NULL;							\
1107 })
1108 
1109 /**
1110  * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1111  *	the &struct video_device embedded on it.
1112  *
1113  * @vdev: pointer to &struct video_device
1114  */
1115 #define vdev_to_v4l2_subdev(vdev) \
1116 	((struct v4l2_subdev *)video_get_drvdata(vdev))
1117 
1118 /**
1119  * struct v4l2_subdev_fh - Used for storing subdev information per file handle
1120  *
1121  * @vfh: pointer to &struct v4l2_fh
1122  * @state: pointer to &struct v4l2_subdev_state
1123  * @owner: module pointer to the owner of this file handle
1124  * @client_caps: bitmask of ``V4L2_SUBDEV_CLIENT_CAP_*``
1125  */
1126 struct v4l2_subdev_fh {
1127 	struct v4l2_fh vfh;
1128 	struct module *owner;
1129 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
1130 	struct v4l2_subdev_state *state;
1131 	u64 client_caps;
1132 #endif
1133 };
1134 
1135 /**
1136  * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
1137  *	the &struct v4l2_fh embedded on it.
1138  *
1139  * @fh: pointer to &struct v4l2_fh
1140  */
1141 #define to_v4l2_subdev_fh(fh)	\
1142 	container_of(fh, struct v4l2_subdev_fh, vfh)
1143 
1144 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
1145 
1146 /**
1147  * v4l2_subdev_get_pad_format - ancillary routine to call
1148  *	&struct v4l2_subdev_pad_config->try_fmt
1149  *
1150  * @sd: pointer to &struct v4l2_subdev
1151  * @state: pointer to &struct v4l2_subdev_state
1152  * @pad: index of the pad in the &struct v4l2_subdev_state->pads array
1153  */
1154 static inline struct v4l2_mbus_framefmt *
v4l2_subdev_get_pad_format(struct v4l2_subdev * sd,struct v4l2_subdev_state * state,unsigned int pad)1155 v4l2_subdev_get_pad_format(struct v4l2_subdev *sd,
1156 			   struct v4l2_subdev_state *state,
1157 			   unsigned int pad)
1158 {
1159 	if (WARN_ON(!state))
1160 		return NULL;
1161 	if (WARN_ON(pad >= sd->entity.num_pads))
1162 		pad = 0;
1163 	return &state->pads[pad].try_fmt;
1164 }
1165 
1166 /**
1167  * v4l2_subdev_get_pad_crop - ancillary routine to call
1168  *	&struct v4l2_subdev_pad_config->try_crop
1169  *
1170  * @sd: pointer to &struct v4l2_subdev
1171  * @state: pointer to &struct v4l2_subdev_state.
1172  * @pad: index of the pad in the &struct v4l2_subdev_state->pads array.
1173  */
1174 static inline struct v4l2_rect *
v4l2_subdev_get_pad_crop(struct v4l2_subdev * sd,struct v4l2_subdev_state * state,unsigned int pad)1175 v4l2_subdev_get_pad_crop(struct v4l2_subdev *sd,
1176 			 struct v4l2_subdev_state *state,
1177 			 unsigned int pad)
1178 {
1179 	if (WARN_ON(!state))
1180 		return NULL;
1181 	if (WARN_ON(pad >= sd->entity.num_pads))
1182 		pad = 0;
1183 	return &state->pads[pad].try_crop;
1184 }
1185 
1186 /**
1187  * v4l2_subdev_get_pad_compose - ancillary routine to call
1188  *	&struct v4l2_subdev_pad_config->try_compose
1189  *
1190  * @sd: pointer to &struct v4l2_subdev
1191  * @state: pointer to &struct v4l2_subdev_state.
1192  * @pad: index of the pad in the &struct v4l2_subdev_state->pads array.
1193  */
1194 static inline struct v4l2_rect *
v4l2_subdev_get_pad_compose(struct v4l2_subdev * sd,struct v4l2_subdev_state * state,unsigned int pad)1195 v4l2_subdev_get_pad_compose(struct v4l2_subdev *sd,
1196 			    struct v4l2_subdev_state *state,
1197 			    unsigned int pad)
1198 {
1199 	if (WARN_ON(!state))
1200 		return NULL;
1201 	if (WARN_ON(pad >= sd->entity.num_pads))
1202 		pad = 0;
1203 	return &state->pads[pad].try_compose;
1204 }
1205 
1206 /*
1207  * Temprary helpers until uses of v4l2_subdev_get_try_* functions have been
1208  * renamed
1209  */
1210 #define v4l2_subdev_get_try_format(sd, state, pad) \
1211 	v4l2_subdev_get_pad_format(sd, state, pad)
1212 
1213 #define v4l2_subdev_get_try_crop(sd, state, pad) \
1214 	v4l2_subdev_get_pad_crop(sd, state, pad)
1215 
1216 #define v4l2_subdev_get_try_compose(sd, state, pad) \
1217 	v4l2_subdev_get_pad_compose(sd, state, pad)
1218 
1219 #endif /* CONFIG_VIDEO_V4L2_SUBDEV_API */
1220 
1221 extern const struct v4l2_file_operations v4l2_subdev_fops;
1222 
1223 /**
1224  * v4l2_set_subdevdata - Sets V4L2 dev private device data
1225  *
1226  * @sd: pointer to &struct v4l2_subdev
1227  * @p: pointer to the private device data to be stored.
1228  */
v4l2_set_subdevdata(struct v4l2_subdev * sd,void * p)1229 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
1230 {
1231 	sd->dev_priv = p;
1232 }
1233 
1234 /**
1235  * v4l2_get_subdevdata - Gets V4L2 dev private device data
1236  *
1237  * @sd: pointer to &struct v4l2_subdev
1238  *
1239  * Returns the pointer to the private device data to be stored.
1240  */
v4l2_get_subdevdata(const struct v4l2_subdev * sd)1241 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
1242 {
1243 	return sd->dev_priv;
1244 }
1245 
1246 /**
1247  * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1248  *
1249  * @sd: pointer to &struct v4l2_subdev
1250  * @p: pointer to the private data to be stored.
1251  */
v4l2_set_subdev_hostdata(struct v4l2_subdev * sd,void * p)1252 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
1253 {
1254 	sd->host_priv = p;
1255 }
1256 
1257 /**
1258  * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1259  *
1260  * @sd: pointer to &struct v4l2_subdev
1261  *
1262  * Returns the pointer to the private host data to be stored.
1263  */
v4l2_get_subdev_hostdata(const struct v4l2_subdev * sd)1264 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
1265 {
1266 	return sd->host_priv;
1267 }
1268 
1269 #ifdef CONFIG_MEDIA_CONTROLLER
1270 
1271 /**
1272  * v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode
1273  *                                     endpoint, assuming 1:1 port:pad
1274  *
1275  * @entity: Pointer to the subdev entity
1276  * @endpoint: Pointer to a parsed fwnode endpoint
1277  *
1278  * This function can be used as the .get_fwnode_pad operation for
1279  * subdevices that map port numbers and pad indexes 1:1. If the endpoint
1280  * is owned by the subdevice, the function returns the endpoint port
1281  * number.
1282  *
1283  * Returns the endpoint port number on success or a negative error code.
1284  */
1285 int v4l2_subdev_get_fwnode_pad_1_to_1(struct media_entity *entity,
1286 				      struct fwnode_endpoint *endpoint);
1287 
1288 /**
1289  * v4l2_subdev_link_validate_default - validates a media link
1290  *
1291  * @sd: pointer to &struct v4l2_subdev
1292  * @link: pointer to &struct media_link
1293  * @source_fmt: pointer to &struct v4l2_subdev_format
1294  * @sink_fmt: pointer to &struct v4l2_subdev_format
1295  *
1296  * This function ensures that width, height and the media bus pixel
1297  * code are equal on both source and sink of the link.
1298  */
1299 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
1300 				      struct media_link *link,
1301 				      struct v4l2_subdev_format *source_fmt,
1302 				      struct v4l2_subdev_format *sink_fmt);
1303 
1304 /**
1305  * v4l2_subdev_link_validate - validates a media link
1306  *
1307  * @link: pointer to &struct media_link
1308  *
1309  * This function calls the subdev's link_validate ops to validate
1310  * if a media link is valid for streaming. It also internally
1311  * calls v4l2_subdev_link_validate_default() to ensure that
1312  * width, height and the media bus pixel code are equal on both
1313  * source and sink of the link.
1314  */
1315 int v4l2_subdev_link_validate(struct media_link *link);
1316 
1317 /**
1318  * v4l2_subdev_has_pad_interdep - MC has_pad_interdep implementation for subdevs
1319  *
1320  * @entity: pointer to &struct media_entity
1321  * @pad0: pad number for the first pad
1322  * @pad1: pad number for the second pad
1323  *
1324  * This function is an implementation of the
1325  * media_entity_operations.has_pad_interdep operation for subdevs that
1326  * implement the multiplexed streams API (as indicated by the
1327  * V4L2_SUBDEV_FL_STREAMS subdev flag).
1328  *
1329  * It considers two pads interdependent if there is an active route between pad0
1330  * and pad1.
1331  */
1332 bool v4l2_subdev_has_pad_interdep(struct media_entity *entity,
1333 				  unsigned int pad0, unsigned int pad1);
1334 
1335 /**
1336  * __v4l2_subdev_state_alloc - allocate v4l2_subdev_state
1337  *
1338  * @sd: pointer to &struct v4l2_subdev for which the state is being allocated.
1339  * @lock_name: name of the state lock
1340  * @key: lock_class_key for the lock
1341  *
1342  * Must call __v4l2_subdev_state_free() when state is no longer needed.
1343  *
1344  * Not to be called directly by the drivers.
1345  */
1346 struct v4l2_subdev_state *__v4l2_subdev_state_alloc(struct v4l2_subdev *sd,
1347 						    const char *lock_name,
1348 						    struct lock_class_key *key);
1349 
1350 /**
1351  * __v4l2_subdev_state_free - free a v4l2_subdev_state
1352  *
1353  * @state: v4l2_subdev_state to be freed.
1354  *
1355  * Not to be called directly by the drivers.
1356  */
1357 void __v4l2_subdev_state_free(struct v4l2_subdev_state *state);
1358 
1359 /**
1360  * v4l2_subdev_init_finalize() - Finalizes the initialization of the subdevice
1361  * @sd: The subdev
1362  *
1363  * This function finalizes the initialization of the subdev, including
1364  * allocation of the active state for the subdev.
1365  *
1366  * This function must be called by the subdev drivers that use the centralized
1367  * active state, after the subdev struct has been initialized and
1368  * media_entity_pads_init() has been called, but before registering the
1369  * subdev.
1370  *
1371  * The user must call v4l2_subdev_cleanup() when the subdev is being removed.
1372  */
1373 #define v4l2_subdev_init_finalize(sd)                                          \
1374 	({                                                                     \
1375 		static struct lock_class_key __key;                            \
1376 		const char *name = KBUILD_BASENAME                             \
1377 			":" __stringify(__LINE__) ":sd->active_state->lock";   \
1378 		__v4l2_subdev_init_finalize(sd, name, &__key);                 \
1379 	})
1380 
1381 int __v4l2_subdev_init_finalize(struct v4l2_subdev *sd, const char *name,
1382 				struct lock_class_key *key);
1383 
1384 /**
1385  * v4l2_subdev_cleanup() - Releases the resources allocated by the subdevice
1386  * @sd: The subdevice
1387  *
1388  * Clean up a V4L2 async sub-device. Must be called for a sub-device as part of
1389  * its release if resources have been associated with it using
1390  * v4l2_async_subdev_endpoint_add() or v4l2_subdev_init_finalize().
1391  */
1392 void v4l2_subdev_cleanup(struct v4l2_subdev *sd);
1393 
1394 /**
1395  * v4l2_subdev_lock_state() - Locks the subdev state
1396  * @state: The subdevice state
1397  *
1398  * Locks the given subdev state.
1399  *
1400  * The state must be unlocked with v4l2_subdev_unlock_state() after use.
1401  */
v4l2_subdev_lock_state(struct v4l2_subdev_state * state)1402 static inline void v4l2_subdev_lock_state(struct v4l2_subdev_state *state)
1403 {
1404 	mutex_lock(state->lock);
1405 }
1406 
1407 /**
1408  * v4l2_subdev_unlock_state() - Unlocks the subdev state
1409  * @state: The subdevice state
1410  *
1411  * Unlocks the given subdev state.
1412  */
v4l2_subdev_unlock_state(struct v4l2_subdev_state * state)1413 static inline void v4l2_subdev_unlock_state(struct v4l2_subdev_state *state)
1414 {
1415 	mutex_unlock(state->lock);
1416 }
1417 
1418 /**
1419  * v4l2_subdev_get_unlocked_active_state() - Checks that the active subdev state
1420  *					     is unlocked and returns it
1421  * @sd: The subdevice
1422  *
1423  * Returns the active state for the subdevice, or NULL if the subdev does not
1424  * support active state. If the state is not NULL, calls
1425  * lockdep_assert_not_held() to issue a warning if the state is locked.
1426  *
1427  * This function is to be used e.g. when getting the active state for the sole
1428  * purpose of passing it forward, without accessing the state fields.
1429  */
1430 static inline struct v4l2_subdev_state *
v4l2_subdev_get_unlocked_active_state(struct v4l2_subdev * sd)1431 v4l2_subdev_get_unlocked_active_state(struct v4l2_subdev *sd)
1432 {
1433 	if (sd->active_state)
1434 		lockdep_assert_not_held(sd->active_state->lock);
1435 	return sd->active_state;
1436 }
1437 
1438 /**
1439  * v4l2_subdev_get_locked_active_state() - Checks that the active subdev state
1440  *					   is locked and returns it
1441  *
1442  * @sd: The subdevice
1443  *
1444  * Returns the active state for the subdevice, or NULL if the subdev does not
1445  * support active state. If the state is not NULL, calls lockdep_assert_held()
1446  * to issue a warning if the state is not locked.
1447  *
1448  * This function is to be used when the caller knows that the active state is
1449  * already locked.
1450  */
1451 static inline struct v4l2_subdev_state *
v4l2_subdev_get_locked_active_state(struct v4l2_subdev * sd)1452 v4l2_subdev_get_locked_active_state(struct v4l2_subdev *sd)
1453 {
1454 	if (sd->active_state)
1455 		lockdep_assert_held(sd->active_state->lock);
1456 	return sd->active_state;
1457 }
1458 
1459 /**
1460  * v4l2_subdev_lock_and_get_active_state() - Locks and returns the active subdev
1461  *					     state for the subdevice
1462  * @sd: The subdevice
1463  *
1464  * Returns the locked active state for the subdevice, or NULL if the subdev
1465  * does not support active state.
1466  *
1467  * The state must be unlocked with v4l2_subdev_unlock_state() after use.
1468  */
1469 static inline struct v4l2_subdev_state *
v4l2_subdev_lock_and_get_active_state(struct v4l2_subdev * sd)1470 v4l2_subdev_lock_and_get_active_state(struct v4l2_subdev *sd)
1471 {
1472 	if (sd->active_state)
1473 		v4l2_subdev_lock_state(sd->active_state);
1474 	return sd->active_state;
1475 }
1476 
1477 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
1478 
1479 /**
1480  * v4l2_subdev_get_fmt() - Fill format based on state
1481  * @sd: subdevice
1482  * @state: subdevice state
1483  * @format: pointer to &struct v4l2_subdev_format
1484  *
1485  * Fill @format->format field based on the information in the @format struct.
1486  *
1487  * This function can be used by the subdev drivers which support active state to
1488  * implement v4l2_subdev_pad_ops.get_fmt if the subdev driver does not need to
1489  * do anything special in their get_fmt op.
1490  *
1491  * Returns 0 on success, error value otherwise.
1492  */
1493 int v4l2_subdev_get_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_state *state,
1494 			struct v4l2_subdev_format *format);
1495 
1496 /**
1497  * v4l2_subdev_set_routing() - Set given routing to subdev state
1498  * @sd: The subdevice
1499  * @state: The subdevice state
1500  * @routing: Routing that will be copied to subdev state
1501  *
1502  * This will release old routing table (if any) from the state, allocate
1503  * enough space for the given routing, and copy the routing.
1504  *
1505  * This can be used from the subdev driver's set_routing op, after validating
1506  * the routing.
1507  */
1508 int v4l2_subdev_set_routing(struct v4l2_subdev *sd,
1509 			    struct v4l2_subdev_state *state,
1510 			    const struct v4l2_subdev_krouting *routing);
1511 
1512 struct v4l2_subdev_route *
1513 __v4l2_subdev_next_active_route(const struct v4l2_subdev_krouting *routing,
1514 				struct v4l2_subdev_route *route);
1515 
1516 /**
1517  * for_each_active_route - iterate on all active routes of a routing table
1518  * @routing: The routing table
1519  * @route: The route iterator
1520  */
1521 #define for_each_active_route(routing, route) \
1522 	for ((route) = NULL;                  \
1523 	     ((route) = __v4l2_subdev_next_active_route((routing), (route)));)
1524 
1525 /**
1526  * v4l2_subdev_set_routing_with_fmt() - Set given routing and format to subdev
1527  *					state
1528  * @sd: The subdevice
1529  * @state: The subdevice state
1530  * @routing: Routing that will be copied to subdev state
1531  * @fmt: Format used to initialize all the streams
1532  *
1533  * This is the same as v4l2_subdev_set_routing, but additionally initializes
1534  * all the streams using the given format.
1535  */
1536 int v4l2_subdev_set_routing_with_fmt(struct v4l2_subdev *sd,
1537 				     struct v4l2_subdev_state *state,
1538 				     const struct v4l2_subdev_krouting *routing,
1539 				     const struct v4l2_mbus_framefmt *fmt);
1540 
1541 /**
1542  * v4l2_subdev_state_get_stream_format() - Get pointer to a stream format
1543  * @state: subdevice state
1544  * @pad: pad id
1545  * @stream: stream id
1546  *
1547  * This returns a pointer to &struct v4l2_mbus_framefmt for the given pad +
1548  * stream in the subdev state.
1549  *
1550  * If the state does not contain the given pad + stream, NULL is returned.
1551  */
1552 struct v4l2_mbus_framefmt *
1553 v4l2_subdev_state_get_stream_format(struct v4l2_subdev_state *state,
1554 				    unsigned int pad, u32 stream);
1555 
1556 /**
1557  * v4l2_subdev_state_get_stream_crop() - Get pointer to a stream crop rectangle
1558  * @state: subdevice state
1559  * @pad: pad id
1560  * @stream: stream id
1561  *
1562  * This returns a pointer to crop rectangle for the given pad + stream in the
1563  * subdev state.
1564  *
1565  * If the state does not contain the given pad + stream, NULL is returned.
1566  */
1567 struct v4l2_rect *
1568 v4l2_subdev_state_get_stream_crop(struct v4l2_subdev_state *state,
1569 				  unsigned int pad, u32 stream);
1570 
1571 /**
1572  * v4l2_subdev_state_get_stream_compose() - Get pointer to a stream compose
1573  *					    rectangle
1574  * @state: subdevice state
1575  * @pad: pad id
1576  * @stream: stream id
1577  *
1578  * This returns a pointer to compose rectangle for the given pad + stream in the
1579  * subdev state.
1580  *
1581  * If the state does not contain the given pad + stream, NULL is returned.
1582  */
1583 struct v4l2_rect *
1584 v4l2_subdev_state_get_stream_compose(struct v4l2_subdev_state *state,
1585 				     unsigned int pad, u32 stream);
1586 
1587 /**
1588  * v4l2_subdev_routing_find_opposite_end() - Find the opposite stream
1589  * @routing: routing used to find the opposite side
1590  * @pad: pad id
1591  * @stream: stream id
1592  * @other_pad: pointer used to return the opposite pad
1593  * @other_stream: pointer used to return the opposite stream
1594  *
1595  * This function uses the routing table to find the pad + stream which is
1596  * opposite the given pad + stream.
1597  *
1598  * @other_pad and/or @other_stream can be NULL if the caller does not need the
1599  * value.
1600  *
1601  * Returns 0 on success, or -EINVAL if no matching route is found.
1602  */
1603 int v4l2_subdev_routing_find_opposite_end(const struct v4l2_subdev_krouting *routing,
1604 					  u32 pad, u32 stream, u32 *other_pad,
1605 					  u32 *other_stream);
1606 
1607 /**
1608  * v4l2_subdev_state_get_opposite_stream_format() - Get pointer to opposite
1609  *                                                  stream format
1610  * @state: subdevice state
1611  * @pad: pad id
1612  * @stream: stream id
1613  *
1614  * This returns a pointer to &struct v4l2_mbus_framefmt for the pad + stream
1615  * that is opposite the given pad + stream in the subdev state.
1616  *
1617  * If the state does not contain the given pad + stream, NULL is returned.
1618  */
1619 struct v4l2_mbus_framefmt *
1620 v4l2_subdev_state_get_opposite_stream_format(struct v4l2_subdev_state *state,
1621 					     u32 pad, u32 stream);
1622 
1623 /**
1624  * v4l2_subdev_state_xlate_streams() - Translate streams from one pad to another
1625  *
1626  * @state: Subdevice state
1627  * @pad0: The first pad
1628  * @pad1: The second pad
1629  * @streams: Streams bitmask on the first pad
1630  *
1631  * Streams on sink pads of a subdev are routed to source pads as expressed in
1632  * the subdev state routing table. Stream numbers don't necessarily match on
1633  * the sink and source side of a route. This function translates stream numbers
1634  * on @pad0, expressed as a bitmask in @streams, to the corresponding streams
1635  * on @pad1 using the routing table from the @state. It returns the stream mask
1636  * on @pad1, and updates @streams with the streams that have been found in the
1637  * routing table.
1638  *
1639  * @pad0 and @pad1 must be a sink and a source, in any order.
1640  *
1641  * Return: The bitmask of streams of @pad1 that are routed to @streams on @pad0.
1642  */
1643 u64 v4l2_subdev_state_xlate_streams(const struct v4l2_subdev_state *state,
1644 				    u32 pad0, u32 pad1, u64 *streams);
1645 
1646 /**
1647  * enum v4l2_subdev_routing_restriction - Subdevice internal routing restrictions
1648  *
1649  * @V4L2_SUBDEV_ROUTING_NO_1_TO_N:
1650  *	an input stream shall not be routed to multiple output streams (stream
1651  *	duplication)
1652  * @V4L2_SUBDEV_ROUTING_NO_N_TO_1:
1653  *	multiple input streams shall not be routed to the same output stream
1654  *	(stream merging)
1655  * @V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX:
1656  *	all streams from a sink pad must be routed to a single source pad
1657  * @V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX:
1658  *	all streams on a source pad must originate from a single sink pad
1659  * @V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING:
1660  *	source pads shall not contain multiplexed streams
1661  * @V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING:
1662  *	sink pads shall not contain multiplexed streams
1663  * @V4L2_SUBDEV_ROUTING_ONLY_1_TO_1:
1664  *	only non-overlapping 1-to-1 stream routing is allowed (a combination of
1665  *	@V4L2_SUBDEV_ROUTING_NO_1_TO_N and @V4L2_SUBDEV_ROUTING_NO_N_TO_1)
1666  * @V4L2_SUBDEV_ROUTING_NO_STREAM_MIX:
1667  *	all streams from a sink pad must be routed to a single source pad, and
1668  *	that source pad shall not get routes from any other sink pad
1669  *	(a combination of @V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX and
1670  *	@V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX)
1671  * @V4L2_SUBDEV_ROUTING_NO_MULTIPLEXING:
1672  *	no multiplexed streams allowed on either source or sink sides.
1673  */
1674 enum v4l2_subdev_routing_restriction {
1675 	V4L2_SUBDEV_ROUTING_NO_1_TO_N = BIT(0),
1676 	V4L2_SUBDEV_ROUTING_NO_N_TO_1 = BIT(1),
1677 	V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX = BIT(2),
1678 	V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX = BIT(3),
1679 	V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING = BIT(4),
1680 	V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING = BIT(5),
1681 	V4L2_SUBDEV_ROUTING_ONLY_1_TO_1 =
1682 		V4L2_SUBDEV_ROUTING_NO_1_TO_N |
1683 		V4L2_SUBDEV_ROUTING_NO_N_TO_1,
1684 	V4L2_SUBDEV_ROUTING_NO_STREAM_MIX =
1685 		V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX |
1686 		V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX,
1687 	V4L2_SUBDEV_ROUTING_NO_MULTIPLEXING =
1688 		V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING |
1689 		V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING,
1690 };
1691 
1692 /**
1693  * v4l2_subdev_routing_validate() - Verify that routes comply with driver
1694  *				    constraints
1695  * @sd: The subdevice
1696  * @routing: Routing to verify
1697  * @disallow: Restrictions on routes
1698  *
1699  * This verifies that the given routing complies with the @disallow constraints.
1700  *
1701  * Returns 0 on success, error value otherwise.
1702  */
1703 int v4l2_subdev_routing_validate(struct v4l2_subdev *sd,
1704 				 const struct v4l2_subdev_krouting *routing,
1705 				 enum v4l2_subdev_routing_restriction disallow);
1706 
1707 /**
1708  * v4l2_subdev_enable_streams() - Enable streams on a pad
1709  * @sd: The subdevice
1710  * @pad: The pad
1711  * @streams_mask: Bitmask of streams to enable
1712  *
1713  * This function enables streams on a source @pad of a subdevice. The pad is
1714  * identified by its index, while the streams are identified by the
1715  * @streams_mask bitmask. This allows enabling multiple streams on a pad at
1716  * once.
1717  *
1718  * Enabling a stream that is already enabled isn't allowed. If @streams_mask
1719  * contains an already enabled stream, this function returns -EALREADY without
1720  * performing any operation.
1721  *
1722  * Per-stream enable is only available for subdevs that implement the
1723  * .enable_streams() and .disable_streams() operations. For other subdevs, this
1724  * function implements a best-effort compatibility by calling the .s_stream()
1725  * operation, limited to subdevs that have a single source pad.
1726  *
1727  * Return:
1728  * * 0: Success
1729  * * -EALREADY: One of the streams in streams_mask is already enabled
1730  * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1731  * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1732  *   impossible because the subdev has multiple source pads
1733  */
1734 int v4l2_subdev_enable_streams(struct v4l2_subdev *sd, u32 pad,
1735 			       u64 streams_mask);
1736 
1737 /**
1738  * v4l2_subdev_disable_streams() - Disable streams on a pad
1739  * @sd: The subdevice
1740  * @pad: The pad
1741  * @streams_mask: Bitmask of streams to disable
1742  *
1743  * This function disables streams on a source @pad of a subdevice. The pad is
1744  * identified by its index, while the streams are identified by the
1745  * @streams_mask bitmask. This allows disabling multiple streams on a pad at
1746  * once.
1747  *
1748  * Disabling a streams that is not enabled isn't allowed. If @streams_mask
1749  * contains a disabled stream, this function returns -EALREADY without
1750  * performing any operation.
1751  *
1752  * Per-stream disable is only available for subdevs that implement the
1753  * .enable_streams() and .disable_streams() operations. For other subdevs, this
1754  * function implements a best-effort compatibility by calling the .s_stream()
1755  * operation, limited to subdevs that have a single source pad.
1756  *
1757  * Return:
1758  * * 0: Success
1759  * * -EALREADY: One of the streams in streams_mask is not enabled
1760  * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1761  * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1762  *   impossible because the subdev has multiple source pads
1763  */
1764 int v4l2_subdev_disable_streams(struct v4l2_subdev *sd, u32 pad,
1765 				u64 streams_mask);
1766 
1767 /**
1768  * v4l2_subdev_s_stream_helper() - Helper to implement the subdev s_stream
1769  *	operation using enable_streams and disable_streams
1770  * @sd: The subdevice
1771  * @enable: Enable or disable streaming
1772  *
1773  * Subdevice drivers that implement the streams-aware
1774  * &v4l2_subdev_pad_ops.enable_streams and &v4l2_subdev_pad_ops.disable_streams
1775  * operations can use this helper to implement the legacy
1776  * &v4l2_subdev_video_ops.s_stream operation.
1777  *
1778  * This helper can only be used by subdevs that have a single source pad.
1779  *
1780  * Return: 0 on success, or a negative error code otherwise.
1781  */
1782 int v4l2_subdev_s_stream_helper(struct v4l2_subdev *sd, int enable);
1783 
1784 #endif /* CONFIG_VIDEO_V4L2_SUBDEV_API */
1785 
1786 #endif /* CONFIG_MEDIA_CONTROLLER */
1787 
1788 /**
1789  * v4l2_subdev_init - initializes the sub-device struct
1790  *
1791  * @sd: pointer to the &struct v4l2_subdev to be initialized
1792  * @ops: pointer to &struct v4l2_subdev_ops.
1793  */
1794 void v4l2_subdev_init(struct v4l2_subdev *sd,
1795 		      const struct v4l2_subdev_ops *ops);
1796 
1797 extern const struct v4l2_subdev_ops v4l2_subdev_call_wrappers;
1798 
1799 /**
1800  * v4l2_subdev_call - call an operation of a v4l2_subdev.
1801  *
1802  * @sd: pointer to the &struct v4l2_subdev
1803  * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1804  *     Each element there groups a set of callbacks functions.
1805  * @f: callback function to be called.
1806  *     The callback functions are defined in groups, according to
1807  *     each element at &struct v4l2_subdev_ops.
1808  * @args: arguments for @f.
1809  *
1810  * Example: err = v4l2_subdev_call(sd, video, s_std, norm);
1811  */
1812 #define v4l2_subdev_call(sd, o, f, args...)				\
1813 	({								\
1814 		struct v4l2_subdev *__sd = (sd);			\
1815 		int __result;						\
1816 		if (!__sd)						\
1817 			__result = -ENODEV;				\
1818 		else if (!(__sd->ops->o && __sd->ops->o->f))		\
1819 			__result = -ENOIOCTLCMD;			\
1820 		else if (v4l2_subdev_call_wrappers.o &&			\
1821 			 v4l2_subdev_call_wrappers.o->f)		\
1822 			__result = v4l2_subdev_call_wrappers.o->f(	\
1823 							__sd, ##args);	\
1824 		else							\
1825 			__result = __sd->ops->o->f(__sd, ##args);	\
1826 		__result;						\
1827 	})
1828 
1829 /**
1830  * v4l2_subdev_call_state_active - call an operation of a v4l2_subdev which
1831  *				   takes state as a parameter, passing the
1832  *				   subdev its active state.
1833  *
1834  * @sd: pointer to the &struct v4l2_subdev
1835  * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1836  *     Each element there groups a set of callbacks functions.
1837  * @f: callback function to be called.
1838  *     The callback functions are defined in groups, according to
1839  *     each element at &struct v4l2_subdev_ops.
1840  * @args: arguments for @f.
1841  *
1842  * This is similar to v4l2_subdev_call(), except that this version can only be
1843  * used for ops that take a subdev state as a parameter. The macro will get the
1844  * active state, lock it before calling the op and unlock it after the call.
1845  */
1846 #define v4l2_subdev_call_state_active(sd, o, f, args...)		\
1847 	({								\
1848 		int __result;						\
1849 		struct v4l2_subdev_state *state;			\
1850 		state = v4l2_subdev_get_unlocked_active_state(sd);	\
1851 		if (state)						\
1852 			v4l2_subdev_lock_state(state);			\
1853 		__result = v4l2_subdev_call(sd, o, f, state, ##args);	\
1854 		if (state)						\
1855 			v4l2_subdev_unlock_state(state);		\
1856 		__result;						\
1857 	})
1858 
1859 /**
1860  * v4l2_subdev_call_state_try - call an operation of a v4l2_subdev which
1861  *				takes state as a parameter, passing the
1862  *				subdev a newly allocated try state.
1863  *
1864  * @sd: pointer to the &struct v4l2_subdev
1865  * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1866  *     Each element there groups a set of callbacks functions.
1867  * @f: callback function to be called.
1868  *     The callback functions are defined in groups, according to
1869  *     each element at &struct v4l2_subdev_ops.
1870  * @args: arguments for @f.
1871  *
1872  * This is similar to v4l2_subdev_call_state_active(), except that as this
1873  * version allocates a new state, this is only usable for
1874  * V4L2_SUBDEV_FORMAT_TRY use cases.
1875  *
1876  * Note: only legacy non-MC drivers may need this macro.
1877  */
1878 #define v4l2_subdev_call_state_try(sd, o, f, args...)                 \
1879 	({                                                            \
1880 		int __result;                                         \
1881 		static struct lock_class_key __key;                   \
1882 		const char *name = KBUILD_BASENAME                    \
1883 			":" __stringify(__LINE__) ":state->lock";     \
1884 		struct v4l2_subdev_state *state =                     \
1885 			__v4l2_subdev_state_alloc(sd, name, &__key);  \
1886 		v4l2_subdev_lock_state(state);                        \
1887 		__result = v4l2_subdev_call(sd, o, f, state, ##args); \
1888 		v4l2_subdev_unlock_state(state);                      \
1889 		__v4l2_subdev_state_free(state);                      \
1890 		__result;                                             \
1891 	})
1892 
1893 /**
1894  * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1895  *
1896  * @sd: pointer to the &struct v4l2_subdev
1897  * @o: The group of callback functions in &struct v4l2_subdev_ops
1898  * which @f is a part of.
1899  * @f: callback function to be checked for its existence.
1900  */
1901 #define v4l2_subdev_has_op(sd, o, f) \
1902 	((sd)->ops->o && (sd)->ops->o->f)
1903 
1904 /**
1905  * v4l2_subdev_notify_event() - Delivers event notification for subdevice
1906  * @sd: The subdev for which to deliver the event
1907  * @ev: The event to deliver
1908  *
1909  * Will deliver the specified event to all userspace event listeners which are
1910  * subscribed to the v42l subdev event queue as well as to the bridge driver
1911  * using the notify callback. The notification type for the notify callback
1912  * will be %V4L2_DEVICE_NOTIFY_EVENT.
1913  */
1914 void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
1915 			      const struct v4l2_event *ev);
1916 
1917 #endif /* _V4L2_SUBDEV_H */
1918