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