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 17 #ifndef _V4L2_SUBDEV_H 18 #define _V4L2_SUBDEV_H 19 20 #include <linux/types.h> 21 #include <linux/v4l2-subdev.h> 22 #include <media/media-entity.h> 23 #include <media/v4l2-async.h> 24 #include <media/v4l2-common.h> 25 #include <media/v4l2-dev.h> 26 #include <media/v4l2-fh.h> 27 #include <media/v4l2-mediabus.h> 28 29 /* generic v4l2_device notify callback notification values */ 30 #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32) 31 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001 32 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002 33 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004 34 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008 35 36 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32) 37 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001 38 39 #define V4L2_DEVICE_NOTIFY_EVENT _IOW('v', 2, struct v4l2_event) 40 41 struct v4l2_device; 42 struct v4l2_ctrl_handler; 43 struct v4l2_event; 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 /** 52 * struct v4l2_decode_vbi_line - used to decode_vbi_line 53 * 54 * @is_second_field: Set to 0 for the first (odd) field; 55 * set to 1 for the second (even) field. 56 * @p: Pointer to the sliced VBI data from the decoder. On exit, points to 57 * the start of the payload. 58 * @line: Line number of the sliced VBI data (1-23) 59 * @type: VBI service type (V4L2_SLICED_*). 0 if no service found 60 */ 61 struct v4l2_decode_vbi_line { 62 u32 is_second_field; 63 u8 *p; 64 u32 line; 65 u32 type; 66 }; 67 68 /* 69 * Sub-devices are devices that are connected somehow to the main bridge 70 * device. These devices are usually audio/video muxers/encoders/decoders or 71 * sensors and webcam controllers. 72 * 73 * Usually these devices are controlled through an i2c bus, but other busses 74 * may also be used. 75 * 76 * The v4l2_subdev struct provides a way of accessing these devices in a 77 * generic manner. Most operations that these sub-devices support fall in 78 * a few categories: core ops, audio ops, video ops and tuner ops. 79 * 80 * More categories can be added if needed, although this should remain a 81 * limited set (no more than approx. 8 categories). 82 * 83 * Each category has its own set of ops that subdev drivers can implement. 84 * 85 * A subdev driver can leave the pointer to the category ops NULL if 86 * it does not implement them (e.g. an audio subdev will generally not 87 * implement the video category ops). The exception is the core category: 88 * this must always be present. 89 * 90 * These ops are all used internally so it is no problem to change, remove 91 * or add ops or move ops from one to another category. Currently these 92 * ops are based on the original ioctls, but since ops are not limited to 93 * one argument there is room for improvement here once all i2c subdev 94 * drivers are converted to use these ops. 95 */ 96 97 /* 98 * Core ops: it is highly recommended to implement at least these ops: 99 * 100 * log_status 101 * g_register 102 * s_register 103 * 104 * This provides basic debugging support. 105 * 106 * The ioctl ops is meant for generic ioctl-like commands. Depending on 107 * the use-case it might be better to use subdev-specific ops (currently 108 * not yet implemented) since ops provide proper type-checking. 109 */ 110 111 /* Subdevice external IO pin configuration */ 112 #define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */ 113 #define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1) 114 #define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2) 115 #define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */ 116 #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */ 117 118 /** 119 * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration 120 * 121 * @flags: bitmask with flags for this pin's config: 122 * %V4L2_SUBDEV_IO_PIN_DISABLE - disables a pin config, 123 * %V4L2_SUBDEV_IO_PIN_OUTPUT - if pin is an output, 124 * %V4L2_SUBDEV_IO_PIN_INPUT - if pin is an input, 125 * %V4L2_SUBDEV_IO_PIN_SET_VALUE - to set the output value via @value 126 * and %V4L2_SUBDEV_IO_PIN_ACTIVE_LOW - if active is 0. 127 * @pin: Chip external IO pin to configure 128 * @function: Internal signal pad/function to route to IO pin 129 * @value: Initial value for pin - e.g. GPIO output value 130 * @strength: Pin drive strength 131 */ 132 struct v4l2_subdev_io_pin_config { 133 u32 flags; 134 u8 pin; 135 u8 function; 136 u8 value; 137 u8 strength; 138 }; 139 140 /** 141 * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs 142 * 143 * @log_status: callback for %VIDIOC_LOG_STATUS ioctl handler code. 144 * 145 * @s_io_pin_config: configure one or more chip I/O pins for chips that 146 * multiplex different internal signal pads out to IO pins. This function 147 * takes a pointer to an array of 'n' pin configuration entries, one for 148 * each pin being configured. This function could be called at times 149 * other than just subdevice initialization. 150 * 151 * @init: initialize the sensor registers to some sort of reasonable default 152 * values. Do not use for new drivers and should be removed in existing 153 * drivers. 154 * 155 * @load_fw: load firmware. 156 * 157 * @reset: generic reset command. The argument selects which subsystems to 158 * reset. Passing 0 will always reset the whole chip. Do not use for new 159 * drivers without discussing this first on the linux-media mailinglist. 160 * There should be no reason normally to reset a device. 161 * 162 * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with 163 * a direction argument if needed. 164 * 165 * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core. 166 * used to provide support for private ioctls used on the driver. 167 * 168 * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel, 169 * in order to fix data passed from/to userspace. 170 * 171 * @g_register: callback for %VIDIOC_G_REGISTER ioctl handler code. 172 * 173 * @s_register: callback for %VIDIOC_G_REGISTER ioctl handler code. 174 * 175 * @s_power: puts subdevice in power saving mode (on == 0) or normal operation 176 * mode (on == 1). 177 * 178 * @interrupt_service_routine: Called by the bridge chip's interrupt service 179 * handler, when an interrupt status has be raised due to this subdev, 180 * so that this subdev can handle the details. It may schedule work to be 181 * performed later. It must not sleep. **Called from an IRQ context**. 182 * 183 * @subscribe_event: used by the drivers to request the control framework that 184 * for it to be warned when the value of a control changes. 185 * 186 * @unsubscribe_event: remove event subscription from the control framework. 187 */ 188 struct v4l2_subdev_core_ops { 189 int (*log_status)(struct v4l2_subdev *sd); 190 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n, 191 struct v4l2_subdev_io_pin_config *pincfg); 192 int (*init)(struct v4l2_subdev *sd, u32 val); 193 int (*load_fw)(struct v4l2_subdev *sd); 194 int (*reset)(struct v4l2_subdev *sd, u32 val); 195 int (*s_gpio)(struct v4l2_subdev *sd, u32 val); 196 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); 197 #ifdef CONFIG_COMPAT 198 long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd, 199 unsigned long arg); 200 #endif 201 #ifdef CONFIG_VIDEO_ADV_DEBUG 202 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); 203 int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg); 204 #endif 205 int (*s_power)(struct v4l2_subdev *sd, int on); 206 int (*interrupt_service_routine)(struct v4l2_subdev *sd, 207 u32 status, bool *handled); 208 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, 209 struct v4l2_event_subscription *sub); 210 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, 211 struct v4l2_event_subscription *sub); 212 }; 213 214 /** 215 * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened 216 * in radio mode. 217 * 218 * @s_radio: callback for %VIDIOC_S_RADIO ioctl handler code. 219 * 220 * @s_frequency: callback for %VIDIOC_S_FREQUENCY ioctl handler code. 221 * 222 * @g_frequency: callback for %VIDIOC_G_FREQUENCY ioctl handler code. 223 * freq->type must be filled in. Normally done by video_ioctl2() 224 * or the bridge driver. 225 * 226 * @enum_freq_bands: callback for %VIDIOC_ENUM_FREQ_BANDS ioctl handler code. 227 * 228 * @g_tuner: callback for %VIDIOC_G_TUNER ioctl handler code. 229 * 230 * @s_tuner: callback for %VIDIOC_S_TUNER ioctl handler code. @vt->type must be 231 * filled in. Normally done by video_ioctl2 or the 232 * bridge driver. 233 * 234 * @g_modulator: callback for %VIDIOC_G_MODULATOR ioctl handler code. 235 * 236 * @s_modulator: callback for %VIDIOC_S_MODULATOR ioctl handler code. 237 * 238 * @s_type_addr: sets tuner type and its I2C addr. 239 * 240 * @s_config: sets tda9887 specific stuff, like port1, port2 and qss 241 */ 242 struct v4l2_subdev_tuner_ops { 243 int (*s_radio)(struct v4l2_subdev *sd); 244 int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq); 245 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); 246 int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band); 247 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); 248 int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt); 249 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); 250 int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm); 251 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); 252 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); 253 }; 254 255 /** 256 * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings 257 * 258 * @s_clock_freq: set the frequency (in Hz) of the audio clock output. 259 * Used to slave an audio processor to the video decoder, ensuring that 260 * audio and video remain synchronized. Usual values for the frequency 261 * are 48000, 44100 or 32000 Hz. If the frequency is not supported, then 262 * -EINVAL is returned. 263 * 264 * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard 265 * way to select I2S clock used by driving digital audio streams at some 266 * board designs. Usual values for the frequency are 1024000 and 2048000. 267 * If the frequency is not supported, then %-EINVAL is returned. 268 * 269 * @s_routing: used to define the input and/or output pins of an audio chip, 270 * and any additional configuration data. 271 * Never attempt to use user-level input IDs (e.g. Composite, S-Video, 272 * Tuner) at this level. An i2c device shouldn't know about whether an 273 * input pin is connected to a Composite connector, become on another 274 * board or platform it might be connected to something else entirely. 275 * The calling driver is responsible for mapping a user-level input to 276 * the right pins on the i2c device. 277 * 278 * @s_stream: used to notify the audio code that stream will start or has 279 * stopped. 280 */ 281 struct v4l2_subdev_audio_ops { 282 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 283 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 284 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 285 int (*s_stream)(struct v4l2_subdev *sd, int enable); 286 }; 287 288 /* Indicates the @length field specifies maximum data length. */ 289 #define V4L2_MBUS_FRAME_DESC_FL_LEN_MAX (1U << 0) 290 /* 291 * Indicates that the format does not have line offsets, i.e. the 292 * receiver should use 1D DMA. 293 */ 294 #define V4L2_MBUS_FRAME_DESC_FL_BLOB (1U << 1) 295 296 /** 297 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure 298 * 299 * @flags: bitmask flags: %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX and 300 * %V4L2_MBUS_FRAME_DESC_FL_BLOB. 301 * @pixelcode: media bus pixel code, valid if FRAME_DESC_FL_BLOB is not set 302 * @length: number of octets per frame, valid if V4L2_MBUS_FRAME_DESC_FL_BLOB 303 * is set 304 */ 305 struct v4l2_mbus_frame_desc_entry { 306 u16 flags; 307 u32 pixelcode; 308 u32 length; 309 }; 310 311 #define V4L2_FRAME_DESC_ENTRY_MAX 4 312 313 /** 314 * struct v4l2_mbus_frame_desc - media bus data frame description 315 * @entry: frame descriptors array 316 * @num_entries: number of entries in @entry array 317 */ 318 struct v4l2_mbus_frame_desc { 319 struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX]; 320 unsigned short num_entries; 321 }; 322 323 /** 324 * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened 325 * in video mode. 326 * 327 * @s_routing: see s_routing in audio_ops, except this version is for video 328 * devices. 329 * 330 * @s_crystal_freq: sets the frequency of the crystal used to generate the 331 * clocks in Hz. An extra flags field allows device specific configuration 332 * regarding clock frequency dividers, etc. If not used, then set flags 333 * to 0. If the frequency is not supported, then -EINVAL is returned. 334 * 335 * @g_std: callback for %VIDIOC_G_STD ioctl handler code. 336 * 337 * @s_std: callback for %VIDIOC_S_STD ioctl handler code. 338 * 339 * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by 340 * video input devices. 341 * 342 * @g_std_output: get current standard for video OUTPUT devices. This is ignored 343 * by video input devices. 344 * 345 * @querystd: callback for %VIDIOC_QUERYSTD ioctl handler code. 346 * 347 * @g_tvnorms: get &v4l2_std_id with all standards supported by the video 348 * CAPTURE device. This is ignored by video output devices. 349 * 350 * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video 351 * OUTPUT device. This is ignored by video capture devices. 352 * 353 * @g_input_status: get input status. Same as the status field in the 354 * &struct &v4l2_input 355 * 356 * @s_stream: used to notify the driver that a video stream will start or has 357 * stopped. 358 * 359 * @g_pixelaspect: callback to return the pixelaspect ratio. 360 * 361 * @g_parm: callback for %VIDIOC_G_PARM ioctl handler code. 362 * 363 * @s_parm: callback for %VIDIOC_S_PARM ioctl handler code. 364 * 365 * @g_frame_interval: callback for %VIDIOC_G_FRAMEINTERVAL ioctl handler code. 366 * 367 * @s_frame_interval: callback for %VIDIOC_S_FRAMEINTERVAL ioctl handler code. 368 * 369 * @s_dv_timings: Set custom dv timings in the sub device. This is used 370 * when sub device is capable of setting detailed timing information 371 * in the hardware to generate/detect the video signal. 372 * 373 * @g_dv_timings: Get custom dv timings in the sub device. 374 * 375 * @query_dv_timings: callback for %VIDIOC_QUERY_DV_TIMINGS ioctl handler code. 376 * 377 * @g_mbus_config: get supported mediabus configurations 378 * 379 * @s_mbus_config: set a certain mediabus configuration. This operation is added 380 * for compatibility with soc-camera drivers and should not be used by new 381 * software. 382 * 383 * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev 384 * can adjust @size to a lower value and must not write more data to the 385 * buffer starting at @data than the original value of @size. 386 */ 387 struct v4l2_subdev_video_ops { 388 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 389 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags); 390 int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm); 391 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); 392 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); 393 int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std); 394 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); 395 int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std); 396 int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std); 397 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); 398 int (*s_stream)(struct v4l2_subdev *sd, int enable); 399 int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect); 400 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); 401 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); 402 int (*g_frame_interval)(struct v4l2_subdev *sd, 403 struct v4l2_subdev_frame_interval *interval); 404 int (*s_frame_interval)(struct v4l2_subdev *sd, 405 struct v4l2_subdev_frame_interval *interval); 406 int (*s_dv_timings)(struct v4l2_subdev *sd, 407 struct v4l2_dv_timings *timings); 408 int (*g_dv_timings)(struct v4l2_subdev *sd, 409 struct v4l2_dv_timings *timings); 410 int (*query_dv_timings)(struct v4l2_subdev *sd, 411 struct v4l2_dv_timings *timings); 412 int (*g_mbus_config)(struct v4l2_subdev *sd, 413 struct v4l2_mbus_config *cfg); 414 int (*s_mbus_config)(struct v4l2_subdev *sd, 415 const struct v4l2_mbus_config *cfg); 416 int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf, 417 unsigned int *size); 418 }; 419 420 /** 421 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened 422 * in video mode via the vbi device node. 423 * 424 * @decode_vbi_line: video decoders that support sliced VBI need to implement 425 * this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the 426 * start of the VBI data that was generated by the decoder. The driver 427 * then parses the sliced VBI data and sets the other fields in the 428 * struct accordingly. The pointer p is updated to point to the start of 429 * the payload which can be copied verbatim into the data field of the 430 * &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the 431 * type field is set to 0 on return. 432 * 433 * @s_vbi_data: used to generate VBI signals on a video signal. 434 * &struct v4l2_sliced_vbi_data is filled with the data packets that 435 * should be output. Note that if you set the line field to 0, then that 436 * VBI signal is disabled. If no valid VBI data was found, then the type 437 * field is set to 0 on return. 438 * 439 * @g_vbi_data: used to obtain the sliced VBI packet from a readback register. 440 * Not all video decoders support this. If no data is available because 441 * the readback register contains invalid or erroneous data %-EIO is 442 * returned. Note that you must fill in the 'id' member and the 'field' 443 * member (to determine whether CC data from the first or second field 444 * should be obtained). 445 * 446 * @g_sliced_vbi_cap: callback for %VIDIOC_SLICED_VBI_CAP ioctl handler code. 447 * 448 * @s_raw_fmt: setup the video encoder/decoder for raw VBI. 449 * 450 * @g_sliced_fmt: retrieve the current sliced VBI settings. 451 * 452 * @s_sliced_fmt: setup the sliced VBI settings. 453 */ 454 struct v4l2_subdev_vbi_ops { 455 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); 456 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); 457 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); 458 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); 459 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt); 460 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 461 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 462 }; 463 464 /** 465 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations 466 * @g_skip_top_lines: number of lines at the top of the image to be skipped. 467 * This is needed for some sensors, which always corrupt 468 * several top lines of the output image, or which send their 469 * metadata in them. 470 * @g_skip_frames: number of frames to skip at stream start. This is needed for 471 * buggy sensors that generate faulty frames when they are 472 * turned on. 473 */ 474 struct v4l2_subdev_sensor_ops { 475 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines); 476 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames); 477 }; 478 479 /** 480 * enum v4l2_subdev_ir_mode- describes the type of IR supported 481 * 482 * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records 483 */ 484 enum v4l2_subdev_ir_mode { 485 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, 486 }; 487 488 /** 489 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX 490 * 491 * @bytes_per_data_element: bytes per data element of data in read or 492 * write call. 493 * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode. 494 * @enable: device is active if true 495 * @interrupt_enable: IR interrupts are enabled if true 496 * @shutdown: if true: set hardware to low/no power, false: normal mode 497 * 498 * @modulation: if true, it uses carrier, if false: baseband 499 * @max_pulse_width: maximum pulse width in ns, valid only for baseband signal 500 * @carrier_freq: carrier frequency in Hz, valid only for modulated signal 501 * @duty_cycle: duty cycle percentage, valid only for modulated signal 502 * @invert_level: invert signal level 503 * 504 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX. 505 * 506 * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX. 507 * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated 508 * signal. Used only for RX. 509 * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated 510 * signal. Used only for RX. 511 * @resolution: The receive resolution, in ns . Used only for RX. 512 */ 513 struct v4l2_subdev_ir_parameters { 514 unsigned int bytes_per_data_element; 515 enum v4l2_subdev_ir_mode mode; 516 517 bool enable; 518 bool interrupt_enable; 519 bool shutdown; 520 521 bool modulation; 522 u32 max_pulse_width; 523 unsigned int carrier_freq; 524 unsigned int duty_cycle; 525 bool invert_level; 526 527 /* Tx only */ 528 bool invert_carrier_sense; 529 530 /* Rx only */ 531 u32 noise_filter_min_width; 532 unsigned int carrier_range_lower; 533 unsigned int carrier_range_upper; 534 u32 resolution; 535 }; 536 537 /** 538 * struct v4l2_subdev_ir_ops - operations for IR subdevices 539 * 540 * @rx_read: Reads received codes or pulse width data. 541 * The semantics are similar to a non-blocking read() call. 542 * @rx_g_parameters: Get the current operating parameters and state of the 543 * the IR receiver. 544 * @rx_s_parameters: Set the current operating parameters and state of the 545 * the IR receiver. It is recommended to call 546 * [rt]x_g_parameters first to fill out the current state, and only change 547 * the fields that need to be changed. Upon return, the actual device 548 * operating parameters and state will be returned. Note that hardware 549 * limitations may prevent the actual settings from matching the requested 550 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz 551 * was requested. An exception is when the shutdown parameter is true. 552 * The last used operational parameters will be returned, but the actual 553 * state of the hardware be different to minimize power consumption and 554 * processing when shutdown is true. 555 * 556 * @tx_write: Writes codes or pulse width data for transmission. 557 * The semantics are similar to a non-blocking write() call. 558 * @tx_g_parameters: Get the current operating parameters and state of the 559 * the IR transmitter. 560 * @tx_s_parameters: Set the current operating parameters and state of the 561 * the IR transmitter. It is recommended to call 562 * [rt]x_g_parameters first to fill out the current state, and only change 563 * the fields that need to be changed. Upon return, the actual device 564 * operating parameters and state will be returned. Note that hardware 565 * limitations may prevent the actual settings from matching the requested 566 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz 567 * was requested. An exception is when the shutdown parameter is true. 568 * The last used operational parameters will be returned, but the actual 569 * state of the hardware be different to minimize power consumption and 570 * processing when shutdown is true. 571 */ 572 struct v4l2_subdev_ir_ops { 573 /* Receiver */ 574 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count, 575 ssize_t *num); 576 577 int (*rx_g_parameters)(struct v4l2_subdev *sd, 578 struct v4l2_subdev_ir_parameters *params); 579 int (*rx_s_parameters)(struct v4l2_subdev *sd, 580 struct v4l2_subdev_ir_parameters *params); 581 582 /* Transmitter */ 583 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count, 584 ssize_t *num); 585 586 int (*tx_g_parameters)(struct v4l2_subdev *sd, 587 struct v4l2_subdev_ir_parameters *params); 588 int (*tx_s_parameters)(struct v4l2_subdev *sd, 589 struct v4l2_subdev_ir_parameters *params); 590 }; 591 592 /** 593 * struct v4l2_subdev_pad_config - Used for storing subdev pad information. 594 * 595 * @try_fmt: &struct v4l2_mbus_framefmt 596 * @try_crop: &struct v4l2_rect to be used for crop 597 * @try_compose: &struct v4l2_rect to be used for compose 598 * 599 * This structure only needs to be passed to the pad op if the 'which' field 600 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For 601 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL. 602 */ 603 struct v4l2_subdev_pad_config { 604 struct v4l2_mbus_framefmt try_fmt; 605 struct v4l2_rect try_crop; 606 struct v4l2_rect try_compose; 607 }; 608 609 /** 610 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations 611 * 612 * @init_cfg: initialize the pad config to default values 613 * @enum_mbus_code: callback for %VIDIOC_SUBDEV_ENUM_MBUS_CODE ioctl handler 614 * code. 615 * @enum_frame_size: callback for %VIDIOC_SUBDEV_ENUM_FRAME_SIZE ioctl handler 616 * code. 617 * 618 * @enum_frame_interval: callback for %VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL ioctl 619 * handler code. 620 * 621 * @get_fmt: callback for %VIDIOC_SUBDEV_G_FMT ioctl handler code. 622 * 623 * @set_fmt: callback for %VIDIOC_SUBDEV_S_FMT ioctl handler code. 624 * 625 * @get_selection: callback for %VIDIOC_SUBDEV_G_SELECTION ioctl handler code. 626 * 627 * @set_selection: callback for %VIDIOC_SUBDEV_S_SELECTION ioctl handler code. 628 * 629 * @get_edid: callback for %VIDIOC_SUBDEV_G_EDID ioctl handler code. 630 * 631 * @set_edid: callback for %VIDIOC_SUBDEV_S_EDID ioctl handler code. 632 * 633 * @dv_timings_cap: callback for %VIDIOC_SUBDEV_DV_TIMINGS_CAP ioctl handler 634 * code. 635 * 636 * @enum_dv_timings: callback for %VIDIOC_SUBDEV_ENUM_DV_TIMINGS ioctl handler 637 * code. 638 * 639 * @link_validate: used by the media controller code to check if the links 640 * that belongs to a pipeline can be used for stream. 641 * 642 * @get_frame_desc: get the current low level media bus frame parameters. 643 * 644 * @set_frame_desc: set the low level media bus frame parameters, @fd array 645 * may be adjusted by the subdev driver to device capabilities. 646 */ 647 struct v4l2_subdev_pad_ops { 648 int (*init_cfg)(struct v4l2_subdev *sd, 649 struct v4l2_subdev_pad_config *cfg); 650 int (*enum_mbus_code)(struct v4l2_subdev *sd, 651 struct v4l2_subdev_pad_config *cfg, 652 struct v4l2_subdev_mbus_code_enum *code); 653 int (*enum_frame_size)(struct v4l2_subdev *sd, 654 struct v4l2_subdev_pad_config *cfg, 655 struct v4l2_subdev_frame_size_enum *fse); 656 int (*enum_frame_interval)(struct v4l2_subdev *sd, 657 struct v4l2_subdev_pad_config *cfg, 658 struct v4l2_subdev_frame_interval_enum *fie); 659 int (*get_fmt)(struct v4l2_subdev *sd, 660 struct v4l2_subdev_pad_config *cfg, 661 struct v4l2_subdev_format *format); 662 int (*set_fmt)(struct v4l2_subdev *sd, 663 struct v4l2_subdev_pad_config *cfg, 664 struct v4l2_subdev_format *format); 665 int (*get_selection)(struct v4l2_subdev *sd, 666 struct v4l2_subdev_pad_config *cfg, 667 struct v4l2_subdev_selection *sel); 668 int (*set_selection)(struct v4l2_subdev *sd, 669 struct v4l2_subdev_pad_config *cfg, 670 struct v4l2_subdev_selection *sel); 671 int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); 672 int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); 673 int (*dv_timings_cap)(struct v4l2_subdev *sd, 674 struct v4l2_dv_timings_cap *cap); 675 int (*enum_dv_timings)(struct v4l2_subdev *sd, 676 struct v4l2_enum_dv_timings *timings); 677 #ifdef CONFIG_MEDIA_CONTROLLER 678 int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link, 679 struct v4l2_subdev_format *source_fmt, 680 struct v4l2_subdev_format *sink_fmt); 681 #endif /* CONFIG_MEDIA_CONTROLLER */ 682 int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, 683 struct v4l2_mbus_frame_desc *fd); 684 int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, 685 struct v4l2_mbus_frame_desc *fd); 686 }; 687 688 /** 689 * struct v4l2_subdev_ops - Subdev operations 690 * 691 * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL 692 * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL 693 * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL 694 * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL 695 * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL 696 * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL 697 * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL 698 * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL 699 */ 700 struct v4l2_subdev_ops { 701 const struct v4l2_subdev_core_ops *core; 702 const struct v4l2_subdev_tuner_ops *tuner; 703 const struct v4l2_subdev_audio_ops *audio; 704 const struct v4l2_subdev_video_ops *video; 705 const struct v4l2_subdev_vbi_ops *vbi; 706 const struct v4l2_subdev_ir_ops *ir; 707 const struct v4l2_subdev_sensor_ops *sensor; 708 const struct v4l2_subdev_pad_ops *pad; 709 }; 710 711 /** 712 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops 713 * 714 * @registered: called when this subdev is registered. When called the v4l2_dev 715 * field is set to the correct v4l2_device. 716 * 717 * @unregistered: called when this subdev is unregistered. When called the 718 * v4l2_dev field is still set to the correct v4l2_device. 719 * 720 * @open: called when the subdev device node is opened by an application. 721 * 722 * @close: called when the subdev device node is closed. 723 * 724 * .. note:: 725 * Never call this from drivers, only the v4l2 framework can call 726 * these ops. 727 */ 728 struct v4l2_subdev_internal_ops { 729 int (*registered)(struct v4l2_subdev *sd); 730 void (*unregistered)(struct v4l2_subdev *sd); 731 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); 732 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); 733 }; 734 735 #define V4L2_SUBDEV_NAME_SIZE 32 736 737 /* Set this flag if this subdev is a i2c device. */ 738 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0) 739 /* Set this flag if this subdev is a spi device. */ 740 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1) 741 /* Set this flag if this subdev needs a device node. */ 742 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2) 743 /* Set this flag if this subdev generates events. */ 744 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3) 745 746 struct regulator_bulk_data; 747 748 /** 749 * struct v4l2_subdev_platform_data - regulators config struct 750 * 751 * @regulators: Optional regulators used to power on/off the subdevice 752 * @num_regulators: Number of regululators 753 * @host_priv: Per-subdevice data, specific for a certain video host device 754 */ 755 struct v4l2_subdev_platform_data { 756 struct regulator_bulk_data *regulators; 757 int num_regulators; 758 759 void *host_priv; 760 }; 761 762 /** 763 * struct v4l2_subdev - describes a V4L2 sub-device 764 * 765 * @entity: pointer to &struct media_entity 766 * @list: List of sub-devices 767 * @owner: The owner is the same as the driver's &struct device owner. 768 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev 769 * ownner. Initialized by v4l2_device_register_subdev(). 770 * @flags: subdev flags. Can be: 771 * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device; 772 * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device; 773 * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a 774 * device node; 775 * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates 776 * events. 777 * 778 * @v4l2_dev: pointer to struct &v4l2_device 779 * @ops: pointer to struct &v4l2_subdev_ops 780 * @internal_ops: pointer to struct &v4l2_subdev_internal_ops. 781 * Never call these internal ops from within a driver! 782 * @ctrl_handler: The control handler of this subdev. May be NULL. 783 * @name: Name of the sub-device. Please notice that the name must be unique. 784 * @grp_id: can be used to group similar subdevs. Value is driver-specific 785 * @dev_priv: pointer to private data 786 * @host_priv: pointer to private data used by the device where the subdev 787 * is attached. 788 * @devnode: subdev device node 789 * @dev: pointer to the physical device, if any 790 * @fwnode: The fwnode_handle of the subdev, usually the same as 791 * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL). 792 * @async_list: Links this subdev to a global subdev_list or @notifier->done 793 * list. 794 * @asd: Pointer to respective &struct v4l2_async_subdev. 795 * @notifier: Pointer to the managing notifier. 796 * @pdata: common part of subdevice platform data 797 * 798 * Each instance of a subdev driver should create this struct, either 799 * stand-alone or embedded in a larger struct. 800 * 801 * This structure should be initialized by v4l2_subdev_init() or one of 802 * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init(). 803 */ 804 struct v4l2_subdev { 805 #if defined(CONFIG_MEDIA_CONTROLLER) 806 struct media_entity entity; 807 #endif 808 struct list_head list; 809 struct module *owner; 810 bool owner_v4l2_dev; 811 u32 flags; 812 struct v4l2_device *v4l2_dev; 813 const struct v4l2_subdev_ops *ops; 814 const struct v4l2_subdev_internal_ops *internal_ops; 815 struct v4l2_ctrl_handler *ctrl_handler; 816 char name[V4L2_SUBDEV_NAME_SIZE]; 817 u32 grp_id; 818 void *dev_priv; 819 void *host_priv; 820 struct video_device *devnode; 821 struct device *dev; 822 struct fwnode_handle *fwnode; 823 struct list_head async_list; 824 struct v4l2_async_subdev *asd; 825 struct v4l2_async_notifier *notifier; 826 struct v4l2_subdev_platform_data *pdata; 827 }; 828 829 #define media_entity_to_v4l2_subdev(ent) \ 830 ({ \ 831 typeof(ent) __me_sd_ent = (ent); \ 832 \ 833 __me_sd_ent ? \ 834 container_of(__me_sd_ent, struct v4l2_subdev, entity) : \ 835 NULL; \ 836 }) 837 838 #define vdev_to_v4l2_subdev(vdev) \ 839 ((struct v4l2_subdev *)video_get_drvdata(vdev)) 840 841 /** 842 * struct v4l2_subdev_fh - Used for storing subdev information per file handle 843 * 844 * @vfh: pointer to struct v4l2_fh 845 * @pad: pointer to v4l2_subdev_pad_config 846 */ 847 struct v4l2_subdev_fh { 848 struct v4l2_fh vfh; 849 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 850 struct v4l2_subdev_pad_config *pad; 851 #endif 852 }; 853 854 #define to_v4l2_subdev_fh(fh) \ 855 container_of(fh, struct v4l2_subdev_fh, vfh) 856 857 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 858 #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name) \ 859 static inline struct rtype * \ 860 fun_name(struct v4l2_subdev *sd, \ 861 struct v4l2_subdev_pad_config *cfg, \ 862 unsigned int pad) \ 863 { \ 864 BUG_ON(pad >= sd->entity.num_pads); \ 865 return &cfg[pad].field_name; \ 866 } 867 868 __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, v4l2_subdev_get_try_format, try_fmt) 869 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_crop, try_crop) 870 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_compose, try_compose) 871 #endif 872 873 extern const struct v4l2_file_operations v4l2_subdev_fops; 874 875 /** 876 * v4l2_set_subdevdata - Sets V4L2 dev private device data 877 * 878 * @sd: pointer to &struct v4l2_subdev 879 * @p: pointer to the private device data to be stored. 880 */ 881 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) 882 { 883 sd->dev_priv = p; 884 } 885 886 /** 887 * v4l2_get_subdevdata - Gets V4L2 dev private device data 888 * 889 * @sd: pointer to &struct v4l2_subdev 890 * 891 * Returns the pointer to the private device data to be stored. 892 */ 893 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) 894 { 895 return sd->dev_priv; 896 } 897 898 /** 899 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data 900 * 901 * @sd: pointer to &struct v4l2_subdev 902 * @p: pointer to the private data to be stored. 903 */ 904 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p) 905 { 906 sd->host_priv = p; 907 } 908 909 /** 910 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data 911 * 912 * @sd: pointer to &struct v4l2_subdev 913 * 914 * Returns the pointer to the private host data to be stored. 915 */ 916 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd) 917 { 918 return sd->host_priv; 919 } 920 921 #ifdef CONFIG_MEDIA_CONTROLLER 922 923 /** 924 * v4l2_subdev_link_validate_default - validates a media link 925 * 926 * @sd: pointer to &struct v4l2_subdev 927 * @link: pointer to &struct media_link 928 * @source_fmt: pointer to &struct v4l2_subdev_format 929 * @sink_fmt: pointer to &struct v4l2_subdev_format 930 * 931 * This function ensures that width, height and the media bus pixel 932 * code are equal on both source and sink of the link. 933 */ 934 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd, 935 struct media_link *link, 936 struct v4l2_subdev_format *source_fmt, 937 struct v4l2_subdev_format *sink_fmt); 938 939 /** 940 * v4l2_subdev_link_validate - validates a media link 941 * 942 * @link: pointer to &struct media_link 943 * 944 * This function calls the subdev's link_validate ops to validate 945 * if a media link is valid for streaming. It also internally 946 * calls v4l2_subdev_link_validate_default() to ensure that 947 * width, height and the media bus pixel code are equal on both 948 * source and sink of the link. 949 */ 950 int v4l2_subdev_link_validate(struct media_link *link); 951 952 /** 953 * v4l2_subdev_alloc_pad_config - Allocates memory for pad config 954 * 955 * @sd: pointer to struct v4l2_subdev 956 */ 957 struct 958 v4l2_subdev_pad_config *v4l2_subdev_alloc_pad_config(struct v4l2_subdev *sd); 959 960 /** 961 * v4l2_subdev_free_pad_config - Frees memory allocated by 962 * v4l2_subdev_alloc_pad_config(). 963 * 964 * @cfg: pointer to &struct v4l2_subdev_pad_config 965 */ 966 void v4l2_subdev_free_pad_config(struct v4l2_subdev_pad_config *cfg); 967 #endif /* CONFIG_MEDIA_CONTROLLER */ 968 969 /** 970 * v4l2_subdev_init - initializes the sub-device struct 971 * 972 * @sd: pointer to the &struct v4l2_subdev to be initialized 973 * @ops: pointer to &struct v4l2_subdev_ops. 974 */ 975 void v4l2_subdev_init(struct v4l2_subdev *sd, 976 const struct v4l2_subdev_ops *ops); 977 978 /* 979 * Call an ops of a v4l2_subdev, doing the right checks against 980 * NULL pointers. 981 * 982 * Example: err = v4l2_subdev_call(sd, video, s_std, norm); 983 */ 984 #define v4l2_subdev_call(sd, o, f, args...) \ 985 ({ \ 986 int __result; \ 987 if (!(sd)) \ 988 __result = -ENODEV; \ 989 else if (!((sd)->ops->o && (sd)->ops->o->f)) \ 990 __result = -ENOIOCTLCMD; \ 991 else \ 992 __result = (sd)->ops->o->f((sd), ##args); \ 993 __result; \ 994 }) 995 996 #define v4l2_subdev_has_op(sd, o, f) \ 997 ((sd)->ops->o && (sd)->ops->o->f) 998 999 /** 1000 * v4l2_subdev_notify_event() - Delivers event notification for subdevice 1001 * @sd: The subdev for which to deliver the event 1002 * @ev: The event to deliver 1003 * 1004 * Will deliver the specified event to all userspace event listeners which are 1005 * subscribed to the v42l subdev event queue as well as to the bridge driver 1006 * using the notify callback. The notification type for the notify callback 1007 * will be %V4L2_DEVICE_NOTIFY_EVENT. 1008 */ 1009 void v4l2_subdev_notify_event(struct v4l2_subdev *sd, 1010 const struct v4l2_event *ev); 1011 1012 #endif 1013