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). 180 * 181 * @interrupt_service_routine: Called by the bridge chip's interrupt service 182 * handler, when an interrupt status has be raised due to this subdev, 183 * so that this subdev can handle the details. It may schedule work to be 184 * performed later. It must not sleep. **Called from an IRQ context**. 185 * 186 * @subscribe_event: used by the drivers to request the control framework that 187 * for it to be warned when the value of a control changes. 188 * 189 * @unsubscribe_event: remove event subscription from the control framework. 190 */ 191 struct v4l2_subdev_core_ops { 192 int (*log_status)(struct v4l2_subdev *sd); 193 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n, 194 struct v4l2_subdev_io_pin_config *pincfg); 195 int (*init)(struct v4l2_subdev *sd, u32 val); 196 int (*load_fw)(struct v4l2_subdev *sd); 197 int (*reset)(struct v4l2_subdev *sd, u32 val); 198 int (*s_gpio)(struct v4l2_subdev *sd, u32 val); 199 long (*command)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); 200 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); 201 #ifdef CONFIG_COMPAT 202 long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd, 203 unsigned long arg); 204 #endif 205 #ifdef CONFIG_VIDEO_ADV_DEBUG 206 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); 207 int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg); 208 #endif 209 int (*s_power)(struct v4l2_subdev *sd, int on); 210 int (*interrupt_service_routine)(struct v4l2_subdev *sd, 211 u32 status, bool *handled); 212 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, 213 struct v4l2_event_subscription *sub); 214 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, 215 struct v4l2_event_subscription *sub); 216 }; 217 218 /** 219 * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened 220 * in radio mode. 221 * 222 * @standby: puts the tuner in standby mode. It will be woken up 223 * automatically the next time it is used. 224 * 225 * @s_radio: callback that switches the tuner to radio mode. 226 * drivers should explicitly call it when a tuner ops should 227 * operate on radio mode, before being able to handle it. 228 * Used on devices that have both AM/FM radio receiver and TV. 229 * 230 * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code. 231 * 232 * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code. 233 * freq->type must be filled in. Normally done by video_ioctl2() 234 * or the bridge driver. 235 * 236 * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code. 237 * 238 * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code. 239 * 240 * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be 241 * filled in. Normally done by video_ioctl2 or the 242 * bridge driver. 243 * 244 * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code. 245 * 246 * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code. 247 * 248 * @s_type_addr: sets tuner type and its I2C addr. 249 * 250 * @s_config: sets tda9887 specific stuff, like port1, port2 and qss 251 * 252 * .. note:: 253 * 254 * On devices that have both AM/FM and TV, it is up to the driver 255 * to explicitly call s_radio when the tuner should be switched to 256 * radio mode, before handling other &struct v4l2_subdev_tuner_ops 257 * that would require it. An example of such usage is:: 258 * 259 * static void s_frequency(void *priv, const struct v4l2_frequency *f) 260 * { 261 * ... 262 * if (f.type == V4L2_TUNER_RADIO) 263 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio); 264 * ... 265 * v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency); 266 * } 267 */ 268 struct v4l2_subdev_tuner_ops { 269 int (*standby)(struct v4l2_subdev *sd); 270 int (*s_radio)(struct v4l2_subdev *sd); 271 int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq); 272 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); 273 int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band); 274 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); 275 int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt); 276 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); 277 int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm); 278 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); 279 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); 280 }; 281 282 /** 283 * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings 284 * 285 * @s_clock_freq: set the frequency (in Hz) of the audio clock output. 286 * Used to slave an audio processor to the video decoder, ensuring that 287 * audio and video remain synchronized. Usual values for the frequency 288 * are 48000, 44100 or 32000 Hz. If the frequency is not supported, then 289 * -EINVAL is returned. 290 * 291 * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard 292 * way to select I2S clock used by driving digital audio streams at some 293 * board designs. Usual values for the frequency are 1024000 and 2048000. 294 * If the frequency is not supported, then %-EINVAL is returned. 295 * 296 * @s_routing: used to define the input and/or output pins of an audio chip, 297 * and any additional configuration data. 298 * Never attempt to use user-level input IDs (e.g. Composite, S-Video, 299 * Tuner) at this level. An i2c device shouldn't know about whether an 300 * input pin is connected to a Composite connector, become on another 301 * board or platform it might be connected to something else entirely. 302 * The calling driver is responsible for mapping a user-level input to 303 * the right pins on the i2c device. 304 * 305 * @s_stream: used to notify the audio code that stream will start or has 306 * stopped. 307 */ 308 struct v4l2_subdev_audio_ops { 309 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 310 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 311 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 312 int (*s_stream)(struct v4l2_subdev *sd, int enable); 313 }; 314 315 /** 316 * enum v4l2_mbus_frame_desc_flags - media bus frame description flags 317 * 318 * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX: 319 * Indicates that &struct v4l2_mbus_frame_desc_entry->length field 320 * specifies maximum data length. 321 * @V4L2_MBUS_FRAME_DESC_FL_BLOB: 322 * Indicates that the format does not have line offsets, i.e. 323 * the receiver should use 1D DMA. 324 */ 325 enum v4l2_mbus_frame_desc_flags { 326 V4L2_MBUS_FRAME_DESC_FL_LEN_MAX = BIT(0), 327 V4L2_MBUS_FRAME_DESC_FL_BLOB = BIT(1), 328 }; 329 330 /** 331 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure 332 * 333 * @flags: bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags. 334 * @pixelcode: media bus pixel code, valid if @flags 335 * %FRAME_DESC_FL_BLOB is not set. 336 * @length: number of octets per frame, valid if @flags 337 * %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set. 338 */ 339 struct v4l2_mbus_frame_desc_entry { 340 enum v4l2_mbus_frame_desc_flags flags; 341 u32 pixelcode; 342 u32 length; 343 }; 344 345 #define V4L2_FRAME_DESC_ENTRY_MAX 4 346 347 /** 348 * struct v4l2_mbus_frame_desc - media bus data frame description 349 * @entry: frame descriptors array 350 * @num_entries: number of entries in @entry array 351 */ 352 struct v4l2_mbus_frame_desc { 353 struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX]; 354 unsigned short num_entries; 355 }; 356 357 /** 358 * enum v4l2_subdev_pre_streamon_flags - Flags for pre_streamon subdev core op 359 * 360 * @V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP: Set the transmitter to either LP-11 361 * or LP-111 mode before call to s_stream(). 362 */ 363 enum v4l2_subdev_pre_streamon_flags { 364 V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP = BIT(0), 365 }; 366 367 /** 368 * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened 369 * in video mode. 370 * 371 * @s_routing: see s_routing in audio_ops, except this version is for video 372 * devices. 373 * 374 * @s_crystal_freq: sets the frequency of the crystal used to generate the 375 * clocks in Hz. An extra flags field allows device specific configuration 376 * regarding clock frequency dividers, etc. If not used, then set flags 377 * to 0. If the frequency is not supported, then -EINVAL is returned. 378 * 379 * @g_std: callback for VIDIOC_G_STD() ioctl handler code. 380 * 381 * @s_std: callback for VIDIOC_S_STD() ioctl handler code. 382 * 383 * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by 384 * video input devices. 385 * 386 * @g_std_output: get current standard for video OUTPUT devices. This is ignored 387 * by video input devices. 388 * 389 * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code. 390 * 391 * @g_tvnorms: get &v4l2_std_id with all standards supported by the video 392 * CAPTURE device. This is ignored by video output devices. 393 * 394 * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video 395 * OUTPUT device. This is ignored by video capture devices. 396 * 397 * @g_input_status: get input status. Same as the status field in the 398 * &struct v4l2_input 399 * 400 * @s_stream: used to notify the driver that a video stream will start or has 401 * stopped. 402 * 403 * @g_pixelaspect: callback to return the pixelaspect ratio. 404 * 405 * @g_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL() 406 * ioctl handler code. 407 * 408 * @s_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL() 409 * ioctl handler code. 410 * 411 * @s_dv_timings: Set custom dv timings in the sub device. This is used 412 * when sub device is capable of setting detailed timing information 413 * in the hardware to generate/detect the video signal. 414 * 415 * @g_dv_timings: Get custom dv timings in the sub device. 416 * 417 * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code. 418 * 419 * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev 420 * can adjust @size to a lower value and must not write more data to the 421 * buffer starting at @data than the original value of @size. 422 * 423 * @pre_streamon: May be called before streaming is actually started, to help 424 * initialising the bus. Current usage is to set a CSI-2 transmitter to 425 * LP-11 or LP-111 mode before streaming. See &enum 426 * v4l2_subdev_pre_streamon_flags. 427 * 428 * pre_streamon shall return error if it cannot perform the operation as 429 * indicated by the flags argument. In particular, -EACCES indicates lack 430 * of support for the operation. The caller shall call post_streamoff for 431 * each successful call of pre_streamon. 432 * 433 * @post_streamoff: Called after streaming is stopped, but if and only if 434 * pre_streamon was called earlier. 435 */ 436 struct v4l2_subdev_video_ops { 437 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 438 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags); 439 int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm); 440 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); 441 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); 442 int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std); 443 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); 444 int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std); 445 int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std); 446 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); 447 int (*s_stream)(struct v4l2_subdev *sd, int enable); 448 int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect); 449 int (*g_frame_interval)(struct v4l2_subdev *sd, 450 struct v4l2_subdev_frame_interval *interval); 451 int (*s_frame_interval)(struct v4l2_subdev *sd, 452 struct v4l2_subdev_frame_interval *interval); 453 int (*s_dv_timings)(struct v4l2_subdev *sd, 454 struct v4l2_dv_timings *timings); 455 int (*g_dv_timings)(struct v4l2_subdev *sd, 456 struct v4l2_dv_timings *timings); 457 int (*query_dv_timings)(struct v4l2_subdev *sd, 458 struct v4l2_dv_timings *timings); 459 int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf, 460 unsigned int *size); 461 int (*pre_streamon)(struct v4l2_subdev *sd, u32 flags); 462 int (*post_streamoff)(struct v4l2_subdev *sd); 463 }; 464 465 /** 466 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened 467 * in video mode via the vbi device node. 468 * 469 * @decode_vbi_line: video decoders that support sliced VBI need to implement 470 * this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the 471 * start of the VBI data that was generated by the decoder. The driver 472 * then parses the sliced VBI data and sets the other fields in the 473 * struct accordingly. The pointer p is updated to point to the start of 474 * the payload which can be copied verbatim into the data field of the 475 * &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the 476 * type field is set to 0 on return. 477 * 478 * @s_vbi_data: used to generate VBI signals on a video signal. 479 * &struct v4l2_sliced_vbi_data is filled with the data packets that 480 * should be output. Note that if you set the line field to 0, then that 481 * VBI signal is disabled. If no valid VBI data was found, then the type 482 * field is set to 0 on return. 483 * 484 * @g_vbi_data: used to obtain the sliced VBI packet from a readback register. 485 * Not all video decoders support this. If no data is available because 486 * the readback register contains invalid or erroneous data %-EIO is 487 * returned. Note that you must fill in the 'id' member and the 'field' 488 * member (to determine whether CC data from the first or second field 489 * should be obtained). 490 * 491 * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler 492 * code. 493 * 494 * @s_raw_fmt: setup the video encoder/decoder for raw VBI. 495 * 496 * @g_sliced_fmt: retrieve the current sliced VBI settings. 497 * 498 * @s_sliced_fmt: setup the sliced VBI settings. 499 */ 500 struct v4l2_subdev_vbi_ops { 501 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); 502 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); 503 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); 504 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); 505 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt); 506 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 507 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 508 }; 509 510 /** 511 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations 512 * @g_skip_top_lines: number of lines at the top of the image to be skipped. 513 * This is needed for some sensors, which always corrupt 514 * several top lines of the output image, or which send their 515 * metadata in them. 516 * @g_skip_frames: number of frames to skip at stream start. This is needed for 517 * buggy sensors that generate faulty frames when they are 518 * turned on. 519 */ 520 struct v4l2_subdev_sensor_ops { 521 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines); 522 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames); 523 }; 524 525 /** 526 * enum v4l2_subdev_ir_mode- describes the type of IR supported 527 * 528 * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records 529 */ 530 enum v4l2_subdev_ir_mode { 531 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, 532 }; 533 534 /** 535 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX 536 * 537 * @bytes_per_data_element: bytes per data element of data in read or 538 * write call. 539 * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode. 540 * @enable: device is active if true 541 * @interrupt_enable: IR interrupts are enabled if true 542 * @shutdown: if true: set hardware to low/no power, false: normal mode 543 * 544 * @modulation: if true, it uses carrier, if false: baseband 545 * @max_pulse_width: maximum pulse width in ns, valid only for baseband signal 546 * @carrier_freq: carrier frequency in Hz, valid only for modulated signal 547 * @duty_cycle: duty cycle percentage, valid only for modulated signal 548 * @invert_level: invert signal level 549 * 550 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX. 551 * 552 * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX. 553 * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated 554 * signal. Used only for RX. 555 * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated 556 * signal. Used only for RX. 557 * @resolution: The receive resolution, in ns . Used only for RX. 558 */ 559 struct v4l2_subdev_ir_parameters { 560 unsigned int bytes_per_data_element; 561 enum v4l2_subdev_ir_mode mode; 562 563 bool enable; 564 bool interrupt_enable; 565 bool shutdown; 566 567 bool modulation; 568 u32 max_pulse_width; 569 unsigned int carrier_freq; 570 unsigned int duty_cycle; 571 bool invert_level; 572 573 /* Tx only */ 574 bool invert_carrier_sense; 575 576 /* Rx only */ 577 u32 noise_filter_min_width; 578 unsigned int carrier_range_lower; 579 unsigned int carrier_range_upper; 580 u32 resolution; 581 }; 582 583 /** 584 * struct v4l2_subdev_ir_ops - operations for IR subdevices 585 * 586 * @rx_read: Reads received codes or pulse width data. 587 * The semantics are similar to a non-blocking read() call. 588 * @rx_g_parameters: Get the current operating parameters and state of 589 * the IR receiver. 590 * @rx_s_parameters: Set the current operating parameters and state of 591 * the IR receiver. It is recommended to call 592 * [rt]x_g_parameters first to fill out the current state, and only change 593 * the fields that need to be changed. Upon return, the actual device 594 * operating parameters and state will be returned. Note that hardware 595 * limitations may prevent the actual settings from matching the requested 596 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz 597 * was requested. An exception is when the shutdown parameter is true. 598 * The last used operational parameters will be returned, but the actual 599 * state of the hardware be different to minimize power consumption and 600 * processing when shutdown is true. 601 * 602 * @tx_write: Writes codes or pulse width data for transmission. 603 * The semantics are similar to a non-blocking write() call. 604 * @tx_g_parameters: Get the current operating parameters and state of 605 * the IR transmitter. 606 * @tx_s_parameters: Set the current operating parameters and state of 607 * the IR transmitter. It is recommended to call 608 * [rt]x_g_parameters first to fill out the current state, and only change 609 * the fields that need to be changed. Upon return, the actual device 610 * operating parameters and state will be returned. Note that hardware 611 * limitations may prevent the actual settings from matching the requested 612 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz 613 * was requested. An exception is when the shutdown parameter is true. 614 * The last used operational parameters will be returned, but the actual 615 * state of the hardware be different to minimize power consumption and 616 * processing when shutdown is true. 617 */ 618 struct v4l2_subdev_ir_ops { 619 /* Receiver */ 620 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count, 621 ssize_t *num); 622 623 int (*rx_g_parameters)(struct v4l2_subdev *sd, 624 struct v4l2_subdev_ir_parameters *params); 625 int (*rx_s_parameters)(struct v4l2_subdev *sd, 626 struct v4l2_subdev_ir_parameters *params); 627 628 /* Transmitter */ 629 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count, 630 ssize_t *num); 631 632 int (*tx_g_parameters)(struct v4l2_subdev *sd, 633 struct v4l2_subdev_ir_parameters *params); 634 int (*tx_s_parameters)(struct v4l2_subdev *sd, 635 struct v4l2_subdev_ir_parameters *params); 636 }; 637 638 /** 639 * struct v4l2_subdev_pad_config - Used for storing subdev pad information. 640 * 641 * @try_fmt: &struct v4l2_mbus_framefmt 642 * @try_crop: &struct v4l2_rect to be used for crop 643 * @try_compose: &struct v4l2_rect to be used for compose 644 * 645 * This structure only needs to be passed to the pad op if the 'which' field 646 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For 647 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL. 648 * 649 * Note: This struct is also used in active state, and the 'try' prefix is 650 * historical and to be removed. 651 */ 652 struct v4l2_subdev_pad_config { 653 struct v4l2_mbus_framefmt try_fmt; 654 struct v4l2_rect try_crop; 655 struct v4l2_rect try_compose; 656 }; 657 658 /** 659 * struct v4l2_subdev_state - Used for storing subdev state information. 660 * 661 * @_lock: default for 'lock' 662 * @lock: mutex for the state. May be replaced by the user. 663 * @pads: &struct v4l2_subdev_pad_config array 664 * 665 * This structure only needs to be passed to the pad op if the 'which' field 666 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For 667 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL. 668 */ 669 struct v4l2_subdev_state { 670 /* lock for the struct v4l2_subdev_state fields */ 671 struct mutex _lock; 672 struct mutex *lock; 673 struct v4l2_subdev_pad_config *pads; 674 }; 675 676 /** 677 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations 678 * 679 * @init_cfg: initialize the pad config to default values 680 * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler 681 * code. 682 * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler 683 * code. 684 * 685 * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl 686 * handler code. 687 * 688 * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code. 689 * 690 * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code. 691 * 692 * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code. 693 * 694 * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code. 695 * 696 * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code. 697 * 698 * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code. 699 * 700 * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler 701 * code. 702 * 703 * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler 704 * code. 705 * 706 * @link_validate: used by the media controller code to check if the links 707 * that belongs to a pipeline can be used for stream. 708 * 709 * @get_frame_desc: get the current low level media bus frame parameters. 710 * 711 * @set_frame_desc: set the low level media bus frame parameters, @fd array 712 * may be adjusted by the subdev driver to device capabilities. 713 * 714 * @get_mbus_config: get the media bus configuration of a remote sub-device. 715 * The media bus configuration is usually retrieved from the 716 * firmware interface at sub-device probe time, immediately 717 * applied to the hardware and eventually adjusted by the 718 * driver. Remote sub-devices (usually video receivers) shall 719 * use this operation to query the transmitting end bus 720 * configuration in order to adjust their own one accordingly. 721 * Callers should make sure they get the most up-to-date as 722 * possible configuration from the remote end, likely calling 723 * this operation as close as possible to stream on time. The 724 * operation shall fail if the pad index it has been called on 725 * is not valid or in case of unrecoverable failures. 726 */ 727 struct v4l2_subdev_pad_ops { 728 int (*init_cfg)(struct v4l2_subdev *sd, 729 struct v4l2_subdev_state *state); 730 int (*enum_mbus_code)(struct v4l2_subdev *sd, 731 struct v4l2_subdev_state *state, 732 struct v4l2_subdev_mbus_code_enum *code); 733 int (*enum_frame_size)(struct v4l2_subdev *sd, 734 struct v4l2_subdev_state *state, 735 struct v4l2_subdev_frame_size_enum *fse); 736 int (*enum_frame_interval)(struct v4l2_subdev *sd, 737 struct v4l2_subdev_state *state, 738 struct v4l2_subdev_frame_interval_enum *fie); 739 int (*get_fmt)(struct v4l2_subdev *sd, 740 struct v4l2_subdev_state *state, 741 struct v4l2_subdev_format *format); 742 int (*set_fmt)(struct v4l2_subdev *sd, 743 struct v4l2_subdev_state *state, 744 struct v4l2_subdev_format *format); 745 int (*get_selection)(struct v4l2_subdev *sd, 746 struct v4l2_subdev_state *state, 747 struct v4l2_subdev_selection *sel); 748 int (*set_selection)(struct v4l2_subdev *sd, 749 struct v4l2_subdev_state *state, 750 struct v4l2_subdev_selection *sel); 751 int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); 752 int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); 753 int (*dv_timings_cap)(struct v4l2_subdev *sd, 754 struct v4l2_dv_timings_cap *cap); 755 int (*enum_dv_timings)(struct v4l2_subdev *sd, 756 struct v4l2_enum_dv_timings *timings); 757 #ifdef CONFIG_MEDIA_CONTROLLER 758 int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link, 759 struct v4l2_subdev_format *source_fmt, 760 struct v4l2_subdev_format *sink_fmt); 761 #endif /* CONFIG_MEDIA_CONTROLLER */ 762 int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, 763 struct v4l2_mbus_frame_desc *fd); 764 int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, 765 struct v4l2_mbus_frame_desc *fd); 766 int (*get_mbus_config)(struct v4l2_subdev *sd, unsigned int pad, 767 struct v4l2_mbus_config *config); 768 }; 769 770 /** 771 * struct v4l2_subdev_ops - Subdev operations 772 * 773 * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL 774 * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL 775 * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL 776 * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL 777 * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL 778 * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL 779 * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL 780 * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL 781 */ 782 struct v4l2_subdev_ops { 783 const struct v4l2_subdev_core_ops *core; 784 const struct v4l2_subdev_tuner_ops *tuner; 785 const struct v4l2_subdev_audio_ops *audio; 786 const struct v4l2_subdev_video_ops *video; 787 const struct v4l2_subdev_vbi_ops *vbi; 788 const struct v4l2_subdev_ir_ops *ir; 789 const struct v4l2_subdev_sensor_ops *sensor; 790 const struct v4l2_subdev_pad_ops *pad; 791 }; 792 793 /** 794 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops 795 * 796 * @registered: called when this subdev is registered. When called the v4l2_dev 797 * field is set to the correct v4l2_device. 798 * 799 * @unregistered: called when this subdev is unregistered. When called the 800 * v4l2_dev field is still set to the correct v4l2_device. 801 * 802 * @open: called when the subdev device node is opened by an application. 803 * 804 * @close: called when the subdev device node is closed. Please note that 805 * it is possible for @close to be called after @unregistered! 806 * 807 * @release: called when the last user of the subdev device is gone. This 808 * happens after the @unregistered callback and when the last open 809 * filehandle to the v4l-subdevX device node was closed. If no device 810 * node was created for this sub-device, then the @release callback 811 * is called right after the @unregistered callback. 812 * The @release callback is typically used to free the memory containing 813 * the v4l2_subdev structure. It is almost certainly required for any 814 * sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag. 815 * 816 * .. note:: 817 * Never call this from drivers, only the v4l2 framework can call 818 * these ops. 819 */ 820 struct v4l2_subdev_internal_ops { 821 int (*registered)(struct v4l2_subdev *sd); 822 void (*unregistered)(struct v4l2_subdev *sd); 823 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); 824 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); 825 void (*release)(struct v4l2_subdev *sd); 826 }; 827 828 #define V4L2_SUBDEV_NAME_SIZE 32 829 830 /* Set this flag if this subdev is a i2c device. */ 831 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0) 832 /* Set this flag if this subdev is a spi device. */ 833 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1) 834 /* Set this flag if this subdev needs a device node. */ 835 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2) 836 /* 837 * Set this flag if this subdev generates events. 838 * Note controls can send events, thus drivers exposing controls 839 * should set this flag. 840 */ 841 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3) 842 843 struct regulator_bulk_data; 844 845 /** 846 * struct v4l2_subdev_platform_data - regulators config struct 847 * 848 * @regulators: Optional regulators used to power on/off the subdevice 849 * @num_regulators: Number of regululators 850 * @host_priv: Per-subdevice data, specific for a certain video host device 851 */ 852 struct v4l2_subdev_platform_data { 853 struct regulator_bulk_data *regulators; 854 int num_regulators; 855 856 void *host_priv; 857 }; 858 859 /** 860 * struct v4l2_subdev - describes a V4L2 sub-device 861 * 862 * @entity: pointer to &struct media_entity 863 * @list: List of sub-devices 864 * @owner: The owner is the same as the driver's &struct device owner. 865 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev 866 * owner. Initialized by v4l2_device_register_subdev(). 867 * @flags: subdev flags. Can be: 868 * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device; 869 * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device; 870 * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a 871 * device node; 872 * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates 873 * events. 874 * 875 * @v4l2_dev: pointer to struct &v4l2_device 876 * @ops: pointer to struct &v4l2_subdev_ops 877 * @internal_ops: pointer to struct &v4l2_subdev_internal_ops. 878 * Never call these internal ops from within a driver! 879 * @ctrl_handler: The control handler of this subdev. May be NULL. 880 * @name: Name of the sub-device. Please notice that the name must be unique. 881 * @grp_id: can be used to group similar subdevs. Value is driver-specific 882 * @dev_priv: pointer to private data 883 * @host_priv: pointer to private data used by the device where the subdev 884 * is attached. 885 * @devnode: subdev device node 886 * @dev: pointer to the physical device, if any 887 * @fwnode: The fwnode_handle of the subdev, usually the same as 888 * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL). 889 * @async_list: Links this subdev to a global subdev_list or @notifier->done 890 * list. 891 * @asd: Pointer to respective &struct v4l2_async_subdev. 892 * @notifier: Pointer to the managing notifier. 893 * @subdev_notifier: A sub-device notifier implicitly registered for the sub- 894 * device using v4l2_async_register_subdev_sensor(). 895 * @pdata: common part of subdevice platform data 896 * @state_lock: A pointer to a lock used for all the subdev's states, set by the 897 * driver. This is optional. If NULL, each state instance will get 898 * a lock of its own. 899 * @active_state: Active state for the subdev (NULL for subdevs tracking the 900 * state internally). Initialized by calling 901 * v4l2_subdev_init_finalize(). 902 * 903 * Each instance of a subdev driver should create this struct, either 904 * stand-alone or embedded in a larger struct. 905 * 906 * This structure should be initialized by v4l2_subdev_init() or one of 907 * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init(). 908 */ 909 struct v4l2_subdev { 910 #if defined(CONFIG_MEDIA_CONTROLLER) 911 struct media_entity entity; 912 #endif 913 struct list_head list; 914 struct module *owner; 915 bool owner_v4l2_dev; 916 u32 flags; 917 struct v4l2_device *v4l2_dev; 918 const struct v4l2_subdev_ops *ops; 919 const struct v4l2_subdev_internal_ops *internal_ops; 920 struct v4l2_ctrl_handler *ctrl_handler; 921 char name[V4L2_SUBDEV_NAME_SIZE]; 922 u32 grp_id; 923 void *dev_priv; 924 void *host_priv; 925 struct video_device *devnode; 926 struct device *dev; 927 struct fwnode_handle *fwnode; 928 struct list_head async_list; 929 struct v4l2_async_subdev *asd; 930 struct v4l2_async_notifier *notifier; 931 struct v4l2_async_notifier *subdev_notifier; 932 struct v4l2_subdev_platform_data *pdata; 933 struct mutex *state_lock; 934 935 /* 936 * The fields below are private, and should only be accessed via 937 * appropriate functions. 938 */ 939 940 /* 941 * TODO: active_state should most likely be changed from a pointer to an 942 * embedded field. For the time being it's kept as a pointer to more 943 * easily catch uses of active_state in the cases where the driver 944 * doesn't support it. 945 */ 946 struct v4l2_subdev_state *active_state; 947 }; 948 949 950 /** 951 * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from 952 * the &struct media_entity embedded in it. 953 * 954 * @ent: pointer to &struct media_entity. 955 */ 956 #define media_entity_to_v4l2_subdev(ent) \ 957 ({ \ 958 typeof(ent) __me_sd_ent = (ent); \ 959 \ 960 __me_sd_ent ? \ 961 container_of(__me_sd_ent, struct v4l2_subdev, entity) : \ 962 NULL; \ 963 }) 964 965 /** 966 * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from 967 * the &struct video_device embedded on it. 968 * 969 * @vdev: pointer to &struct video_device 970 */ 971 #define vdev_to_v4l2_subdev(vdev) \ 972 ((struct v4l2_subdev *)video_get_drvdata(vdev)) 973 974 /** 975 * struct v4l2_subdev_fh - Used for storing subdev information per file handle 976 * 977 * @vfh: pointer to &struct v4l2_fh 978 * @state: pointer to &struct v4l2_subdev_state 979 * @owner: module pointer to the owner of this file handle 980 */ 981 struct v4l2_subdev_fh { 982 struct v4l2_fh vfh; 983 struct module *owner; 984 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 985 struct v4l2_subdev_state *state; 986 #endif 987 }; 988 989 /** 990 * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from 991 * the &struct v4l2_fh embedded on it. 992 * 993 * @fh: pointer to &struct v4l2_fh 994 */ 995 #define to_v4l2_subdev_fh(fh) \ 996 container_of(fh, struct v4l2_subdev_fh, vfh) 997 998 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 999 1000 /** 1001 * v4l2_subdev_get_pad_format - ancillary routine to call 1002 * &struct v4l2_subdev_pad_config->try_fmt 1003 * 1004 * @sd: pointer to &struct v4l2_subdev 1005 * @state: pointer to &struct v4l2_subdev_state 1006 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array 1007 */ 1008 static inline struct v4l2_mbus_framefmt * 1009 v4l2_subdev_get_pad_format(struct v4l2_subdev *sd, 1010 struct v4l2_subdev_state *state, 1011 unsigned int pad) 1012 { 1013 if (WARN_ON(pad >= sd->entity.num_pads)) 1014 pad = 0; 1015 return &state->pads[pad].try_fmt; 1016 } 1017 1018 /** 1019 * v4l2_subdev_get_pad_crop - ancillary routine to call 1020 * &struct v4l2_subdev_pad_config->try_crop 1021 * 1022 * @sd: pointer to &struct v4l2_subdev 1023 * @state: pointer to &struct v4l2_subdev_state. 1024 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array. 1025 */ 1026 static inline struct v4l2_rect * 1027 v4l2_subdev_get_pad_crop(struct v4l2_subdev *sd, 1028 struct v4l2_subdev_state *state, 1029 unsigned int pad) 1030 { 1031 if (WARN_ON(pad >= sd->entity.num_pads)) 1032 pad = 0; 1033 return &state->pads[pad].try_crop; 1034 } 1035 1036 /** 1037 * v4l2_subdev_get_pad_compose - ancillary routine to call 1038 * &struct v4l2_subdev_pad_config->try_compose 1039 * 1040 * @sd: pointer to &struct v4l2_subdev 1041 * @state: pointer to &struct v4l2_subdev_state. 1042 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array. 1043 */ 1044 static inline struct v4l2_rect * 1045 v4l2_subdev_get_pad_compose(struct v4l2_subdev *sd, 1046 struct v4l2_subdev_state *state, 1047 unsigned int pad) 1048 { 1049 if (WARN_ON(pad >= sd->entity.num_pads)) 1050 pad = 0; 1051 return &state->pads[pad].try_compose; 1052 } 1053 1054 /* 1055 * Temprary helpers until uses of v4l2_subdev_get_try_* functions have been 1056 * renamed 1057 */ 1058 #define v4l2_subdev_get_try_format(sd, state, pad) \ 1059 v4l2_subdev_get_pad_format(sd, state, pad) 1060 1061 #define v4l2_subdev_get_try_crop(sd, state, pad) \ 1062 v4l2_subdev_get_pad_crop(sd, state, pad) 1063 1064 #define v4l2_subdev_get_try_compose(sd, state, pad) \ 1065 v4l2_subdev_get_pad_compose(sd, state, pad) 1066 1067 #endif /* CONFIG_VIDEO_V4L2_SUBDEV_API */ 1068 1069 extern const struct v4l2_file_operations v4l2_subdev_fops; 1070 1071 /** 1072 * v4l2_set_subdevdata - Sets V4L2 dev private device data 1073 * 1074 * @sd: pointer to &struct v4l2_subdev 1075 * @p: pointer to the private device data to be stored. 1076 */ 1077 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) 1078 { 1079 sd->dev_priv = p; 1080 } 1081 1082 /** 1083 * v4l2_get_subdevdata - Gets V4L2 dev private device data 1084 * 1085 * @sd: pointer to &struct v4l2_subdev 1086 * 1087 * Returns the pointer to the private device data to be stored. 1088 */ 1089 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) 1090 { 1091 return sd->dev_priv; 1092 } 1093 1094 /** 1095 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data 1096 * 1097 * @sd: pointer to &struct v4l2_subdev 1098 * @p: pointer to the private data to be stored. 1099 */ 1100 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p) 1101 { 1102 sd->host_priv = p; 1103 } 1104 1105 /** 1106 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data 1107 * 1108 * @sd: pointer to &struct v4l2_subdev 1109 * 1110 * Returns the pointer to the private host data to be stored. 1111 */ 1112 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd) 1113 { 1114 return sd->host_priv; 1115 } 1116 1117 #ifdef CONFIG_MEDIA_CONTROLLER 1118 1119 /** 1120 * v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode 1121 * endpoint, assuming 1:1 port:pad 1122 * 1123 * @entity: Pointer to the subdev entity 1124 * @endpoint: Pointer to a parsed fwnode endpoint 1125 * 1126 * This function can be used as the .get_fwnode_pad operation for 1127 * subdevices that map port numbers and pad indexes 1:1. If the endpoint 1128 * is owned by the subdevice, the function returns the endpoint port 1129 * number. 1130 * 1131 * Returns the endpoint port number on success or a negative error code. 1132 */ 1133 int v4l2_subdev_get_fwnode_pad_1_to_1(struct media_entity *entity, 1134 struct fwnode_endpoint *endpoint); 1135 1136 /** 1137 * v4l2_subdev_link_validate_default - validates a media link 1138 * 1139 * @sd: pointer to &struct v4l2_subdev 1140 * @link: pointer to &struct media_link 1141 * @source_fmt: pointer to &struct v4l2_subdev_format 1142 * @sink_fmt: pointer to &struct v4l2_subdev_format 1143 * 1144 * This function ensures that width, height and the media bus pixel 1145 * code are equal on both source and sink of the link. 1146 */ 1147 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd, 1148 struct media_link *link, 1149 struct v4l2_subdev_format *source_fmt, 1150 struct v4l2_subdev_format *sink_fmt); 1151 1152 /** 1153 * v4l2_subdev_link_validate - validates a media link 1154 * 1155 * @link: pointer to &struct media_link 1156 * 1157 * This function calls the subdev's link_validate ops to validate 1158 * if a media link is valid for streaming. It also internally 1159 * calls v4l2_subdev_link_validate_default() to ensure that 1160 * width, height and the media bus pixel code are equal on both 1161 * source and sink of the link. 1162 */ 1163 int v4l2_subdev_link_validate(struct media_link *link); 1164 1165 /** 1166 * __v4l2_subdev_state_alloc - allocate v4l2_subdev_state 1167 * 1168 * @sd: pointer to &struct v4l2_subdev for which the state is being allocated. 1169 * @lock_name: name of the state lock 1170 * @key: lock_class_key for the lock 1171 * 1172 * Must call __v4l2_subdev_state_free() when state is no longer needed. 1173 * 1174 * Not to be called directly by the drivers. 1175 */ 1176 struct v4l2_subdev_state *__v4l2_subdev_state_alloc(struct v4l2_subdev *sd, 1177 const char *lock_name, 1178 struct lock_class_key *key); 1179 1180 /** 1181 * __v4l2_subdev_state_free - free a v4l2_subdev_state 1182 * 1183 * @state: v4l2_subdev_state to be freed. 1184 * 1185 * Not to be called directly by the drivers. 1186 */ 1187 void __v4l2_subdev_state_free(struct v4l2_subdev_state *state); 1188 1189 /** 1190 * v4l2_subdev_init_finalize() - Finalizes the initialization of the subdevice 1191 * @sd: The subdev 1192 * 1193 * This function finalizes the initialization of the subdev, including 1194 * allocation of the active state for the subdev. 1195 * 1196 * This function must be called by the subdev drivers that use the centralized 1197 * active state, after the subdev struct has been initialized and 1198 * media_entity_pads_init() has been called, but before registering the 1199 * subdev. 1200 * 1201 * The user must call v4l2_subdev_cleanup() when the subdev is being removed. 1202 */ 1203 #define v4l2_subdev_init_finalize(sd) \ 1204 ({ \ 1205 static struct lock_class_key __key; \ 1206 const char *name = KBUILD_BASENAME \ 1207 ":" __stringify(__LINE__) ":sd->active_state->lock"; \ 1208 __v4l2_subdev_init_finalize(sd, name, &__key); \ 1209 }) 1210 1211 int __v4l2_subdev_init_finalize(struct v4l2_subdev *sd, const char *name, 1212 struct lock_class_key *key); 1213 1214 /** 1215 * v4l2_subdev_cleanup() - Releases the resources allocated by the subdevice 1216 * @sd: The subdevice 1217 * 1218 * This function will release the resources allocated in 1219 * v4l2_subdev_init_finalize. 1220 */ 1221 void v4l2_subdev_cleanup(struct v4l2_subdev *sd); 1222 1223 /** 1224 * v4l2_subdev_lock_state() - Locks the subdev state 1225 * @state: The subdevice state 1226 * 1227 * Locks the given subdev state. 1228 * 1229 * The state must be unlocked with v4l2_subdev_unlock_state() after use. 1230 */ 1231 static inline void v4l2_subdev_lock_state(struct v4l2_subdev_state *state) 1232 { 1233 mutex_lock(state->lock); 1234 } 1235 1236 /** 1237 * v4l2_subdev_unlock_state() - Unlocks the subdev state 1238 * @state: The subdevice state 1239 * 1240 * Unlocks the given subdev state. 1241 */ 1242 static inline void v4l2_subdev_unlock_state(struct v4l2_subdev_state *state) 1243 { 1244 mutex_unlock(state->lock); 1245 } 1246 1247 /** 1248 * v4l2_subdev_get_unlocked_active_state() - Checks that the active subdev state 1249 * is unlocked and returns it 1250 * @sd: The subdevice 1251 * 1252 * Returns the active state for the subdevice, or NULL if the subdev does not 1253 * support active state. If the state is not NULL, calls 1254 * lockdep_assert_not_held() to issue a warning if the state is locked. 1255 * 1256 * This function is to be used e.g. when getting the active state for the sole 1257 * purpose of passing it forward, without accessing the state fields. 1258 */ 1259 static inline struct v4l2_subdev_state * 1260 v4l2_subdev_get_unlocked_active_state(struct v4l2_subdev *sd) 1261 { 1262 if (sd->active_state) 1263 lockdep_assert_not_held(sd->active_state->lock); 1264 return sd->active_state; 1265 } 1266 1267 /** 1268 * v4l2_subdev_get_locked_active_state() - Checks that the active subdev state 1269 * is locked and returns it 1270 * 1271 * @sd: The subdevice 1272 * 1273 * Returns the active state for the subdevice, or NULL if the subdev does not 1274 * support active state. If the state is not NULL, calls lockdep_assert_held() 1275 * to issue a warning if the state is not locked. 1276 * 1277 * This function is to be used when the caller knows that the active state is 1278 * already locked. 1279 */ 1280 static inline struct v4l2_subdev_state * 1281 v4l2_subdev_get_locked_active_state(struct v4l2_subdev *sd) 1282 { 1283 if (sd->active_state) 1284 lockdep_assert_held(sd->active_state->lock); 1285 return sd->active_state; 1286 } 1287 1288 /** 1289 * v4l2_subdev_lock_and_get_active_state() - Locks and returns the active subdev 1290 * state for the subdevice 1291 * @sd: The subdevice 1292 * 1293 * Returns the locked active state for the subdevice, or NULL if the subdev 1294 * does not support active state. 1295 * 1296 * The state must be unlocked with v4l2_subdev_unlock_state() after use. 1297 */ 1298 static inline struct v4l2_subdev_state * 1299 v4l2_subdev_lock_and_get_active_state(struct v4l2_subdev *sd) 1300 { 1301 if (sd->active_state) 1302 v4l2_subdev_lock_state(sd->active_state); 1303 return sd->active_state; 1304 } 1305 1306 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) 1307 1308 /** 1309 * v4l2_subdev_get_fmt() - Fill format based on state 1310 * @sd: subdevice 1311 * @state: subdevice state 1312 * @format: pointer to &struct v4l2_subdev_format 1313 * 1314 * Fill @format->format field based on the information in the @format struct. 1315 * 1316 * This function can be used by the subdev drivers which support active state to 1317 * implement v4l2_subdev_pad_ops.get_fmt if the subdev driver does not need to 1318 * do anything special in their get_fmt op. 1319 * 1320 * Returns 0 on success, error value otherwise. 1321 */ 1322 int v4l2_subdev_get_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_state *state, 1323 struct v4l2_subdev_format *format); 1324 1325 #endif /* CONFIG_VIDEO_V4L2_SUBDEV_API */ 1326 1327 #endif /* CONFIG_MEDIA_CONTROLLER */ 1328 1329 /** 1330 * v4l2_subdev_init - initializes the sub-device struct 1331 * 1332 * @sd: pointer to the &struct v4l2_subdev to be initialized 1333 * @ops: pointer to &struct v4l2_subdev_ops. 1334 */ 1335 void v4l2_subdev_init(struct v4l2_subdev *sd, 1336 const struct v4l2_subdev_ops *ops); 1337 1338 extern const struct v4l2_subdev_ops v4l2_subdev_call_wrappers; 1339 1340 /** 1341 * v4l2_subdev_call - call an operation of a v4l2_subdev. 1342 * 1343 * @sd: pointer to the &struct v4l2_subdev 1344 * @o: name of the element at &struct v4l2_subdev_ops that contains @f. 1345 * Each element there groups a set of callbacks functions. 1346 * @f: callback function to be called. 1347 * The callback functions are defined in groups, according to 1348 * each element at &struct v4l2_subdev_ops. 1349 * @args: arguments for @f. 1350 * 1351 * Example: err = v4l2_subdev_call(sd, video, s_std, norm); 1352 */ 1353 #define v4l2_subdev_call(sd, o, f, args...) \ 1354 ({ \ 1355 struct v4l2_subdev *__sd = (sd); \ 1356 int __result; \ 1357 if (!__sd) \ 1358 __result = -ENODEV; \ 1359 else if (!(__sd->ops->o && __sd->ops->o->f)) \ 1360 __result = -ENOIOCTLCMD; \ 1361 else if (v4l2_subdev_call_wrappers.o && \ 1362 v4l2_subdev_call_wrappers.o->f) \ 1363 __result = v4l2_subdev_call_wrappers.o->f( \ 1364 __sd, ##args); \ 1365 else \ 1366 __result = __sd->ops->o->f(__sd, ##args); \ 1367 __result; \ 1368 }) 1369 1370 /** 1371 * v4l2_subdev_call_state_active - call an operation of a v4l2_subdev which 1372 * takes state as a parameter, passing the 1373 * subdev its active state. 1374 * 1375 * @sd: pointer to the &struct v4l2_subdev 1376 * @o: name of the element at &struct v4l2_subdev_ops that contains @f. 1377 * Each element there groups a set of callbacks functions. 1378 * @f: callback function to be called. 1379 * The callback functions are defined in groups, according to 1380 * each element at &struct v4l2_subdev_ops. 1381 * @args: arguments for @f. 1382 * 1383 * This is similar to v4l2_subdev_call(), except that this version can only be 1384 * used for ops that take a subdev state as a parameter. The macro will get the 1385 * active state, lock it before calling the op and unlock it after the call. 1386 */ 1387 #define v4l2_subdev_call_state_active(sd, o, f, args...) \ 1388 ({ \ 1389 int __result; \ 1390 struct v4l2_subdev_state *state; \ 1391 state = v4l2_subdev_get_unlocked_active_state(sd); \ 1392 if (state) \ 1393 v4l2_subdev_lock_state(state); \ 1394 __result = v4l2_subdev_call(sd, o, f, state, ##args); \ 1395 if (state) \ 1396 v4l2_subdev_unlock_state(state); \ 1397 __result; \ 1398 }) 1399 1400 /** 1401 * v4l2_subdev_has_op - Checks if a subdev defines a certain operation. 1402 * 1403 * @sd: pointer to the &struct v4l2_subdev 1404 * @o: The group of callback functions in &struct v4l2_subdev_ops 1405 * which @f is a part of. 1406 * @f: callback function to be checked for its existence. 1407 */ 1408 #define v4l2_subdev_has_op(sd, o, f) \ 1409 ((sd)->ops->o && (sd)->ops->o->f) 1410 1411 /** 1412 * v4l2_subdev_notify_event() - Delivers event notification for subdevice 1413 * @sd: The subdev for which to deliver the event 1414 * @ev: The event to deliver 1415 * 1416 * Will deliver the specified event to all userspace event listeners which are 1417 * subscribed to the v42l subdev event queue as well as to the bridge driver 1418 * using the notify callback. The notification type for the notify callback 1419 * will be %V4L2_DEVICE_NOTIFY_EVENT. 1420 */ 1421 void v4l2_subdev_notify_event(struct v4l2_subdev *sd, 1422 const struct v4l2_event *ev); 1423 1424 #endif /* _V4L2_SUBDEV_H */ 1425