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 /* These printk constructs can be used with v4l2_device and v4l2_subdev */
  61 #define v4l2_printk(level, dev, fmt, arg...) \
  62         printk(level "%s: " fmt, (dev)->name , ## arg)
  63
  64 #define v4l2_err(dev, fmt, arg...) \
  65         v4l2_printk(KERN_ERR, dev, fmt , ## arg)
  66
  67 #define v4l2_warn(dev, fmt, arg...) \
  68         v4l2_printk(KERN_WARNING, dev, fmt , ## arg)
  69
  70 #define v4l2_info(dev, fmt, arg...) \
  71         v4l2_printk(KERN_INFO, dev, fmt , ## arg)
  72
  73 /* These three macros assume that the debug level is set with a module
  74    parameter called 'debug'. */
  75 #define v4l2_dbg(level, debug, dev, fmt, arg...)                        \
  76         do {                                                            \
  77                 if (debug >= (level))                                   \
  78                         v4l2_printk(KERN_DEBUG, dev, fmt , ## arg);     \
  79         } while (0)
  80
  81 /* ------------------------------------------------------------------------- */
  82
  83 /* Control helper functions */
  84
  85 int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
  86                 const char * const *menu_items);
  87 const char *v4l2_ctrl_get_name(u32 id);
  88 const char * const *v4l2_ctrl_get_menu(u32 id);
  89 const s64 const *v4l2_ctrl_get_int_menu(u32 id, u32 *len);
  90 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
  91 int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
  92                 struct v4l2_queryctrl *qctrl, const char * const *menu_items);
  93 #define V4L2_CTRL_MENU_IDS_END (0xffffffff)
  94 int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu *qmenu, const u32 *ids);
  95
  96 /* Note: ctrl_classes points to an array of u32 pointers. Each u32 array is a
  97    0-terminated array of control IDs. Each array must be sorted low to high
  98    and belong to the same control class. The array of u32 pointers must also
  99    be sorted, from low class IDs to high class IDs. */
 100 u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
 101
 102 /* ------------------------------------------------------------------------- */
 103
 104 /* I2C Helper functions */
 105
 106 struct i2c_driver;
 107 struct i2c_adapter;
 108 struct i2c_client;
 109 struct i2c_device_id;
 110 struct v4l2_device;
 111 struct v4l2_subdev;
 112 struct v4l2_subdev_ops;
 113
 114
 115 /* Load an i2c module and return an initialized v4l2_subdev struct.
 116    The client_type argument is the name of the chip that's on the adapter. */
 117 struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
 118                 struct i2c_adapter *adapter, const char *client_type,
 119                 u8 addr, const unsigned short *probe_addrs);
 120
 121 struct i2c_board_info;
 122
 123 struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
 124                 struct i2c_adapter *adapter, struct i2c_board_info *info,
 125                 const unsigned short *probe_addrs);
 126
 127 /* Initialize a v4l2_subdev with data from an i2c_client struct */
 128 void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
 129                 const struct v4l2_subdev_ops *ops);
 130 /* Return i2c client address of v4l2_subdev. */
 131 unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
 132
 133 enum v4l2_i2c_tuner_type {
 134         ADDRS_RADIO,    /* Radio tuner addresses */
 135         ADDRS_DEMOD,    /* Demod tuner addresses */
 136         ADDRS_TV,       /* TV tuner addresses */
 137         /* TV tuner addresses if demod is present, this excludes
 138            addresses used by the demodulator from the list of
 139            candidates. */
 140         ADDRS_TV_WITH_DEMOD,
 141 };
 142 /* Return a list of I2C tuner addresses to probe. Use only if the tuner
 143    addresses are unknown. */
 144 const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
 145
 146 /* ------------------------------------------------------------------------- */
 147
 148 /* SPI Helper functions */
 149 #if defined(CONFIG_SPI)
 150
 151 #include <linux/spi/spi.h>
 152
 153 struct spi_device;
 154
 155 /* Load an spi module and return an initialized v4l2_subdev struct.
 156    The client_type argument is the name of the chip that's on the adapter. */
 157 struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
 158                 struct spi_master *master, struct spi_board_info *info);
 159
 160 /* Initialize a v4l2_subdev with data from an spi_device struct */
 161 void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
 162                 const struct v4l2_subdev_ops *ops);
 163 #endif
 164
 165 /* ------------------------------------------------------------------------- */
 166
 167 /* Note: these remaining ioctls/structs should be removed as well, but they are
 168    still used in tuner-simple.c (TUNER_SET_CONFIG), cx18/ivtv (RESET) and
 169    v4l2-int-device.h (v4l2_routing). To remove these ioctls some more cleanup
 170    is needed in those modules. */
 171
 172 /* s_config */
 173 struct v4l2_priv_tun_config {
 174         int tuner;
 175         void *priv;
 176 };
 177 #define TUNER_SET_CONFIG           _IOW('d', 92, struct v4l2_priv_tun_config)
 178
 179 #define VIDIOC_INT_RESET                _IOW ('d', 102, u32)
 180
 181 struct v4l2_routing {
 182         u32 input;
 183         u32 output;
 184 };
 185
 186 /* ------------------------------------------------------------------------- */
 187
 188 /* Miscellaneous helper functions */
 189
 190 void v4l_bound_align_image(unsigned int *w, unsigned int wmin,
 191                            unsigned int wmax, unsigned int walign,
 192                            unsigned int *h, unsigned int hmin,
 193                            unsigned int hmax, unsigned int halign,
 194                            unsigned int salign);
 195
 196 struct v4l2_discrete_probe {
 197         const struct v4l2_frmsize_discrete      *sizes;
 198         int                                     num_sizes;
 199 };
 200
 201 const struct v4l2_frmsize_discrete *v4l2_find_nearest_format(
 202                 const struct v4l2_discrete_probe *probe,
 203                 s32 width, s32 height);
 204
 205 void v4l2_get_timestamp(struct timeval *tv);
 206
 207 #endif /* V4L2_COMMON_H_ */