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 struct v4l2_device;
  27 struct v4l2_subdev;
  28 struct tuner_setup;
  29
  30 /* decode_vbi_line */
  31 struct v4l2_decode_vbi_line {
  32         u32 is_second_field;    /* Set to 0 for the first (odd) field,
  33                                    set to 1 for the second (even) field. */
  34         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
  35                                    On exit points to the start of the payload. */
  36         u32 line;               /* Line number of the sliced VBI data (1-23) */
  37         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
  38 };
  39
  40 /* s_crystal_freq */
  41 struct v4l2_crystal_freq {
  42         u32 freq;       /* frequency in Hz of the crystal */
  43         u32 flags;      /* device specific flags */
  44 };
  45
  46 /* Sub-devices are devices that are connected somehow to the main bridge
  47    device. These devices are usually audio/video muxers/encoders/decoders or
  48    sensors and webcam controllers.
  49
  50    Usually these devices are controlled through an i2c bus, but other busses
  51    may also be used.
  52
  53    The v4l2_subdev struct provides a way of accessing these devices in a
  54    generic manner. Most operations that these sub-devices support fall in
  55    a few categories: core ops, audio ops, video ops and tuner ops.
  56
  57    More categories can be added if needed, although this should remain a
  58    limited set (no more than approx. 8 categories).
  59
  60    Each category has its own set of ops that subdev drivers can implement.
  61
  62    A subdev driver can leave the pointer to the category ops NULL if
  63    it does not implement them (e.g. an audio subdev will generally not
  64    implement the video category ops). The exception is the core category:
  65    this must always be present.
  66
  67    These ops are all used internally so it is no problem to change, remove
  68    or add ops or move ops from one to another category. Currently these
  69    ops are based on the original ioctls, but since ops are not limited to
  70    one argument there is room for improvement here once all i2c subdev
  71    drivers are converted to use these ops.
  72  */
  73
  74 /* Core ops: it is highly recommended to implement at least these ops:
  75
  76    g_chip_ident
  77    log_status
  78    g_register
  79    s_register
  80
  81    This provides basic debugging support.
  82
  83    The ioctl ops is meant for generic ioctl-like commands. Depending on
  84    the use-case it might be better to use subdev-specific ops (currently
  85    not yet implemented) since ops provide proper type-checking.
  86  */
  87
  88 /* init: initialize the sensor registors to some sort of reasonable default
  89         values. Do not use for new drivers and should be removed in existing
  90         drivers.
  91
  92    load_fw: load firmware.
  93
  94    reset: generic reset command. The argument selects which subsystems to
  95         reset. Passing 0 will always reset the whole chip. Do not use for new
  96         drivers without discussing this first on the linux-media mailinglist.
  97         There should be no reason normally to reset a device.
  98
  99    s_gpio: set GPIO pins. Very simple right now, might need to be extended with
 100         a direction argument if needed.
 101  */
 102 struct v4l2_subdev_core_ops {
 103         int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
 104         int (*log_status)(struct v4l2_subdev *sd);
 105         int (*init)(struct v4l2_subdev *sd, u32 val);
 106         int (*load_fw)(struct v4l2_subdev *sd);
 107         int (*reset)(struct v4l2_subdev *sd, u32 val);
 108         int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
 109         int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
 110         int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 111         int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 112         int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 113         int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 114         int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
 115         int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
 116         int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
 117         long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
 118 #ifdef CONFIG_VIDEO_ADV_DEBUG
 119         int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
 120         int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
 121 #endif
 122 };
 123
 124 /* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
 125
 126    s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
 127
 128    s_type_addr: sets tuner type and its I2C addr.
 129
 130    s_config: sets tda9887 specific stuff, like port1, port2 and qss
 131
 132    s_standby: puts tuner on powersaving state, disabling it, except for i2c.
 133  */
 134 struct v4l2_subdev_tuner_ops {
 135         int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
 136         int (*s_radio)(struct v4l2_subdev *sd);
 137         int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 138         int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
 139         int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 140         int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
 141         int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
 142         int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
 143         int (*s_standby)(struct v4l2_subdev *sd);
 144 };
 145
 146 /* s_clock_freq: set the frequency (in Hz) of the audio clock output.
 147         Used to slave an audio processor to the video decoder, ensuring that
 148         audio and video remain synchronized. Usual values for the frequency
 149         are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
 150         -EINVAL is returned.
 151
 152    s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
 153         way to select I2S clock used by driving digital audio streams at some
 154         board designs. Usual values for the frequency are 1024000 and 2048000.
 155         If the frequency is not supported, then -EINVAL is returned.
 156
 157    s_routing: used to define the input and/or output pins of an audio chip.
 158         Never attempt to use user-level input IDs (e.g. Composite, S-Video,
 159         Tuner) at this level. An i2c device shouldn't know about whether an
 160         input pin is connected to a Composite connector, become on another
 161         board or platform it might be connected to something else entirely.
 162         The calling driver is responsible for mapping a user-level input to
 163         the right pins on the i2c device.
 164  */
 165 struct v4l2_subdev_audio_ops {
 166         int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 167         int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
 168         int (*s_routing)(struct v4l2_subdev *sd, const struct v4l2_routing *route);
 169 };
 170
 171 /*
 172    decode_vbi_line: video decoders that support sliced VBI need to implement
 173         this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
 174         start of the VBI data that was generated by the decoder. The driver
 175         then parses the sliced VBI data and sets the other fields in the
 176         struct accordingly. The pointer p is updated to point to the start of
 177         the payload which can be copied verbatim into the data field of the
 178         v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
 179         type field is set to 0 on return.
 180
 181    s_vbi_data: used to generate VBI signals on a video signal.
 182         v4l2_sliced_vbi_data is filled with the data packets that should be
 183         output. Note that if you set the line field to 0, then that VBI signal
 184         is disabled. If no valid VBI data was found, then the type field is
 185         set to 0 on return.
 186
 187    g_vbi_data: used to obtain the sliced VBI packet from a readback register.
 188         Not all video decoders support this. If no data is available because
 189         the readback register contains invalid or erroneous data -EIO is
 190         returned. Note that you must fill in the 'id' member and the 'field'
 191         member (to determine whether CC data from the first or second field
 192         should be obtained).
 193
 194    s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
 195         video input devices.
 196
 197    s_crystal_freq: sets the frequency of the crystal used to generate the
 198         clocks. An extra flags field allows device specific configuration
 199         regarding clock frequency dividers, etc. If not used, then set flags
 200         to 0. If the frequency is not supported, then -EINVAL is returned.
 201
 202    g_input_status: get input status. Same as the status field in the v4l2_input
 203         struct.
 204
 205    s_routing: see s_routing in audio_ops, except this version is for video
 206         devices.
 207  */
 208 struct v4l2_subdev_video_ops {
 209         int (*s_routing)(struct v4l2_subdev *sd, const struct v4l2_routing *route);
 210         int (*s_crystal_freq)(struct v4l2_subdev *sd, struct v4l2_crystal_freq *freq);
 211         int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
 212         int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
 213         int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
 214         int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
 215         int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
 216         int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
 217         int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
 218         int (*s_stream)(struct v4l2_subdev *sd, int enable);
 219         int (*enum_fmt)(struct v4l2_subdev *sd, struct v4l2_fmtdesc *fmtdesc);
 220         int (*g_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
 221         int (*try_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
 222         int (*s_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
 223         int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 224         int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
 225         int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
 226         int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
 227 };
 228
 229 struct v4l2_subdev_ops {
 230         const struct v4l2_subdev_core_ops  *core;
 231         const struct v4l2_subdev_tuner_ops *tuner;
 232         const struct v4l2_subdev_audio_ops *audio;
 233         const struct v4l2_subdev_video_ops *video;
 234 };
 235
 236 #define V4L2_SUBDEV_NAME_SIZE 32
 237
 238 /* Each instance of a subdev driver should create this struct, either
 239    stand-alone or embedded in a larger struct.
 240  */
 241 struct v4l2_subdev {
 242         struct list_head list;
 243         struct module *owner;
 244         struct v4l2_device *v4l2_dev;
 245         const struct v4l2_subdev_ops *ops;
 246         /* name must be unique */
 247         char name[V4L2_SUBDEV_NAME_SIZE];
 248         /* can be used to group similar subdevs, value is driver-specific */
 249         u32 grp_id;
 250         /* pointer to private data */
 251         void *priv;
 252 };
 253
 254 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
 255 {
 256         sd->priv = p;
 257 }
 258
 259 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
 260 {
 261         return sd->priv;
 262 }
 263
 264 static inline void v4l2_subdev_init(struct v4l2_subdev *sd,
 265                                         const struct v4l2_subdev_ops *ops)
 266 {
 267         INIT_LIST_HEAD(&sd->list);
 268         /* ops->core MUST be set */
 269         BUG_ON(!ops || !ops->core);
 270         sd->ops = ops;
 271         sd->v4l2_dev = NULL;
 272         sd->name[0] = '\0';
 273         sd->grp_id = 0;
 274         sd->priv = NULL;
 275 }
 276
 277 /* Call an ops of a v4l2_subdev, doing the right checks against
 278    NULL pointers.
 279
 280    Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
 281  */
 282 #define v4l2_subdev_call(sd, o, f, args...)                             \
 283         (!(sd) ? -ENODEV : (((sd) && (sd)->ops->o && (sd)->ops->o->f) ? \
 284                 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
 285
 286 /* Send a notification to v4l2_device. */
 287 #define v4l2_subdev_notify(sd, notification, arg)                          \
 288         ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
 289          (sd)->v4l2_dev->notify((sd), (notification), (arg)))
 290
 291 #endif