1 /* 2 V4L2 sub-device support header. 3 4 Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl> 5 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. 10 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. 15 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 19 */ 20 21 #ifndef _V4L2_SUBDEV_H 22 #define _V4L2_SUBDEV_H 23 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> 32 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 39 40 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32) 41 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001 42 43 struct v4l2_device; 44 struct v4l2_ctrl_handler; 45 struct v4l2_event_subscription; 46 struct v4l2_fh; 47 struct v4l2_subdev; 48 struct v4l2_subdev_fh; 49 struct tuner_setup; 50 struct v4l2_mbus_frame_desc; 51 52 /* decode_vbi_line */ 53 struct v4l2_decode_vbi_line { 54 u32 is_second_field; /* Set to 0 for the first (odd) field, 55 set to 1 for the second (even) field. */ 56 u8 *p; /* Pointer to the sliced VBI data from the decoder. 57 On exit points to the start of the payload. */ 58 u32 line; /* Line number of the sliced VBI data (1-23) */ 59 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */ 60 }; 61 62 /* Sub-devices are devices that are connected somehow to the main bridge 63 device. These devices are usually audio/video muxers/encoders/decoders or 64 sensors and webcam controllers. 65 66 Usually these devices are controlled through an i2c bus, but other busses 67 may also be used. 68 69 The v4l2_subdev struct provides a way of accessing these devices in a 70 generic manner. Most operations that these sub-devices support fall in 71 a few categories: core ops, audio ops, video ops and tuner ops. 72 73 More categories can be added if needed, although this should remain a 74 limited set (no more than approx. 8 categories). 75 76 Each category has its own set of ops that subdev drivers can implement. 77 78 A subdev driver can leave the pointer to the category ops NULL if 79 it does not implement them (e.g. an audio subdev will generally not 80 implement the video category ops). The exception is the core category: 81 this must always be present. 82 83 These ops are all used internally so it is no problem to change, remove 84 or add ops or move ops from one to another category. Currently these 85 ops are based on the original ioctls, but since ops are not limited to 86 one argument there is room for improvement here once all i2c subdev 87 drivers are converted to use these ops. 88 */ 89 90 /* Core ops: it is highly recommended to implement at least these ops: 91 92 log_status 93 g_register 94 s_register 95 96 This provides basic debugging support. 97 98 The ioctl ops is meant for generic ioctl-like commands. Depending on 99 the use-case it might be better to use subdev-specific ops (currently 100 not yet implemented) since ops provide proper type-checking. 101 */ 102 103 /* Subdevice external IO pin configuration */ 104 #define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */ 105 #define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1) 106 #define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2) 107 #define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */ 108 #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */ 109 110 struct v4l2_subdev_io_pin_config { 111 u32 flags; /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */ 112 u8 pin; /* Chip external IO pin to configure */ 113 u8 function; /* Internal signal pad/function to route to IO pin */ 114 u8 value; /* Initial value for pin - e.g. GPIO output value */ 115 u8 strength; /* Pin drive strength */ 116 }; 117 118 /* 119 s_io_pin_config: configure one or more chip I/O pins for chips that 120 multiplex different internal signal pads out to IO pins. This function 121 takes a pointer to an array of 'n' pin configuration entries, one for 122 each pin being configured. This function could be called at times 123 other than just subdevice initialization. 124 125 init: initialize the sensor registers to some sort of reasonable default 126 values. Do not use for new drivers and should be removed in existing 127 drivers. 128 129 load_fw: load firmware. 130 131 reset: generic reset command. The argument selects which subsystems to 132 reset. Passing 0 will always reset the whole chip. Do not use for new 133 drivers without discussing this first on the linux-media mailinglist. 134 There should be no reason normally to reset a device. 135 136 s_gpio: set GPIO pins. Very simple right now, might need to be extended with 137 a direction argument if needed. 138 139 s_power: puts subdevice in power saving mode (on == 0) or normal operation 140 mode (on == 1). 141 142 interrupt_service_routine: Called by the bridge chip's interrupt service 143 handler, when an interrupt status has be raised due to this subdev, 144 so that this subdev can handle the details. It may schedule work to be 145 performed later. It must not sleep. *Called from an IRQ context*. 146 */ 147 struct v4l2_subdev_core_ops { 148 int (*log_status)(struct v4l2_subdev *sd); 149 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n, 150 struct v4l2_subdev_io_pin_config *pincfg); 151 int (*init)(struct v4l2_subdev *sd, u32 val); 152 int (*load_fw)(struct v4l2_subdev *sd); 153 int (*reset)(struct v4l2_subdev *sd, u32 val); 154 int (*s_gpio)(struct v4l2_subdev *sd, u32 val); 155 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc); 156 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl); 157 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl); 158 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); 159 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); 160 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); 161 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm); 162 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); 163 #ifdef CONFIG_COMPAT 164 long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd, 165 unsigned long arg); 166 #endif 167 #ifdef CONFIG_VIDEO_ADV_DEBUG 168 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); 169 int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg); 170 #endif 171 int (*s_power)(struct v4l2_subdev *sd, int on); 172 int (*interrupt_service_routine)(struct v4l2_subdev *sd, 173 u32 status, bool *handled); 174 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, 175 struct v4l2_event_subscription *sub); 176 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, 177 struct v4l2_event_subscription *sub); 178 }; 179 180 /* s_radio: v4l device was opened in radio mode. 181 182 g_frequency: freq->type must be filled in. Normally done by video_ioctl2 183 or the bridge driver. 184 185 g_tuner: 186 s_tuner: vt->type must be filled in. Normally done by video_ioctl2 or the 187 bridge driver. 188 189 s_type_addr: sets tuner type and its I2C addr. 190 191 s_config: sets tda9887 specific stuff, like port1, port2 and qss 192 */ 193 struct v4l2_subdev_tuner_ops { 194 int (*s_radio)(struct v4l2_subdev *sd); 195 int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq); 196 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); 197 int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band); 198 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); 199 int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt); 200 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); 201 int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm); 202 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); 203 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); 204 }; 205 206 /* s_clock_freq: set the frequency (in Hz) of the audio clock output. 207 Used to slave an audio processor to the video decoder, ensuring that 208 audio and video remain synchronized. Usual values for the frequency 209 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then 210 -EINVAL is returned. 211 212 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard 213 way to select I2S clock used by driving digital audio streams at some 214 board designs. Usual values for the frequency are 1024000 and 2048000. 215 If the frequency is not supported, then -EINVAL is returned. 216 217 s_routing: used to define the input and/or output pins of an audio chip, 218 and any additional configuration data. 219 Never attempt to use user-level input IDs (e.g. Composite, S-Video, 220 Tuner) at this level. An i2c device shouldn't know about whether an 221 input pin is connected to a Composite connector, become on another 222 board or platform it might be connected to something else entirely. 223 The calling driver is responsible for mapping a user-level input to 224 the right pins on the i2c device. 225 */ 226 struct v4l2_subdev_audio_ops { 227 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 228 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 229 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 230 int (*s_stream)(struct v4l2_subdev *sd, int enable); 231 }; 232 233 /* Indicates the @length field specifies maximum data length. */ 234 #define V4L2_MBUS_FRAME_DESC_FL_LEN_MAX (1U << 0) 235 /* 236 * Indicates that the format does not have line offsets, i.e. the 237 * receiver should use 1D DMA. 238 */ 239 #define V4L2_MBUS_FRAME_DESC_FL_BLOB (1U << 1) 240 241 /** 242 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure 243 * @flags: V4L2_MBUS_FRAME_DESC_FL_* flags 244 * @pixelcode: media bus pixel code, valid if FRAME_DESC_FL_BLOB is not set 245 * @length: number of octets per frame, valid if V4L2_MBUS_FRAME_DESC_FL_BLOB 246 * is set 247 */ 248 struct v4l2_mbus_frame_desc_entry { 249 u16 flags; 250 u32 pixelcode; 251 u32 length; 252 }; 253 254 #define V4L2_FRAME_DESC_ENTRY_MAX 4 255 256 /** 257 * struct v4l2_mbus_frame_desc - media bus data frame description 258 * @entry: frame descriptors array 259 * @num_entries: number of entries in @entry array 260 */ 261 struct v4l2_mbus_frame_desc { 262 struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX]; 263 unsigned short num_entries; 264 }; 265 266 /* 267 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by 268 video input devices. 269 270 g_std_output: get current standard for video OUTPUT devices. This is ignored 271 by video input devices. 272 273 g_tvnorms: get v4l2_std_id with all standards supported by the video 274 CAPTURE device. This is ignored by video output devices. 275 276 g_tvnorms_output: get v4l2_std_id with all standards supported by the video 277 OUTPUT device. This is ignored by video capture devices. 278 279 s_crystal_freq: sets the frequency of the crystal used to generate the 280 clocks in Hz. An extra flags field allows device specific configuration 281 regarding clock frequency dividers, etc. If not used, then set flags 282 to 0. If the frequency is not supported, then -EINVAL is returned. 283 284 g_input_status: get input status. Same as the status field in the v4l2_input 285 struct. 286 287 s_routing: see s_routing in audio_ops, except this version is for video 288 devices. 289 290 s_dv_timings(): Set custom dv timings in the sub device. This is used 291 when sub device is capable of setting detailed timing information 292 in the hardware to generate/detect the video signal. 293 294 g_dv_timings(): Get custom dv timings in the sub device. 295 296 enum_mbus_fmt: enumerate pixel formats, provided by a video data source 297 298 g_mbus_fmt: get the current pixel format, provided by a video data source 299 300 try_mbus_fmt: try to set a pixel format on a video data source 301 302 s_mbus_fmt: set a pixel format on a video data source 303 304 g_mbus_config: get supported mediabus configurations 305 306 s_mbus_config: set a certain mediabus configuration. This operation is added 307 for compatibility with soc-camera drivers and should not be used by new 308 software. 309 310 s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev 311 can adjust @size to a lower value and must not write more data to the 312 buffer starting at @data than the original value of @size. 313 */ 314 struct v4l2_subdev_video_ops { 315 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 316 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags); 317 int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm); 318 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); 319 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); 320 int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std); 321 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); 322 int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std); 323 int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std); 324 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); 325 int (*s_stream)(struct v4l2_subdev *sd, int enable); 326 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc); 327 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop); 328 int (*s_crop)(struct v4l2_subdev *sd, const struct v4l2_crop *crop); 329 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); 330 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); 331 int (*g_frame_interval)(struct v4l2_subdev *sd, 332 struct v4l2_subdev_frame_interval *interval); 333 int (*s_frame_interval)(struct v4l2_subdev *sd, 334 struct v4l2_subdev_frame_interval *interval); 335 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize); 336 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival); 337 int (*s_dv_timings)(struct v4l2_subdev *sd, 338 struct v4l2_dv_timings *timings); 339 int (*g_dv_timings)(struct v4l2_subdev *sd, 340 struct v4l2_dv_timings *timings); 341 int (*query_dv_timings)(struct v4l2_subdev *sd, 342 struct v4l2_dv_timings *timings); 343 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index, 344 enum v4l2_mbus_pixelcode *code); 345 int (*enum_mbus_fsizes)(struct v4l2_subdev *sd, 346 struct v4l2_frmsizeenum *fsize); 347 int (*g_mbus_fmt)(struct v4l2_subdev *sd, 348 struct v4l2_mbus_framefmt *fmt); 349 int (*try_mbus_fmt)(struct v4l2_subdev *sd, 350 struct v4l2_mbus_framefmt *fmt); 351 int (*s_mbus_fmt)(struct v4l2_subdev *sd, 352 struct v4l2_mbus_framefmt *fmt); 353 int (*g_mbus_config)(struct v4l2_subdev *sd, 354 struct v4l2_mbus_config *cfg); 355 int (*s_mbus_config)(struct v4l2_subdev *sd, 356 const struct v4l2_mbus_config *cfg); 357 int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf, 358 unsigned int *size); 359 }; 360 361 /* 362 decode_vbi_line: video decoders that support sliced VBI need to implement 363 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the 364 start of the VBI data that was generated by the decoder. The driver 365 then parses the sliced VBI data and sets the other fields in the 366 struct accordingly. The pointer p is updated to point to the start of 367 the payload which can be copied verbatim into the data field of the 368 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the 369 type field is set to 0 on return. 370 371 s_vbi_data: used to generate VBI signals on a video signal. 372 v4l2_sliced_vbi_data is filled with the data packets that should be 373 output. Note that if you set the line field to 0, then that VBI signal 374 is disabled. If no valid VBI data was found, then the type field is 375 set to 0 on return. 376 377 g_vbi_data: used to obtain the sliced VBI packet from a readback register. 378 Not all video decoders support this. If no data is available because 379 the readback register contains invalid or erroneous data -EIO is 380 returned. Note that you must fill in the 'id' member and the 'field' 381 member (to determine whether CC data from the first or second field 382 should be obtained). 383 384 s_raw_fmt: setup the video encoder/decoder for raw VBI. 385 386 g_sliced_fmt: retrieve the current sliced VBI settings. 387 388 s_sliced_fmt: setup the sliced VBI settings. 389 */ 390 struct v4l2_subdev_vbi_ops { 391 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); 392 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); 393 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); 394 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); 395 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt); 396 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 397 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 398 }; 399 400 /** 401 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations 402 * @g_skip_top_lines: number of lines at the top of the image to be skipped. 403 * This is needed for some sensors, which always corrupt 404 * several top lines of the output image, or which send their 405 * metadata in them. 406 * @g_skip_frames: number of frames to skip at stream start. This is needed for 407 * buggy sensors that generate faulty frames when they are 408 * turned on. 409 */ 410 struct v4l2_subdev_sensor_ops { 411 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines); 412 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames); 413 }; 414 415 /* 416 [rt]x_g_parameters: Get the current operating parameters and state of the 417 the IR receiver or transmitter. 418 419 [rt]x_s_parameters: Set the current operating parameters and state of the 420 the IR receiver or transmitter. It is recommended to call 421 [rt]x_g_parameters first to fill out the current state, and only change 422 the fields that need to be changed. Upon return, the actual device 423 operating parameters and state will be returned. Note that hardware 424 limitations may prevent the actual settings from matching the requested 425 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz 426 was requested. An exception is when the shutdown parameter is true. 427 The last used operational parameters will be returned, but the actual 428 state of the hardware be different to minimize power consumption and 429 processing when shutdown is true. 430 431 rx_read: Reads received codes or pulse width data. 432 The semantics are similar to a non-blocking read() call. 433 434 tx_write: Writes codes or pulse width data for transmission. 435 The semantics are similar to a non-blocking write() call. 436 */ 437 438 enum v4l2_subdev_ir_mode { 439 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */ 440 }; 441 442 struct v4l2_subdev_ir_parameters { 443 /* Either Rx or Tx */ 444 unsigned int bytes_per_data_element; /* of data in read or write call */ 445 enum v4l2_subdev_ir_mode mode; 446 447 bool enable; 448 bool interrupt_enable; 449 bool shutdown; /* true: set hardware to low/no power, false: normal */ 450 451 bool modulation; /* true: uses carrier, false: baseband */ 452 u32 max_pulse_width; /* ns, valid only for baseband signal */ 453 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/ 454 unsigned int duty_cycle; /* percent, valid only for modulated signal*/ 455 bool invert_level; /* invert signal level */ 456 457 /* Tx only */ 458 bool invert_carrier_sense; /* Send 0/space as a carrier burst */ 459 460 /* Rx only */ 461 u32 noise_filter_min_width; /* ns, min time of a valid pulse */ 462 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */ 463 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */ 464 u32 resolution; /* ns */ 465 }; 466 467 struct v4l2_subdev_ir_ops { 468 /* Receiver */ 469 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count, 470 ssize_t *num); 471 472 int (*rx_g_parameters)(struct v4l2_subdev *sd, 473 struct v4l2_subdev_ir_parameters *params); 474 int (*rx_s_parameters)(struct v4l2_subdev *sd, 475 struct v4l2_subdev_ir_parameters *params); 476 477 /* Transmitter */ 478 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count, 479 ssize_t *num); 480 481 int (*tx_g_parameters)(struct v4l2_subdev *sd, 482 struct v4l2_subdev_ir_parameters *params); 483 int (*tx_s_parameters)(struct v4l2_subdev *sd, 484 struct v4l2_subdev_ir_parameters *params); 485 }; 486 487 /** 488 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations 489 * @get_frame_desc: get the current low level media bus frame parameters. 490 * @get_frame_desc: set the low level media bus frame parameters, @fd array 491 * may be adjusted by the subdev driver to device capabilities. 492 */ 493 struct v4l2_subdev_pad_ops { 494 int (*enum_mbus_code)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, 495 struct v4l2_subdev_mbus_code_enum *code); 496 int (*enum_frame_size)(struct v4l2_subdev *sd, 497 struct v4l2_subdev_fh *fh, 498 struct v4l2_subdev_frame_size_enum *fse); 499 int (*enum_frame_interval)(struct v4l2_subdev *sd, 500 struct v4l2_subdev_fh *fh, 501 struct v4l2_subdev_frame_interval_enum *fie); 502 int (*get_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, 503 struct v4l2_subdev_format *format); 504 int (*set_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, 505 struct v4l2_subdev_format *format); 506 int (*set_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, 507 struct v4l2_subdev_crop *crop); 508 int (*get_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, 509 struct v4l2_subdev_crop *crop); 510 int (*get_selection)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, 511 struct v4l2_subdev_selection *sel); 512 int (*set_selection)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, 513 struct v4l2_subdev_selection *sel); 514 int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); 515 int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); 516 int (*dv_timings_cap)(struct v4l2_subdev *sd, 517 struct v4l2_dv_timings_cap *cap); 518 int (*enum_dv_timings)(struct v4l2_subdev *sd, 519 struct v4l2_enum_dv_timings *timings); 520 #ifdef CONFIG_MEDIA_CONTROLLER 521 int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link, 522 struct v4l2_subdev_format *source_fmt, 523 struct v4l2_subdev_format *sink_fmt); 524 #endif /* CONFIG_MEDIA_CONTROLLER */ 525 int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, 526 struct v4l2_mbus_frame_desc *fd); 527 int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, 528 struct v4l2_mbus_frame_desc *fd); 529 }; 530 531 struct v4l2_subdev_ops { 532 const struct v4l2_subdev_core_ops *core; 533 const struct v4l2_subdev_tuner_ops *tuner; 534 const struct v4l2_subdev_audio_ops *audio; 535 const struct v4l2_subdev_video_ops *video; 536 const struct v4l2_subdev_vbi_ops *vbi; 537 const struct v4l2_subdev_ir_ops *ir; 538 const struct v4l2_subdev_sensor_ops *sensor; 539 const struct v4l2_subdev_pad_ops *pad; 540 }; 541 542 /* 543 * Internal ops. Never call this from drivers, only the v4l2 framework can call 544 * these ops. 545 * 546 * registered: called when this subdev is registered. When called the v4l2_dev 547 * field is set to the correct v4l2_device. 548 * 549 * unregistered: called when this subdev is unregistered. When called the 550 * v4l2_dev field is still set to the correct v4l2_device. 551 * 552 * open: called when the subdev device node is opened by an application. 553 * 554 * close: called when the subdev device node is closed. 555 */ 556 struct v4l2_subdev_internal_ops { 557 int (*registered)(struct v4l2_subdev *sd); 558 void (*unregistered)(struct v4l2_subdev *sd); 559 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); 560 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); 561 }; 562 563 #define V4L2_SUBDEV_NAME_SIZE 32 564 565 /* Set this flag if this subdev is a i2c device. */ 566 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0) 567 /* Set this flag if this subdev is a spi device. */ 568 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1) 569 /* Set this flag if this subdev needs a device node. */ 570 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2) 571 /* Set this flag if this subdev generates events. */ 572 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3) 573 574 struct regulator_bulk_data; 575 576 struct v4l2_subdev_platform_data { 577 /* Optional regulators uset to power on/off the subdevice */ 578 struct regulator_bulk_data *regulators; 579 int num_regulators; 580 581 /* Per-subdevice data, specific for a certain video host device */ 582 void *host_priv; 583 }; 584 585 /* Each instance of a subdev driver should create this struct, either 586 stand-alone or embedded in a larger struct. 587 */ 588 struct v4l2_subdev { 589 #if defined(CONFIG_MEDIA_CONTROLLER) 590 struct media_entity entity; 591 #endif 592 struct list_head list; 593 struct module *owner; 594 bool owner_v4l2_dev; 595 u32 flags; 596 struct v4l2_device *v4l2_dev; 597 const struct v4l2_subdev_ops *ops; 598 /* Never call these internal ops from within a driver! */ 599 const struct v4l2_subdev_internal_ops *internal_ops; 600 /* The control handler of this subdev. May be NULL. */ 601 struct v4l2_ctrl_handler *ctrl_handler; 602 /* name must be unique */ 603 char name[V4L2_SUBDEV_NAME_SIZE]; 604 /* can be used to group similar subdevs, value is driver-specific */ 605 u32 grp_id; 606 /* pointer to private data */ 607 void *dev_priv; 608 void *host_priv; 609 /* subdev device node */ 610 struct video_device *devnode; 611 /* pointer to the physical device, if any */ 612 struct device *dev; 613 /* Links this subdev to a global subdev_list or @notifier->done list. */ 614 struct list_head async_list; 615 /* Pointer to respective struct v4l2_async_subdev. */ 616 struct v4l2_async_subdev *asd; 617 /* Pointer to the managing notifier. */ 618 struct v4l2_async_notifier *notifier; 619 /* common part of subdevice platform data */ 620 struct v4l2_subdev_platform_data *pdata; 621 }; 622 623 #define media_entity_to_v4l2_subdev(ent) \ 624 container_of(ent, struct v4l2_subdev, entity) 625 #define vdev_to_v4l2_subdev(vdev) \ 626 ((struct v4l2_subdev *)video_get_drvdata(vdev)) 627 628 /* 629 * Used for storing subdev information per file handle 630 */ 631 struct v4l2_subdev_fh { 632 struct v4l2_fh vfh; 633 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 634 struct { 635 struct v4l2_mbus_framefmt try_fmt; 636 struct v4l2_rect try_crop; 637 struct v4l2_rect try_compose; 638 } *pad; 639 #endif 640 }; 641 642 #define to_v4l2_subdev_fh(fh) \ 643 container_of(fh, struct v4l2_subdev_fh, vfh) 644 645 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 646 #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name) \ 647 static inline struct rtype * \ 648 v4l2_subdev_get_try_##fun_name(struct v4l2_subdev_fh *fh, \ 649 unsigned int pad) \ 650 { \ 651 BUG_ON(pad >= vdev_to_v4l2_subdev( \ 652 fh->vfh.vdev)->entity.num_pads); \ 653 return &fh->pad[pad].field_name; \ 654 } 655 656 __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, format, try_fmt) 657 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, crop, try_crop) 658 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, compose, try_compose) 659 #endif 660 661 extern const struct v4l2_file_operations v4l2_subdev_fops; 662 663 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) 664 { 665 sd->dev_priv = p; 666 } 667 668 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) 669 { 670 return sd->dev_priv; 671 } 672 673 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p) 674 { 675 sd->host_priv = p; 676 } 677 678 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd) 679 { 680 return sd->host_priv; 681 } 682 683 #ifdef CONFIG_MEDIA_CONTROLLER 684 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd, 685 struct media_link *link, 686 struct v4l2_subdev_format *source_fmt, 687 struct v4l2_subdev_format *sink_fmt); 688 int v4l2_subdev_link_validate(struct media_link *link); 689 #endif /* CONFIG_MEDIA_CONTROLLER */ 690 void v4l2_subdev_init(struct v4l2_subdev *sd, 691 const struct v4l2_subdev_ops *ops); 692 693 /* Call an ops of a v4l2_subdev, doing the right checks against 694 NULL pointers. 695 696 Example: err = v4l2_subdev_call(sd, video, s_std, norm); 697 */ 698 #define v4l2_subdev_call(sd, o, f, args...) \ 699 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \ 700 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD)) 701 702 #define v4l2_subdev_has_op(sd, o, f) \ 703 ((sd)->ops->o && (sd)->ops->o->f) 704 705 #endif 706