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