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