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	* The caller shall track the subdev state, and shall not start or stop an
450	* already started or stopped subdev. Also see call_s_stream wrapper in
451	* v4l2-subdev.c.
452	*
453	* This callback is DEPRECATED. New drivers should instead implement
454	* &v4l2_subdev_pad_ops.enable_streams and
455	* &v4l2_subdev_pad_ops.disable_streams operations, and use
456	* v4l2_subdev_s_stream_helper for the &v4l2_subdev_video_ops.s_stream
457	* operation to support legacy users.
458	*
459	* Drivers should also not call the .s_stream() subdev operation directly,
460	* but use the v4l2_subdev_enable_streams() and
461	* v4l2_subdev_disable_streams() helpers.
462	*
463	* @g_pixelaspect: callback to return the pixelaspect ratio.
464	*
465	* @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
466	* can adjust @size to a lower value and must not write more data to the
467	* buffer starting at @data than the original value of @size.
468	*
469	* @pre_streamon: May be called before streaming is actually started, to help
470	* initialising the bus. Current usage is to set a CSI-2 transmitter to
471	* LP-11 or LP-111 mode before streaming. See &enum
472	* v4l2_subdev_pre_streamon_flags.
473	*
474	* pre_streamon shall return error if it cannot perform the operation as
475	* indicated by the flags argument. In particular, -EACCES indicates lack
476	* of support for the operation. The caller shall call post_streamoff for
477	* each successful call of pre_streamon.
478	*
479	* @post_streamoff: Called after streaming is stopped, but if and only if
480	* pre_streamon was called earlier.
481	*/
482	struct v4l2_subdev_video_ops {
483	int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
484	int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
485	int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
486	int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
487	int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
488	int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
489	int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
490	int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
491	int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
492	int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
493	int (*s_stream)(struct v4l2_subdev *sd, int enable);
494	int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect);
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	* @format: &struct v4l2_mbus_framefmt
678	* @crop: &struct v4l2_rect to be used for crop
679	* @compose: &struct v4l2_rect to be used for compose
680	* @interval: frame interval
681	*/
682	struct v4l2_subdev_pad_config {
683	struct v4l2_mbus_framefmt format;
684	struct v4l2_rect crop;
685	struct v4l2_rect compose;
686	struct v4l2_fract interval;
687	};
688
689	/**
690	* struct v4l2_subdev_stream_config - Used for storing stream configuration.
691	*
692	* @pad: pad number
693	* @stream: stream number
694	* @enabled: has the stream been enabled with v4l2_subdev_enable_streams()
695	* @fmt: &struct v4l2_mbus_framefmt
696	* @crop: &struct v4l2_rect to be used for crop
697	* @compose: &struct v4l2_rect to be used for compose
698	* @interval: frame interval
699	*
700	* This structure stores configuration for a stream.
701	*/
702	struct v4l2_subdev_stream_config {
703	u32 pad;
704	u32 stream;
705	bool enabled;
706
707	struct v4l2_mbus_framefmt fmt;
708	struct v4l2_rect crop;
709	struct v4l2_rect compose;
710	struct v4l2_fract interval;
711	};
712
713	/**
714	* struct v4l2_subdev_stream_configs - A collection of stream configs.
715	*
716	* @num_configs: number of entries in @config.
717	* @configs: an array of &struct v4l2_subdev_stream_configs.
718	*/
719	struct v4l2_subdev_stream_configs {
720	u32 num_configs;
721	struct v4l2_subdev_stream_config *configs;
722	};
723
724	/**
725	* struct v4l2_subdev_krouting - subdev routing table
726	*
727	* @len_routes: length of routes array, in routes
728	* @num_routes: number of routes
729	* @routes: &struct v4l2_subdev_route
730	*
731	* This structure contains the routing table for a subdev.
732	*/
733	struct v4l2_subdev_krouting {
734	unsigned int len_routes;
735	unsigned int num_routes;
736	struct v4l2_subdev_route *routes;
737	};
738
739	/**
740	* struct v4l2_subdev_state - Used for storing subdev state information.
741	*
742	* @_lock: default for 'lock'
743	* @lock: mutex for the state. May be replaced by the user.
744	* @sd: the sub-device which the state is related to
745	* @pads: &struct v4l2_subdev_pad_config array
746	* @routing: routing table for the subdev
747	* @stream_configs: stream configurations (only for V4L2_SUBDEV_FL_STREAMS)
748	*
749	* This structure only needs to be passed to the pad op if the 'which' field
750	* of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
751	* %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
752	*/
753	struct v4l2_subdev_state {
754	/* lock for the struct v4l2_subdev_state fields */
755	struct mutex _lock;
756	struct mutex *lock;
757	struct v4l2_subdev *sd;
758	struct v4l2_subdev_pad_config *pads;
759	struct v4l2_subdev_krouting routing;
760	struct v4l2_subdev_stream_configs stream_configs;
761	};
762
763	/**
764	* struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
765	*
766	* @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler
767	* code.
768	* @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler
769	* code.
770	*
771	* @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl
772	* handler code.
773	*
774	* @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code.
775	*
776	* @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code.
777	*
778	* @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code.
779	*
780	* @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code.
781	*
782	* @get_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL()
783	* ioctl handler code.
784	*
785	* @set_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL()
786	* ioctl handler code.
787	*
788	* @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code.
789	*
790	* @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code.
791	*
792	* @s_dv_timings: Set custom dv timings in the sub device. This is used
793	* when sub device is capable of setting detailed timing information
794	* in the hardware to generate/detect the video signal.
795	*
796	* @g_dv_timings: Get custom dv timings in the sub device.
797	*
798	* @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code.
799	*
800	* @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler
801	* code.
802	*
803	* @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler
804	* code.
805	*
806	* @link_validate: used by the media controller code to check if the links
807	* that belongs to a pipeline can be used for stream.
808	*
809	* @get_frame_desc: get the current low level media bus frame parameters.
810	*
811	* @set_frame_desc: set the low level media bus frame parameters, @fd array
812	* may be adjusted by the subdev driver to device capabilities.
813	*
814	* @get_mbus_config: get the media bus configuration of a remote sub-device.
815	* The media bus configuration is usually retrieved from the
816	* firmware interface at sub-device probe time, immediately
817	* applied to the hardware and eventually adjusted by the
818	* driver. Remote sub-devices (usually video receivers) shall
819	* use this operation to query the transmitting end bus
820	* configuration in order to adjust their own one accordingly.
821	* Callers should make sure they get the most up-to-date as
822	* possible configuration from the remote end, likely calling
823	* this operation as close as possible to stream on time. The
824	* operation shall fail if the pad index it has been called on
825	* is not valid or in case of unrecoverable failures. The
826	* config argument has been memset to 0 just before calling
827	* the op.
828	*
829	* @set_routing: Enable or disable data connection routes described in the
830	* subdevice routing table. Subdevs that implement this operation
831	* must set the V4L2_SUBDEV_FL_STREAMS flag.
832	*
833	* @enable_streams: Enable the streams defined in streams_mask on the given
834	* source pad. Subdevs that implement this operation must use the active
835	* state management provided by the subdev core (enabled through a call to
836	* v4l2_subdev_init_finalize() at initialization time). Do not call
837	* directly, use v4l2_subdev_enable_streams() instead.
838	*
839	* Drivers that support only a single stream without setting the
840	* V4L2_SUBDEV_CAP_STREAMS sub-device capability flag can ignore the mask
841	* argument.
842	*
843	* @disable_streams: Disable the streams defined in streams_mask on the given
844	* source pad. Subdevs that implement this operation must use the active
845	* state management provided by the subdev core (enabled through a call to
846	* v4l2_subdev_init_finalize() at initialization time). Do not call
847	* directly, use v4l2_subdev_disable_streams() instead.
848	*
849	* Drivers that support only a single stream without setting the
850	* V4L2_SUBDEV_CAP_STREAMS sub-device capability flag can ignore the mask
851	* argument.
852	*/
853	struct v4l2_subdev_pad_ops {
854	int (*enum_mbus_code)(struct v4l2_subdev *sd,
855	struct v4l2_subdev_state *state,
856	struct v4l2_subdev_mbus_code_enum *code);
857	int (*enum_frame_size)(struct v4l2_subdev *sd,
858	struct v4l2_subdev_state *state,
859	struct v4l2_subdev_frame_size_enum *fse);
860	int (*enum_frame_interval)(struct v4l2_subdev *sd,
861	struct v4l2_subdev_state *state,
862	struct v4l2_subdev_frame_interval_enum *fie);
863	int (*get_fmt)(struct v4l2_subdev *sd,
864	struct v4l2_subdev_state *state,
865	struct v4l2_subdev_format *format);
866	int (*set_fmt)(struct v4l2_subdev *sd,
867	struct v4l2_subdev_state *state,
868	struct v4l2_subdev_format *format);
869	int (*get_selection)(struct v4l2_subdev *sd,
870	struct v4l2_subdev_state *state,
871	struct v4l2_subdev_selection *sel);
872	int (*set_selection)(struct v4l2_subdev *sd,
873	struct v4l2_subdev_state *state,
874	struct v4l2_subdev_selection *sel);
875	int (*get_frame_interval)(struct v4l2_subdev *sd,
876	struct v4l2_subdev_state *state,
877	struct v4l2_subdev_frame_interval *interval);
878	int (*set_frame_interval)(struct v4l2_subdev *sd,
879	struct v4l2_subdev_state *state,
880	struct v4l2_subdev_frame_interval *interval);
881	int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
882	int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
883	int (*s_dv_timings)(struct v4l2_subdev *sd, unsigned int pad,
884	struct v4l2_dv_timings *timings);
885	int (*g_dv_timings)(struct v4l2_subdev *sd, unsigned int pad,
886	struct v4l2_dv_timings *timings);
887	int (*query_dv_timings)(struct v4l2_subdev *sd, unsigned int pad,
888	struct v4l2_dv_timings *timings);
889	int (*dv_timings_cap)(struct v4l2_subdev *sd,
890	struct v4l2_dv_timings_cap *cap);
891	int (*enum_dv_timings)(struct v4l2_subdev *sd,
892	struct v4l2_enum_dv_timings *timings);
893	#ifdef CONFIG_MEDIA_CONTROLLER
894	int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
895	struct v4l2_subdev_format *source_fmt,
896	struct v4l2_subdev_format *sink_fmt);
897	#endif /* CONFIG_MEDIA_CONTROLLER */
898	int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
899	struct v4l2_mbus_frame_desc *fd);
900	int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
901	struct v4l2_mbus_frame_desc *fd);
902	int (*get_mbus_config)(struct v4l2_subdev *sd, unsigned int pad,
903	struct v4l2_mbus_config *config);
904	int (*set_routing)(struct v4l2_subdev *sd,
905	struct v4l2_subdev_state *state,
906	enum v4l2_subdev_format_whence which,
907	struct v4l2_subdev_krouting *route);
908	int (*enable_streams)(struct v4l2_subdev *sd,
909	struct v4l2_subdev_state *state, u32 pad,
910	u64 streams_mask);
911	int (*disable_streams)(struct v4l2_subdev *sd,
912	struct v4l2_subdev_state *state, u32 pad,
913	u64 streams_mask);
914	};
915
916	/**
917	* struct v4l2_subdev_ops - Subdev operations
918	*
919	* @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL
920	* @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL
921	* @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL
922	* @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL
923	* @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL
924	* @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL
925	* @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL
926	* @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL
927	*/
928	struct v4l2_subdev_ops {
929	const struct v4l2_subdev_core_ops *core;
930	const struct v4l2_subdev_tuner_ops *tuner;
931	const struct v4l2_subdev_audio_ops *audio;
932	const struct v4l2_subdev_video_ops *video;
933	const struct v4l2_subdev_vbi_ops *vbi;
934	const struct v4l2_subdev_ir_ops *ir;
935	const struct v4l2_subdev_sensor_ops *sensor;
936	const struct v4l2_subdev_pad_ops *pad;
937	};
938
939	/**
940	* struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
941	*
942	* @init_state: initialize the subdev state to default values
943	*
944	* @registered: called when this subdev is registered. When called the v4l2_dev
945	* field is set to the correct v4l2_device.
946	*
947	* @unregistered: called when this subdev is unregistered. When called the
948	* v4l2_dev field is still set to the correct v4l2_device.
949	*
950	* @open: called when the subdev device node is opened by an application.
951	*
952	* @close: called when the subdev device node is closed. Please note that
953	* it is possible for @close to be called after @unregistered!
954	*
955	* @release: called when the last user of the subdev device is gone. This
956	* happens after the @unregistered callback and when the last open
957	* filehandle to the v4l-subdevX device node was closed. If no device
958	* node was created for this sub-device, then the @release callback
959	* is called right after the @unregistered callback.
960	* The @release callback is typically used to free the memory containing
961	* the v4l2_subdev structure. It is almost certainly required for any
962	* sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag.
963	*
964	* .. note::
965	* Never call this from drivers, only the v4l2 framework can call
966	* these ops.
967	*/
968	struct v4l2_subdev_internal_ops {
969	int (*init_state)(struct v4l2_subdev *sd,
970	struct v4l2_subdev_state *state);
971	int (*registered)(struct v4l2_subdev *sd);
972	void (*unregistered)(struct v4l2_subdev *sd);
973	int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
974	int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
975	void (*release)(struct v4l2_subdev *sd);
976	};
977
978	/* Set this flag if this subdev is a i2c device. */
979	#define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
980	/* Set this flag if this subdev is a spi device. */
981	#define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
982	/* Set this flag if this subdev needs a device node. */
983	#define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
984	/*
985	* Set this flag if this subdev generates events.
986	* Note controls can send events, thus drivers exposing controls
987	* should set this flag.
988	*/
989	#define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
990	/*
991	* Set this flag if this subdev supports multiplexed streams. This means
992	* that the driver supports routing and handles the stream parameter in its
993	* v4l2_subdev_pad_ops handlers. More specifically, this means:
994	*
995	* - Centrally managed subdev active state is enabled
996	* - Legacy pad config is _not_ supported (state->pads is NULL)
997	* - Routing ioctls are available
998	* - Multiple streams per pad are supported
999	*/
1000	#define V4L2_SUBDEV_FL_STREAMS (1U << 4)
1001
1002	struct regulator_bulk_data;
1003
1004	/**
1005	* struct v4l2_subdev_platform_data - regulators config struct
1006	*
1007	* @regulators: Optional regulators used to power on/off the subdevice
1008	* @num_regulators: Number of regululators
1009	* @host_priv: Per-subdevice data, specific for a certain video host device
1010	*/
1011	struct v4l2_subdev_platform_data {
1012	struct regulator_bulk_data *regulators;
1013	int num_regulators;
1014
1015	void *host_priv;
1016	};
1017
1018	/**
1019	* struct v4l2_subdev - describes a V4L2 sub-device
1020	*
1021	* @entity: pointer to &struct media_entity
1022	* @list: List of sub-devices
1023	* @owner: The owner is the same as the driver's &struct device owner.
1024	* @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
1025	* owner. Initialized by v4l2_device_register_subdev().
1026	* @flags: subdev flags. Can be:
1027	* %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
1028	* %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
1029	* %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
1030	* device node;
1031	* %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates
1032	* events.
1033	*
1034	* @v4l2_dev: pointer to struct &v4l2_device
1035	* @ops: pointer to struct &v4l2_subdev_ops
1036	* @internal_ops: pointer to struct &v4l2_subdev_internal_ops.
1037	* Never call these internal ops from within a driver!
1038	* @ctrl_handler: The control handler of this subdev. May be NULL.
1039	* @name: Name of the sub-device. Please notice that the name must be unique.
1040	* @grp_id: can be used to group similar subdevs. Value is driver-specific
1041	* @dev_priv: pointer to private data
1042	* @host_priv: pointer to private data used by the device where the subdev
1043	* is attached.
1044	* @devnode: subdev device node
1045	* @dev: pointer to the physical device, if any
1046	* @fwnode: The fwnode_handle of the subdev, usually the same as
1047	* either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
1048	* @async_list: Links this subdev to a global subdev_list or
1049	* @notifier->done_list list.
1050	* @async_subdev_endpoint_list: List entry in async_subdev_endpoint_entry of
1051	* &struct v4l2_async_subdev_endpoint.
1052	* @subdev_notifier: A sub-device notifier implicitly registered for the sub-
1053	* device using v4l2_async_register_subdev_sensor().
1054	* @asc_list: Async connection list, of &struct
1055	* v4l2_async_connection.subdev_entry.
1056	* @pdata: common part of subdevice platform data
1057	* @state_lock: A pointer to a lock used for all the subdev's states, set by the
1058	* driver. This is optional. If NULL, each state instance will get
1059	* a lock of its own.
1060	* @privacy_led: Optional pointer to a LED classdev for the privacy LED for sensors.
1061	* @active_state: Active state for the subdev (NULL for subdevs tracking the
1062	* state internally). Initialized by calling
1063	* v4l2_subdev_init_finalize().
1064	* @enabled_pads: Bitmask of enabled pads used by v4l2_subdev_enable_streams()
1065	* and v4l2_subdev_disable_streams() helper functions for
1066	* fallback cases.
1067	* @s_stream_enabled: Tracks whether streaming has been enabled with s_stream.
1068	* This is only for call_s_stream() internal use.
1069	*
1070	* Each instance of a subdev driver should create this struct, either
1071	* stand-alone or embedded in a larger struct.
1072	*
1073	* This structure should be initialized by v4l2_subdev_init() or one of
1074	* its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init().
1075	*/
1076	struct v4l2_subdev {
1077	#if defined(CONFIG_MEDIA_CONTROLLER)
1078	struct media_entity entity;
1079	#endif
1080	struct list_head list;
1081	struct module *owner;
1082	bool owner_v4l2_dev;
1083	u32 flags;
1084	struct v4l2_device *v4l2_dev;
1085	const struct v4l2_subdev_ops *ops;
1086	const struct v4l2_subdev_internal_ops *internal_ops;
1087	struct v4l2_ctrl_handler *ctrl_handler;
1088	char name[52];
1089	u32 grp_id;
1090	void *dev_priv;
1091	void *host_priv;
1092	struct video_device *devnode;
1093	struct device *dev;
1094	struct fwnode_handle *fwnode;
1095	struct list_head async_list;
1096	struct list_head async_subdev_endpoint_list;
1097	struct v4l2_async_notifier *subdev_notifier;
1098	struct list_head asc_list;
1099	struct v4l2_subdev_platform_data *pdata;
1100	struct mutex *state_lock;
1101
1102	/*
1103	* The fields below are private, and should only be accessed via
1104	* appropriate functions.
1105	*/
1106
1107	struct led_classdev *privacy_led;
1108
1109	/*
1110	* TODO: active_state should most likely be changed from a pointer to an
1111	* embedded field. For the time being it's kept as a pointer to more
1112	* easily catch uses of active_state in the cases where the driver
1113	* doesn't support it.
1114	*/
1115	struct v4l2_subdev_state *active_state;
1116	u64 enabled_pads;
1117	bool s_stream_enabled;
1118	};
1119
1120
1121	/**
1122	* media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1123	* the &struct media_entity embedded in it.
1124	*
1125	* @ent: pointer to &struct media_entity.
1126	*/
1127	#define media_entity_to_v4l2_subdev(ent) \
1128	({ \
1129	typeof(ent) __me_sd_ent = (ent); \
1130	\
1131	__me_sd_ent ? \
1132	container_of(__me_sd_ent, struct v4l2_subdev, entity) : \
1133	NULL; \
1134	})
1135
1136	/**
1137	* vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1138	* the &struct video_device embedded on it.
1139	*
1140	* @vdev: pointer to &struct video_device
1141	*/
1142	#define vdev_to_v4l2_subdev(vdev) \
1143	((struct v4l2_subdev *)video_get_drvdata(vdev))
1144
1145	/**
1146	* struct v4l2_subdev_fh - Used for storing subdev information per file handle
1147	*
1148	* @vfh: pointer to &struct v4l2_fh
1149	* @state: pointer to &struct v4l2_subdev_state
1150	* @owner: module pointer to the owner of this file handle
1151	* @client_caps: bitmask of ``V4L2_SUBDEV_CLIENT_CAP_*``
1152	*/
1153	struct v4l2_subdev_fh {
1154	struct v4l2_fh vfh;
1155	struct module *owner;
1156	#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
1157	struct v4l2_subdev_state *state;
1158	u64 client_caps;
1159	#endif
1160	};
1161
1162	/**
1163	* to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
1164	* the &struct v4l2_fh embedded on it.
1165	*
1166	* @fh: pointer to &struct v4l2_fh
1167	*/
1168	#define to_v4l2_subdev_fh(fh) \
1169	container_of(fh, struct v4l2_subdev_fh, vfh)
1170
1171	extern const struct v4l2_file_operations v4l2_subdev_fops;
1172
1173	/**
1174	* v4l2_set_subdevdata - Sets V4L2 dev private device data
1175	*
1176	* @sd: pointer to &struct v4l2_subdev
1177	* @p: pointer to the private device data to be stored.
1178	*/
1179	static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
1180	{
1181	sd->dev_priv = p;
1182	}
1183
1184	/**
1185	* v4l2_get_subdevdata - Gets V4L2 dev private device data
1186	*
1187	* @sd: pointer to &struct v4l2_subdev
1188	*
1189	* Returns the pointer to the private device data to be stored.
1190	*/
1191	static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
1192	{
1193	return sd->dev_priv;
1194	}
1195
1196	/**
1197	* v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1198	*
1199	* @sd: pointer to &struct v4l2_subdev
1200	* @p: pointer to the private data to be stored.
1201	*/
1202	static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
1203	{
1204	sd->host_priv = p;
1205	}
1206
1207	/**
1208	* v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1209	*
1210	* @sd: pointer to &struct v4l2_subdev
1211	*
1212	* Returns the pointer to the private host data to be stored.
1213	*/
1214	static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
1215	{
1216	return sd->host_priv;
1217	}
1218
1219	#ifdef CONFIG_MEDIA_CONTROLLER
1220
1221	/**
1222	* v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode
1223	* endpoint, assuming 1:1 port:pad
1224	*
1225	* @entity: Pointer to the subdev entity
1226	* @endpoint: Pointer to a parsed fwnode endpoint
1227	*
1228	* This function can be used as the .get_fwnode_pad operation for
1229	* subdevices that map port numbers and pad indexes 1:1. If the endpoint
1230	* is owned by the subdevice, the function returns the endpoint port
1231	* number.
1232	*
1233	* Returns the endpoint port number on success or a negative error code.
1234	*/
1235	int v4l2_subdev_get_fwnode_pad_1_to_1(struct media_entity *entity,
1236	struct fwnode_endpoint *endpoint);
1237
1238	/**
1239	* v4l2_subdev_link_validate_default - validates a media link
1240	*
1241	* @sd: pointer to &struct v4l2_subdev
1242	* @link: pointer to &struct media_link
1243	* @source_fmt: pointer to &struct v4l2_subdev_format
1244	* @sink_fmt: pointer to &struct v4l2_subdev_format
1245	*
1246	* This function ensures that width, height and the media bus pixel
1247	* code are equal on both source and sink of the link.
1248	*/
1249	int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
1250	struct media_link *link,
1251	struct v4l2_subdev_format *source_fmt,
1252	struct v4l2_subdev_format *sink_fmt);
1253
1254	/**
1255	* v4l2_subdev_link_validate - validates a media link
1256	*
1257	* @link: pointer to &struct media_link
1258	*
1259	* This function calls the subdev's link_validate ops to validate
1260	* if a media link is valid for streaming. It also internally
1261	* calls v4l2_subdev_link_validate_default() to ensure that
1262	* width, height and the media bus pixel code are equal on both
1263	* source and sink of the link.
1264	*
1265	* The function can be used as a drop-in &media_entity_ops.link_validate
1266	* implementation for v4l2_subdev instances. It supports all links between
1267	* subdevs, as well as links between subdevs and video devices, provided that
1268	* the video devices also implement their &media_entity_ops.link_validate
1269	* operation.
1270	*/
1271	int v4l2_subdev_link_validate(struct media_link *link);
1272
1273	/**
1274	* v4l2_subdev_has_pad_interdep - MC has_pad_interdep implementation for subdevs
1275	*
1276	* @entity: pointer to &struct media_entity
1277	* @pad0: pad number for the first pad
1278	* @pad1: pad number for the second pad
1279	*
1280	* This function is an implementation of the
1281	* media_entity_operations.has_pad_interdep operation for subdevs that
1282	* implement the multiplexed streams API (as indicated by the
1283	* V4L2_SUBDEV_FL_STREAMS subdev flag).
1284	*
1285	* It considers two pads interdependent if there is an active route between pad0
1286	* and pad1.
1287	*/
1288	bool v4l2_subdev_has_pad_interdep(struct media_entity *entity,
1289	unsigned int pad0, unsigned int pad1);
1290
1291	/**
1292	* __v4l2_subdev_state_alloc - allocate v4l2_subdev_state
1293	*
1294	* @sd: pointer to &struct v4l2_subdev for which the state is being allocated.
1295	* @lock_name: name of the state lock
1296	* @key: lock_class_key for the lock
1297	*
1298	* Must call __v4l2_subdev_state_free() when state is no longer needed.
1299	*
1300	* Not to be called directly by the drivers.
1301	*/
1302	struct v4l2_subdev_state *__v4l2_subdev_state_alloc(struct v4l2_subdev *sd,
1303	const char *lock_name,
1304	struct lock_class_key *key);
1305
1306	/**
1307	* __v4l2_subdev_state_free - free a v4l2_subdev_state
1308	*
1309	* @state: v4l2_subdev_state to be freed.
1310	*
1311	* Not to be called directly by the drivers.
1312	*/
1313	void __v4l2_subdev_state_free(struct v4l2_subdev_state *state);
1314
1315	/**
1316	* v4l2_subdev_init_finalize() - Finalizes the initialization of the subdevice
1317	* @sd: The subdev
1318	*
1319	* This function finalizes the initialization of the subdev, including
1320	* allocation of the active state for the subdev.
1321	*
1322	* This function must be called by the subdev drivers that use the centralized
1323	* active state, after the subdev struct has been initialized and
1324	* media_entity_pads_init() has been called, but before registering the
1325	* subdev.
1326	*
1327	* The user must call v4l2_subdev_cleanup() when the subdev is being removed.
1328	*/
1329	#define v4l2_subdev_init_finalize(sd) \
1330	({ \
1331	static struct lock_class_key __key; \
1332	const char *name = KBUILD_BASENAME \
1333	":" __stringify(__LINE__) ":sd->active_state->lock"; \
1334	__v4l2_subdev_init_finalize(sd, name, &__key); \
1335	})
1336
1337	int __v4l2_subdev_init_finalize(struct v4l2_subdev *sd, const char *name,
1338	struct lock_class_key *key);
1339
1340	/**
1341	* v4l2_subdev_cleanup() - Releases the resources allocated by the subdevice
1342	* @sd: The subdevice
1343	*
1344	* Clean up a V4L2 async sub-device. Must be called for a sub-device as part of
1345	* its release if resources have been associated with it using
1346	* v4l2_async_subdev_endpoint_add() or v4l2_subdev_init_finalize().
1347	*/
1348	void v4l2_subdev_cleanup(struct v4l2_subdev *sd);
1349
1350	/*
1351	* A macro to generate the macro or function name for sub-devices state access
1352	* wrapper macros below.
1353	*/
1354	#define __v4l2_subdev_state_gen_call(NAME, _1, ARG, ...) \
1355	__v4l2_subdev_state_get_ ## NAME ## ARG
1356
1357	/*
1358	* A macro to constify the return value of the state accessors when the state
1359	* parameter is const.
1360	*/
1361	#define __v4l2_subdev_state_constify_ret(state, value) \
1362	_Generic(state, \
1363	const struct v4l2_subdev_state *: (const typeof(*(value)) *)(value), \
1364	struct v4l2_subdev_state *: (value) \
1365	)
1366
1367	/**
1368	* v4l2_subdev_state_get_format() - Get pointer to a stream format
1369	* @state: subdevice state
1370	* @pad: pad id
1371	* @...: stream id (optional argument)
1372	*
1373	* This returns a pointer to &struct v4l2_mbus_framefmt for the given pad +
1374	* stream in the subdev state.
1375	*
1376	* For stream-unaware drivers the format for the corresponding pad is returned.
1377	* If the pad does not exist, NULL is returned.
1378	*/
1379	/*
1380	* Wrap v4l2_subdev_state_get_format(), allowing the function to be called with
1381	* two or three arguments. The purpose of the __v4l2_subdev_state_gen_call()
1382	* macro is to come up with the name of the function or macro to call, using
1383	* the last two arguments (_stream and _pad). The selected function or macro is
1384	* then called using the arguments specified by the caller. The
1385	* __v4l2_subdev_state_constify_ret() macro constifies the returned pointer
1386	* when the state is const, allowing the state accessors to guarantee
1387	* const-correctness in all cases.
1388	*
1389	* A similar arrangement is used for v4l2_subdev_state_crop(),
1390	* v4l2_subdev_state_compose() and v4l2_subdev_state_get_interval() below.
1391	*/
1392	#define v4l2_subdev_state_get_format(state, pad, ...) \
1393	__v4l2_subdev_state_constify_ret(state, \
1394	__v4l2_subdev_state_gen_call(format, ##__VA_ARGS__, , _pad) \
1395	((struct v4l2_subdev_state *)state, pad, ##__VA_ARGS__))
1396	#define __v4l2_subdev_state_get_format_pad(state, pad) \
1397	__v4l2_subdev_state_get_format(state, pad, 0)
1398	struct v4l2_mbus_framefmt *
1399	__v4l2_subdev_state_get_format(struct v4l2_subdev_state *state,
1400	unsigned int pad, u32 stream);
1401
1402	/**
1403	* v4l2_subdev_state_get_crop() - Get pointer to a stream crop rectangle
1404	* @state: subdevice state
1405	* @pad: pad id
1406	* @...: stream id (optional argument)
1407	*
1408	* This returns a pointer to crop rectangle for the given pad + stream in the
1409	* subdev state.
1410	*
1411	* For stream-unaware drivers the crop rectangle for the corresponding pad is
1412	* returned. If the pad does not exist, NULL is returned.
1413	*/
1414	#define v4l2_subdev_state_get_crop(state, pad, ...) \
1415	__v4l2_subdev_state_constify_ret(state, \
1416	__v4l2_subdev_state_gen_call(crop, ##__VA_ARGS__, , _pad) \
1417	((struct v4l2_subdev_state *)state, pad, ##__VA_ARGS__))
1418	#define __v4l2_subdev_state_get_crop_pad(state, pad) \
1419	__v4l2_subdev_state_get_crop(state, pad, 0)
1420	struct v4l2_rect *
1421	__v4l2_subdev_state_get_crop(struct v4l2_subdev_state *state, unsigned int pad,
1422	u32 stream);
1423
1424	/**
1425	* v4l2_subdev_state_get_compose() - Get pointer to a stream compose rectangle
1426	* @state: subdevice state
1427	* @pad: pad id
1428	* @...: stream id (optional argument)
1429	*
1430	* This returns a pointer to compose rectangle for the given pad + stream in the
1431	* subdev state.
1432	*
1433	* For stream-unaware drivers the compose rectangle for the corresponding pad is
1434	* returned. If the pad does not exist, NULL is returned.
1435	*/
1436	#define v4l2_subdev_state_get_compose(state, pad, ...) \
1437	__v4l2_subdev_state_constify_ret(state, \
1438	__v4l2_subdev_state_gen_call(compose, ##__VA_ARGS__, , _pad) \
1439	((struct v4l2_subdev_state *)state, pad, ##__VA_ARGS__))
1440	#define __v4l2_subdev_state_get_compose_pad(state, pad) \
1441	__v4l2_subdev_state_get_compose(state, pad, 0)
1442	struct v4l2_rect *
1443	__v4l2_subdev_state_get_compose(struct v4l2_subdev_state *state,
1444	unsigned int pad, u32 stream);
1445
1446	/**
1447	* v4l2_subdev_state_get_interval() - Get pointer to a stream frame interval
1448	* @state: subdevice state
1449	* @pad: pad id
1450	* @...: stream id (optional argument)
1451	*
1452	* This returns a pointer to the frame interval for the given pad + stream in
1453	* the subdev state.
1454	*
1455	* For stream-unaware drivers the frame interval for the corresponding pad is
1456	* returned. If the pad does not exist, NULL is returned.
1457	*/
1458	#define v4l2_subdev_state_get_interval(state, pad, ...) \
1459	__v4l2_subdev_state_constify_ret(state, \
1460	__v4l2_subdev_state_gen_call(interval, ##__VA_ARGS__, , _pad) \
1461	((struct v4l2_subdev_state *)state, pad, ##__VA_ARGS__))
1462	#define __v4l2_subdev_state_get_interval_pad(state, pad) \
1463	__v4l2_subdev_state_get_interval(state, pad, 0)
1464	struct v4l2_fract *
1465	__v4l2_subdev_state_get_interval(struct v4l2_subdev_state *state,
1466	unsigned int pad, u32 stream);
1467
1468	#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
1469
1470	/**
1471	* v4l2_subdev_get_fmt() - Fill format based on state
1472	* @sd: subdevice
1473	* @state: subdevice state
1474	* @format: pointer to &struct v4l2_subdev_format
1475	*
1476	* Fill @format->format field based on the information in the @format struct.
1477	*
1478	* This function can be used by the subdev drivers which support active state to
1479	* implement v4l2_subdev_pad_ops.get_fmt if the subdev driver does not need to
1480	* do anything special in their get_fmt op.
1481	*
1482	* Returns 0 on success, error value otherwise.
1483	*/
1484	int v4l2_subdev_get_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_state *state,
1485	struct v4l2_subdev_format *format);
1486
1487	/**
1488	* v4l2_subdev_get_frame_interval() - Fill frame interval based on state
1489	* @sd: subdevice
1490	* @state: subdevice state
1491	* @fi: pointer to &struct v4l2_subdev_frame_interval
1492	*
1493	* Fill @fi->interval field based on the information in the @fi struct.
1494	*
1495	* This function can be used by the subdev drivers which support active state to
1496	* implement v4l2_subdev_pad_ops.get_frame_interval if the subdev driver does
1497	* not need to do anything special in their get_frame_interval op.
1498	*
1499	* Returns 0 on success, error value otherwise.
1500	*/
1501	int v4l2_subdev_get_frame_interval(struct v4l2_subdev *sd,
1502	struct v4l2_subdev_state *state,
1503	struct v4l2_subdev_frame_interval *fi);
1504
1505	/**
1506	* v4l2_subdev_set_routing() - Set given routing to subdev state
1507	* @sd: The subdevice
1508	* @state: The subdevice state
1509	* @routing: Routing that will be copied to subdev state
1510	*
1511	* This will release old routing table (if any) from the state, allocate
1512	* enough space for the given routing, and copy the routing.
1513	*
1514	* This can be used from the subdev driver's set_routing op, after validating
1515	* the routing.
1516	*/
1517	int v4l2_subdev_set_routing(struct v4l2_subdev *sd,
1518	struct v4l2_subdev_state *state,
1519	const struct v4l2_subdev_krouting *routing);
1520
1521	struct v4l2_subdev_route *
1522	__v4l2_subdev_next_active_route(const struct v4l2_subdev_krouting *routing,
1523	struct v4l2_subdev_route *route);
1524
1525	/**
1526	* for_each_active_route - iterate on all active routes of a routing table
1527	* @routing: The routing table
1528	* @route: The route iterator
1529	*/
1530	#define for_each_active_route(routing, route) \
1531	for ((route) = NULL; \
1532	((route) = __v4l2_subdev_next_active_route((routing), (route)));)
1533
1534	/**
1535	* v4l2_subdev_set_routing_with_fmt() - Set given routing and format to subdev
1536	* state
1537	* @sd: The subdevice
1538	* @state: The subdevice state
1539	* @routing: Routing that will be copied to subdev state
1540	* @fmt: Format used to initialize all the streams
1541	*
1542	* This is the same as v4l2_subdev_set_routing, but additionally initializes
1543	* all the streams using the given format.
1544	*/
1545	int v4l2_subdev_set_routing_with_fmt(struct v4l2_subdev *sd,
1546	struct v4l2_subdev_state *state,
1547	const struct v4l2_subdev_krouting *routing,
1548	const struct v4l2_mbus_framefmt *fmt);
1549
1550	/**
1551	* v4l2_subdev_routing_find_opposite_end() - Find the opposite stream
1552	* @routing: routing used to find the opposite side
1553	* @pad: pad id
1554	* @stream: stream id
1555	* @other_pad: pointer used to return the opposite pad
1556	* @other_stream: pointer used to return the opposite stream
1557	*
1558	* This function uses the routing table to find the pad + stream which is
1559	* opposite the given pad + stream.
1560	*
1561	* @other_pad and/or @other_stream can be NULL if the caller does not need the
1562	* value.
1563	*
1564	* Returns 0 on success, or -EINVAL if no matching route is found.
1565	*/
1566	int v4l2_subdev_routing_find_opposite_end(const struct v4l2_subdev_krouting *routing,
1567	u32 pad, u32 stream, u32 *other_pad,
1568	u32 *other_stream);
1569
1570	/**
1571	* v4l2_subdev_state_get_opposite_stream_format() - Get pointer to opposite
1572	* stream format
1573	* @state: subdevice state
1574	* @pad: pad id
1575	* @stream: stream id
1576	*
1577	* This returns a pointer to &struct v4l2_mbus_framefmt for the pad + stream
1578	* that is opposite the given pad + stream in the subdev state.
1579	*
1580	* If the state does not contain the given pad + stream, NULL is returned.
1581	*/
1582	struct v4l2_mbus_framefmt *
1583	v4l2_subdev_state_get_opposite_stream_format(struct v4l2_subdev_state *state,
1584	u32 pad, u32 stream);
1585
1586	/**
1587	* v4l2_subdev_state_xlate_streams() - Translate streams from one pad to another
1588	*
1589	* @state: Subdevice state
1590	* @pad0: The first pad
1591	* @pad1: The second pad
1592	* @streams: Streams bitmask on the first pad
1593	*
1594	* Streams on sink pads of a subdev are routed to source pads as expressed in
1595	* the subdev state routing table. Stream numbers don't necessarily match on
1596	* the sink and source side of a route. This function translates stream numbers
1597	* on @pad0, expressed as a bitmask in @streams, to the corresponding streams
1598	* on @pad1 using the routing table from the @state. It returns the stream mask
1599	* on @pad1, and updates @streams with the streams that have been found in the
1600	* routing table.
1601	*
1602	* @pad0 and @pad1 must be a sink and a source, in any order.
1603	*
1604	* Return: The bitmask of streams of @pad1 that are routed to @streams on @pad0.
1605	*/
1606	u64 v4l2_subdev_state_xlate_streams(const struct v4l2_subdev_state *state,
1607	u32 pad0, u32 pad1, u64 *streams);
1608
1609	/**
1610	* enum v4l2_subdev_routing_restriction - Subdevice internal routing restrictions
1611	*
1612	* @V4L2_SUBDEV_ROUTING_NO_1_TO_N:
1613	* an input stream shall not be routed to multiple output streams (stream
1614	* duplication)
1615	* @V4L2_SUBDEV_ROUTING_NO_N_TO_1:
1616	* multiple input streams shall not be routed to the same output stream
1617	* (stream merging)
1618	* @V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX:
1619	* all streams from a sink pad must be routed to a single source pad
1620	* @V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX:
1621	* all streams on a source pad must originate from a single sink pad
1622	* @V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING:
1623	* source pads shall not contain multiplexed streams
1624	* @V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING:
1625	* sink pads shall not contain multiplexed streams
1626	* @V4L2_SUBDEV_ROUTING_ONLY_1_TO_1:
1627	* only non-overlapping 1-to-1 stream routing is allowed (a combination of
1628	* @V4L2_SUBDEV_ROUTING_NO_1_TO_N and @V4L2_SUBDEV_ROUTING_NO_N_TO_1)
1629	* @V4L2_SUBDEV_ROUTING_NO_STREAM_MIX:
1630	* all streams from a sink pad must be routed to a single source pad, and
1631	* that source pad shall not get routes from any other sink pad
1632	* (a combination of @V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX and
1633	* @V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX)
1634	* @V4L2_SUBDEV_ROUTING_NO_MULTIPLEXING:
1635	* no multiplexed streams allowed on either source or sink sides.
1636	*/
1637	enum v4l2_subdev_routing_restriction {
1638	V4L2_SUBDEV_ROUTING_NO_1_TO_N = BIT(0),
1639	V4L2_SUBDEV_ROUTING_NO_N_TO_1 = BIT(1),
1640	V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX = BIT(2),
1641	V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX = BIT(3),
1642	V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING = BIT(4),
1643	V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING = BIT(5),
1644	V4L2_SUBDEV_ROUTING_ONLY_1_TO_1 =
1645	V4L2_SUBDEV_ROUTING_NO_1_TO_N |
1646	V4L2_SUBDEV_ROUTING_NO_N_TO_1,
1647	V4L2_SUBDEV_ROUTING_NO_STREAM_MIX =
1648	V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX |
1649	V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX,
1650	V4L2_SUBDEV_ROUTING_NO_MULTIPLEXING =
1651	V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING |
1652	V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING,
1653	};
1654
1655	/**
1656	* v4l2_subdev_routing_validate() - Verify that routes comply with driver
1657	* constraints
1658	* @sd: The subdevice
1659	* @routing: Routing to verify
1660	* @disallow: Restrictions on routes
1661	*
1662	* This verifies that the given routing complies with the @disallow constraints.
1663	*
1664	* Returns 0 on success, error value otherwise.
1665	*/
1666	int v4l2_subdev_routing_validate(struct v4l2_subdev *sd,
1667	const struct v4l2_subdev_krouting *routing,
1668	enum v4l2_subdev_routing_restriction disallow);
1669
1670	/**
1671	* v4l2_subdev_enable_streams() - Enable streams on a pad
1672	* @sd: The subdevice
1673	* @pad: The pad
1674	* @streams_mask: Bitmask of streams to enable
1675	*
1676	* This function enables streams on a source @pad of a subdevice. The pad is
1677	* identified by its index, while the streams are identified by the
1678	* @streams_mask bitmask. This allows enabling multiple streams on a pad at
1679	* once.
1680	*
1681	* Enabling a stream that is already enabled isn't allowed. If @streams_mask
1682	* contains an already enabled stream, this function returns -EALREADY without
1683	* performing any operation.
1684	*
1685	* Per-stream enable is only available for subdevs that implement the
1686	* .enable_streams() and .disable_streams() operations. For other subdevs, this
1687	* function implements a best-effort compatibility by calling the .s_stream()
1688	* operation, limited to subdevs that have a single source pad.
1689	*
1690	* Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0).
1691	*
1692	* Return:
1693	* * 0: Success
1694	* * -EALREADY: One of the streams in streams_mask is already enabled
1695	* * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1696	* * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1697	* impossible because the subdev has multiple source pads
1698	*/
1699	int v4l2_subdev_enable_streams(struct v4l2_subdev *sd, u32 pad,
1700	u64 streams_mask);
1701
1702	/**
1703	* v4l2_subdev_disable_streams() - Disable streams on a pad
1704	* @sd: The subdevice
1705	* @pad: The pad
1706	* @streams_mask: Bitmask of streams to disable
1707	*
1708	* This function disables streams on a source @pad of a subdevice. The pad is
1709	* identified by its index, while the streams are identified by the
1710	* @streams_mask bitmask. This allows disabling multiple streams on a pad at
1711	* once.
1712	*
1713	* Disabling a streams that is not enabled isn't allowed. If @streams_mask
1714	* contains a disabled stream, this function returns -EALREADY without
1715	* performing any operation.
1716	*
1717	* Per-stream disable is only available for subdevs that implement the
1718	* .enable_streams() and .disable_streams() operations. For other subdevs, this
1719	* function implements a best-effort compatibility by calling the .s_stream()
1720	* operation, limited to subdevs that have a single source pad.
1721	*
1722	* Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0).
1723	*
1724	* Return:
1725	* * 0: Success
1726	* * -EALREADY: One of the streams in streams_mask is not enabled
1727	* * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1728	* * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1729	* impossible because the subdev has multiple source pads
1730	*/
1731	int v4l2_subdev_disable_streams(struct v4l2_subdev *sd, u32 pad,
1732	u64 streams_mask);
1733
1734	/**
1735	* v4l2_subdev_s_stream_helper() - Helper to implement the subdev s_stream
1736	* operation using enable_streams and disable_streams
1737	* @sd: The subdevice
1738	* @enable: Enable or disable streaming
1739	*
1740	* Subdevice drivers that implement the streams-aware
1741	* &v4l2_subdev_pad_ops.enable_streams and &v4l2_subdev_pad_ops.disable_streams
1742	* operations can use this helper to implement the legacy
1743	* &v4l2_subdev_video_ops.s_stream operation.
1744	*
1745	* This helper can only be used by subdevs that have a single source pad.
1746	*
1747	* Return: 0 on success, or a negative error code otherwise.
1748	*/
1749	int v4l2_subdev_s_stream_helper(struct v4l2_subdev *sd, int enable);
1750
1751	#endif /* CONFIG_VIDEO_V4L2_SUBDEV_API */
1752
1753	#endif /* CONFIG_MEDIA_CONTROLLER */
1754
1755	/**
1756	* v4l2_subdev_lock_state() - Locks the subdev state
1757	* @state: The subdevice state
1758	*
1759	* Locks the given subdev state.
1760	*
1761	* The state must be unlocked with v4l2_subdev_unlock_state() after use.
1762	*/
1763	static inline void v4l2_subdev_lock_state(struct v4l2_subdev_state *state)
1764	{
1765	mutex_lock(state->lock);
1766	}
1767
1768	/**
1769	* v4l2_subdev_unlock_state() - Unlocks the subdev state
1770	* @state: The subdevice state
1771	*
1772	* Unlocks the given subdev state.
1773	*/
1774	static inline void v4l2_subdev_unlock_state(struct v4l2_subdev_state *state)
1775	{
1776	mutex_unlock(lock: state->lock);
1777	}
1778
1779	/**
1780	* v4l2_subdev_lock_states - Lock two sub-device states
1781	* @state1: One subdevice state
1782	* @state2: The other subdevice state
1783	*
1784	* Locks the state of two sub-devices.
1785	*
1786	* The states must be unlocked with v4l2_subdev_unlock_states() after use.
1787	*
1788	* This differs from calling v4l2_subdev_lock_state() on both states so that if
1789	* the states share the same lock, the lock is acquired only once (so no
1790	* deadlock occurs). The caller is responsible for ensuring the locks will
1791	* always be acquired in the same order.
1792	*/
1793	static inline void v4l2_subdev_lock_states(struct v4l2_subdev_state *state1,
1794	struct v4l2_subdev_state *state2)
1795	{
1796	mutex_lock(state1->lock);
1797	if (state1->lock != state2->lock)
1798	mutex_lock(state2->lock);
1799	}
1800
1801	/**
1802	* v4l2_subdev_unlock_states() - Unlock two sub-device states
1803	* @state1: One subdevice state
1804	* @state2: The other subdevice state
1805	*
1806	* Unlocks the state of two sub-devices.
1807	*
1808	* This differs from calling v4l2_subdev_unlock_state() on both states so that
1809	* if the states share the same lock, the lock is released only once.
1810	*/
1811	static inline void v4l2_subdev_unlock_states(struct v4l2_subdev_state *state1,
1812	struct v4l2_subdev_state *state2)
1813	{
1814	mutex_unlock(lock: state1->lock);
1815	if (state1->lock != state2->lock)
1816	mutex_unlock(lock: state2->lock);
1817	}
1818
1819	/**
1820	* v4l2_subdev_get_unlocked_active_state() - Checks that the active subdev state
1821	* is unlocked and returns it
1822	* @sd: The subdevice
1823	*
1824	* Returns the active state for the subdevice, or NULL if the subdev does not
1825	* support active state. If the state is not NULL, calls
1826	* lockdep_assert_not_held() to issue a warning if the state is locked.
1827	*
1828	* This function is to be used e.g. when getting the active state for the sole
1829	* purpose of passing it forward, without accessing the state fields.
1830	*/
1831	static inline struct v4l2_subdev_state *
1832	v4l2_subdev_get_unlocked_active_state(struct v4l2_subdev *sd)
1833	{
1834	if (sd->active_state)
1835	lockdep_assert_not_held(sd->active_state->lock);
1836	return sd->active_state;
1837	}
1838
1839	/**
1840	* v4l2_subdev_get_locked_active_state() - Checks that the active subdev state
1841	* is locked and returns it
1842	*
1843	* @sd: The subdevice
1844	*
1845	* Returns the active state for the subdevice, or NULL if the subdev does not
1846	* support active state. If the state is not NULL, calls lockdep_assert_held()
1847	* to issue a warning if the state is not locked.
1848	*
1849	* This function is to be used when the caller knows that the active state is
1850	* already locked.
1851	*/
1852	static inline struct v4l2_subdev_state *
1853	v4l2_subdev_get_locked_active_state(struct v4l2_subdev *sd)
1854	{
1855	if (sd->active_state)
1856	lockdep_assert_held(sd->active_state->lock);
1857	return sd->active_state;
1858	}
1859
1860	/**
1861	* v4l2_subdev_lock_and_get_active_state() - Locks and returns the active subdev
1862	* state for the subdevice
1863	* @sd: The subdevice
1864	*
1865	* Returns the locked active state for the subdevice, or NULL if the subdev
1866	* does not support active state.
1867	*
1868	* The state must be unlocked with v4l2_subdev_unlock_state() after use.
1869	*/
1870	static inline struct v4l2_subdev_state *
1871	v4l2_subdev_lock_and_get_active_state(struct v4l2_subdev *sd)
1872	{
1873	if (sd->active_state)
1874	v4l2_subdev_lock_state(state: sd->active_state);
1875	return sd->active_state;
1876	}
1877
1878	/**
1879	* v4l2_subdev_init - initializes the sub-device struct
1880	*
1881	* @sd: pointer to the &struct v4l2_subdev to be initialized
1882	* @ops: pointer to &struct v4l2_subdev_ops.
1883	*/
1884	void v4l2_subdev_init(struct v4l2_subdev *sd,
1885	const struct v4l2_subdev_ops *ops);
1886
1887	extern const struct v4l2_subdev_ops v4l2_subdev_call_wrappers;
1888
1889	/**
1890	* v4l2_subdev_call - call an operation of a v4l2_subdev.
1891	*
1892	* @sd: pointer to the &struct v4l2_subdev
1893	* @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1894	* Each element there groups a set of callbacks functions.
1895	* @f: callback function to be called.
1896	* The callback functions are defined in groups, according to
1897	* each element at &struct v4l2_subdev_ops.
1898	* @args: arguments for @f.
1899	*
1900	* Example: err = v4l2_subdev_call(sd, video, s_std, norm);
1901	*/
1902	#define v4l2_subdev_call(sd, o, f, args...) \
1903	({ \
1904	struct v4l2_subdev *__sd = (sd); \
1905	int __result; \
1906	if (!__sd) \
1907	__result = -ENODEV; \
1908	else if (!(__sd->ops->o && __sd->ops->o->f)) \
1909	__result = -ENOIOCTLCMD; \
1910	else if (v4l2_subdev_call_wrappers.o && \
1911	v4l2_subdev_call_wrappers.o->f) \
1912	__result = v4l2_subdev_call_wrappers.o->f( \
1913	__sd, ##args); \
1914	else \
1915	__result = __sd->ops->o->f(__sd, ##args); \
1916	__result; \
1917	})
1918
1919	/**
1920	* v4l2_subdev_call_state_active - call an operation of a v4l2_subdev which
1921	* takes state as a parameter, passing the
1922	* subdev its active state.
1923	*
1924	* @sd: pointer to the &struct v4l2_subdev
1925	* @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1926	* Each element there groups a set of callbacks functions.
1927	* @f: callback function to be called.
1928	* The callback functions are defined in groups, according to
1929	* each element at &struct v4l2_subdev_ops.
1930	* @args: arguments for @f.
1931	*
1932	* This is similar to v4l2_subdev_call(), except that this version can only be
1933	* used for ops that take a subdev state as a parameter. The macro will get the
1934	* active state, lock it before calling the op and unlock it after the call.
1935	*/
1936	#define v4l2_subdev_call_state_active(sd, o, f, args...) \
1937	({ \
1938	int __result; \
1939	struct v4l2_subdev_state *state; \
1940	state = v4l2_subdev_get_unlocked_active_state(sd); \
1941	if (state) \
1942	v4l2_subdev_lock_state(state); \
1943	__result = v4l2_subdev_call(sd, o, f, state, ##args); \
1944	if (state) \
1945	v4l2_subdev_unlock_state(state); \
1946	__result; \
1947	})
1948
1949	/**
1950	* v4l2_subdev_call_state_try - call an operation of a v4l2_subdev which
1951	* takes state as a parameter, passing the
1952	* subdev a newly allocated try state.
1953	*
1954	* @sd: pointer to the &struct v4l2_subdev
1955	* @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1956	* Each element there groups a set of callbacks functions.
1957	* @f: callback function to be called.
1958	* The callback functions are defined in groups, according to
1959	* each element at &struct v4l2_subdev_ops.
1960	* @args: arguments for @f.
1961	*
1962	* This is similar to v4l2_subdev_call_state_active(), except that as this
1963	* version allocates a new state, this is only usable for
1964	* V4L2_SUBDEV_FORMAT_TRY use cases.
1965	*
1966	* Note: only legacy non-MC drivers may need this macro.
1967	*/
1968	#define v4l2_subdev_call_state_try(sd, o, f, args...) \
1969	({ \
1970	int __result; \
1971	static struct lock_class_key __key; \
1972	const char *name = KBUILD_BASENAME \
1973	":" __stringify(__LINE__) ":state->lock"; \
1974	struct v4l2_subdev_state *state = \
1975	__v4l2_subdev_state_alloc(sd, name, &__key); \
1976	v4l2_subdev_lock_state(state); \
1977	__result = v4l2_subdev_call(sd, o, f, state, ##args); \
1978	v4l2_subdev_unlock_state(state); \
1979	__v4l2_subdev_state_free(state); \
1980	__result; \
1981	})
1982
1983	/**
1984	* v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1985	*
1986	* @sd: pointer to the &struct v4l2_subdev
1987	* @o: The group of callback functions in &struct v4l2_subdev_ops
1988	* which @f is a part of.
1989	* @f: callback function to be checked for its existence.
1990	*/
1991	#define v4l2_subdev_has_op(sd, o, f) \
1992	((sd)->ops->o && (sd)->ops->o->f)
1993
1994	/**
1995	* v4l2_subdev_notify_event() - Delivers event notification for subdevice
1996	* @sd: The subdev for which to deliver the event
1997	* @ev: The event to deliver
1998	*
1999	* Will deliver the specified event to all userspace event listeners which are
2000	* subscribed to the v42l subdev event queue as well as to the bridge driver
2001	* using the notify callback. The notification type for the notify callback
2002	* will be %V4L2_DEVICE_NOTIFY_EVENT.
2003	*/
2004	void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
2005	const struct v4l2_event *ev);
2006
2007	/**
2008	* v4l2_subdev_is_streaming() - Returns if the subdevice is streaming
2009	* @sd: The subdevice
2010	*
2011	* v4l2_subdev_is_streaming() tells if the subdevice is currently streaming.
2012	* "Streaming" here means whether .s_stream() or .enable_streams() has been
2013	* successfully called, and the streaming has not yet been disabled.
2014	*
2015	* If the subdevice implements .enable_streams() this function must be called
2016	* while holding the active state lock.
2017	*/
2018	bool v4l2_subdev_is_streaming(struct v4l2_subdev *sd);
2019
2020	#endif /* _V4L2_SUBDEV_H */
2021