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