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  * @command: called by in-kernel drivers in order to call functions internal
166  *	   to subdev drivers driver that have a separate callback.
167  *
168  * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core.
169  *	   used to provide support for private ioctls used on the driver.
170  *
171  * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel,
172  *		    in order to fix data passed from/to userspace.
173  *
174  * @g_register: callback for VIDIOC_DBG_G_REGISTER() ioctl handler code.
175  *
176  * @s_register: callback for VIDIOC_DBG_S_REGISTER() ioctl handler code.
177  *
178  * @s_power: puts subdevice in power saving mode (on == 0) or normal operation
179  *	mode (on == 1).
180  *
181  * @interrupt_service_routine: Called by the bridge chip's interrupt service
182  *	handler, when an interrupt status has be raised due to this subdev,
183  *	so that this subdev can handle the details.  It may schedule work to be
184  *	performed later.  It must not sleep. **Called from an IRQ context**.
185  *
186  * @subscribe_event: used by the drivers to request the control framework that
187  *		     for it to be warned when the value of a control changes.
188  *
189  * @unsubscribe_event: remove event subscription from the control framework.
190  */
191 struct v4l2_subdev_core_ops {
192 	int (*log_status)(struct v4l2_subdev *sd);
193 	int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
194 				      struct v4l2_subdev_io_pin_config *pincfg);
195 	int (*init)(struct v4l2_subdev *sd, u32 val);
196 	int (*load_fw)(struct v4l2_subdev *sd);
197 	int (*reset)(struct v4l2_subdev *sd, u32 val);
198 	int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
199 	long (*command)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
200 	long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
201 #ifdef CONFIG_COMPAT
202 	long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,
203 			       unsigned long arg);
204 #endif
205 #ifdef CONFIG_VIDEO_ADV_DEBUG
206 	int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
207 	int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg);
208 #endif
209 	int (*s_power)(struct v4l2_subdev *sd, int on);
210 	int (*interrupt_service_routine)(struct v4l2_subdev *sd,
211 						u32 status, bool *handled);
212 	int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
213 			       struct v4l2_event_subscription *sub);
214 	int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
215 				 struct v4l2_event_subscription *sub);
216 };
217 
218 /**
219  * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened
220  *	in radio mode.
221  *
222  * @standby: puts the tuner in standby mode. It will be woken up
223  *	     automatically the next time it is used.
224  *
225  * @s_radio: callback that switches the tuner to radio mode.
226  *	     drivers should explicitly call it when a tuner ops should
227  *	     operate on radio mode, before being able to handle it.
228  *	     Used on devices that have both AM/FM radio receiver and TV.
229  *
230  * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code.
231  *
232  * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code.
233  *		 freq->type must be filled in. Normally done by video_ioctl2()
234  *		 or the bridge driver.
235  *
236  * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code.
237  *
238  * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code.
239  *
240  * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be
241  *	     filled in. Normally done by video_ioctl2 or the
242  *	     bridge driver.
243  *
244  * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code.
245  *
246  * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code.
247  *
248  * @s_type_addr: sets tuner type and its I2C addr.
249  *
250  * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
251  *
252  * .. note::
253  *
254  *	On devices that have both AM/FM and TV, it is up to the driver
255  *	to explicitly call s_radio when the tuner should be switched to
256  *	radio mode, before handling other &struct v4l2_subdev_tuner_ops
257  *	that would require it. An example of such usage is::
258  *
259  *	  static void s_frequency(void *priv, const struct v4l2_frequency *f)
260  *	  {
261  *		...
262  *		if (f.type == V4L2_TUNER_RADIO)
263  *			v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio);
264  *		...
265  *		v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency);
266  *	  }
267  */
268 struct v4l2_subdev_tuner_ops {
269 	int (*standby)(struct v4l2_subdev *sd);
270 	int (*s_radio)(struct v4l2_subdev *sd);
271 	int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);
272 	int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
273 	int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);
274 	int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
275 	int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);
276 	int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
277 	int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);
278 	int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
279 	int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
280 };
281 
282 /**
283  * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
284  *
285  * @s_clock_freq: set the frequency (in Hz) of the audio clock output.
286  *	Used to slave an audio processor to the video decoder, ensuring that
287  *	audio and video remain synchronized. Usual values for the frequency
288  *	are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
289  *	-EINVAL is returned.
290  *
291  * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
292  *	way to select I2S clock used by driving digital audio streams at some
293  *	board designs. Usual values for the frequency are 1024000 and 2048000.
294  *	If the frequency is not supported, then %-EINVAL is returned.
295  *
296  * @s_routing: used to define the input and/or output pins of an audio chip,
297  *	and any additional configuration data.
298  *	Never attempt to use user-level input IDs (e.g. Composite, S-Video,
299  *	Tuner) at this level. An i2c device shouldn't know about whether an
300  *	input pin is connected to a Composite connector, become on another
301  *	board or platform it might be connected to something else entirely.
302  *	The calling driver is responsible for mapping a user-level input to
303  *	the right pins on the i2c device.
304  *
305  * @s_stream: used to notify the audio code that stream will start or has
306  *	stopped.
307  */
308 struct v4l2_subdev_audio_ops {
309 	int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
310 	int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
311 	int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
312 	int (*s_stream)(struct v4l2_subdev *sd, int enable);
313 };
314 
315 /**
316  * struct v4l2_mbus_frame_desc_entry_csi2
317  *
318  * @vc: CSI-2 virtual channel
319  * @dt: CSI-2 data type ID
320  */
321 struct v4l2_mbus_frame_desc_entry_csi2 {
322 	u8 vc;
323 	u8 dt;
324 };
325 
326 /**
327  * enum v4l2_mbus_frame_desc_flags - media bus frame description flags
328  *
329  * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX:
330  *	Indicates that &struct v4l2_mbus_frame_desc_entry->length field
331  *	specifies maximum data length.
332  * @V4L2_MBUS_FRAME_DESC_FL_BLOB:
333  *	Indicates that the format does not have line offsets, i.e.
334  *	the receiver should use 1D DMA.
335  */
336 enum v4l2_mbus_frame_desc_flags {
337 	V4L2_MBUS_FRAME_DESC_FL_LEN_MAX	= BIT(0),
338 	V4L2_MBUS_FRAME_DESC_FL_BLOB	= BIT(1),
339 };
340 
341 /**
342  * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
343  *
344  * @flags:	bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags.
345  * @pixelcode:	media bus pixel code, valid if @flags
346  *		%FRAME_DESC_FL_BLOB is not set.
347  * @length:	number of octets per frame, valid if @flags
348  *		%V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set.
349  * @bus:	Bus-specific frame descriptor parameters
350  * @bus.csi2:	CSI-2-specific bus configuration
351  */
352 struct v4l2_mbus_frame_desc_entry {
353 	enum v4l2_mbus_frame_desc_flags flags;
354 	u32 pixelcode;
355 	u32 length;
356 	union {
357 		struct v4l2_mbus_frame_desc_entry_csi2 csi2;
358 	} bus;
359 };
360 
361 #define V4L2_FRAME_DESC_ENTRY_MAX	4
362 
363 /**
364  * enum v4l2_mbus_frame_desc_type - media bus frame description type
365  *
366  * @V4L2_MBUS_FRAME_DESC_TYPE_UNDEFINED:
367  *	Undefined frame desc type. Drivers should not use this, it is
368  *	for backwards compatibility.
369  * @V4L2_MBUS_FRAME_DESC_TYPE_PARALLEL:
370  *	Parallel media bus.
371  * @V4L2_MBUS_FRAME_DESC_TYPE_CSI2:
372  *	CSI-2 media bus. Frame desc parameters must be set in
373  *	&struct v4l2_mbus_frame_desc_entry->csi2.
374  */
375 enum v4l2_mbus_frame_desc_type {
376 	V4L2_MBUS_FRAME_DESC_TYPE_UNDEFINED = 0,
377 	V4L2_MBUS_FRAME_DESC_TYPE_PARALLEL,
378 	V4L2_MBUS_FRAME_DESC_TYPE_CSI2,
379 };
380 
381 /**
382  * struct v4l2_mbus_frame_desc - media bus data frame description
383  * @type: type of the bus (enum v4l2_mbus_frame_desc_type)
384  * @entry: frame descriptors array
385  * @num_entries: number of entries in @entry array
386  */
387 struct v4l2_mbus_frame_desc {
388 	enum v4l2_mbus_frame_desc_type type;
389 	struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
390 	unsigned short num_entries;
391 };
392 
393 /**
394  * enum v4l2_subdev_pre_streamon_flags - Flags for pre_streamon subdev core op
395  *
396  * @V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP: Set the transmitter to either LP-11
397  *	or LP-111 mode before call to s_stream().
398  */
399 enum v4l2_subdev_pre_streamon_flags {
400 	V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP = BIT(0),
401 };
402 
403 /**
404  * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
405  *				  in video mode.
406  *
407  * @s_routing: see s_routing in audio_ops, except this version is for video
408  *	devices.
409  *
410  * @s_crystal_freq: sets the frequency of the crystal used to generate the
411  *	clocks in Hz. An extra flags field allows device specific configuration
412  *	regarding clock frequency dividers, etc. If not used, then set flags
413  *	to 0. If the frequency is not supported, then -EINVAL is returned.
414  *
415  * @g_std: callback for VIDIOC_G_STD() ioctl handler code.
416  *
417  * @s_std: callback for VIDIOC_S_STD() ioctl handler code.
418  *
419  * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
420  *	video input devices.
421  *
422  * @g_std_output: get current standard for video OUTPUT devices. This is ignored
423  *	by video input devices.
424  *
425  * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code.
426  *
427  * @g_tvnorms: get &v4l2_std_id with all standards supported by the video
428  *	CAPTURE device. This is ignored by video output devices.
429  *
430  * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
431  *	OUTPUT device. This is ignored by video capture devices.
432  *
433  * @g_input_status: get input status. Same as the status field in the
434  *	&struct v4l2_input
435  *
436  * @s_stream: used to notify the driver that a video stream will start or has
437  *	stopped.
438  *
439  * @g_pixelaspect: callback to return the pixelaspect ratio.
440  *
441  * @g_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL()
442  *		      ioctl handler code.
443  *
444  * @s_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL()
445  *		      ioctl handler code.
446  *
447  * @s_dv_timings: Set custom dv timings in the sub device. This is used
448  *	when sub device is capable of setting detailed timing information
449  *	in the hardware to generate/detect the video signal.
450  *
451  * @g_dv_timings: Get custom dv timings in the sub device.
452  *
453  * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code.
454  *
455  * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
456  *	can adjust @size to a lower value and must not write more data to the
457  *	buffer starting at @data than the original value of @size.
458  *
459  * @pre_streamon: May be called before streaming is actually started, to help
460  *	initialising the bus. Current usage is to set a CSI-2 transmitter to
461  *	LP-11 or LP-111 mode before streaming. See &enum
462  *	v4l2_subdev_pre_streamon_flags.
463  *
464  *	pre_streamon shall return error if it cannot perform the operation as
465  *	indicated by the flags argument. In particular, -EACCES indicates lack
466  *	of support for the operation. The caller shall call post_streamoff for
467  *	each successful call of pre_streamon.
468  *
469  * @post_streamoff: Called after streaming is stopped, but if and only if
470  *	pre_streamon was called earlier.
471  */
472 struct v4l2_subdev_video_ops {
473 	int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
474 	int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
475 	int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
476 	int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
477 	int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
478 	int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
479 	int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
480 	int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
481 	int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
482 	int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
483 	int (*s_stream)(struct v4l2_subdev *sd, int enable);
484 	int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect);
485 	int (*g_frame_interval)(struct v4l2_subdev *sd,
486 				struct v4l2_subdev_frame_interval *interval);
487 	int (*s_frame_interval)(struct v4l2_subdev *sd,
488 				struct v4l2_subdev_frame_interval *interval);
489 	int (*s_dv_timings)(struct v4l2_subdev *sd,
490 			struct v4l2_dv_timings *timings);
491 	int (*g_dv_timings)(struct v4l2_subdev *sd,
492 			struct v4l2_dv_timings *timings);
493 	int (*query_dv_timings)(struct v4l2_subdev *sd,
494 			struct v4l2_dv_timings *timings);
495 	int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
496 			   unsigned int *size);
497 	int (*pre_streamon)(struct v4l2_subdev *sd, u32 flags);
498 	int (*post_streamoff)(struct v4l2_subdev *sd);
499 };
500 
501 /**
502  * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
503  *				  in video mode via the vbi device node.
504  *
505  *  @decode_vbi_line: video decoders that support sliced VBI need to implement
506  *	this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the
507  *	start of the VBI data that was generated by the decoder. The driver
508  *	then parses the sliced VBI data and sets the other fields in the
509  *	struct accordingly. The pointer p is updated to point to the start of
510  *	the payload which can be copied verbatim into the data field of the
511  *	&struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the
512  *	type field is set to 0 on return.
513  *
514  * @s_vbi_data: used to generate VBI signals on a video signal.
515  *	&struct v4l2_sliced_vbi_data is filled with the data packets that
516  *	should be output. Note that if you set the line field to 0, then that
517  *	VBI signal is disabled. If no valid VBI data was found, then the type
518  *	field is set to 0 on return.
519  *
520  * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
521  *	Not all video decoders support this. If no data is available because
522  *	the readback register contains invalid or erroneous data %-EIO is
523  *	returned. Note that you must fill in the 'id' member and the 'field'
524  *	member (to determine whether CC data from the first or second field
525  *	should be obtained).
526  *
527  * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler
528  *		      code.
529  *
530  * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
531  *
532  * @g_sliced_fmt: retrieve the current sliced VBI settings.
533  *
534  * @s_sliced_fmt: setup the sliced VBI settings.
535  */
536 struct v4l2_subdev_vbi_ops {
537 	int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
538 	int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
539 	int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
540 	int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
541 	int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
542 	int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
543 	int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
544 };
545 
546 /**
547  * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
548  * @g_skip_top_lines: number of lines at the top of the image to be skipped.
549  *		      This is needed for some sensors, which always corrupt
550  *		      several top lines of the output image, or which send their
551  *		      metadata in them.
552  * @g_skip_frames: number of frames to skip at stream start. This is needed for
553  *		   buggy sensors that generate faulty frames when they are
554  *		   turned on.
555  */
556 struct v4l2_subdev_sensor_ops {
557 	int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
558 	int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
559 };
560 
561 /**
562  * enum v4l2_subdev_ir_mode- describes the type of IR supported
563  *
564  * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records
565  */
566 enum v4l2_subdev_ir_mode {
567 	V4L2_SUBDEV_IR_MODE_PULSE_WIDTH,
568 };
569 
570 /**
571  * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
572  *
573  * @bytes_per_data_element: bytes per data element of data in read or
574  *	write call.
575  * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode.
576  * @enable: device is active if true
577  * @interrupt_enable: IR interrupts are enabled if true
578  * @shutdown: if true: set hardware to low/no power, false: normal mode
579  *
580  * @modulation: if true, it uses carrier, if false: baseband
581  * @max_pulse_width:  maximum pulse width in ns, valid only for baseband signal
582  * @carrier_freq: carrier frequency in Hz, valid only for modulated signal
583  * @duty_cycle: duty cycle percentage, valid only for modulated signal
584  * @invert_level: invert signal level
585  *
586  * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX.
587  *
588  * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX.
589  * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated
590  *	signal. Used only for RX.
591  * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated
592  *	signal. Used only for RX.
593  * @resolution: The receive resolution, in ns . Used only for RX.
594  */
595 struct v4l2_subdev_ir_parameters {
596 	unsigned int bytes_per_data_element;
597 	enum v4l2_subdev_ir_mode mode;
598 
599 	bool enable;
600 	bool interrupt_enable;
601 	bool shutdown;
602 
603 	bool modulation;
604 	u32 max_pulse_width;
605 	unsigned int carrier_freq;
606 	unsigned int duty_cycle;
607 	bool invert_level;
608 
609 	/* Tx only */
610 	bool invert_carrier_sense;
611 
612 	/* Rx only */
613 	u32 noise_filter_min_width;
614 	unsigned int carrier_range_lower;
615 	unsigned int carrier_range_upper;
616 	u32 resolution;
617 };
618 
619 /**
620  * struct v4l2_subdev_ir_ops - operations for IR subdevices
621  *
622  * @rx_read: Reads received codes or pulse width data.
623  *	The semantics are similar to a non-blocking read() call.
624  * @rx_g_parameters: Get the current operating parameters and state of
625  *	the IR receiver.
626  * @rx_s_parameters: Set the current operating parameters and state of
627  *	the IR receiver.  It is recommended to call
628  *	[rt]x_g_parameters first to fill out the current state, and only change
629  *	the fields that need to be changed.  Upon return, the actual device
630  *	operating parameters and state will be returned.  Note that hardware
631  *	limitations may prevent the actual settings from matching the requested
632  *	settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
633  *	was requested.  An exception is when the shutdown parameter is true.
634  *	The last used operational parameters will be returned, but the actual
635  *	state of the hardware be different to minimize power consumption and
636  *	processing when shutdown is true.
637  *
638  * @tx_write: Writes codes or pulse width data for transmission.
639  *	The semantics are similar to a non-blocking write() call.
640  * @tx_g_parameters: Get the current operating parameters and state of
641  *	the IR transmitter.
642  * @tx_s_parameters: Set the current operating parameters and state of
643  *	the IR transmitter.  It is recommended to call
644  *	[rt]x_g_parameters first to fill out the current state, and only change
645  *	the fields that need to be changed.  Upon return, the actual device
646  *	operating parameters and state will be returned.  Note that hardware
647  *	limitations may prevent the actual settings from matching the requested
648  *	settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
649  *	was requested.  An exception is when the shutdown parameter is true.
650  *	The last used operational parameters will be returned, but the actual
651  *	state of the hardware be different to minimize power consumption and
652  *	processing when shutdown is true.
653  */
654 struct v4l2_subdev_ir_ops {
655 	/* Receiver */
656 	int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
657 				ssize_t *num);
658 
659 	int (*rx_g_parameters)(struct v4l2_subdev *sd,
660 				struct v4l2_subdev_ir_parameters *params);
661 	int (*rx_s_parameters)(struct v4l2_subdev *sd,
662 				struct v4l2_subdev_ir_parameters *params);
663 
664 	/* Transmitter */
665 	int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
666 				ssize_t *num);
667 
668 	int (*tx_g_parameters)(struct v4l2_subdev *sd,
669 				struct v4l2_subdev_ir_parameters *params);
670 	int (*tx_s_parameters)(struct v4l2_subdev *sd,
671 				struct v4l2_subdev_ir_parameters *params);
672 };
673 
674 /**
675  * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
676  *
677  * @try_fmt: &struct v4l2_mbus_framefmt
678  * @try_crop: &struct v4l2_rect to be used for crop
679  * @try_compose: &struct v4l2_rect to be used for compose
680  *
681  * This structure only needs to be passed to the pad op if the 'which' field
682  * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
683  * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
684  *
685  * Note: This struct is also used in active state, and the 'try' prefix is
686  * historical and to be removed.
687  */
688 struct v4l2_subdev_pad_config {
689 	struct v4l2_mbus_framefmt try_fmt;
690 	struct v4l2_rect try_crop;
691 	struct v4l2_rect try_compose;
692 };
693 
694 /**
695  * struct v4l2_subdev_state - Used for storing subdev state information.
696  *
697  * @_lock: default for 'lock'
698  * @lock: mutex for the state. May be replaced by the user.
699  * @pads: &struct v4l2_subdev_pad_config array
700  *
701  * This structure only needs to be passed to the pad op if the 'which' field
702  * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
703  * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
704  */
705 struct v4l2_subdev_state {
706 	/* lock for the struct v4l2_subdev_state fields */
707 	struct mutex _lock;
708 	struct mutex *lock;
709 	struct v4l2_subdev_pad_config *pads;
710 };
711 
712 /**
713  * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
714  *
715  * @init_cfg: initialize the pad config to default values
716  * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler
717  *		    code.
718  * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler
719  *		     code.
720  *
721  * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl
722  *			 handler code.
723  *
724  * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code.
725  *
726  * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code.
727  *
728  * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code.
729  *
730  * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code.
731  *
732  * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code.
733  *
734  * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code.
735  *
736  * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler
737  *		    code.
738  *
739  * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler
740  *		     code.
741  *
742  * @link_validate: used by the media controller code to check if the links
743  *		   that belongs to a pipeline can be used for stream.
744  *
745  * @get_frame_desc: get the current low level media bus frame parameters.
746  *
747  * @set_frame_desc: set the low level media bus frame parameters, @fd array
748  *                  may be adjusted by the subdev driver to device capabilities.
749  *
750  * @get_mbus_config: get the media bus configuration of a remote sub-device.
751  *		     The media bus configuration is usually retrieved from the
752  *		     firmware interface at sub-device probe time, immediately
753  *		     applied to the hardware and eventually adjusted by the
754  *		     driver. Remote sub-devices (usually video receivers) shall
755  *		     use this operation to query the transmitting end bus
756  *		     configuration in order to adjust their own one accordingly.
757  *		     Callers should make sure they get the most up-to-date as
758  *		     possible configuration from the remote end, likely calling
759  *		     this operation as close as possible to stream on time. The
760  *		     operation shall fail if the pad index it has been called on
761  *		     is not valid or in case of unrecoverable failures.
762  */
763 struct v4l2_subdev_pad_ops {
764 	int (*init_cfg)(struct v4l2_subdev *sd,
765 			struct v4l2_subdev_state *state);
766 	int (*enum_mbus_code)(struct v4l2_subdev *sd,
767 			      struct v4l2_subdev_state *state,
768 			      struct v4l2_subdev_mbus_code_enum *code);
769 	int (*enum_frame_size)(struct v4l2_subdev *sd,
770 			       struct v4l2_subdev_state *state,
771 			       struct v4l2_subdev_frame_size_enum *fse);
772 	int (*enum_frame_interval)(struct v4l2_subdev *sd,
773 				   struct v4l2_subdev_state *state,
774 				   struct v4l2_subdev_frame_interval_enum *fie);
775 	int (*get_fmt)(struct v4l2_subdev *sd,
776 		       struct v4l2_subdev_state *state,
777 		       struct v4l2_subdev_format *format);
778 	int (*set_fmt)(struct v4l2_subdev *sd,
779 		       struct v4l2_subdev_state *state,
780 		       struct v4l2_subdev_format *format);
781 	int (*get_selection)(struct v4l2_subdev *sd,
782 			     struct v4l2_subdev_state *state,
783 			     struct v4l2_subdev_selection *sel);
784 	int (*set_selection)(struct v4l2_subdev *sd,
785 			     struct v4l2_subdev_state *state,
786 			     struct v4l2_subdev_selection *sel);
787 	int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
788 	int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
789 	int (*dv_timings_cap)(struct v4l2_subdev *sd,
790 			      struct v4l2_dv_timings_cap *cap);
791 	int (*enum_dv_timings)(struct v4l2_subdev *sd,
792 			       struct v4l2_enum_dv_timings *timings);
793 #ifdef CONFIG_MEDIA_CONTROLLER
794 	int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
795 			     struct v4l2_subdev_format *source_fmt,
796 			     struct v4l2_subdev_format *sink_fmt);
797 #endif /* CONFIG_MEDIA_CONTROLLER */
798 	int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
799 			      struct v4l2_mbus_frame_desc *fd);
800 	int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
801 			      struct v4l2_mbus_frame_desc *fd);
802 	int (*get_mbus_config)(struct v4l2_subdev *sd, unsigned int pad,
803 			       struct v4l2_mbus_config *config);
804 };
805 
806 /**
807  * struct v4l2_subdev_ops - Subdev operations
808  *
809  * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL
810  * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL
811  * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL
812  * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL
813  * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL
814  * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL
815  * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL
816  * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL
817  */
818 struct v4l2_subdev_ops {
819 	const struct v4l2_subdev_core_ops	*core;
820 	const struct v4l2_subdev_tuner_ops	*tuner;
821 	const struct v4l2_subdev_audio_ops	*audio;
822 	const struct v4l2_subdev_video_ops	*video;
823 	const struct v4l2_subdev_vbi_ops	*vbi;
824 	const struct v4l2_subdev_ir_ops		*ir;
825 	const struct v4l2_subdev_sensor_ops	*sensor;
826 	const struct v4l2_subdev_pad_ops	*pad;
827 };
828 
829 /**
830  * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
831  *
832  * @registered: called when this subdev is registered. When called the v4l2_dev
833  *	field is set to the correct v4l2_device.
834  *
835  * @unregistered: called when this subdev is unregistered. When called the
836  *	v4l2_dev field is still set to the correct v4l2_device.
837  *
838  * @open: called when the subdev device node is opened by an application.
839  *
840  * @close: called when the subdev device node is closed. Please note that
841  *	it is possible for @close to be called after @unregistered!
842  *
843  * @release: called when the last user of the subdev device is gone. This
844  *	happens after the @unregistered callback and when the last open
845  *	filehandle to the v4l-subdevX device node was closed. If no device
846  *	node was created for this sub-device, then the @release callback
847  *	is called right after the @unregistered callback.
848  *	The @release callback is typically used to free the memory containing
849  *	the v4l2_subdev structure. It is almost certainly required for any
850  *	sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag.
851  *
852  * .. note::
853  *	Never call this from drivers, only the v4l2 framework can call
854  *	these ops.
855  */
856 struct v4l2_subdev_internal_ops {
857 	int (*registered)(struct v4l2_subdev *sd);
858 	void (*unregistered)(struct v4l2_subdev *sd);
859 	int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
860 	int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
861 	void (*release)(struct v4l2_subdev *sd);
862 };
863 
864 #define V4L2_SUBDEV_NAME_SIZE 32
865 
866 /* Set this flag if this subdev is a i2c device. */
867 #define V4L2_SUBDEV_FL_IS_I2C			(1U << 0)
868 /* Set this flag if this subdev is a spi device. */
869 #define V4L2_SUBDEV_FL_IS_SPI			(1U << 1)
870 /* Set this flag if this subdev needs a device node. */
871 #define V4L2_SUBDEV_FL_HAS_DEVNODE		(1U << 2)
872 /*
873  * Set this flag if this subdev generates events.
874  * Note controls can send events, thus drivers exposing controls
875  * should set this flag.
876  */
877 #define V4L2_SUBDEV_FL_HAS_EVENTS		(1U << 3)
878 
879 struct regulator_bulk_data;
880 
881 /**
882  * struct v4l2_subdev_platform_data - regulators config struct
883  *
884  * @regulators: Optional regulators used to power on/off the subdevice
885  * @num_regulators: Number of regululators
886  * @host_priv: Per-subdevice data, specific for a certain video host device
887  */
888 struct v4l2_subdev_platform_data {
889 	struct regulator_bulk_data *regulators;
890 	int num_regulators;
891 
892 	void *host_priv;
893 };
894 
895 /**
896  * struct v4l2_subdev - describes a V4L2 sub-device
897  *
898  * @entity: pointer to &struct media_entity
899  * @list: List of sub-devices
900  * @owner: The owner is the same as the driver's &struct device owner.
901  * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
902  *	owner. Initialized by v4l2_device_register_subdev().
903  * @flags: subdev flags. Can be:
904  *   %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
905  *   %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
906  *   %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
907  *   device node;
908  *   %V4L2_SUBDEV_FL_HAS_EVENTS -  Set this flag if this subdev generates
909  *   events.
910  *
911  * @v4l2_dev: pointer to struct &v4l2_device
912  * @ops: pointer to struct &v4l2_subdev_ops
913  * @internal_ops: pointer to struct &v4l2_subdev_internal_ops.
914  *	Never call these internal ops from within a driver!
915  * @ctrl_handler: The control handler of this subdev. May be NULL.
916  * @name: Name of the sub-device. Please notice that the name must be unique.
917  * @grp_id: can be used to group similar subdevs. Value is driver-specific
918  * @dev_priv: pointer to private data
919  * @host_priv: pointer to private data used by the device where the subdev
920  *	is attached.
921  * @devnode: subdev device node
922  * @dev: pointer to the physical device, if any
923  * @fwnode: The fwnode_handle of the subdev, usually the same as
924  *	    either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
925  * @async_list: Links this subdev to a global subdev_list or @notifier->done
926  *	list.
927  * @asd: Pointer to respective &struct v4l2_async_subdev.
928  * @notifier: Pointer to the managing notifier.
929  * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
930  *		     device using v4l2_async_register_subdev_sensor().
931  * @pdata: common part of subdevice platform data
932  * @state_lock: A pointer to a lock used for all the subdev's states, set by the
933  *		driver. This is	optional. If NULL, each state instance will get
934  *		a lock of its own.
935  * @active_state: Active state for the subdev (NULL for subdevs tracking the
936  *		  state internally). Initialized by calling
937  *		  v4l2_subdev_init_finalize().
938  *
939  * Each instance of a subdev driver should create this struct, either
940  * stand-alone or embedded in a larger struct.
941  *
942  * This structure should be initialized by v4l2_subdev_init() or one of
943  * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init().
944  */
945 struct v4l2_subdev {
946 #if defined(CONFIG_MEDIA_CONTROLLER)
947 	struct media_entity entity;
948 #endif
949 	struct list_head list;
950 	struct module *owner;
951 	bool owner_v4l2_dev;
952 	u32 flags;
953 	struct v4l2_device *v4l2_dev;
954 	const struct v4l2_subdev_ops *ops;
955 	const struct v4l2_subdev_internal_ops *internal_ops;
956 	struct v4l2_ctrl_handler *ctrl_handler;
957 	char name[V4L2_SUBDEV_NAME_SIZE];
958 	u32 grp_id;
959 	void *dev_priv;
960 	void *host_priv;
961 	struct video_device *devnode;
962 	struct device *dev;
963 	struct fwnode_handle *fwnode;
964 	struct list_head async_list;
965 	struct v4l2_async_subdev *asd;
966 	struct v4l2_async_notifier *notifier;
967 	struct v4l2_async_notifier *subdev_notifier;
968 	struct v4l2_subdev_platform_data *pdata;
969 	struct mutex *state_lock;
970 
971 	/*
972 	 * The fields below are private, and should only be accessed via
973 	 * appropriate functions.
974 	 */
975 
976 	/*
977 	 * TODO: active_state should most likely be changed from a pointer to an
978 	 * embedded field. For the time being it's kept as a pointer to more
979 	 * easily catch uses of active_state in the cases where the driver
980 	 * doesn't support it.
981 	 */
982 	struct v4l2_subdev_state *active_state;
983 };
984 
985 
986 /**
987  * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
988  *    the &struct media_entity embedded in it.
989  *
990  * @ent: pointer to &struct media_entity.
991  */
992 #define media_entity_to_v4l2_subdev(ent)				\
993 ({									\
994 	typeof(ent) __me_sd_ent = (ent);				\
995 									\
996 	__me_sd_ent ?							\
997 		container_of(__me_sd_ent, struct v4l2_subdev, entity) :	\
998 		NULL;							\
999 })
1000 
1001 /**
1002  * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1003  *	the &struct video_device embedded on it.
1004  *
1005  * @vdev: pointer to &struct video_device
1006  */
1007 #define vdev_to_v4l2_subdev(vdev) \
1008 	((struct v4l2_subdev *)video_get_drvdata(vdev))
1009 
1010 /**
1011  * struct v4l2_subdev_fh - Used for storing subdev information per file handle
1012  *
1013  * @vfh: pointer to &struct v4l2_fh
1014  * @state: pointer to &struct v4l2_subdev_state
1015  * @owner: module pointer to the owner of this file handle
1016  */
1017 struct v4l2_subdev_fh {
1018 	struct v4l2_fh vfh;
1019 	struct module *owner;
1020 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
1021 	struct v4l2_subdev_state *state;
1022 #endif
1023 };
1024 
1025 /**
1026  * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
1027  *	the &struct v4l2_fh embedded on it.
1028  *
1029  * @fh: pointer to &struct v4l2_fh
1030  */
1031 #define to_v4l2_subdev_fh(fh)	\
1032 	container_of(fh, struct v4l2_subdev_fh, vfh)
1033 
1034 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
1035 
1036 /**
1037  * v4l2_subdev_get_pad_format - ancillary routine to call
1038  *	&struct v4l2_subdev_pad_config->try_fmt
1039  *
1040  * @sd: pointer to &struct v4l2_subdev
1041  * @state: pointer to &struct v4l2_subdev_state
1042  * @pad: index of the pad in the &struct v4l2_subdev_state->pads array
1043  */
1044 static inline struct v4l2_mbus_framefmt *
v4l2_subdev_get_pad_format(struct v4l2_subdev * sd,struct v4l2_subdev_state * state,unsigned int pad)1045 v4l2_subdev_get_pad_format(struct v4l2_subdev *sd,
1046 			   struct v4l2_subdev_state *state,
1047 			   unsigned int pad)
1048 {
1049 	if (WARN_ON(pad >= sd->entity.num_pads))
1050 		pad = 0;
1051 	return &state->pads[pad].try_fmt;
1052 }
1053 
1054 /**
1055  * v4l2_subdev_get_pad_crop - ancillary routine to call
1056  *	&struct v4l2_subdev_pad_config->try_crop
1057  *
1058  * @sd: pointer to &struct v4l2_subdev
1059  * @state: pointer to &struct v4l2_subdev_state.
1060  * @pad: index of the pad in the &struct v4l2_subdev_state->pads array.
1061  */
1062 static inline struct v4l2_rect *
v4l2_subdev_get_pad_crop(struct v4l2_subdev * sd,struct v4l2_subdev_state * state,unsigned int pad)1063 v4l2_subdev_get_pad_crop(struct v4l2_subdev *sd,
1064 			 struct v4l2_subdev_state *state,
1065 			 unsigned int pad)
1066 {
1067 	if (WARN_ON(pad >= sd->entity.num_pads))
1068 		pad = 0;
1069 	return &state->pads[pad].try_crop;
1070 }
1071 
1072 /**
1073  * v4l2_subdev_get_pad_compose - ancillary routine to call
1074  *	&struct v4l2_subdev_pad_config->try_compose
1075  *
1076  * @sd: pointer to &struct v4l2_subdev
1077  * @state: pointer to &struct v4l2_subdev_state.
1078  * @pad: index of the pad in the &struct v4l2_subdev_state->pads array.
1079  */
1080 static inline struct v4l2_rect *
v4l2_subdev_get_pad_compose(struct v4l2_subdev * sd,struct v4l2_subdev_state * state,unsigned int pad)1081 v4l2_subdev_get_pad_compose(struct v4l2_subdev *sd,
1082 			    struct v4l2_subdev_state *state,
1083 			    unsigned int pad)
1084 {
1085 	if (WARN_ON(pad >= sd->entity.num_pads))
1086 		pad = 0;
1087 	return &state->pads[pad].try_compose;
1088 }
1089 
1090 /*
1091  * Temprary helpers until uses of v4l2_subdev_get_try_* functions have been
1092  * renamed
1093  */
1094 #define v4l2_subdev_get_try_format(sd, state, pad) \
1095 	v4l2_subdev_get_pad_format(sd, state, pad)
1096 
1097 #define v4l2_subdev_get_try_crop(sd, state, pad) \
1098 	v4l2_subdev_get_pad_crop(sd, state, pad)
1099 
1100 #define v4l2_subdev_get_try_compose(sd, state, pad) \
1101 	v4l2_subdev_get_pad_compose(sd, state, pad)
1102 
1103 #endif /* CONFIG_VIDEO_V4L2_SUBDEV_API */
1104 
1105 extern const struct v4l2_file_operations v4l2_subdev_fops;
1106 
1107 /**
1108  * v4l2_set_subdevdata - Sets V4L2 dev private device data
1109  *
1110  * @sd: pointer to &struct v4l2_subdev
1111  * @p: pointer to the private device data to be stored.
1112  */
v4l2_set_subdevdata(struct v4l2_subdev * sd,void * p)1113 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
1114 {
1115 	sd->dev_priv = p;
1116 }
1117 
1118 /**
1119  * v4l2_get_subdevdata - Gets V4L2 dev private device data
1120  *
1121  * @sd: pointer to &struct v4l2_subdev
1122  *
1123  * Returns the pointer to the private device data to be stored.
1124  */
v4l2_get_subdevdata(const struct v4l2_subdev * sd)1125 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
1126 {
1127 	return sd->dev_priv;
1128 }
1129 
1130 /**
1131  * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1132  *
1133  * @sd: pointer to &struct v4l2_subdev
1134  * @p: pointer to the private data to be stored.
1135  */
v4l2_set_subdev_hostdata(struct v4l2_subdev * sd,void * p)1136 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
1137 {
1138 	sd->host_priv = p;
1139 }
1140 
1141 /**
1142  * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1143  *
1144  * @sd: pointer to &struct v4l2_subdev
1145  *
1146  * Returns the pointer to the private host data to be stored.
1147  */
v4l2_get_subdev_hostdata(const struct v4l2_subdev * sd)1148 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
1149 {
1150 	return sd->host_priv;
1151 }
1152 
1153 #ifdef CONFIG_MEDIA_CONTROLLER
1154 
1155 /**
1156  * v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode
1157  *                                     endpoint, assuming 1:1 port:pad
1158  *
1159  * @entity: Pointer to the subdev entity
1160  * @endpoint: Pointer to a parsed fwnode endpoint
1161  *
1162  * This function can be used as the .get_fwnode_pad operation for
1163  * subdevices that map port numbers and pad indexes 1:1. If the endpoint
1164  * is owned by the subdevice, the function returns the endpoint port
1165  * number.
1166  *
1167  * Returns the endpoint port number on success or a negative error code.
1168  */
1169 int v4l2_subdev_get_fwnode_pad_1_to_1(struct media_entity *entity,
1170 				      struct fwnode_endpoint *endpoint);
1171 
1172 /**
1173  * v4l2_subdev_link_validate_default - validates a media link
1174  *
1175  * @sd: pointer to &struct v4l2_subdev
1176  * @link: pointer to &struct media_link
1177  * @source_fmt: pointer to &struct v4l2_subdev_format
1178  * @sink_fmt: pointer to &struct v4l2_subdev_format
1179  *
1180  * This function ensures that width, height and the media bus pixel
1181  * code are equal on both source and sink of the link.
1182  */
1183 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
1184 				      struct media_link *link,
1185 				      struct v4l2_subdev_format *source_fmt,
1186 				      struct v4l2_subdev_format *sink_fmt);
1187 
1188 /**
1189  * v4l2_subdev_link_validate - validates a media link
1190  *
1191  * @link: pointer to &struct media_link
1192  *
1193  * This function calls the subdev's link_validate ops to validate
1194  * if a media link is valid for streaming. It also internally
1195  * calls v4l2_subdev_link_validate_default() to ensure that
1196  * width, height and the media bus pixel code are equal on both
1197  * source and sink of the link.
1198  */
1199 int v4l2_subdev_link_validate(struct media_link *link);
1200 
1201 /**
1202  * __v4l2_subdev_state_alloc - allocate v4l2_subdev_state
1203  *
1204  * @sd: pointer to &struct v4l2_subdev for which the state is being allocated.
1205  * @lock_name: name of the state lock
1206  * @key: lock_class_key for the lock
1207  *
1208  * Must call __v4l2_subdev_state_free() when state is no longer needed.
1209  *
1210  * Not to be called directly by the drivers.
1211  */
1212 struct v4l2_subdev_state *__v4l2_subdev_state_alloc(struct v4l2_subdev *sd,
1213 						    const char *lock_name,
1214 						    struct lock_class_key *key);
1215 
1216 /**
1217  * __v4l2_subdev_state_free - free a v4l2_subdev_state
1218  *
1219  * @state: v4l2_subdev_state to be freed.
1220  *
1221  * Not to be called directly by the drivers.
1222  */
1223 void __v4l2_subdev_state_free(struct v4l2_subdev_state *state);
1224 
1225 /**
1226  * v4l2_subdev_init_finalize() - Finalizes the initialization of the subdevice
1227  * @sd: The subdev
1228  *
1229  * This function finalizes the initialization of the subdev, including
1230  * allocation of the active state for the subdev.
1231  *
1232  * This function must be called by the subdev drivers that use the centralized
1233  * active state, after the subdev struct has been initialized and
1234  * media_entity_pads_init() has been called, but before registering the
1235  * subdev.
1236  *
1237  * The user must call v4l2_subdev_cleanup() when the subdev is being removed.
1238  */
1239 #define v4l2_subdev_init_finalize(sd)                                          \
1240 	({                                                                     \
1241 		static struct lock_class_key __key;                            \
1242 		const char *name = KBUILD_BASENAME                             \
1243 			":" __stringify(__LINE__) ":sd->active_state->lock";   \
1244 		__v4l2_subdev_init_finalize(sd, name, &__key);                 \
1245 	})
1246 
1247 int __v4l2_subdev_init_finalize(struct v4l2_subdev *sd, const char *name,
1248 				struct lock_class_key *key);
1249 
1250 /**
1251  * v4l2_subdev_cleanup() - Releases the resources allocated by the subdevice
1252  * @sd: The subdevice
1253  *
1254  * This function will release the resources allocated in
1255  * v4l2_subdev_init_finalize.
1256  */
1257 void v4l2_subdev_cleanup(struct v4l2_subdev *sd);
1258 
1259 /**
1260  * v4l2_subdev_lock_state() - Locks the subdev state
1261  * @state: The subdevice state
1262  *
1263  * Locks the given subdev state.
1264  *
1265  * The state must be unlocked with v4l2_subdev_unlock_state() after use.
1266  */
v4l2_subdev_lock_state(struct v4l2_subdev_state * state)1267 static inline void v4l2_subdev_lock_state(struct v4l2_subdev_state *state)
1268 {
1269 	mutex_lock(state->lock);
1270 }
1271 
1272 /**
1273  * v4l2_subdev_unlock_state() - Unlocks the subdev state
1274  * @state: The subdevice state
1275  *
1276  * Unlocks the given subdev state.
1277  */
v4l2_subdev_unlock_state(struct v4l2_subdev_state * state)1278 static inline void v4l2_subdev_unlock_state(struct v4l2_subdev_state *state)
1279 {
1280 	mutex_unlock(state->lock);
1281 }
1282 
1283 /**
1284  * v4l2_subdev_get_unlocked_active_state() - Checks that the active subdev state
1285  *					     is unlocked and returns it
1286  * @sd: The subdevice
1287  *
1288  * Returns the active state for the subdevice, or NULL if the subdev does not
1289  * support active state. If the state is not NULL, calls
1290  * lockdep_assert_not_held() to issue a warning if the state is locked.
1291  *
1292  * This function is to be used e.g. when getting the active state for the sole
1293  * purpose of passing it forward, without accessing the state fields.
1294  */
1295 static inline struct v4l2_subdev_state *
v4l2_subdev_get_unlocked_active_state(struct v4l2_subdev * sd)1296 v4l2_subdev_get_unlocked_active_state(struct v4l2_subdev *sd)
1297 {
1298 	if (sd->active_state)
1299 		lockdep_assert_not_held(sd->active_state->lock);
1300 	return sd->active_state;
1301 }
1302 
1303 /**
1304  * v4l2_subdev_get_locked_active_state() - Checks that the active subdev state
1305  *					   is locked and returns it
1306  *
1307  * @sd: The subdevice
1308  *
1309  * Returns the active state for the subdevice, or NULL if the subdev does not
1310  * support active state. If the state is not NULL, calls lockdep_assert_held()
1311  * to issue a warning if the state is not locked.
1312  *
1313  * This function is to be used when the caller knows that the active state is
1314  * already locked.
1315  */
1316 static inline struct v4l2_subdev_state *
v4l2_subdev_get_locked_active_state(struct v4l2_subdev * sd)1317 v4l2_subdev_get_locked_active_state(struct v4l2_subdev *sd)
1318 {
1319 	if (sd->active_state)
1320 		lockdep_assert_held(sd->active_state->lock);
1321 	return sd->active_state;
1322 }
1323 
1324 /**
1325  * v4l2_subdev_lock_and_get_active_state() - Locks and returns the active subdev
1326  *					     state for the subdevice
1327  * @sd: The subdevice
1328  *
1329  * Returns the locked active state for the subdevice, or NULL if the subdev
1330  * does not support active state.
1331  *
1332  * The state must be unlocked with v4l2_subdev_unlock_state() after use.
1333  */
1334 static inline struct v4l2_subdev_state *
v4l2_subdev_lock_and_get_active_state(struct v4l2_subdev * sd)1335 v4l2_subdev_lock_and_get_active_state(struct v4l2_subdev *sd)
1336 {
1337 	if (sd->active_state)
1338 		v4l2_subdev_lock_state(sd->active_state);
1339 	return sd->active_state;
1340 }
1341 
1342 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
1343 
1344 /**
1345  * v4l2_subdev_get_fmt() - Fill format based on state
1346  * @sd: subdevice
1347  * @state: subdevice state
1348  * @format: pointer to &struct v4l2_subdev_format
1349  *
1350  * Fill @format->format field based on the information in the @format struct.
1351  *
1352  * This function can be used by the subdev drivers which support active state to
1353  * implement v4l2_subdev_pad_ops.get_fmt if the subdev driver does not need to
1354  * do anything special in their get_fmt op.
1355  *
1356  * Returns 0 on success, error value otherwise.
1357  */
1358 int v4l2_subdev_get_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_state *state,
1359 			struct v4l2_subdev_format *format);
1360 
1361 #endif /* CONFIG_VIDEO_V4L2_SUBDEV_API */
1362 
1363 #endif /* CONFIG_MEDIA_CONTROLLER */
1364 
1365 /**
1366  * v4l2_subdev_init - initializes the sub-device struct
1367  *
1368  * @sd: pointer to the &struct v4l2_subdev to be initialized
1369  * @ops: pointer to &struct v4l2_subdev_ops.
1370  */
1371 void v4l2_subdev_init(struct v4l2_subdev *sd,
1372 		      const struct v4l2_subdev_ops *ops);
1373 
1374 extern const struct v4l2_subdev_ops v4l2_subdev_call_wrappers;
1375 
1376 /**
1377  * v4l2_subdev_call - call an operation of a v4l2_subdev.
1378  *
1379  * @sd: pointer to the &struct v4l2_subdev
1380  * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1381  *     Each element there groups a set of callbacks functions.
1382  * @f: callback function to be called.
1383  *     The callback functions are defined in groups, according to
1384  *     each element at &struct v4l2_subdev_ops.
1385  * @args: arguments for @f.
1386  *
1387  * Example: err = v4l2_subdev_call(sd, video, s_std, norm);
1388  */
1389 #define v4l2_subdev_call(sd, o, f, args...)				\
1390 	({								\
1391 		struct v4l2_subdev *__sd = (sd);			\
1392 		int __result;						\
1393 		if (!__sd)						\
1394 			__result = -ENODEV;				\
1395 		else if (!(__sd->ops->o && __sd->ops->o->f))		\
1396 			__result = -ENOIOCTLCMD;			\
1397 		else if (v4l2_subdev_call_wrappers.o &&			\
1398 			 v4l2_subdev_call_wrappers.o->f)		\
1399 			__result = v4l2_subdev_call_wrappers.o->f(	\
1400 							__sd, ##args);	\
1401 		else							\
1402 			__result = __sd->ops->o->f(__sd, ##args);	\
1403 		__result;						\
1404 	})
1405 
1406 /**
1407  * v4l2_subdev_call_state_active - call an operation of a v4l2_subdev which
1408  *				   takes state as a parameter, passing the
1409  *				   subdev its active state.
1410  *
1411  * @sd: pointer to the &struct v4l2_subdev
1412  * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1413  *     Each element there groups a set of callbacks functions.
1414  * @f: callback function to be called.
1415  *     The callback functions are defined in groups, according to
1416  *     each element at &struct v4l2_subdev_ops.
1417  * @args: arguments for @f.
1418  *
1419  * This is similar to v4l2_subdev_call(), except that this version can only be
1420  * used for ops that take a subdev state as a parameter. The macro will get the
1421  * active state, lock it before calling the op and unlock it after the call.
1422  */
1423 #define v4l2_subdev_call_state_active(sd, o, f, args...)		\
1424 	({								\
1425 		int __result;						\
1426 		struct v4l2_subdev_state *state;			\
1427 		state = v4l2_subdev_get_unlocked_active_state(sd);	\
1428 		if (state)						\
1429 			v4l2_subdev_lock_state(state);			\
1430 		__result = v4l2_subdev_call(sd, o, f, state, ##args);	\
1431 		if (state)						\
1432 			v4l2_subdev_unlock_state(state);		\
1433 		__result;						\
1434 	})
1435 
1436 /**
1437  * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1438  *
1439  * @sd: pointer to the &struct v4l2_subdev
1440  * @o: The group of callback functions in &struct v4l2_subdev_ops
1441  * which @f is a part of.
1442  * @f: callback function to be checked for its existence.
1443  */
1444 #define v4l2_subdev_has_op(sd, o, f) \
1445 	((sd)->ops->o && (sd)->ops->o->f)
1446 
1447 /**
1448  * v4l2_subdev_notify_event() - Delivers event notification for subdevice
1449  * @sd: The subdev for which to deliver the event
1450  * @ev: The event to deliver
1451  *
1452  * Will deliver the specified event to all userspace event listeners which are
1453  * subscribed to the v42l subdev event queue as well as to the bridge driver
1454  * using the notify callback. The notification type for the notify callback
1455  * will be %V4L2_DEVICE_NOTIFY_EVENT.
1456  */
1457 void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
1458 			      const struct v4l2_event *ev);
1459 
1460 #endif /* _V4L2_SUBDEV_H */
1461