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