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_menu(u32 id);
  80 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
  81 int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl);
  82 int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
  83                 struct v4l2_queryctrl *qctrl, const char **menu_items);
  84 u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
  85
  86 /* ------------------------------------------------------------------------- */
  87
  88 /* Register/chip ident helper function */
  89
  90 struct i2c_client; /* forward reference */
  91 int v4l2_chip_match_i2c_client(struct i2c_client *c, u32 id_type, u32 chip_id);
  92 int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_chip_ident *chip,
  93                 u32 ident, u32 revision);
  94 int v4l2_chip_match_host(u32 id_type, u32 chip_id);
  95
  96 /* ------------------------------------------------------------------------- */
  97
  98 /* Helper function for I2C legacy drivers */
  99
 100 struct i2c_driver;
 101 struct i2c_adapter;
 102 struct i2c_client;
 103 struct i2c_device_id;
 104
 105 int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver,
 106                 const char *name,
 107                 int (*probe)(struct i2c_client *, const struct i2c_device_id *));
 108
 109 /* ------------------------------------------------------------------------- */
 110
 111 /* Internal ioctls */
 112
 113 /* VIDIOC_INT_DECODE_VBI_LINE */
 114 struct v4l2_decode_vbi_line {
 115         u32 is_second_field;    /* Set to 0 for the first (odd) field,
 116                                    set to 1 for the second (even) field. */
 117         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
 118                                    On exit points to the start of the payload. */
 119         u32 line;               /* Line number of the sliced VBI data (1-23) */
 120         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
 121 };
 122
 123 struct v4l2_priv_tun_config {
 124         int tuner;
 125         void *priv;
 126 };
 127
 128 /* audio ioctls */
 129
 130 /* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
 131 #define AUDC_SET_RADIO        _IO('d',88)
 132
 133 /* tuner ioctls */
 134
 135 /* Sets tuner type and its I2C addr */
 136 #define TUNER_SET_TYPE_ADDR          _IOW('d', 90, int)
 137
 138 /* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
 139    by VIDIOC_INT_S_STANDBY. */
 140 #define TUNER_SET_STANDBY            _IOW('d', 91, int)
 141
 142 /* Sets tda9887 specific stuff, like port1, port2 and qss */
 143 #define TUNER_SET_CONFIG           _IOW('d', 92, struct v4l2_priv_tun_config)
 144
 145 /* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
 146 #define VIDIOC_INT_S_TUNER_MODE      _IOW('d', 93, enum v4l2_tuner_type)
 147
 148 /* Generic standby command. Passing -1 (all bits set to 1) will put the whole
 149    chip into standby mode, value 0 will make the chip fully active. Specific
 150    bits can be used by certain chips to enable/disable specific subsystems.
 151    Replacement of TUNER_SET_STANDBY. */
 152 #define VIDIOC_INT_S_STANDBY         _IOW('d', 94, u32)
 153
 154 /* 100, 101 used by  VIDIOC_DBG_[SG]_REGISTER */
 155
 156 /* Generic reset command. The argument selects which subsystems to reset.
 157    Passing 0 will always reset the whole chip. */
 158 #define VIDIOC_INT_RESET                _IOW ('d', 102, u32)
 159
 160 /* Set the frequency (in Hz) of the audio clock output.
 161    Used to slave an audio processor to the video decoder, ensuring that audio
 162    and video remain synchronized.
 163    Usual values for the frequency are 48000, 44100 or 32000 Hz.
 164    If the frequency is not supported, then -EINVAL is returned. */
 165 #define VIDIOC_INT_AUDIO_CLOCK_FREQ     _IOW ('d', 103, u32)
 166
 167 /* Video decoders that support sliced VBI need to implement this ioctl.
 168    Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
 169    data that was generated by the decoder. The driver then parses the sliced
 170    VBI data and sets the other fields in the struct accordingly. The pointer p
 171    is updated to point to the start of the payload which can be copied
 172    verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
 173    valid VBI data was found, then the type field is set to 0 on return. */
 174 #define VIDIOC_INT_DECODE_VBI_LINE      _IOWR('d', 104, struct v4l2_decode_vbi_line)
 175
 176 /* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
 177    filled with the data packets that should be output. Note that if you set
 178    the line field to 0, then that VBI signal is disabled. If no
 179    valid VBI data was found, then the type field is set to 0 on return. */
 180 #define VIDIOC_INT_S_VBI_DATA           _IOW ('d', 105, struct v4l2_sliced_vbi_data)
 181
 182 /* Used to obtain the sliced VBI packet from a readback register. Not all
 183    video decoders support this. If no data is available because the readback
 184    register contains invalid or erroneous data -EIO is returned. Note that
 185    you must fill in the 'id' member and the 'field' member (to determine
 186    whether CC data from the first or second field should be obtained). */
 187 #define VIDIOC_INT_G_VBI_DATA           _IOWR('d', 106, struct v4l2_sliced_vbi_data)
 188
 189 /* Sets I2S speed in bps. This is used to provide a standard way to select I2S
 190    clock used by driving digital audio streams at some board designs.
 191    Usual values for the frequency are 1024000 and 2048000.
 192    If the frequency is not supported, then -EINVAL is returned. */
 193 #define VIDIOC_INT_I2S_CLOCK_FREQ       _IOW ('d', 108, u32)
 194
 195 /* Routing definition, device dependent. It specifies which inputs (if any)
 196    should be routed to which outputs (if any). */
 197 struct v4l2_routing {
 198         u32 input;
 199         u32 output;
 200 };
 201
 202 /* These internal commands should be used to define the inputs and outputs
 203    of an audio/video chip. They will replace the v4l2 API commands
 204    VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
 205    that are meant to be used by the user.
 206    The internal commands should be used to switch inputs/outputs
 207    because only the driver knows how to map a 'Television' input to the precise
 208    input/output routing of an A/D converter, or a DSP, or a video digitizer.
 209    These four commands should only be sent directly to an i2c device, they
 210    should not be broadcast as the routing is very device specific. */
 211 #define VIDIOC_INT_S_AUDIO_ROUTING      _IOW ('d', 109, struct v4l2_routing)
 212 #define VIDIOC_INT_G_AUDIO_ROUTING      _IOR ('d', 110, struct v4l2_routing)
 213 #define VIDIOC_INT_S_VIDEO_ROUTING      _IOW ('d', 111, struct v4l2_routing)
 214 #define VIDIOC_INT_G_VIDEO_ROUTING      _IOR ('d', 112, struct v4l2_routing)
 215
 216 struct v4l2_crystal_freq {
 217         u32 freq;       /* frequency in Hz of the crystal */
 218         u32 flags;      /* device specific flags */
 219 };
 220
 221 /* Sets the frequency of the crystal used to generate the clocks.
 222    An extra flags field allows device specific configuration regarding
 223    clock frequency dividers, etc. If not used, then set flags to 0.
 224    If the frequency is not supported, then -EINVAL is returned. */
 225 #define VIDIOC_INT_S_CRYSTAL_FREQ       _IOW ('d', 113, struct v4l2_crystal_freq)
 226
 227 /* Initialize the sensor registors to some sort of reasonable
 228    default values. */
 229 #define VIDIOC_INT_INIT                 _IOW ('d', 114, u32)
 230
 231 /* Set v4l2_std_id for video OUTPUT devices. This is ignored by
 232    video input devices. */
 233 #define VIDIOC_INT_S_STD_OUTPUT         _IOW  ('d', 115, v4l2_std_id)
 234
 235 /* Get v4l2_std_id for video OUTPUT devices. This is ignored by
 236    video input devices. */
 237 #define VIDIOC_INT_G_STD_OUTPUT         _IOW  ('d', 116, v4l2_std_id)
 238
 239 #endif /* V4L2_COMMON_H_ */