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     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef _V4L2_SUBDEV_H
  22 #define _V4L2_SUBDEV_H
  23
  24 #include <linux/types.h>
  25 #include <linux/v4l2-subdev.h>
  26 #include <media/media-entity.h>
  27 #include <media/v4l2-async.h>
  28 #include <media/v4l2-common.h>
  29 #include <media/v4l2-dev.h>
  30 #include <media/v4l2-fh.h>
  31 #include <media/v4l2-mediabus.h>
  32
  33 /* generic v4l2_device notify callback notification values */
  34 #define V4L2_SUBDEV_IR_RX_NOTIFY                _IOW('v', 0, u32)
  35 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ      0x00000001
  36 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED    0x00000002
  37 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN       0x00000004
  38 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN       0x00000008
  39
  40 #define V4L2_SUBDEV_IR_TX_NOTIFY                _IOW('v', 1, u32)
  41 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ      0x00000001
  42
  43 #define V4L2_DEVICE_NOTIFY_EVENT                _IOW('v', 2, struct v4l2_event)
  44
  45 struct v4l2_device;
  46 struct v4l2_ctrl_handler;
  47 struct v4l2_event;
  48 struct v4l2_event_subscription;
  49 struct v4l2_fh;
  50 struct v4l2_subdev;
  51 struct v4l2_subdev_fh;
  52 struct tuner_setup;
  53 struct v4l2_mbus_frame_desc;
  54
  55 /* decode_vbi_line */
  56 struct v4l2_decode_vbi_line {
  57         u32 is_second_field;    /* Set to 0 for the first (odd) field,
  58                                    set to 1 for the second (even) field. */
  59         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
  60                                    On exit points to the start of the payload. */
  61         u32 line;               /* Line number of the sliced VBI data (1-23) */
  62         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
  63 };
  64
  65 /* Sub-devices are devices that are connected somehow to the main bridge
  66    device. These devices are usually audio/video muxers/encoders/decoders or
  67    sensors and webcam controllers.
  68
  69    Usually these devices are controlled through an i2c bus, but other busses
  70    may also be used.
  71
  72    The v4l2_subdev struct provides a way of accessing these devices in a
  73    generic manner. Most operations that these sub-devices support fall in
  74    a few categories: core ops, audio ops, video ops and tuner ops.
  75
  76    More categories can be added if needed, although this should remain a
  77    limited set (no more than approx. 8 categories).
  78
  79    Each category has its own set of ops that subdev drivers can implement.
  80
  81    A subdev driver can leave the pointer to the category ops NULL if
  82    it does not implement them (e.g. an audio subdev will generally not
  83    implement the video category ops). The exception is the core category:
  84    this must always be present.
  85
  86    These ops are all used internally so it is no problem to change, remove
  87    or add ops or move ops from one to another category. Currently these
  88    ops are based on the original ioctls, but since ops are not limited to
  89    one argument there is room for improvement here once all i2c subdev
  90    drivers are converted to use these ops.
  91  */
  92
  93 /* Core ops: it is highly recommended to implement at least these ops:
  94
  95    log_status
  96    g_register
  97    s_register
  98
  99    This provides basic debugging support.
 100
 101    The ioctl ops is meant for generic ioctl-like commands. Depending on
 102    the use-case it might be better to use subdev-specific ops (currently
 103    not yet implemented) since ops provide proper type-checking.
 104  */
 105
 106 /* Subdevice external IO pin configuration */
 107 #define V4L2_SUBDEV_IO_PIN_DISABLE      (1 << 0) /* ENABLE assumed */
 108 #define V4L2_SUBDEV_IO_PIN_OUTPUT       (1 << 1)
 109 #define V4L2_SUBDEV_IO_PIN_INPUT        (1 << 2)
 110 #define V4L2_SUBDEV_IO_PIN_SET_VALUE    (1 << 3) /* Set output value */
 111 #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW   (1 << 4) /* ACTIVE HIGH assumed */
 112
 113 struct v4l2_subdev_io_pin_config {
 114         u32 flags;      /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */
 115         u8 pin;         /* Chip external IO pin to configure */
 116         u8 function;    /* Internal signal pad/function to route to IO pin */
 117         u8 value;       /* Initial value for pin - e.g. GPIO output value */
 118         u8 strength;    /* Pin drive strength */
 119 };
 120
 121 /**
 122  * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs
 123  *
 124  * @log_status: callback for VIDIOC_LOG_STATUS ioctl handler code.
 125  *
 126  * @s_io_pin_config: configure one or more chip I/O pins for chips that
 127  *      multiplex different internal signal pads out to IO pins.  This function
 128  *      takes a pointer to an array of 'n' pin configuration entries, one for
 129  *      each pin being configured.  This function could be called at times
 130  *      other than just subdevice initialization.
 131  *
 132  * @init: initialize the sensor registers to some sort of reasonable default
 133  *      values. Do not use for new drivers and should be removed in existing
 134  *      drivers.
 135  *
 136  * @load_fw: load firmware.
 137  *
 138  * @reset: generic reset command. The argument selects which subsystems to
 139  *      reset. Passing 0 will always reset the whole chip. Do not use for new
 140  *      drivers without discussing this first on the linux-media mailinglist.
 141  *      There should be no reason normally to reset a device.
 142  *
 143  * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with
 144  *      a direction argument if needed.
 145  *
 146  * @queryctrl: callback for VIDIOC_QUERYCTL ioctl handler code.
 147  *
 148  * @g_ctrl: callback for VIDIOC_G_CTRL ioctl handler code.
 149  *
 150  * @s_ctrl: callback for VIDIOC_S_CTRL ioctl handler code.
 151  *
 152  * @g_ext_ctrls: callback for VIDIOC_G_EXT_CTRLS ioctl handler code.
 153  *
 154  * @s_ext_ctrls: callback for VIDIOC_S_EXT_CTRLS ioctl handler code.
 155  *
 156  * @try_ext_ctrls: callback for VIDIOC_TRY_EXT_CTRLS ioctl handler code.
 157  *
 158  * @querymenu: callback for VIDIOC_QUERYMENU ioctl handler code.
 159  *
 160  * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core.
 161  *         used to provide support for private ioctls used on the driver.
 162  *
 163  * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel,
 164  *                  in order to fix data passed from/to userspace.
 165  *
 166  * @g_register: callback for VIDIOC_G_REGISTER ioctl handler code.
 167  *
 168  * @s_register: callback for VIDIOC_G_REGISTER ioctl handler code.
 169  *
 170  * @s_power: puts subdevice in power saving mode (on == 0) or normal operation
 171  *      mode (on == 1).
 172  *
 173  * @interrupt_service_routine: Called by the bridge chip's interrupt service
 174  *      handler, when an interrupt status has be raised due to this subdev,
 175  *      so that this subdev can handle the details.  It may schedule work to be
 176  *      performed later.  It must not sleep.  *Called from an IRQ context*.
 177  *
 178  * @subscribe_event: used by the drivers to request the control framework that
 179  *                   for it to be warned when the value of a control changes.
 180  *
 181  * @unsubscribe_event: remove event subscription from the control framework.
 182  */
 183 struct v4l2_subdev_core_ops {
 184         int (*log_status)(struct v4l2_subdev *sd);
 185         int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
 186                                       struct v4l2_subdev_io_pin_config *pincfg);
 187         int (*init)(struct v4l2_subdev *sd, u32 val);
 188         int (*load_fw)(struct v4l2_subdev *sd);
 189         int (*reset)(struct v4l2_subdev *sd, u32 val);
 190         int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
 191         int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
 192         int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 193         int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 194         int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 195         int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 196         int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 197         int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
 198         long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
 199 #ifdef CONFIG_COMPAT
 200         long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,
 201                                unsigned long arg);
 202 #endif
 203 #ifdef CONFIG_VIDEO_ADV_DEBUG
 204         int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
 205         int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg);
 206 #endif
 207         int (*s_power)(struct v4l2_subdev *sd, int on);
 208         int (*interrupt_service_routine)(struct v4l2_subdev *sd,
 209                                                 u32 status, bool *handled);
 210         int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
 211                                struct v4l2_event_subscription *sub);
 212         int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
 213                                  struct v4l2_event_subscription *sub);
 214 };
 215
 216 /**
 217  * struct s_radio - Callbacks used when v4l device was opened in radio mode.
 218  *
 219  * @s_radio: callback for VIDIOC_S_RADIO ioctl handler code.
 220  *
 221  * @s_frequency: callback for VIDIOC_S_FREQUENCY ioctl handler code.
 222  *
 223  * @g_frequency: callback for VIDIOC_G_FREQUENCY ioctl handler code.
 224  *               freq->type must be filled in. Normally done by video_ioctl2
 225  *              or the bridge driver.
 226  *
 227  * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS ioctl handler code.
 228  *
 229  * @g_tuner: callback for VIDIOC_G_TUNER ioctl handler code.
 230  *
 231  * @s_tuner: callback for VIDIOC_S_TUNER ioctl handler code. vt->type must be
 232  *           filled in. Normally done by video_ioctl2 or the
 233  *      bridge driver.
 234  *
 235  * @g_modulator: callback for VIDIOC_G_MODULATOR ioctl handler code.
 236  *
 237  * @s_modulator: callback for VIDIOC_S_MODULATOR ioctl handler code.
 238  *
 239  * @s_type_addr: sets tuner type and its I2C addr.
 240  *
 241  * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
 242  */
 243 struct v4l2_subdev_tuner_ops {
 244         int (*s_radio)(struct v4l2_subdev *sd);
 245         int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);
 246         int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 247         int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);
 248         int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 249         int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);
 250         int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
 251         int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);
 252         int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
 253         int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
 254 };
 255
 256 /**
 257  * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
 258  *
 259  * @s_clock_freq: set the frequency (in Hz) of the audio clock output.
 260  *      Used to slave an audio processor to the video decoder, ensuring that
 261  *      audio and video remain synchronized. Usual values for the frequency
 262  *      are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
 263  *      -EINVAL is returned.
 264  *
 265  * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
 266  *      way to select I2S clock used by driving digital audio streams at some
 267  *      board designs. Usual values for the frequency are 1024000 and 2048000.
 268  *      If the frequency is not supported, then -EINVAL is returned.
 269  *
 270  * @s_routing: used to define the input and/or output pins of an audio chip,
 271  *      and any additional configuration data.
 272  *      Never attempt to use user-level input IDs (e.g. Composite, S-Video,
 273  *      Tuner) at this level. An i2c device shouldn't know about whether an
 274  *      input pin is connected to a Composite connector, become on another
 275  *      board or platform it might be connected to something else entirely.
 276  *      The calling driver is responsible for mapping a user-level input to
 277  *      the right pins on the i2c device.
 278  *
 279  * @s_stream: used to notify the audio code that stream will start or has
 280  *      stopped.
 281  */
 282 struct v4l2_subdev_audio_ops {
 283         int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 284         int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 285         int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 286         int (*s_stream)(struct v4l2_subdev *sd, int enable);
 287 };
 288
 289 /* Indicates the @length field specifies maximum data length. */
 290 #define V4L2_MBUS_FRAME_DESC_FL_LEN_MAX         (1U << 0)
 291 /*
 292  * Indicates that the format does not have line offsets, i.e. the
 293  * receiver should use 1D DMA.
 294  */
 295 #define V4L2_MBUS_FRAME_DESC_FL_BLOB            (1U << 1)
 296
 297 /**
 298  * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
 299  *
 300  * @flags: V4L2_MBUS_FRAME_DESC_FL_* flags
 301  * @pixelcode: media bus pixel code, valid if FRAME_DESC_FL_BLOB is not set
 302  * @length: number of octets per frame, valid if V4L2_MBUS_FRAME_DESC_FL_BLOB
 303  *          is set
 304  */
 305 struct v4l2_mbus_frame_desc_entry {
 306         u16 flags;
 307         u32 pixelcode;
 308         u32 length;
 309 };
 310
 311 #define V4L2_FRAME_DESC_ENTRY_MAX       4
 312
 313 /**
 314  * struct v4l2_mbus_frame_desc - media bus data frame description
 315  * @entry: frame descriptors array
 316  * @num_entries: number of entries in @entry array
 317  */
 318 struct v4l2_mbus_frame_desc {
 319         struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
 320         unsigned short num_entries;
 321 };
 322
 323 /**
 324  * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
 325  *                                in video mode.
 326  *
 327  * @s_routing: see s_routing in audio_ops, except this version is for video
 328  *      devices.
 329  *
 330  * @s_crystal_freq: sets the frequency of the crystal used to generate the
 331  *      clocks in Hz. An extra flags field allows device specific configuration
 332  *      regarding clock frequency dividers, etc. If not used, then set flags
 333  *      to 0. If the frequency is not supported, then -EINVAL is returned.
 334  *
 335  * @g_std: callback for VIDIOC_G_STD ioctl handler code.
 336  *
 337  * @s_std: callback for VIDIOC_S_STD ioctl handler code.
 338  *
 339  * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
 340  *      video input devices.
 341  *
 342  * @g_std_output: get current standard for video OUTPUT devices. This is ignored
 343  *      by video input devices.
 344  *
 345  * @querystd: callback for VIDIOC_QUERYSTD ioctl handler code.
 346  *
 347  * @g_tvnorms: get v4l2_std_id with all standards supported by the video
 348  *      CAPTURE device. This is ignored by video output devices.
 349  *
 350  * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
 351  *      OUTPUT device. This is ignored by video capture devices.
 352  *
 353  * @g_input_status: get input status. Same as the status field in the v4l2_input
 354  *      struct.
 355  *
 356  * @s_stream: used to notify the driver that a video stream will start or has
 357  *      stopped.
 358  *
 359  * @cropcap: callback for VIDIOC_CROPCAP ioctl handler code.
 360  *
 361  * @g_crop: callback for VIDIOC_G_CROP ioctl handler code.
 362  *
 363  * @s_crop: callback for VIDIOC_S_CROP ioctl handler code.
 364  *
 365  * @g_parm: callback for VIDIOC_G_PARM ioctl handler code.
 366  *
 367  * @s_parm: callback for VIDIOC_S_PARM ioctl handler code.
 368  *
 369  * @g_frame_interval: callback for VIDIOC_G_FRAMEINTERVAL ioctl handler code.
 370  *
 371  * @s_frame_interval: callback for VIDIOC_S_FRAMEINTERVAL ioctl handler code.
 372  *
 373  * @s_dv_timings: Set custom dv timings in the sub device. This is used
 374  *      when sub device is capable of setting detailed timing information
 375  *      in the hardware to generate/detect the video signal.
 376  *
 377  * @g_dv_timings: Get custom dv timings in the sub device.
 378  *
 379  * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS ioctl handler code.
 380  *
 381  * @g_mbus_config: get supported mediabus configurations
 382  *
 383  * @s_mbus_config: set a certain mediabus configuration. This operation is added
 384  *      for compatibility with soc-camera drivers and should not be used by new
 385  *      software.
 386  *
 387  * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
 388  *      can adjust @size to a lower value and must not write more data to the
 389  *      buffer starting at @data than the original value of @size.
 390  */
 391 struct v4l2_subdev_video_ops {
 392         int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 393         int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
 394         int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
 395         int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
 396         int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
 397         int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
 398         int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
 399         int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
 400         int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
 401         int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
 402         int (*s_stream)(struct v4l2_subdev *sd, int enable);
 403         int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
 404         int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
 405         int (*s_crop)(struct v4l2_subdev *sd, const struct v4l2_crop *crop);
 406         int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 407         int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 408         int (*g_frame_interval)(struct v4l2_subdev *sd,
 409                                 struct v4l2_subdev_frame_interval *interval);
 410         int (*s_frame_interval)(struct v4l2_subdev *sd,
 411                                 struct v4l2_subdev_frame_interval *interval);
 412         int (*s_dv_timings)(struct v4l2_subdev *sd,
 413                         struct v4l2_dv_timings *timings);
 414         int (*g_dv_timings)(struct v4l2_subdev *sd,
 415                         struct v4l2_dv_timings *timings);
 416         int (*query_dv_timings)(struct v4l2_subdev *sd,
 417                         struct v4l2_dv_timings *timings);
 418         int (*g_mbus_config)(struct v4l2_subdev *sd,
 419                              struct v4l2_mbus_config *cfg);
 420         int (*s_mbus_config)(struct v4l2_subdev *sd,
 421                              const struct v4l2_mbus_config *cfg);
 422         int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
 423                            unsigned int *size);
 424 };
 425
 426 /**
 427  * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
 428  *                                in video mode via the vbi device node.
 429  *
 430  *  @decode_vbi_line: video decoders that support sliced VBI need to implement
 431  *      this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
 432  *      start of the VBI data that was generated by the decoder. The driver
 433  *      then parses the sliced VBI data and sets the other fields in the
 434  *      struct accordingly. The pointer p is updated to point to the start of
 435  *      the payload which can be copied verbatim into the data field of the
 436  *      v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
 437  *      type field is set to 0 on return.
 438  *
 439  * @s_vbi_data: used to generate VBI signals on a video signal.
 440  *      v4l2_sliced_vbi_data is filled with the data packets that should be
 441  *      output. Note that if you set the line field to 0, then that VBI signal
 442  *      is disabled. If no valid VBI data was found, then the type field is
 443  *      set to 0 on return.
 444  *
 445  * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
 446  *      Not all video decoders support this. If no data is available because
 447  *      the readback register contains invalid or erroneous data -EIO is
 448  *      returned. Note that you must fill in the 'id' member and the 'field'
 449  *      member (to determine whether CC data from the first or second field
 450  *      should be obtained).
 451  *
 452  * @g_sliced_vbi_cap: callback for VIDIOC_SLICED_VBI_CAP ioctl handler code.
 453  *
 454  * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
 455  *
 456  * @g_sliced_fmt: retrieve the current sliced VBI settings.
 457  *
 458  * @s_sliced_fmt: setup the sliced VBI settings.
 459  */
 460 struct v4l2_subdev_vbi_ops {
 461         int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
 462         int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
 463         int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
 464         int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
 465         int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
 466         int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
 467         int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
 468 };
 469
 470 /**
 471  * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
 472  * @g_skip_top_lines: number of lines at the top of the image to be skipped.
 473  *                    This is needed for some sensors, which always corrupt
 474  *                    several top lines of the output image, or which send their
 475  *                    metadata in them.
 476  * @g_skip_frames: number of frames to skip at stream start. This is needed for
 477  *                 buggy sensors that generate faulty frames when they are
 478  *                 turned on.
 479  */
 480 struct v4l2_subdev_sensor_ops {
 481         int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
 482         int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
 483 };
 484
 485 /*
 486    [rt]x_g_parameters: Get the current operating parameters and state of the
 487         the IR receiver or transmitter.
 488
 489    [rt]x_s_parameters: Set the current operating parameters and state of the
 490         the IR receiver or transmitter.  It is recommended to call
 491         [rt]x_g_parameters first to fill out the current state, and only change
 492         the fields that need to be changed.  Upon return, the actual device
 493         operating parameters and state will be returned.  Note that hardware
 494         limitations may prevent the actual settings from matching the requested
 495         settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
 496         was requested.  An exception is when the shutdown parameter is true.
 497         The last used operational parameters will be returned, but the actual
 498         state of the hardware be different to minimize power consumption and
 499         processing when shutdown is true.
 500
 501    rx_read: Reads received codes or pulse width data.
 502         The semantics are similar to a non-blocking read() call.
 503
 504    tx_write: Writes codes or pulse width data for transmission.
 505         The semantics are similar to a non-blocking write() call.
 506  */
 507
 508 enum v4l2_subdev_ir_mode {
 509         V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
 510 };
 511
 512 struct v4l2_subdev_ir_parameters {
 513         /* Either Rx or Tx */
 514         unsigned int bytes_per_data_element; /* of data in read or write call */
 515         enum v4l2_subdev_ir_mode mode;
 516
 517         bool enable;
 518         bool interrupt_enable;
 519         bool shutdown; /* true: set hardware to low/no power, false: normal */
 520
 521         bool modulation;           /* true: uses carrier, false: baseband */
 522         u32 max_pulse_width;       /* ns,      valid only for baseband signal */
 523         unsigned int carrier_freq; /* Hz,      valid only for modulated signal*/
 524         unsigned int duty_cycle;   /* percent, valid only for modulated signal*/
 525         bool invert_level;         /* invert signal level */
 526
 527         /* Tx only */
 528         bool invert_carrier_sense; /* Send 0/space as a carrier burst */
 529
 530         /* Rx only */
 531         u32 noise_filter_min_width;       /* ns, min time of a valid pulse */
 532         unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
 533         unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
 534         u32 resolution;                   /* ns */
 535 };
 536
 537 struct v4l2_subdev_ir_ops {
 538         /* Receiver */
 539         int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 540                                 ssize_t *num);
 541
 542         int (*rx_g_parameters)(struct v4l2_subdev *sd,
 543                                 struct v4l2_subdev_ir_parameters *params);
 544         int (*rx_s_parameters)(struct v4l2_subdev *sd,
 545                                 struct v4l2_subdev_ir_parameters *params);
 546
 547         /* Transmitter */
 548         int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 549                                 ssize_t *num);
 550
 551         int (*tx_g_parameters)(struct v4l2_subdev *sd,
 552                                 struct v4l2_subdev_ir_parameters *params);
 553         int (*tx_s_parameters)(struct v4l2_subdev *sd,
 554                                 struct v4l2_subdev_ir_parameters *params);
 555 };
 556
 557 /*
 558  * Used for storing subdev pad information. This structure only needs
 559  * to be passed to the pad op if the 'which' field of the main argument
 560  * is set to V4L2_SUBDEV_FORMAT_TRY. For V4L2_SUBDEV_FORMAT_ACTIVE it is
 561  * safe to pass NULL.
 562  */
 563 struct v4l2_subdev_pad_config {
 564         struct v4l2_mbus_framefmt try_fmt;
 565         struct v4l2_rect try_crop;
 566         struct v4l2_rect try_compose;
 567 };
 568
 569 /**
 570  * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
 571  *
 572  * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE ioctl handler
 573  *                  code.
 574  * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE ioctl handler
 575  *                   code.
 576  *
 577  * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL ioctl
 578  *                       handler code.
 579  *
 580  * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT ioctl handler code.
 581  *
 582  * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT ioctl handler code.
 583  *
 584  * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION ioctl handler code.
 585  *
 586  * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION ioctl handler code.
 587  *
 588  * @get_edid: callback for VIDIOC_SUBDEV_G_EDID ioctl handler code.
 589  *
 590  * @set_edid: callback for VIDIOC_SUBDEV_S_EDID ioctl handler code.
 591  *
 592  * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP ioctl handler
 593  *                  code.
 594  *
 595  * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS ioctl handler
 596  *                   code.
 597  *
 598  * @link_validate: used by the media controller code to check if the links
 599  *                 that belongs to a pipeline can be used for stream.
 600  *
 601  * @get_frame_desc: get the current low level media bus frame parameters.
 602  *
 603  * @set_frame_desc: set the low level media bus frame parameters, @fd array
 604  *                  may be adjusted by the subdev driver to device capabilities.
 605  */
 606 struct v4l2_subdev_pad_ops {
 607         int (*enum_mbus_code)(struct v4l2_subdev *sd,
 608                               struct v4l2_subdev_pad_config *cfg,
 609                               struct v4l2_subdev_mbus_code_enum *code);
 610         int (*enum_frame_size)(struct v4l2_subdev *sd,
 611                                struct v4l2_subdev_pad_config *cfg,
 612                                struct v4l2_subdev_frame_size_enum *fse);
 613         int (*enum_frame_interval)(struct v4l2_subdev *sd,
 614                                    struct v4l2_subdev_pad_config *cfg,
 615                                    struct v4l2_subdev_frame_interval_enum *fie);
 616         int (*get_fmt)(struct v4l2_subdev *sd,
 617                        struct v4l2_subdev_pad_config *cfg,
 618                        struct v4l2_subdev_format *format);
 619         int (*set_fmt)(struct v4l2_subdev *sd,
 620                        struct v4l2_subdev_pad_config *cfg,
 621                        struct v4l2_subdev_format *format);
 622         int (*get_selection)(struct v4l2_subdev *sd,
 623                              struct v4l2_subdev_pad_config *cfg,
 624                              struct v4l2_subdev_selection *sel);
 625         int (*set_selection)(struct v4l2_subdev *sd,
 626                              struct v4l2_subdev_pad_config *cfg,
 627                              struct v4l2_subdev_selection *sel);
 628         int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
 629         int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
 630         int (*dv_timings_cap)(struct v4l2_subdev *sd,
 631                               struct v4l2_dv_timings_cap *cap);
 632         int (*enum_dv_timings)(struct v4l2_subdev *sd,
 633                                struct v4l2_enum_dv_timings *timings);
 634 #ifdef CONFIG_MEDIA_CONTROLLER
 635         int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
 636                              struct v4l2_subdev_format *source_fmt,
 637                              struct v4l2_subdev_format *sink_fmt);
 638 #endif /* CONFIG_MEDIA_CONTROLLER */
 639         int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
 640                               struct v4l2_mbus_frame_desc *fd);
 641         int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
 642                               struct v4l2_mbus_frame_desc *fd);
 643 };
 644
 645 struct v4l2_subdev_ops {
 646         const struct v4l2_subdev_core_ops       *core;
 647         const struct v4l2_subdev_tuner_ops      *tuner;
 648         const struct v4l2_subdev_audio_ops      *audio;
 649         const struct v4l2_subdev_video_ops      *video;
 650         const struct v4l2_subdev_vbi_ops        *vbi;
 651         const struct v4l2_subdev_ir_ops         *ir;
 652         const struct v4l2_subdev_sensor_ops     *sensor;
 653         const struct v4l2_subdev_pad_ops        *pad;
 654 };
 655
 656 /*
 657  * Internal ops. Never call this from drivers, only the v4l2 framework can call
 658  * these ops.
 659  *
 660  * registered: called when this subdev is registered. When called the v4l2_dev
 661  *      field is set to the correct v4l2_device.
 662  *
 663  * unregistered: called when this subdev is unregistered. When called the
 664  *      v4l2_dev field is still set to the correct v4l2_device.
 665  *
 666  * open: called when the subdev device node is opened by an application.
 667  *
 668  * close: called when the subdev device node is closed.
 669  */
 670 struct v4l2_subdev_internal_ops {
 671         int (*registered)(struct v4l2_subdev *sd);
 672         void (*unregistered)(struct v4l2_subdev *sd);
 673         int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
 674         int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
 675 };
 676
 677 #define V4L2_SUBDEV_NAME_SIZE 32
 678
 679 /* Set this flag if this subdev is a i2c device. */
 680 #define V4L2_SUBDEV_FL_IS_I2C                   (1U << 0)
 681 /* Set this flag if this subdev is a spi device. */
 682 #define V4L2_SUBDEV_FL_IS_SPI                   (1U << 1)
 683 /* Set this flag if this subdev needs a device node. */
 684 #define V4L2_SUBDEV_FL_HAS_DEVNODE              (1U << 2)
 685 /* Set this flag if this subdev generates events. */
 686 #define V4L2_SUBDEV_FL_HAS_EVENTS               (1U << 3)
 687
 688 struct regulator_bulk_data;
 689
 690 struct v4l2_subdev_platform_data {
 691         /* Optional regulators uset to power on/off the subdevice */
 692         struct regulator_bulk_data *regulators;
 693         int num_regulators;
 694
 695         /* Per-subdevice data, specific for a certain video host device */
 696         void *host_priv;
 697 };
 698
 699 /* Each instance of a subdev driver should create this struct, either
 700    stand-alone or embedded in a larger struct.
 701  */
 702 struct v4l2_subdev {
 703 #if defined(CONFIG_MEDIA_CONTROLLER)
 704         struct media_entity entity;
 705 #endif
 706         struct list_head list;
 707         struct module *owner;
 708         bool owner_v4l2_dev;
 709         u32 flags;
 710         struct v4l2_device *v4l2_dev;
 711         const struct v4l2_subdev_ops *ops;
 712         /* Never call these internal ops from within a driver! */
 713         const struct v4l2_subdev_internal_ops *internal_ops;
 714         /* The control handler of this subdev. May be NULL. */
 715         struct v4l2_ctrl_handler *ctrl_handler;
 716         /* name must be unique */
 717         char name[V4L2_SUBDEV_NAME_SIZE];
 718         /* can be used to group similar subdevs, value is driver-specific */
 719         u32 grp_id;
 720         /* pointer to private data */
 721         void *dev_priv;
 722         void *host_priv;
 723         /* subdev device node */
 724         struct video_device *devnode;
 725         /* pointer to the physical device, if any */
 726         struct device *dev;
 727         /* The device_node of the subdev, usually the same as dev->of_node. */
 728         struct device_node *of_node;
 729         /* Links this subdev to a global subdev_list or @notifier->done list. */
 730         struct list_head async_list;
 731         /* Pointer to respective struct v4l2_async_subdev. */
 732         struct v4l2_async_subdev *asd;
 733         /* Pointer to the managing notifier. */
 734         struct v4l2_async_notifier *notifier;
 735         /* common part of subdevice platform data */
 736         struct v4l2_subdev_platform_data *pdata;
 737 };
 738
 739 #define media_entity_to_v4l2_subdev(ent) \
 740         container_of(ent, struct v4l2_subdev, entity)
 741 #define vdev_to_v4l2_subdev(vdev) \
 742         ((struct v4l2_subdev *)video_get_drvdata(vdev))
 743
 744 /*
 745  * Used for storing subdev information per file handle
 746  */
 747 struct v4l2_subdev_fh {
 748         struct v4l2_fh vfh;
 749 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
 750         struct v4l2_subdev_pad_config *pad;
 751 #endif
 752 };
 753
 754 #define to_v4l2_subdev_fh(fh)   \
 755         container_of(fh, struct v4l2_subdev_fh, vfh)
 756
 757 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
 758 #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name)           \
 759         static inline struct rtype *                                    \
 760         fun_name(struct v4l2_subdev *sd,                                \
 761                  struct v4l2_subdev_pad_config *cfg,                    \
 762                  unsigned int pad)                                      \
 763         {                                                               \
 764                 BUG_ON(pad >= sd->entity.num_pads);                     \
 765                 return &cfg[pad].field_name;                            \
 766         }
 767
 768 __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, v4l2_subdev_get_try_format, try_fmt)
 769 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_crop, try_crop)
 770 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_compose, try_compose)
 771 #endif
 772
 773 extern const struct v4l2_file_operations v4l2_subdev_fops;
 774
 775 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
 776 {
 777         sd->dev_priv = p;
 778 }
 779
 780 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
 781 {
 782         return sd->dev_priv;
 783 }
 784
 785 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
 786 {
 787         sd->host_priv = p;
 788 }
 789
 790 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
 791 {
 792         return sd->host_priv;
 793 }
 794
 795 #ifdef CONFIG_MEDIA_CONTROLLER
 796 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
 797                                       struct media_link *link,
 798                                       struct v4l2_subdev_format *source_fmt,
 799                                       struct v4l2_subdev_format *sink_fmt);
 800 int v4l2_subdev_link_validate(struct media_link *link);
 801 #endif /* CONFIG_MEDIA_CONTROLLER */
 802 void v4l2_subdev_init(struct v4l2_subdev *sd,
 803                       const struct v4l2_subdev_ops *ops);
 804
 805 /* Call an ops of a v4l2_subdev, doing the right checks against
 806    NULL pointers.
 807
 808    Example: err = v4l2_subdev_call(sd, video, s_std, norm);
 809  */
 810 #define v4l2_subdev_call(sd, o, f, args...)                             \
 811         (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
 812                 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
 813
 814 #define v4l2_subdev_has_op(sd, o, f) \
 815         ((sd)->ops->o && (sd)->ops->o->f)
 816
 817 void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
 818                               const struct v4l2_event *ev);
 819
 820 #endif