Commit | Line | Data |
---|---|---|
2b455db6 LS |
1 | #ifndef PWC_IOCTL_H |
2 | #define PWC_IOCTL_H | |
3 | ||
4 | /* (C) 2001-2004 Nemosoft Unv. | |
5 | (C) 2004-2006 Luc Saillard (luc@saillard.org) | |
6 | ||
7 | NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx | |
8 | driver and thus may have bugs that are not present in the original version. | |
9 | Please send bug reports and support requests to <luc@saillard.org>. | |
10 | The decompression routines have been implemented by reverse-engineering the | |
11 | Nemosoft binary pwcx module. Caveat emptor. | |
12 | ||
13 | This program is free software; you can redistribute it and/or modify | |
14 | it under the terms of the GNU General Public License as published by | |
15 | the Free Software Foundation; either version 2 of the License, or | |
16 | (at your option) any later version. | |
17 | ||
18 | This program is distributed in the hope that it will be useful, | |
19 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | GNU General Public License for more details. | |
22 | ||
23 | You should have received a copy of the GNU General Public License | |
24 | along with this program; if not, write to the Free Software | |
25 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
26 | */ | |
27 | ||
28 | /* This is pwc-ioctl.h belonging to PWC 10.0.10 | |
29 | It contains structures and defines to communicate from user space | |
30 | directly to the driver. | |
31 | */ | |
32 | ||
33 | /* | |
34 | Changes | |
35 | 2001/08/03 Alvarado Added ioctl constants to access methods for | |
36 | changing white balance and red/blue gains | |
37 | 2002/12/15 G. H. Fernandez-Toribio VIDIOCGREALSIZE | |
38 | 2003/12/13 Nemosft Unv. Some modifications to make interfacing to | |
39 | PWCX easier | |
40 | 2006/01/01 Luc Saillard Add raw format definition | |
41 | */ | |
42 | ||
43 | /* These are private ioctl() commands, specific for the Philips webcams. | |
44 | They contain functions not found in other webcams, and settings not | |
45 | specified in the Video4Linux API. | |
46 | ||
47 | The #define names are built up like follows: | |
48 | VIDIOC VIDeo IOCtl prefix | |
49 | PWC Philps WebCam | |
50 | G optional: Get | |
51 | S optional: Set | |
52 | ... the function | |
53 | */ | |
54 | ||
55 | #include <linux/types.h> | |
56 | #include <linux/version.h> | |
57 | ||
58 | ||
59 | /* Enumeration of image sizes */ | |
60 | #define PSZ_SQCIF 0x00 | |
61 | #define PSZ_QSIF 0x01 | |
62 | #define PSZ_QCIF 0x02 | |
63 | #define PSZ_SIF 0x03 | |
64 | #define PSZ_CIF 0x04 | |
65 | #define PSZ_VGA 0x05 | |
66 | #define PSZ_MAX 6 | |
67 | ||
68 | ||
69 | /* The frame rate is encoded in the video_window.flags parameter using | |
70 | the upper 16 bits, since some flags are defined nowadays. The following | |
71 | defines provide a mask and shift to filter out this value. | |
72 | This value can also be passing using the private flag when using v4l2 and | |
73 | VIDIOC_S_FMT ioctl. | |
74 | ||
75 | In 'Snapshot' mode the camera freezes its automatic exposure and colour | |
76 | balance controls. | |
77 | */ | |
78 | #define PWC_FPS_SHIFT 16 | |
79 | #define PWC_FPS_MASK 0x00FF0000 | |
80 | #define PWC_FPS_FRMASK 0x003F0000 | |
81 | #define PWC_FPS_SNAPSHOT 0x00400000 | |
82 | #define PWC_QLT_MASK 0x03000000 | |
83 | #define PWC_QLT_SHIFT 24 | |
84 | ||
85 | ||
86 | /* structure for transferring x & y coordinates */ | |
87 | struct pwc_coord | |
88 | { | |
89 | int x, y; /* guess what */ | |
90 | int size; /* size, or offset */ | |
91 | }; | |
92 | ||
93 | ||
94 | /* Used with VIDIOCPWCPROBE */ | |
95 | struct pwc_probe | |
96 | { | |
97 | char name[32]; | |
98 | int type; | |
99 | }; | |
100 | ||
101 | struct pwc_serial | |
102 | { | |
103 | char serial[30]; /* String with serial number. Contains terminating 0 */ | |
104 | }; | |
105 | ||
106 | /* pwc_whitebalance.mode values */ | |
107 | #define PWC_WB_INDOOR 0 | |
108 | #define PWC_WB_OUTDOOR 1 | |
109 | #define PWC_WB_FL 2 | |
110 | #define PWC_WB_MANUAL 3 | |
111 | #define PWC_WB_AUTO 4 | |
112 | ||
113 | /* Used with VIDIOCPWC[SG]AWB (Auto White Balance). | |
114 | Set mode to one of the PWC_WB_* values above. | |
115 | *red and *blue are the respective gains of these colour components inside | |
116 | the camera; range 0..65535 | |
117 | When 'mode' == PWC_WB_MANUAL, 'manual_red' and 'manual_blue' are set or read; | |
118 | otherwise undefined. | |
119 | 'read_red' and 'read_blue' are read-only. | |
120 | */ | |
121 | struct pwc_whitebalance | |
122 | { | |
123 | int mode; | |
124 | int manual_red, manual_blue; /* R/W */ | |
125 | int read_red, read_blue; /* R/O */ | |
126 | }; | |
127 | ||
128 | /* | |
129 | 'control_speed' and 'control_delay' are used in automatic whitebalance mode, | |
130 | and tell the camera how fast it should react to changes in lighting, and | |
131 | with how much delay. Valid values are 0..65535. | |
132 | */ | |
133 | struct pwc_wb_speed | |
134 | { | |
135 | int control_speed; | |
136 | int control_delay; | |
137 | ||
138 | }; | |
139 | ||
140 | /* Used with VIDIOCPWC[SG]LED */ | |
141 | struct pwc_leds | |
142 | { | |
143 | int led_on; /* Led on-time; range = 0..25000 */ | |
144 | int led_off; /* Led off-time; range = 0..25000 */ | |
145 | }; | |
146 | ||
147 | /* Image size (used with GREALSIZE) */ | |
148 | struct pwc_imagesize | |
149 | { | |
150 | int width; | |
151 | int height; | |
152 | }; | |
153 | ||
154 | /* Defines and structures for Motorized Pan & Tilt */ | |
155 | #define PWC_MPT_PAN 0x01 | |
156 | #define PWC_MPT_TILT 0x02 | |
157 | #define PWC_MPT_TIMEOUT 0x04 /* for status */ | |
158 | ||
159 | /* Set angles; when absolute != 0, the angle is absolute and the | |
160 | driver calculates the relative offset for you. This can only | |
161 | be used with VIDIOCPWCSANGLE; VIDIOCPWCGANGLE always returns | |
162 | absolute angles. | |
163 | */ | |
164 | struct pwc_mpt_angles | |
165 | { | |
166 | int absolute; /* write-only */ | |
167 | int pan; /* degrees * 100 */ | |
168 | int tilt; /* degress * 100 */ | |
169 | }; | |
170 | ||
171 | /* Range of angles of the camera, both horizontally and vertically. | |
172 | */ | |
173 | struct pwc_mpt_range | |
174 | { | |
175 | int pan_min, pan_max; /* degrees * 100 */ | |
176 | int tilt_min, tilt_max; | |
177 | }; | |
178 | ||
179 | struct pwc_mpt_status | |
180 | { | |
181 | int status; | |
182 | int time_pan; | |
183 | int time_tilt; | |
184 | }; | |
185 | ||
186 | ||
187 | /* This is used for out-of-kernel decompression. With it, you can get | |
188 | all the necessary information to initialize and use the decompressor | |
189 | routines in standalone applications. | |
190 | */ | |
191 | struct pwc_video_command | |
192 | { | |
193 | int type; /* camera type (645, 675, 730, etc.) */ | |
194 | int release; /* release number */ | |
195 | ||
196 | int size; /* one of PSZ_* */ | |
197 | int alternate; | |
198 | int command_len; /* length of USB video command */ | |
199 | unsigned char command_buf[13]; /* Actual USB video command */ | |
200 | int bandlength; /* >0 = compressed */ | |
201 | int frame_size; /* Size of one (un)compressed frame */ | |
202 | }; | |
203 | ||
204 | /* Flags for PWCX subroutines. Not all modules honour all flags. */ | |
205 | #define PWCX_FLAG_PLANAR 0x0001 | |
206 | #define PWCX_FLAG_BAYER 0x0008 | |
207 | ||
208 | ||
209 | /* IOCTL definitions */ | |
210 | ||
211 | /* Restore user settings */ | |
212 | #define VIDIOCPWCRUSER _IO('v', 192) | |
213 | /* Save user settings */ | |
214 | #define VIDIOCPWCSUSER _IO('v', 193) | |
215 | /* Restore factory settings */ | |
216 | #define VIDIOCPWCFACTORY _IO('v', 194) | |
217 | ||
218 | /* You can manipulate the compression factor. A compression preference of 0 | |
219 | means use uncompressed modes when available; 1 is low compression, 2 is | |
220 | medium and 3 is high compression preferred. Of course, the higher the | |
221 | compression, the lower the bandwidth used but more chance of artefacts | |
222 | in the image. The driver automatically chooses a higher compression when | |
223 | the preferred mode is not available. | |
224 | */ | |
225 | /* Set preferred compression quality (0 = uncompressed, 3 = highest compression) */ | |
226 | #define VIDIOCPWCSCQUAL _IOW('v', 195, int) | |
227 | /* Get preferred compression quality */ | |
228 | #define VIDIOCPWCGCQUAL _IOR('v', 195, int) | |
229 | ||
230 | ||
231 | /* Retrieve serial number of camera */ | |
232 | #define VIDIOCPWCGSERIAL _IOR('v', 198, struct pwc_serial) | |
233 | ||
234 | /* This is a probe function; since so many devices are supported, it | |
235 | becomes difficult to include all the names in programs that want to | |
236 | check for the enhanced Philips stuff. So in stead, try this PROBE; | |
237 | it returns a structure with the original name, and the corresponding | |
238 | Philips type. | |
239 | To use, fill the structure with zeroes, call PROBE and if that succeeds, | |
240 | compare the name with that returned from VIDIOCGCAP; they should be the | |
241 | same. If so, you can be assured it is a Philips (OEM) cam and the type | |
242 | is valid. | |
243 | */ | |
244 | #define VIDIOCPWCPROBE _IOR('v', 199, struct pwc_probe) | |
245 | ||
246 | /* Set AGC (Automatic Gain Control); int < 0 = auto, 0..65535 = fixed */ | |
247 | #define VIDIOCPWCSAGC _IOW('v', 200, int) | |
248 | /* Get AGC; int < 0 = auto; >= 0 = fixed, range 0..65535 */ | |
249 | #define VIDIOCPWCGAGC _IOR('v', 200, int) | |
250 | /* Set shutter speed; int < 0 = auto; >= 0 = fixed, range 0..65535 */ | |
251 | #define VIDIOCPWCSSHUTTER _IOW('v', 201, int) | |
252 | ||
253 | /* Color compensation (Auto White Balance) */ | |
254 | #define VIDIOCPWCSAWB _IOW('v', 202, struct pwc_whitebalance) | |
255 | #define VIDIOCPWCGAWB _IOR('v', 202, struct pwc_whitebalance) | |
256 | ||
257 | /* Auto WB speed */ | |
258 | #define VIDIOCPWCSAWBSPEED _IOW('v', 203, struct pwc_wb_speed) | |
259 | #define VIDIOCPWCGAWBSPEED _IOR('v', 203, struct pwc_wb_speed) | |
260 | ||
261 | /* LEDs on/off/blink; int range 0..65535 */ | |
262 | #define VIDIOCPWCSLED _IOW('v', 205, struct pwc_leds) | |
263 | #define VIDIOCPWCGLED _IOR('v', 205, struct pwc_leds) | |
264 | ||
265 | /* Contour (sharpness); int < 0 = auto, 0..65536 = fixed */ | |
266 | #define VIDIOCPWCSCONTOUR _IOW('v', 206, int) | |
267 | #define VIDIOCPWCGCONTOUR _IOR('v', 206, int) | |
268 | ||
269 | /* Backlight compensation; 0 = off, otherwise on */ | |
270 | #define VIDIOCPWCSBACKLIGHT _IOW('v', 207, int) | |
271 | #define VIDIOCPWCGBACKLIGHT _IOR('v', 207, int) | |
272 | ||
273 | /* Flickerless mode; = 0 off, otherwise on */ | |
274 | #define VIDIOCPWCSFLICKER _IOW('v', 208, int) | |
275 | #define VIDIOCPWCGFLICKER _IOR('v', 208, int) | |
276 | ||
277 | /* Dynamic noise reduction; 0 off, 3 = high noise reduction */ | |
278 | #define VIDIOCPWCSDYNNOISE _IOW('v', 209, int) | |
279 | #define VIDIOCPWCGDYNNOISE _IOR('v', 209, int) | |
280 | ||
281 | /* Real image size as used by the camera; tells you whether or not there's a gray border around the image */ | |
282 | #define VIDIOCPWCGREALSIZE _IOR('v', 210, struct pwc_imagesize) | |
283 | ||
284 | /* Motorized pan & tilt functions */ | |
285 | #define VIDIOCPWCMPTRESET _IOW('v', 211, int) | |
286 | #define VIDIOCPWCMPTGRANGE _IOR('v', 211, struct pwc_mpt_range) | |
287 | #define VIDIOCPWCMPTSANGLE _IOW('v', 212, struct pwc_mpt_angles) | |
288 | #define VIDIOCPWCMPTGANGLE _IOR('v', 212, struct pwc_mpt_angles) | |
289 | #define VIDIOCPWCMPTSTATUS _IOR('v', 213, struct pwc_mpt_status) | |
290 | ||
291 | /* Get the USB set-video command; needed for initializing libpwcx */ | |
292 | #define VIDIOCPWCGVIDCMD _IOR('v', 215, struct pwc_video_command) | |
293 | struct pwc_table_init_buffer { | |
294 | int len; | |
295 | char *buffer; | |
296 | ||
297 | }; | |
298 | #define VIDIOCPWCGVIDTABLE _IOR('v', 216, struct pwc_table_init_buffer) | |
299 | ||
300 | /* | |
301 | * This is private command used when communicating with v4l2. | |
302 | * In the future all private ioctl will be remove/replace to | |
303 | * use interface offer by v4l2. | |
304 | */ | |
305 | ||
306 | #define V4L2_CID_PRIVATE_SAVE_USER (V4L2_CID_PRIVATE_BASE + 0) | |
307 | #define V4L2_CID_PRIVATE_RESTORE_USER (V4L2_CID_PRIVATE_BASE + 1) | |
308 | #define V4L2_CID_PRIVATE_RESTORE_FACTORY (V4L2_CID_PRIVATE_BASE + 2) | |
309 | #define V4L2_CID_PRIVATE_COLOUR_MODE (V4L2_CID_PRIVATE_BASE + 3) | |
310 | #define V4L2_CID_PRIVATE_AUTOCONTOUR (V4L2_CID_PRIVATE_BASE + 4) | |
311 | #define V4L2_CID_PRIVATE_CONTOUR (V4L2_CID_PRIVATE_BASE + 5) | |
312 | #define V4L2_CID_PRIVATE_BACKLIGHT (V4L2_CID_PRIVATE_BASE + 6) | |
313 | #define V4L2_CID_PRIVATE_FLICKERLESS (V4L2_CID_PRIVATE_BASE + 7) | |
314 | #define V4L2_CID_PRIVATE_NOISE_REDUCTION (V4L2_CID_PRIVATE_BASE + 8) | |
315 | ||
316 | struct pwc_raw_frame { | |
317 | __le16 type; /* type of the webcam */ | |
318 | __le16 vbandlength; /* Size of 4lines compressed (used by the decompressor) */ | |
319 | __u8 cmd[4]; /* the four byte of the command (in case of nala, | |
320 | only the first 3 bytes is filled) */ | |
321 | __u8 rawframe[0]; /* frame_size = H/4*vbandlength */ | |
322 | } __attribute__ ((packed)); | |
323 | ||
324 | ||
325 | #endif |