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.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef _V4L2_SUBDEV_H
22 #define _V4L2_SUBDEV_H
24 #include <linux/types.h>
25 #include <linux/v4l2-subdev.h>
26 #include <media/media-entity.h>
27 #include <media/v4l2-async.h>
28 #include <media/v4l2-common.h>
29 #include <media/v4l2-dev.h>
30 #include <media/v4l2-fh.h>
31 #include <media/v4l2-mediabus.h>
33 /* generic v4l2_device notify callback notification values */
34 #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32)
35 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001
36 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002
37 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004
38 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008
40 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32)
41 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001
43 #define V4L2_DEVICE_NOTIFY_EVENT _IOW('v', 2, struct v4l2_event)
46 struct v4l2_ctrl_handler;
48 struct v4l2_event_subscription;
51 struct v4l2_subdev_fh;
53 struct v4l2_mbus_frame_desc;
56 struct v4l2_decode_vbi_line {
57 u32 is_second_field; /* Set to 0 for the first (odd) field,
58 set to 1 for the second (even) field. */
59 u8 *p; /* Pointer to the sliced VBI data from the decoder.
60 On exit points to the start of the payload. */
61 u32 line; /* Line number of the sliced VBI data (1-23) */
62 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
65 /* Sub-devices are devices that are connected somehow to the main bridge
66 device. These devices are usually audio/video muxers/encoders/decoders or
67 sensors and webcam controllers.
69 Usually these devices are controlled through an i2c bus, but other busses
72 The v4l2_subdev struct provides a way of accessing these devices in a
73 generic manner. Most operations that these sub-devices support fall in
74 a few categories: core ops, audio ops, video ops and tuner ops.
76 More categories can be added if needed, although this should remain a
77 limited set (no more than approx. 8 categories).
79 Each category has its own set of ops that subdev drivers can implement.
81 A subdev driver can leave the pointer to the category ops NULL if
82 it does not implement them (e.g. an audio subdev will generally not
83 implement the video category ops). The exception is the core category:
84 this must always be present.
86 These ops are all used internally so it is no problem to change, remove
87 or add ops or move ops from one to another category. Currently these
88 ops are based on the original ioctls, but since ops are not limited to
89 one argument there is room for improvement here once all i2c subdev
90 drivers are converted to use these ops.
93 /* Core ops: it is highly recommended to implement at least these ops:
99 This provides basic debugging support.
101 The ioctl ops is meant for generic ioctl-like commands. Depending on
102 the use-case it might be better to use subdev-specific ops (currently
103 not yet implemented) since ops provide proper type-checking.
106 /* Subdevice external IO pin configuration */
107 #define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */
108 #define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1)
109 #define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2)
110 #define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */
111 #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */
113 struct v4l2_subdev_io_pin_config {
114 u32 flags; /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */
115 u8 pin; /* Chip external IO pin to configure */
116 u8 function; /* Internal signal pad/function to route to IO pin */
117 u8 value; /* Initial value for pin - e.g. GPIO output value */
118 u8 strength; /* Pin drive strength */
122 * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs
124 * @log_status: callback for VIDIOC_LOG_STATUS ioctl handler code.
126 * @s_io_pin_config: configure one or more chip I/O pins for chips that
127 * multiplex different internal signal pads out to IO pins. This function
128 * takes a pointer to an array of 'n' pin configuration entries, one for
129 * each pin being configured. This function could be called at times
130 * other than just subdevice initialization.
132 * @init: initialize the sensor registers to some sort of reasonable default
133 * values. Do not use for new drivers and should be removed in existing
136 * @load_fw: load firmware.
138 * @reset: generic reset command. The argument selects which subsystems to
139 * reset. Passing 0 will always reset the whole chip. Do not use for new
140 * drivers without discussing this first on the linux-media mailinglist.
141 * There should be no reason normally to reset a device.
143 * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with
144 * a direction argument if needed.
146 * @queryctrl: callback for VIDIOC_QUERYCTL ioctl handler code.
148 * @g_ctrl: callback for VIDIOC_G_CTRL ioctl handler code.
150 * @s_ctrl: callback for VIDIOC_S_CTRL ioctl handler code.
152 * @g_ext_ctrls: callback for VIDIOC_G_EXT_CTRLS ioctl handler code.
154 * @s_ext_ctrls: callback for VIDIOC_S_EXT_CTRLS ioctl handler code.
156 * @try_ext_ctrls: callback for VIDIOC_TRY_EXT_CTRLS ioctl handler code.
158 * @querymenu: callback for VIDIOC_QUERYMENU ioctl handler code.
160 * @g_register: callback for VIDIOC_G_REGISTER ioctl handler code.
162 * @s_register: callback for VIDIOC_G_REGISTER ioctl handler code.
164 * @s_power: puts subdevice in power saving mode (on == 0) or normal operation
167 * @interrupt_service_routine: Called by the bridge chip's interrupt service
168 * handler, when an interrupt status has be raised due to this subdev,
169 * so that this subdev can handle the details. It may schedule work to be
170 * performed later. It must not sleep. *Called from an IRQ context*.
172 struct v4l2_subdev_core_ops {
173 int (*log_status)(struct v4l2_subdev *sd);
174 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
175 struct v4l2_subdev_io_pin_config *pincfg);
176 int (*init)(struct v4l2_subdev *sd, u32 val);
177 int (*load_fw)(struct v4l2_subdev *sd);
178 int (*reset)(struct v4l2_subdev *sd, u32 val);
179 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
180 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
181 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
182 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
183 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
184 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
185 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
186 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
187 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
189 long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,
192 #ifdef CONFIG_VIDEO_ADV_DEBUG
193 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
194 int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg);
196 int (*s_power)(struct v4l2_subdev *sd, int on);
197 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
198 u32 status, bool *handled);
199 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
200 struct v4l2_event_subscription *sub);
201 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
202 struct v4l2_event_subscription *sub);
206 * struct s_radio - Callbacks used when v4l device was opened in radio mode.
208 * @s_radio: callback for VIDIOC_S_RADIO ioctl handler code.
210 * @s_frequency: callback for VIDIOC_S_FREQUENCY ioctl handler code.
212 * @g_frequency: callback for VIDIOC_G_FREQUENCY ioctl handler code.
213 * freq->type must be filled in. Normally done by video_ioctl2
214 * or the bridge driver.
216 * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS ioctl handler code.
218 * @g_tuner: callback for VIDIOC_G_TUNER ioctl handler code.
220 * @s_tuner: callback for VIDIOC_S_TUNER ioctl handler code. vt->type must be
221 * filled in. Normally done by video_ioctl2 or the
224 * @g_modulator: callback for VIDIOC_G_MODULATOR ioctl handler code.
226 * @s_modulator: callback for VIDIOC_S_MODULATOR ioctl handler code.
228 * @s_type_addr: sets tuner type and its I2C addr.
230 * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
232 struct v4l2_subdev_tuner_ops {
233 int (*s_radio)(struct v4l2_subdev *sd);
234 int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);
235 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
236 int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);
237 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
238 int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);
239 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
240 int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);
241 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
242 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
246 * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
248 * @s_clock_freq: set the frequency (in Hz) of the audio clock output.
249 * Used to slave an audio processor to the video decoder, ensuring that
250 * audio and video remain synchronized. Usual values for the frequency
251 * are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
252 * -EINVAL is returned.
254 * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
255 * way to select I2S clock used by driving digital audio streams at some
256 * board designs. Usual values for the frequency are 1024000 and 2048000.
257 * If the frequency is not supported, then -EINVAL is returned.
259 * @s_routing: used to define the input and/or output pins of an audio chip,
260 * and any additional configuration data.
261 * Never attempt to use user-level input IDs (e.g. Composite, S-Video,
262 * Tuner) at this level. An i2c device shouldn't know about whether an
263 * input pin is connected to a Composite connector, become on another
264 * board or platform it might be connected to something else entirely.
265 * The calling driver is responsible for mapping a user-level input to
266 * the right pins on the i2c device.
268 struct v4l2_subdev_audio_ops {
269 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
270 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
271 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
272 int (*s_stream)(struct v4l2_subdev *sd, int enable);
275 /* Indicates the @length field specifies maximum data length. */
276 #define V4L2_MBUS_FRAME_DESC_FL_LEN_MAX (1U << 0)
278 * Indicates that the format does not have line offsets, i.e. the
279 * receiver should use 1D DMA.
281 #define V4L2_MBUS_FRAME_DESC_FL_BLOB (1U << 1)
284 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
286 * @flags: V4L2_MBUS_FRAME_DESC_FL_* flags
287 * @pixelcode: media bus pixel code, valid if FRAME_DESC_FL_BLOB is not set
288 * @length: number of octets per frame, valid if V4L2_MBUS_FRAME_DESC_FL_BLOB
291 struct v4l2_mbus_frame_desc_entry {
297 #define V4L2_FRAME_DESC_ENTRY_MAX 4
300 * struct v4l2_mbus_frame_desc - media bus data frame description
301 * @entry: frame descriptors array
302 * @num_entries: number of entries in @entry array
304 struct v4l2_mbus_frame_desc {
305 struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
306 unsigned short num_entries;
310 * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
313 * @s_routing: see s_routing in audio_ops, except this version is for video
316 * @s_crystal_freq: sets the frequency of the crystal used to generate the
317 * clocks in Hz. An extra flags field allows device specific configuration
318 * regarding clock frequency dividers, etc. If not used, then set flags
319 * to 0. If the frequency is not supported, then -EINVAL is returned.
321 * @g_std: callback for VIDIOC_G_STD ioctl handler code.
323 * @s_std: callback for VIDIOC_S_STD ioctl handler code.
325 * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
326 * video input devices.
328 * @g_std_output: get current standard for video OUTPUT devices. This is ignored
329 * by video input devices.
331 * @querystd: callback for VIDIOC_QUERYSTD ioctl handler code.
333 * @g_tvnorms: get v4l2_std_id with all standards supported by the video
334 * CAPTURE device. This is ignored by video output devices.
336 * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
337 * OUTPUT device. This is ignored by video capture devices.
339 * @g_input_status: get input status. Same as the status field in the v4l2_input
342 * @cropcap: callback for VIDIOC_CROPCAP ioctl handler code.
344 * @g_crop: callback for VIDIOC_G_CROP ioctl handler code.
346 * @s_crop: callback for VIDIOC_S_CROP ioctl handler code.
348 * @g_parm: callback for VIDIOC_G_PARM ioctl handler code.
350 * @s_parm: callback for VIDIOC_S_PARM ioctl handler code.
352 * @g_frame_interval: callback for VIDIOC_G_FRAMEINTERVAL ioctl handler code.
354 * @s_frame_interval: callback for VIDIOC_S_FRAMEINTERVAL ioctl handler code.
356 * @s_dv_timings: Set custom dv timings in the sub device. This is used
357 * when sub device is capable of setting detailed timing information
358 * in the hardware to generate/detect the video signal.
360 * @g_dv_timings: Get custom dv timings in the sub device.
362 * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS ioctl handler code.
364 * @g_mbus_config: get supported mediabus configurations
366 * @s_mbus_config: set a certain mediabus configuration. This operation is added
367 * for compatibility with soc-camera drivers and should not be used by new
370 * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
371 * can adjust @size to a lower value and must not write more data to the
372 * buffer starting at @data than the original value of @size.
374 struct v4l2_subdev_video_ops {
375 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
376 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
377 int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
378 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
379 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
380 int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
381 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
382 int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
383 int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
384 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
385 int (*s_stream)(struct v4l2_subdev *sd, int enable);
386 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
387 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
388 int (*s_crop)(struct v4l2_subdev *sd, const struct v4l2_crop *crop);
389 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
390 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
391 int (*g_frame_interval)(struct v4l2_subdev *sd,
392 struct v4l2_subdev_frame_interval *interval);
393 int (*s_frame_interval)(struct v4l2_subdev *sd,
394 struct v4l2_subdev_frame_interval *interval);
395 int (*s_dv_timings)(struct v4l2_subdev *sd,
396 struct v4l2_dv_timings *timings);
397 int (*g_dv_timings)(struct v4l2_subdev *sd,
398 struct v4l2_dv_timings *timings);
399 int (*query_dv_timings)(struct v4l2_subdev *sd,
400 struct v4l2_dv_timings *timings);
401 int (*g_mbus_config)(struct v4l2_subdev *sd,
402 struct v4l2_mbus_config *cfg);
403 int (*s_mbus_config)(struct v4l2_subdev *sd,
404 const struct v4l2_mbus_config *cfg);
405 int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
410 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
411 * in video mode via the vbi device node.
413 * @decode_vbi_line: video decoders that support sliced VBI need to implement
414 * this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
415 * start of the VBI data that was generated by the decoder. The driver
416 * then parses the sliced VBI data and sets the other fields in the
417 * struct accordingly. The pointer p is updated to point to the start of
418 * the payload which can be copied verbatim into the data field of the
419 * v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
420 * type field is set to 0 on return.
422 * @s_vbi_data: used to generate VBI signals on a video signal.
423 * v4l2_sliced_vbi_data is filled with the data packets that should be
424 * output. Note that if you set the line field to 0, then that VBI signal
425 * is disabled. If no valid VBI data was found, then the type field is
426 * set to 0 on return.
428 * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
429 * Not all video decoders support this. If no data is available because
430 * the readback register contains invalid or erroneous data -EIO is
431 * returned. Note that you must fill in the 'id' member and the 'field'
432 * member (to determine whether CC data from the first or second field
433 * should be obtained).
435 * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
437 * @g_sliced_fmt: retrieve the current sliced VBI settings.
439 * @s_sliced_fmt: setup the sliced VBI settings.
441 struct v4l2_subdev_vbi_ops {
442 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
443 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
444 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
445 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
446 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
447 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
448 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
452 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
453 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
454 * This is needed for some sensors, which always corrupt
455 * several top lines of the output image, or which send their
457 * @g_skip_frames: number of frames to skip at stream start. This is needed for
458 * buggy sensors that generate faulty frames when they are
461 struct v4l2_subdev_sensor_ops {
462 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
463 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
467 [rt]x_g_parameters: Get the current operating parameters and state of the
468 the IR receiver or transmitter.
470 [rt]x_s_parameters: Set the current operating parameters and state of the
471 the IR receiver or transmitter. It is recommended to call
472 [rt]x_g_parameters first to fill out the current state, and only change
473 the fields that need to be changed. Upon return, the actual device
474 operating parameters and state will be returned. Note that hardware
475 limitations may prevent the actual settings from matching the requested
476 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
477 was requested. An exception is when the shutdown parameter is true.
478 The last used operational parameters will be returned, but the actual
479 state of the hardware be different to minimize power consumption and
480 processing when shutdown is true.
482 rx_read: Reads received codes or pulse width data.
483 The semantics are similar to a non-blocking read() call.
485 tx_write: Writes codes or pulse width data for transmission.
486 The semantics are similar to a non-blocking write() call.
489 enum v4l2_subdev_ir_mode {
490 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
493 struct v4l2_subdev_ir_parameters {
494 /* Either Rx or Tx */
495 unsigned int bytes_per_data_element; /* of data in read or write call */
496 enum v4l2_subdev_ir_mode mode;
499 bool interrupt_enable;
500 bool shutdown; /* true: set hardware to low/no power, false: normal */
502 bool modulation; /* true: uses carrier, false: baseband */
503 u32 max_pulse_width; /* ns, valid only for baseband signal */
504 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
505 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
506 bool invert_level; /* invert signal level */
509 bool invert_carrier_sense; /* Send 0/space as a carrier burst */
512 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
513 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
514 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
515 u32 resolution; /* ns */
518 struct v4l2_subdev_ir_ops {
520 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
523 int (*rx_g_parameters)(struct v4l2_subdev *sd,
524 struct v4l2_subdev_ir_parameters *params);
525 int (*rx_s_parameters)(struct v4l2_subdev *sd,
526 struct v4l2_subdev_ir_parameters *params);
529 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
532 int (*tx_g_parameters)(struct v4l2_subdev *sd,
533 struct v4l2_subdev_ir_parameters *params);
534 int (*tx_s_parameters)(struct v4l2_subdev *sd,
535 struct v4l2_subdev_ir_parameters *params);
539 * Used for storing subdev pad information. This structure only needs
540 * to be passed to the pad op if the 'which' field of the main argument
541 * is set to V4L2_SUBDEV_FORMAT_TRY. For V4L2_SUBDEV_FORMAT_ACTIVE it is
544 struct v4l2_subdev_pad_config {
545 struct v4l2_mbus_framefmt try_fmt;
546 struct v4l2_rect try_crop;
547 struct v4l2_rect try_compose;
551 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
552 * @get_frame_desc: get the current low level media bus frame parameters.
553 * @get_frame_desc: set the low level media bus frame parameters, @fd array
554 * may be adjusted by the subdev driver to device capabilities.
556 struct v4l2_subdev_pad_ops {
557 int (*enum_mbus_code)(struct v4l2_subdev *sd,
558 struct v4l2_subdev_pad_config *cfg,
559 struct v4l2_subdev_mbus_code_enum *code);
560 int (*enum_frame_size)(struct v4l2_subdev *sd,
561 struct v4l2_subdev_pad_config *cfg,
562 struct v4l2_subdev_frame_size_enum *fse);
563 int (*enum_frame_interval)(struct v4l2_subdev *sd,
564 struct v4l2_subdev_pad_config *cfg,
565 struct v4l2_subdev_frame_interval_enum *fie);
566 int (*get_fmt)(struct v4l2_subdev *sd,
567 struct v4l2_subdev_pad_config *cfg,
568 struct v4l2_subdev_format *format);
569 int (*set_fmt)(struct v4l2_subdev *sd,
570 struct v4l2_subdev_pad_config *cfg,
571 struct v4l2_subdev_format *format);
572 int (*get_selection)(struct v4l2_subdev *sd,
573 struct v4l2_subdev_pad_config *cfg,
574 struct v4l2_subdev_selection *sel);
575 int (*set_selection)(struct v4l2_subdev *sd,
576 struct v4l2_subdev_pad_config *cfg,
577 struct v4l2_subdev_selection *sel);
578 int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
579 int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
580 int (*dv_timings_cap)(struct v4l2_subdev *sd,
581 struct v4l2_dv_timings_cap *cap);
582 int (*enum_dv_timings)(struct v4l2_subdev *sd,
583 struct v4l2_enum_dv_timings *timings);
584 #ifdef CONFIG_MEDIA_CONTROLLER
585 int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
586 struct v4l2_subdev_format *source_fmt,
587 struct v4l2_subdev_format *sink_fmt);
588 #endif /* CONFIG_MEDIA_CONTROLLER */
589 int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
590 struct v4l2_mbus_frame_desc *fd);
591 int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
592 struct v4l2_mbus_frame_desc *fd);
595 struct v4l2_subdev_ops {
596 const struct v4l2_subdev_core_ops *core;
597 const struct v4l2_subdev_tuner_ops *tuner;
598 const struct v4l2_subdev_audio_ops *audio;
599 const struct v4l2_subdev_video_ops *video;
600 const struct v4l2_subdev_vbi_ops *vbi;
601 const struct v4l2_subdev_ir_ops *ir;
602 const struct v4l2_subdev_sensor_ops *sensor;
603 const struct v4l2_subdev_pad_ops *pad;
607 * Internal ops. Never call this from drivers, only the v4l2 framework can call
610 * registered: called when this subdev is registered. When called the v4l2_dev
611 * field is set to the correct v4l2_device.
613 * unregistered: called when this subdev is unregistered. When called the
614 * v4l2_dev field is still set to the correct v4l2_device.
616 * open: called when the subdev device node is opened by an application.
618 * close: called when the subdev device node is closed.
620 struct v4l2_subdev_internal_ops {
621 int (*registered)(struct v4l2_subdev *sd);
622 void (*unregistered)(struct v4l2_subdev *sd);
623 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
624 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
627 #define V4L2_SUBDEV_NAME_SIZE 32
629 /* Set this flag if this subdev is a i2c device. */
630 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
631 /* Set this flag if this subdev is a spi device. */
632 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
633 /* Set this flag if this subdev needs a device node. */
634 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
635 /* Set this flag if this subdev generates events. */
636 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
638 struct regulator_bulk_data;
640 struct v4l2_subdev_platform_data {
641 /* Optional regulators uset to power on/off the subdevice */
642 struct regulator_bulk_data *regulators;
645 /* Per-subdevice data, specific for a certain video host device */
649 /* Each instance of a subdev driver should create this struct, either
650 stand-alone or embedded in a larger struct.
653 #if defined(CONFIG_MEDIA_CONTROLLER)
654 struct media_entity entity;
656 struct list_head list;
657 struct module *owner;
660 struct v4l2_device *v4l2_dev;
661 const struct v4l2_subdev_ops *ops;
662 /* Never call these internal ops from within a driver! */
663 const struct v4l2_subdev_internal_ops *internal_ops;
664 /* The control handler of this subdev. May be NULL. */
665 struct v4l2_ctrl_handler *ctrl_handler;
666 /* name must be unique */
667 char name[V4L2_SUBDEV_NAME_SIZE];
668 /* can be used to group similar subdevs, value is driver-specific */
670 /* pointer to private data */
673 /* subdev device node */
674 struct video_device *devnode;
675 /* pointer to the physical device, if any */
677 /* The device_node of the subdev, usually the same as dev->of_node. */
678 struct device_node *of_node;
679 /* Links this subdev to a global subdev_list or @notifier->done list. */
680 struct list_head async_list;
681 /* Pointer to respective struct v4l2_async_subdev. */
682 struct v4l2_async_subdev *asd;
683 /* Pointer to the managing notifier. */
684 struct v4l2_async_notifier *notifier;
685 /* common part of subdevice platform data */
686 struct v4l2_subdev_platform_data *pdata;
689 #define media_entity_to_v4l2_subdev(ent) \
690 container_of(ent, struct v4l2_subdev, entity)
691 #define vdev_to_v4l2_subdev(vdev) \
692 ((struct v4l2_subdev *)video_get_drvdata(vdev))
695 * Used for storing subdev information per file handle
697 struct v4l2_subdev_fh {
699 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
700 struct v4l2_subdev_pad_config *pad;
704 #define to_v4l2_subdev_fh(fh) \
705 container_of(fh, struct v4l2_subdev_fh, vfh)
707 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
708 #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name) \
709 static inline struct rtype * \
710 fun_name(struct v4l2_subdev *sd, \
711 struct v4l2_subdev_pad_config *cfg, \
714 BUG_ON(pad >= sd->entity.num_pads); \
715 return &cfg[pad].field_name; \
718 __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, v4l2_subdev_get_try_format, try_fmt)
719 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_crop, try_crop)
720 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_compose, try_compose)
723 extern const struct v4l2_file_operations v4l2_subdev_fops;
725 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
730 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
735 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
740 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
742 return sd->host_priv;
745 #ifdef CONFIG_MEDIA_CONTROLLER
746 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
747 struct media_link *link,
748 struct v4l2_subdev_format *source_fmt,
749 struct v4l2_subdev_format *sink_fmt);
750 int v4l2_subdev_link_validate(struct media_link *link);
751 #endif /* CONFIG_MEDIA_CONTROLLER */
752 void v4l2_subdev_init(struct v4l2_subdev *sd,
753 const struct v4l2_subdev_ops *ops);
755 /* Call an ops of a v4l2_subdev, doing the right checks against
758 Example: err = v4l2_subdev_call(sd, video, s_std, norm);
760 #define v4l2_subdev_call(sd, o, f, args...) \
761 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
762 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
764 #define v4l2_subdev_has_op(sd, o, f) \
765 ((sd)->ops->o && (sd)->ops->o->f)
767 void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
768 const struct v4l2_event *ev);