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