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