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