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)->dev.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/* Add a version of v4l_dbg to be used on drivers using dev_foo() macros */ 59#define dev_dbg_lvl(__dev, __level, __debug, __fmt, __arg...) \ 60 do { \ 61 if (__debug >= (__level)) \ 62 dev_printk(KERN_DEBUG, __dev, __fmt, ##__arg); \ 63 } while (0) 64 65/* ------------------------------------------------------------------------- */ 66 67/* These printk constructs can be used with v4l2_device and v4l2_subdev */ 68#define v4l2_printk(level, dev, fmt, arg...) \ 69 printk(level "%s: " fmt, (dev)->name , ## arg) 70 71#define v4l2_err(dev, fmt, arg...) \ 72 v4l2_printk(KERN_ERR, dev, fmt , ## arg) 73 74#define v4l2_warn(dev, fmt, arg...) \ 75 v4l2_printk(KERN_WARNING, dev, fmt , ## arg) 76 77#define v4l2_info(dev, fmt, arg...) \ 78 v4l2_printk(KERN_INFO, dev, fmt , ## arg) 79 80/* These three macros assume that the debug level is set with a module 81 parameter called 'debug'. */ 82#define v4l2_dbg(level, debug, dev, fmt, arg...) \ 83 do { \ 84 if (debug >= (level)) \ 85 v4l2_printk(KERN_DEBUG, dev, fmt , ## arg); \ 86 } while (0) 87 88/** 89 * v4l2_ctrl_query_fill- Fill in a struct v4l2_queryctrl 90 * 91 * @qctrl: pointer to the &struct v4l2_queryctrl to be filled 92 * @min: minimum value for the control 93 * @max: maximum value for the control 94 * @step: control step 95 * @def: default value for the control 96 * 97 * Fills the &struct v4l2_queryctrl fields for the query control. 98 * 99 * .. note:: 100 * 101 * This function assumes that the @qctrl->id field is filled. 102 * 103 * Returns -EINVAL if the control is not known by the V4L2 core, 0 on success. 104 */ 105 106int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, 107 s32 min, s32 max, s32 step, s32 def); 108 109/* ------------------------------------------------------------------------- */ 110 111/* I2C Helper functions */ 112 113struct i2c_driver; 114struct i2c_adapter; 115struct i2c_client; 116struct i2c_device_id; 117struct v4l2_device; 118struct v4l2_subdev; 119struct v4l2_subdev_ops; 120 121/** 122 * v4l2_i2c_new_subdev - Load an i2c module and return an initialized 123 * &struct v4l2_subdev. 124 * 125 * @v4l2_dev: pointer to &struct v4l2_device 126 * @adapter: pointer to struct i2c_adapter 127 * @client_type: name of the chip that's on the adapter. 128 * @addr: I2C address. If zero, it will use @probe_addrs 129 * @probe_addrs: array with a list of address. The last entry at such 130 * array should be %I2C_CLIENT_END. 131 * 132 * returns a &struct v4l2_subdev pointer. 133 */ 134struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev, 135 struct i2c_adapter *adapter, const char *client_type, 136 u8 addr, const unsigned short *probe_addrs); 137 138struct i2c_board_info; 139 140/** 141 * v4l2_i2c_new_subdev_board - Load an i2c module and return an initialized 142 * &struct v4l2_subdev. 143 * 144 * @v4l2_dev: pointer to &struct v4l2_device 145 * @adapter: pointer to struct i2c_adapter 146 * @info: pointer to struct i2c_board_info used to replace the irq, 147 * platform_data and addr arguments. 148 * @probe_addrs: array with a list of address. The last entry at such 149 * array should be %I2C_CLIENT_END. 150 * 151 * returns a &struct v4l2_subdev pointer. 152 */ 153struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev, 154 struct i2c_adapter *adapter, struct i2c_board_info *info, 155 const unsigned short *probe_addrs); 156 157/** 158 * v4l2_i2c_subdev_init - Initializes a &struct v4l2_subdev with data from 159 * an i2c_client struct. 160 * 161 * @sd: pointer to &struct v4l2_subdev 162 * @client: pointer to struct i2c_client 163 * @ops: pointer to &struct v4l2_subdev_ops 164 */ 165void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client, 166 const struct v4l2_subdev_ops *ops); 167 168/** 169 * v4l2_i2c_subdev_addr - returns i2c client address of &struct v4l2_subdev. 170 * 171 * @sd: pointer to &struct v4l2_subdev 172 * 173 * Returns the address of an I2C sub-device 174 */ 175unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd); 176 177enum v4l2_i2c_tuner_type { 178 ADDRS_RADIO, /* Radio tuner addresses */ 179 ADDRS_DEMOD, /* Demod tuner addresses */ 180 ADDRS_TV, /* TV tuner addresses */ 181 /* TV tuner addresses if demod is present, this excludes 182 addresses used by the demodulator from the list of 183 candidates. */ 184 ADDRS_TV_WITH_DEMOD, 185}; 186/* Return a list of I2C tuner addresses to probe. Use only if the tuner 187 addresses are unknown. */ 188const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type); 189 190/* ------------------------------------------------------------------------- */ 191 192/* SPI Helper functions */ 193#if defined(CONFIG_SPI) 194 195#include <linux/spi/spi.h> 196 197struct spi_device; 198 199/** 200 * v4l2_spi_new_subdev - Load an spi module and return an initialized 201 * &struct v4l2_subdev. 202 * 203 * 204 * @v4l2_dev: pointer to &struct v4l2_device. 205 * @master: pointer to struct spi_master. 206 * @info: pointer to struct spi_board_info. 207 * 208 * returns a &struct v4l2_subdev pointer. 209 */ 210struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev, 211 struct spi_master *master, struct spi_board_info *info); 212 213/** 214 * v4l2_spi_subdev_init - Initialize a v4l2_subdev with data from an 215 * spi_device struct. 216 * 217 * @sd: pointer to &struct v4l2_subdev 218 * @spi: pointer to struct spi_device. 219 * @ops: pointer to &struct v4l2_subdev_ops 220 */ 221void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi, 222 const struct v4l2_subdev_ops *ops); 223#endif 224 225/* ------------------------------------------------------------------------- */ 226 227/* Note: these remaining ioctls/structs should be removed as well, but they are 228 still used in tuner-simple.c (TUNER_SET_CONFIG), cx18/ivtv (RESET) and 229 v4l2-int-device.h (v4l2_routing). To remove these ioctls some more cleanup 230 is needed in those modules. */ 231 232/* s_config */ 233struct v4l2_priv_tun_config { 234 int tuner; 235 void *priv; 236}; 237#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config) 238 239#define VIDIOC_INT_RESET _IOW ('d', 102, u32) 240 241struct v4l2_routing { 242 u32 input; 243 u32 output; 244}; 245 246/* ------------------------------------------------------------------------- */ 247 248/* Miscellaneous helper functions */ 249 250void v4l_bound_align_image(unsigned int *w, unsigned int wmin, 251 unsigned int wmax, unsigned int walign, 252 unsigned int *h, unsigned int hmin, 253 unsigned int hmax, unsigned int halign, 254 unsigned int salign); 255 256struct v4l2_discrete_probe { 257 const struct v4l2_frmsize_discrete *sizes; 258 int num_sizes; 259}; 260 261const struct v4l2_frmsize_discrete *v4l2_find_nearest_format( 262 const struct v4l2_discrete_probe *probe, 263 s32 width, s32 height); 264 265void v4l2_get_timestamp(struct timeval *tv); 266 267#endif /* V4L2_COMMON_H_ */ 268