1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * V4L2 sub-device support header.
5 * Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl>
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>
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
27 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32)
28 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001
30 #define V4L2_DEVICE_NOTIFY_EVENT _IOW('v', 2, struct v4l2_event)
33 struct v4l2_ctrl_handler;
35 struct v4l2_event_subscription;
38 struct v4l2_subdev_fh;
40 struct v4l2_mbus_frame_desc;
43 * struct v4l2_decode_vbi_line - used to decode_vbi_line
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
52 struct v4l2_decode_vbi_line {
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.
64 * Usually these devices are controlled through an i2c bus, but other buses
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.
71 * More categories can be added if needed, although this should remain a
72 * limited set (no more than approx. 8 categories).
74 * Each category has its own set of ops that subdev drivers can implement.
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.
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.
89 * Core ops: it is highly recommended to implement at least these ops:
95 * This provides basic debugging support.
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.
103 * enum v4l2_subdev_io_pin_bits - Subdevice external IO pin configuration
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.
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,
123 * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration
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
132 struct v4l2_subdev_io_pin_config {
141 * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs
143 * @log_status: callback for VIDIOC_LOG_STATUS() ioctl handler code.
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.
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
155 * @load_fw: load firmware.
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.
162 * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with
163 * a direction argument if needed.
165 * @command: called by in-kernel drivers in order to call functions internal
166 * to subdev drivers driver that have a separate callback.
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.
171 * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel,
172 * in order to fix data passed from/to userspace.
174 * @g_register: callback for VIDIOC_DBG_G_REGISTER() ioctl handler code.
176 * @s_register: callback for VIDIOC_DBG_S_REGISTER() ioctl handler code.
178 * @s_power: puts subdevice in power saving mode (on == 0) or normal operation
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**.
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.
189 * @unsubscribe_event: remove event subscription from the control framework.
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);
202 long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,
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);
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);
219 * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened
222 * @standby: puts the tuner in standby mode. It will be woken up
223 * automatically the next time it is used.
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.
230 * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code.
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.
236 * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code.
238 * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code.
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
244 * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code.
246 * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code.
248 * @s_type_addr: sets tuner type and its I2C addr.
250 * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
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::
259 * static void s_frequency(void *priv, const struct v4l2_frequency *f)
262 * if (f.type == V4L2_TUNER_RADIO)
263 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio);
265 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency);
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);
283 * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
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.
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.
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.
305 * @s_stream: used to notify the audio code that stream will start or has
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);
316 * enum v4l2_mbus_frame_desc_flags - media bus frame description flags
318 * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX:
319 * Indicates that &struct v4l2_mbus_frame_desc_entry->length field
320 * specifies maximum data length.
321 * @V4L2_MBUS_FRAME_DESC_FL_BLOB:
322 * Indicates that the format does not have line offsets, i.e.
323 * the receiver should use 1D DMA.
325 enum v4l2_mbus_frame_desc_flags {
326 V4L2_MBUS_FRAME_DESC_FL_LEN_MAX = BIT(0),
327 V4L2_MBUS_FRAME_DESC_FL_BLOB = BIT(1),
331 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
333 * @flags: bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags.
334 * @pixelcode: media bus pixel code, valid if @flags
335 * %FRAME_DESC_FL_BLOB is not set.
336 * @length: number of octets per frame, valid if @flags
337 * %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set.
339 struct v4l2_mbus_frame_desc_entry {
340 enum v4l2_mbus_frame_desc_flags flags;
345 #define V4L2_FRAME_DESC_ENTRY_MAX 4
348 * struct v4l2_mbus_frame_desc - media bus data frame description
349 * @entry: frame descriptors array
350 * @num_entries: number of entries in @entry array
352 struct v4l2_mbus_frame_desc {
353 struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
354 unsigned short num_entries;
358 * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
361 * @s_routing: see s_routing in audio_ops, except this version is for video
364 * @s_crystal_freq: sets the frequency of the crystal used to generate the
365 * clocks in Hz. An extra flags field allows device specific configuration
366 * regarding clock frequency dividers, etc. If not used, then set flags
367 * to 0. If the frequency is not supported, then -EINVAL is returned.
369 * @g_std: callback for VIDIOC_G_STD() ioctl handler code.
371 * @s_std: callback for VIDIOC_S_STD() ioctl handler code.
373 * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
374 * video input devices.
376 * @g_std_output: get current standard for video OUTPUT devices. This is ignored
377 * by video input devices.
379 * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code.
381 * @g_tvnorms: get &v4l2_std_id with all standards supported by the video
382 * CAPTURE device. This is ignored by video output devices.
384 * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
385 * OUTPUT device. This is ignored by video capture devices.
387 * @g_input_status: get input status. Same as the status field in the
390 * @s_stream: used to notify the driver that a video stream will start or has
393 * @g_pixelaspect: callback to return the pixelaspect ratio.
395 * @g_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL()
396 * ioctl handler code.
398 * @s_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL()
399 * ioctl handler code.
401 * @s_dv_timings: Set custom dv timings in the sub device. This is used
402 * when sub device is capable of setting detailed timing information
403 * in the hardware to generate/detect the video signal.
405 * @g_dv_timings: Get custom dv timings in the sub device.
407 * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code.
409 * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
410 * can adjust @size to a lower value and must not write more data to the
411 * buffer starting at @data than the original value of @size.
413 struct v4l2_subdev_video_ops {
414 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
415 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
416 int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
417 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
418 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
419 int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
420 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
421 int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
422 int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
423 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
424 int (*s_stream)(struct v4l2_subdev *sd, int enable);
425 int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect);
426 int (*g_frame_interval)(struct v4l2_subdev *sd,
427 struct v4l2_subdev_frame_interval *interval);
428 int (*s_frame_interval)(struct v4l2_subdev *sd,
429 struct v4l2_subdev_frame_interval *interval);
430 int (*s_dv_timings)(struct v4l2_subdev *sd,
431 struct v4l2_dv_timings *timings);
432 int (*g_dv_timings)(struct v4l2_subdev *sd,
433 struct v4l2_dv_timings *timings);
434 int (*query_dv_timings)(struct v4l2_subdev *sd,
435 struct v4l2_dv_timings *timings);
436 int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
441 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
442 * in video mode via the vbi device node.
444 * @decode_vbi_line: video decoders that support sliced VBI need to implement
445 * this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the
446 * start of the VBI data that was generated by the decoder. The driver
447 * then parses the sliced VBI data and sets the other fields in the
448 * struct accordingly. The pointer p is updated to point to the start of
449 * the payload which can be copied verbatim into the data field of the
450 * &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the
451 * type field is set to 0 on return.
453 * @s_vbi_data: used to generate VBI signals on a video signal.
454 * &struct v4l2_sliced_vbi_data is filled with the data packets that
455 * should be output. Note that if you set the line field to 0, then that
456 * VBI signal is disabled. If no valid VBI data was found, then the type
457 * field is set to 0 on return.
459 * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
460 * Not all video decoders support this. If no data is available because
461 * the readback register contains invalid or erroneous data %-EIO is
462 * returned. Note that you must fill in the 'id' member and the 'field'
463 * member (to determine whether CC data from the first or second field
464 * should be obtained).
466 * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler
469 * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
471 * @g_sliced_fmt: retrieve the current sliced VBI settings.
473 * @s_sliced_fmt: setup the sliced VBI settings.
475 struct v4l2_subdev_vbi_ops {
476 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
477 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
478 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
479 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
480 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
481 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
482 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
486 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
487 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
488 * This is needed for some sensors, which always corrupt
489 * several top lines of the output image, or which send their
491 * @g_skip_frames: number of frames to skip at stream start. This is needed for
492 * buggy sensors that generate faulty frames when they are
495 struct v4l2_subdev_sensor_ops {
496 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
497 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
501 * enum v4l2_subdev_ir_mode- describes the type of IR supported
503 * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records
505 enum v4l2_subdev_ir_mode {
506 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH,
510 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
512 * @bytes_per_data_element: bytes per data element of data in read or
514 * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode.
515 * @enable: device is active if true
516 * @interrupt_enable: IR interrupts are enabled if true
517 * @shutdown: if true: set hardware to low/no power, false: normal mode
519 * @modulation: if true, it uses carrier, if false: baseband
520 * @max_pulse_width: maximum pulse width in ns, valid only for baseband signal
521 * @carrier_freq: carrier frequency in Hz, valid only for modulated signal
522 * @duty_cycle: duty cycle percentage, valid only for modulated signal
523 * @invert_level: invert signal level
525 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX.
527 * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX.
528 * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated
529 * signal. Used only for RX.
530 * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated
531 * signal. Used only for RX.
532 * @resolution: The receive resolution, in ns . Used only for RX.
534 struct v4l2_subdev_ir_parameters {
535 unsigned int bytes_per_data_element;
536 enum v4l2_subdev_ir_mode mode;
539 bool interrupt_enable;
544 unsigned int carrier_freq;
545 unsigned int duty_cycle;
549 bool invert_carrier_sense;
552 u32 noise_filter_min_width;
553 unsigned int carrier_range_lower;
554 unsigned int carrier_range_upper;
559 * struct v4l2_subdev_ir_ops - operations for IR subdevices
561 * @rx_read: Reads received codes or pulse width data.
562 * The semantics are similar to a non-blocking read() call.
563 * @rx_g_parameters: Get the current operating parameters and state of
565 * @rx_s_parameters: Set the current operating parameters and state of
566 * the IR receiver. It is recommended to call
567 * [rt]x_g_parameters first to fill out the current state, and only change
568 * the fields that need to be changed. Upon return, the actual device
569 * operating parameters and state will be returned. Note that hardware
570 * limitations may prevent the actual settings from matching the requested
571 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
572 * was requested. An exception is when the shutdown parameter is true.
573 * The last used operational parameters will be returned, but the actual
574 * state of the hardware be different to minimize power consumption and
575 * processing when shutdown is true.
577 * @tx_write: Writes codes or pulse width data for transmission.
578 * The semantics are similar to a non-blocking write() call.
579 * @tx_g_parameters: Get the current operating parameters and state of
580 * the IR transmitter.
581 * @tx_s_parameters: Set the current operating parameters and state of
582 * the IR transmitter. It is recommended to call
583 * [rt]x_g_parameters first to fill out the current state, and only change
584 * the fields that need to be changed. Upon return, the actual device
585 * operating parameters and state will be returned. Note that hardware
586 * limitations may prevent the actual settings from matching the requested
587 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
588 * was requested. An exception is when the shutdown parameter is true.
589 * The last used operational parameters will be returned, but the actual
590 * state of the hardware be different to minimize power consumption and
591 * processing when shutdown is true.
593 struct v4l2_subdev_ir_ops {
595 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
598 int (*rx_g_parameters)(struct v4l2_subdev *sd,
599 struct v4l2_subdev_ir_parameters *params);
600 int (*rx_s_parameters)(struct v4l2_subdev *sd,
601 struct v4l2_subdev_ir_parameters *params);
604 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
607 int (*tx_g_parameters)(struct v4l2_subdev *sd,
608 struct v4l2_subdev_ir_parameters *params);
609 int (*tx_s_parameters)(struct v4l2_subdev *sd,
610 struct v4l2_subdev_ir_parameters *params);
614 * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
616 * @try_fmt: &struct v4l2_mbus_framefmt
617 * @try_crop: &struct v4l2_rect to be used for crop
618 * @try_compose: &struct v4l2_rect to be used for compose
620 * This structure only needs to be passed to the pad op if the 'which' field
621 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
622 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
624 struct v4l2_subdev_pad_config {
625 struct v4l2_mbus_framefmt try_fmt;
626 struct v4l2_rect try_crop;
627 struct v4l2_rect try_compose;
631 * struct v4l2_subdev_state - Used for storing subdev state information.
633 * @pads: &struct v4l2_subdev_pad_config array
635 * This structure only needs to be passed to the pad op if the 'which' field
636 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
637 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
639 struct v4l2_subdev_state {
640 struct v4l2_subdev_pad_config *pads;
644 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
646 * @init_cfg: initialize the pad config to default values
647 * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler
649 * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler
652 * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl
655 * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code.
657 * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code.
659 * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code.
661 * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code.
663 * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code.
665 * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code.
667 * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler
670 * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler
673 * @link_validate: used by the media controller code to check if the links
674 * that belongs to a pipeline can be used for stream.
676 * @get_frame_desc: get the current low level media bus frame parameters.
678 * @set_frame_desc: set the low level media bus frame parameters, @fd array
679 * may be adjusted by the subdev driver to device capabilities.
681 * @get_mbus_config: get the media bus configuration of a remote sub-device.
682 * The media bus configuration is usually retrieved from the
683 * firmware interface at sub-device probe time, immediately
684 * applied to the hardware and eventually adjusted by the
685 * driver. Remote sub-devices (usually video receivers) shall
686 * use this operation to query the transmitting end bus
687 * configuration in order to adjust their own one accordingly.
688 * Callers should make sure they get the most up-to-date as
689 * possible configuration from the remote end, likely calling
690 * this operation as close as possible to stream on time. The
691 * operation shall fail if the pad index it has been called on
692 * is not valid or in case of unrecoverable failures.
694 * @set_mbus_config: set the media bus configuration of a remote sub-device.
695 * This operations is intended to allow, in combination with
696 * the get_mbus_config operation, the negotiation of media bus
697 * configuration parameters between media sub-devices. The
698 * operation shall not fail if the requested configuration is
699 * not supported, but the driver shall update the content of
700 * the %config argument to reflect what has been actually
701 * applied to the hardware. The operation shall fail if the
702 * pad index it has been called on is not valid or in case of
703 * unrecoverable failures.
705 struct v4l2_subdev_pad_ops {
706 int (*init_cfg)(struct v4l2_subdev *sd,
707 struct v4l2_subdev_state *state);
708 int (*enum_mbus_code)(struct v4l2_subdev *sd,
709 struct v4l2_subdev_state *state,
710 struct v4l2_subdev_mbus_code_enum *code);
711 int (*enum_frame_size)(struct v4l2_subdev *sd,
712 struct v4l2_subdev_state *state,
713 struct v4l2_subdev_frame_size_enum *fse);
714 int (*enum_frame_interval)(struct v4l2_subdev *sd,
715 struct v4l2_subdev_state *state,
716 struct v4l2_subdev_frame_interval_enum *fie);
717 int (*get_fmt)(struct v4l2_subdev *sd,
718 struct v4l2_subdev_state *state,
719 struct v4l2_subdev_format *format);
720 int (*set_fmt)(struct v4l2_subdev *sd,
721 struct v4l2_subdev_state *state,
722 struct v4l2_subdev_format *format);
723 int (*get_selection)(struct v4l2_subdev *sd,
724 struct v4l2_subdev_state *state,
725 struct v4l2_subdev_selection *sel);
726 int (*set_selection)(struct v4l2_subdev *sd,
727 struct v4l2_subdev_state *state,
728 struct v4l2_subdev_selection *sel);
729 int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
730 int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
731 int (*dv_timings_cap)(struct v4l2_subdev *sd,
732 struct v4l2_dv_timings_cap *cap);
733 int (*enum_dv_timings)(struct v4l2_subdev *sd,
734 struct v4l2_enum_dv_timings *timings);
735 #ifdef CONFIG_MEDIA_CONTROLLER
736 int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
737 struct v4l2_subdev_format *source_fmt,
738 struct v4l2_subdev_format *sink_fmt);
739 #endif /* CONFIG_MEDIA_CONTROLLER */
740 int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
741 struct v4l2_mbus_frame_desc *fd);
742 int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
743 struct v4l2_mbus_frame_desc *fd);
744 int (*get_mbus_config)(struct v4l2_subdev *sd, unsigned int pad,
745 struct v4l2_mbus_config *config);
746 int (*set_mbus_config)(struct v4l2_subdev *sd, unsigned int pad,
747 struct v4l2_mbus_config *config);
751 * struct v4l2_subdev_ops - Subdev operations
753 * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL
754 * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL
755 * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL
756 * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL
757 * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL
758 * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL
759 * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL
760 * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL
762 struct v4l2_subdev_ops {
763 const struct v4l2_subdev_core_ops *core;
764 const struct v4l2_subdev_tuner_ops *tuner;
765 const struct v4l2_subdev_audio_ops *audio;
766 const struct v4l2_subdev_video_ops *video;
767 const struct v4l2_subdev_vbi_ops *vbi;
768 const struct v4l2_subdev_ir_ops *ir;
769 const struct v4l2_subdev_sensor_ops *sensor;
770 const struct v4l2_subdev_pad_ops *pad;
774 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
776 * @registered: called when this subdev is registered. When called the v4l2_dev
777 * field is set to the correct v4l2_device.
779 * @unregistered: called when this subdev is unregistered. When called the
780 * v4l2_dev field is still set to the correct v4l2_device.
782 * @open: called when the subdev device node is opened by an application.
784 * @close: called when the subdev device node is closed. Please note that
785 * it is possible for @close to be called after @unregistered!
787 * @release: called when the last user of the subdev device is gone. This
788 * happens after the @unregistered callback and when the last open
789 * filehandle to the v4l-subdevX device node was closed. If no device
790 * node was created for this sub-device, then the @release callback
791 * is called right after the @unregistered callback.
792 * The @release callback is typically used to free the memory containing
793 * the v4l2_subdev structure. It is almost certainly required for any
794 * sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag.
797 * Never call this from drivers, only the v4l2 framework can call
800 struct v4l2_subdev_internal_ops {
801 int (*registered)(struct v4l2_subdev *sd);
802 void (*unregistered)(struct v4l2_subdev *sd);
803 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
804 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
805 void (*release)(struct v4l2_subdev *sd);
808 #define V4L2_SUBDEV_NAME_SIZE 32
810 /* Set this flag if this subdev is a i2c device. */
811 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
812 /* Set this flag if this subdev is a spi device. */
813 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
814 /* Set this flag if this subdev needs a device node. */
815 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
817 * Set this flag if this subdev generates events.
818 * Note controls can send events, thus drivers exposing controls
819 * should set this flag.
821 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
823 struct regulator_bulk_data;
826 * struct v4l2_subdev_platform_data - regulators config struct
828 * @regulators: Optional regulators used to power on/off the subdevice
829 * @num_regulators: Number of regululators
830 * @host_priv: Per-subdevice data, specific for a certain video host device
832 struct v4l2_subdev_platform_data {
833 struct regulator_bulk_data *regulators;
840 * struct v4l2_subdev - describes a V4L2 sub-device
842 * @entity: pointer to &struct media_entity
843 * @list: List of sub-devices
844 * @owner: The owner is the same as the driver's &struct device owner.
845 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
846 * owner. Initialized by v4l2_device_register_subdev().
847 * @flags: subdev flags. Can be:
848 * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
849 * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
850 * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
852 * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates
855 * @v4l2_dev: pointer to struct &v4l2_device
856 * @ops: pointer to struct &v4l2_subdev_ops
857 * @internal_ops: pointer to struct &v4l2_subdev_internal_ops.
858 * Never call these internal ops from within a driver!
859 * @ctrl_handler: The control handler of this subdev. May be NULL.
860 * @name: Name of the sub-device. Please notice that the name must be unique.
861 * @grp_id: can be used to group similar subdevs. Value is driver-specific
862 * @dev_priv: pointer to private data
863 * @host_priv: pointer to private data used by the device where the subdev
865 * @devnode: subdev device node
866 * @dev: pointer to the physical device, if any
867 * @fwnode: The fwnode_handle of the subdev, usually the same as
868 * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
869 * @async_list: Links this subdev to a global subdev_list or @notifier->done
871 * @asd: Pointer to respective &struct v4l2_async_subdev.
872 * @notifier: Pointer to the managing notifier.
873 * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
874 * device using v4l2_device_register_sensor_subdev().
875 * @pdata: common part of subdevice platform data
877 * Each instance of a subdev driver should create this struct, either
878 * stand-alone or embedded in a larger struct.
880 * This structure should be initialized by v4l2_subdev_init() or one of
881 * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init().
884 #if defined(CONFIG_MEDIA_CONTROLLER)
885 struct media_entity entity;
887 struct list_head list;
888 struct module *owner;
891 struct v4l2_device *v4l2_dev;
892 const struct v4l2_subdev_ops *ops;
893 const struct v4l2_subdev_internal_ops *internal_ops;
894 struct v4l2_ctrl_handler *ctrl_handler;
895 char name[V4L2_SUBDEV_NAME_SIZE];
899 struct video_device *devnode;
901 struct fwnode_handle *fwnode;
902 struct list_head async_list;
903 struct v4l2_async_subdev *asd;
904 struct v4l2_async_notifier *notifier;
905 struct v4l2_async_notifier *subdev_notifier;
906 struct v4l2_subdev_platform_data *pdata;
911 * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
912 * the &struct media_entity embedded in it.
914 * @ent: pointer to &struct media_entity.
916 #define media_entity_to_v4l2_subdev(ent) \
918 typeof(ent) __me_sd_ent = (ent); \
921 container_of(__me_sd_ent, struct v4l2_subdev, entity) : \
926 * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
927 * the &struct video_device embedded on it.
929 * @vdev: pointer to &struct video_device
931 #define vdev_to_v4l2_subdev(vdev) \
932 ((struct v4l2_subdev *)video_get_drvdata(vdev))
935 * struct v4l2_subdev_fh - Used for storing subdev information per file handle
937 * @vfh: pointer to &struct v4l2_fh
938 * @state: pointer to &struct v4l2_subdev_state
939 * @owner: module pointer to the owner of this file handle
941 struct v4l2_subdev_fh {
943 struct module *owner;
944 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
945 struct v4l2_subdev_state *state;
950 * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
951 * the &struct v4l2_fh embedded on it.
953 * @fh: pointer to &struct v4l2_fh
955 #define to_v4l2_subdev_fh(fh) \
956 container_of(fh, struct v4l2_subdev_fh, vfh)
958 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
961 * v4l2_subdev_get_try_format - ancillary routine to call
962 * &struct v4l2_subdev_pad_config->try_fmt
964 * @sd: pointer to &struct v4l2_subdev
965 * @state: pointer to &struct v4l2_subdev_state
966 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array
968 static inline struct v4l2_mbus_framefmt *
969 v4l2_subdev_get_try_format(struct v4l2_subdev *sd,
970 struct v4l2_subdev_state *state,
973 if (WARN_ON(pad >= sd->entity.num_pads))
975 return &state->pads[pad].try_fmt;
979 * v4l2_subdev_get_try_crop - ancillary routine to call
980 * &struct v4l2_subdev_pad_config->try_crop
982 * @sd: pointer to &struct v4l2_subdev
983 * @state: pointer to &struct v4l2_subdev_state.
984 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array.
986 static inline struct v4l2_rect *
987 v4l2_subdev_get_try_crop(struct v4l2_subdev *sd,
988 struct v4l2_subdev_state *state,
991 if (WARN_ON(pad >= sd->entity.num_pads))
993 return &state->pads[pad].try_crop;
997 * v4l2_subdev_get_try_compose - ancillary routine to call
998 * &struct v4l2_subdev_pad_config->try_compose
1000 * @sd: pointer to &struct v4l2_subdev
1001 * @state: pointer to &struct v4l2_subdev_state.
1002 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array.
1004 static inline struct v4l2_rect *
1005 v4l2_subdev_get_try_compose(struct v4l2_subdev *sd,
1006 struct v4l2_subdev_state *state,
1009 if (WARN_ON(pad >= sd->entity.num_pads))
1011 return &state->pads[pad].try_compose;
1016 extern const struct v4l2_file_operations v4l2_subdev_fops;
1019 * v4l2_set_subdevdata - Sets V4L2 dev private device data
1021 * @sd: pointer to &struct v4l2_subdev
1022 * @p: pointer to the private device data to be stored.
1024 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
1030 * v4l2_get_subdevdata - Gets V4L2 dev private device data
1032 * @sd: pointer to &struct v4l2_subdev
1034 * Returns the pointer to the private device data to be stored.
1036 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
1038 return sd->dev_priv;
1042 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1044 * @sd: pointer to &struct v4l2_subdev
1045 * @p: pointer to the private data to be stored.
1047 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
1053 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1055 * @sd: pointer to &struct v4l2_subdev
1057 * Returns the pointer to the private host data to be stored.
1059 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
1061 return sd->host_priv;
1064 #ifdef CONFIG_MEDIA_CONTROLLER
1067 * v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode
1068 * endpoint, assuming 1:1 port:pad
1070 * @entity: Pointer to the subdev entity
1071 * @endpoint: Pointer to a parsed fwnode endpoint
1073 * This function can be used as the .get_fwnode_pad operation for
1074 * subdevices that map port numbers and pad indexes 1:1. If the endpoint
1075 * is owned by the subdevice, the function returns the endpoint port
1078 * Returns the endpoint port number on success or a negative error code.
1080 int v4l2_subdev_get_fwnode_pad_1_to_1(struct media_entity *entity,
1081 struct fwnode_endpoint *endpoint);
1084 * v4l2_subdev_link_validate_default - validates a media link
1086 * @sd: pointer to &struct v4l2_subdev
1087 * @link: pointer to &struct media_link
1088 * @source_fmt: pointer to &struct v4l2_subdev_format
1089 * @sink_fmt: pointer to &struct v4l2_subdev_format
1091 * This function ensures that width, height and the media bus pixel
1092 * code are equal on both source and sink of the link.
1094 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
1095 struct media_link *link,
1096 struct v4l2_subdev_format *source_fmt,
1097 struct v4l2_subdev_format *sink_fmt);
1100 * v4l2_subdev_link_validate - validates a media link
1102 * @link: pointer to &struct media_link
1104 * This function calls the subdev's link_validate ops to validate
1105 * if a media link is valid for streaming. It also internally
1106 * calls v4l2_subdev_link_validate_default() to ensure that
1107 * width, height and the media bus pixel code are equal on both
1108 * source and sink of the link.
1110 int v4l2_subdev_link_validate(struct media_link *link);
1113 * v4l2_subdev_alloc_state - allocate v4l2_subdev_state
1115 * @sd: pointer to &struct v4l2_subdev for which the state is being allocated.
1117 * Must call v4l2_subdev_free_state() when state is no longer needed.
1119 struct v4l2_subdev_state *v4l2_subdev_alloc_state(struct v4l2_subdev *sd);
1122 * v4l2_subdev_free_state - free a v4l2_subdev_state
1124 * @state: v4l2_subdev_state to be freed.
1126 void v4l2_subdev_free_state(struct v4l2_subdev_state *state);
1128 #endif /* CONFIG_MEDIA_CONTROLLER */
1131 * v4l2_subdev_init - initializes the sub-device struct
1133 * @sd: pointer to the &struct v4l2_subdev to be initialized
1134 * @ops: pointer to &struct v4l2_subdev_ops.
1136 void v4l2_subdev_init(struct v4l2_subdev *sd,
1137 const struct v4l2_subdev_ops *ops);
1139 extern const struct v4l2_subdev_ops v4l2_subdev_call_wrappers;
1142 * v4l2_subdev_call - call an operation of a v4l2_subdev.
1144 * @sd: pointer to the &struct v4l2_subdev
1145 * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1146 * Each element there groups a set of callbacks functions.
1147 * @f: callback function to be called.
1148 * The callback functions are defined in groups, according to
1149 * each element at &struct v4l2_subdev_ops.
1150 * @args: arguments for @f.
1152 * Example: err = v4l2_subdev_call(sd, video, s_std, norm);
1154 #define v4l2_subdev_call(sd, o, f, args...) \
1156 struct v4l2_subdev *__sd = (sd); \
1159 __result = -ENODEV; \
1160 else if (!(__sd->ops->o && __sd->ops->o->f)) \
1161 __result = -ENOIOCTLCMD; \
1162 else if (v4l2_subdev_call_wrappers.o && \
1163 v4l2_subdev_call_wrappers.o->f) \
1164 __result = v4l2_subdev_call_wrappers.o->f( \
1167 __result = __sd->ops->o->f(__sd, ##args); \
1172 * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1174 * @sd: pointer to the &struct v4l2_subdev
1175 * @o: The group of callback functions in &struct v4l2_subdev_ops
1176 * which @f is a part of.
1177 * @f: callback function to be checked for its existence.
1179 #define v4l2_subdev_has_op(sd, o, f) \
1180 ((sd)->ops->o && (sd)->ops->o->f)
1183 * v4l2_subdev_notify_event() - Delivers event notification for subdevice
1184 * @sd: The subdev for which to deliver the event
1185 * @ev: The event to deliver
1187 * Will deliver the specified event to all userspace event listeners which are
1188 * subscribed to the v42l subdev event queue as well as to the bridge driver
1189 * using the notify callback. The notification type for the notify callback
1190 * will be %V4L2_DEVICE_NOTIFY_EVENT.
1192 void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
1193 const struct v4l2_event *ev);