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