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 ops callbacks for subdevs
 123  *
 124  * @s_io_pin_config: configure one or more chip I/O pins for chips that
 125  *      multiplex different internal signal pads out to IO pins.  This function
 126  *      takes a pointer to an array of 'n' pin configuration entries, one for
 127  *      each pin being configured.  This function could be called at times
 128  *      other than just subdevice initialization.
 129  *
 130  * @init: initialize the sensor registers to some sort of reasonable default
 131  *      values. Do not use for new drivers and should be removed in existing
 132  *      drivers.
 133  *
 134  * @load_fw: load firmware.
 135  *
 136  * @reset: generic reset command. The argument selects which subsystems to
 137  *      reset. Passing 0 will always reset the whole chip. Do not use for new
 138  *      drivers without discussing this first on the linux-media mailinglist.
 139  *      There should be no reason normally to reset a device.
 140  *
 141  * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with
 142  *      a direction argument if needed.
 143  *
 144  * @s_power: puts subdevice in power saving mode (on == 0) or normal operation
 145  *      mode (on == 1).
 146  *
 147  * @interrupt_service_routine: Called by the bridge chip's interrupt service
 148  *      handler, when an interrupt status has be raised due to this subdev,
 149  *      so that this subdev can handle the details.  It may schedule work to be
 150  *      performed later.  It must not sleep.  *Called from an IRQ context*.
 151  */
 152 struct v4l2_subdev_core_ops {
 153         int (*log_status)(struct v4l2_subdev *sd);
 154         int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
 155                                       struct v4l2_subdev_io_pin_config *pincfg);
 156         int (*init)(struct v4l2_subdev *sd, u32 val);
 157         int (*load_fw)(struct v4l2_subdev *sd);
 158         int (*reset)(struct v4l2_subdev *sd, u32 val);
 159         int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
 160         int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
 161         int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 162         int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 163         int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 164         int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 165         int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 166         int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
 167         long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
 168 #ifdef CONFIG_COMPAT
 169         long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,
 170                                unsigned long arg);
 171 #endif
 172 #ifdef CONFIG_VIDEO_ADV_DEBUG
 173         int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
 174         int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg);
 175 #endif
 176         int (*s_power)(struct v4l2_subdev *sd, int on);
 177         int (*interrupt_service_routine)(struct v4l2_subdev *sd,
 178                                                 u32 status, bool *handled);
 179         int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
 180                                struct v4l2_event_subscription *sub);
 181         int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
 182                                  struct v4l2_event_subscription *sub);
 183 };
 184
 185 /**
 186  * struct s_radio - Callbacks used when v4l device was opened in radio mode.
 187  *
 188  * @g_frequency: freq->type must be filled in. Normally done by video_ioctl2
 189  *      or the bridge driver.
 190  * @g_tuner:
 191  * @s_tuner: vt->type must be filled in. Normally done by video_ioctl2 or the
 192  *      bridge driver.
 193  *
 194  * @s_type_addr: sets tuner type and its I2C addr.
 195  * @s_config: sets tda9887 specific stuff, like port1, port2 and qss
 196  */
 197 struct v4l2_subdev_tuner_ops {
 198         int (*s_radio)(struct v4l2_subdev *sd);
 199         int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);
 200         int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 201         int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);
 202         int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 203         int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);
 204         int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
 205         int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);
 206         int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
 207         int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
 208 };
 209
 210 /**
 211  * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
 212  *
 213  * @s_clock_freq: set the frequency (in Hz) of the audio clock output.
 214  *      Used to slave an audio processor to the video decoder, ensuring that
 215  *      audio and video remain synchronized. Usual values for the frequency
 216  *      are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
 217  *      -EINVAL is returned.
 218  *
 219  * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
 220  *      way to select I2S clock used by driving digital audio streams at some
 221  *      board designs. Usual values for the frequency are 1024000 and 2048000.
 222  *      If the frequency is not supported, then -EINVAL is returned.
 223  *
 224  * @s_routing: used to define the input and/or output pins of an audio chip,
 225  *      and any additional configuration data.
 226  *      Never attempt to use user-level input IDs (e.g. Composite, S-Video,
 227  *      Tuner) at this level. An i2c device shouldn't know about whether an
 228  *      input pin is connected to a Composite connector, become on another
 229  *      board or platform it might be connected to something else entirely.
 230  *      The calling driver is responsible for mapping a user-level input to
 231  *      the right pins on the i2c device.
 232  */
 233 struct v4l2_subdev_audio_ops {
 234         int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 235         int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 236         int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 237         int (*s_stream)(struct v4l2_subdev *sd, int enable);
 238 };
 239
 240 /* Indicates the @length field specifies maximum data length. */
 241 #define V4L2_MBUS_FRAME_DESC_FL_LEN_MAX         (1U << 0)
 242 /*
 243  * Indicates that the format does not have line offsets, i.e. the
 244  * receiver should use 1D DMA.
 245  */
 246 #define V4L2_MBUS_FRAME_DESC_FL_BLOB            (1U << 1)
 247
 248 /**
 249  * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
 250  *
 251  * @flags: V4L2_MBUS_FRAME_DESC_FL_* flags
 252  * @pixelcode: media bus pixel code, valid if FRAME_DESC_FL_BLOB is not set
 253  * @length: number of octets per frame, valid if V4L2_MBUS_FRAME_DESC_FL_BLOB
 254  *          is set
 255  */
 256 struct v4l2_mbus_frame_desc_entry {
 257         u16 flags;
 258         u32 pixelcode;
 259         u32 length;
 260 };
 261
 262 #define V4L2_FRAME_DESC_ENTRY_MAX       4
 263
 264 /**
 265  * struct v4l2_mbus_frame_desc - media bus data frame description
 266  * @entry: frame descriptors array
 267  * @num_entries: number of entries in @entry array
 268  */
 269 struct v4l2_mbus_frame_desc {
 270         struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];
 271         unsigned short num_entries;
 272 };
 273
 274 /**
 275  * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
 276  *                                in video mode.
 277  * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
 278  *      video input devices.
 279  *
 280  * @g_std_output: get current standard for video OUTPUT devices. This is ignored
 281  *      by video input devices.
 282  *
 283  * @g_tvnorms: get v4l2_std_id with all standards supported by the video
 284  *      CAPTURE device. This is ignored by video output devices.
 285  *
 286  * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
 287  *      OUTPUT device. This is ignored by video capture devices.
 288  *
 289  * @s_crystal_freq: sets the frequency of the crystal used to generate the
 290  *      clocks in Hz. An extra flags field allows device specific configuration
 291  *      regarding clock frequency dividers, etc. If not used, then set flags
 292  *      to 0. If the frequency is not supported, then -EINVAL is returned.
 293  *
 294  * @g_input_status: get input status. Same as the status field in the v4l2_input
 295  *      struct.
 296  *
 297  * @s_routing: see s_routing in audio_ops, except this version is for video
 298  *      devices.
 299  *
 300  * @s_dv_timings(): Set custom dv timings in the sub device. This is used
 301  *      when sub device is capable of setting detailed timing information
 302  *      in the hardware to generate/detect the video signal.
 303  *
 304  * @g_dv_timings(): Get custom dv timings in the sub device.
 305  * @g_mbus_config: get supported mediabus configurations
 306  *
 307  * @s_mbus_config: set a certain mediabus configuration. This operation is added
 308  *      for compatibility with soc-camera drivers and should not be used by new
 309  *      software.
 310  *
 311  * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev
 312  *      can adjust @size to a lower value and must not write more data to the
 313  *      buffer starting at @data than the original value of @size.
 314  */
 315 struct v4l2_subdev_video_ops {
 316         int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 317         int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
 318         int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
 319         int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
 320         int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
 321         int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
 322         int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
 323         int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);
 324         int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
 325         int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
 326         int (*s_stream)(struct v4l2_subdev *sd, int enable);
 327         int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
 328         int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
 329         int (*s_crop)(struct v4l2_subdev *sd, const struct v4l2_crop *crop);
 330         int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 331         int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 332         int (*g_frame_interval)(struct v4l2_subdev *sd,
 333                                 struct v4l2_subdev_frame_interval *interval);
 334         int (*s_frame_interval)(struct v4l2_subdev *sd,
 335                                 struct v4l2_subdev_frame_interval *interval);
 336         int (*s_dv_timings)(struct v4l2_subdev *sd,
 337                         struct v4l2_dv_timings *timings);
 338         int (*g_dv_timings)(struct v4l2_subdev *sd,
 339                         struct v4l2_dv_timings *timings);
 340         int (*query_dv_timings)(struct v4l2_subdev *sd,
 341                         struct v4l2_dv_timings *timings);
 342         int (*g_mbus_config)(struct v4l2_subdev *sd,
 343                              struct v4l2_mbus_config *cfg);
 344         int (*s_mbus_config)(struct v4l2_subdev *sd,
 345                              const struct v4l2_mbus_config *cfg);
 346         int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,
 347                            unsigned int *size);
 348 };
 349
 350 /**
 351  * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
 352  *                                in video mode via the vbi device node.
 353  *
 354  *  @decode_vbi_line: video decoders that support sliced VBI need to implement
 355  *      this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
 356  *      start of the VBI data that was generated by the decoder. The driver
 357  *      then parses the sliced VBI data and sets the other fields in the
 358  *      struct accordingly. The pointer p is updated to point to the start of
 359  *      the payload which can be copied verbatim into the data field of the
 360  *      v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
 361  *      type field is set to 0 on return.
 362  *
 363  * @s_vbi_data: used to generate VBI signals on a video signal.
 364  *      v4l2_sliced_vbi_data is filled with the data packets that should be
 365  *      output. Note that if you set the line field to 0, then that VBI signal
 366  *      is disabled. If no valid VBI data was found, then the type field is
 367  *      set to 0 on return.
 368  *
 369  * @g_vbi_data: used to obtain the sliced VBI packet from a readback register.
 370  *      Not all video decoders support this. If no data is available because
 371  *      the readback register contains invalid or erroneous data -EIO is
 372  *      returned. Note that you must fill in the 'id' member and the 'field'
 373  *      member (to determine whether CC data from the first or second field
 374  *      should be obtained).
 375  *
 376  * @s_raw_fmt: setup the video encoder/decoder for raw VBI.
 377  *
 378  * @g_sliced_fmt: retrieve the current sliced VBI settings.
 379  *
 380  * @s_sliced_fmt: setup the sliced VBI settings.
 381  */
 382 struct v4l2_subdev_vbi_ops {
 383         int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
 384         int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
 385         int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
 386         int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
 387         int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
 388         int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
 389         int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
 390 };
 391
 392 /**
 393  * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
 394  * @g_skip_top_lines: number of lines at the top of the image to be skipped.
 395  *                    This is needed for some sensors, which always corrupt
 396  *                    several top lines of the output image, or which send their
 397  *                    metadata in them.
 398  * @g_skip_frames: number of frames to skip at stream start. This is needed for
 399  *                 buggy sensors that generate faulty frames when they are
 400  *                 turned on.
 401  */
 402 struct v4l2_subdev_sensor_ops {
 403         int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
 404         int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
 405 };
 406
 407 /*
 408    [rt]x_g_parameters: Get the current operating parameters and state of the
 409         the IR receiver or transmitter.
 410
 411    [rt]x_s_parameters: Set the current operating parameters and state of the
 412         the IR receiver or transmitter.  It is recommended to call
 413         [rt]x_g_parameters first to fill out the current state, and only change
 414         the fields that need to be changed.  Upon return, the actual device
 415         operating parameters and state will be returned.  Note that hardware
 416         limitations may prevent the actual settings from matching the requested
 417         settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
 418         was requested.  An exception is when the shutdown parameter is true.
 419         The last used operational parameters will be returned, but the actual
 420         state of the hardware be different to minimize power consumption and
 421         processing when shutdown is true.
 422
 423    rx_read: Reads received codes or pulse width data.
 424         The semantics are similar to a non-blocking read() call.
 425
 426    tx_write: Writes codes or pulse width data for transmission.
 427         The semantics are similar to a non-blocking write() call.
 428  */
 429
 430 enum v4l2_subdev_ir_mode {
 431         V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
 432 };
 433
 434 struct v4l2_subdev_ir_parameters {
 435         /* Either Rx or Tx */
 436         unsigned int bytes_per_data_element; /* of data in read or write call */
 437         enum v4l2_subdev_ir_mode mode;
 438
 439         bool enable;
 440         bool interrupt_enable;
 441         bool shutdown; /* true: set hardware to low/no power, false: normal */
 442
 443         bool modulation;           /* true: uses carrier, false: baseband */
 444         u32 max_pulse_width;       /* ns,      valid only for baseband signal */
 445         unsigned int carrier_freq; /* Hz,      valid only for modulated signal*/
 446         unsigned int duty_cycle;   /* percent, valid only for modulated signal*/
 447         bool invert_level;         /* invert signal level */
 448
 449         /* Tx only */
 450         bool invert_carrier_sense; /* Send 0/space as a carrier burst */
 451
 452         /* Rx only */
 453         u32 noise_filter_min_width;       /* ns, min time of a valid pulse */
 454         unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
 455         unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
 456         u32 resolution;                   /* ns */
 457 };
 458
 459 struct v4l2_subdev_ir_ops {
 460         /* Receiver */
 461         int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 462                                 ssize_t *num);
 463
 464         int (*rx_g_parameters)(struct v4l2_subdev *sd,
 465                                 struct v4l2_subdev_ir_parameters *params);
 466         int (*rx_s_parameters)(struct v4l2_subdev *sd,
 467                                 struct v4l2_subdev_ir_parameters *params);
 468
 469         /* Transmitter */
 470         int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 471                                 ssize_t *num);
 472
 473         int (*tx_g_parameters)(struct v4l2_subdev *sd,
 474                                 struct v4l2_subdev_ir_parameters *params);
 475         int (*tx_s_parameters)(struct v4l2_subdev *sd,
 476                                 struct v4l2_subdev_ir_parameters *params);
 477 };
 478
 479 /*
 480  * Used for storing subdev pad information. This structure only needs
 481  * to be passed to the pad op if the 'which' field of the main argument
 482  * is set to V4L2_SUBDEV_FORMAT_TRY. For V4L2_SUBDEV_FORMAT_ACTIVE it is
 483  * safe to pass NULL.
 484  */
 485 struct v4l2_subdev_pad_config {
 486         struct v4l2_mbus_framefmt try_fmt;
 487         struct v4l2_rect try_crop;
 488         struct v4l2_rect try_compose;
 489 };
 490
 491 /**
 492  * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
 493  * @get_frame_desc: get the current low level media bus frame parameters.
 494  * @get_frame_desc: set the low level media bus frame parameters, @fd array
 495  *                  may be adjusted by the subdev driver to device capabilities.
 496  */
 497 struct v4l2_subdev_pad_ops {
 498         int (*enum_mbus_code)(struct v4l2_subdev *sd,
 499                               struct v4l2_subdev_pad_config *cfg,
 500                               struct v4l2_subdev_mbus_code_enum *code);
 501         int (*enum_frame_size)(struct v4l2_subdev *sd,
 502                                struct v4l2_subdev_pad_config *cfg,
 503                                struct v4l2_subdev_frame_size_enum *fse);
 504         int (*enum_frame_interval)(struct v4l2_subdev *sd,
 505                                    struct v4l2_subdev_pad_config *cfg,
 506                                    struct v4l2_subdev_frame_interval_enum *fie);
 507         int (*get_fmt)(struct v4l2_subdev *sd,
 508                        struct v4l2_subdev_pad_config *cfg,
 509                        struct v4l2_subdev_format *format);
 510         int (*set_fmt)(struct v4l2_subdev *sd,
 511                        struct v4l2_subdev_pad_config *cfg,
 512                        struct v4l2_subdev_format *format);
 513         int (*get_selection)(struct v4l2_subdev *sd,
 514                              struct v4l2_subdev_pad_config *cfg,
 515                              struct v4l2_subdev_selection *sel);
 516         int (*set_selection)(struct v4l2_subdev *sd,
 517                              struct v4l2_subdev_pad_config *cfg,
 518                              struct v4l2_subdev_selection *sel);
 519         int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
 520         int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid);
 521         int (*dv_timings_cap)(struct v4l2_subdev *sd,
 522                               struct v4l2_dv_timings_cap *cap);
 523         int (*enum_dv_timings)(struct v4l2_subdev *sd,
 524                                struct v4l2_enum_dv_timings *timings);
 525 #ifdef CONFIG_MEDIA_CONTROLLER
 526         int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
 527                              struct v4l2_subdev_format *source_fmt,
 528                              struct v4l2_subdev_format *sink_fmt);
 529 #endif /* CONFIG_MEDIA_CONTROLLER */
 530         int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
 531                               struct v4l2_mbus_frame_desc *fd);
 532         int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad,
 533                               struct v4l2_mbus_frame_desc *fd);
 534 };
 535
 536 struct v4l2_subdev_ops {
 537         const struct v4l2_subdev_core_ops       *core;
 538         const struct v4l2_subdev_tuner_ops      *tuner;
 539         const struct v4l2_subdev_audio_ops      *audio;
 540         const struct v4l2_subdev_video_ops      *video;
 541         const struct v4l2_subdev_vbi_ops        *vbi;
 542         const struct v4l2_subdev_ir_ops         *ir;
 543         const struct v4l2_subdev_sensor_ops     *sensor;
 544         const struct v4l2_subdev_pad_ops        *pad;
 545 };
 546
 547 /*
 548  * Internal ops. Never call this from drivers, only the v4l2 framework can call
 549  * these ops.
 550  *
 551  * registered: called when this subdev is registered. When called the v4l2_dev
 552  *      field is set to the correct v4l2_device.
 553  *
 554  * unregistered: called when this subdev is unregistered. When called the
 555  *      v4l2_dev field is still set to the correct v4l2_device.
 556  *
 557  * open: called when the subdev device node is opened by an application.
 558  *
 559  * close: called when the subdev device node is closed.
 560  */
 561 struct v4l2_subdev_internal_ops {
 562         int (*registered)(struct v4l2_subdev *sd);
 563         void (*unregistered)(struct v4l2_subdev *sd);
 564         int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
 565         int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
 566 };
 567
 568 #define V4L2_SUBDEV_NAME_SIZE 32
 569
 570 /* Set this flag if this subdev is a i2c device. */
 571 #define V4L2_SUBDEV_FL_IS_I2C                   (1U << 0)
 572 /* Set this flag if this subdev is a spi device. */
 573 #define V4L2_SUBDEV_FL_IS_SPI                   (1U << 1)
 574 /* Set this flag if this subdev needs a device node. */
 575 #define V4L2_SUBDEV_FL_HAS_DEVNODE              (1U << 2)
 576 /* Set this flag if this subdev generates events. */
 577 #define V4L2_SUBDEV_FL_HAS_EVENTS               (1U << 3)
 578
 579 struct regulator_bulk_data;
 580
 581 struct v4l2_subdev_platform_data {
 582         /* Optional regulators uset to power on/off the subdevice */
 583         struct regulator_bulk_data *regulators;
 584         int num_regulators;
 585
 586         /* Per-subdevice data, specific for a certain video host device */
 587         void *host_priv;
 588 };
 589
 590 /* Each instance of a subdev driver should create this struct, either
 591    stand-alone or embedded in a larger struct.
 592  */
 593 struct v4l2_subdev {
 594 #if defined(CONFIG_MEDIA_CONTROLLER)
 595         struct media_entity entity;
 596 #endif
 597         struct list_head list;
 598         struct module *owner;
 599         bool owner_v4l2_dev;
 600         u32 flags;
 601         struct v4l2_device *v4l2_dev;
 602         const struct v4l2_subdev_ops *ops;
 603         /* Never call these internal ops from within a driver! */
 604         const struct v4l2_subdev_internal_ops *internal_ops;
 605         /* The control handler of this subdev. May be NULL. */
 606         struct v4l2_ctrl_handler *ctrl_handler;
 607         /* name must be unique */
 608         char name[V4L2_SUBDEV_NAME_SIZE];
 609         /* can be used to group similar subdevs, value is driver-specific */
 610         u32 grp_id;
 611         /* pointer to private data */
 612         void *dev_priv;
 613         void *host_priv;
 614         /* subdev device node */
 615         struct video_device *devnode;
 616         /* pointer to the physical device, if any */
 617         struct device *dev;
 618         /* The device_node of the subdev, usually the same as dev->of_node. */
 619         struct device_node *of_node;
 620         /* Links this subdev to a global subdev_list or @notifier->done list. */
 621         struct list_head async_list;
 622         /* Pointer to respective struct v4l2_async_subdev. */
 623         struct v4l2_async_subdev *asd;
 624         /* Pointer to the managing notifier. */
 625         struct v4l2_async_notifier *notifier;
 626         /* common part of subdevice platform data */
 627         struct v4l2_subdev_platform_data *pdata;
 628 };
 629
 630 #define media_entity_to_v4l2_subdev(ent) \
 631         container_of(ent, struct v4l2_subdev, entity)
 632 #define vdev_to_v4l2_subdev(vdev) \
 633         ((struct v4l2_subdev *)video_get_drvdata(vdev))
 634
 635 /*
 636  * Used for storing subdev information per file handle
 637  */
 638 struct v4l2_subdev_fh {
 639         struct v4l2_fh vfh;
 640 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
 641         struct v4l2_subdev_pad_config *pad;
 642 #endif
 643 };
 644
 645 #define to_v4l2_subdev_fh(fh)   \
 646         container_of(fh, struct v4l2_subdev_fh, vfh)
 647
 648 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
 649 #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name)           \
 650         static inline struct rtype *                                    \
 651         fun_name(struct v4l2_subdev *sd,                                \
 652                  struct v4l2_subdev_pad_config *cfg,                    \
 653                  unsigned int pad)                                      \
 654         {                                                               \
 655                 BUG_ON(pad >= sd->entity.num_pads);                     \
 656                 return &cfg[pad].field_name;                            \
 657         }
 658
 659 __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, v4l2_subdev_get_try_format, try_fmt)
 660 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_crop, try_crop)
 661 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_compose, try_compose)
 662 #endif
 663
 664 extern const struct v4l2_file_operations v4l2_subdev_fops;
 665
 666 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
 667 {
 668         sd->dev_priv = p;
 669 }
 670
 671 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
 672 {
 673         return sd->dev_priv;
 674 }
 675
 676 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
 677 {
 678         sd->host_priv = p;
 679 }
 680
 681 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
 682 {
 683         return sd->host_priv;
 684 }
 685
 686 #ifdef CONFIG_MEDIA_CONTROLLER
 687 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
 688                                       struct media_link *link,
 689                                       struct v4l2_subdev_format *source_fmt,
 690                                       struct v4l2_subdev_format *sink_fmt);
 691 int v4l2_subdev_link_validate(struct media_link *link);
 692 #endif /* CONFIG_MEDIA_CONTROLLER */
 693 void v4l2_subdev_init(struct v4l2_subdev *sd,
 694                       const struct v4l2_subdev_ops *ops);
 695
 696 /* Call an ops of a v4l2_subdev, doing the right checks against
 697    NULL pointers.
 698
 699    Example: err = v4l2_subdev_call(sd, video, s_std, norm);
 700  */
 701 #define v4l2_subdev_call(sd, o, f, args...)                             \
 702         (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
 703                 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
 704
 705 #define v4l2_subdev_has_op(sd, o, f) \
 706         ((sd)->ops->o && (sd)->ops->o->f)
 707
 708 void v4l2_subdev_notify_event(struct v4l2_subdev *sd,
 709                               const struct v4l2_event *ev);
 710
 711 #endif