2 * V4L2 sub-device support header.
4 * Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #ifndef _V4L2_SUBDEV_H
18 #define _V4L2_SUBDEV_H
20 #include <linux/types.h>
21 #include <linux/v4l2-subdev.h>
22 #include <media/media-entity.h>
23 #include <media/v4l2-async.h>
24 #include <media/v4l2-common.h>
25 #include <media/v4l2-dev.h>
26 #include <media/v4l2-fh.h>
27 #include <media/v4l2-mediabus.h>
29 /* generic v4l2_device notify callback notification values */
30 #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32)
31 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001
32 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002
33 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004
34 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008
36 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32)
37 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001
39 #define V4L2_DEVICE_NOTIFY_EVENT _IOW('v', 2, struct v4l2_event)
42 struct v4l2_ctrl_handler;
44 struct v4l2_event_subscription;
47 struct v4l2_subdev_fh;
49 struct v4l2_mbus_frame_desc;
52 * struct v4l2_decode_vbi_line - used to decode_vbi_line
54 * @is_second_field: Set to 0 for the first (odd) field;
55 * set to 1 for the second (even) field.
56 * @p: Pointer to the sliced VBI data from the decoder. On exit, points to
57 * the start of the payload.
58 * @line: Line number of the sliced VBI data (1-23)
59 * @type: VBI service type (V4L2_SLICED_*). 0 if no service found
61 struct v4l2_decode_vbi_line {
69 * Sub-devices are devices that are connected somehow to the main bridge
70 * device. These devices are usually audio/video muxers/encoders/decoders or
71 * sensors and webcam controllers.
73 * Usually these devices are controlled through an i2c bus, but other busses
76 * The v4l2_subdev struct provides a way of accessing these devices in a
77 * generic manner. Most operations that these sub-devices support fall in
78 * a few categories: core ops, audio ops, video ops and tuner ops.
80 * More categories can be added if needed, although this should remain a
81 * limited set (no more than approx. 8 categories).
83 * Each category has its own set of ops that subdev drivers can implement.
85 * A subdev driver can leave the pointer to the category ops NULL if
86 * it does not implement them (e.g. an audio subdev will generally not
87 * implement the video category ops). The exception is the core category:
88 * this must always be present.
90 * These ops are all used internally so it is no problem to change, remove
91 * or add ops or move ops from one to another category. Currently these
92 * ops are based on the original ioctls, but since ops are not limited to
93 * one argument there is room for improvement here once all i2c subdev
94 * drivers are converted to use these ops.
98 * Core ops: it is highly recommended to implement at least these ops:
104 * This provides basic debugging support.
106 * The ioctl ops is meant for generic ioctl-like commands. Depending on
107 * the use-case it might be better to use subdev-specific ops (currently
108 * not yet implemented) since ops provide proper type-checking.
112 * enum v4l2_subdev_io_pin_bits - Subdevice external IO pin configuration
115 * @V4L2_SUBDEV_IO_PIN_DISABLE: disables a pin config. ENABLE assumed.
116 * @V4L2_SUBDEV_IO_PIN_OUTPUT: set it if pin is an output.
117 * @V4L2_SUBDEV_IO_PIN_INPUT: set it if pin is an input.
118 * @V4L2_SUBDEV_IO_PIN_SET_VALUE: to set the output value via
119 * &struct v4l2_subdev_io_pin_config->value.
120 * @V4L2_SUBDEV_IO_PIN_ACTIVE_LOW: pin active is bit 0.
121 * Otherwise, ACTIVE HIGH is assumed.
123 enum v4l2_subdev_io_pin_bits {
124 V4L2_SUBDEV_IO_PIN_DISABLE = 0,
125 V4L2_SUBDEV_IO_PIN_OUTPUT = 1,
126 V4L2_SUBDEV_IO_PIN_INPUT = 2,
127 V4L2_SUBDEV_IO_PIN_SET_VALUE = 3,
128 V4L2_SUBDEV_IO_PIN_ACTIVE_LOW = 4,
132 * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration
134 * @flags: bitmask with flags for this pin's config, whose bits are defined by
135 * &enum v4l2_subdev_io_pin_bits.
136 * @pin: Chip external IO pin to configure
137 * @function: Internal signal pad/function to route to IO pin
138 * @value: Initial value for pin - e.g. GPIO output value
139 * @strength: Pin drive strength
141 struct v4l2_subdev_io_pin_config {
150 * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs
152 * @log_status: callback for VIDIOC_LOG_STATUS() ioctl handler code.
154 * @s_io_pin_config: configure one or more chip I/O pins for chips that
155 * multiplex different internal signal pads out to IO pins. This function
156 * takes a pointer to an array of 'n' pin configuration entries, one for
157 * each pin being configured. This function could be called at times
158 * other than just subdevice initialization.
160 * @init: initialize the sensor registers to some sort of reasonable default
161 * values. Do not use for new drivers and should be removed in existing
164 * @load_fw: load firmware.
166 * @reset: generic reset command. The argument selects which subsystems to
167 * reset. Passing 0 will always reset the whole chip. Do not use for new
168 * drivers without discussing this first on the linux-media mailinglist.
169 * There should be no reason normally to reset a device.
171 * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with
172 * a direction argument if needed.
174 * @command: called by in-kernel drivers in order to call functions internal
175 * to subdev drivers driver that have a separate callback.
177 * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core.
178 * used to provide support for private ioctls used on the driver.
180 * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel,
181 * in order to fix data passed from/to userspace.
183 * @g_register: callback for VIDIOC_DBG_G_REGISTER() ioctl handler code.
185 * @s_register: callback for VIDIOC_DBG_S_REGISTER() ioctl handler code.
187 * @s_power: puts subdevice in power saving mode (on == 0) or normal operation
190 * @interrupt_service_routine: Called by the bridge chip's interrupt service
191 * handler, when an interrupt status has be raised due to this subdev,
192 * so that this subdev can handle the details. It may schedule work to be
193 * performed later. It must not sleep. **Called from an IRQ context**.
195 * @subscribe_event: used by the drivers to request the control framework that
196 * for it to be warned when the value of a control changes.
198 * @unsubscribe_event: remove event subscription from the control framework.
200 struct v4l2_subdev_core_ops {
201 int (*log_status)(struct v4l2_subdev *sd);
202 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
203 struct v4l2_subdev_io_pin_config *pincfg);
204 int (*init)(struct v4l2_subdev *sd, u32 val);
205 int (*load_fw)(struct v4l2_subdev *sd);
206 int (*reset)(struct v4l2_subdev *sd, u32 val);
207 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
208 long (*command)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
209 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
211 long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,
214 #ifdef CONFIG_VIDEO_ADV_DEBUG
215 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
216 int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg);
218 int (*s_power)(struct v4l2_subdev *sd, int on);
219 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
220 u32 status, bool *handled);
221 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
222 struct v4l2_event_subscription *sub);
223 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
224 struct v4l2_event_subscription *sub);
228 * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened
231 * @standby: puts the tuner in standby mode. It will be woken up
232 * automatically the next time it is used.
234 * @s_radio: callback that switches the tuner to radio mode.
235 * drivers should explicitly call it when a tuner ops should
236 * operate on radio mode, before being able to handle it.
237 * Used on devices that have both AM/FM radio receiver and TV.
239 * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code.
241 * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code.
242 * freq->type must be filled in. Normally done by video_ioctl2()
243 * or the bridge driver.
245 * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code.
247 * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code.
249 * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be
250 * filled in. Normally done by video_ioctl2 or the
253 * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code.
255 * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code.
257 * @s_type_addr: sets tuner type and its I2C addr.
259 * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
263 * On devices that have both AM/FM and TV, it is up to the driver
264 * to explicitly call s_radio when the tuner should be switched to
265 * radio mode, before handling other &struct v4l2_subdev_tuner_ops
266 * that would require it. An example of such usage is::
268 * static void s_frequency(void *priv, const struct v4l2_frequency *f)
271 * if (f.type == V4L2_TUNER_RADIO)
272 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio);
274 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency);
277 struct v4l2_subdev_tuner_ops {
278 int (*standby)(struct v4l2_subdev *sd);
279 int (*s_radio)(struct v4l2_subdev *sd);
280 int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);
281 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
282 int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);
283 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
284 int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);
285 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
286 int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);
287 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
288 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
292 * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
294 * @s_clock_freq: set the frequency (in Hz) of the audio clock output.
295 * Used to slave an audio processor to the video decoder, ensuring that
296 * audio and video remain synchronized. Usual values for the frequency
297 * are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
298 * -EINVAL is returned.
300 * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
301 * way to select I2S clock used by driving digital audio streams at some
302 * board designs. Usual values for the frequency are 1024000 and 2048000.
303 * If the frequency is not supported, then %-EINVAL is returned.
305 * @s_routing: used to define the input and/or output pins of an audio chip,
306 * and any additional configuration data.
307 * Never attempt to use user-level input IDs (e.g. Composite, S-Video,
308 * Tuner) at this level. An i2c device shouldn't know about whether an
309 * input pin is connected to a Composite connector, become on another
310 * board or platform it might be connected to something else entirely.
311 * The calling driver is responsible for mapping a user-level input to
312 * the right pins on the i2c device.
314 * @s_stream: used to notify the audio code that stream will start or has
317 struct v4l2_subdev_audio_ops {
318 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
319 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
320 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
321 int (*s_stream)(struct v4l2_subdev *sd, int enable);
325 * enum v4l2_mbus_frame_desc_entry - media bus frame description flags
327 * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX:
328 * Indicates that &struct v4l2_mbus_frame_desc_entry->length field
329 * specifies maximum data length.
330 * @V4L2_MBUS_FRAME_DESC_FL_BLOB:
331 * Indicates that the format does not have line offsets, i.e.
332 * the receiver should use 1D DMA.
334 enum v4l2_mbus_frame_desc_flags {
335 V4L2_MBUS_FRAME_DESC_FL_LEN_MAX = BIT(0),
336 V4L2_MBUS_FRAME_DESC_FL_BLOB = BIT(1),
340 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
342 * @flags: bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags.
343 * @pixelcode: media bus pixel code, valid if @flags
344 * %FRAME_DESC_FL_BLOB is not set.
345 * @length: number of octets per frame, valid if @flags
346 * %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set.
348 struct v4l2_mbus_frame_desc_entry {
349 enum v4l2_mbus_frame_desc_flags flags;
354 #define V4L2_FRAME_DESC_ENTRY_MAX 4
357 * struct v4l2_mbus_frame_desc - media bus data frame description
358 * @entry: frame descriptors array
359 * @num_entries: number of entries in @entry array
361 struct v4l2_mbus_frame_desc {
362 struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
363 unsigned short num_entries;
367 * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
370 * @s_routing: see s_routing in audio_ops, except this version is for video
373 * @s_crystal_freq: sets the frequency of the crystal used to generate the
374 * clocks in Hz. An extra flags field allows device specific configuration
375 * regarding clock frequency dividers, etc. If not used, then set flags
376 * to 0. If the frequency is not supported, then -EINVAL is returned.
378 * @g_std: callback for VIDIOC_G_STD() ioctl handler code.
380 * @s_std: callback for VIDIOC_S_STD() ioctl handler code.
382 * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
383 * video input devices.
385 * @g_std_output: get current standard for video OUTPUT devices. This is ignored
386 * by video input devices.
388 * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code.
390 * @g_tvnorms: get &v4l2_std_id with all standards supported by the video
391 * CAPTURE device. This is ignored by video output devices.
393 * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
394 * OUTPUT device. This is ignored by video capture devices.
396 * @g_input_status: get input status. Same as the status field in the
397 * &struct &v4l2_input
399 * @s_stream: used to notify the driver that a video stream will start or has
402 * @g_pixelaspect: callback to return the pixelaspect ratio.
404 * @g_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL()
405 * ioctl handler code.
407 * @s_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL()
408 * ioctl handler code.
410 * @s_dv_timings: Set custom dv timings in the sub device. This is used
411 * when sub device is capable of setting detailed timing information
412 * in the hardware to generate/detect the video signal.
414 * @g_dv_timings: Get custom dv timings in the sub device.
416 * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code.
418 * @g_mbus_config: get supported mediabus configurations
420 * @s_mbus_config: set a certain mediabus configuration. This operation is added
421 * for compatibility with soc-camera drivers and should not be used by new
424 * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
425 * can adjust @size to a lower value and must not write more data to the
426 * buffer starting at @data than the original value of @size.
428 struct v4l2_subdev_video_ops {
429 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
430 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
431 int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
432 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
433 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
434 int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
435 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
436 int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
437 int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
438 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
439 int (*s_stream)(struct v4l2_subdev *sd, int enable);
440 int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect);
441 int (*g_frame_interval)(struct v4l2_subdev *sd,
442 struct v4l2_subdev_frame_interval *interval);
443 int (*s_frame_interval)(struct v4l2_subdev *sd,
444 struct v4l2_subdev_frame_interval *interval);
445 int (*s_dv_timings)(struct v4l2_subdev *sd,
446 struct v4l2_dv_timings *timings);
447 int (*g_dv_timings)(struct v4l2_subdev *sd,
448 struct v4l2_dv_timings *timings);
449 int (*query_dv_timings)(struct v4l2_subdev *sd,
450 struct v4l2_dv_timings *timings);
451 int (*g_mbus_config)(struct v4l2_subdev *sd,
452 struct v4l2_mbus_config *cfg);
453 int (*s_mbus_config)(struct v4l2_subdev *sd,
454 const struct v4l2_mbus_config *cfg);
455 int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
460 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
461 * in video mode via the vbi device node.
463 * @decode_vbi_line: video decoders that support sliced VBI need to implement
464 * this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the
465 * start of the VBI data that was generated by the decoder. The driver
466 * then parses the sliced VBI data and sets the other fields in the
467 * struct accordingly. The pointer p is updated to point to the start of
468 * the payload which can be copied verbatim into the data field of the
469 * &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the
470 * type field is set to 0 on return.
472 * @s_vbi_data: used to generate VBI signals on a video signal.
473 * &struct v4l2_sliced_vbi_data is filled with the data packets that
474 * should be output. Note that if you set the line field to 0, then that
475 * VBI signal is disabled. If no valid VBI data was found, then the type
476 * field is set to 0 on return.
478 * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
479 * Not all video decoders support this. If no data is available because
480 * the readback register contains invalid or erroneous data %-EIO is
481 * returned. Note that you must fill in the 'id' member and the 'field'
482 * member (to determine whether CC data from the first or second field
483 * should be obtained).
485 * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler
488 * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
490 * @g_sliced_fmt: retrieve the current sliced VBI settings.
492 * @s_sliced_fmt: setup the sliced VBI settings.
494 struct v4l2_subdev_vbi_ops {
495 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
496 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
497 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
498 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
499 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
500 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
501 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
505 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
506 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
507 * This is needed for some sensors, which always corrupt
508 * several top lines of the output image, or which send their
510 * @g_skip_frames: number of frames to skip at stream start. This is needed for
511 * buggy sensors that generate faulty frames when they are
514 struct v4l2_subdev_sensor_ops {
515 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
516 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
520 * enum v4l2_subdev_ir_mode- describes the type of IR supported
522 * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records
524 enum v4l2_subdev_ir_mode {
525 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH,
529 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
531 * @bytes_per_data_element: bytes per data element of data in read or
533 * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode.
534 * @enable: device is active if true
535 * @interrupt_enable: IR interrupts are enabled if true
536 * @shutdown: if true: set hardware to low/no power, false: normal mode
538 * @modulation: if true, it uses carrier, if false: baseband
539 * @max_pulse_width: maximum pulse width in ns, valid only for baseband signal
540 * @carrier_freq: carrier frequency in Hz, valid only for modulated signal
541 * @duty_cycle: duty cycle percentage, valid only for modulated signal
542 * @invert_level: invert signal level
544 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX.
546 * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX.
547 * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated
548 * signal. Used only for RX.
549 * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated
550 * signal. Used only for RX.
551 * @resolution: The receive resolution, in ns . Used only for RX.
553 struct v4l2_subdev_ir_parameters {
554 unsigned int bytes_per_data_element;
555 enum v4l2_subdev_ir_mode mode;
558 bool interrupt_enable;
563 unsigned int carrier_freq;
564 unsigned int duty_cycle;
568 bool invert_carrier_sense;
571 u32 noise_filter_min_width;
572 unsigned int carrier_range_lower;
573 unsigned int carrier_range_upper;
578 * struct v4l2_subdev_ir_ops - operations for IR subdevices
580 * @rx_read: Reads received codes or pulse width data.
581 * The semantics are similar to a non-blocking read() call.
582 * @rx_g_parameters: Get the current operating parameters and state of the
584 * @rx_s_parameters: Set the current operating parameters and state of the
585 * the IR receiver. It is recommended to call
586 * [rt]x_g_parameters first to fill out the current state, and only change
587 * the fields that need to be changed. Upon return, the actual device
588 * operating parameters and state will be returned. Note that hardware
589 * limitations may prevent the actual settings from matching the requested
590 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
591 * was requested. An exception is when the shutdown parameter is true.
592 * The last used operational parameters will be returned, but the actual
593 * state of the hardware be different to minimize power consumption and
594 * processing when shutdown is true.
596 * @tx_write: Writes codes or pulse width data for transmission.
597 * The semantics are similar to a non-blocking write() call.
598 * @tx_g_parameters: Get the current operating parameters and state of the
599 * the IR transmitter.
600 * @tx_s_parameters: Set the current operating parameters and state of the
601 * the IR transmitter. It is recommended to call
602 * [rt]x_g_parameters first to fill out the current state, and only change
603 * the fields that need to be changed. Upon return, the actual device
604 * operating parameters and state will be returned. Note that hardware
605 * limitations may prevent the actual settings from matching the requested
606 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
607 * was requested. An exception is when the shutdown parameter is true.
608 * The last used operational parameters will be returned, but the actual
609 * state of the hardware be different to minimize power consumption and
610 * processing when shutdown is true.
612 struct v4l2_subdev_ir_ops {
614 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
617 int (*rx_g_parameters)(struct v4l2_subdev *sd,
618 struct v4l2_subdev_ir_parameters *params);
619 int (*rx_s_parameters)(struct v4l2_subdev *sd,
620 struct v4l2_subdev_ir_parameters *params);
623 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
626 int (*tx_g_parameters)(struct v4l2_subdev *sd,
627 struct v4l2_subdev_ir_parameters *params);
628 int (*tx_s_parameters)(struct v4l2_subdev *sd,
629 struct v4l2_subdev_ir_parameters *params);
633 * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
635 * @try_fmt: &struct v4l2_mbus_framefmt
636 * @try_crop: &struct v4l2_rect to be used for crop
637 * @try_compose: &struct v4l2_rect to be used for compose
639 * This structure only needs to be passed to the pad op if the 'which' field
640 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
641 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
643 struct v4l2_subdev_pad_config {
644 struct v4l2_mbus_framefmt try_fmt;
645 struct v4l2_rect try_crop;
646 struct v4l2_rect try_compose;
650 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
652 * @init_cfg: initialize the pad config to default values
653 * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler
655 * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler
658 * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl
661 * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code.
663 * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code.
665 * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code.
667 * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code.
669 * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code.
671 * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code.
673 * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler
676 * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler
679 * @link_validate: used by the media controller code to check if the links
680 * that belongs to a pipeline can be used for stream.
682 * @get_frame_desc: get the current low level media bus frame parameters.
684 * @set_frame_desc: set the low level media bus frame parameters, @fd array
685 * may be adjusted by the subdev driver to device capabilities.
687 struct v4l2_subdev_pad_ops {
688 int (*init_cfg)(struct v4l2_subdev *sd,
689 struct v4l2_subdev_pad_config *cfg);
690 int (*enum_mbus_code)(struct v4l2_subdev *sd,
691 struct v4l2_subdev_pad_config *cfg,
692 struct v4l2_subdev_mbus_code_enum *code);
693 int (*enum_frame_size)(struct v4l2_subdev *sd,
694 struct v4l2_subdev_pad_config *cfg,
695 struct v4l2_subdev_frame_size_enum *fse);
696 int (*enum_frame_interval)(struct v4l2_subdev *sd,
697 struct v4l2_subdev_pad_config *cfg,
698 struct v4l2_subdev_frame_interval_enum *fie);
699 int (*get_fmt)(struct v4l2_subdev *sd,
700 struct v4l2_subdev_pad_config *cfg,
701 struct v4l2_subdev_format *format);
702 int (*set_fmt)(struct v4l2_subdev *sd,
703 struct v4l2_subdev_pad_config *cfg,
704 struct v4l2_subdev_format *format);
705 int (*get_selection)(struct v4l2_subdev *sd,
706 struct v4l2_subdev_pad_config *cfg,
707 struct v4l2_subdev_selection *sel);
708 int (*set_selection)(struct v4l2_subdev *sd,
709 struct v4l2_subdev_pad_config *cfg,
710 struct v4l2_subdev_selection *sel);
711 int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
712 int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
713 int (*dv_timings_cap)(struct v4l2_subdev *sd,
714 struct v4l2_dv_timings_cap *cap);
715 int (*enum_dv_timings)(struct v4l2_subdev *sd,
716 struct v4l2_enum_dv_timings *timings);
717 #ifdef CONFIG_MEDIA_CONTROLLER
718 int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
719 struct v4l2_subdev_format *source_fmt,
720 struct v4l2_subdev_format *sink_fmt);
721 #endif /* CONFIG_MEDIA_CONTROLLER */
722 int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
723 struct v4l2_mbus_frame_desc *fd);
724 int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
725 struct v4l2_mbus_frame_desc *fd);
729 * struct v4l2_subdev_ops - Subdev operations
731 * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL
732 * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL
733 * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL
734 * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL
735 * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL
736 * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL
737 * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL
738 * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL
740 struct v4l2_subdev_ops {
741 const struct v4l2_subdev_core_ops *core;
742 const struct v4l2_subdev_tuner_ops *tuner;
743 const struct v4l2_subdev_audio_ops *audio;
744 const struct v4l2_subdev_video_ops *video;
745 const struct v4l2_subdev_vbi_ops *vbi;
746 const struct v4l2_subdev_ir_ops *ir;
747 const struct v4l2_subdev_sensor_ops *sensor;
748 const struct v4l2_subdev_pad_ops *pad;
752 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
754 * @registered: called when this subdev is registered. When called the v4l2_dev
755 * field is set to the correct v4l2_device.
757 * @unregistered: called when this subdev is unregistered. When called the
758 * v4l2_dev field is still set to the correct v4l2_device.
760 * @open: called when the subdev device node is opened by an application.
762 * @close: called when the subdev device node is closed.
765 * Never call this from drivers, only the v4l2 framework can call
768 struct v4l2_subdev_internal_ops {
769 int (*registered)(struct v4l2_subdev *sd);
770 void (*unregistered)(struct v4l2_subdev *sd);
771 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
772 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
775 #define V4L2_SUBDEV_NAME_SIZE 32
777 /* Set this flag if this subdev is a i2c device. */
778 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
779 /* Set this flag if this subdev is a spi device. */
780 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
781 /* Set this flag if this subdev needs a device node. */
782 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
783 /* Set this flag if this subdev generates events. */
784 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
786 struct regulator_bulk_data;
789 * struct v4l2_subdev_platform_data - regulators config struct
791 * @regulators: Optional regulators used to power on/off the subdevice
792 * @num_regulators: Number of regululators
793 * @host_priv: Per-subdevice data, specific for a certain video host device
795 struct v4l2_subdev_platform_data {
796 struct regulator_bulk_data *regulators;
803 * struct v4l2_subdev - describes a V4L2 sub-device
805 * @entity: pointer to &struct media_entity
806 * @list: List of sub-devices
807 * @owner: The owner is the same as the driver's &struct device owner.
808 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
809 * owner. Initialized by v4l2_device_register_subdev().
810 * @flags: subdev flags. Can be:
811 * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
812 * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
813 * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
815 * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates
818 * @v4l2_dev: pointer to struct &v4l2_device
819 * @ops: pointer to struct &v4l2_subdev_ops
820 * @internal_ops: pointer to struct &v4l2_subdev_internal_ops.
821 * Never call these internal ops from within a driver!
822 * @ctrl_handler: The control handler of this subdev. May be NULL.
823 * @name: Name of the sub-device. Please notice that the name must be unique.
824 * @grp_id: can be used to group similar subdevs. Value is driver-specific
825 * @dev_priv: pointer to private data
826 * @host_priv: pointer to private data used by the device where the subdev
828 * @devnode: subdev device node
829 * @dev: pointer to the physical device, if any
830 * @fwnode: The fwnode_handle of the subdev, usually the same as
831 * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
832 * @async_list: Links this subdev to a global subdev_list or @notifier->done
834 * @asd: Pointer to respective &struct v4l2_async_subdev.
835 * @notifier: Pointer to the managing notifier.
836 * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
837 * device using v4l2_device_register_sensor_subdev().
838 * @pdata: common part of subdevice platform data
840 * Each instance of a subdev driver should create this struct, either
841 * stand-alone or embedded in a larger struct.
843 * This structure should be initialized by v4l2_subdev_init() or one of
844 * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init().
847 #if defined(CONFIG_MEDIA_CONTROLLER)
848 struct media_entity entity;
850 struct list_head list;
851 struct module *owner;
854 struct v4l2_device *v4l2_dev;
855 const struct v4l2_subdev_ops *ops;
856 const struct v4l2_subdev_internal_ops *internal_ops;
857 struct v4l2_ctrl_handler *ctrl_handler;
858 char name[V4L2_SUBDEV_NAME_SIZE];
862 struct video_device *devnode;
864 struct fwnode_handle *fwnode;
865 struct list_head async_list;
866 struct v4l2_async_subdev *asd;
867 struct v4l2_async_notifier *notifier;
868 struct v4l2_async_notifier *subdev_notifier;
869 struct v4l2_subdev_platform_data *pdata;
874 * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
875 * the &struct media_entity embedded in it.
877 * @ent: pointer to &struct media_entity.
879 #define media_entity_to_v4l2_subdev(ent) \
881 typeof(ent) __me_sd_ent = (ent); \
884 container_of(__me_sd_ent, struct v4l2_subdev, entity) : \
889 * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
890 * the &struct video_device embedded on it.
892 * @vdev: pointer to &struct video_device
894 #define vdev_to_v4l2_subdev(vdev) \
895 ((struct v4l2_subdev *)video_get_drvdata(vdev))
898 * struct v4l2_subdev_fh - Used for storing subdev information per file handle
900 * @vfh: pointer to &struct v4l2_fh
901 * @pad: pointer to &struct v4l2_subdev_pad_config
903 struct v4l2_subdev_fh {
905 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
906 struct v4l2_subdev_pad_config *pad;
911 * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
912 * the &struct v4l2_fh embedded on it.
914 * @fh: pointer to &struct v4l2_fh
916 #define to_v4l2_subdev_fh(fh) \
917 container_of(fh, struct v4l2_subdev_fh, vfh)
919 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
922 * v4l2_subdev_get_try_format - ancillary routine to call
923 * &struct v4l2_subdev_pad_config->try_fmt
925 * @sd: pointer to &struct v4l2_subdev
926 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
927 * @pad: index of the pad in the @cfg array.
929 static inline struct v4l2_mbus_framefmt
930 *v4l2_subdev_get_try_format(struct v4l2_subdev *sd,
931 struct v4l2_subdev_pad_config *cfg,
934 if (WARN_ON(pad >= sd->entity.num_pads))
936 return &cfg[pad].try_fmt;
940 * v4l2_subdev_get_try_crop - ancillary routine to call
941 * &struct v4l2_subdev_pad_config->try_crop
943 * @sd: pointer to &struct v4l2_subdev
944 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
945 * @pad: index of the pad in the @cfg array.
947 static inline struct v4l2_rect
948 *v4l2_subdev_get_try_crop(struct v4l2_subdev *sd,
949 struct v4l2_subdev_pad_config *cfg,
952 if (WARN_ON(pad >= sd->entity.num_pads))
954 return &cfg[pad].try_crop;
958 * v4l2_subdev_get_try_crop - ancillary routine to call
959 * &struct v4l2_subdev_pad_config->try_compose
961 * @sd: pointer to &struct v4l2_subdev
962 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
963 * @pad: index of the pad in the @cfg array.
965 static inline struct v4l2_rect
966 *v4l2_subdev_get_try_compose(struct v4l2_subdev *sd,
967 struct v4l2_subdev_pad_config *cfg,
970 if (WARN_ON(pad >= sd->entity.num_pads))
972 return &cfg[pad].try_compose;
976 extern const struct v4l2_file_operations v4l2_subdev_fops;
979 * v4l2_set_subdevdata - Sets V4L2 dev private device data
981 * @sd: pointer to &struct v4l2_subdev
982 * @p: pointer to the private device data to be stored.
984 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
990 * v4l2_get_subdevdata - Gets V4L2 dev private device data
992 * @sd: pointer to &struct v4l2_subdev
994 * Returns the pointer to the private device data to be stored.
996 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
1002 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1004 * @sd: pointer to &struct v4l2_subdev
1005 * @p: pointer to the private data to be stored.
1007 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
1013 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1015 * @sd: pointer to &struct v4l2_subdev
1017 * Returns the pointer to the private host data to be stored.
1019 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
1021 return sd->host_priv;
1024 #ifdef CONFIG_MEDIA_CONTROLLER
1027 * v4l2_subdev_link_validate_default - validates a media link
1029 * @sd: pointer to &struct v4l2_subdev
1030 * @link: pointer to &struct media_link
1031 * @source_fmt: pointer to &struct v4l2_subdev_format
1032 * @sink_fmt: pointer to &struct v4l2_subdev_format
1034 * This function ensures that width, height and the media bus pixel
1035 * code are equal on both source and sink of the link.
1037 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
1038 struct media_link *link,
1039 struct v4l2_subdev_format *source_fmt,
1040 struct v4l2_subdev_format *sink_fmt);
1043 * v4l2_subdev_link_validate - validates a media link
1045 * @link: pointer to &struct media_link
1047 * This function calls the subdev's link_validate ops to validate
1048 * if a media link is valid for streaming. It also internally
1049 * calls v4l2_subdev_link_validate_default() to ensure that
1050 * width, height and the media bus pixel code are equal on both
1051 * source and sink of the link.
1053 int v4l2_subdev_link_validate(struct media_link *link);
1056 * v4l2_subdev_alloc_pad_config - Allocates memory for pad config
1058 * @sd: pointer to struct v4l2_subdev
1061 v4l2_subdev_pad_config *v4l2_subdev_alloc_pad_config(struct v4l2_subdev *sd);
1064 * v4l2_subdev_free_pad_config - Frees memory allocated by
1065 * v4l2_subdev_alloc_pad_config().
1067 * @cfg: pointer to &struct v4l2_subdev_pad_config
1069 void v4l2_subdev_free_pad_config(struct v4l2_subdev_pad_config *cfg);
1070 #endif /* CONFIG_MEDIA_CONTROLLER */
1073 * v4l2_subdev_init - initializes the sub-device struct
1075 * @sd: pointer to the &struct v4l2_subdev to be initialized
1076 * @ops: pointer to &struct v4l2_subdev_ops.
1078 void v4l2_subdev_init(struct v4l2_subdev *sd,
1079 const struct v4l2_subdev_ops *ops);
1082 * v4l2_subdev_call - call an operation of a v4l2_subdev.
1084 * @sd: pointer to the &struct v4l2_subdev
1085 * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1086 * Each element there groups a set of callbacks functions.
1087 * @f: callback function that will be called if @cond matches.
1088 * The callback functions are defined in groups, according to
1089 * each element at &struct v4l2_subdev_ops.
1090 * @args...: arguments for @f.
1092 * Example: err = v4l2_subdev_call(sd, video, s_std, norm);
1094 #define v4l2_subdev_call(sd, o, f, args...) \
1098 __result = -ENODEV; \
1099 else if (!((sd)->ops->o && (sd)->ops->o->f)) \
1100 __result = -ENOIOCTLCMD; \
1102 __result = (sd)->ops->o->f((sd), ##args); \
1107 * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1109 * @sd: pointer to the &struct v4l2_subdev
1110 * @o: The group of callback functions in &struct v4l2_subdev_ops
1111 * which @f is a part of.
1112 * @f: callback function to be checked for its existence.
1114 #define v4l2_subdev_has_op(sd, o, f) \
1115 ((sd)->ops->o && (sd)->ops->o->f)
1118 * v4l2_subdev_notify_event() - Delivers event notification for subdevice
1119 * @sd: The subdev for which to deliver the event
1120 * @ev: The event to deliver
1122 * Will deliver the specified event to all userspace event listeners which are
1123 * subscribed to the v42l subdev event queue as well as to the bridge driver
1124 * using the notify callback. The notification type for the notify callback
1125 * will be %V4L2_DEVICE_NOTIFY_EVENT.
1127 void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
1128 const struct v4l2_event *ev);