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