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