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/v4l2-subdev.h>
  25 #include <media/media-entity.h>
  26 #include <media/v4l2-common.h>
  27 #include <media/v4l2-dev.h>
  28 #include <media/v4l2-fh.h>
  29 #include <media/v4l2-mediabus.h>
  30
  31 /* generic v4l2_device notify callback notification values */
  32 #define V4L2_SUBDEV_IR_RX_NOTIFY                _IOW('v', 0, u32)
  33 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ      0x00000001
  34 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED    0x00000002
  35 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN       0x00000004
  36 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN       0x00000008
  37
  38 #define V4L2_SUBDEV_IR_TX_NOTIFY                _IOW('v', 1, u32)
  39 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ      0x00000001
  40
  41 struct v4l2_device;
  42 struct v4l2_ctrl_handler;
  43 struct v4l2_event_subscription;
  44 struct v4l2_fh;
  45 struct v4l2_subdev;
  46 struct v4l2_subdev_fh;
  47 struct tuner_setup;
  48
  49 /* decode_vbi_line */
  50 struct v4l2_decode_vbi_line {
  51         u32 is_second_field;    /* Set to 0 for the first (odd) field,
  52                                    set to 1 for the second (even) field. */
  53         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
  54                                    On exit points to the start of the payload. */
  55         u32 line;               /* Line number of the sliced VBI data (1-23) */
  56         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
  57 };
  58
  59 /* Sub-devices are devices that are connected somehow to the main bridge
  60    device. These devices are usually audio/video muxers/encoders/decoders or
  61    sensors and webcam controllers.
  62
  63    Usually these devices are controlled through an i2c bus, but other busses
  64    may also be used.
  65
  66    The v4l2_subdev struct provides a way of accessing these devices in a
  67    generic manner. Most operations that these sub-devices support fall in
  68    a few categories: core ops, audio ops, video ops and tuner ops.
  69
  70    More categories can be added if needed, although this should remain a
  71    limited set (no more than approx. 8 categories).
  72
  73    Each category has its own set of ops that subdev drivers can implement.
  74
  75    A subdev driver can leave the pointer to the category ops NULL if
  76    it does not implement them (e.g. an audio subdev will generally not
  77    implement the video category ops). The exception is the core category:
  78    this must always be present.
  79
  80    These ops are all used internally so it is no problem to change, remove
  81    or add ops or move ops from one to another category. Currently these
  82    ops are based on the original ioctls, but since ops are not limited to
  83    one argument there is room for improvement here once all i2c subdev
  84    drivers are converted to use these ops.
  85  */
  86
  87 /* Core ops: it is highly recommended to implement at least these ops:
  88
  89    g_chip_ident
  90    log_status
  91    g_register
  92    s_register
  93
  94    This provides basic debugging support.
  95
  96    The ioctl ops is meant for generic ioctl-like commands. Depending on
  97    the use-case it might be better to use subdev-specific ops (currently
  98    not yet implemented) since ops provide proper type-checking.
  99  */
 100
 101 /* Subdevice external IO pin configuration */
 102 #define V4L2_SUBDEV_IO_PIN_DISABLE      (1 << 0) /* ENABLE assumed */
 103 #define V4L2_SUBDEV_IO_PIN_OUTPUT       (1 << 1)
 104 #define V4L2_SUBDEV_IO_PIN_INPUT        (1 << 2)
 105 #define V4L2_SUBDEV_IO_PIN_SET_VALUE    (1 << 3) /* Set output value */
 106 #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW   (1 << 4) /* ACTIVE HIGH assumed */
 107
 108 struct v4l2_subdev_io_pin_config {
 109         u32 flags;      /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */
 110         u8 pin;         /* Chip external IO pin to configure */
 111         u8 function;    /* Internal signal pad/function to route to IO pin */
 112         u8 value;       /* Initial value for pin - e.g. GPIO output value */
 113         u8 strength;    /* Pin drive strength */
 114 };
 115
 116 /*
 117    s_io_pin_config: configure one or more chip I/O pins for chips that
 118         multiplex different internal signal pads out to IO pins.  This function
 119         takes a pointer to an array of 'n' pin configuration entries, one for
 120         each pin being configured.  This function could be called at times
 121         other than just subdevice initialization.
 122
 123    init: initialize the sensor registors to some sort of reasonable default
 124         values. Do not use for new drivers and should be removed in existing
 125         drivers.
 126
 127    load_fw: load firmware.
 128
 129    reset: generic reset command. The argument selects which subsystems to
 130         reset. Passing 0 will always reset the whole chip. Do not use for new
 131         drivers without discussing this first on the linux-media mailinglist.
 132         There should be no reason normally to reset a device.
 133
 134    s_gpio: set GPIO pins. Very simple right now, might need to be extended with
 135         a direction argument if needed.
 136
 137    s_power: puts subdevice in power saving mode (on == 0) or normal operation
 138         mode (on == 1).
 139
 140    interrupt_service_routine: Called by the bridge chip's interrupt service
 141         handler, when an interrupt status has be raised due to this subdev,
 142         so that this subdev can handle the details.  It may schedule work to be
 143         performed later.  It must not sleep.  *Called from an IRQ context*.
 144  */
 145 struct v4l2_subdev_core_ops {
 146         int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
 147         int (*log_status)(struct v4l2_subdev *sd);
 148         int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
 149                                       struct v4l2_subdev_io_pin_config *pincfg);
 150         int (*init)(struct v4l2_subdev *sd, u32 val);
 151         int (*load_fw)(struct v4l2_subdev *sd);
 152         int (*reset)(struct v4l2_subdev *sd, u32 val);
 153         int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
 154         int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
 155         int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 156         int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 157         int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 158         int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 159         int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 160         int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
 161         int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);
 162         int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
 163         long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
 164 #ifdef CONFIG_VIDEO_ADV_DEBUG
 165         int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
 166         int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
 167 #endif
 168         int (*s_power)(struct v4l2_subdev *sd, int on);
 169         int (*interrupt_service_routine)(struct v4l2_subdev *sd,
 170                                                 u32 status, bool *handled);
 171         int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
 172                                struct v4l2_event_subscription *sub);
 173         int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
 174                                  struct v4l2_event_subscription *sub);
 175 };
 176
 177 /* s_radio: v4l device was opened in radio mode.
 178
 179    g_frequency: freq->type must be filled in. Normally done by video_ioctl2
 180         or the bridge driver.
 181
 182    g_tuner:
 183    s_tuner: vt->type must be filled in. Normally done by video_ioctl2 or the
 184         bridge driver.
 185
 186    s_type_addr: sets tuner type and its I2C addr.
 187
 188    s_config: sets tda9887 specific stuff, like port1, port2 and qss
 189  */
 190 struct v4l2_subdev_tuner_ops {
 191         int (*s_radio)(struct v4l2_subdev *sd);
 192         int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 193         int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 194         int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 195         int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 196         int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
 197         int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
 198         int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
 199         int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
 200 };
 201
 202 /* s_clock_freq: set the frequency (in Hz) of the audio clock output.
 203         Used to slave an audio processor to the video decoder, ensuring that
 204         audio and video remain synchronized. Usual values for the frequency
 205         are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
 206         -EINVAL is returned.
 207
 208    s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
 209         way to select I2S clock used by driving digital audio streams at some
 210         board designs. Usual values for the frequency are 1024000 and 2048000.
 211         If the frequency is not supported, then -EINVAL is returned.
 212
 213    s_routing: used to define the input and/or output pins of an audio chip,
 214         and any additional configuration data.
 215         Never attempt to use user-level input IDs (e.g. Composite, S-Video,
 216         Tuner) at this level. An i2c device shouldn't know about whether an
 217         input pin is connected to a Composite connector, become on another
 218         board or platform it might be connected to something else entirely.
 219         The calling driver is responsible for mapping a user-level input to
 220         the right pins on the i2c device.
 221  */
 222 struct v4l2_subdev_audio_ops {
 223         int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 224         int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 225         int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 226         int (*s_stream)(struct v4l2_subdev *sd, int enable);
 227 };
 228
 229 /*
 230    s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
 231         video input devices.
 232
 233    g_std_output: get current standard for video OUTPUT devices. This is ignored
 234         by video input devices.
 235
 236    g_tvnorms_output: get v4l2_std_id with all standards supported by video
 237         OUTPUT device. This is ignored by video input devices.
 238
 239    s_crystal_freq: sets the frequency of the crystal used to generate the
 240         clocks in Hz. An extra flags field allows device specific configuration
 241         regarding clock frequency dividers, etc. If not used, then set flags
 242         to 0. If the frequency is not supported, then -EINVAL is returned.
 243
 244    g_input_status: get input status. Same as the status field in the v4l2_input
 245         struct.
 246
 247    s_routing: see s_routing in audio_ops, except this version is for video
 248         devices.
 249
 250    s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
 251         s_std()
 252
 253    g_dv_preset: get current dv (Digital Video) preset in the sub device.
 254
 255    query_dv_preset: query dv preset in the sub device. This is similar to
 256         querystd()
 257
 258    s_dv_timings(): Set custom dv timings in the sub device. This is used
 259         when sub device is capable of setting detailed timing information
 260         in the hardware to generate/detect the video signal.
 261
 262    g_dv_timings(): Get custom dv timings in the sub device.
 263
 264    enum_mbus_fmt: enumerate pixel formats, provided by a video data source
 265
 266    g_mbus_fmt: get the current pixel format, provided by a video data source
 267
 268    try_mbus_fmt: try to set a pixel format on a video data source
 269
 270    s_mbus_fmt: set a pixel format on a video data source
 271
 272    g_mbus_config: get supported mediabus configurations
 273
 274    s_mbus_config: set a certain mediabus configuration. This operation is added
 275         for compatibility with soc-camera drivers and should not be used by new
 276         software.
 277  */
 278 struct v4l2_subdev_video_ops {
 279         int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 280         int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
 281         int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
 282         int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
 283         int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
 284         int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);
 285         int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
 286         int (*s_stream)(struct v4l2_subdev *sd, int enable);
 287         int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
 288         int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
 289         int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
 290         int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 291         int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 292         int (*g_frame_interval)(struct v4l2_subdev *sd,
 293                                 struct v4l2_subdev_frame_interval *interval);
 294         int (*s_frame_interval)(struct v4l2_subdev *sd,
 295                                 struct v4l2_subdev_frame_interval *interval);
 296         int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
 297         int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
 298         int (*enum_dv_presets) (struct v4l2_subdev *sd,
 299                         struct v4l2_dv_enum_preset *preset);
 300         int (*s_dv_preset)(struct v4l2_subdev *sd,
 301                         struct v4l2_dv_preset *preset);
 302         int (*g_dv_preset)(struct v4l2_subdev *sd,
 303                         struct v4l2_dv_preset *preset);
 304         int (*query_dv_preset)(struct v4l2_subdev *sd,
 305                         struct v4l2_dv_preset *preset);
 306         int (*s_dv_timings)(struct v4l2_subdev *sd,
 307                         struct v4l2_dv_timings *timings);
 308         int (*g_dv_timings)(struct v4l2_subdev *sd,
 309                         struct v4l2_dv_timings *timings);
 310         int (*enum_dv_timings)(struct v4l2_subdev *sd,
 311                         struct v4l2_enum_dv_timings *timings);
 312         int (*query_dv_timings)(struct v4l2_subdev *sd,
 313                         struct v4l2_dv_timings *timings);
 314         int (*dv_timings_cap)(struct v4l2_subdev *sd,
 315                         struct v4l2_dv_timings_cap *cap);
 316         int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index,
 317                              enum v4l2_mbus_pixelcode *code);
 318         int (*enum_mbus_fsizes)(struct v4l2_subdev *sd,
 319                              struct v4l2_frmsizeenum *fsize);
 320         int (*g_mbus_fmt)(struct v4l2_subdev *sd,
 321                           struct v4l2_mbus_framefmt *fmt);
 322         int (*try_mbus_fmt)(struct v4l2_subdev *sd,
 323                             struct v4l2_mbus_framefmt *fmt);
 324         int (*s_mbus_fmt)(struct v4l2_subdev *sd,
 325                           struct v4l2_mbus_framefmt *fmt);
 326         int (*g_mbus_config)(struct v4l2_subdev *sd,
 327                              struct v4l2_mbus_config *cfg);
 328         int (*s_mbus_config)(struct v4l2_subdev *sd,
 329                              const struct v4l2_mbus_config *cfg);
 330 };
 331
 332 /*
 333    decode_vbi_line: video decoders that support sliced VBI need to implement
 334         this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
 335         start of the VBI data that was generated by the decoder. The driver
 336         then parses the sliced VBI data and sets the other fields in the
 337         struct accordingly. The pointer p is updated to point to the start of
 338         the payload which can be copied verbatim into the data field of the
 339         v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
 340         type field is set to 0 on return.
 341
 342    s_vbi_data: used to generate VBI signals on a video signal.
 343         v4l2_sliced_vbi_data is filled with the data packets that should be
 344         output. Note that if you set the line field to 0, then that VBI signal
 345         is disabled. If no valid VBI data was found, then the type field is
 346         set to 0 on return.
 347
 348    g_vbi_data: used to obtain the sliced VBI packet from a readback register.
 349         Not all video decoders support this. If no data is available because
 350         the readback register contains invalid or erroneous data -EIO is
 351         returned. Note that you must fill in the 'id' member and the 'field'
 352         member (to determine whether CC data from the first or second field
 353         should be obtained).
 354
 355    s_raw_fmt: setup the video encoder/decoder for raw VBI.
 356
 357    g_sliced_fmt: retrieve the current sliced VBI settings.
 358
 359    s_sliced_fmt: setup the sliced VBI settings.
 360  */
 361 struct v4l2_subdev_vbi_ops {
 362         int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
 363         int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
 364         int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
 365         int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
 366         int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
 367         int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
 368         int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
 369 };
 370
 371 /**
 372  * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
 373  * @g_skip_top_lines: number of lines at the top of the image to be skipped.
 374  *                    This is needed for some sensors, which always corrupt
 375  *                    several top lines of the output image, or which send their
 376  *                    metadata in them.
 377  * @g_skip_frames: number of frames to skip at stream start. This is needed for
 378  *                 buggy sensors that generate faulty frames when they are
 379  *                 turned on.
 380  */
 381 struct v4l2_subdev_sensor_ops {
 382         int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
 383         int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
 384 };
 385
 386 /*
 387    [rt]x_g_parameters: Get the current operating parameters and state of the
 388         the IR receiver or transmitter.
 389
 390    [rt]x_s_parameters: Set the current operating parameters and state of the
 391         the IR receiver or transmitter.  It is recommended to call
 392         [rt]x_g_parameters first to fill out the current state, and only change
 393         the fields that need to be changed.  Upon return, the actual device
 394         operating parameters and state will be returned.  Note that hardware
 395         limitations may prevent the actual settings from matching the requested
 396         settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
 397         was requested.  An exception is when the shutdown parameter is true.
 398         The last used operational parameters will be returned, but the actual
 399         state of the hardware be different to minimize power consumption and
 400         processing when shutdown is true.
 401
 402    rx_read: Reads received codes or pulse width data.
 403         The semantics are similar to a non-blocking read() call.
 404
 405    tx_write: Writes codes or pulse width data for transmission.
 406         The semantics are similar to a non-blocking write() call.
 407  */
 408
 409 enum v4l2_subdev_ir_mode {
 410         V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
 411 };
 412
 413 struct v4l2_subdev_ir_parameters {
 414         /* Either Rx or Tx */
 415         unsigned int bytes_per_data_element; /* of data in read or write call */
 416         enum v4l2_subdev_ir_mode mode;
 417
 418         bool enable;
 419         bool interrupt_enable;
 420         bool shutdown; /* true: set hardware to low/no power, false: normal */
 421
 422         bool modulation;           /* true: uses carrier, false: baseband */
 423         u32 max_pulse_width;       /* ns,      valid only for baseband signal */
 424         unsigned int carrier_freq; /* Hz,      valid only for modulated signal*/
 425         unsigned int duty_cycle;   /* percent, valid only for modulated signal*/
 426         bool invert_level;         /* invert signal level */
 427
 428         /* Tx only */
 429         bool invert_carrier_sense; /* Send 0/space as a carrier burst */
 430
 431         /* Rx only */
 432         u32 noise_filter_min_width;       /* ns, min time of a valid pulse */
 433         unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
 434         unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
 435         u32 resolution;                   /* ns */
 436 };
 437
 438 struct v4l2_subdev_ir_ops {
 439         /* Receiver */
 440         int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 441                                 ssize_t *num);
 442
 443         int (*rx_g_parameters)(struct v4l2_subdev *sd,
 444                                 struct v4l2_subdev_ir_parameters *params);
 445         int (*rx_s_parameters)(struct v4l2_subdev *sd,
 446                                 struct v4l2_subdev_ir_parameters *params);
 447
 448         /* Transmitter */
 449         int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 450                                 ssize_t *num);
 451
 452         int (*tx_g_parameters)(struct v4l2_subdev *sd,
 453                                 struct v4l2_subdev_ir_parameters *params);
 454         int (*tx_s_parameters)(struct v4l2_subdev *sd,
 455                                 struct v4l2_subdev_ir_parameters *params);
 456 };
 457
 458 struct v4l2_subdev_pad_ops {
 459         int (*enum_mbus_code)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
 460                               struct v4l2_subdev_mbus_code_enum *code);
 461         int (*enum_frame_size)(struct v4l2_subdev *sd,
 462                                struct v4l2_subdev_fh *fh,
 463                                struct v4l2_subdev_frame_size_enum *fse);
 464         int (*enum_frame_interval)(struct v4l2_subdev *sd,
 465                                    struct v4l2_subdev_fh *fh,
 466                                    struct v4l2_subdev_frame_interval_enum *fie);
 467         int (*get_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
 468                        struct v4l2_subdev_format *format);
 469         int (*set_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
 470                        struct v4l2_subdev_format *format);
 471         int (*set_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
 472                        struct v4l2_subdev_crop *crop);
 473         int (*get_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
 474                        struct v4l2_subdev_crop *crop);
 475         int (*get_selection)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
 476                              struct v4l2_subdev_selection *sel);
 477         int (*set_selection)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
 478                              struct v4l2_subdev_selection *sel);
 479 #ifdef CONFIG_MEDIA_CONTROLLER
 480         int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link,
 481                              struct v4l2_subdev_format *source_fmt,
 482                              struct v4l2_subdev_format *sink_fmt);
 483 #endif /* CONFIG_MEDIA_CONTROLLER */
 484 };
 485
 486 struct v4l2_subdev_ops {
 487         const struct v4l2_subdev_core_ops       *core;
 488         const struct v4l2_subdev_tuner_ops      *tuner;
 489         const struct v4l2_subdev_audio_ops      *audio;
 490         const struct v4l2_subdev_video_ops      *video;
 491         const struct v4l2_subdev_vbi_ops        *vbi;
 492         const struct v4l2_subdev_ir_ops         *ir;
 493         const struct v4l2_subdev_sensor_ops     *sensor;
 494         const struct v4l2_subdev_pad_ops        *pad;
 495 };
 496
 497 /*
 498  * Internal ops. Never call this from drivers, only the v4l2 framework can call
 499  * these ops.
 500  *
 501  * registered: called when this subdev is registered. When called the v4l2_dev
 502  *      field is set to the correct v4l2_device.
 503  *
 504  * unregistered: called when this subdev is unregistered. When called the
 505  *      v4l2_dev field is still set to the correct v4l2_device.
 506  *
 507  * open: called when the subdev device node is opened by an application.
 508  *
 509  * close: called when the subdev device node is closed.
 510  */
 511 struct v4l2_subdev_internal_ops {
 512         int (*registered)(struct v4l2_subdev *sd);
 513         void (*unregistered)(struct v4l2_subdev *sd);
 514         int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
 515         int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
 516 };
 517
 518 #define V4L2_SUBDEV_NAME_SIZE 32
 519
 520 /* Set this flag if this subdev is a i2c device. */
 521 #define V4L2_SUBDEV_FL_IS_I2C                   (1U << 0)
 522 /* Set this flag if this subdev is a spi device. */
 523 #define V4L2_SUBDEV_FL_IS_SPI                   (1U << 1)
 524 /* Set this flag if this subdev needs a device node. */
 525 #define V4L2_SUBDEV_FL_HAS_DEVNODE              (1U << 2)
 526 /* Set this flag if this subdev generates events. */
 527 #define V4L2_SUBDEV_FL_HAS_EVENTS               (1U << 3)
 528
 529 /* Each instance of a subdev driver should create this struct, either
 530    stand-alone or embedded in a larger struct.
 531  */
 532 struct v4l2_subdev {
 533 #if defined(CONFIG_MEDIA_CONTROLLER)
 534         struct media_entity entity;
 535 #endif
 536         struct list_head list;
 537         struct module *owner;
 538         u32 flags;
 539         struct v4l2_device *v4l2_dev;
 540         const struct v4l2_subdev_ops *ops;
 541         /* Never call these internal ops from within a driver! */
 542         const struct v4l2_subdev_internal_ops *internal_ops;
 543         /* The control handler of this subdev. May be NULL. */
 544         struct v4l2_ctrl_handler *ctrl_handler;
 545         /* name must be unique */
 546         char name[V4L2_SUBDEV_NAME_SIZE];
 547         /* can be used to group similar subdevs, value is driver-specific */
 548         u32 grp_id;
 549         /* pointer to private data */
 550         void *dev_priv;
 551         void *host_priv;
 552         /* subdev device node */
 553         struct video_device *devnode;
 554 };
 555
 556 #define media_entity_to_v4l2_subdev(ent) \
 557         container_of(ent, struct v4l2_subdev, entity)
 558 #define vdev_to_v4l2_subdev(vdev) \
 559         ((struct v4l2_subdev *)video_get_drvdata(vdev))
 560
 561 /*
 562  * Used for storing subdev information per file handle
 563  */
 564 struct v4l2_subdev_fh {
 565         struct v4l2_fh vfh;
 566 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
 567         struct {
 568                 struct v4l2_mbus_framefmt try_fmt;
 569                 struct v4l2_rect try_crop;
 570                 struct v4l2_rect try_compose;
 571         } *pad;
 572 #endif
 573 };
 574
 575 #define to_v4l2_subdev_fh(fh)   \
 576         container_of(fh, struct v4l2_subdev_fh, vfh)
 577
 578 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
 579 #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name)           \
 580         static inline struct rtype *                                    \
 581         v4l2_subdev_get_try_##fun_name(struct v4l2_subdev_fh *fh,       \
 582                                        unsigned int pad)                \
 583         {                                                               \
 584                 BUG_ON(unlikely(pad >= vdev_to_v4l2_subdev(             \
 585                                         fh->vfh.vdev)->entity.num_pads)); \
 586                 return &fh->pad[pad].field_name;                        \
 587         }
 588
 589 __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, format, try_fmt)
 590 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, crop, try_compose)
 591 __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, compose, try_compose)
 592 #endif
 593
 594 extern const struct v4l2_file_operations v4l2_subdev_fops;
 595
 596 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
 597 {
 598         sd->dev_priv = p;
 599 }
 600
 601 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
 602 {
 603         return sd->dev_priv;
 604 }
 605
 606 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
 607 {
 608         sd->host_priv = p;
 609 }
 610
 611 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
 612 {
 613         return sd->host_priv;
 614 }
 615
 616 #ifdef CONFIG_MEDIA_CONTROLLER
 617 int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd,
 618                                       struct media_link *link,
 619                                       struct v4l2_subdev_format *source_fmt,
 620                                       struct v4l2_subdev_format *sink_fmt);
 621 int v4l2_subdev_link_validate(struct media_link *link);
 622 #endif /* CONFIG_MEDIA_CONTROLLER */
 623 void v4l2_subdev_init(struct v4l2_subdev *sd,
 624                       const struct v4l2_subdev_ops *ops);
 625
 626 /* Call an ops of a v4l2_subdev, doing the right checks against
 627    NULL pointers.
 628
 629    Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
 630  */
 631 #define v4l2_subdev_call(sd, o, f, args...)                             \
 632         (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
 633                 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
 634
 635 /* Send a notification to v4l2_device. */
 636 #define v4l2_subdev_notify(sd, notification, arg)                          \
 637         ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
 638          (sd)->v4l2_dev->notify((sd), (notification), (arg)))
 639
 640 #endif