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 *master,
48 struct v4l2_int_device *slave);
49 void (*detach)(struct v4l2_int_device *master);
52 typedef int (v4l2_int_ioctl_func)(struct v4l2_int_device *);
53 typedef int (v4l2_int_ioctl_func_0)(struct v4l2_int_device *);
54 typedef int (v4l2_int_ioctl_func_1)(struct v4l2_int_device *, void *);
56 struct v4l2_int_ioctl_desc {
58 v4l2_int_ioctl_func *func;
61 struct v4l2_int_slave {
62 /* Don't touch master. */
63 struct v4l2_int_device *master;
65 char attach_to[V4L2NAMESIZE];
68 struct v4l2_int_ioctl_desc *ioctls;
71 struct v4l2_int_device {
72 /* Don't touch head. */
73 struct list_head head;
75 struct module *module;
77 char name[V4L2NAMESIZE];
79 enum v4l2_int_type type;
81 struct v4l2_int_master *master;
82 struct v4l2_int_slave *slave;
88 int v4l2_int_device_register(struct v4l2_int_device *d);
89 void v4l2_int_device_unregister(struct v4l2_int_device *d);
91 int v4l2_int_ioctl_0(struct v4l2_int_device *d, int cmd);
92 int v4l2_int_ioctl_1(struct v4l2_int_device *d, int cmd, void *arg);
96 * Types and definitions for IOCTL commands.
100 /* Slave interface type. */
105 enum v4l2_if_type if_type;
110 /* IOCTL command numbers. */
111 enum v4l2_int_ioctl_num {
114 * "Proper" V4L ioctls, as in struct video_device.
117 vidioc_int_enum_fmt_cap_num = 1,
118 vidioc_int_g_fmt_cap_num,
119 vidioc_int_s_fmt_cap_num,
120 vidioc_int_try_fmt_cap_num,
121 vidioc_int_queryctrl_num,
122 vidioc_int_g_ctrl_num,
123 vidioc_int_s_ctrl_num,
124 vidioc_int_g_parm_num,
125 vidioc_int_s_parm_num,
129 * Strictly internal ioctls.
132 /* Initialise the device when slave attaches to the master. */
133 vidioc_int_dev_init_num = 1000,
134 /* Delinitialise the device at slave detach. */
135 vidioc_int_dev_exit_num,
136 /* Set device power state: 0 is off, non-zero is on. */
137 vidioc_int_s_power_num,
138 /* Get slave interface parameters. */
139 vidioc_int_g_ifparm_num,
140 /* Get external clock speed for current slave settings. */
141 vidioc_int_g_ext_clk_num,
143 * Tell what the generated interface clock speed actually is.
145 vidioc_int_s_ext_clk_num,
146 /* Does the slave need to be reset after VIDIOC_DQBUF? */
147 vidioc_int_g_needs_reset_num,
151 * VIDIOC_INT_* ioctls.
154 /* VIDIOC_INT_RESET */
155 vidioc_int_reset_num,
156 /* VIDIOC_INT_INIT */
158 /* VIDIOC_INT_G_CHIP_IDENT */
159 vidioc_int_g_chip_ident_num,
163 * Start of private ioctls.
166 vidioc_int_priv_start_num = 2000,
171 * IOCTL wrapper functions for better type checking.
175 #define V4L2_INT_WRAPPER_0(name) \
176 static inline int vidioc_int_##name(struct v4l2_int_device *d) \
178 return v4l2_int_ioctl_0(d, vidioc_int_##name##_num); \
181 static inline struct v4l2_int_ioctl_desc \
182 vidioc_int_##name##_cb(int (*func) \
183 (struct v4l2_int_device *)) \
185 struct v4l2_int_ioctl_desc desc; \
187 desc.num = vidioc_int_##name##_num; \
188 desc.func = (v4l2_int_ioctl_func *)func; \
193 #define V4L2_INT_WRAPPER_1(name, arg_type, asterisk) \
194 static inline int vidioc_int_##name(struct v4l2_int_device *d, \
195 arg_type asterisk arg) \
197 return v4l2_int_ioctl_1(d, vidioc_int_##name##_num, \
198 (void *)(unsigned long)arg); \
201 static inline struct v4l2_int_ioctl_desc \
202 vidioc_int_##name##_cb(int (*func) \
203 (struct v4l2_int_device *, \
204 arg_type asterisk)) \
206 struct v4l2_int_ioctl_desc desc; \
208 desc.num = vidioc_int_##name##_num; \
209 desc.func = (v4l2_int_ioctl_func *)func; \
214 V4L2_INT_WRAPPER_1(enum_fmt_cap, struct v4l2_fmtdesc, *);
215 V4L2_INT_WRAPPER_1(g_fmt_cap, struct v4l2_format, *);
216 V4L2_INT_WRAPPER_1(s_fmt_cap, struct v4l2_format, *);
217 V4L2_INT_WRAPPER_1(try_fmt_cap, struct v4l2_format, *);
218 V4L2_INT_WRAPPER_1(queryctrl, struct v4l2_queryctrl, *);
219 V4L2_INT_WRAPPER_1(g_ctrl, struct v4l2_control, *);
220 V4L2_INT_WRAPPER_1(s_ctrl, struct v4l2_control, *);
221 V4L2_INT_WRAPPER_1(g_parm, struct v4l2_streamparm, *);
222 V4L2_INT_WRAPPER_1(s_parm, struct v4l2_streamparm, *);
224 V4L2_INT_WRAPPER_0(dev_init);
225 V4L2_INT_WRAPPER_0(dev_exit);
226 V4L2_INT_WRAPPER_1(s_power, int, );
227 V4L2_INT_WRAPPER_1(g_ifparm, struct v4l2_ifparm, *);
228 V4L2_INT_WRAPPER_1(s_ext_clk, u32, );
229 V4L2_INT_WRAPPER_1(g_ext_clk, u32, *);
230 V4L2_INT_WRAPPER_1(g_needs_reset, void, *);
232 V4L2_INT_WRAPPER_0(reset);
233 V4L2_INT_WRAPPER_0(init);
234 V4L2_INT_WRAPPER_1(g_chip_ident, int, *);