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