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