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