include/media/v4l2-subdev.h

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