2 * include/media/v4l2-int-device.h
4 * V4L2 internal ioctl interface.
6 * Copyright (C) 2007 Nokia Corporation.
8 * Contact: Sakari Ailus <sakari.ailus@nokia.com>
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * version 2 as published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
25 #ifndef V4L2_INT_DEVICE_H
26 #define V4L2_INT_DEVICE_H
28 #include <linux/module.h>
29 #include <media/v4l2-common.h>
31 #define V4L2NAMESIZE 32
35 * The internal V4L2 device interface core.
40 v4l2_int_type_master = 1,
44 struct v4l2_int_device;
46 struct v4l2_int_master {
47 int (*attach)(struct v4l2_int_device *slave);
48 void (*detach)(struct v4l2_int_device *slave);
51 typedef int (v4l2_int_ioctl_func)(struct v4l2_int_device *);
52 typedef int (v4l2_int_ioctl_func_0)(struct v4l2_int_device *);
53 typedef int (v4l2_int_ioctl_func_1)(struct v4l2_int_device *, void *);
55 struct v4l2_int_ioctl_desc {
57 v4l2_int_ioctl_func *func;
60 struct v4l2_int_slave {
61 /* Don't touch master. */
62 struct v4l2_int_device *master;
64 char attach_to[V4L2NAMESIZE];
67 struct v4l2_int_ioctl_desc *ioctls;
70 struct v4l2_int_device {
71 /* Don't touch head. */
72 struct list_head head;
74 struct module *module;
76 char name[V4L2NAMESIZE];
78 enum v4l2_int_type type;
80 struct v4l2_int_master *master;
81 struct v4l2_int_slave *slave;
87 int v4l2_int_device_register(struct v4l2_int_device *d);
88 void v4l2_int_device_unregister(struct v4l2_int_device *d);
90 int v4l2_int_ioctl_0(struct v4l2_int_device *d, int cmd);
91 int v4l2_int_ioctl_1(struct v4l2_int_device *d, int cmd, void *arg);
95 * Types and definitions for IOCTL commands.
99 /* Slave interface type. */
102 * Parallel 8-, 10- or 12-bit interface, used by for example
103 * on certain image sensors.
108 enum v4l2_if_type_bt656_mode {
110 * Modes without Bt synchronisation codes. Separate
111 * synchronisation signal lines are used.
113 V4L2_IF_TYPE_BT656_MODE_NOBT_8BIT,
114 V4L2_IF_TYPE_BT656_MODE_NOBT_10BIT,
115 V4L2_IF_TYPE_BT656_MODE_NOBT_12BIT,
117 * Use Bt synchronisation codes. The vertical and horizontal
118 * synchronisation is done based on synchronisation codes.
120 V4L2_IF_TYPE_BT656_MODE_BT_8BIT,
121 V4L2_IF_TYPE_BT656_MODE_BT_10BIT,
124 struct v4l2_if_type_bt656 {
126 * 0: Frame begins when vsync is high.
127 * 1: Frame begins when vsync changes from low to high.
129 unsigned frame_start_on_rising_vs:1;
130 /* Use Bt synchronisation codes for sync correction. */
131 unsigned bt_sync_correct:1;
132 /* Swap every two adjacent image data elements. */
134 /* Inverted latch clock polarity from slave. */
135 unsigned latch_clk_inv:1;
136 /* Hs polarity. 0 is active high, 1 active low. */
137 unsigned nobt_hs_inv:1;
138 /* Vs polarity. 0 is active high, 1 active low. */
139 unsigned nobt_vs_inv:1;
140 enum v4l2_if_type_bt656_mode mode;
141 /* Minimum accepted bus clock for slave (in Hz). */
143 /* Maximum accepted bus clock for slave. */
146 * Current wish of the slave. May only change in response to
147 * ioctls that affect image capture.
153 enum v4l2_if_type if_type;
155 struct v4l2_if_type_bt656 bt656;
159 /* IOCTL command numbers. */
160 enum v4l2_int_ioctl_num {
163 * "Proper" V4L ioctls, as in struct video_device.
166 vidioc_int_enum_fmt_cap_num = 1,
167 vidioc_int_g_fmt_cap_num,
168 vidioc_int_s_fmt_cap_num,
169 vidioc_int_try_fmt_cap_num,
170 vidioc_int_queryctrl_num,
171 vidioc_int_g_ctrl_num,
172 vidioc_int_s_ctrl_num,
173 vidioc_int_cropcap_num,
174 vidioc_int_g_crop_num,
175 vidioc_int_s_crop_num,
176 vidioc_int_g_parm_num,
177 vidioc_int_s_parm_num,
181 * Strictly internal ioctls.
184 /* Initialise the device when slave attaches to the master. */
185 vidioc_int_dev_init_num = 1000,
186 /* Delinitialise the device at slave detach. */
187 vidioc_int_dev_exit_num,
188 /* Set device power state: 0 is off, non-zero is on. */
189 vidioc_int_s_power_num,
191 * Get slave private data, e.g. platform-specific slave
192 * configuration used by the master.
194 vidioc_int_g_priv_num,
195 /* Get slave interface parameters. */
196 vidioc_int_g_ifparm_num,
197 /* Does the slave need to be reset after VIDIOC_DQBUF? */
198 vidioc_int_g_needs_reset_num,
202 * VIDIOC_INT_* ioctls.
205 /* VIDIOC_INT_RESET */
206 vidioc_int_reset_num,
207 /* VIDIOC_INT_INIT */
209 /* VIDIOC_INT_G_CHIP_IDENT */
210 vidioc_int_g_chip_ident_num,
214 * Start of private ioctls.
217 vidioc_int_priv_start_num = 2000,
222 * IOCTL wrapper functions for better type checking.
226 #define V4L2_INT_WRAPPER_0(name) \
227 static inline int vidioc_int_##name(struct v4l2_int_device *d) \
229 return v4l2_int_ioctl_0(d, vidioc_int_##name##_num); \
232 static inline struct v4l2_int_ioctl_desc \
233 vidioc_int_##name##_cb(int (*func) \
234 (struct v4l2_int_device *)) \
236 struct v4l2_int_ioctl_desc desc; \
238 desc.num = vidioc_int_##name##_num; \
239 desc.func = (v4l2_int_ioctl_func *)func; \
244 #define V4L2_INT_WRAPPER_1(name, arg_type, asterisk) \
245 static inline int vidioc_int_##name(struct v4l2_int_device *d, \
246 arg_type asterisk arg) \
248 return v4l2_int_ioctl_1(d, vidioc_int_##name##_num, \
249 (void *)(unsigned long)arg); \
252 static inline struct v4l2_int_ioctl_desc \
253 vidioc_int_##name##_cb(int (*func) \
254 (struct v4l2_int_device *, \
255 arg_type asterisk)) \
257 struct v4l2_int_ioctl_desc desc; \
259 desc.num = vidioc_int_##name##_num; \
260 desc.func = (v4l2_int_ioctl_func *)func; \
265 V4L2_INT_WRAPPER_1(enum_fmt_cap, struct v4l2_fmtdesc, *);
266 V4L2_INT_WRAPPER_1(g_fmt_cap, struct v4l2_format, *);
267 V4L2_INT_WRAPPER_1(s_fmt_cap, struct v4l2_format, *);
268 V4L2_INT_WRAPPER_1(try_fmt_cap, struct v4l2_format, *);
269 V4L2_INT_WRAPPER_1(queryctrl, struct v4l2_queryctrl, *);
270 V4L2_INT_WRAPPER_1(g_ctrl, struct v4l2_control, *);
271 V4L2_INT_WRAPPER_1(s_ctrl, struct v4l2_control, *);
272 V4L2_INT_WRAPPER_1(cropcap, struct v4l2_cropcap, *);
273 V4L2_INT_WRAPPER_1(g_crop, struct v4l2_crop, *);
274 V4L2_INT_WRAPPER_1(s_crop, struct v4l2_crop, *);
275 V4L2_INT_WRAPPER_1(g_parm, struct v4l2_streamparm, *);
276 V4L2_INT_WRAPPER_1(s_parm, struct v4l2_streamparm, *);
278 V4L2_INT_WRAPPER_0(dev_init);
279 V4L2_INT_WRAPPER_0(dev_exit);
280 V4L2_INT_WRAPPER_1(s_power, int, );
281 V4L2_INT_WRAPPER_1(g_priv, void, *);
282 V4L2_INT_WRAPPER_1(g_ifparm, struct v4l2_ifparm, *);
283 V4L2_INT_WRAPPER_1(g_needs_reset, void, *);
285 V4L2_INT_WRAPPER_0(reset);
286 V4L2_INT_WRAPPER_0(init);
287 V4L2_INT_WRAPPER_1(g_chip_ident, int, *);