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