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