v2.4.9.9 -> v2.4.9.10
[opensuse:kernel.git] / drivers / usb / pwc-ioctl.h
1 #ifndef PWC_IOCTL_H
2 #define PWC_IOCTL_H
3
4 /* (C) 2001 Nemosoft Unv.    webcam@smcc.demon.nl
5    
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19 */
20
21 /*
22    Changes
23    2001/08/03  Alvarado   Added ioctl constants to access methods for 
24                           changing white balance and red/blue gains
25  */
26
27 /* These are private ioctl() commands, specific for the Philips webcams.
28    They contain functions not found in other webcams, and settings not
29    specified in the Video4Linux API. 
30    
31    The #define names are built up like follows:
32    VIDIOC               VIDeo IOCtl prefix
33          PWC            Philps WebCam
34             G           optional: Get
35             S           optional: Set
36              ...        the function
37  */
38
39
40
41
42 /* The frame rate is encoded in the video_window.flags parameter using
43    the upper 16 bits, since some flags are defined nowadays. The following
44    defines provide a mask and shift to filter out this value.
45    
46    In 'Snapshot' mode the camera freezes its automatic exposure and colour 
47    balance controls.
48  */
49 #define PWC_FPS_SHIFT           16
50 #define PWC_FPS_MASK            0x00FF0000
51 #define PWC_FPS_FRMASK          0x003F0000
52 #define PWC_FPS_SNAPSHOT        0x00400000
53
54
55 /* pwc_whitebalance.mode values */
56 #define PWC_WB_INDOOR           0
57 #define PWC_WB_OUTDOOR          1
58 #define PWC_WB_FL               2
59 #define PWC_WB_MANUAL           3
60 #define PWC_WB_AUTO             4
61
62 /* Used with VIDIOCPWC[SG]AWB (Auto White Balance). 
63    Set mode to one of the PWC_WB_* values above.
64    *red and *blue are the respective gains of these colour components inside 
65    the camera; range 0..65535
66    When mode == PWC_WB_MANUAL, manual_red and manual_blue are set or read; 
67    otherwise undefined.
68    read_red and read_blue are read-only.
69 */   
70    
71 struct pwc_whitebalance
72 {
73         int mode;
74         int manual_red, manual_blue;    /* R/W */
75         int read_red, read_blue;        /* R/O */
76 };
77
78
79  /* Restore user settings */
80 #define VIDIOCPWCRUSER          _IO('v', 192)
81  /* Save user settings */
82 #define VIDIOCPWCSUSER          _IO('v', 193)
83  /* Restore factory settings */
84 #define VIDIOCPWCFACTORY        _IO('v', 194)
85
86  /* You can manipulate the compression factor. A compression preference of 0
87     means use uncompressed modes when available; 1 is low compression, 2 is
88     medium and 3 is high compression preferred. Of course, the higher the
89     compression, the lower the bandwidth used but more chance of artefacts
90     in the image. The driver automatically chooses a higher compression when
91     the preferred mode is not available.
92   */
93  /* Set preferred compression quality (0 = uncompressed, 3 = highest compression) */
94 #define VIDIOCPWCSCQUAL         _IOW('v', 195, int)
95  /* Get preferred compression quality */
96 #define VIDIOCPWCGCQUAL         _IOR('v', 195, int)
97
98  /* Set AGC (Automatic Gain Control); int < 0 = auto, 0..65535 = fixed */
99 #define VIDIOCPWCSAGC           _IOW('v', 200, int)
100  /* Get AGC; int < 0 = auto; >= 0 = fixed, range 0..65535 */
101 #define VIDIOCPWCGAGC           _IOR('v', 200, int)
102  /* Set shutter speed; int < 0 = auto; >= 0 = fixed, range 0..65535 */
103 #define VIDIOCPWCSSHUTTER       _IOW('v', 201, int)
104
105  /* Color compensation (Auto White Balance) */
106 #define VIDIOCPWCSAWB           _IOW('v', 202, struct pwc_whitebalance)
107 #define VIDIOCPWCGAWB           _IOR('v', 202, struct pwc_whitebalance)
108
109  /* Turn LED on/off ; int range 0..65535 */
110 #define VIDIOCPWCSLED           _IOW('v', 205, int)
111
112  /* Get state of LED; int range 0..65535 */
113 #define VIDIOCPWCGLED           _IOR('v', 205, int)
114
115 #endif