include/media/v4l2-subdev.h

   1 /*
   2     V4L2 sub-device support header.
   3
   4     Copyright (C) 2008  Hans Verkuil <hverkuil@xs4all.nl>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef _V4L2_SUBDEV_H
  22 #define _V4L2_SUBDEV_H
  23
  24 #include <media/v4l2-common.h>
  25
  26 /* generic v4l2_device notify callback notification values */
  27 #define V4L2_SUBDEV_IR_RX_NOTIFY                _IOW('v', 0, u32)
  28 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ      0x00000001
  29 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED    0x00000002
  30 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN       0x00000004
  31 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN       0x00000008
  32
  33 #define V4L2_SUBDEV_IR_TX_NOTIFY                _IOW('v', 1, u32)
  34 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ      0x00000001
  35
  36 struct v4l2_device;
  37 struct v4l2_subdev;
  38 struct tuner_setup;
  39
  40 /* decode_vbi_line */
  41 struct v4l2_decode_vbi_line {
  42         u32 is_second_field;    /* Set to 0 for the first (odd) field,
  43                                    set to 1 for the second (even) field. */
  44         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
  45                                    On exit points to the start of the payload. */
  46         u32 line;               /* Line number of the sliced VBI data (1-23) */
  47         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
  48 };
  49
  50 /* Sub-devices are devices that are connected somehow to the main bridge
  51    device. These devices are usually audio/video muxers/encoders/decoders or
  52    sensors and webcam controllers.
  53
  54    Usually these devices are controlled through an i2c bus, but other busses
  55    may also be used.
  56
  57    The v4l2_subdev struct provides a way of accessing these devices in a
  58    generic manner. Most operations that these sub-devices support fall in
  59    a few categories: core ops, audio ops, video ops and tuner ops.
  60
  61    More categories can be added if needed, although this should remain a
  62    limited set (no more than approx. 8 categories).
  63
  64    Each category has its own set of ops that subdev drivers can implement.
  65
  66    A subdev driver can leave the pointer to the category ops NULL if
  67    it does not implement them (e.g. an audio subdev will generally not
  68    implement the video category ops). The exception is the core category:
  69    this must always be present.
  70
  71    These ops are all used internally so it is no problem to change, remove
  72    or add ops or move ops from one to another category. Currently these
  73    ops are based on the original ioctls, but since ops are not limited to
  74    one argument there is room for improvement here once all i2c subdev
  75    drivers are converted to use these ops.
  76  */
  77
  78 /* Core ops: it is highly recommended to implement at least these ops:
  79
  80    g_chip_ident
  81    log_status
  82    g_register
  83    s_register
  84
  85    This provides basic debugging support.
  86
  87    The ioctl ops is meant for generic ioctl-like commands. Depending on
  88    the use-case it might be better to use subdev-specific ops (currently
  89    not yet implemented) since ops provide proper type-checking.
  90  */
  91
  92 /* s_config: if set, then it is always called by the v4l2_i2c_new_subdev*
  93         functions after the v4l2_subdev was registered. It is used to pass
  94         platform data to the subdev which can be used during initialization.
  95
  96    init: initialize the sensor registors to some sort of reasonable default
  97         values. Do not use for new drivers and should be removed in existing
  98         drivers.
  99
 100    load_fw: load firmware.
 101
 102    reset: generic reset command. The argument selects which subsystems to
 103         reset. Passing 0 will always reset the whole chip. Do not use for new
 104         drivers without discussing this first on the linux-media mailinglist.
 105         There should be no reason normally to reset a device.
 106
 107    s_gpio: set GPIO pins. Very simple right now, might need to be extended with
 108         a direction argument if needed.
 109  */
 110 struct v4l2_subdev_core_ops {
 111         int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
 112         int (*log_status)(struct v4l2_subdev *sd);
 113         int (*s_config)(struct v4l2_subdev *sd, int irq, void *platform_data);
 114         int (*init)(struct v4l2_subdev *sd, u32 val);
 115         int (*load_fw)(struct v4l2_subdev *sd);
 116         int (*reset)(struct v4l2_subdev *sd, u32 val);
 117         int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
 118         int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
 119         int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 120         int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 121         int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 122         int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 123         int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 124         int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
 125         int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
 126         long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
 127 #ifdef CONFIG_VIDEO_ADV_DEBUG
 128         int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
 129         int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
 130 #endif
 131 };
 132
 133 /* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
 134
 135    s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
 136
 137    s_type_addr: sets tuner type and its I2C addr.
 138
 139    s_config: sets tda9887 specific stuff, like port1, port2 and qss
 140
 141    s_standby: puts tuner on powersaving state, disabling it, except for i2c.
 142  */
 143 struct v4l2_subdev_tuner_ops {
 144         int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
 145         int (*s_radio)(struct v4l2_subdev *sd);
 146         int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 147         int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 148         int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 149         int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 150         int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
 151         int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
 152         int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
 153         int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
 154         int (*s_standby)(struct v4l2_subdev *sd);
 155 };
 156
 157 /* s_clock_freq: set the frequency (in Hz) of the audio clock output.
 158         Used to slave an audio processor to the video decoder, ensuring that
 159         audio and video remain synchronized. Usual values for the frequency
 160         are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
 161         -EINVAL is returned.
 162
 163    s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
 164         way to select I2S clock used by driving digital audio streams at some
 165         board designs. Usual values for the frequency are 1024000 and 2048000.
 166         If the frequency is not supported, then -EINVAL is returned.
 167
 168    s_routing: used to define the input and/or output pins of an audio chip,
 169         and any additional configuration data.
 170         Never attempt to use user-level input IDs (e.g. Composite, S-Video,
 171         Tuner) at this level. An i2c device shouldn't know about whether an
 172         input pin is connected to a Composite connector, become on another
 173         board or platform it might be connected to something else entirely.
 174         The calling driver is responsible for mapping a user-level input to
 175         the right pins on the i2c device.
 176  */
 177 struct v4l2_subdev_audio_ops {
 178         int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 179         int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 180         int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 181 };
 182
 183 /*
 184    decode_vbi_line: video decoders that support sliced VBI need to implement
 185         this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
 186         start of the VBI data that was generated by the decoder. The driver
 187         then parses the sliced VBI data and sets the other fields in the
 188         struct accordingly. The pointer p is updated to point to the start of
 189         the payload which can be copied verbatim into the data field of the
 190         v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
 191         type field is set to 0 on return.
 192
 193    s_vbi_data: used to generate VBI signals on a video signal.
 194         v4l2_sliced_vbi_data is filled with the data packets that should be
 195         output. Note that if you set the line field to 0, then that VBI signal
 196         is disabled. If no valid VBI data was found, then the type field is
 197         set to 0 on return.
 198
 199    g_vbi_data: used to obtain the sliced VBI packet from a readback register.
 200         Not all video decoders support this. If no data is available because
 201         the readback register contains invalid or erroneous data -EIO is
 202         returned. Note that you must fill in the 'id' member and the 'field'
 203         member (to determine whether CC data from the first or second field
 204         should be obtained).
 205
 206    s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
 207         video input devices.
 208
 209   s_crystal_freq: sets the frequency of the crystal used to generate the
 210         clocks in Hz. An extra flags field allows device specific configuration
 211         regarding clock frequency dividers, etc. If not used, then set flags
 212         to 0. If the frequency is not supported, then -EINVAL is returned.
 213
 214    g_input_status: get input status. Same as the status field in the v4l2_input
 215         struct.
 216
 217    s_routing: see s_routing in audio_ops, except this version is for video
 218         devices.
 219  */
 220 struct v4l2_subdev_video_ops {
 221         int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
 222         int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
 223         int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
 224         int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
 225         int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
 226         int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
 227         int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
 228         int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
 229         int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
 230         int (*s_stream)(struct v4l2_subdev *sd, int enable);
 231         int (*enum_fmt)(struct v4l2_subdev *sd, struct v4l2_fmtdesc *fmtdesc);
 232         int (*g_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
 233         int (*try_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
 234         int (*s_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
 235         int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
 236         int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
 237         int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
 238         int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 239         int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 240         int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
 241         int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
 242 };
 243
 244 /*
 245    interrupt_service_routine: Called by the bridge chip's interrupt service
 246         handler, when an IR interrupt status has be raised due to this subdev,
 247         so that this subdev can handle the details.  It may schedule work to be
 248         performed later.  It must not sleep.  *Called from an IRQ context*.
 249
 250    [rt]x_g_parameters: Get the current operating parameters and state of the
 251         the IR receiver or transmitter.
 252
 253    [rt]x_s_parameters: Set the current operating parameters and state of the
 254         the IR receiver or transmitter.  It is recommended to call
 255         [rt]x_g_parameters first to fill out the current state, and only change
 256         the fields that need to be changed.  Upon return, the actual device
 257         operating parameters and state will be returned.  Note that hardware
 258         limitations may prevent the actual settings from matching the requested
 259         settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
 260         was requested.  An exception is when the shutdown parameter is true.
 261         The last used operational parameters will be returned, but the actual
 262         state of the hardware be different to minimize power consumption and
 263         processing when shutdown is true.
 264
 265    rx_read: Reads received codes or pulse width data.
 266         The semantics are similar to a non-blocking read() call.
 267
 268    tx_write: Writes codes or pulse width data for transmission.
 269         The semantics are similar to a non-blocking write() call.
 270  */
 271
 272 enum v4l2_subdev_ir_mode {
 273         V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* space & mark widths in nanosecs */
 274 };
 275
 276 /* Data format of data read or written for V4L2_SUBDEV_IR_MODE_PULSE_WIDTH */
 277 #define V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS       0x7fffffff
 278 #define V4L2_SUBDEV_IR_PULSE_LEVEL_MASK         0x80000000
 279 #define V4L2_SUBDEV_IR_PULSE_RX_SEQ_END         0xffffffff
 280
 281 struct v4l2_subdev_ir_parameters {
 282         /* Either Rx or Tx */
 283         unsigned int bytes_per_data_element; /* of data in read or write call */
 284         enum v4l2_subdev_ir_mode mode;
 285
 286         bool enable;
 287         bool interrupt_enable;
 288         bool shutdown; /* true: set hardware to low/no power, false: normal */
 289
 290         bool modulation;           /* true: uses carrier, false: baseband */
 291         u32 max_pulse_width;       /* ns,      valid only for baseband signal */
 292         unsigned int carrier_freq; /* Hz,      valid only for modulated signal*/
 293         unsigned int duty_cycle;   /* percent, valid only for modulated signal*/
 294         bool invert;               /* logically invert sense of mark/space */
 295
 296         /* Rx only */
 297         u32 noise_filter_min_width;       /* ns, min time of a valid pulse */
 298         unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
 299         unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
 300         u32 resolution;                   /* ns */
 301 };
 302
 303 struct v4l2_subdev_ir_ops {
 304         /* Common to receiver and transmitter */
 305         int (*interrupt_service_routine)(struct v4l2_subdev *sd,
 306                                                 u32 status, bool *handled);
 307
 308         /* Receiver */
 309         int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 310                                 ssize_t *num);
 311
 312         int (*rx_g_parameters)(struct v4l2_subdev *sd,
 313                                 struct v4l2_subdev_ir_parameters *params);
 314         int (*rx_s_parameters)(struct v4l2_subdev *sd,
 315                                 struct v4l2_subdev_ir_parameters *params);
 316
 317         /* Transmitter */
 318         int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
 319                                 ssize_t *num);
 320
 321         int (*tx_g_parameters)(struct v4l2_subdev *sd,
 322                                 struct v4l2_subdev_ir_parameters *params);
 323         int (*tx_s_parameters)(struct v4l2_subdev *sd,
 324                                 struct v4l2_subdev_ir_parameters *params);
 325 };
 326
 327 struct v4l2_subdev_ops {
 328         const struct v4l2_subdev_core_ops  *core;
 329         const struct v4l2_subdev_tuner_ops *tuner;
 330         const struct v4l2_subdev_audio_ops *audio;
 331         const struct v4l2_subdev_video_ops *video;
 332         const struct v4l2_subdev_ir_ops    *ir;
 333 };
 334
 335 #define V4L2_SUBDEV_NAME_SIZE 32
 336
 337 /* Set this flag if this subdev is a i2c device. */
 338 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
 339
 340 /* Each instance of a subdev driver should create this struct, either
 341    stand-alone or embedded in a larger struct.
 342  */
 343 struct v4l2_subdev {
 344         struct list_head list;
 345         struct module *owner;
 346         u32 flags;
 347         struct v4l2_device *v4l2_dev;
 348         const struct v4l2_subdev_ops *ops;
 349         /* name must be unique */
 350         char name[V4L2_SUBDEV_NAME_SIZE];
 351         /* can be used to group similar subdevs, value is driver-specific */
 352         u32 grp_id;
 353         /* pointer to private data */
 354         void *priv;
 355 };
 356
 357 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
 358 {
 359         sd->priv = p;
 360 }
 361
 362 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
 363 {
 364         return sd->priv;
 365 }
 366
 367 static inline void v4l2_subdev_init(struct v4l2_subdev *sd,
 368                                         const struct v4l2_subdev_ops *ops)
 369 {
 370         INIT_LIST_HEAD(&sd->list);
 371         /* ops->core MUST be set */
 372         BUG_ON(!ops || !ops->core);
 373         sd->ops = ops;
 374         sd->v4l2_dev = NULL;
 375         sd->flags = 0;
 376         sd->name[0] = '\0';
 377         sd->grp_id = 0;
 378         sd->priv = NULL;
 379 }
 380
 381 /* Call an ops of a v4l2_subdev, doing the right checks against
 382    NULL pointers.
 383
 384    Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
 385  */
 386 #define v4l2_subdev_call(sd, o, f, args...)                             \
 387         (!(sd) ? -ENODEV : (((sd) && (sd)->ops->o && (sd)->ops->o->f) ? \
 388                 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
 389
 390 /* Send a notification to v4l2_device. */
 391 #define v4l2_subdev_notify(sd, notification, arg)                          \
 392         ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
 393          (sd)->v4l2_dev->notify((sd), (notification), (arg)))
 394
 395 #endif