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 /* Prints the ioctl in a human-readable format */
  65 extern void v4l_printk_ioctl(unsigned int cmd);
  66
  67 /* Prints the ioctl and arg in a human-readable format */
  68 extern void v4l_printk_ioctl_arg(char *s,unsigned int cmd, void *arg);
  69
  70 /* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
  71 #define v4l_print_ioctl(name, cmd)               \
  72         do {                                     \
  73                 printk(KERN_DEBUG "%s: ", name); \
  74                 v4l_printk_ioctl(cmd);           \
  75         } while (0)
  76
  77 /* Use this macro in I2C drivers where 'client' is the struct i2c_client
  78    pointer */
  79 #define v4l_i2c_print_ioctl(client, cmd)                   \
  80         do {                                               \
  81                 v4l_client_printk(KERN_DEBUG, client, ""); \
  82                 v4l_printk_ioctl(cmd);                     \
  83         } while (0)
  84
  85 /* ------------------------------------------------------------------------- */
  86
  87 /* Control helper functions */
  88
  89 int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
  90                 const char **menu_items);
  91 const char **v4l2_ctrl_get_menu(u32 id);
  92 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
  93 int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl);
  94 int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
  95                 struct v4l2_queryctrl *qctrl, const char **menu_items);
  96 u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
  97
  98 /* ------------------------------------------------------------------------- */
  99
 100 /* Internal ioctls */
 101
 102 /* VIDIOC_INT_G_REGISTER and VIDIOC_INT_S_REGISTER */
 103 struct v4l2_register {
 104         u32 i2c_id;             /* I2C driver ID of the I2C chip. 0 for the I2C adapter. */
 105         unsigned long reg;
 106         u32 val;
 107 };
 108
 109 /* VIDIOC_INT_DECODE_VBI_LINE */
 110 struct v4l2_decode_vbi_line {
 111         u32 is_second_field;    /* Set to 0 for the first (odd) field,
 112                                    set to 1 for the second (even) field. */
 113         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
 114                                    On exit points to the start of the payload. */
 115         u32 line;               /* Line number of the sliced VBI data (1-23) */
 116         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
 117 };
 118
 119 /* VIDIOC_INT_G_CHIP_IDENT: identifies the actual chip installed on the board */
 120 enum v4l2_chip_ident {
 121         /* general idents: reserved range 0-49 */
 122         V4L2_IDENT_UNKNOWN = 0,
 123
 124         /* module saa7110: just ident= 100 */
 125         V4L2_IDENT_SAA7110 = 100,
 126
 127         /* module saa7111: just ident= 101 */
 128         V4L2_IDENT_SAA7111 = 101,
 129
 130         /* module saa7115: reserved range 102-149 */
 131         V4L2_IDENT_SAA7113 = 103,
 132         V4L2_IDENT_SAA7114 = 104,
 133         V4L2_IDENT_SAA7115 = 105,
 134         V4L2_IDENT_SAA7118 = 108,
 135
 136         /* module saa7127: reserved range 150-199 */
 137         V4L2_IDENT_SAA7127 = 157,
 138         V4L2_IDENT_SAA7129 = 159,
 139
 140         /* module cx25840: reserved range 200-249 */
 141         V4L2_IDENT_CX25836 = 236,
 142         V4L2_IDENT_CX25837 = 237,
 143         V4L2_IDENT_CX25840 = 240,
 144         V4L2_IDENT_CX25841 = 241,
 145         V4L2_IDENT_CX25842 = 242,
 146         V4L2_IDENT_CX25843 = 243,
 147 };
 148
 149 /* audio ioctls */
 150
 151 /* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
 152 #define AUDC_SET_RADIO        _IO('d',88)
 153
 154 /* tuner ioctls */
 155
 156 /* Sets tuner type and its I2C addr */
 157 #define TUNER_SET_TYPE_ADDR          _IOW('d', 90, int)
 158
 159 /* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
 160    by VIDIOC_INT_S_STANDBY. */
 161 #define TUNER_SET_STANDBY            _IOW('d', 91, int)
 162
 163 /* Sets tda9887 specific stuff, like port1, port2 and qss */
 164 #define TDA9887_SET_CONFIG           _IOW('d', 92, int)
 165
 166 /* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
 167 #define VIDIOC_INT_S_TUNER_MODE      _IOW('d', 93, enum v4l2_tuner_type)
 168
 169 /* Generic standby command. Passing -1 (all bits set to 1) will put the whole
 170    chip into standby mode, value 0 will make the chip fully active. Specific
 171    bits can be used by certain chips to enable/disable specific subsystems.
 172    Replacement of TUNER_SET_STANDBY. */
 173 #define VIDIOC_INT_S_STANDBY         _IOW('d', 94, u32)
 174
 175 /* only implemented if CONFIG_VIDEO_ADV_DEBUG is defined */
 176 #define VIDIOC_INT_S_REGISTER           _IOW ('d', 100, struct v4l2_register)
 177 #define VIDIOC_INT_G_REGISTER           _IOWR('d', 101, struct v4l2_register)
 178
 179 /* Generic reset command. The argument selects which subsystems to reset.
 180    Passing 0 will always reset the whole chip. */
 181 #define VIDIOC_INT_RESET                _IOW ('d', 102, u32)
 182
 183 /* Set the frequency (in Hz) of the audio clock output.
 184    Used to slave an audio processor to the video decoder, ensuring that audio
 185    and video remain synchronized.
 186    Usual values for the frequency are 48000, 44100 or 32000 Hz.
 187    If the frequency is not supported, then -EINVAL is returned. */
 188 #define VIDIOC_INT_AUDIO_CLOCK_FREQ     _IOW ('d', 103, u32)
 189
 190 /* Video decoders that support sliced VBI need to implement this ioctl.
 191    Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
 192    data that was generated by the decoder. The driver then parses the sliced
 193    VBI data and sets the other fields in the struct accordingly. The pointer p
 194    is updated to point to the start of the payload which can be copied
 195    verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
 196    valid VBI data was found, then the type field is set to 0 on return. */
 197 #define VIDIOC_INT_DECODE_VBI_LINE      _IOWR('d', 104, struct v4l2_decode_vbi_line)
 198
 199 /* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
 200    filled with the data packets that should be output. Note that if you set
 201    the line field to 0, then that VBI signal is disabled. If no
 202    valid VBI data was found, then the type field is set to 0 on return. */
 203 #define VIDIOC_INT_S_VBI_DATA           _IOW ('d', 105, struct v4l2_sliced_vbi_data)
 204
 205 /* Used to obtain the sliced VBI packet from a readback register. Not all
 206    video decoders support this. If no data is available because the readback
 207    register contains invalid or erroneous data -EIO is returned. Note that
 208    you must fill in the 'id' member and the 'field' member (to determine
 209    whether CC data from the first or second field should be obtained). */
 210 #define VIDIOC_INT_G_VBI_DATA           _IOWR('d', 106, struct v4l2_sliced_vbi_data)
 211
 212 /* Returns the chip identifier or V4L2_IDENT_UNKNOWN if no identification can
 213    be made. */
 214 #define VIDIOC_INT_G_CHIP_IDENT         _IOR ('d', 107, enum v4l2_chip_ident)
 215
 216 /* Sets I2S speed in bps. This is used to provide a standard way to select I2S
 217    clock used by driving digital audio streams at some board designs.
 218    Usual values for the frequency are 1024000 and 2048000.
 219    If the frequency is not supported, then -EINVAL is returned. */
 220 #define VIDIOC_INT_I2S_CLOCK_FREQ       _IOW ('d', 108, u32)
 221
 222 /* Routing definition, device dependent. It specifies which inputs (if any)
 223    should be routed to which outputs (if any). */
 224 struct v4l2_routing {
 225         u32 input;
 226         u32 output;
 227 };
 228
 229 /* These internal commands should be used to define the inputs and outputs
 230    of an audio/video chip. They will replace the v4l2 API commands
 231    VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
 232    that are meant to be used by the user.
 233    The internal commands should be used to switch inputs/outputs
 234    because only the driver knows how to map a 'Television' input to the precise
 235    input/output routing of an A/D converter, or a DSP, or a video digitizer.
 236    These four commands should only be sent directly to an i2c device, they
 237    should not be broadcast as the routing is very device specific. */
 238 #define VIDIOC_INT_S_AUDIO_ROUTING      _IOW ('d', 109, struct v4l2_routing)
 239 #define VIDIOC_INT_G_AUDIO_ROUTING      _IOR ('d', 110, struct v4l2_routing)
 240 #define VIDIOC_INT_S_VIDEO_ROUTING      _IOW ('d', 111, struct v4l2_routing)
 241 #define VIDIOC_INT_G_VIDEO_ROUTING      _IOR ('d', 112, struct v4l2_routing)
 242
 243 struct v4l2_crystal_freq {
 244         u32 freq;       /* frequency in Hz of the crystal */
 245         u32 flags;      /* device specific flags */
 246 };
 247
 248 /* Sets the frequency of the crystal used to generate the clocks.
 249    An extra flags field allows device specific configuration regarding
 250    clock frequency dividers, etc. If not used, then set flags to 0.
 251    If the frequency is not supported, then -EINVAL is returned. */
 252 #define VIDIOC_INT_S_CRYSTAL_FREQ       _IOW ('d', 113, struct v4l2_crystal_freq)
 253
 254 #endif /* V4L2_COMMON_H_ */