Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/roland...
[linux-2.6] / include / media / v4l2-int-device.h
1 /*
2  * include/media/v4l2-int-device.h
3  *
4  * V4L2 internal ioctl interface.
5  *
6  * Copyright (C) 2007 Nokia Corporation.
7  *
8  * Contact: Sakari Ailus <sakari.ailus@nokia.com>
9  *
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.
13  *
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.
18  *
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
22  * 02110-1301 USA
23  */
24
25 #ifndef V4L2_INT_DEVICE_H
26 #define V4L2_INT_DEVICE_H
27
28 #include <linux/module.h>
29 #include <media/v4l2-common.h>
30
31 #define V4L2NAMESIZE 32
32
33 /*
34  *
35  * The internal V4L2 device interface core.
36  *
37  */
38
39 enum v4l2_int_type {
40         v4l2_int_type_master = 1,
41         v4l2_int_type_slave
42 };
43
44 struct v4l2_int_device;
45
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);
50 };
51
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 *);
55
56 struct v4l2_int_ioctl_desc {
57         int num;
58         v4l2_int_ioctl_func *func;
59 };
60
61 struct v4l2_int_slave {
62         /* Don't touch master. */
63         struct v4l2_int_device *master;
64
65         char attach_to[V4L2NAMESIZE];
66
67         int num_ioctls;
68         struct v4l2_int_ioctl_desc *ioctls;
69 };
70
71 struct v4l2_int_device {
72         /* Don't touch head. */
73         struct list_head head;
74
75         struct module *module;
76
77         char name[V4L2NAMESIZE];
78
79         enum v4l2_int_type type;
80         union {
81                 struct v4l2_int_master *master;
82                 struct v4l2_int_slave *slave;
83         } u;
84
85         void *priv;
86 };
87
88 int v4l2_int_device_register(struct v4l2_int_device *d);
89 void v4l2_int_device_unregister(struct v4l2_int_device *d);
90
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);
93
94 /*
95  *
96  * Types and definitions for IOCTL commands.
97  *
98  */
99
100 /* Slave interface type. */
101 enum v4l2_if_type {
102         /*
103          * Parallel 8-, 10- or 12-bit interface, used by for example
104          * on certain image sensors.
105          */
106         V4L2_IF_TYPE_BT656,
107 };
108
109 enum v4l2_if_type_bt656_mode {
110         /*
111          * Modes without Bt synchronisation codes. Separate
112          * synchronisation signal lines are used.
113          */
114         V4L2_IF_TYPE_BT656_MODE_NOBT_8BIT,
115         V4L2_IF_TYPE_BT656_MODE_NOBT_10BIT,
116         V4L2_IF_TYPE_BT656_MODE_NOBT_12BIT,
117         /*
118          * Use Bt synchronisation codes. The vertical and horizontal
119          * synchronisation is done based on synchronisation codes.
120          */
121         V4L2_IF_TYPE_BT656_MODE_BT_8BIT,
122         V4L2_IF_TYPE_BT656_MODE_BT_10BIT,
123 };
124
125 struct v4l2_if_type_bt656 {
126         /*
127          * 0: Frame begins when vsync is high.
128          * 1: Frame begins when vsync changes from low to high.
129          */
130         unsigned frame_start_on_rising_vs:1;
131         /* Use Bt synchronisation codes for sync correction. */
132         unsigned bt_sync_correct:1;
133         /* Swap every two adjacent image data elements. */
134         unsigned swap:1;
135         /* Inverted latch clock polarity from slave. */
136         unsigned latch_clk_inv:1;
137         /* Hs polarity. 0 is active high, 1 active low. */
138         unsigned nobt_hs_inv:1;
139         /* Vs polarity. 0 is active high, 1 active low. */
140         unsigned nobt_vs_inv:1;
141         enum v4l2_if_type_bt656_mode mode;
142         /* Minimum accepted bus clock for slave (in Hz). */
143         u32 clock_min;
144         /* Maximum accepted bus clock for slave. */
145         u32 clock_max;
146         /*
147          * Current wish of the slave. May only change in response to
148          * ioctls that affect image capture.
149          */
150         u32 clock_curr;
151 };
152
153 struct v4l2_ifparm {
154         enum v4l2_if_type if_type;
155         union {
156                 struct v4l2_if_type_bt656 bt656;
157         } u;
158 };
159
160 /* IOCTL command numbers. */
161 enum v4l2_int_ioctl_num {
162         /*
163          *
164          * "Proper" V4L ioctls, as in struct video_device.
165          *
166          */
167         vidioc_int_enum_fmt_cap_num = 1,
168         vidioc_int_g_fmt_cap_num,
169         vidioc_int_s_fmt_cap_num,
170         vidioc_int_try_fmt_cap_num,
171         vidioc_int_queryctrl_num,
172         vidioc_int_g_ctrl_num,
173         vidioc_int_s_ctrl_num,
174         vidioc_int_g_parm_num,
175         vidioc_int_s_parm_num,
176
177         /*
178          *
179          * Strictly internal ioctls.
180          *
181          */
182         /* Initialise the device when slave attaches to the master. */
183         vidioc_int_dev_init_num = 1000,
184         /* Delinitialise the device at slave detach. */
185         vidioc_int_dev_exit_num,
186         /* Set device power state: 0 is off, non-zero is on. */
187         vidioc_int_s_power_num,
188         /* Get slave interface parameters. */
189         vidioc_int_g_ifparm_num,
190         /* Does the slave need to be reset after VIDIOC_DQBUF? */
191         vidioc_int_g_needs_reset_num,
192
193         /*
194          *
195          * VIDIOC_INT_* ioctls.
196          *
197          */
198         /* VIDIOC_INT_RESET */
199         vidioc_int_reset_num,
200         /* VIDIOC_INT_INIT */
201         vidioc_int_init_num,
202         /* VIDIOC_INT_G_CHIP_IDENT */
203         vidioc_int_g_chip_ident_num,
204
205         /*
206          *
207          * Start of private ioctls.
208          *
209          */
210         vidioc_int_priv_start_num = 2000,
211 };
212
213 /*
214  *
215  * IOCTL wrapper functions for better type checking.
216  *
217  */
218
219 #define V4L2_INT_WRAPPER_0(name)                                        \
220         static inline int vidioc_int_##name(struct v4l2_int_device *d)  \
221         {                                                               \
222                 return v4l2_int_ioctl_0(d, vidioc_int_##name##_num);    \
223         }                                                               \
224                                                                         \
225         static inline struct v4l2_int_ioctl_desc                        \
226         vidioc_int_##name##_cb(int (*func)                              \
227                                (struct v4l2_int_device *))              \
228         {                                                               \
229                 struct v4l2_int_ioctl_desc desc;                        \
230                                                                         \
231                 desc.num = vidioc_int_##name##_num;                     \
232                 desc.func = (v4l2_int_ioctl_func *)func;                \
233                                                                         \
234                 return desc;                                            \
235         }
236
237 #define V4L2_INT_WRAPPER_1(name, arg_type, asterisk)                    \
238         static inline int vidioc_int_##name(struct v4l2_int_device *d,  \
239                                             arg_type asterisk arg)      \
240         {                                                               \
241                 return v4l2_int_ioctl_1(d, vidioc_int_##name##_num,     \
242                                         (void *)(unsigned long)arg);    \
243         }                                                               \
244                                                                         \
245         static inline struct v4l2_int_ioctl_desc                        \
246         vidioc_int_##name##_cb(int (*func)                              \
247                                (struct v4l2_int_device *,               \
248                                 arg_type asterisk))                     \
249         {                                                               \
250                 struct v4l2_int_ioctl_desc desc;                        \
251                                                                         \
252                 desc.num = vidioc_int_##name##_num;                     \
253                 desc.func = (v4l2_int_ioctl_func *)func;                \
254                                                                         \
255                 return desc;                                            \
256         }
257
258 V4L2_INT_WRAPPER_1(enum_fmt_cap, struct v4l2_fmtdesc, *);
259 V4L2_INT_WRAPPER_1(g_fmt_cap, struct v4l2_format, *);
260 V4L2_INT_WRAPPER_1(s_fmt_cap, struct v4l2_format, *);
261 V4L2_INT_WRAPPER_1(try_fmt_cap, struct v4l2_format, *);
262 V4L2_INT_WRAPPER_1(queryctrl, struct v4l2_queryctrl, *);
263 V4L2_INT_WRAPPER_1(g_ctrl, struct v4l2_control, *);
264 V4L2_INT_WRAPPER_1(s_ctrl, struct v4l2_control, *);
265 V4L2_INT_WRAPPER_1(g_parm, struct v4l2_streamparm, *);
266 V4L2_INT_WRAPPER_1(s_parm, struct v4l2_streamparm, *);
267
268 V4L2_INT_WRAPPER_0(dev_init);
269 V4L2_INT_WRAPPER_0(dev_exit);
270 V4L2_INT_WRAPPER_1(s_power, int, );
271 V4L2_INT_WRAPPER_1(g_ifparm, struct v4l2_ifparm, *);
272 V4L2_INT_WRAPPER_1(g_needs_reset, void, *);
273
274 V4L2_INT_WRAPPER_0(reset);
275 V4L2_INT_WRAPPER_0(init);
276 V4L2_INT_WRAPPER_1(g_chip_ident, int, *);
277
278 #endif