1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * V4L2 sub-device support header. 4 * 5 * Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl> 6 */ 7 8 #ifndef _V4L2_SUBDEV_H 9 #define _V4L2_SUBDEV_H 10 11 #include <linux/types.h> 12 #include <linux/v4l2-subdev.h> 13 #include <media/media-entity.h> 14 #include <media/v4l2-async.h> 15 #include <media/v4l2-common.h> 16 #include <media/v4l2-dev.h> 17 #include <media/v4l2-fh.h> 18 #include <media/v4l2-mediabus.h> 19 20 /* generic v4l2_device notify callback notification values */ 21 #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32) 22 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001 23 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002 24 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004 25 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008 26 27 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32) 28 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001 29 30 #define V4L2_DEVICE_NOTIFY_EVENT _IOW('v', 2, struct v4l2_event) 31 32 struct v4l2_device; 33 struct v4l2_ctrl_handler; 34 struct v4l2_event; 35 struct v4l2_event_subscription; 36 struct v4l2_fh; 37 struct v4l2_subdev; 38 struct v4l2_subdev_fh; 39 struct tuner_setup; 40 struct v4l2_mbus_frame_desc; 41 struct led_classdev; 42 43 /** 44 * struct v4l2_decode_vbi_line - used to decode_vbi_line 45 * 46 * @is_second_field: Set to 0 for the first (odd) field; 47 * set to 1 for the second (even) field. 48 * @p: Pointer to the sliced VBI data from the decoder. On exit, points to 49 * the start of the payload. 50 * @line: Line number of the sliced VBI data (1-23) 51 * @type: VBI service type (V4L2_SLICED_*). 0 if no service found 52 */ 53 struct v4l2_decode_vbi_line { 54 u32 is_second_field; 55 u8 *p; 56 u32 line; 57 u32 type; 58 }; 59 60 /* 61 * Sub-devices are devices that are connected somehow to the main bridge 62 * device. These devices are usually audio/video muxers/encoders/decoders or 63 * sensors and webcam controllers. 64 * 65 * Usually these devices are controlled through an i2c bus, but other buses 66 * may also be used. 67 * 68 * The v4l2_subdev struct provides a way of accessing these devices in a 69 * generic manner. Most operations that these sub-devices support fall in 70 * a few categories: core ops, audio ops, video ops and tuner ops. 71 * 72 * More categories can be added if needed, although this should remain a 73 * limited set (no more than approx. 8 categories). 74 * 75 * Each category has its own set of ops that subdev drivers can implement. 76 * 77 * A subdev driver can leave the pointer to the category ops NULL if 78 * it does not implement them (e.g. an audio subdev will generally not 79 * implement the video category ops). The exception is the core category: 80 * this must always be present. 81 * 82 * These ops are all used internally so it is no problem to change, remove 83 * or add ops or move ops from one to another category. Currently these 84 * ops are based on the original ioctls, but since ops are not limited to 85 * one argument there is room for improvement here once all i2c subdev 86 * drivers are converted to use these ops. 87 */ 88 89 /* 90 * Core ops: it is highly recommended to implement at least these ops: 91 * 92 * log_status 93 * g_register 94 * s_register 95 * 96 * This provides basic debugging support. 97 * 98 * The ioctl ops is meant for generic ioctl-like commands. Depending on 99 * the use-case it might be better to use subdev-specific ops (currently 100 * not yet implemented) since ops provide proper type-checking. 101 */ 102 103 /** 104 * enum v4l2_subdev_io_pin_bits - Subdevice external IO pin configuration 105 * bits 106 * 107 * @V4L2_SUBDEV_IO_PIN_DISABLE: disables a pin config. ENABLE assumed. 108 * @V4L2_SUBDEV_IO_PIN_OUTPUT: set it if pin is an output. 109 * @V4L2_SUBDEV_IO_PIN_INPUT: set it if pin is an input. 110 * @V4L2_SUBDEV_IO_PIN_SET_VALUE: to set the output value via 111 * &struct v4l2_subdev_io_pin_config->value. 112 * @V4L2_SUBDEV_IO_PIN_ACTIVE_LOW: pin active is bit 0. 113 * Otherwise, ACTIVE HIGH is assumed. 114 */ 115 enum v4l2_subdev_io_pin_bits { 116 V4L2_SUBDEV_IO_PIN_DISABLE = 0, 117 V4L2_SUBDEV_IO_PIN_OUTPUT = 1, 118 V4L2_SUBDEV_IO_PIN_INPUT = 2, 119 V4L2_SUBDEV_IO_PIN_SET_VALUE = 3, 120 V4L2_SUBDEV_IO_PIN_ACTIVE_LOW = 4, 121 }; 122 123 /** 124 * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration 125 * 126 * @flags: bitmask with flags for this pin's config, whose bits are defined by 127 * &enum v4l2_subdev_io_pin_bits. 128 * @pin: Chip external IO pin to configure 129 * @function: Internal signal pad/function to route to IO pin 130 * @value: Initial value for pin - e.g. GPIO output value 131 * @strength: Pin drive strength 132 */ 133 struct v4l2_subdev_io_pin_config { 134 u32 flags; 135 u8 pin; 136 u8 function; 137 u8 value; 138 u8 strength; 139 }; 140 141 /** 142 * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs 143 * 144 * @log_status: callback for VIDIOC_LOG_STATUS() ioctl handler code. 145 * 146 * @s_io_pin_config: configure one or more chip I/O pins for chips that 147 * multiplex different internal signal pads out to IO pins. This function 148 * takes a pointer to an array of 'n' pin configuration entries, one for 149 * each pin being configured. This function could be called at times 150 * other than just subdevice initialization. 151 * 152 * @init: initialize the sensor registers to some sort of reasonable default 153 * values. Do not use for new drivers and should be removed in existing 154 * drivers. 155 * 156 * @load_fw: load firmware. 157 * 158 * @reset: generic reset command. The argument selects which subsystems to 159 * reset. Passing 0 will always reset the whole chip. Do not use for new 160 * drivers without discussing this first on the linux-media mailinglist. 161 * There should be no reason normally to reset a device. 162 * 163 * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with 164 * a direction argument if needed. 165 * 166 * @command: called by in-kernel drivers in order to call functions internal 167 * to subdev drivers driver that have a separate callback. 168 * 169 * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core. 170 * used to provide support for private ioctls used on the driver. 171 * 172 * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel, 173 * in order to fix data passed from/to userspace. 174 * 175 * @g_register: callback for VIDIOC_DBG_G_REGISTER() ioctl handler code. 176 * 177 * @s_register: callback for VIDIOC_DBG_S_REGISTER() ioctl handler code. 178 * 179 * @s_power: puts subdevice in power saving mode (on == 0) or normal operation 180 * mode (on == 1). DEPRECATED. See 181 * Documentation/driver-api/media/camera-sensor.rst . pre_streamon and 182 * post_streamoff callbacks can be used for e.g. setting the bus to LP-11 183 * mode before s_stream is called. 184 * 185 * @interrupt_service_routine: Called by the bridge chip's interrupt service 186 * handler, when an interrupt status has be raised due to this subdev, 187 * so that this subdev can handle the details. It may schedule work to be 188 * performed later. It must not sleep. **Called from an IRQ context**. 189 * 190 * @subscribe_event: used by the drivers to request the control framework that 191 * for it to be warned when the value of a control changes. 192 * 193 * @unsubscribe_event: remove event subscription from the control framework. 194 */ 195 struct v4l2_subdev_core_ops { 196 int (*log_status)(struct v4l2_subdev *sd); 197 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n, 198 struct v4l2_subdev_io_pin_config *pincfg); 199 int (*init)(struct v4l2_subdev *sd, u32 val); 200 int (*load_fw)(struct v4l2_subdev *sd); 201 int (*reset)(struct v4l2_subdev *sd, u32 val); 202 int (*s_gpio)(struct v4l2_subdev *sd, u32 val); 203 long (*command)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); 204 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); 205 #ifdef CONFIG_COMPAT 206 long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd, 207 unsigned long arg); 208 #endif 209 #ifdef CONFIG_VIDEO_ADV_DEBUG 210 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); 211 int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg); 212 #endif 213 int (*s_power)(struct v4l2_subdev *sd, int on); 214 int (*interrupt_service_routine)(struct v4l2_subdev *sd, 215 u32 status, bool *handled); 216 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, 217 struct v4l2_event_subscription *sub); 218 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, 219 struct v4l2_event_subscription *sub); 220 }; 221 222 /** 223 * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened 224 * in radio mode. 225 * 226 * @standby: puts the tuner in standby mode. It will be woken up 227 * automatically the next time it is used. 228 * 229 * @s_radio: callback that switches the tuner to radio mode. 230 * drivers should explicitly call it when a tuner ops should 231 * operate on radio mode, before being able to handle it. 232 * Used on devices that have both AM/FM radio receiver and TV. 233 * 234 * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code. 235 * 236 * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code. 237 * freq->type must be filled in. Normally done by video_ioctl2() 238 * or the bridge driver. 239 * 240 * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code. 241 * 242 * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code. 243 * 244 * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be 245 * filled in. Normally done by video_ioctl2 or the 246 * bridge driver. 247 * 248 * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code. 249 * 250 * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code. 251 * 252 * @s_type_addr: sets tuner type and its I2C addr. 253 * 254 * @s_config: sets tda9887 specific stuff, like port1, port2 and qss 255 * 256 * .. note:: 257 * 258 * On devices that have both AM/FM and TV, it is up to the driver 259 * to explicitly call s_radio when the tuner should be switched to 260 * radio mode, before handling other &struct v4l2_subdev_tuner_ops 261 * that would require it. An example of such usage is:: 262 * 263 * static void s_frequency(void *priv, const struct v4l2_frequency *f) 264 * { 265 * ... 266 * if (f.type == V4L2_TUNER_RADIO) 267 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio); 268 * ... 269 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency); 270 * } 271 */ 272 struct v4l2_subdev_tuner_ops { 273 int (*standby)(struct v4l2_subdev *sd); 274 int (*s_radio)(struct v4l2_subdev *sd); 275 int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq); 276 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); 277 int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band); 278 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); 279 int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt); 280 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); 281 int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm); 282 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); 283 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); 284 }; 285 286 /** 287 * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings 288 * 289 * @s_clock_freq: set the frequency (in Hz) of the audio clock output. 290 * Used to slave an audio processor to the video decoder, ensuring that 291 * audio and video remain synchronized. Usual values for the frequency 292 * are 48000, 44100 or 32000 Hz. If the frequency is not supported, then 293 * -EINVAL is returned. 294 * 295 * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard 296 * way to select I2S clock used by driving digital audio streams at some 297 * board designs. Usual values for the frequency are 1024000 and 2048000. 298 * If the frequency is not supported, then %-EINVAL is returned. 299 * 300 * @s_routing: used to define the input and/or output pins of an audio chip, 301 * and any additional configuration data. 302 * Never attempt to use user-level input IDs (e.g. Composite, S-Video, 303 * Tuner) at this level. An i2c device shouldn't know about whether an 304 * input pin is connected to a Composite connector, become on another 305 * board or platform it might be connected to something else entirely. 306 * The calling driver is responsible for mapping a user-level input to 307 * the right pins on the i2c device. 308 * 309 * @s_stream: used to notify the audio code that stream will start or has 310 * stopped. 311 */ 312 struct v4l2_subdev_audio_ops { 313 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 314 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 315 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 316 int (*s_stream)(struct v4l2_subdev *sd, int enable); 317 }; 318 319 /** 320 * struct v4l2_mbus_frame_desc_entry_csi2 321 * 322 * @vc: CSI-2 virtual channel 323 * @dt: CSI-2 data type ID 324 */ 325 struct v4l2_mbus_frame_desc_entry_csi2 { 326 u8 vc; 327 u8 dt; 328 }; 329 330 /** 331 * enum v4l2_mbus_frame_desc_flags - media bus frame description flags 332 * 333 * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX: 334 * Indicates that &struct v4l2_mbus_frame_desc_entry->length field 335 * specifies maximum data length. 336 * @V4L2_MBUS_FRAME_DESC_FL_BLOB: 337 * Indicates that the format does not have line offsets, i.e. 338 * the receiver should use 1D DMA. 339 */ 340 enum v4l2_mbus_frame_desc_flags { 341 V4L2_MBUS_FRAME_DESC_FL_LEN_MAX = BIT(0), 342 V4L2_MBUS_FRAME_DESC_FL_BLOB = BIT(1), 343 }; 344 345 /** 346 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure 347 * 348 * @flags: bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags. 349 * @stream: stream in routing configuration 350 * @pixelcode: media bus pixel code, valid if @flags 351 * %FRAME_DESC_FL_BLOB is not set. 352 * @length: number of octets per frame, valid if @flags 353 * %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set. 354 * @bus: Bus-specific frame descriptor parameters 355 * @bus.csi2: CSI-2-specific bus configuration 356 */ 357 struct v4l2_mbus_frame_desc_entry { 358 enum v4l2_mbus_frame_desc_flags flags; 359 u32 stream; 360 u32 pixelcode; 361 u32 length; 362 union { 363 struct v4l2_mbus_frame_desc_entry_csi2 csi2; 364 } bus; 365 }; 366 367 /* 368 * If this number is too small, it should be dropped altogether and the 369 * API switched to a dynamic number of frame descriptor entries. 370 */ 371 #define V4L2_FRAME_DESC_ENTRY_MAX 8 372 373 /** 374 * enum v4l2_mbus_frame_desc_type - media bus frame description type 375 * 376 * @V4L2_MBUS_FRAME_DESC_TYPE_UNDEFINED: 377 * Undefined frame desc type. Drivers should not use this, it is 378 * for backwards compatibility. 379 * @V4L2_MBUS_FRAME_DESC_TYPE_PARALLEL: 380 * Parallel media bus. 381 * @V4L2_MBUS_FRAME_DESC_TYPE_CSI2: 382 * CSI-2 media bus. Frame desc parameters must be set in 383 * &struct v4l2_mbus_frame_desc_entry->csi2. 384 */ 385 enum v4l2_mbus_frame_desc_type { 386 V4L2_MBUS_FRAME_DESC_TYPE_UNDEFINED = 0, 387 V4L2_MBUS_FRAME_DESC_TYPE_PARALLEL, 388 V4L2_MBUS_FRAME_DESC_TYPE_CSI2, 389 }; 390 391 /** 392 * struct v4l2_mbus_frame_desc - media bus data frame description 393 * @type: type of the bus (enum v4l2_mbus_frame_desc_type) 394 * @entry: frame descriptors array 395 * @num_entries: number of entries in @entry array 396 */ 397 struct v4l2_mbus_frame_desc { 398 enum v4l2_mbus_frame_desc_type type; 399 struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX]; 400 unsigned short num_entries; 401 }; 402 403 /** 404 * enum v4l2_subdev_pre_streamon_flags - Flags for pre_streamon subdev core op 405 * 406 * @V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP: Set the transmitter to either LP-11 407 * or LP-111 mode before call to s_stream(). 408 */ 409 enum v4l2_subdev_pre_streamon_flags { 410 V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP = BIT(0), 411 }; 412 413 /** 414 * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened 415 * in video mode. 416 * 417 * @s_routing: see s_routing in audio_ops, except this version is for video 418 * devices. 419 * 420 * @s_crystal_freq: sets the frequency of the crystal used to generate the 421 * clocks in Hz. An extra flags field allows device specific configuration 422 * regarding clock frequency dividers, etc. If not used, then set flags 423 * to 0. If the frequency is not supported, then -EINVAL is returned. 424 * 425 * @g_std: callback for VIDIOC_G_STD() ioctl handler code. 426 * 427 * @s_std: callback for VIDIOC_S_STD() ioctl handler code. 428 * 429 * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by 430 * video input devices. 431 * 432 * @g_std_output: get current standard for video OUTPUT devices. This is ignored 433 * by video input devices. 434 * 435 * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code. 436 * 437 * @g_tvnorms: get &v4l2_std_id with all standards supported by the video 438 * CAPTURE device. This is ignored by video output devices. 439 * 440 * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video 441 * OUTPUT device. This is ignored by video capture devices. 442 * 443 * @g_input_status: get input status. Same as the status field in the 444 * &struct v4l2_input 445 * 446 * @s_stream: start (enabled == 1) or stop (enabled == 0) streaming on the 447 * sub-device. Failure on stop will remove any resources acquired in 448 * streaming start, while the error code is still returned by the driver. 449 * The caller shall track the subdev state, and shall not start or stop an 450 * already started or stopped subdev. Also see call_s_stream wrapper in 451 * v4l2-subdev.c. 452 * 453 * This callback is DEPRECATED. New drivers should instead implement 454 * &v4l2_subdev_pad_ops.enable_streams and 455 * &v4l2_subdev_pad_ops.disable_streams operations, and use 456 * v4l2_subdev_s_stream_helper for the &v4l2_subdev_video_ops.s_stream 457 * operation to support legacy users. 458 * 459 * Drivers should also not call the .s_stream() subdev operation directly, 460 * but use the v4l2_subdev_enable_streams() and 461 * v4l2_subdev_disable_streams() helpers. 462 * 463 * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev 464 * can adjust @size to a lower value and must not write more data to the 465 * buffer starting at @data than the original value of @size. 466 * 467 * @pre_streamon: May be called before streaming is actually started, to help 468 * initialising the bus. Current usage is to set a CSI-2 transmitter to 469 * LP-11 or LP-111 mode before streaming. See &enum 470 * v4l2_subdev_pre_streamon_flags. 471 * 472 * pre_streamon shall return error if it cannot perform the operation as 473 * indicated by the flags argument. In particular, -EACCES indicates lack 474 * of support for the operation. The caller shall call post_streamoff for 475 * each successful call of pre_streamon. 476 * 477 * @post_streamoff: Called after streaming is stopped, but if and only if 478 * pre_streamon was called earlier. 479 */ 480 struct v4l2_subdev_video_ops { 481 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 482 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags); 483 int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm); 484 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); 485 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); 486 int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std); 487 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); 488 int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std); 489 int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std); 490 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); 491 int (*s_stream)(struct v4l2_subdev *sd, int enable); 492 int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf, 493 unsigned int *size); 494 int (*pre_streamon)(struct v4l2_subdev *sd, u32 flags); 495 int (*post_streamoff)(struct v4l2_subdev *sd); 496 }; 497 498 /** 499 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened 500 * in video mode via the vbi device node. 501 * 502 * @decode_vbi_line: video decoders that support sliced VBI need to implement 503 * this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the 504 * start of the VBI data that was generated by the decoder. The driver 505 * then parses the sliced VBI data and sets the other fields in the 506 * struct accordingly. The pointer p is updated to point to the start of 507 * the payload which can be copied verbatim into the data field of the 508 * &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the 509 * type field is set to 0 on return. 510 * 511 * @s_vbi_data: used to generate VBI signals on a video signal. 512 * &struct v4l2_sliced_vbi_data is filled with the data packets that 513 * should be output. Note that if you set the line field to 0, then that 514 * VBI signal is disabled. If no valid VBI data was found, then the type 515 * field is set to 0 on return. 516 * 517 * @g_vbi_data: used to obtain the sliced VBI packet from a readback register. 518 * Not all video decoders support this. If no data is available because 519 * the readback register contains invalid or erroneous data %-EIO is 520 * returned. Note that you must fill in the 'id' member and the 'field' 521 * member (to determine whether CC data from the first or second field 522 * should be obtained). 523 * 524 * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler 525 * code. 526 * 527 * @s_raw_fmt: setup the video encoder/decoder for raw VBI. 528 * 529 * @g_sliced_fmt: retrieve the current sliced VBI settings. 530 * 531 * @s_sliced_fmt: setup the sliced VBI settings. 532 */ 533 struct v4l2_subdev_vbi_ops { 534 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); 535 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); 536 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); 537 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); 538 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt); 539 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 540 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 541 }; 542 543 /** 544 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations 545 * @g_skip_top_lines: number of lines at the top of the image to be skipped. 546 * This is needed for some sensors, which always corrupt 547 * several top lines of the output image, or which send their 548 * metadata in them. 549 * @g_skip_frames: number of frames to skip at stream start. This is needed for 550 * buggy sensors that generate faulty frames when they are 551 * turned on. 552 */ 553 struct v4l2_subdev_sensor_ops { 554 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines); 555 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames); 556 }; 557 558 /** 559 * enum v4l2_subdev_ir_mode- describes the type of IR supported 560 * 561 * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records 562 */ 563 enum v4l2_subdev_ir_mode { 564 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, 565 }; 566 567 /** 568 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX 569 * 570 * @bytes_per_data_element: bytes per data element of data in read or 571 * write call. 572 * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode. 573 * @enable: device is active if true 574 * @interrupt_enable: IR interrupts are enabled if true 575 * @shutdown: if true: set hardware to low/no power, false: normal mode 576 * 577 * @modulation: if true, it uses carrier, if false: baseband 578 * @max_pulse_width: maximum pulse width in ns, valid only for baseband signal 579 * @carrier_freq: carrier frequency in Hz, valid only for modulated signal 580 * @duty_cycle: duty cycle percentage, valid only for modulated signal 581 * @invert_level: invert signal level 582 * 583 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX. 584 * 585 * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX. 586 * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated 587 * signal. Used only for RX. 588 * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated 589 * signal. Used only for RX. 590 * @resolution: The receive resolution, in ns . Used only for RX. 591 */ 592 struct v4l2_subdev_ir_parameters { 593 unsigned int bytes_per_data_element; 594 enum v4l2_subdev_ir_mode mode; 595 596 bool enable; 597 bool interrupt_enable; 598 bool shutdown; 599 600 bool modulation; 601 u32 max_pulse_width; 602 unsigned int carrier_freq; 603 unsigned int duty_cycle; 604 bool invert_level; 605 606 /* Tx only */ 607 bool invert_carrier_sense; 608 609 /* Rx only */ 610 u32 noise_filter_min_width; 611 unsigned int carrier_range_lower; 612 unsigned int carrier_range_upper; 613 u32 resolution; 614 }; 615 616 /** 617 * struct v4l2_subdev_ir_ops - operations for IR subdevices 618 * 619 * @rx_read: Reads received codes or pulse width data. 620 * The semantics are similar to a non-blocking read() call. 621 * @rx_g_parameters: Get the current operating parameters and state of 622 * the IR receiver. 623 * @rx_s_parameters: Set the current operating parameters and state of 624 * the IR receiver. It is recommended to call 625 * [rt]x_g_parameters first to fill out the current state, and only change 626 * the fields that need to be changed. Upon return, the actual device 627 * operating parameters and state will be returned. Note that hardware 628 * limitations may prevent the actual settings from matching the requested 629 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz 630 * was requested. An exception is when the shutdown parameter is true. 631 * The last used operational parameters will be returned, but the actual 632 * state of the hardware be different to minimize power consumption and 633 * processing when shutdown is true. 634 * 635 * @tx_write: Writes codes or pulse width data for transmission. 636 * The semantics are similar to a non-blocking write() call. 637 * @tx_g_parameters: Get the current operating parameters and state of 638 * the IR transmitter. 639 * @tx_s_parameters: Set the current operating parameters and state of 640 * the IR transmitter. It is recommended to call 641 * [rt]x_g_parameters first to fill out the current state, and only change 642 * the fields that need to be changed. Upon return, the actual device 643 * operating parameters and state will be returned. Note that hardware 644 * limitations may prevent the actual settings from matching the requested 645 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz 646 * was requested. An exception is when the shutdown parameter is true. 647 * The last used operational parameters will be returned, but the actual 648 * state of the hardware be different to minimize power consumption and 649 * processing when shutdown is true. 650 */ 651 struct v4l2_subdev_ir_ops { 652 /* Receiver */ 653 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count, 654 ssize_t *num); 655 656 int (*rx_g_parameters)(struct v4l2_subdev *sd, 657 struct v4l2_subdev_ir_parameters *params); 658 int (*rx_s_parameters)(struct v4l2_subdev *sd, 659 struct v4l2_subdev_ir_parameters *params); 660 661 /* Transmitter */ 662 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count, 663 ssize_t *num); 664 665 int (*tx_g_parameters)(struct v4l2_subdev *sd, 666 struct v4l2_subdev_ir_parameters *params); 667 int (*tx_s_parameters)(struct v4l2_subdev *sd, 668 struct v4l2_subdev_ir_parameters *params); 669 }; 670 671 /** 672 * struct v4l2_subdev_pad_config - Used for storing subdev pad information. 673 * 674 * @format: &struct v4l2_mbus_framefmt 675 * @crop: &struct v4l2_rect to be used for crop 676 * @compose: &struct v4l2_rect to be used for compose 677 * @interval: frame interval 678 */ 679 struct v4l2_subdev_pad_config { 680 struct v4l2_mbus_framefmt format; 681 struct v4l2_rect crop; 682 struct v4l2_rect compose; 683 struct v4l2_fract interval; 684 }; 685 686 /** 687 * struct v4l2_subdev_stream_config - Used for storing stream configuration. 688 * 689 * @pad: pad number 690 * @stream: stream number 691 * @enabled: has the stream been enabled with v4l2_subdev_enable_streams() 692 * @fmt: &struct v4l2_mbus_framefmt 693 * @crop: &struct v4l2_rect to be used for crop 694 * @compose: &struct v4l2_rect to be used for compose 695 * @interval: frame interval 696 * 697 * This structure stores configuration for a stream. 698 */ 699 struct v4l2_subdev_stream_config { 700 u32 pad; 701 u32 stream; 702 bool enabled; 703 704 struct v4l2_mbus_framefmt fmt; 705 struct v4l2_rect crop; 706 struct v4l2_rect compose; 707 struct v4l2_fract interval; 708 }; 709 710 /** 711 * struct v4l2_subdev_stream_configs - A collection of stream configs. 712 * 713 * @num_configs: number of entries in @config. 714 * @configs: an array of &struct v4l2_subdev_stream_configs. 715 */ 716 struct v4l2_subdev_stream_configs { 717 u32 num_configs; 718 struct v4l2_subdev_stream_config *configs; 719 }; 720 721 /** 722 * struct v4l2_subdev_krouting - subdev routing table 723 * 724 * @len_routes: length of routes array, in routes 725 * @num_routes: number of routes 726 * @routes: &struct v4l2_subdev_route 727 * 728 * This structure contains the routing table for a subdev. 729 */ 730 struct v4l2_subdev_krouting { 731 unsigned int len_routes; 732 unsigned int num_routes; 733 struct v4l2_subdev_route *routes; 734 }; 735 736 /** 737 * struct v4l2_subdev_state - Used for storing subdev state information. 738 * 739 * @_lock: default for 'lock' 740 * @lock: mutex for the state. May be replaced by the user. 741 * @sd: the sub-device which the state is related to 742 * @pads: &struct v4l2_subdev_pad_config array 743 * @routing: routing table for the subdev 744 * @stream_configs: stream configurations (only for V4L2_SUBDEV_FL_STREAMS) 745 * 746 * This structure only needs to be passed to the pad op if the 'which' field 747 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For 748 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL. 749 */ 750 struct v4l2_subdev_state { 751 /* lock for the struct v4l2_subdev_state fields */ 752 struct mutex _lock; 753 struct mutex *lock; 754 struct v4l2_subdev *sd; 755 struct v4l2_subdev_pad_config *pads; 756 struct v4l2_subdev_krouting routing; 757 struct v4l2_subdev_stream_configs stream_configs; 758 }; 759 760 /** 761 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations 762 * 763 * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler 764 * code. 765 * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler 766 * code. 767 * 768 * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl 769 * handler code. 770 * 771 * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code. 772 * 773 * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code. 774 * 775 * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code. 776 * 777 * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code. 778 * 779 * @get_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL() 780 * ioctl handler code. 781 * 782 * @set_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL() 783 * ioctl handler code. 784 * 785 * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code. 786 * 787 * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code. 788 * 789 * @s_dv_timings: Set custom dv timings in the sub device. This is used 790 * when sub device is capable of setting detailed timing information 791 * in the hardware to generate/detect the video signal. 792 * 793 * @g_dv_timings: Get custom dv timings in the sub device. 794 * 795 * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code. 796 * 797 * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler 798 * code. 799 * 800 * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler 801 * code. 802 * 803 * @link_validate: used by the media controller code to check if the links 804 * that belongs to a pipeline can be used for stream. 805 * 806 * @get_frame_desc: get the current low level media bus frame parameters. 807 * 808 * @set_frame_desc: set the low level media bus frame parameters, @fd array 809 * may be adjusted by the subdev driver to device capabilities. 810 * 811 * @get_mbus_config: get the media bus configuration of a remote sub-device. 812 * The media bus configuration is usually retrieved from the 813 * firmware interface at sub-device probe time, immediately 814 * applied to the hardware and eventually adjusted by the 815 * driver. Remote sub-devices (usually video receivers) shall 816 * use this operation to query the transmitting end bus 817 * configuration in order to adjust their own one accordingly. 818 * Callers should make sure they get the most up-to-date as 819 * possible configuration from the remote end, likely calling 820 * this operation as close as possible to stream on time. The 821 * operation shall fail if the pad index it has been called on 822 * is not valid or in case of unrecoverable failures. The 823 * config argument has been memset to 0 just before calling 824 * the op. 825 * 826 * @set_routing: Enable or disable data connection routes described in the 827 * subdevice routing table. Subdevs that implement this operation 828 * must set the V4L2_SUBDEV_FL_STREAMS flag. 829 * 830 * @enable_streams: Enable the streams defined in streams_mask on the given 831 * source pad. Subdevs that implement this operation must use the active 832 * state management provided by the subdev core (enabled through a call to 833 * v4l2_subdev_init_finalize() at initialization time). Do not call 834 * directly, use v4l2_subdev_enable_streams() instead. 835 * 836 * Drivers that support only a single stream without setting the 837 * V4L2_SUBDEV_CAP_STREAMS sub-device capability flag can ignore the mask 838 * argument. 839 * 840 * @disable_streams: Disable the streams defined in streams_mask on the given 841 * source pad. Subdevs that implement this operation must use the active 842 * state management provided by the subdev core (enabled through a call to 843 * v4l2_subdev_init_finalize() at initialization time). Do not call 844 * directly, use v4l2_subdev_disable_streams() instead. 845 * 846 * Drivers that support only a single stream without setting the 847 * V4L2_SUBDEV_CAP_STREAMS sub-device capability flag can ignore the mask 848 * argument. 849 */ 850 struct v4l2_subdev_pad_ops { 851 int (*enum_mbus_code)(struct v4l2_subdev *sd, 852 struct v4l2_subdev_state *state, 853 struct v4l2_subdev_mbus_code_enum *code); 854 int (*enum_frame_size)(struct v4l2_subdev *sd, 855 struct v4l2_subdev_state *state, 856 struct v4l2_subdev_frame_size_enum *fse); 857 int (*enum_frame_interval)(struct v4l2_subdev *sd, 858 struct v4l2_subdev_state *state, 859 struct v4l2_subdev_frame_interval_enum *fie); 860 int (*get_fmt)(struct v4l2_subdev *sd, 861 struct v4l2_subdev_state *state, 862 struct v4l2_subdev_format *format); 863 int (*set_fmt)(struct v4l2_subdev *sd, 864 struct v4l2_subdev_state *state, 865 struct v4l2_subdev_format *format); 866 int (*get_selection)(struct v4l2_subdev *sd, 867 struct v4l2_subdev_state *state, 868 struct v4l2_subdev_selection *sel); 869 int (*set_selection)(struct v4l2_subdev *sd, 870 struct v4l2_subdev_state *state, 871 struct v4l2_subdev_selection *sel); 872 int (*get_frame_interval)(struct v4l2_subdev *sd, 873 struct v4l2_subdev_state *state, 874 struct v4l2_subdev_frame_interval *interval); 875 int (*set_frame_interval)(struct v4l2_subdev *sd, 876 struct v4l2_subdev_state *state, 877 struct v4l2_subdev_frame_interval *interval); 878 int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); 879 int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); 880 int (*s_dv_timings)(struct v4l2_subdev *sd, unsigned int pad, 881 struct v4l2_dv_timings *timings); 882 int (*g_dv_timings)(struct v4l2_subdev *sd, unsigned int pad, 883 struct v4l2_dv_timings *timings); 884 int (*query_dv_timings)(struct v4l2_subdev *sd, unsigned int pad, 885 struct v4l2_dv_timings *timings); 886 int (*dv_timings_cap)(struct v4l2_subdev *sd, 887 struct v4l2_dv_timings_cap *cap); 888 int (*enum_dv_timings)(struct v4l2_subdev *sd, 889 struct v4l2_enum_dv_timings *timings); 890 #ifdef CONFIG_MEDIA_CONTROLLER 891 int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link, 892 struct v4l2_subdev_format *source_fmt, 893 struct v4l2_subdev_format *sink_fmt); 894 #endif /* CONFIG_MEDIA_CONTROLLER */ 895 int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, 896 struct v4l2_mbus_frame_desc *fd); 897 int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, 898 struct v4l2_mbus_frame_desc *fd); 899 int (*get_mbus_config)(struct v4l2_subdev *sd, unsigned int pad, 900 struct v4l2_mbus_config *config); 901 int (*set_routing)(struct v4l2_subdev *sd, 902 struct v4l2_subdev_state *state, 903 enum v4l2_subdev_format_whence which, 904 struct v4l2_subdev_krouting *route); 905 int (*enable_streams)(struct v4l2_subdev *sd, 906 struct v4l2_subdev_state *state, u32 pad, 907 u64 streams_mask); 908 int (*disable_streams)(struct v4l2_subdev *sd, 909 struct v4l2_subdev_state *state, u32 pad, 910 u64 streams_mask); 911 }; 912 913 /** 914 * struct v4l2_subdev_ops - Subdev operations 915 * 916 * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL 917 * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL 918 * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL 919 * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL 920 * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL 921 * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL 922 * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL 923 * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL 924 */ 925 struct v4l2_subdev_ops { 926 const struct v4l2_subdev_core_ops *core; 927 const struct v4l2_subdev_tuner_ops *tuner; 928 const struct v4l2_subdev_audio_ops *audio; 929 const struct v4l2_subdev_video_ops *video; 930 const struct v4l2_subdev_vbi_ops *vbi; 931 const struct v4l2_subdev_ir_ops *ir; 932 const struct v4l2_subdev_sensor_ops *sensor; 933 const struct v4l2_subdev_pad_ops *pad; 934 }; 935 936 /** 937 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops 938 * 939 * @init_state: initialize the subdev state to default values 940 * 941 * @registered: called when this subdev is registered. When called the v4l2_dev 942 * field is set to the correct v4l2_device. 943 * 944 * @unregistered: called when this subdev is unregistered. When called the 945 * v4l2_dev field is still set to the correct v4l2_device. 946 * 947 * @open: called when the subdev device node is opened by an application. 948 * 949 * @close: called when the subdev device node is closed. Please note that 950 * it is possible for @close to be called after @unregistered! 951 * 952 * @release: called when the last user of the subdev device is gone. This 953 * happens after the @unregistered callback and when the last open 954 * filehandle to the v4l-subdevX device node was closed. If no device 955 * node was created for this sub-device, then the @release callback 956 * is called right after the @unregistered callback. 957 * The @release callback is typically used to free the memory containing 958 * the v4l2_subdev structure. It is almost certainly required for any 959 * sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag. 960 * 961 * .. note:: 962 * Never call this from drivers, only the v4l2 framework can call 963 * these ops. 964 */ 965 struct v4l2_subdev_internal_ops { 966 int (*init_state)(struct v4l2_subdev *sd, 967 struct v4l2_subdev_state *state); 968 int (*registered)(struct v4l2_subdev *sd); 969 void (*unregistered)(struct v4l2_subdev *sd); 970 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); 971 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); 972 void (*release)(struct v4l2_subdev *sd); 973 }; 974 975 /* Set this flag if this subdev is a i2c device. */ 976 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0) 977 /* Set this flag if this subdev is a spi device. */ 978 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1) 979 /* Set this flag if this subdev needs a device node. */ 980 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2) 981 /* 982 * Set this flag if this subdev generates events. 983 * Note controls can send events, thus drivers exposing controls 984 * should set this flag. 985 */ 986 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3) 987 /* 988 * Set this flag if this subdev supports multiplexed streams. This means 989 * that the driver supports routing and handles the stream parameter in its 990 * v4l2_subdev_pad_ops handlers. More specifically, this means: 991 * 992 * - Centrally managed subdev active state is enabled 993 * - Legacy pad config is _not_ supported (state->pads is NULL) 994 * - Routing ioctls are available 995 * - Multiple streams per pad are supported 996 */ 997 #define V4L2_SUBDEV_FL_STREAMS (1U << 4) 998 999 struct regulator_bulk_data; 1000 1001 /** 1002 * struct v4l2_subdev_platform_data - regulators config struct 1003 * 1004 * @regulators: Optional regulators used to power on/off the subdevice 1005 * @num_regulators: Number of regululators 1006 * @host_priv: Per-subdevice data, specific for a certain video host device 1007 */ 1008 struct v4l2_subdev_platform_data { 1009 struct regulator_bulk_data *regulators; 1010 int num_regulators; 1011 1012 void *host_priv; 1013 }; 1014 1015 /** 1016 * struct v4l2_subdev - describes a V4L2 sub-device 1017 * 1018 * @entity: pointer to &struct media_entity 1019 * @list: List of sub-devices 1020 * @owner: The owner is the same as the driver's &struct device owner. 1021 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev 1022 * owner. Initialized by v4l2_device_register_subdev(). 1023 * @flags: subdev flags. Can be: 1024 * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device; 1025 * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device; 1026 * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a 1027 * device node; 1028 * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates 1029 * events. 1030 * 1031 * @v4l2_dev: pointer to struct &v4l2_device 1032 * @ops: pointer to struct &v4l2_subdev_ops 1033 * @internal_ops: pointer to struct &v4l2_subdev_internal_ops. 1034 * Never call these internal ops from within a driver! 1035 * @ctrl_handler: The control handler of this subdev. May be NULL. 1036 * @name: Name of the sub-device. Please notice that the name must be unique. 1037 * @grp_id: can be used to group similar subdevs. Value is driver-specific 1038 * @dev_priv: pointer to private data 1039 * @host_priv: pointer to private data used by the device where the subdev 1040 * is attached. 1041 * @devnode: subdev device node 1042 * @dev: pointer to the physical device, if any 1043 * @fwnode: The fwnode_handle of the subdev, usually the same as 1044 * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL). 1045 * @async_list: Links this subdev to a global subdev_list or 1046 * @notifier->done_list list. 1047 * @async_subdev_endpoint_list: List entry in async_subdev_endpoint_entry of 1048 * &struct v4l2_async_subdev_endpoint. 1049 * @subdev_notifier: A sub-device notifier implicitly registered for the sub- 1050 * device using v4l2_async_register_subdev_sensor(). 1051 * @asc_list: Async connection list, of &struct 1052 * v4l2_async_connection.subdev_entry. 1053 * @pdata: common part of subdevice platform data 1054 * @state_lock: A pointer to a lock used for all the subdev's states, set by the 1055 * driver. This is optional. If NULL, each state instance will get 1056 * a lock of its own. 1057 * @privacy_led: Optional pointer to a LED classdev for the privacy LED for sensors. 1058 * @active_state: Active state for the subdev (NULL for subdevs tracking the 1059 * state internally). Initialized by calling 1060 * v4l2_subdev_init_finalize(). 1061 * @enabled_pads: Bitmask of enabled pads used by v4l2_subdev_enable_streams() 1062 * and v4l2_subdev_disable_streams() helper functions for 1063 * fallback cases. 1064 * @s_stream_enabled: Tracks whether streaming has been enabled with s_stream. 1065 * This is only for call_s_stream() internal use. 1066 * 1067 * Each instance of a subdev driver should create this struct, either 1068 * stand-alone or embedded in a larger struct. 1069 * 1070 * This structure should be initialized by v4l2_subdev_init() or one of 1071 * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init(). 1072 */ 1073 struct v4l2_subdev { 1074 #if defined(CONFIG_MEDIA_CONTROLLER) 1075 struct media_entity entity; 1076 #endif 1077 struct list_head list; 1078 struct module *owner; 1079 bool owner_v4l2_dev; 1080 u32 flags; 1081 struct v4l2_device *v4l2_dev; 1082 const struct v4l2_subdev_ops *ops; 1083 const struct v4l2_subdev_internal_ops *internal_ops; 1084 struct v4l2_ctrl_handler *ctrl_handler; 1085 char name[52]; 1086 u32 grp_id; 1087 void *dev_priv; 1088 void *host_priv; 1089 struct video_device *devnode; 1090 struct device *dev; 1091 struct fwnode_handle *fwnode; 1092 struct list_head async_list; 1093 struct list_head async_subdev_endpoint_list; 1094 struct v4l2_async_notifier *subdev_notifier; 1095 struct list_head asc_list; 1096 struct v4l2_subdev_platform_data *pdata; 1097 struct mutex *state_lock; 1098 1099 /* 1100 * The fields below are private, and should only be accessed via 1101 * appropriate functions. 1102 */ 1103 1104 struct led_classdev *privacy_led; 1105 1106 /* 1107 * TODO: active_state should most likely be changed from a pointer to an 1108 * embedded field. For the time being it's kept as a pointer to more 1109 * easily catch uses of active_state in the cases where the driver 1110 * doesn't support it. 1111 */ 1112 struct v4l2_subdev_state *active_state; 1113 u64 enabled_pads; 1114 bool s_stream_enabled; 1115 }; 1116 1117 1118 /** 1119 * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from 1120 * the &struct media_entity embedded in it. 1121 * 1122 * @ent: pointer to &struct media_entity. 1123 */ 1124 #define media_entity_to_v4l2_subdev(ent) \ 1125 ({ \ 1126 typeof(ent) __me_sd_ent = (ent); \ 1127 \ 1128 __me_sd_ent ? \ 1129 container_of(__me_sd_ent, struct v4l2_subdev, entity) : \ 1130 NULL; \ 1131 }) 1132 1133 /** 1134 * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from 1135 * the &struct video_device embedded on it. 1136 * 1137 * @vdev: pointer to &struct video_device 1138 */ 1139 #define vdev_to_v4l2_subdev(vdev) \ 1140 ((struct v4l2_subdev *)video_get_drvdata(vdev)) 1141 1142 /** 1143 * struct v4l2_subdev_fh - Used for storing subdev information per file handle 1144 * 1145 * @vfh: pointer to &struct v4l2_fh 1146 * @state: pointer to &struct v4l2_subdev_state 1147 * @owner: module pointer to the owner of this file handle 1148 * @client_caps: bitmask of ``V4L2_SUBDEV_CLIENT_CAP_*`` 1149 */ 1150 struct v4l2_subdev_fh { 1151 struct v4l2_fh vfh; 1152 struct module *owner; 1153 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 1154 struct v4l2_subdev_state *state; 1155 u64 client_caps; 1156 #endif 1157 }; 1158 1159 /** 1160 * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from 1161 * the &struct v4l2_fh embedded on it. 1162 * 1163 * @fh: pointer to &struct v4l2_fh 1164 */ 1165 #define to_v4l2_subdev_fh(fh) \ 1166 container_of(fh, struct v4l2_subdev_fh, vfh) 1167 1168 extern const struct v4l2_file_operations v4l2_subdev_fops; 1169 1170 /** 1171 * v4l2_set_subdevdata - Sets V4L2 dev private device data 1172 * 1173 * @sd: pointer to &struct v4l2_subdev 1174 * @p: pointer to the private device data to be stored. 1175 */ 1176 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) 1177 { 1178 sd->dev_priv = p; 1179 } 1180 1181 /** 1182 * v4l2_get_subdevdata - Gets V4L2 dev private device data 1183 * 1184 * @sd: pointer to &struct v4l2_subdev 1185 * 1186 * Returns the pointer to the private device data to be stored. 1187 */ 1188 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) 1189 { 1190 return sd->dev_priv; 1191 } 1192 1193 /** 1194 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data 1195 * 1196 * @sd: pointer to &struct v4l2_subdev 1197 * @p: pointer to the private data to be stored. 1198 */ 1199 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p) 1200 { 1201 sd->host_priv = p; 1202 } 1203 1204 /** 1205 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data 1206 * 1207 * @sd: pointer to &struct v4l2_subdev 1208 * 1209 * Returns the pointer to the private host data to be stored. 1210 */ 1211 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd) 1212 { 1213 return sd->host_priv; 1214 } 1215 1216 #ifdef CONFIG_MEDIA_CONTROLLER 1217 1218 /** 1219 * v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode 1220 * endpoint, assuming 1:1 port:pad 1221 * 1222 * @entity: Pointer to the subdev entity 1223 * @endpoint: Pointer to a parsed fwnode endpoint 1224 * 1225 * This function can be used as the .get_fwnode_pad operation for 1226 * subdevices that map port numbers and pad indexes 1:1. If the endpoint 1227 * is owned by the subdevice, the function returns the endpoint port 1228 * number. 1229 * 1230 * Returns the endpoint port number on success or a negative error code. 1231 */ 1232 int v4l2_subdev_get_fwnode_pad_1_to_1(struct media_entity *entity, 1233 struct fwnode_endpoint *endpoint); 1234 1235 /** 1236 * v4l2_subdev_link_validate_default - validates a media link 1237 * 1238 * @sd: pointer to &struct v4l2_subdev 1239 * @link: pointer to &struct media_link 1240 * @source_fmt: pointer to &struct v4l2_subdev_format 1241 * @sink_fmt: pointer to &struct v4l2_subdev_format 1242 * 1243 * This function ensures that width, height and the media bus pixel 1244 * code are equal on both source and sink of the link. 1245 */ 1246 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd, 1247 struct media_link *link, 1248 struct v4l2_subdev_format *source_fmt, 1249 struct v4l2_subdev_format *sink_fmt); 1250 1251 /** 1252 * v4l2_subdev_link_validate - validates a media link 1253 * 1254 * @link: pointer to &struct media_link 1255 * 1256 * This function calls the subdev's link_validate ops to validate 1257 * if a media link is valid for streaming. It also internally 1258 * calls v4l2_subdev_link_validate_default() to ensure that 1259 * width, height and the media bus pixel code are equal on both 1260 * source and sink of the link. 1261 * 1262 * The function can be used as a drop-in &media_entity_ops.link_validate 1263 * implementation for v4l2_subdev instances. It supports all links between 1264 * subdevs, as well as links between subdevs and video devices, provided that 1265 * the video devices also implement their &media_entity_ops.link_validate 1266 * operation. 1267 */ 1268 int v4l2_subdev_link_validate(struct media_link *link); 1269 1270 /** 1271 * v4l2_subdev_has_pad_interdep - MC has_pad_interdep implementation for subdevs 1272 * 1273 * @entity: pointer to &struct media_entity 1274 * @pad0: pad number for the first pad 1275 * @pad1: pad number for the second pad 1276 * 1277 * This function is an implementation of the 1278 * media_entity_operations.has_pad_interdep operation for subdevs that 1279 * implement the multiplexed streams API (as indicated by the 1280 * V4L2_SUBDEV_FL_STREAMS subdev flag). 1281 * 1282 * It considers two pads interdependent if there is an active route between pad0 1283 * and pad1. 1284 */ 1285 bool v4l2_subdev_has_pad_interdep(struct media_entity *entity, 1286 unsigned int pad0, unsigned int pad1); 1287 1288 /** 1289 * __v4l2_subdev_state_alloc - allocate v4l2_subdev_state 1290 * 1291 * @sd: pointer to &struct v4l2_subdev for which the state is being allocated. 1292 * @lock_name: name of the state lock 1293 * @key: lock_class_key for the lock 1294 * 1295 * Must call __v4l2_subdev_state_free() when state is no longer needed. 1296 * 1297 * Not to be called directly by the drivers. 1298 */ 1299 struct v4l2_subdev_state *__v4l2_subdev_state_alloc(struct v4l2_subdev *sd, 1300 const char *lock_name, 1301 struct lock_class_key *key); 1302 1303 /** 1304 * __v4l2_subdev_state_free - free a v4l2_subdev_state 1305 * 1306 * @state: v4l2_subdev_state to be freed. 1307 * 1308 * Not to be called directly by the drivers. 1309 */ 1310 void __v4l2_subdev_state_free(struct v4l2_subdev_state *state); 1311 1312 /** 1313 * v4l2_subdev_init_finalize() - Finalizes the initialization of the subdevice 1314 * @sd: The subdev 1315 * 1316 * This function finalizes the initialization of the subdev, including 1317 * allocation of the active state for the subdev. 1318 * 1319 * This function must be called by the subdev drivers that use the centralized 1320 * active state, after the subdev struct has been initialized and 1321 * media_entity_pads_init() has been called, but before registering the 1322 * subdev. 1323 * 1324 * The user must call v4l2_subdev_cleanup() when the subdev is being removed. 1325 */ 1326 #define v4l2_subdev_init_finalize(sd) \ 1327 ({ \ 1328 static struct lock_class_key __key; \ 1329 const char *name = KBUILD_BASENAME \ 1330 ":" __stringify(__LINE__) ":sd->active_state->lock"; \ 1331 __v4l2_subdev_init_finalize(sd, name, &__key); \ 1332 }) 1333 1334 int __v4l2_subdev_init_finalize(struct v4l2_subdev *sd, const char *name, 1335 struct lock_class_key *key); 1336 1337 /** 1338 * v4l2_subdev_cleanup() - Releases the resources allocated by the subdevice 1339 * @sd: The subdevice 1340 * 1341 * Clean up a V4L2 async sub-device. Must be called for a sub-device as part of 1342 * its release if resources have been associated with it using 1343 * v4l2_async_subdev_endpoint_add() or v4l2_subdev_init_finalize(). 1344 */ 1345 void v4l2_subdev_cleanup(struct v4l2_subdev *sd); 1346 1347 /* 1348 * A macro to generate the macro or function name for sub-devices state access 1349 * wrapper macros below. 1350 */ 1351 #define __v4l2_subdev_state_gen_call(NAME, _1, ARG, ...) \ 1352 __v4l2_subdev_state_get_ ## NAME ## ARG 1353 1354 /* 1355 * A macro to constify the return value of the state accessors when the state 1356 * parameter is const. 1357 */ 1358 #define __v4l2_subdev_state_constify_ret(state, value) \ 1359 _Generic(state, \ 1360 const struct v4l2_subdev_state *: (const typeof(*(value)) *)(value), \ 1361 struct v4l2_subdev_state *: (value) \ 1362 ) 1363 1364 /** 1365 * v4l2_subdev_state_get_format() - Get pointer to a stream format 1366 * @state: subdevice state 1367 * @pad: pad id 1368 * @...: stream id (optional argument) 1369 * 1370 * This returns a pointer to &struct v4l2_mbus_framefmt for the given pad + 1371 * stream in the subdev state. 1372 * 1373 * For stream-unaware drivers the format for the corresponding pad is returned. 1374 * If the pad does not exist, NULL is returned. 1375 */ 1376 /* 1377 * Wrap v4l2_subdev_state_get_format(), allowing the function to be called with 1378 * two or three arguments. The purpose of the __v4l2_subdev_state_gen_call() 1379 * macro is to come up with the name of the function or macro to call, using 1380 * the last two arguments (_stream and _pad). The selected function or macro is 1381 * then called using the arguments specified by the caller. The 1382 * __v4l2_subdev_state_constify_ret() macro constifies the returned pointer 1383 * when the state is const, allowing the state accessors to guarantee 1384 * const-correctness in all cases. 1385 * 1386 * A similar arrangement is used for v4l2_subdev_state_crop(), 1387 * v4l2_subdev_state_compose() and v4l2_subdev_state_get_interval() below. 1388 */ 1389 #define v4l2_subdev_state_get_format(state, pad, ...) \ 1390 __v4l2_subdev_state_constify_ret(state, \ 1391 __v4l2_subdev_state_gen_call(format, ##__VA_ARGS__, , _pad) \ 1392 ((struct v4l2_subdev_state *)state, pad, ##__VA_ARGS__)) 1393 #define __v4l2_subdev_state_get_format_pad(state, pad) \ 1394 __v4l2_subdev_state_get_format(state, pad, 0) 1395 struct v4l2_mbus_framefmt * 1396 __v4l2_subdev_state_get_format(struct v4l2_subdev_state *state, 1397 unsigned int pad, u32 stream); 1398 1399 /** 1400 * v4l2_subdev_state_get_crop() - Get pointer to a stream crop rectangle 1401 * @state: subdevice state 1402 * @pad: pad id 1403 * @...: stream id (optional argument) 1404 * 1405 * This returns a pointer to crop rectangle for the given pad + stream in the 1406 * subdev state. 1407 * 1408 * For stream-unaware drivers the crop rectangle for the corresponding pad is 1409 * returned. If the pad does not exist, NULL is returned. 1410 */ 1411 #define v4l2_subdev_state_get_crop(state, pad, ...) \ 1412 __v4l2_subdev_state_constify_ret(state, \ 1413 __v4l2_subdev_state_gen_call(crop, ##__VA_ARGS__, , _pad) \ 1414 ((struct v4l2_subdev_state *)state, pad, ##__VA_ARGS__)) 1415 #define __v4l2_subdev_state_get_crop_pad(state, pad) \ 1416 __v4l2_subdev_state_get_crop(state, pad, 0) 1417 struct v4l2_rect * 1418 __v4l2_subdev_state_get_crop(struct v4l2_subdev_state *state, unsigned int pad, 1419 u32 stream); 1420 1421 /** 1422 * v4l2_subdev_state_get_compose() - Get pointer to a stream compose rectangle 1423 * @state: subdevice state 1424 * @pad: pad id 1425 * @...: stream id (optional argument) 1426 * 1427 * This returns a pointer to compose rectangle for the given pad + stream in the 1428 * subdev state. 1429 * 1430 * For stream-unaware drivers the compose rectangle for the corresponding pad is 1431 * returned. If the pad does not exist, NULL is returned. 1432 */ 1433 #define v4l2_subdev_state_get_compose(state, pad, ...) \ 1434 __v4l2_subdev_state_constify_ret(state, \ 1435 __v4l2_subdev_state_gen_call(compose, ##__VA_ARGS__, , _pad) \ 1436 ((struct v4l2_subdev_state *)state, pad, ##__VA_ARGS__)) 1437 #define __v4l2_subdev_state_get_compose_pad(state, pad) \ 1438 __v4l2_subdev_state_get_compose(state, pad, 0) 1439 struct v4l2_rect * 1440 __v4l2_subdev_state_get_compose(struct v4l2_subdev_state *state, 1441 unsigned int pad, u32 stream); 1442 1443 /** 1444 * v4l2_subdev_state_get_interval() - Get pointer to a stream frame interval 1445 * @state: subdevice state 1446 * @pad: pad id 1447 * @...: stream id (optional argument) 1448 * 1449 * This returns a pointer to the frame interval for the given pad + stream in 1450 * the subdev state. 1451 * 1452 * For stream-unaware drivers the frame interval for the corresponding pad is 1453 * returned. If the pad does not exist, NULL is returned. 1454 */ 1455 #define v4l2_subdev_state_get_interval(state, pad, ...) \ 1456 __v4l2_subdev_state_constify_ret(state, \ 1457 __v4l2_subdev_state_gen_call(interval, ##__VA_ARGS__, , _pad) \ 1458 ((struct v4l2_subdev_state *)state, pad, ##__VA_ARGS__)) 1459 #define __v4l2_subdev_state_get_interval_pad(state, pad) \ 1460 __v4l2_subdev_state_get_interval(state, pad, 0) 1461 struct v4l2_fract * 1462 __v4l2_subdev_state_get_interval(struct v4l2_subdev_state *state, 1463 unsigned int pad, u32 stream); 1464 1465 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 1466 1467 /** 1468 * v4l2_subdev_get_fmt() - Fill format based on state 1469 * @sd: subdevice 1470 * @state: subdevice state 1471 * @format: pointer to &struct v4l2_subdev_format 1472 * 1473 * Fill @format->format field based on the information in the @format struct. 1474 * 1475 * This function can be used by the subdev drivers which support active state to 1476 * implement v4l2_subdev_pad_ops.get_fmt if the subdev driver does not need to 1477 * do anything special in their get_fmt op. 1478 * 1479 * Returns 0 on success, error value otherwise. 1480 */ 1481 int v4l2_subdev_get_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_state *state, 1482 struct v4l2_subdev_format *format); 1483 1484 /** 1485 * v4l2_subdev_get_frame_interval() - Fill frame interval based on state 1486 * @sd: subdevice 1487 * @state: subdevice state 1488 * @fi: pointer to &struct v4l2_subdev_frame_interval 1489 * 1490 * Fill @fi->interval field based on the information in the @fi struct. 1491 * 1492 * This function can be used by the subdev drivers which support active state to 1493 * implement v4l2_subdev_pad_ops.get_frame_interval if the subdev driver does 1494 * not need to do anything special in their get_frame_interval op. 1495 * 1496 * Returns 0 on success, error value otherwise. 1497 */ 1498 int v4l2_subdev_get_frame_interval(struct v4l2_subdev *sd, 1499 struct v4l2_subdev_state *state, 1500 struct v4l2_subdev_frame_interval *fi); 1501 1502 /** 1503 * v4l2_subdev_set_routing() - Set given routing to subdev state 1504 * @sd: The subdevice 1505 * @state: The subdevice state 1506 * @routing: Routing that will be copied to subdev state 1507 * 1508 * This will release old routing table (if any) from the state, allocate 1509 * enough space for the given routing, and copy the routing. 1510 * 1511 * This can be used from the subdev driver's set_routing op, after validating 1512 * the routing. 1513 */ 1514 int v4l2_subdev_set_routing(struct v4l2_subdev *sd, 1515 struct v4l2_subdev_state *state, 1516 const struct v4l2_subdev_krouting *routing); 1517 1518 struct v4l2_subdev_route * 1519 __v4l2_subdev_next_active_route(const struct v4l2_subdev_krouting *routing, 1520 struct v4l2_subdev_route *route); 1521 1522 /** 1523 * for_each_active_route - iterate on all active routes of a routing table 1524 * @routing: The routing table 1525 * @route: The route iterator 1526 */ 1527 #define for_each_active_route(routing, route) \ 1528 for ((route) = NULL; \ 1529 ((route) = __v4l2_subdev_next_active_route((routing), (route)));) 1530 1531 /** 1532 * v4l2_subdev_set_routing_with_fmt() - Set given routing and format to subdev 1533 * state 1534 * @sd: The subdevice 1535 * @state: The subdevice state 1536 * @routing: Routing that will be copied to subdev state 1537 * @fmt: Format used to initialize all the streams 1538 * 1539 * This is the same as v4l2_subdev_set_routing, but additionally initializes 1540 * all the streams using the given format. 1541 */ 1542 int v4l2_subdev_set_routing_with_fmt(struct v4l2_subdev *sd, 1543 struct v4l2_subdev_state *state, 1544 const struct v4l2_subdev_krouting *routing, 1545 const struct v4l2_mbus_framefmt *fmt); 1546 1547 /** 1548 * v4l2_subdev_routing_find_opposite_end() - Find the opposite stream 1549 * @routing: routing used to find the opposite side 1550 * @pad: pad id 1551 * @stream: stream id 1552 * @other_pad: pointer used to return the opposite pad 1553 * @other_stream: pointer used to return the opposite stream 1554 * 1555 * This function uses the routing table to find the pad + stream which is 1556 * opposite the given pad + stream. 1557 * 1558 * @other_pad and/or @other_stream can be NULL if the caller does not need the 1559 * value. 1560 * 1561 * Returns 0 on success, or -EINVAL if no matching route is found. 1562 */ 1563 int v4l2_subdev_routing_find_opposite_end(const struct v4l2_subdev_krouting *routing, 1564 u32 pad, u32 stream, u32 *other_pad, 1565 u32 *other_stream); 1566 1567 /** 1568 * v4l2_subdev_state_get_opposite_stream_format() - Get pointer to opposite 1569 * stream format 1570 * @state: subdevice state 1571 * @pad: pad id 1572 * @stream: stream id 1573 * 1574 * This returns a pointer to &struct v4l2_mbus_framefmt for the pad + stream 1575 * that is opposite the given pad + stream in the subdev state. 1576 * 1577 * If the state does not contain the given pad + stream, NULL is returned. 1578 */ 1579 struct v4l2_mbus_framefmt * 1580 v4l2_subdev_state_get_opposite_stream_format(struct v4l2_subdev_state *state, 1581 u32 pad, u32 stream); 1582 1583 /** 1584 * v4l2_subdev_state_xlate_streams() - Translate streams from one pad to another 1585 * 1586 * @state: Subdevice state 1587 * @pad0: The first pad 1588 * @pad1: The second pad 1589 * @streams: Streams bitmask on the first pad 1590 * 1591 * Streams on sink pads of a subdev are routed to source pads as expressed in 1592 * the subdev state routing table. Stream numbers don't necessarily match on 1593 * the sink and source side of a route. This function translates stream numbers 1594 * on @pad0, expressed as a bitmask in @streams, to the corresponding streams 1595 * on @pad1 using the routing table from the @state. It returns the stream mask 1596 * on @pad1, and updates @streams with the streams that have been found in the 1597 * routing table. 1598 * 1599 * @pad0 and @pad1 must be a sink and a source, in any order. 1600 * 1601 * Return: The bitmask of streams of @pad1 that are routed to @streams on @pad0. 1602 */ 1603 u64 v4l2_subdev_state_xlate_streams(const struct v4l2_subdev_state *state, 1604 u32 pad0, u32 pad1, u64 *streams); 1605 1606 /** 1607 * enum v4l2_subdev_routing_restriction - Subdevice internal routing restrictions 1608 * 1609 * @V4L2_SUBDEV_ROUTING_NO_1_TO_N: 1610 * an input stream shall not be routed to multiple output streams (stream 1611 * duplication) 1612 * @V4L2_SUBDEV_ROUTING_NO_N_TO_1: 1613 * multiple input streams shall not be routed to the same output stream 1614 * (stream merging) 1615 * @V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX: 1616 * all streams from a sink pad must be routed to a single source pad 1617 * @V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX: 1618 * all streams on a source pad must originate from a single sink pad 1619 * @V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING: 1620 * source pads shall not contain multiplexed streams 1621 * @V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING: 1622 * sink pads shall not contain multiplexed streams 1623 * @V4L2_SUBDEV_ROUTING_ONLY_1_TO_1: 1624 * only non-overlapping 1-to-1 stream routing is allowed (a combination of 1625 * @V4L2_SUBDEV_ROUTING_NO_1_TO_N and @V4L2_SUBDEV_ROUTING_NO_N_TO_1) 1626 * @V4L2_SUBDEV_ROUTING_NO_STREAM_MIX: 1627 * all streams from a sink pad must be routed to a single source pad, and 1628 * that source pad shall not get routes from any other sink pad 1629 * (a combination of @V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX and 1630 * @V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX) 1631 * @V4L2_SUBDEV_ROUTING_NO_MULTIPLEXING: 1632 * no multiplexed streams allowed on either source or sink sides. 1633 */ 1634 enum v4l2_subdev_routing_restriction { 1635 V4L2_SUBDEV_ROUTING_NO_1_TO_N = BIT(0), 1636 V4L2_SUBDEV_ROUTING_NO_N_TO_1 = BIT(1), 1637 V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX = BIT(2), 1638 V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX = BIT(3), 1639 V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING = BIT(4), 1640 V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING = BIT(5), 1641 V4L2_SUBDEV_ROUTING_ONLY_1_TO_1 = 1642 V4L2_SUBDEV_ROUTING_NO_1_TO_N | 1643 V4L2_SUBDEV_ROUTING_NO_N_TO_1, 1644 V4L2_SUBDEV_ROUTING_NO_STREAM_MIX = 1645 V4L2_SUBDEV_ROUTING_NO_SINK_STREAM_MIX | 1646 V4L2_SUBDEV_ROUTING_NO_SOURCE_STREAM_MIX, 1647 V4L2_SUBDEV_ROUTING_NO_MULTIPLEXING = 1648 V4L2_SUBDEV_ROUTING_NO_SINK_MULTIPLEXING | 1649 V4L2_SUBDEV_ROUTING_NO_SOURCE_MULTIPLEXING, 1650 }; 1651 1652 /** 1653 * v4l2_subdev_routing_validate() - Verify that routes comply with driver 1654 * constraints 1655 * @sd: The subdevice 1656 * @routing: Routing to verify 1657 * @disallow: Restrictions on routes 1658 * 1659 * This verifies that the given routing complies with the @disallow constraints. 1660 * 1661 * Returns 0 on success, error value otherwise. 1662 */ 1663 int v4l2_subdev_routing_validate(struct v4l2_subdev *sd, 1664 const struct v4l2_subdev_krouting *routing, 1665 enum v4l2_subdev_routing_restriction disallow); 1666 1667 /** 1668 * v4l2_subdev_enable_streams() - Enable streams on a pad 1669 * @sd: The subdevice 1670 * @pad: The pad 1671 * @streams_mask: Bitmask of streams to enable 1672 * 1673 * This function enables streams on a source @pad of a subdevice. The pad is 1674 * identified by its index, while the streams are identified by the 1675 * @streams_mask bitmask. This allows enabling multiple streams on a pad at 1676 * once. 1677 * 1678 * Enabling a stream that is already enabled isn't allowed. If @streams_mask 1679 * contains an already enabled stream, this function returns -EALREADY without 1680 * performing any operation. 1681 * 1682 * Per-stream enable is only available for subdevs that implement the 1683 * .enable_streams() and .disable_streams() operations. For other subdevs, this 1684 * function implements a best-effort compatibility by calling the .s_stream() 1685 * operation, limited to subdevs that have a single source pad. 1686 * 1687 * Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0). 1688 * 1689 * Return: 1690 * * 0: Success 1691 * * -EALREADY: One of the streams in streams_mask is already enabled 1692 * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad 1693 * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is 1694 * impossible because the subdev has multiple source pads 1695 */ 1696 int v4l2_subdev_enable_streams(struct v4l2_subdev *sd, u32 pad, 1697 u64 streams_mask); 1698 1699 /** 1700 * v4l2_subdev_disable_streams() - Disable streams on a pad 1701 * @sd: The subdevice 1702 * @pad: The pad 1703 * @streams_mask: Bitmask of streams to disable 1704 * 1705 * This function disables streams on a source @pad of a subdevice. The pad is 1706 * identified by its index, while the streams are identified by the 1707 * @streams_mask bitmask. This allows disabling multiple streams on a pad at 1708 * once. 1709 * 1710 * Disabling a streams that is not enabled isn't allowed. If @streams_mask 1711 * contains a disabled stream, this function returns -EALREADY without 1712 * performing any operation. 1713 * 1714 * Per-stream disable is only available for subdevs that implement the 1715 * .enable_streams() and .disable_streams() operations. For other subdevs, this 1716 * function implements a best-effort compatibility by calling the .s_stream() 1717 * operation, limited to subdevs that have a single source pad. 1718 * 1719 * Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0). 1720 * 1721 * Return: 1722 * * 0: Success 1723 * * -EALREADY: One of the streams in streams_mask is not enabled 1724 * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad 1725 * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is 1726 * impossible because the subdev has multiple source pads 1727 */ 1728 int v4l2_subdev_disable_streams(struct v4l2_subdev *sd, u32 pad, 1729 u64 streams_mask); 1730 1731 /** 1732 * v4l2_subdev_s_stream_helper() - Helper to implement the subdev s_stream 1733 * operation using enable_streams and disable_streams 1734 * @sd: The subdevice 1735 * @enable: Enable or disable streaming 1736 * 1737 * Subdevice drivers that implement the streams-aware 1738 * &v4l2_subdev_pad_ops.enable_streams and &v4l2_subdev_pad_ops.disable_streams 1739 * operations can use this helper to implement the legacy 1740 * &v4l2_subdev_video_ops.s_stream operation. 1741 * 1742 * This helper can only be used by subdevs that have a single source pad. 1743 * 1744 * Return: 0 on success, or a negative error code otherwise. 1745 */ 1746 int v4l2_subdev_s_stream_helper(struct v4l2_subdev *sd, int enable); 1747 1748 #endif /* CONFIG_VIDEO_V4L2_SUBDEV_API */ 1749 1750 #endif /* CONFIG_MEDIA_CONTROLLER */ 1751 1752 /** 1753 * v4l2_subdev_lock_state() - Locks the subdev state 1754 * @state: The subdevice state 1755 * 1756 * Locks the given subdev state. 1757 * 1758 * The state must be unlocked with v4l2_subdev_unlock_state() after use. 1759 */ 1760 static inline void v4l2_subdev_lock_state(struct v4l2_subdev_state *state) 1761 { 1762 mutex_lock(state->lock); 1763 } 1764 1765 /** 1766 * v4l2_subdev_unlock_state() - Unlocks the subdev state 1767 * @state: The subdevice state 1768 * 1769 * Unlocks the given subdev state. 1770 */ 1771 static inline void v4l2_subdev_unlock_state(struct v4l2_subdev_state *state) 1772 { 1773 mutex_unlock(state->lock); 1774 } 1775 1776 /** 1777 * v4l2_subdev_lock_states - Lock two sub-device states 1778 * @state1: One subdevice state 1779 * @state2: The other subdevice state 1780 * 1781 * Locks the state of two sub-devices. 1782 * 1783 * The states must be unlocked with v4l2_subdev_unlock_states() after use. 1784 * 1785 * This differs from calling v4l2_subdev_lock_state() on both states so that if 1786 * the states share the same lock, the lock is acquired only once (so no 1787 * deadlock occurs). The caller is responsible for ensuring the locks will 1788 * always be acquired in the same order. 1789 */ 1790 static inline void v4l2_subdev_lock_states(struct v4l2_subdev_state *state1, 1791 struct v4l2_subdev_state *state2) 1792 { 1793 mutex_lock(state1->lock); 1794 if (state1->lock != state2->lock) 1795 mutex_lock(state2->lock); 1796 } 1797 1798 /** 1799 * v4l2_subdev_unlock_states() - Unlock two sub-device states 1800 * @state1: One subdevice state 1801 * @state2: The other subdevice state 1802 * 1803 * Unlocks the state of two sub-devices. 1804 * 1805 * This differs from calling v4l2_subdev_unlock_state() on both states so that 1806 * if the states share the same lock, the lock is released only once. 1807 */ 1808 static inline void v4l2_subdev_unlock_states(struct v4l2_subdev_state *state1, 1809 struct v4l2_subdev_state *state2) 1810 { 1811 mutex_unlock(state1->lock); 1812 if (state1->lock != state2->lock) 1813 mutex_unlock(state2->lock); 1814 } 1815 1816 /** 1817 * v4l2_subdev_get_unlocked_active_state() - Checks that the active subdev state 1818 * is unlocked and returns it 1819 * @sd: The subdevice 1820 * 1821 * Returns the active state for the subdevice, or NULL if the subdev does not 1822 * support active state. If the state is not NULL, calls 1823 * lockdep_assert_not_held() to issue a warning if the state is locked. 1824 * 1825 * This function is to be used e.g. when getting the active state for the sole 1826 * purpose of passing it forward, without accessing the state fields. 1827 */ 1828 static inline struct v4l2_subdev_state * 1829 v4l2_subdev_get_unlocked_active_state(struct v4l2_subdev *sd) 1830 { 1831 if (sd->active_state) 1832 lockdep_assert_not_held(sd->active_state->lock); 1833 return sd->active_state; 1834 } 1835 1836 /** 1837 * v4l2_subdev_get_locked_active_state() - Checks that the active subdev state 1838 * is locked and returns it 1839 * 1840 * @sd: The subdevice 1841 * 1842 * Returns the active state for the subdevice, or NULL if the subdev does not 1843 * support active state. If the state is not NULL, calls lockdep_assert_held() 1844 * to issue a warning if the state is not locked. 1845 * 1846 * This function is to be used when the caller knows that the active state is 1847 * already locked. 1848 */ 1849 static inline struct v4l2_subdev_state * 1850 v4l2_subdev_get_locked_active_state(struct v4l2_subdev *sd) 1851 { 1852 if (sd->active_state) 1853 lockdep_assert_held(sd->active_state->lock); 1854 return sd->active_state; 1855 } 1856 1857 /** 1858 * v4l2_subdev_lock_and_get_active_state() - Locks and returns the active subdev 1859 * state for the subdevice 1860 * @sd: The subdevice 1861 * 1862 * Returns the locked active state for the subdevice, or NULL if the subdev 1863 * does not support active state. 1864 * 1865 * The state must be unlocked with v4l2_subdev_unlock_state() after use. 1866 */ 1867 static inline struct v4l2_subdev_state * 1868 v4l2_subdev_lock_and_get_active_state(struct v4l2_subdev *sd) 1869 { 1870 if (sd->active_state) 1871 v4l2_subdev_lock_state(sd->active_state); 1872 return sd->active_state; 1873 } 1874 1875 /** 1876 * v4l2_subdev_init - initializes the sub-device struct 1877 * 1878 * @sd: pointer to the &struct v4l2_subdev to be initialized 1879 * @ops: pointer to &struct v4l2_subdev_ops. 1880 */ 1881 void v4l2_subdev_init(struct v4l2_subdev *sd, 1882 const struct v4l2_subdev_ops *ops); 1883 1884 extern const struct v4l2_subdev_ops v4l2_subdev_call_wrappers; 1885 1886 /** 1887 * v4l2_subdev_call - call an operation of a v4l2_subdev. 1888 * 1889 * @sd: pointer to the &struct v4l2_subdev 1890 * @o: name of the element at &struct v4l2_subdev_ops that contains @f. 1891 * Each element there groups a set of callbacks functions. 1892 * @f: callback function to be called. 1893 * The callback functions are defined in groups, according to 1894 * each element at &struct v4l2_subdev_ops. 1895 * @args: arguments for @f. 1896 * 1897 * Example: err = v4l2_subdev_call(sd, video, s_std, norm); 1898 */ 1899 #define v4l2_subdev_call(sd, o, f, args...) \ 1900 ({ \ 1901 struct v4l2_subdev *__sd = (sd); \ 1902 int __result; \ 1903 if (!__sd) \ 1904 __result = -ENODEV; \ 1905 else if (!(__sd->ops->o && __sd->ops->o->f)) \ 1906 __result = -ENOIOCTLCMD; \ 1907 else if (v4l2_subdev_call_wrappers.o && \ 1908 v4l2_subdev_call_wrappers.o->f) \ 1909 __result = v4l2_subdev_call_wrappers.o->f( \ 1910 __sd, ##args); \ 1911 else \ 1912 __result = __sd->ops->o->f(__sd, ##args); \ 1913 __result; \ 1914 }) 1915 1916 /** 1917 * v4l2_subdev_call_state_active - call an operation of a v4l2_subdev which 1918 * takes state as a parameter, passing the 1919 * subdev its active state. 1920 * 1921 * @sd: pointer to the &struct v4l2_subdev 1922 * @o: name of the element at &struct v4l2_subdev_ops that contains @f. 1923 * Each element there groups a set of callbacks functions. 1924 * @f: callback function to be called. 1925 * The callback functions are defined in groups, according to 1926 * each element at &struct v4l2_subdev_ops. 1927 * @args: arguments for @f. 1928 * 1929 * This is similar to v4l2_subdev_call(), except that this version can only be 1930 * used for ops that take a subdev state as a parameter. The macro will get the 1931 * active state, lock it before calling the op and unlock it after the call. 1932 */ 1933 #define v4l2_subdev_call_state_active(sd, o, f, args...) \ 1934 ({ \ 1935 int __result; \ 1936 struct v4l2_subdev_state *state; \ 1937 state = v4l2_subdev_get_unlocked_active_state(sd); \ 1938 if (state) \ 1939 v4l2_subdev_lock_state(state); \ 1940 __result = v4l2_subdev_call(sd, o, f, state, ##args); \ 1941 if (state) \ 1942 v4l2_subdev_unlock_state(state); \ 1943 __result; \ 1944 }) 1945 1946 /** 1947 * v4l2_subdev_call_state_try - call an operation of a v4l2_subdev which 1948 * takes state as a parameter, passing the 1949 * subdev a newly allocated try state. 1950 * 1951 * @sd: pointer to the &struct v4l2_subdev 1952 * @o: name of the element at &struct v4l2_subdev_ops that contains @f. 1953 * Each element there groups a set of callbacks functions. 1954 * @f: callback function to be called. 1955 * The callback functions are defined in groups, according to 1956 * each element at &struct v4l2_subdev_ops. 1957 * @args: arguments for @f. 1958 * 1959 * This is similar to v4l2_subdev_call_state_active(), except that as this 1960 * version allocates a new state, this is only usable for 1961 * V4L2_SUBDEV_FORMAT_TRY use cases. 1962 * 1963 * Note: only legacy non-MC drivers may need this macro. 1964 */ 1965 #define v4l2_subdev_call_state_try(sd, o, f, args...) \ 1966 ({ \ 1967 int __result; \ 1968 static struct lock_class_key __key; \ 1969 const char *name = KBUILD_BASENAME \ 1970 ":" __stringify(__LINE__) ":state->lock"; \ 1971 struct v4l2_subdev_state *state = \ 1972 __v4l2_subdev_state_alloc(sd, name, &__key); \ 1973 v4l2_subdev_lock_state(state); \ 1974 __result = v4l2_subdev_call(sd, o, f, state, ##args); \ 1975 v4l2_subdev_unlock_state(state); \ 1976 __v4l2_subdev_state_free(state); \ 1977 __result; \ 1978 }) 1979 1980 /** 1981 * v4l2_subdev_has_op - Checks if a subdev defines a certain operation. 1982 * 1983 * @sd: pointer to the &struct v4l2_subdev 1984 * @o: The group of callback functions in &struct v4l2_subdev_ops 1985 * which @f is a part of. 1986 * @f: callback function to be checked for its existence. 1987 */ 1988 #define v4l2_subdev_has_op(sd, o, f) \ 1989 ((sd)->ops->o && (sd)->ops->o->f) 1990 1991 /** 1992 * v4l2_subdev_notify_event() - Delivers event notification for subdevice 1993 * @sd: The subdev for which to deliver the event 1994 * @ev: The event to deliver 1995 * 1996 * Will deliver the specified event to all userspace event listeners which are 1997 * subscribed to the v42l subdev event queue as well as to the bridge driver 1998 * using the notify callback. The notification type for the notify callback 1999 * will be %V4L2_DEVICE_NOTIFY_EVENT. 2000 */ 2001 void v4l2_subdev_notify_event(struct v4l2_subdev *sd, 2002 const struct v4l2_event *ev); 2003 2004 /** 2005 * v4l2_subdev_is_streaming() - Returns if the subdevice is streaming 2006 * @sd: The subdevice 2007 * 2008 * v4l2_subdev_is_streaming() tells if the subdevice is currently streaming. 2009 * "Streaming" here means whether .s_stream() or .enable_streams() has been 2010 * successfully called, and the streaming has not yet been disabled. 2011 * 2012 * If the subdevice implements .enable_streams() this function must be called 2013 * while holding the active state lock. 2014 */ 2015 bool v4l2_subdev_is_streaming(struct v4l2_subdev *sd); 2016 2017 #endif /* _V4L2_SUBDEV_H */ 2018