SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/media/v4l2-common.h

   1 /*
   2     v4l2 common internal API header
   3
   4     This header contains internal shared ioctl definitions for use by the
   5     internal low-level v4l2 drivers.
   6     Each ioctl begins with VIDIOC_INT_ to clearly mark that it is an internal
   7     define,
   8
   9     Copyright (C) 2005  Hans Verkuil <hverkuil@xs4all.nl>
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (at your option) any later version.
  15
  16     This program is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19     GNU General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with this program; if not, write to the Free Software
  23     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26 #ifndef V4L2_COMMON_H_
  27 #define V4L2_COMMON_H_
  28
  29 #include <media/v4l2-dev.h>
  30
  31 /* Common printk constucts for v4l-i2c drivers. These macros create a unique
  32    prefix consisting of the driver name, the adapter number and the i2c
  33    address. */
  34 #define v4l_printk(level, name, adapter, addr, fmt, arg...) \
  35         printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
  36
  37 #define v4l_client_printk(level, client, fmt, arg...)                       \
  38         v4l_printk(level, (client)->driver->driver.name, (client)->adapter, \
  39                    (client)->addr, fmt , ## arg)
  40
  41 #define v4l_err(client, fmt, arg...) \
  42         v4l_client_printk(KERN_ERR, client, fmt , ## arg)
  43
  44 #define v4l_warn(client, fmt, arg...) \
  45         v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
  46
  47 #define v4l_info(client, fmt, arg...) \
  48         v4l_client_printk(KERN_INFO, client, fmt , ## arg)
  49
  50 /* These three macros assume that the debug level is set with a module
  51    parameter called 'debug'. */
  52 #define v4l_dbg(level, debug, client, fmt, arg...)                           \
  53         do {                                                                 \
  54                 if (debug >= (level))                                        \
  55                         v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
  56         } while (0)
  57
  58 /* ------------------------------------------------------------------------- */
  59
  60 /* Priority helper functions */
  61
  62 struct v4l2_prio_state {
  63         atomic_t prios[4];
  64 };
  65 int v4l2_prio_init(struct v4l2_prio_state *global);
  66 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
  67                      enum v4l2_priority new);
  68 int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
  69 int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
  70 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
  71 int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
  72
  73 /* ------------------------------------------------------------------------- */
  74
  75 /* Control helper functions */
  76
  77 int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
  78                 const char **menu_items);
  79 const char *v4l2_ctrl_get_name(u32 id);
  80 const char **v4l2_ctrl_get_menu(u32 id);
  81 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
  82 int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl);
  83 int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
  84                 struct v4l2_queryctrl *qctrl, const char **menu_items);
  85 u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
  86
  87 /* ------------------------------------------------------------------------- */
  88
  89 /* Register/chip ident helper function */
  90
  91 struct i2c_client; /* forward reference */
  92 int v4l2_chip_match_i2c_client(struct i2c_client *c, u32 id_type, u32 chip_id);
  93 int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_chip_ident *chip,
  94                 u32 ident, u32 revision);
  95 int v4l2_chip_match_host(u32 id_type, u32 chip_id);
  96
  97 /* ------------------------------------------------------------------------- */
  98
  99 /* Helper function for I2C legacy drivers */
 100
 101 struct i2c_driver;
 102 struct i2c_adapter;
 103 struct i2c_client;
 104 struct i2c_device_id;
 105
 106 int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver,
 107                 const char *name,
 108                 int (*probe)(struct i2c_client *, const struct i2c_device_id *));
 109
 110 /* ------------------------------------------------------------------------- */
 111
 112 /* Internal ioctls */
 113
 114 /* VIDIOC_INT_DECODE_VBI_LINE */
 115 struct v4l2_decode_vbi_line {
 116         u32 is_second_field;    /* Set to 0 for the first (odd) field,
 117                                    set to 1 for the second (even) field. */
 118         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
 119                                    On exit points to the start of the payload. */
 120         u32 line;               /* Line number of the sliced VBI data (1-23) */
 121         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
 122 };
 123
 124 struct v4l2_priv_tun_config {
 125         int tuner;
 126         void *priv;
 127 };
 128
 129 /* audio ioctls */
 130
 131 /* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
 132 #define AUDC_SET_RADIO        _IO('d',88)
 133
 134 /* tuner ioctls */
 135
 136 /* Sets tuner type and its I2C addr */
 137 #define TUNER_SET_TYPE_ADDR          _IOW('d', 90, int)
 138
 139 /* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
 140    by VIDIOC_INT_S_STANDBY. */
 141 #define TUNER_SET_STANDBY            _IOW('d', 91, int)
 142
 143 /* Sets tda9887 specific stuff, like port1, port2 and qss */
 144 #define TUNER_SET_CONFIG           _IOW('d', 92, struct v4l2_priv_tun_config)
 145
 146 /* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
 147 #define VIDIOC_INT_S_TUNER_MODE      _IOW('d', 93, enum v4l2_tuner_type)
 148
 149 /* Generic standby command. Passing -1 (all bits set to 1) will put the whole
 150    chip into standby mode, value 0 will make the chip fully active. Specific
 151    bits can be used by certain chips to enable/disable specific subsystems.
 152    Replacement of TUNER_SET_STANDBY. */
 153 #define VIDIOC_INT_S_STANDBY         _IOW('d', 94, u32)
 154
 155 /* 100, 101 used by  VIDIOC_DBG_[SG]_REGISTER */
 156
 157 /* Generic reset command. The argument selects which subsystems to reset.
 158    Passing 0 will always reset the whole chip. */
 159 #define VIDIOC_INT_RESET                _IOW ('d', 102, u32)
 160
 161 /* Set the frequency (in Hz) of the audio clock output.
 162    Used to slave an audio processor to the video decoder, ensuring that audio
 163    and video remain synchronized.
 164    Usual values for the frequency are 48000, 44100 or 32000 Hz.
 165    If the frequency is not supported, then -EINVAL is returned. */
 166 #define VIDIOC_INT_AUDIO_CLOCK_FREQ     _IOW ('d', 103, u32)
 167
 168 /* Video decoders that support sliced VBI need to implement this ioctl.
 169    Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
 170    data that was generated by the decoder. The driver then parses the sliced
 171    VBI data and sets the other fields in the struct accordingly. The pointer p
 172    is updated to point to the start of the payload which can be copied
 173    verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
 174    valid VBI data was found, then the type field is set to 0 on return. */
 175 #define VIDIOC_INT_DECODE_VBI_LINE      _IOWR('d', 104, struct v4l2_decode_vbi_line)
 176
 177 /* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
 178    filled with the data packets that should be output. Note that if you set
 179    the line field to 0, then that VBI signal is disabled. If no
 180    valid VBI data was found, then the type field is set to 0 on return. */
 181 #define VIDIOC_INT_S_VBI_DATA           _IOW ('d', 105, struct v4l2_sliced_vbi_data)
 182
 183 /* Used to obtain the sliced VBI packet from a readback register. Not all
 184    video decoders support this. If no data is available because the readback
 185    register contains invalid or erroneous data -EIO is returned. Note that
 186    you must fill in the 'id' member and the 'field' member (to determine
 187    whether CC data from the first or second field should be obtained). */
 188 #define VIDIOC_INT_G_VBI_DATA           _IOWR('d', 106, struct v4l2_sliced_vbi_data)
 189
 190 /* Sets I2S speed in bps. This is used to provide a standard way to select I2S
 191    clock used by driving digital audio streams at some board designs.
 192    Usual values for the frequency are 1024000 and 2048000.
 193    If the frequency is not supported, then -EINVAL is returned. */
 194 #define VIDIOC_INT_I2S_CLOCK_FREQ       _IOW ('d', 108, u32)
 195
 196 /* Routing definition, device dependent. It specifies which inputs (if any)
 197    should be routed to which outputs (if any). */
 198 struct v4l2_routing {
 199         u32 input;
 200         u32 output;
 201 };
 202
 203 /* These internal commands should be used to define the inputs and outputs
 204    of an audio/video chip. They will replace the v4l2 API commands
 205    VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
 206    that are meant to be used by the user.
 207    The internal commands should be used to switch inputs/outputs
 208    because only the driver knows how to map a 'Television' input to the precise
 209    input/output routing of an A/D converter, or a DSP, or a video digitizer.
 210    These four commands should only be sent directly to an i2c device, they
 211    should not be broadcast as the routing is very device specific. */
 212 #define VIDIOC_INT_S_AUDIO_ROUTING      _IOW ('d', 109, struct v4l2_routing)
 213 #define VIDIOC_INT_G_AUDIO_ROUTING      _IOR ('d', 110, struct v4l2_routing)
 214 #define VIDIOC_INT_S_VIDEO_ROUTING      _IOW ('d', 111, struct v4l2_routing)
 215 #define VIDIOC_INT_G_VIDEO_ROUTING      _IOR ('d', 112, struct v4l2_routing)
 216
 217 struct v4l2_crystal_freq {
 218         u32 freq;       /* frequency in Hz of the crystal */
 219         u32 flags;      /* device specific flags */
 220 };
 221
 222 /* Sets the frequency of the crystal used to generate the clocks.
 223    An extra flags field allows device specific configuration regarding
 224    clock frequency dividers, etc. If not used, then set flags to 0.
 225    If the frequency is not supported, then -EINVAL is returned. */
 226 #define VIDIOC_INT_S_CRYSTAL_FREQ       _IOW ('d', 113, struct v4l2_crystal_freq)
 227
 228 /* Initialize the sensor registors to some sort of reasonable
 229    default values. */
 230 #define VIDIOC_INT_INIT                 _IOW ('d', 114, u32)
 231
 232 /* Set v4l2_std_id for video OUTPUT devices. This is ignored by
 233    video input devices. */
 234 #define VIDIOC_INT_S_STD_OUTPUT         _IOW  ('d', 115, v4l2_std_id)
 235
 236 /* Get v4l2_std_id for video OUTPUT devices. This is ignored by
 237    video input devices. */
 238 #define VIDIOC_INT_G_STD_OUTPUT         _IOW  ('d', 116, v4l2_std_id)
 239
 240 #endif /* V4L2_COMMON_H_ */