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