include/media/v4l2-subdev.h

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