linux/include/media/v4l2-subdev.h
<<
>>
Prefs
   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
  41struct v4l2_device;
  42struct v4l2_ctrl_handler;
  43struct v4l2_event;
  44struct v4l2_event_subscription;
  45struct v4l2_fh;
  46struct v4l2_subdev;
  47struct v4l2_subdev_fh;
  48struct tuner_setup;
  49struct 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 */
  61struct 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 */
 123enum 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 */
 141struct 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 */
 197struct 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 * @standby: puts the tuner in standby mode. It will be woken up
 228 *           automatically the next time it is used.
 229 *
 230 * @s_radio: callback that switches the tuner to radio mode.
 231 *           drivers should explicitly call it when a tuner ops should
 232 *           operate on radio mode, before being able to handle it.
 233 *           Used on devices that have both AM/FM radio receiver and TV.
 234 *
 235 * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code.
 236 *
 237 * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code.
 238 *               freq->type must be filled in. Normally done by video_ioctl2()
 239 *               or the bridge driver.
 240 *
 241 * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code.
 242 *
 243 * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code.
 244 *
 245 * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be
 246 *           filled in. Normally done by video_ioctl2 or the
 247 *           bridge driver.
 248 *
 249 * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code.
 250 *
 251 * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code.
 252 *
 253 * @s_type_addr: sets tuner type and its I2C addr.
 254 *
 255 * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
 256 *
 257 * .. note::
 258 *
 259 *      On devices that have both AM/FM and TV, it is up to the driver
 260 *      to explicitly call s_radio when the tuner should be switched to
 261 *      radio mode, before handling other &struct v4l2_subdev_tuner_ops
 262 *      that would require it. An example of such usage is::
 263 *
 264 *        static void s_frequency(void *priv, const struct v4l2_frequency *f)
 265 *        {
 266 *              ...
 267 *              if (f.type == V4L2_TUNER_RADIO)
 268 *                      v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio);
 269 *              ...
 270 *              v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency);
 271 *        }
 272 */
 273struct v4l2_subdev_tuner_ops {
 274        int (*standby)(struct v4l2_subdev *sd);
 275        int (*s_radio)(struct v4l2_subdev *sd);
 276        int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);
 277        int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 278        int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);
 279        int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 280        int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);
 281        int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
 282        int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);
 283        int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
 284        int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
 285};
 286
 287/**
 288 * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
 289 *
 290 * @s_clock_freq: set the frequency (in Hz) of the audio clock output.
 291 *      Used to slave an audio processor to the video decoder, ensuring that
 292 *      audio and video remain synchronized. Usual values for the frequency
 293 *      are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
 294 *      -EINVAL is returned.
 295 *
 296 * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
 297 *      way to select I2S clock used by driving digital audio streams at some
 298 *      board designs. Usual values for the frequency are 1024000 and 2048000.
 299 *      If the frequency is not supported, then %-EINVAL is returned.
 300 *
 301 * @s_routing: used to define the input and/or output pins of an audio chip,
 302 *      and any additional configuration data.
 303 *      Never attempt to use user-level input IDs (e.g. Composite, S-Video,
 304 *      Tuner) at this level. An i2c device shouldn't know about whether an
 305 *      input pin is connected to a Composite connector, become on another
 306 *      board or platform it might be connected to something else entirely.
 307 *      The calling driver is responsible for mapping a user-level input to
 308 *      the right pins on the i2c device.
 309 *
 310 * @s_stream: used to notify the audio code that stream will start or has
 311 *      stopped.
 312 */
 313struct v4l2_subdev_audio_ops {
 314        int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 315        int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 316        int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 317        int (*s_stream)(struct v4l2_subdev *sd, int enable);
 318};
 319
 320/**
 321 * enum v4l2_mbus_frame_desc_entry - media bus frame description flags
 322 *
 323 * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX:
 324 *      Indicates that &struct v4l2_mbus_frame_desc_entry->length field
 325 *      specifies maximum data length.
 326 * @V4L2_MBUS_FRAME_DESC_FL_BLOB:
 327 *      Indicates that the format does not have line offsets, i.e.
 328 *      the receiver should use 1D DMA.
 329 */
 330enum v4l2_mbus_frame_desc_flags {
 331        V4L2_MBUS_FRAME_DESC_FL_LEN_MAX = BIT(0),
 332        V4L2_MBUS_FRAME_DESC_FL_BLOB    = BIT(1),
 333};
 334
 335/**
 336 * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
 337 *
 338 * @flags:      bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags.
 339 * @pixelcode:  media bus pixel code, valid if @flags
 340 *              %FRAME_DESC_FL_BLOB is not set.
 341 * @length:     number of octets per frame, valid if @flags
 342 *              %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set.
 343 */
 344struct v4l2_mbus_frame_desc_entry {
 345        enum v4l2_mbus_frame_desc_flags flags;
 346        u32 pixelcode;
 347        u32 length;
 348};
 349
 350#define V4L2_FRAME_DESC_ENTRY_MAX       4
 351
 352/**
 353 * struct v4l2_mbus_frame_desc - media bus data frame description
 354 * @entry: frame descriptors array
 355 * @num_entries: number of entries in @entry array
 356 */
 357struct v4l2_mbus_frame_desc {
 358        struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
 359        unsigned short num_entries;
 360};
 361
 362/**
 363 * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
 364 *                                in video mode.
 365 *
 366 * @s_routing: see s_routing in audio_ops, except this version is for video
 367 *      devices.
 368 *
 369 * @s_crystal_freq: sets the frequency of the crystal used to generate the
 370 *      clocks in Hz. An extra flags field allows device specific configuration
 371 *      regarding clock frequency dividers, etc. If not used, then set flags
 372 *      to 0. If the frequency is not supported, then -EINVAL is returned.
 373 *
 374 * @g_std: callback for VIDIOC_G_STD() ioctl handler code.
 375 *
 376 * @s_std: callback for VIDIOC_S_STD() ioctl handler code.
 377 *
 378 * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
 379 *      video input devices.
 380 *
 381 * @g_std_output: get current standard for video OUTPUT devices. This is ignored
 382 *      by video input devices.
 383 *
 384 * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code.
 385 *
 386 * @g_tvnorms: get &v4l2_std_id with all standards supported by the video
 387 *      CAPTURE device. This is ignored by video output devices.
 388 *
 389 * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
 390 *      OUTPUT device. This is ignored by video capture devices.
 391 *
 392 * @g_input_status: get input status. Same as the status field in the
 393 *      &struct &v4l2_input
 394 *
 395 * @s_stream: used to notify the driver that a video stream will start or has
 396 *      stopped.
 397 *
 398 * @g_pixelaspect: callback to return the pixelaspect ratio.
 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 */
 424struct 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_frame_interval)(struct v4l2_subdev *sd,
 438                                struct v4l2_subdev_frame_interval *interval);
 439        int (*s_frame_interval)(struct v4l2_subdev *sd,
 440                                struct v4l2_subdev_frame_interval *interval);
 441        int (*s_dv_timings)(struct v4l2_subdev *sd,
 442                        struct v4l2_dv_timings *timings);
 443        int (*g_dv_timings)(struct v4l2_subdev *sd,
 444                        struct v4l2_dv_timings *timings);
 445        int (*query_dv_timings)(struct v4l2_subdev *sd,
 446                        struct v4l2_dv_timings *timings);
 447        int (*g_mbus_config)(struct v4l2_subdev *sd,
 448                             struct v4l2_mbus_config *cfg);
 449        int (*s_mbus_config)(struct v4l2_subdev *sd,
 450                             const struct v4l2_mbus_config *cfg);
 451        int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
 452                           unsigned int *size);
 453};
 454
 455/**
 456 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
 457 *                                in video mode via the vbi device node.
 458 *
 459 *  @decode_vbi_line: video decoders that support sliced VBI need to implement
 460 *      this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the
 461 *      start of the VBI data that was generated by the decoder. The driver
 462 *      then parses the sliced VBI data and sets the other fields in the
 463 *      struct accordingly. The pointer p is updated to point to the start of
 464 *      the payload which can be copied verbatim into the data field of the
 465 *      &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the
 466 *      type field is set to 0 on return.
 467 *
 468 * @s_vbi_data: used to generate VBI signals on a video signal.
 469 *      &struct v4l2_sliced_vbi_data is filled with the data packets that
 470 *      should be output. Note that if you set the line field to 0, then that
 471 *      VBI signal is disabled. If no valid VBI data was found, then the type
 472 *      field is set to 0 on return.
 473 *
 474 * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
 475 *      Not all video decoders support this. If no data is available because
 476 *      the readback register contains invalid or erroneous data %-EIO is
 477 *      returned. Note that you must fill in the 'id' member and the 'field'
 478 *      member (to determine whether CC data from the first or second field
 479 *      should be obtained).
 480 *
 481 * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler
 482 *                    code.
 483 *
 484 * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
 485 *
 486 * @g_sliced_fmt: retrieve the current sliced VBI settings.
 487 *
 488 * @s_sliced_fmt: setup the sliced VBI settings.
 489 */
 490struct v4l2_subdev_vbi_ops {
 491        int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
 492        int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
 493        int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
 494        int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
 495        int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
 496        int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
 497        int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
 498};
 499
 500/**
 501 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
 502 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
 503 *                    This is needed for some sensors, which always corrupt
 504 *                    several top lines of the output image, or which send their
 505 *                    metadata in them.
 506 * @g_skip_frames: number of frames to skip at stream start. This is needed for
 507 *                 buggy sensors that generate faulty frames when they are
 508 *                 turned on.
 509 */
 510struct v4l2_subdev_sensor_ops {
 511        int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
 512        int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
 513};
 514
 515/**
 516 * enum v4l2_subdev_ir_mode- describes the type of IR supported
 517 *
 518 * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records
 519 */
 520enum v4l2_subdev_ir_mode {
 521        V4L2_SUBDEV_IR_MODE_PULSE_WIDTH,
 522};
 523
 524/**
 525 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
 526 *
 527 * @bytes_per_data_element: bytes per data element of data in read or
 528 *      write call.
 529 * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode.
 530 * @enable: device is active if true
 531 * @interrupt_enable: IR interrupts are enabled if true
 532 * @shutdown: if true: set hardware to low/no power, false: normal mode
 533 *
 534 * @modulation: if true, it uses carrier, if false: baseband
 535 * @max_pulse_width:  maximum pulse width in ns, valid only for baseband signal
 536 * @carrier_freq: carrier frequency in Hz, valid only for modulated signal
 537 * @duty_cycle: duty cycle percentage, valid only for modulated signal
 538 * @invert_level: invert signal level
 539 *
 540 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX.
 541 *
 542 * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX.
 543 * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated
 544 *      signal. Used only for RX.
 545 * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated
 546 *      signal. Used only for RX.
 547 * @resolution: The receive resolution, in ns . Used only for RX.
 548 */
 549struct v4l2_subdev_ir_parameters {
 550        unsigned int bytes_per_data_element;
 551        enum v4l2_subdev_ir_mode mode;
 552
 553        bool enable;
 554        bool interrupt_enable;
 555        bool shutdown;
 556
 557        bool modulation;
 558        u32 max_pulse_width;
 559        unsigned int carrier_freq;
 560        unsigned int duty_cycle;
 561        bool invert_level;
 562
 563        /* Tx only */
 564        bool invert_carrier_sense;
 565
 566        /* Rx only */
 567        u32 noise_filter_min_width;
 568        unsigned int carrier_range_lower;
 569        unsigned int carrier_range_upper;
 570        u32 resolution;
 571};
 572
 573/**
 574 * struct v4l2_subdev_ir_ops - operations for IR subdevices
 575 *
 576 * @rx_read: Reads received codes or pulse width data.
 577 *      The semantics are similar to a non-blocking read() call.
 578 * @rx_g_parameters: Get the current operating parameters and state of the
 579 *      the IR receiver.
 580 * @rx_s_parameters: Set the current operating parameters and state of the
 581 *      the IR receiver.  It is recommended to call
 582 *      [rt]x_g_parameters first to fill out the current state, and only change
 583 *      the fields that need to be changed.  Upon return, the actual device
 584 *      operating parameters and state will be returned.  Note that hardware
 585 *      limitations may prevent the actual settings from matching the requested
 586 *      settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
 587 *      was requested.  An exception is when the shutdown parameter is true.
 588 *      The last used operational parameters will be returned, but the actual
 589 *      state of the hardware be different to minimize power consumption and
 590 *      processing when shutdown is true.
 591 *
 592 * @tx_write: Writes codes or pulse width data for transmission.
 593 *      The semantics are similar to a non-blocking write() call.
 594 * @tx_g_parameters: Get the current operating parameters and state of the
 595 *      the IR transmitter.
 596 * @tx_s_parameters: Set the current operating parameters and state of the
 597 *      the IR transmitter.  It is recommended to call
 598 *      [rt]x_g_parameters first to fill out the current state, and only change
 599 *      the fields that need to be changed.  Upon return, the actual device
 600 *      operating parameters and state will be returned.  Note that hardware
 601 *      limitations may prevent the actual settings from matching the requested
 602 *      settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
 603 *      was requested.  An exception is when the shutdown parameter is true.
 604 *      The last used operational parameters will be returned, but the actual
 605 *      state of the hardware be different to minimize power consumption and
 606 *      processing when shutdown is true.
 607 */
 608struct v4l2_subdev_ir_ops {
 609        /* Receiver */
 610        int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 611                                ssize_t *num);
 612
 613        int (*rx_g_parameters)(struct v4l2_subdev *sd,
 614                                struct v4l2_subdev_ir_parameters *params);
 615        int (*rx_s_parameters)(struct v4l2_subdev *sd,
 616                                struct v4l2_subdev_ir_parameters *params);
 617
 618        /* Transmitter */
 619        int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 620                                ssize_t *num);
 621
 622        int (*tx_g_parameters)(struct v4l2_subdev *sd,
 623                                struct v4l2_subdev_ir_parameters *params);
 624        int (*tx_s_parameters)(struct v4l2_subdev *sd,
 625                                struct v4l2_subdev_ir_parameters *params);
 626};
 627
 628/**
 629 * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
 630 *
 631 * @try_fmt: &struct v4l2_mbus_framefmt
 632 * @try_crop: &struct v4l2_rect to be used for crop
 633 * @try_compose: &struct v4l2_rect to be used for compose
 634 *
 635 * This structure only needs to be passed to the pad op if the 'which' field
 636 * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For
 637 * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL.
 638 */
 639struct v4l2_subdev_pad_config {
 640        struct v4l2_mbus_framefmt try_fmt;
 641        struct v4l2_rect try_crop;
 642        struct v4l2_rect try_compose;
 643};
 644
 645/**
 646 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
 647 *
 648 * @init_cfg: initialize the pad config to default values
 649 * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler
 650 *                  code.
 651 * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler
 652 *                   code.
 653 *
 654 * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl
 655 *                       handler code.
 656 *
 657 * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code.
 658 *
 659 * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code.
 660 *
 661 * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code.
 662 *
 663 * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code.
 664 *
 665 * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code.
 666 *
 667 * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code.
 668 *
 669 * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler
 670 *                  code.
 671 *
 672 * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler
 673 *                   code.
 674 *
 675 * @link_validate: used by the media controller code to check if the links
 676 *                 that belongs to a pipeline can be used for stream.
 677 *
 678 * @get_frame_desc: get the current low level media bus frame parameters.
 679 *
 680 * @set_frame_desc: set the low level media bus frame parameters, @fd array
 681 *                  may be adjusted by the subdev driver to device capabilities.
 682 */
 683struct v4l2_subdev_pad_ops {
 684        int (*init_cfg)(struct v4l2_subdev *sd,
 685                        struct v4l2_subdev_pad_config *cfg);
 686        int (*enum_mbus_code)(struct v4l2_subdev *sd,
 687                              struct v4l2_subdev_pad_config *cfg,
 688                              struct v4l2_subdev_mbus_code_enum *code);
 689        int (*enum_frame_size)(struct v4l2_subdev *sd,
 690                               struct v4l2_subdev_pad_config *cfg,
 691                               struct v4l2_subdev_frame_size_enum *fse);
 692        int (*enum_frame_interval)(struct v4l2_subdev *sd,
 693                                   struct v4l2_subdev_pad_config *cfg,
 694                                   struct v4l2_subdev_frame_interval_enum *fie);
 695        int (*get_fmt)(struct v4l2_subdev *sd,
 696                       struct v4l2_subdev_pad_config *cfg,
 697                       struct v4l2_subdev_format *format);
 698        int (*set_fmt)(struct v4l2_subdev *sd,
 699                       struct v4l2_subdev_pad_config *cfg,
 700                       struct v4l2_subdev_format *format);
 701        int (*get_selection)(struct v4l2_subdev *sd,
 702                             struct v4l2_subdev_pad_config *cfg,
 703                             struct v4l2_subdev_selection *sel);
 704        int (*set_selection)(struct v4l2_subdev *sd,
 705                             struct v4l2_subdev_pad_config *cfg,
 706                             struct v4l2_subdev_selection *sel);
 707        int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
 708        int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
 709        int (*dv_timings_cap)(struct v4l2_subdev *sd,
 710                              struct v4l2_dv_timings_cap *cap);
 711        int (*enum_dv_timings)(struct v4l2_subdev *sd,
 712                               struct v4l2_enum_dv_timings *timings);
 713#ifdef CONFIG_MEDIA_CONTROLLER
 714        int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
 715                             struct v4l2_subdev_format *source_fmt,
 716                             struct v4l2_subdev_format *sink_fmt);
 717#endif /* CONFIG_MEDIA_CONTROLLER */
 718        int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
 719                              struct v4l2_mbus_frame_desc *fd);
 720        int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
 721                              struct v4l2_mbus_frame_desc *fd);
 722};
 723
 724/**
 725 * struct v4l2_subdev_ops - Subdev operations
 726 *
 727 * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL
 728 * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL
 729 * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL
 730 * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL
 731 * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL
 732 * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL
 733 * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL
 734 * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL
 735 */
 736struct v4l2_subdev_ops {
 737        const struct v4l2_subdev_core_ops       *core;
 738        const struct v4l2_subdev_tuner_ops      *tuner;
 739        const struct v4l2_subdev_audio_ops      *audio;
 740        const struct v4l2_subdev_video_ops      *video;
 741        const struct v4l2_subdev_vbi_ops        *vbi;
 742        const struct v4l2_subdev_ir_ops         *ir;
 743        const struct v4l2_subdev_sensor_ops     *sensor;
 744        const struct v4l2_subdev_pad_ops        *pad;
 745};
 746
 747/**
 748 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
 749 *
 750 * @registered: called when this subdev is registered. When called the v4l2_dev
 751 *      field is set to the correct v4l2_device.
 752 *
 753 * @unregistered: called when this subdev is unregistered. When called the
 754 *      v4l2_dev field is still set to the correct v4l2_device.
 755 *
 756 * @open: called when the subdev device node is opened by an application.
 757 *
 758 * @close: called when the subdev device node is closed.
 759 *
 760 * .. note::
 761 *      Never call this from drivers, only the v4l2 framework can call
 762 *      these ops.
 763 */
 764struct v4l2_subdev_internal_ops {
 765        int (*registered)(struct v4l2_subdev *sd);
 766        void (*unregistered)(struct v4l2_subdev *sd);
 767        int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
 768        int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
 769};
 770
 771#define V4L2_SUBDEV_NAME_SIZE 32
 772
 773/* Set this flag if this subdev is a i2c device. */
 774#define V4L2_SUBDEV_FL_IS_I2C                   (1U << 0)
 775/* Set this flag if this subdev is a spi device. */
 776#define V4L2_SUBDEV_FL_IS_SPI                   (1U << 1)
 777/* Set this flag if this subdev needs a device node. */
 778#define V4L2_SUBDEV_FL_HAS_DEVNODE              (1U << 2)
 779/* Set this flag if this subdev generates events. */
 780#define V4L2_SUBDEV_FL_HAS_EVENTS               (1U << 3)
 781
 782struct regulator_bulk_data;
 783
 784/**
 785 * struct v4l2_subdev_platform_data - regulators config struct
 786 *
 787 * @regulators: Optional regulators used to power on/off the subdevice
 788 * @num_regulators: Number of regululators
 789 * @host_priv: Per-subdevice data, specific for a certain video host device
 790 */
 791struct v4l2_subdev_platform_data {
 792        struct regulator_bulk_data *regulators;
 793        int num_regulators;
 794
 795        void *host_priv;
 796};
 797
 798/**
 799 * struct v4l2_subdev - describes a V4L2 sub-device
 800 *
 801 * @entity: pointer to &struct media_entity
 802 * @list: List of sub-devices
 803 * @owner: The owner is the same as the driver's &struct device owner.
 804 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
 805 *      owner. Initialized by v4l2_device_register_subdev().
 806 * @flags: subdev flags. Can be:
 807 *   %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
 808 *   %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
 809 *   %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
 810 *   device node;
 811 *   %V4L2_SUBDEV_FL_HAS_EVENTS -  Set this flag if this subdev generates
 812 *   events.
 813 *
 814 * @v4l2_dev: pointer to struct &v4l2_device
 815 * @ops: pointer to struct &v4l2_subdev_ops
 816 * @internal_ops: pointer to struct &v4l2_subdev_internal_ops.
 817 *      Never call these internal ops from within a driver!
 818 * @ctrl_handler: The control handler of this subdev. May be NULL.
 819 * @name: Name of the sub-device. Please notice that the name must be unique.
 820 * @grp_id: can be used to group similar subdevs. Value is driver-specific
 821 * @dev_priv: pointer to private data
 822 * @host_priv: pointer to private data used by the device where the subdev
 823 *      is attached.
 824 * @devnode: subdev device node
 825 * @dev: pointer to the physical device, if any
 826 * @fwnode: The fwnode_handle of the subdev, usually the same as
 827 *          either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
 828 * @async_list: Links this subdev to a global subdev_list or @notifier->done
 829 *      list.
 830 * @asd: Pointer to respective &struct v4l2_async_subdev.
 831 * @notifier: Pointer to the managing notifier.
 832 * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
 833 *                   device using v4l2_device_register_sensor_subdev().
 834 * @pdata: common part of subdevice platform data
 835 *
 836 * Each instance of a subdev driver should create this struct, either
 837 * stand-alone or embedded in a larger struct.
 838 *
 839 * This structure should be initialized by v4l2_subdev_init() or one of
 840 * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init().
 841 */
 842struct v4l2_subdev {
 843#if defined(CONFIG_MEDIA_CONTROLLER)
 844        struct media_entity entity;
 845#endif
 846        struct list_head list;
 847        struct module *owner;
 848        bool owner_v4l2_dev;
 849        u32 flags;
 850        struct v4l2_device *v4l2_dev;
 851        const struct v4l2_subdev_ops *ops;
 852        const struct v4l2_subdev_internal_ops *internal_ops;
 853        struct v4l2_ctrl_handler *ctrl_handler;
 854        char name[V4L2_SUBDEV_NAME_SIZE];
 855        u32 grp_id;
 856        void *dev_priv;
 857        void *host_priv;
 858        struct video_device *devnode;
 859        struct device *dev;
 860        struct fwnode_handle *fwnode;
 861        struct list_head async_list;
 862        struct v4l2_async_subdev *asd;
 863        struct v4l2_async_notifier *notifier;
 864        struct v4l2_async_notifier *subdev_notifier;
 865        struct v4l2_subdev_platform_data *pdata;
 866};
 867
 868
 869/**
 870 * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
 871 *    the &struct media_entity embedded in it.
 872 *
 873 * @ent: pointer to &struct media_entity.
 874 */
 875#define media_entity_to_v4l2_subdev(ent)                                \
 876({                                                                      \
 877        typeof(ent) __me_sd_ent = (ent);                                \
 878                                                                        \
 879        __me_sd_ent ?                                                   \
 880                container_of(__me_sd_ent, struct v4l2_subdev, entity) : \
 881                NULL;                                                   \
 882})
 883
 884/**
 885 * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
 886 *      the &struct video_device embedded on it.
 887 *
 888 * @vdev: pointer to &struct video_device
 889 */
 890#define vdev_to_v4l2_subdev(vdev) \
 891        ((struct v4l2_subdev *)video_get_drvdata(vdev))
 892
 893/**
 894 * struct v4l2_subdev_fh - Used for storing subdev information per file handle
 895 *
 896 * @vfh: pointer to &struct v4l2_fh
 897 * @pad: pointer to &struct v4l2_subdev_pad_config
 898 */
 899struct v4l2_subdev_fh {
 900        struct v4l2_fh vfh;
 901#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
 902        struct v4l2_subdev_pad_config *pad;
 903#endif
 904};
 905
 906/**
 907 * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
 908 *      the &struct v4l2_fh embedded on it.
 909 *
 910 * @fh: pointer to &struct v4l2_fh
 911 */
 912#define to_v4l2_subdev_fh(fh)   \
 913        container_of(fh, struct v4l2_subdev_fh, vfh)
 914
 915#if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
 916
 917/**
 918 * v4l2_subdev_get_try_format - ancillary routine to call
 919 *      &struct v4l2_subdev_pad_config->try_fmt
 920 *
 921 * @sd: pointer to &struct v4l2_subdev
 922 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
 923 * @pad: index of the pad in the @cfg array.
 924 */
 925static inline struct v4l2_mbus_framefmt
 926*v4l2_subdev_get_try_format(struct v4l2_subdev *sd,
 927                            struct v4l2_subdev_pad_config *cfg,
 928                            unsigned int pad)
 929{
 930        if (WARN_ON(pad >= sd->entity.num_pads))
 931                pad = 0;
 932        return &cfg[pad].try_fmt;
 933}
 934
 935/**
 936 * v4l2_subdev_get_try_crop - ancillary routine to call
 937 *      &struct v4l2_subdev_pad_config->try_crop
 938 *
 939 * @sd: pointer to &struct v4l2_subdev
 940 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
 941 * @pad: index of the pad in the @cfg array.
 942 */
 943static inline struct v4l2_rect
 944*v4l2_subdev_get_try_crop(struct v4l2_subdev *sd,
 945                          struct v4l2_subdev_pad_config *cfg,
 946                          unsigned int pad)
 947{
 948        if (WARN_ON(pad >= sd->entity.num_pads))
 949                pad = 0;
 950        return &cfg[pad].try_crop;
 951}
 952
 953/**
 954 * v4l2_subdev_get_try_crop - ancillary routine to call
 955 *      &struct v4l2_subdev_pad_config->try_compose
 956 *
 957 * @sd: pointer to &struct v4l2_subdev
 958 * @cfg: pointer to &struct v4l2_subdev_pad_config array.
 959 * @pad: index of the pad in the @cfg array.
 960 */
 961static inline struct v4l2_rect
 962*v4l2_subdev_get_try_compose(struct v4l2_subdev *sd,
 963                             struct v4l2_subdev_pad_config *cfg,
 964                             unsigned int pad)
 965{
 966        if (WARN_ON(pad >= sd->entity.num_pads))
 967                pad = 0;
 968        return &cfg[pad].try_compose;
 969}
 970#endif
 971
 972extern const struct v4l2_file_operations v4l2_subdev_fops;
 973
 974/**
 975 * v4l2_set_subdevdata - Sets V4L2 dev private device data
 976 *
 977 * @sd: pointer to &struct v4l2_subdev
 978 * @p: pointer to the private device data to be stored.
 979 */
 980static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
 981{
 982        sd->dev_priv = p;
 983}
 984
 985/**
 986 * v4l2_get_subdevdata - Gets V4L2 dev private device data
 987 *
 988 * @sd: pointer to &struct v4l2_subdev
 989 *
 990 * Returns the pointer to the private device data to be stored.
 991 */
 992static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
 993{
 994        return sd->dev_priv;
 995}
 996
 997/**
 998 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
 999 *
1000 * @sd: pointer to &struct v4l2_subdev
1001 * @p: pointer to the private data to be stored.
1002 */
1003static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
1004{
1005        sd->host_priv = p;
1006}
1007
1008/**
1009 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1010 *
1011 * @sd: pointer to &struct v4l2_subdev
1012 *
1013 * Returns the pointer to the private host data to be stored.
1014 */
1015static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
1016{
1017        return sd->host_priv;
1018}
1019
1020#ifdef CONFIG_MEDIA_CONTROLLER
1021
1022/**
1023 * v4l2_subdev_link_validate_default - validates a media link
1024 *
1025 * @sd: pointer to &struct v4l2_subdev
1026 * @link: pointer to &struct media_link
1027 * @source_fmt: pointer to &struct v4l2_subdev_format
1028 * @sink_fmt: pointer to &struct v4l2_subdev_format
1029 *
1030 * This function ensures that width, height and the media bus pixel
1031 * code are equal on both source and sink of the link.
1032 */
1033int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
1034                                      struct media_link *link,
1035                                      struct v4l2_subdev_format *source_fmt,
1036                                      struct v4l2_subdev_format *sink_fmt);
1037
1038/**
1039 * v4l2_subdev_link_validate - validates a media link
1040 *
1041 * @link: pointer to &struct media_link
1042 *
1043 * This function calls the subdev's link_validate ops to validate
1044 * if a media link is valid for streaming. It also internally
1045 * calls v4l2_subdev_link_validate_default() to ensure that
1046 * width, height and the media bus pixel code are equal on both
1047 * source and sink of the link.
1048 */
1049int v4l2_subdev_link_validate(struct media_link *link);
1050
1051/**
1052 * v4l2_subdev_alloc_pad_config - Allocates memory for pad config
1053 *
1054 * @sd: pointer to struct v4l2_subdev
1055 */
1056struct
1057v4l2_subdev_pad_config *v4l2_subdev_alloc_pad_config(struct v4l2_subdev *sd);
1058
1059/**
1060 * v4l2_subdev_free_pad_config - Frees memory allocated by
1061 *      v4l2_subdev_alloc_pad_config().
1062 *
1063 * @cfg: pointer to &struct v4l2_subdev_pad_config
1064 */
1065void v4l2_subdev_free_pad_config(struct v4l2_subdev_pad_config *cfg);
1066#endif /* CONFIG_MEDIA_CONTROLLER */
1067
1068/**
1069 * v4l2_subdev_init - initializes the sub-device struct
1070 *
1071 * @sd: pointer to the &struct v4l2_subdev to be initialized
1072 * @ops: pointer to &struct v4l2_subdev_ops.
1073 */
1074void v4l2_subdev_init(struct v4l2_subdev *sd,
1075                      const struct v4l2_subdev_ops *ops);
1076
1077/**
1078 * v4l2_subdev_call - call an operation of a v4l2_subdev.
1079 *
1080 * @sd: pointer to the &struct v4l2_subdev
1081 * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
1082 *     Each element there groups a set of callbacks functions.
1083 * @f: callback function that will be called if @cond matches.
1084 *     The callback functions are defined in groups, according to
1085 *     each element at &struct v4l2_subdev_ops.
1086 * @args...: arguments for @f.
1087 *
1088 * Example: err = v4l2_subdev_call(sd, video, s_std, norm);
1089 */
1090#define v4l2_subdev_call(sd, o, f, args...)                             \
1091        ({                                                              \
1092                int __result;                                           \
1093                if (!(sd))                                              \
1094                        __result = -ENODEV;                             \
1095                else if (!((sd)->ops->o && (sd)->ops->o->f))            \
1096                        __result = -ENOIOCTLCMD;                        \
1097                else                                                    \
1098                        __result = (sd)->ops->o->f((sd), ##args);       \
1099                __result;                                               \
1100        })
1101
1102/**
1103 * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1104 *
1105 * @sd: pointer to the &struct v4l2_subdev
1106 * @o: The group of callback functions in &struct v4l2_subdev_ops
1107 * which @f is a part of.
1108 * @f: callback function to be checked for its existence.
1109 */
1110#define v4l2_subdev_has_op(sd, o, f) \
1111        ((sd)->ops->o && (sd)->ops->o->f)
1112
1113/**
1114 * v4l2_subdev_notify_event() - Delivers event notification for subdevice
1115 * @sd: The subdev for which to deliver the event
1116 * @ev: The event to deliver
1117 *
1118 * Will deliver the specified event to all userspace event listeners which are
1119 * subscribed to the v42l subdev event queue as well as to the bridge driver
1120 * using the notify callback. The notification type for the notify callback
1121 * will be %V4L2_DEVICE_NOTIFY_EVENT.
1122 */
1123void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
1124                              const struct v4l2_event *ev);
1125
1126#endif
1127