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