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