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 /* 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, client, fmt, arg...)                                  \
  53         do {                                                                 \
  54                 extern int debug;                                            \
  55                 if (debug >= (level))                                        \
  56                         v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
  57         } while (0)
  58
  59 /* Prints the ioctl in a human-readable format */
  60 extern void v4l_printk_ioctl(unsigned int cmd);
  61
  62 /* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
  63 #define v4l_print_ioctl(name, cmd)               \
  64         do {                                     \
  65                 printk(KERN_DEBUG "%s: ", name); \
  66                 v4l_printk_ioctl(cmd);           \
  67         } while (0)
  68
  69 /* Use this macro in I2C drivers where 'client' is the struct i2c_client
  70    pointer */
  71 #define v4l_i2c_print_ioctl(client, cmd)                   \
  72         do {                                               \
  73                 v4l_client_printk(KERN_DEBUG, client, ""); \
  74                 v4l_printk_ioctl(cmd);                     \
  75         } while (0)
  76
  77 /* ------------------------------------------------------------------------- */
  78
  79 /* Internal ioctls */
  80
  81 /* VIDIOC_INT_G_REGISTER and VIDIOC_INT_S_REGISTER */
  82 struct v4l2_register {
  83         u32 i2c_id;             /* I2C driver ID of the I2C chip. 0 for the I2C adapter. */
  84         unsigned long reg;
  85         u32 val;
  86 };
  87
  88 /* VIDIOC_INT_DECODE_VBI_LINE */
  89 struct v4l2_decode_vbi_line {
  90         u32 is_second_field;    /* Set to 0 for the first (odd) field,
  91                                    set to 1 for the second (even) field. */
  92         u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
  93                                    On exit points to the start of the payload. */
  94         u32 line;               /* Line number of the sliced VBI data (1-23) */
  95         u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
  96 };
  97
  98 /* VIDIOC_INT_G_CHIP_IDENT: identifies the actual chip installed on the board */
  99 enum v4l2_chip_ident {
 100         /* general idents: reserved range 0-49 */
 101         V4L2_IDENT_UNKNOWN = 0,
 102
 103         /* module saa7115: reserved range 100-149 */
 104         V4L2_IDENT_SAA7114 = 104,
 105         V4L2_IDENT_SAA7115 = 105,
 106
 107         /* module saa7127: reserved range 150-199 */
 108         V4L2_IDENT_SAA7127 = 157,
 109         V4L2_IDENT_SAA7129 = 159,
 110
 111         /* module cx25840: reserved range 200-249 */
 112         V4L2_IDENT_CX25840 = 240,
 113         V4L2_IDENT_CX25841 = 241,
 114         V4L2_IDENT_CX25842 = 242,
 115         V4L2_IDENT_CX25843 = 243,
 116 };
 117
 118 /* audio ioctls */
 119 /* v4l device was opened in Radio mode */
 120 #define AUDC_SET_RADIO        _IO('d',88)
 121 /* select from TV,radio,extern,MUTE */
 122 #define AUDC_SET_INPUT        _IOW('d',89,int)
 123
 124 /* tuner ioctls */
 125 /* Sets tuner type and its I2C addr */
 126 #define TUNER_SET_TYPE_ADDR          _IOW('d',90,int)
 127 /* Puts tuner on powersaving state, disabling it, except for i2c */
 128 #define TUNER_SET_STANDBY            _IOW('d',91,int)
 129 /* Sets tda9887 specific stuff, like port1, port2 and qss */
 130 #define TDA9887_SET_CONFIG           _IOW('d',92,int)
 131
 132 /* only implemented if CONFIG_VIDEO_ADV_DEBUG is defined */
 133 #define VIDIOC_INT_S_REGISTER           _IOR ('d', 100, struct v4l2_register)
 134 #define VIDIOC_INT_G_REGISTER           _IOWR('d', 101, struct v4l2_register)
 135
 136 /* Reset the I2C chip */
 137 #define VIDIOC_INT_RESET                _IO  ('d', 102)
 138
 139 /* Set the frequency (in Hz) of the audio clock output.
 140    Used to slave an audio processor to the video decoder, ensuring that audio
 141    and video remain synchronized.
 142    Usual values for the frequency are 48000, 44100 or 32000 Hz.
 143    If the frequency is not supported, then -EINVAL is returned. */
 144 #define VIDIOC_INT_AUDIO_CLOCK_FREQ     _IOW ('d', 103, u32)
 145
 146 /* Video decoders that support sliced VBI need to implement this ioctl.
 147    Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
 148    data that was generated by the decoder. The driver then parses the sliced
 149    VBI data and sets the other fields in the struct accordingly. The pointer p
 150    is updated to point to the start of the payload which can be copied
 151    verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
 152    valid VBI data was found, then the type field is set to 0 on return. */
 153 #define VIDIOC_INT_DECODE_VBI_LINE      _IOWR('d', 104, struct v4l2_decode_vbi_line)
 154
 155 /* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
 156    filled with the data packets that should be output. Note that if you set
 157    the line field to 0, then that VBI signal is disabled. */
 158 #define VIDIOC_INT_S_VBI_DATA           _IOW ('d', 105, struct v4l2_sliced_vbi_data)
 159
 160 /* Used to obtain the sliced VBI packet from a readback register. Not all
 161    video decoders support this. If no data is available because the readback
 162    register contains invalid or erroneous data -EIO is returned. Note that
 163    you must fill in the 'id' member and the 'field' member (to determine
 164    whether CC data from the first or second field should be obtained). */
 165 #define VIDIOC_INT_G_VBI_DATA           _IOWR('d', 106, struct v4l2_sliced_vbi_data *)
 166
 167 /* Returns the chip identifier or V4L2_IDENT_UNKNOWN if no identification can
 168    be made. */
 169 #define VIDIOC_INT_G_CHIP_IDENT         _IOR ('d', 107, enum v4l2_chip_ident *)
 170
 171 /* Sets I2S speed in bps. This is used to provide a standard way to select I2S
 172    clock used by driving digital audio streams at some board designs.
 173    Usual values for the frequency are 1024000 and 2048000.
 174    If the frequency is not supported, then -EINVAL is returned. */
 175 #define VIDIOC_INT_I2S_CLOCK_FREQ       _IOW ('d', 108, u32)
 176
 177 #endif /* V4L2_COMMON_H_ */