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