aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans de Goede <hdegoede@redhat.com>2012-11-29 05:06:22 -0500
committerMauro Carvalho Chehab <mchehab@redhat.com>2012-12-21 10:35:58 -0500
commit23e8321624076317e9ffd6df949a5a3a5e59b448 (patch)
tree0049d61bef22fe85e288e13a80274ef58c26fa49
parent7a29ee2e37b3f9675f46c87998c67b68c315c54a (diff)
[media] Documentation/media: Remove docs for obsoleted and removed v4l1 drivers
When the v4l1 drivers were removed, there docs were forgotten. Signed-off-by: Hans de Goede <hdegoede@redhat.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
-rw-r--r--Documentation/video4linux/et61x251.txt315
-rw-r--r--Documentation/video4linux/ibmcam.txt323
-rw-r--r--Documentation/video4linux/m5602.txt12
-rw-r--r--Documentation/video4linux/ov511.txt288
-rw-r--r--Documentation/video4linux/se401.txt54
-rw-r--r--Documentation/video4linux/stv680.txt53
-rw-r--r--Documentation/video4linux/w9968cf.txt458
-rw-r--r--Documentation/video4linux/zc0301.txt270
8 files changed, 0 insertions, 1773 deletions
diff --git a/Documentation/video4linux/et61x251.txt b/Documentation/video4linux/et61x251.txt
deleted file mode 100644
index e0cdae491858..000000000000
--- a/Documentation/video4linux/et61x251.txt
+++ /dev/null
@@ -1,315 +0,0 @@
1
2 ET61X[12]51 PC Camera Controllers
3 Driver for Linux
4 =================================
5
6 - Documentation -
7
8
9Index
10=====
111. Copyright
122. Disclaimer
133. License
144. Overview and features
155. Module dependencies
166. Module loading
177. Module parameters
188. Optional device control through "sysfs"
199. Supported devices
2010. Notes for V4L2 application developers
2111. Contact information
22
23
241. Copyright
25============
26Copyright (C) 2006-2007 by Luca Risolia <luca.risolia@studio.unibo.it>
27
28
292. Disclaimer
30=============
31Etoms is a trademark of Etoms Electronics Corp.
32This software is not developed or sponsored by Etoms Electronics.
33
34
353. License
36==========
37This program is free software; you can redistribute it and/or modify
38it under the terms of the GNU General Public License as published by
39the Free Software Foundation; either version 2 of the License, or
40(at your option) any later version.
41
42This program is distributed in the hope that it will be useful,
43but WITHOUT ANY WARRANTY; without even the implied warranty of
44MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45GNU General Public License for more details.
46
47You should have received a copy of the GNU General Public License
48along with this program; if not, write to the Free Software
49Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
50
51
524. Overview and features
53========================
54This driver supports the video interface of the devices mounting the ET61X151
55or ET61X251 PC Camera Controllers.
56
57It's worth to note that Etoms Electronics has never collaborated with the
58author during the development of this project; despite several requests,
59Etoms Electronics also refused to release enough detailed specifications of
60the video compression engine.
61
62The driver relies on the Video4Linux2 and USB core modules. It has been
63designed to run properly on SMP systems as well.
64
65The latest version of the ET61X[12]51 driver can be found at the following URL:
66http://www.linux-projects.org/
67
68Some of the features of the driver are:
69
70- full compliance with the Video4Linux2 API (see also "Notes for V4L2
71 application developers" paragraph);
72- available mmap or read/poll methods for video streaming through isochronous
73 data transfers;
74- automatic detection of image sensor;
75- support for any window resolutions and optional panning within the maximum
76 pixel area of image sensor;
77- image downscaling with arbitrary scaling factors from 1 and 2 in both
78 directions (see "Notes for V4L2 application developers" paragraph);
79- two different video formats for uncompressed or compressed data in low or
80 high compression quality (see also "Notes for V4L2 application developers"
81 paragraph);
82- full support for the capabilities of every possible image sensors that can
83 be connected to the ET61X[12]51 bridges, including, for instance, red, green,
84 blue and global gain adjustments and exposure control (see "Supported
85 devices" paragraph for details);
86- use of default color settings for sunlight conditions;
87- dynamic I/O interface for both ET61X[12]51 and image sensor control (see
88 "Optional device control through 'sysfs'" paragraph);
89- dynamic driver control thanks to various module parameters (see "Module
90 parameters" paragraph);
91- up to 64 cameras can be handled at the same time; they can be connected and
92 disconnected from the host many times without turning off the computer, if
93 the system supports hotplugging;
94- no known bugs.
95
96
975. Module dependencies
98======================
99For it to work properly, the driver needs kernel support for Video4Linux and
100USB.
101
102The following options of the kernel configuration file must be enabled and
103corresponding modules must be compiled:
104
105 # Multimedia devices
106 #
107 CONFIG_VIDEO_DEV=m
108
109To enable advanced debugging functionality on the device through /sysfs:
110
111 # Multimedia devices
112 #
113 CONFIG_VIDEO_ADV_DEBUG=y
114
115 # USB support
116 #
117 CONFIG_USB=m
118
119In addition, depending on the hardware being used, the modules below are
120necessary:
121
122 # USB Host Controller Drivers
123 #
124 CONFIG_USB_EHCI_HCD=m
125 CONFIG_USB_UHCI_HCD=m
126 CONFIG_USB_OHCI_HCD=m
127
128And finally:
129
130 # USB Multimedia devices
131 #
132 CONFIG_USB_ET61X251=m
133
134
1356. Module loading
136=================
137To use the driver, it is necessary to load the "et61x251" module into memory
138after every other module required: "videodev", "v4l2_common", "compat_ioctl32",
139"usbcore" and, depending on the USB host controller you have, "ehci-hcd",
140"uhci-hcd" or "ohci-hcd".
141
142Loading can be done as shown below:
143
144 [root@localhost home]# modprobe et61x251
145
146At this point the devices should be recognized. You can invoke "dmesg" to
147analyze kernel messages and verify that the loading process has gone well:
148
149 [user@localhost home]$ dmesg
150
151
1527. Module parameters
153====================
154Module parameters are listed below:
155-------------------------------------------------------------------------------
156Name: video_nr
157Type: short array (min = 0, max = 64)
158Syntax: <-1|n[,...]>
159Description: Specify V4L2 minor mode number:
160 -1 = use next available
161 n = use minor number n
162 You can specify up to 64 cameras this way.
163 For example:
164 video_nr=-1,2,-1 would assign minor number 2 to the second
165 registered camera and use auto for the first one and for every
166 other camera.
167Default: -1
168-------------------------------------------------------------------------------
169Name: force_munmap
170Type: bool array (min = 0, max = 64)
171Syntax: <0|1[,...]>
172Description: Force the application to unmap previously mapped buffer memory
173 before calling any VIDIOC_S_CROP or VIDIOC_S_FMT ioctl's. Not
174 all the applications support this feature. This parameter is
175 specific for each detected camera.
176 0 = do not force memory unmapping
177 1 = force memory unmapping (save memory)
178Default: 0
179-------------------------------------------------------------------------------
180Name: frame_timeout
181Type: uint array (min = 0, max = 64)
182Syntax: <n[,...]>
183Description: Timeout for a video frame in seconds. This parameter is
184 specific for each detected camera. This parameter can be
185 changed at runtime thanks to the /sys filesystem interface.
186Default: 2
187-------------------------------------------------------------------------------
188Name: debug
189Type: ushort
190Syntax: <n>
191Description: Debugging information level, from 0 to 3:
192 0 = none (use carefully)
193 1 = critical errors
194 2 = significant information
195 3 = more verbose messages
196 Level 3 is useful for testing only, when only one device
197 is used at the same time. It also shows some more information
198 about the hardware being detected. This module parameter can be
199 changed at runtime thanks to the /sys filesystem interface.
200Default: 2
201-------------------------------------------------------------------------------
202
203
2048. Optional device control through "sysfs"
205==========================================
206If the kernel has been compiled with the CONFIG_VIDEO_ADV_DEBUG option enabled,
207it is possible to read and write both the ET61X[12]51 and the image sensor
208registers by using the "sysfs" filesystem interface.
209
210There are four files in the /sys/class/video4linux/videoX directory for each
211registered camera: "reg", "val", "i2c_reg" and "i2c_val". The first two files
212control the ET61X[12]51 bridge, while the other two control the sensor chip.
213"reg" and "i2c_reg" hold the values of the current register index where the
214following reading/writing operations are addressed at through "val" and
215"i2c_val". Their use is not intended for end-users, unless you know what you
216are doing. Remember that you must be logged in as root before writing to them.
217
218As an example, suppose we were to want to read the value contained in the
219register number 1 of the sensor register table - which is usually the product
220identifier - of the camera registered as "/dev/video0":
221
222 [root@localhost #] cd /sys/class/video4linux/video0
223 [root@localhost #] echo 1 > i2c_reg
224 [root@localhost #] cat i2c_val
225
226Note that if the sensor registers cannot be read, "cat" will fail.
227To avoid race conditions, all the I/O accesses to the files are serialized.
228
229
2309. Supported devices
231====================
232None of the names of the companies as well as their products will be mentioned
233here. They have never collaborated with the author, so no advertising.
234
235From the point of view of a driver, what unambiguously identify a device are
236its vendor and product USB identifiers. Below is a list of known identifiers of
237devices mounting the ET61X[12]51 PC camera controllers:
238
239Vendor ID Product ID
240--------- ----------
2410x102c 0x6151
2420x102c 0x6251
2430x102c 0x6253
2440x102c 0x6254
2450x102c 0x6255
2460x102c 0x6256
2470x102c 0x6257
2480x102c 0x6258
2490x102c 0x6259
2500x102c 0x625a
2510x102c 0x625b
2520x102c 0x625c
2530x102c 0x625d
2540x102c 0x625e
2550x102c 0x625f
2560x102c 0x6260
2570x102c 0x6261
2580x102c 0x6262
2590x102c 0x6263
2600x102c 0x6264
2610x102c 0x6265
2620x102c 0x6266
2630x102c 0x6267
2640x102c 0x6268
2650x102c 0x6269
266
267The following image sensors are supported:
268
269Model Manufacturer
270----- ------------
271TAS5130D1B Taiwan Advanced Sensor Corporation
272
273All the available control settings of each image sensor are supported through
274the V4L2 interface.
275
276
27710. Notes for V4L2 application developers
278=========================================
279This driver follows the V4L2 API specifications. In particular, it enforces two
280rules:
281
282- exactly one I/O method, either "mmap" or "read", is associated with each
283file descriptor. Once it is selected, the application must close and reopen the
284device to switch to the other I/O method;
285
286- although it is not mandatory, previously mapped buffer memory should always
287be unmapped before calling any "VIDIOC_S_CROP" or "VIDIOC_S_FMT" ioctl's.
288The same number of buffers as before will be allocated again to match the size
289of the new video frames, so you have to map the buffers again before any I/O
290attempts on them.
291
292Consistently with the hardware limits, this driver also supports image
293downscaling with arbitrary scaling factors from 1 and 2 in both directions.
294However, the V4L2 API specifications don't correctly define how the scaling
295factor can be chosen arbitrarily by the "negotiation" of the "source" and
296"target" rectangles. To work around this flaw, we have added the convention
297that, during the negotiation, whenever the "VIDIOC_S_CROP" ioctl is issued, the
298scaling factor is restored to 1.
299
300This driver supports two different video formats: the first one is the "8-bit
301Sequential Bayer" format and can be used to obtain uncompressed video data
302from the device through the current I/O method, while the second one provides
303"raw" compressed video data (without frame headers not related to the
304compressed data). The current compression quality may vary from 0 to 1 and can
305be selected or queried thanks to the VIDIOC_S_JPEGCOMP and VIDIOC_G_JPEGCOMP
306V4L2 ioctl's.
307
308
30911. Contact information
310=======================
311The author may be contacted by e-mail at <luca.risolia@studio.unibo.it>.
312
313GPG/PGP encrypted e-mail's are accepted. The GPG key ID of the author is
314'FCE635A4'; the public 1024-bit key should be available at any keyserver;
315the fingerprint is: '88E8 F32F 7244 68BA 3958 5D40 99DA 5D2A FCE6 35A4'.
diff --git a/Documentation/video4linux/ibmcam.txt b/Documentation/video4linux/ibmcam.txt
deleted file mode 100644
index a51055211e62..000000000000
--- a/Documentation/video4linux/ibmcam.txt
+++ /dev/null
@@ -1,323 +0,0 @@
1README for Linux device driver for the IBM "C-It" USB video camera
2
3INTRODUCTION:
4
5This driver does not use all features known to exist in
6the IBM camera. However most of needed features work well.
7
8This driver was developed using logs of observed USB traffic
9which was produced by standard Windows driver (c-it98.sys).
10I did not have data sheets from Xirlink.
11
12Video formats:
13 128x96 [model 1]
14 176x144
15 320x240 [model 2]
16 352x240 [model 2]
17 352x288
18Frame rate: 3 - 30 frames per second (FPS)
19External interface: USB
20Internal interface: Video For Linux (V4L)
21Supported controls:
22- by V4L: Contrast, Brightness, Color, Hue
23- by driver options: frame rate, lighting conditions, video format,
24 default picture settings, sharpness.
25
26SUPPORTED CAMERAS:
27
28Xirlink "C-It" camera, also known as "IBM PC Camera".
29The device uses proprietary ASIC (and compression method);
30it is manufactured by Xirlink. See http://xirlinkwebcam.sourceforge.net,
31http://www.ibmpccamera.com, or http://www.c-itnow.com/ for details and pictures.
32
33This very chipset ("X Chip", as marked at the factory)
34is used in several other cameras, and they are supported
35as well:
36
37- IBM NetCamera
38- Veo Stingray
39
40The Linux driver was developed with camera with following
41model number (or FCC ID): KSX-XVP510. This camera has three
42interfaces, each with one endpoint (control, iso, iso). This
43type of cameras is referred to as "model 1". These cameras are
44no longer manufactured.
45
46Xirlink now manufactures new cameras which are somewhat different.
47In particular, following models [FCC ID] belong to that category:
48
49XVP300 [KSX-X9903]
50XVP600 [KSX-X9902]
51XVP610 [KSX-X9902]
52
53(see http://www.xirlink.com/ibmpccamera/ for updates, they refer
54to these new cameras by Windows driver dated 12-27-99, v3005 BETA)
55These cameras have two interfaces, one endpoint in each (iso, bulk).
56Such type of cameras is referred to as "model 2". They are supported
57(with exception of 352x288 native mode).
58
59Some IBM NetCameras (Model 4) are made to generate only compressed
60video streams. This is great for performance, but unfortunately
61nobody knows how to decompress the stream :-( Therefore, these
62cameras are *unsupported* and if you try to use one of those, all
63you get is random colored horizontal streaks, not the image!
64If you have one of those cameras, you probably should return it
65to the store and get something that is supported.
66
67Tell me more about all that "model" business
68--------------------------------------------
69
70I just invented model numbers to uniquely identify flavors of the
71hardware/firmware that were sold. It was very confusing to use
72brand names or some other internal numbering schemes. So I found
73by experimentation that all Xirlink chipsets fall into four big
74classes, and I called them "models". Each model is programmed in
75its own way, and each model sends back the video in its own way.
76
77Quirks of Model 2 cameras:
78-------------------------
79
80Model 2 does not have hardware contrast control. Corresponding V4L
81control is implemented in software, which is not very nice to your
82CPU, but at least it works.
83
84This driver provides 352x288 mode by switching the camera into
85quasi-352x288 RGB mode (800 Kbits per frame) essentially limiting
86this mode to 10 frames per second or less, in ideal conditions on
87the bus (USB is shared, after all). The frame rate
88has to be programmed very conservatively. Additional concern is that
89frame rate depends on brightness setting; therefore the picture can
90be good at one brightness and broken at another! I did not want to fix
91the frame rate at slowest setting, but I had to move it pretty much down
92the scale (so that framerate option barely matters). I also noticed that
93camera after first powering up produces frames slightly faster than during
94consecutive uses. All this means that if you use 352x288 (which is
95default), be warned - you may encounter broken picture on first connect;
96try to adjust brightness - brighter image is slower, so USB will be able
97to send all data. However if you regularly use Model 2 cameras you may
98prefer 176x144 which makes perfectly good I420, with no scaling and
99lesser demands on USB (300 Kbits per second, or 26 frames per second).
100
101Another strange effect of 352x288 mode is the fine vertical grid visible
102on some colored surfaces. I am sure it is caused by me not understanding
103what the camera is trying to say. Blame trade secrets for that.
104
105The camera that I had also has a hardware quirk: if disconnected,
106it needs few minutes to "relax" before it can be plugged in again
107(poorly designed USB processor reset circuit?)
108
109[Veo Stingray with Product ID 0x800C is also Model 2, but I haven't
110observed this particular flaw in it.]
111
112Model 2 camera can be programmed for very high sensitivity (even starlight
113may be enough), this makes it convenient for tinkering with. The driver
114code has enough comments to help a programmer to tweak the camera
115as s/he feels necessary.
116
117WHAT YOU NEED:
118
119- A supported IBM PC (C-it) camera (model 1 or 2)
120
121- A Linux box with USB support (2.3/2.4; 2.2 w/backport may work)
122
123- A Video4Linux compatible frame grabber program such as xawtv.
124
125HOW TO COMPILE THE DRIVER:
126
127You need to compile the driver only if you are a developer
128or if you want to make changes to the code. Most distributions
129precompile all modules, so you can go directly to the next
130section "HOW TO USE THE DRIVER".
131
132The ibmcam driver uses usbvideo helper library (module),
133so if you are studying the ibmcam code you will be led there.
134
135The driver itself consists of only one file in usb/ directory:
136ibmcam.c. This file is included into the Linux kernel build
137process if you configure the kernel for CONFIG_USB_IBMCAM.
138Run "make xconfig" and in USB section you will find the IBM
139camera driver. Select it, save the configuration and recompile.
140
141HOW TO USE THE DRIVER:
142
143I recommend to compile driver as a module. This gives you an
144easier access to its configuration. The camera has many more
145settings than V4L can operate, so some settings are done using
146module options.
147
148To begin with, on most modern Linux distributions the driver
149will be automatically loaded whenever you plug the supported
150camera in. Therefore, you don't need to do anything. However
151if you want to experiment with some module parameters then
152you can load and unload the driver manually, with camera
153plugged in or unplugged.
154
155Typically module is installed with command 'modprobe', like this:
156
157# modprobe ibmcam framerate=1
158
159Alternatively you can use 'insmod' in similar fashion:
160
161# insmod /lib/modules/2.x.y/usb/ibmcam.o framerate=1
162
163Module can be inserted with camera connected or disconnected.
164
165The driver can have options, though some defaults are provided.
166
167Driver options: (* indicates that option is model-dependent)
168
169Name Type Range [default] Example
170-------------- -------------- -------------- ------------------
171debug Integer 0-9 [0] debug=1
172flags Integer 0-0xFF [0] flags=0x0d
173framerate Integer 0-6 [2] framerate=1
174hue_correction Integer 0-255 [128] hue_correction=115
175init_brightness Integer 0-255 [128] init_brightness=100
176init_contrast Integer 0-255 [192] init_contrast=200
177init_color Integer 0-255 [128] init_color=130
178init_hue Integer 0-255 [128] init_hue=115
179lighting Integer 0-2* [1] lighting=2
180sharpness Integer 0-6* [4] sharpness=3
181size Integer 0-2* [2] size=1
182
183Options for Model 2 only:
184
185Name Type Range [default] Example
186-------------- -------------- -------------- ------------------
187init_model2_rg Integer 0..255 [0x70] init_model2_rg=128
188init_model2_rg2 Integer 0..255 [0x2f] init_model2_rg2=50
189init_model2_sat Integer 0..255 [0x34] init_model2_sat=65
190init_model2_yb Integer 0..255 [0xa0] init_model2_yb=200
191
192debug You don't need this option unless you are a developer.
193 If you are a developer then you will see in the code
194 what values do what. 0=off.
195
196flags This is a bit mask, and you can combine any number of
197 bits to produce what you want. Usually you don't want
198 any of extra features this option provides:
199
200 FLAGS_RETRY_VIDIOCSYNC 1 This bit allows to retry failed
201 VIDIOCSYNC ioctls without failing.
202 Will work with xawtv, will not
203 with xrealproducer. Default is
204 not set.
205 FLAGS_MONOCHROME 2 Activates monochrome (b/w) mode.
206 FLAGS_DISPLAY_HINTS 4 Shows colored pixels which have
207 magic meaning to developers.
208 FLAGS_OVERLAY_STATS 8 Shows tiny numbers on screen,
209 useful only for debugging.
210 FLAGS_FORCE_TESTPATTERN 16 Shows blue screen with numbers.
211 FLAGS_SEPARATE_FRAMES 32 Shows each frame separately, as
212 it was received from the camera.
213 Default (not set) is to mix the
214 preceding frame in to compensate
215 for occasional loss of Isoc data
216 on high frame rates.
217 FLAGS_CLEAN_FRAMES 64 Forces "cleanup" of each frame
218 prior to use; relevant only if
219 FLAGS_SEPARATE_FRAMES is set.
220 Default is not to clean frames,
221 this is a little faster but may
222 produce flicker if frame rate is
223 too high and Isoc data gets lost.
224 FLAGS_NO_DECODING 128 This flag turns the video stream
225 decoder off, and dumps the raw
226 Isoc data from the camera into
227 the reading process. Useful to
228 developers, but not to users.
229
230framerate This setting controls frame rate of the camera. This is
231 an approximate setting (in terms of "worst" ... "best")
232 because camera changes frame rate depending on amount
233 of light available. Setting 0 is slowest, 6 is fastest.
234 Beware - fast settings are very demanding and may not
235 work well with all video sizes. Be conservative.
236
237hue_correction This highly optional setting allows to adjust the
238 hue of the image in a way slightly different from
239 what usual "hue" control does. Both controls affect
240 YUV colorspace: regular "hue" control adjusts only
241 U component, and this "hue_correction" option similarly
242 adjusts only V component. However usually it is enough
243 to tweak only U or V to compensate for colored light or
244 color temperature; this option simply allows more
245 complicated correction when and if it is necessary.
246
247init_brightness These settings specify _initial_ values which will be
248init_contrast used to set up the camera. If your V4L application has
249init_color its own controls to adjust the picture then these
250init_hue controls will be used too. These options allow you to
251 preconfigure the camera when it gets connected, before
252 any V4L application connects to it. Good for webcams.
253
254init_model2_rg These initial settings alter color balance of the
255init_model2_rg2 camera on hardware level. All four settings may be used
256init_model2_sat to tune the camera to specific lighting conditions. These
257init_model2_yb settings only apply to Model 2 cameras.
258
259lighting This option selects one of three hardware-defined
260 photosensitivity settings of the camera. 0=bright light,
261 1=Medium (default), 2=Low light. This setting affects
262 frame rate: the dimmer the lighting the lower the frame
263 rate (because longer exposition time is needed). The
264 Model 2 cameras allow values more than 2 for this option,
265 thus enabling extremely high sensitivity at cost of frame
266 rate, color saturation and imaging sensor noise.
267
268sharpness This option controls smoothing (noise reduction)
269 made by camera. Setting 0 is most smooth, setting 6
270 is most sharp. Be aware that CMOS sensor used in the
271 camera is pretty noisy, so if you choose 6 you will
272 be greeted with "snowy" image. Default is 4. Model 2
273 cameras do not support this feature.
274
275size This setting chooses one of several image sizes that are
276 supported by this driver. Cameras may support more, but
277 it's difficult to reverse-engineer all formats.
278 Following video sizes are supported:
279
280 size=0 128x96 (Model 1 only)
281 size=1 160x120
282 size=2 176x144
283 size=3 320x240 (Model 2 only)
284 size=4 352x240 (Model 2 only)
285 size=5 352x288
286 size=6 640x480 (Model 3 only)
287
288 The 352x288 is the native size of the Model 1 sensor
289 array, so it's the best resolution the camera can
290 yield. The best resolution of Model 2 is 176x144, and
291 larger images are produced by stretching the bitmap.
292 Model 3 has sensor with 640x480 grid, and it works too,
293 but the frame rate will be exceptionally low (1-2 FPS);
294 it may be still OK for some applications, like security.
295 Choose the image size you need. The smaller image can
296 support faster frame rate. Default is 352x288.
297
298For more information and the Troubleshooting FAQ visit this URL:
299
300 http://www.linux-usb.org/ibmcam/
301
302WHAT NEEDS TO BE DONE:
303
304- The button on the camera is not used. I don't know how to get to it.
305 I know now how to read button on Model 2, but what to do with it?
306
307- Camera reports its status back to the driver; however I don't know
308 what returned data means. If camera fails at some initialization
309 stage then something should be done, and I don't do that because
310 I don't even know that some command failed. This is mostly Model 1
311 concern because Model 2 uses different commands which do not return
312 status (and seem to complete successfully every time).
313
314- Some flavors of Model 4 NetCameras produce only compressed video
315 streams, and I don't know how to decode them.
316
317CREDITS:
318
319The code is based in no small part on the CPiA driver by Johannes Erdfelt,
320Randy Dunlap, and others. Big thanks to them for their pioneering work on that
321and the USB stack.
322
323I also thank John Lightsey for his donation of the Veo Stingray camera.
diff --git a/Documentation/video4linux/m5602.txt b/Documentation/video4linux/m5602.txt
deleted file mode 100644
index 4450ab13f37b..000000000000
--- a/Documentation/video4linux/m5602.txt
+++ /dev/null
@@ -1,12 +0,0 @@
1This document describes the ALi m5602 bridge connected
2to the following supported sensors:
3OmniVision OV9650,
4Samsung s5k83a,
5Samsung s5k4aa,
6Micron mt9m111,
7Pixel plus PO1030
8
9This driver mimics the windows drivers, which have a braindead implementation sending bayer-encoded frames at VGA resolution.
10In a perfect world we should be able to reprogram the m5602 and the connected sensor in hardware instead, supporting a range of resolutions and pixelformats
11
12Anyway, have fun and please report any bugs to m560x-driver-devel@lists.sourceforge.net
diff --git a/Documentation/video4linux/ov511.txt b/Documentation/video4linux/ov511.txt
deleted file mode 100644
index b3326b167ada..000000000000
--- a/Documentation/video4linux/ov511.txt
+++ /dev/null
@@ -1,288 +0,0 @@
1-------------------------------------------------------------------------------
2Readme for Linux device driver for the OmniVision OV511 USB to camera bridge IC
3-------------------------------------------------------------------------------
4
5Author: Mark McClelland
6Homepage: http://alpha.dyndns.org/ov511
7
8INTRODUCTION:
9
10This is a driver for the OV511, a USB-only chip used in many "webcam" devices.
11Any camera using the OV511/OV511+ and the OV6620/OV7610/20/20AE should work.
12Video capture devices that use the Philips SAA7111A decoder also work. It
13supports streaming and capture of color or monochrome video via the Video4Linux
14API. Most V4L apps are compatible with it. Most resolutions with a width and
15height that are a multiple of 8 are supported.
16
17If you need more information, please visit the OV511 homepage at the above URL.
18
19WHAT YOU NEED:
20
21- If you want to help with the development, get the chip's specification docs at
22 http://www.ovt.com/omniusbp.html
23
24- A Video4Linux compatible frame grabber program (I recommend vidcat and xawtv)
25 vidcat is part of the w3cam package: http://mpx.freeshell.net/
26 xawtv is available at: http://linux.bytesex.org/xawtv/
27
28HOW TO USE IT:
29
30Note: These are simplified instructions. For complete instructions see:
31 http://alpha.dyndns.org/ov511/install.html
32
33You must have first compiled USB support, support for your specific USB host
34controller (UHCI or OHCI), and Video4Linux support for your kernel (I recommend
35making them modules.) Make sure "Enforce bandwidth allocation" is NOT enabled.
36
37Next, (as root):
38
39 modprobe usbcore
40 modprobe usb-uhci <OR> modprobe usb-ohci
41 modprobe videodev
42 modprobe ov511
43
44If it is not already there (it usually is), create the video device:
45
46 mknod /dev/video0 c 81 0
47
48Optionally, symlink /dev/video to /dev/video0
49
50You will have to set permissions on this device to allow you to read/write
51from it:
52
53 chmod 666 /dev/video
54 chmod 666 /dev/video0 (if necessary)
55
56Now you are ready to run a video app! Both vidcat and xawtv work well for me
57at 640x480.
58
59[Using vidcat:]
60
61 vidcat -s 640x480 -p c > test.jpg
62 xview test.jpg
63
64[Using xawtv:]
65
66From the main xawtv directory:
67
68 make clean
69 ./configure
70 make
71 make install
72
73Now you should be able to run xawtv. Right click for the options dialog.
74
75MODULE PARAMETERS:
76
77 You can set these with: insmod ov511 NAME=VALUE
78 There is currently no way to set these on a per-camera basis.
79
80 NAME: autobright
81 TYPE: integer (Boolean)
82 DEFAULT: 1
83 DESC: Brightness is normally under automatic control and can't be set
84 manually by the video app. Set to 0 for manual control.
85
86 NAME: autogain
87 TYPE: integer (Boolean)
88 DEFAULT: 1
89 DESC: Auto Gain Control enable. This feature is not yet implemented.
90
91 NAME: autoexp
92 TYPE: integer (Boolean)
93 DEFAULT: 1
94 DESC: Auto Exposure Control enable. This feature is not yet implemented.
95
96 NAME: debug
97 TYPE: integer (0-6)
98 DEFAULT: 3
99 DESC: Sets the threshold for printing debug messages. The higher the value,
100 the more is printed. The levels are cumulative, and are as follows:
101 0=no debug messages
102 1=init/detection/unload and other significant messages
103 2=some warning messages
104 3=config/control function calls
105 4=most function calls and data parsing messages
106 5=highly repetitive mesgs
107
108 NAME: snapshot
109 TYPE: integer (Boolean)
110 DEFAULT: 0
111 DESC: Set to 1 to enable snapshot mode. read()/VIDIOCSYNC will block until
112 the snapshot button is pressed. Note: enabling this mode disables
113 /proc/video/ov511/<minor#>/button
114
115 NAME: cams
116 TYPE: integer (1-4 for OV511, 1-31 for OV511+)
117 DEFAULT: 1
118 DESC: Number of cameras allowed to stream simultaneously on a single bus.
119 Values higher than 1 reduce the data rate of each camera, allowing two
120 or more to be used at once. If you have a complicated setup involving
121 both OV511 and OV511+ cameras, trial-and-error may be necessary for
122 finding the optimum setting.
123
124 NAME: compress
125 TYPE: integer (Boolean)
126 DEFAULT: 0
127 DESC: Set this to 1 to turn on the camera's compression engine. This can
128 potentially increase the frame rate at the expense of quality, if you
129 have a fast CPU. You must load the proper compression module for your
130 camera before starting your application (ov511_decomp or ov518_decomp).
131
132 NAME: testpat
133 TYPE: integer (Boolean)
134 DEFAULT: 0
135 DESC: This configures the camera's sensor to transmit a colored test-pattern
136 instead of an image. This does not work correctly yet.
137
138 NAME: dumppix
139 TYPE: integer (0-2)
140 DEFAULT: 0
141 DESC: Dumps raw pixel data and skips post-processing and format conversion.
142 It is for debugging purposes only. Options are:
143 0: Disable (default)
144 1: Dump raw data from camera, excluding headers and trailers
145 2: Dumps data exactly as received from camera
146
147 NAME: led
148 TYPE: integer (0-2)
149 DEFAULT: 1 (Always on)
150 DESC: Controls whether the LED (the little light) on the front of the camera
151 is always off (0), always on (1), or only on when driver is open (2).
152 This is not supported with the OV511, and might only work with certain
153 cameras (ones that actually have the LED wired to the control pin, and
154 not just hard-wired to be on all the time).
155
156 NAME: dump_bridge
157 TYPE: integer (Boolean)
158 DEFAULT: 0
159 DESC: Dumps the bridge (OV511[+] or OV518[+]) register values to the system
160 log. Only useful for serious debugging/development purposes.
161
162 NAME: dump_sensor
163 TYPE: integer (Boolean)
164 DEFAULT: 0
165 DESC: Dumps the sensor register values to the system log. Only useful for
166 serious debugging/development purposes.
167
168 NAME: printph
169 TYPE: integer (Boolean)
170 DEFAULT: 0
171 DESC: Setting this to 1 will dump the first 12 bytes of each isoc frame. This
172 is only useful if you are trying to debug problems with the isoc data
173 stream (i.e.: camera initializes, but vidcat hangs until Ctrl-C). Be
174 warned that this dumps a large number of messages to your kernel log.
175
176 NAME: phy, phuv, pvy, pvuv, qhy, qhuv, qvy, qvuv
177 TYPE: integer (0-63 for phy and phuv, 0-255 for rest)
178 DEFAULT: OV511 default values
179 DESC: These are registers 70h - 77h of the OV511, which control the
180 prediction ranges and quantization thresholds of the compressor, for
181 the Y and UV channels in the horizontal and vertical directions. See
182 the OV511 or OV511+ data sheet for more detailed descriptions. These
183 normally do not need to be changed.
184
185 NAME: lightfreq
186 TYPE: integer (0, 50, or 60)
187 DEFAULT: 0 (use sensor default)
188 DESC: Sets the sensor to match your lighting frequency. This can reduce the
189 appearance of "banding", i.e. horizontal lines or waves of light and
190 dark that are often caused by artificial lighting. Valid values are:
191 0 - Use default (depends on sensor, most likely 60 Hz)
192 50 - For European and Asian 50 Hz power
193 60 - For American 60 Hz power
194
195 NAME: bandingfilter
196 TYPE: integer (Boolean)
197 DEFAULT: 0 (off)
198 DESC: Enables the sensor´s banding filter exposure algorithm. This reduces
199 or stabilizes the "banding" caused by some artificial light sources
200 (especially fluorescent). You might have to set lightfreq correctly for
201 this to work right. As an added bonus, this sometimes makes it
202 possible to capture your monitor´s output.
203
204 NAME: fastset
205 TYPE: integer (Boolean)
206 DEFAULT: 0 (off)
207 DESC: Allows picture settings (brightness, contrast, color, and hue) to take
208 effect immediately, even in the middle of a frame. This reduces the
209 time to change settings, but can ruin frames during the change. Only
210 affects OmniVision sensors.
211
212 NAME: force_palette
213 TYPE: integer (Boolean)
214 DEFAULT: 0 (off)
215 DESC: Forces the palette (color format) to a specific value. If an
216 application requests a different palette, it will be rejected, thereby
217 forcing it to try others until it succeeds. This is useful for forcing
218 greyscale mode with a color camera, for example. Supported modes are:
219 0 (Allows all the following formats)
220 1 VIDEO_PALETTE_GREY (Linear greyscale)
221 10 VIDEO_PALETTE_YUV420 (YUV 4:2:0 Planar)
222 15 VIDEO_PALETTE_YUV420P (YUV 4:2:0 Planar, same as 10)
223
224 NAME: backlight
225 TYPE: integer (Boolean)
226 DEFAULT: 0 (off)
227 DESC: Setting this flag changes the exposure algorithm for OmniVision sensors
228 such that objects in the camera's view (i.e. your head) can be clearly
229 seen when they are illuminated from behind. It reduces or eliminates
230 the sensor's auto-exposure function, so it should only be used when
231 needed. Additionally, it is only supported with the OV6620 and OV7620.
232
233 NAME: unit_video
234 TYPE: Up to 16 comma-separated integers
235 DEFAULT: 0,0,0... (automatically assign the next available minor(s))
236 DESC: You can specify up to 16 minor numbers to be assigned to ov511 devices.
237 For example, "unit_video=1,3" will make the driver use /dev/video1 and
238 /dev/video3 for the first two devices it detects. Additional devices
239 will be assigned automatically starting at the first available device
240 node (/dev/video0 in this case). Note that you cannot specify 0 as a
241 minor number. This feature requires kernel version 2.4.5 or higher.
242
243 NAME: remove_zeros
244 TYPE: integer (Boolean)
245 DEFAULT: 0 (do not skip any incoming data)
246 DESC: Setting this to 1 will remove zero-padding from incoming data. This
247 will compensate for the blocks of corruption that can appear when the
248 camera cannot keep up with the speed of the USB bus (eg. at low frame
249 resolutions). This feature is always enabled when compression is on.
250
251 NAME: mirror
252 TYPE: integer (Boolean)
253 DEFAULT: 0 (off)
254 DESC: Setting this to 1 will reverse ("mirror") the image horizontally. This
255 might be necessary if your camera has a custom lens assembly. This has
256 no effect with video capture devices.
257
258 NAME: ov518_color
259 TYPE: integer (Boolean)
260 DEFAULT: 0 (off)
261 DESC: Enable OV518 color support. This is off by default since it doesn't
262 work most of the time. If you want to try it, you must also load
263 ov518_decomp with the "nouv=0" parameter. If you get improper colors or
264 diagonal lines through the image, restart your video app and try again.
265 Repeat as necessary.
266
267WORKING FEATURES:
268 o Color streaming/capture at most widths and heights that are multiples of 8.
269 o Monochrome (use force_palette=1 to enable)
270 o Setting/getting of saturation, contrast, brightness, and hue (only some of
271 them work the OV7620 and OV7620AE)
272 o /proc status reporting
273 o SAA7111A video capture support at 320x240 and 640x480
274 o Compression support
275 o SMP compatibility
276
277HOW TO CONTACT ME:
278
279You can email me at mark@alpha.dyndns.org . Please prefix the subject line
280with "OV511: " so that I am certain to notice your message.
281
282CREDITS:
283
284The code is based in no small part on the CPiA driver by Johannes Erdfelt,
285Randy Dunlap, and others. Big thanks to them for their pioneering work on that
286and the USB stack. Thanks to Bret Wallach for getting camera reg IO, ISOC, and
287image capture working. Thanks to Orion Sky Lawlor, Kevin Moore, and Claudio
288Matsuoka for their work as well.
diff --git a/Documentation/video4linux/se401.txt b/Documentation/video4linux/se401.txt
deleted file mode 100644
index bd6526ec8dd7..000000000000
--- a/Documentation/video4linux/se401.txt
+++ /dev/null
@@ -1,54 +0,0 @@
1Linux driver for SE401 based USB cameras
2
3Copyright, 2001, Jeroen Vreeken
4
5
6INTRODUCTION:
7
8The SE401 chip is the used in low-cost usb webcams.
9It is produced by Endpoints Inc. (www.endpoints.com).
10It interfaces directly to a cmos image sensor and USB. The only other major
11part in a se401 based camera is a dram chip.
12
13The following cameras are known to work with this driver:
14
15Aox se401 (non-branded) cameras
16Philips PVCV665 USB VGA webcam 'Vesta Fun'
17Kensington VideoCAM PC Camera Model 67014
18Kensington VideoCAM PC Camera Model 67015
19Kensington VideoCAM PC Camera Model 67016
20Kensington VideoCAM PC Camera Model 67017
21
22
23WHAT YOU NEED:
24
25- USB support
26- VIDEO4LINUX support
27
28More information about USB support for linux can be found at:
29http://www.linux-usb.org
30
31
32MODULE OPTIONS:
33
34When the driver is compiled as a module you can also use the 'flickerless'
35option. With it exposure is limited to values that do not interfere with the
36net frequency. Valid options for this option are 0, 50 and 60. (0=disable,
3750=50hz, 60=60hz)
38
39
40KNOWN PROBLEMS:
41
42The driver works fine with the usb-ohci and uhci host controller drivers,
43the default settings also work with usb-uhci. But sending more than one bulk
44transfer at a time with usb-uhci doesn't work yet.
45Users of usb-ohci and uhci can safely enlarge SE401_NUMSBUF in se401.h in
46order to increase the throughput (and thus framerate).
47
48
49HELP:
50
51The latest info on this driver can be found at:
52http://members.chello.nl/~j.vreeken/se401/
53And questions to me can be send to:
54pe1rxq@amsat.org
diff --git a/Documentation/video4linux/stv680.txt b/Documentation/video4linux/stv680.txt
deleted file mode 100644
index e3de33645308..000000000000
--- a/Documentation/video4linux/stv680.txt
+++ /dev/null
@@ -1,53 +0,0 @@
1Linux driver for STV0680 based USB cameras
2
3Copyright, 2001, Kevin Sisson
4
5
6INTRODUCTION:
7
8STMicroelectronics produces the STV0680B chip, which comes in two
9types, -001 and -003. The -003 version allows the recording and downloading
10of sound clips from the camera, and allows a flash attachment. Otherwise,
11it uses the same commands as the -001 version. Both versions support a
12variety of SDRAM sizes and sensors, allowing for a maximum of 26 VGA or 20
13CIF pictures. The STV0680 supports either a serial or a usb interface, and
14video is possible through the usb interface.
15
16The following cameras are known to work with this driver, although any
17camera with Vendor/Product codes of 0553/0202 should work:
18
19Aiptek Pencam (various models)
20Nisis QuickPix 2
21Radio Shack 'Kid's digital camera' (#60-1207)
22At least one Trust Spycam model
23Several other European brand models
24
25WHAT YOU NEED:
26
27- USB support
28- VIDEO4LINUX support
29
30More information about USB support for linux can be found at:
31http://www.linux-usb.org
32
33
34MODULE OPTIONS:
35
36When the driver is compiled as a module, you can set a "swapRGB=1"
37option, if necessary, for those applications that require it
38(such as xawtv). However, the driver should detect and set this
39automatically, so this option should not normally be used.
40
41
42KNOWN PROBLEMS:
43
44The driver seems to work better with the usb-ohci than the usb-uhci host
45controller driver.
46
47HELP:
48
49The latest info on this driver can be found at:
50http://personal.clt.bellsouth.net/~kjsisson or at
51http://stv0680-usb.sourceforge.net
52
53Any questions to me can be send to: kjsisson@bellsouth.net
diff --git a/Documentation/video4linux/w9968cf.txt b/Documentation/video4linux/w9968cf.txt
deleted file mode 100644
index 9649450f3b90..000000000000
--- a/Documentation/video4linux/w9968cf.txt
+++ /dev/null
@@ -1,458 +0,0 @@
1
2 W996[87]CF JPEG USB Dual Mode Camera Chip
3 Driver for Linux 2.6 (basic version)
4 =========================================
5
6 - Documentation -
7
8
9Index
10=====
111. Copyright
122. Disclaimer
133. License
144. Overview
155. Supported devices
166. Module dependencies
177. Module loading
188. Module parameters
199. Contact information
2010. Credits
21
22
231. Copyright
24============
25Copyright (C) 2002-2004 by Luca Risolia <luca.risolia@studio.unibo.it>
26
27
282. Disclaimer
29=============
30Winbond is a trademark of Winbond Electronics Corporation.
31This software is not sponsored or developed by Winbond.
32
33
343. License
35==========
36This program is free software; you can redistribute it and/or modify
37it under the terms of the GNU General Public License as published by
38the Free Software Foundation; either version 2 of the License, or
39(at your option) any later version.
40
41This program is distributed in the hope that it will be useful,
42but WITHOUT ANY WARRANTY; without even the implied warranty of
43MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
44GNU General Public License for more details.
45
46You should have received a copy of the GNU General Public License
47along with this program; if not, write to the Free Software
48Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
49
50
514. Overview
52===========
53This driver supports the video streaming capabilities of the devices mounting
54Winbond W9967CF and Winbond W9968CF JPEG USB Dual Mode Camera Chips. OV681
55based cameras should be supported as well.
56
57The driver is divided into two modules: the basic one, "w9968cf", is needed for
58the supported devices to work; the second one, "w9968cf-vpp", is an optional
59module, which provides some useful video post-processing functions like video
60decoding, up-scaling and colour conversions.
61
62Note that the official kernels do neither include nor support the second
63module for performance purposes. Therefore, it is always recommended to
64download and install the latest and complete release of the driver,
65replacing the existing one, if present.
66
67The latest and full-featured version of the W996[87]CF driver can be found at:
68http://www.linux-projects.org. Please refer to the documentation included in
69that package, if you are going to use it.
70
71Up to 32 cameras can be handled at the same time. They can be connected and
72disconnected from the host many times without turning off the computer, if
73your system supports the hotplug facility.
74
75To change the default settings for each camera, many parameters can be passed
76through command line when the module is loaded into memory.
77
78The driver relies on the Video4Linux, USB and I2C core modules. It has been
79designed to run properly on SMP systems as well. An additional module,
80"ovcamchip", is mandatory; it provides support for some OmniVision image
81sensors connected to the W996[87]CF chips; if found in the system, the module
82will be automatically loaded by default (provided that the kernel has been
83compiled with the automatic module loading option).
84
85
865. Supported devices
87====================
88At the moment, known W996[87]CF and OV681 based devices are:
89- Aroma Digi Pen VGA Dual Mode ADG-5000 (unknown image sensor)
90- AVerMedia AVerTV USB (SAA7111A, Philips FI1216Mk2 tuner, PT2313L audio chip)
91- Creative Labs Video Blaster WebCam Go (OmniVision OV7610 sensor)
92- Creative Labs Video Blaster WebCam Go Plus (OmniVision OV7620 sensor)
93- Lebon LDC-035A (unknown image sensor)
94- Ezonics EZ-802 EZMega Cam (OmniVision OV8610C sensor)
95- OmniVision OV8610-EDE (OmniVision OV8610 sensor)
96- OPCOM Digi Pen VGA Dual Mode Pen Camera (unknown image sensor)
97- Pretec Digi Pen-II (OmniVision OV7620 sensor)
98- Pretec DigiPen-480 (OmniVision OV8610 sensor)
99
100If you know any other W996[87]CF or OV681 based cameras, please contact me.
101
102The list above does not imply that all those devices work with this driver: up
103until now only webcams that have an image sensor supported by the "ovcamchip"
104module work. Kernel messages will always tell you whether this is case.
105
106Possible external microcontrollers of those webcams are not supported: this
107means that still images cannot be downloaded from the device memory.
108
109Furthermore, it's worth to note that I was only able to run tests on my
110"Creative Labs Video Blaster WebCam Go". Donations of other models, for
111additional testing and full support, would be much appreciated.
112
113
1146. Module dependencies
115======================
116For it to work properly, the driver needs kernel support for Video4Linux, USB
117and I2C, and the "ovcamchip" module for the image sensor. Make sure you are not
118actually using any external "ovcamchip" module, given that the W996[87]CF
119driver depends on the version of the module present in the official kernels.
120
121The following options of the kernel configuration file must be enabled and
122corresponding modules must be compiled:
123
124 # Multimedia devices
125 #
126 CONFIG_VIDEO_DEV=m
127
128 # I2C support
129 #
130 CONFIG_I2C=m
131
132The I2C core module can be compiled statically in the kernel as well.
133
134 # OmniVision Camera Chip support
135 #
136 CONFIG_VIDEO_OVCAMCHIP=m
137
138 # USB support
139 #
140 CONFIG_USB=m
141
142In addition, depending on the hardware being used, only one of the modules
143below is necessary:
144
145 # USB Host Controller Drivers
146 #
147 CONFIG_USB_EHCI_HCD=m
148 CONFIG_USB_UHCI_HCD=m
149 CONFIG_USB_OHCI_HCD=m
150
151And finally:
152
153 # USB Multimedia devices
154 #
155 CONFIG_USB_W9968CF=m
156
157
1587. Module loading
159=================
160To use the driver, it is necessary to load the "w9968cf" module into memory
161after every other module required.
162
163Loading can be done this way, from root:
164
165 [root@localhost home]# modprobe usbcore
166 [root@localhost home]# modprobe i2c-core
167 [root@localhost home]# modprobe videodev
168 [root@localhost home]# modprobe w9968cf
169
170At this point the pertinent devices should be recognized: "dmesg" can be used
171to analyze kernel messages:
172
173 [user@localhost home]$ dmesg
174
175There are a lot of parameters the module can use to change the default
176settings for each device. To list every possible parameter with a brief
177explanation about them and which syntax to use, it is recommended to run the
178"modinfo" command:
179
180 [root@locahost home]# modinfo w9968cf
181
182
1838. Module parameters
184====================
185Module parameters are listed below:
186-------------------------------------------------------------------------------
187Name: ovmod_load
188Type: bool
189Syntax: <0|1>
190Description: Automatic 'ovcamchip' module loading: 0 disabled, 1 enabled.
191 If enabled, 'insmod' searches for the required 'ovcamchip'
192 module in the system, according to its configuration, and
193 loads that module automatically. This action is performed as
194 once soon as the 'w9968cf' module is loaded into memory.
195Default: 1
196-------------------------------------------------------------------------------
197Name: simcams
198Type: int
199Syntax: <n>
200Description: Number of cameras allowed to stream simultaneously.
201 n may vary from 0 to 32.
202Default: 32
203-------------------------------------------------------------------------------
204Name: video_nr
205Type: int array (min = 0, max = 32)
206Syntax: <-1|n[,...]>
207Description: Specify V4L minor mode number.
208 -1 = use next available
209 n = use minor number n
210 You can specify up to 32 cameras this way.
211 For example:
212 video_nr=-1,2,-1 would assign minor number 2 to the second
213 recognized camera and use auto for the first one and for every
214 other camera.
215Default: -1
216-------------------------------------------------------------------------------
217Name: packet_size
218Type: int array (min = 0, max = 32)
219Syntax: <n[,...]>
220Description: Specify the maximum data payload size in bytes for alternate
221 settings, for each device. n is scaled between 63 and 1023.
222Default: 1023
223-------------------------------------------------------------------------------
224Name: max_buffers
225Type: int array (min = 0, max = 32)
226Syntax: <n[,...]>
227Description: For advanced users.
228 Specify the maximum number of video frame buffers to allocate
229 for each device, from 2 to 32.
230Default: 2
231-------------------------------------------------------------------------------
232Name: double_buffer
233Type: bool array (min = 0, max = 32)
234Syntax: <0|1[,...]>
235Description: Hardware double buffering: 0 disabled, 1 enabled.
236 It should be enabled if you want smooth video output: if you
237 obtain out of sync. video, disable it, or try to
238 decrease the 'clockdiv' module parameter value.
239Default: 1 for every device.
240-------------------------------------------------------------------------------
241Name: clamping
242Type: bool array (min = 0, max = 32)
243Syntax: <0|1[,...]>
244Description: Video data clamping: 0 disabled, 1 enabled.
245Default: 0 for every device.
246-------------------------------------------------------------------------------
247Name: filter_type
248Type: int array (min = 0, max = 32)
249Syntax: <0|1|2[,...]>
250Description: Video filter type.
251 0 none, 1 (1-2-1) 3-tap filter, 2 (2-3-6-3-2) 5-tap filter.
252 The filter is used to reduce noise and aliasing artifacts
253 produced by the CCD or CMOS image sensor.
254Default: 0 for every device.
255-------------------------------------------------------------------------------
256Name: largeview
257Type: bool array (min = 0, max = 32)
258Syntax: <0|1[,...]>
259Description: Large view: 0 disabled, 1 enabled.
260Default: 1 for every device.
261-------------------------------------------------------------------------------
262Name: upscaling
263Type: bool array (min = 0, max = 32)
264Syntax: <0|1[,...]>
265Description: Software scaling (for non-compressed video only):
266 0 disabled, 1 enabled.
267 Disable it if you have a slow CPU or you don't have enough
268 memory.
269Default: 0 for every device.
270Note: If 'w9968cf-vpp' is not present, this parameter is set to 0.
271-------------------------------------------------------------------------------
272Name: decompression
273Type: int array (min = 0, max = 32)
274Syntax: <0|1|2[,...]>
275Description: Software video decompression:
276 0 = disables decompression
277 (doesn't allow formats needing decompression).
278 1 = forces decompression
279 (allows formats needing decompression only).
280 2 = allows any permitted formats.
281 Formats supporting (de)compressed video are YUV422P and
282 YUV420P/YUV420 in any resolutions where width and height are
283 multiples of 16.
284Default: 2 for every device.
285Note: If 'w9968cf-vpp' is not present, forcing decompression is not
286 allowed; in this case this parameter is set to 2.
287-------------------------------------------------------------------------------
288Name: force_palette
289Type: int array (min = 0, max = 32)
290Syntax: <0|9|10|13|15|8|7|1|6|3|4|5[,...]>
291Description: Force picture palette.
292 In order:
293 0 = Off - allows any of the following formats:
294 9 = UYVY 16 bpp - Original video, compression disabled
295 10 = YUV420 12 bpp - Original video, compression enabled
296 13 = YUV422P 16 bpp - Original video, compression enabled
297 15 = YUV420P 12 bpp - Original video, compression enabled
298 8 = YUVY 16 bpp - Software conversion from UYVY
299 7 = YUV422 16 bpp - Software conversion from UYVY
300 1 = GREY 8 bpp - Software conversion from UYVY
301 6 = RGB555 16 bpp - Software conversion from UYVY
302 3 = RGB565 16 bpp - Software conversion from UYVY
303 4 = RGB24 24 bpp - Software conversion from UYVY
304 5 = RGB32 32 bpp - Software conversion from UYVY
305 When not 0, this parameter will override 'decompression'.
306Default: 0 for every device. Initial palette is 9 (UYVY).
307Note: If 'w9968cf-vpp' is not present, this parameter is set to 9.
308-------------------------------------------------------------------------------
309Name: force_rgb
310Type: bool array (min = 0, max = 32)
311Syntax: <0|1[,...]>
312Description: Read RGB video data instead of BGR:
313 1 = use RGB component ordering.
314 0 = use BGR component ordering.
315 This parameter has effect when using RGBX palettes only.
316Default: 0 for every device.
317-------------------------------------------------------------------------------
318Name: autobright
319Type: bool array (min = 0, max = 32)
320Syntax: <0|1[,...]>
321Description: Image sensor automatically changes brightness:
322 0 = no, 1 = yes
323Default: 0 for every device.
324-------------------------------------------------------------------------------
325Name: autoexp
326Type: bool array (min = 0, max = 32)
327Syntax: <0|1[,...]>
328Description: Image sensor automatically changes exposure:
329 0 = no, 1 = yes
330Default: 1 for every device.
331-------------------------------------------------------------------------------
332Name: lightfreq
333Type: int array (min = 0, max = 32)
334Syntax: <50|60[,...]>
335Description: Light frequency in Hz:
336 50 for European and Asian lighting, 60 for American lighting.
337Default: 50 for every device.
338-------------------------------------------------------------------------------
339Name: bandingfilter
340Type: bool array (min = 0, max = 32)
341Syntax: <0|1[,...]>
342Description: Banding filter to reduce effects of fluorescent
343 lighting:
344 0 disabled, 1 enabled.
345 This filter tries to reduce the pattern of horizontal
346 light/dark bands caused by some (usually fluorescent) lighting.
347Default: 0 for every device.
348-------------------------------------------------------------------------------
349Name: clockdiv
350Type: int array (min = 0, max = 32)
351Syntax: <-1|n[,...]>
352Description: Force pixel clock divisor to a specific value (for experts):
353 n may vary from 0 to 127.
354 -1 for automatic value.
355 See also the 'double_buffer' module parameter.
356Default: -1 for every device.
357-------------------------------------------------------------------------------
358Name: backlight
359Type: bool array (min = 0, max = 32)
360Syntax: <0|1[,...]>
361Description: Objects are lit from behind:
362 0 = no, 1 = yes
363Default: 0 for every device.
364-------------------------------------------------------------------------------
365Name: mirror
366Type: bool array (min = 0, max = 32)
367Syntax: <0|1[,...]>
368Description: Reverse image horizontally:
369 0 = no, 1 = yes
370Default: 0 for every device.
371-------------------------------------------------------------------------------
372Name: monochrome
373Type: bool array (min = 0, max = 32)
374Syntax: <0|1[,...]>
375Description: The image sensor is monochrome:
376 0 = no, 1 = yes
377Default: 0 for every device.
378-------------------------------------------------------------------------------
379Name: brightness
380Type: long array (min = 0, max = 32)
381Syntax: <n[,...]>
382Description: Set picture brightness (0-65535).
383 This parameter has no effect if 'autobright' is enabled.
384Default: 31000 for every device.
385-------------------------------------------------------------------------------
386Name: hue
387Type: long array (min = 0, max = 32)
388Syntax: <n[,...]>
389Description: Set picture hue (0-65535).
390Default: 32768 for every device.
391-------------------------------------------------------------------------------
392Name: colour
393Type: long array (min = 0, max = 32)
394Syntax: <n[,...]>
395Description: Set picture saturation (0-65535).
396Default: 32768 for every device.
397-------------------------------------------------------------------------------
398Name: contrast
399Type: long array (min = 0, max = 32)
400Syntax: <n[,...]>
401Description: Set picture contrast (0-65535).
402Default: 50000 for every device.
403-------------------------------------------------------------------------------
404Name: whiteness
405Type: long array (min = 0, max = 32)
406Syntax: <n[,...]>
407Description: Set picture whiteness (0-65535).
408Default: 32768 for every device.
409-------------------------------------------------------------------------------
410Name: debug
411Type: int
412Syntax: <n>
413Description: Debugging information level, from 0 to 6:
414 0 = none (use carefully)
415 1 = critical errors
416 2 = significant information
417 3 = configuration or general messages
418 4 = warnings
419 5 = called functions
420 6 = function internals
421 Level 5 and 6 are useful for testing only, when only one
422 device is used.
423Default: 2
424-------------------------------------------------------------------------------
425Name: specific_debug
426Type: bool
427Syntax: <0|1>
428Description: Enable or disable specific debugging messages:
429 0 = print messages concerning every level <= 'debug' level.
430 1 = print messages concerning the level indicated by 'debug'.
431Default: 0
432-------------------------------------------------------------------------------
433
434
4359. Contact information
436======================
437I may be contacted by e-mail at <luca.risolia@studio.unibo.it>.
438
439I can accept GPG/PGP encrypted e-mail. My GPG key ID is 'FCE635A4'.
440My public 1024-bit key should be available at your keyserver; the fingerprint
441is: '88E8 F32F 7244 68BA 3958 5D40 99DA 5D2A FCE6 35A4'.
442
443
44410. Credits
445==========
446The development would not have proceed much further without having looked at
447the source code of other drivers and without the help of several persons; in
448particular:
449
450- the I2C interface to kernel and high-level image sensor control routines have
451 been taken from the OV511 driver by Mark McClelland;
452
453- memory management code has been copied from the bttv driver by Ralph Metzler,
454 Marcus Metzler and Gerd Knorr;
455
456- the low-level I2C read function has been written by Frederic Jouault;
457
458- the low-level I2C fast write function has been written by Piotr Czerczak.
diff --git a/Documentation/video4linux/zc0301.txt b/Documentation/video4linux/zc0301.txt
deleted file mode 100644
index b41c83cf09f4..000000000000
--- a/Documentation/video4linux/zc0301.txt
+++ /dev/null
@@ -1,270 +0,0 @@
1
2 ZC0301 and ZC0301P Image Processor and Control Chip
3 Driver for Linux
4 ===================================================
5
6 - Documentation -
7
8
9Index
10=====
111. Copyright
122. Disclaimer
133. License
144. Overview and features
155. Module dependencies
166. Module loading
177. Module parameters
188. Supported devices
199. Notes for V4L2 application developers
2010. Contact information
2111. Credits
22
23
241. Copyright
25============
26Copyright (C) 2006-2007 by Luca Risolia <luca.risolia@studio.unibo.it>
27
28
292. Disclaimer
30=============
31This software is not developed or sponsored by Z-Star Microelectronics Corp.
32Trademarks are property of their respective owner.
33
34
353. License
36==========
37This program is free software; you can redistribute it and/or modify
38it under the terms of the GNU General Public License as published by
39the Free Software Foundation; either version 2 of the License, or
40(at your option) any later version.
41
42This program is distributed in the hope that it will be useful,
43but WITHOUT ANY WARRANTY; without even the implied warranty of
44MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45GNU General Public License for more details.
46
47You should have received a copy of the GNU General Public License
48along with this program; if not, write to the Free Software
49Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
50
51
524. Overview and features
53========================
54This driver supports the video interface of the devices mounting the ZC0301 or
55ZC0301P Image Processors and Control Chips.
56
57The driver relies on the Video4Linux2 and USB core modules. It has been
58designed to run properly on SMP systems as well.
59
60The latest version of the ZC0301[P] driver can be found at the following URL:
61http://www.linux-projects.org/
62
63Some of the features of the driver are:
64
65- full compliance with the Video4Linux2 API (see also "Notes for V4L2
66 application developers" paragraph);
67- available mmap or read/poll methods for video streaming through isochronous
68 data transfers;
69- automatic detection of image sensor;
70- video format is standard JPEG;
71- dynamic driver control thanks to various module parameters (see "Module
72 parameters" paragraph);
73- up to 64 cameras can be handled at the same time; they can be connected and
74 disconnected from the host many times without turning off the computer, if
75 the system supports hotplugging;
76
77
785. Module dependencies
79======================
80For it to work properly, the driver needs kernel support for Video4Linux and
81USB.
82
83The following options of the kernel configuration file must be enabled and
84corresponding modules must be compiled:
85
86 # Multimedia devices
87 #
88 CONFIG_VIDEO_DEV=m
89
90 # USB support
91 #
92 CONFIG_USB=m
93
94In addition, depending on the hardware being used, the modules below are
95necessary:
96
97 # USB Host Controller Drivers
98 #
99 CONFIG_USB_EHCI_HCD=m
100 CONFIG_USB_UHCI_HCD=m
101 CONFIG_USB_OHCI_HCD=m
102
103The ZC0301 controller also provides a built-in microphone interface. It is
104supported by the USB Audio driver thanks to the ALSA API:
105
106 # Sound
107 #
108 CONFIG_SOUND=y
109
110 # Advanced Linux Sound Architecture
111 #
112 CONFIG_SND=m
113
114 # USB devices
115 #
116 CONFIG_SND_USB_AUDIO=m
117
118And finally:
119
120 # V4L USB devices
121 #
122 CONFIG_USB_ZC0301=m
123
124
1256. Module loading
126=================
127To use the driver, it is necessary to load the "zc0301" module into memory
128after every other module required: "videodev", "v4l2_common", "compat_ioctl32",
129"usbcore" and, depending on the USB host controller you have, "ehci-hcd",
130"uhci-hcd" or "ohci-hcd".
131
132Loading can be done as shown below:
133
134 [root@localhost home]# modprobe zc0301
135
136At this point the devices should be recognized. You can invoke "dmesg" to
137analyze kernel messages and verify that the loading process has gone well:
138
139 [user@localhost home]$ dmesg
140
141
1427. Module parameters
143====================
144Module parameters are listed below:
145-------------------------------------------------------------------------------
146Name: video_nr
147Type: short array (min = 0, max = 64)
148Syntax: <-1|n[,...]>
149Description: Specify V4L2 minor mode number:
150 -1 = use next available
151 n = use minor number n
152 You can specify up to 64 cameras this way.
153 For example:
154 video_nr=-1,2,-1 would assign minor number 2 to the second
155 registered camera and use auto for the first one and for every
156 other camera.
157Default: -1
158-------------------------------------------------------------------------------
159Name: force_munmap
160Type: bool array (min = 0, max = 64)
161Syntax: <0|1[,...]>
162Description: Force the application to unmap previously mapped buffer memory
163 before calling any VIDIOC_S_CROP or VIDIOC_S_FMT ioctl's. Not
164 all the applications support this feature. This parameter is
165 specific for each detected camera.
166 0 = do not force memory unmapping
167 1 = force memory unmapping (save memory)
168Default: 0
169-------------------------------------------------------------------------------
170Name: frame_timeout
171Type: uint array (min = 0, max = 64)
172Syntax: <n[,...]>
173Description: Timeout for a video frame in seconds. This parameter is
174 specific for each detected camera. This parameter can be
175 changed at runtime thanks to the /sys filesystem interface.
176Default: 2
177-------------------------------------------------------------------------------
178Name: debug
179Type: ushort
180Syntax: <n>
181Description: Debugging information level, from 0 to 3:
182 0 = none (use carefully)
183 1 = critical errors
184 2 = significant information
185 3 = more verbose messages
186 Level 3 is useful for testing only, when only one device
187 is used at the same time. It also shows some information
188 about the hardware being detected. This module parameter can be
189 changed at runtime thanks to the /sys filesystem interface.
190Default: 2
191-------------------------------------------------------------------------------
192
193
1948. Supported devices
195====================
196None of the names of the companies as well as their products will be mentioned
197here. They have never collaborated with the author, so no advertising.
198
199From the point of view of a driver, what unambiguously identify a device are
200its vendor and product USB identifiers. Below is a list of known identifiers of
201devices mounting the ZC0301 Image Processor and Control Chips:
202
203Vendor ID Product ID
204--------- ----------
2050x041e 0x4017
2060x041e 0x401c
2070x041e 0x401e
2080x041e 0x401f
2090x041e 0x4022
2100x041e 0x4034
2110x041e 0x4035
2120x041e 0x4036
2130x041e 0x403a
2140x0458 0x7007
2150x0458 0x700c
2160x0458 0x700f
2170x046d 0x08ae
2180x055f 0xd003
2190x055f 0xd004
2200x0ac8 0x0301
2210x0ac8 0x301b
2220x0ac8 0x303b
2230x10fd 0x0128
2240x10fd 0x8050
2250x10fd 0x804e
226
227The list above does not imply that all those devices work with this driver: up
228until now only the ones that mount the following image sensors are supported;
229kernel messages will always tell you whether this is the case:
230
231Model Manufacturer
232----- ------------
233PAS202BCB PixArt Imaging, Inc.
234PB-0330 Photobit Corporation
235
236
2379. Notes for V4L2 application developers
238========================================
239This driver follows the V4L2 API specifications. In particular, it enforces two
240rules:
241
242- exactly one I/O method, either "mmap" or "read", is associated with each
243file descriptor. Once it is selected, the application must close and reopen the
244device to switch to the other I/O method;
245
246- although it is not mandatory, previously mapped buffer memory should always
247be unmapped before calling any "VIDIOC_S_CROP" or "VIDIOC_S_FMT" ioctl's.
248The same number of buffers as before will be allocated again to match the size
249of the new video frames, so you have to map the buffers again before any I/O
250attempts on them.
251
252
25310. Contact information
254=======================
255The author may be contacted by e-mail at <luca.risolia@studio.unibo.it>.
256
257GPG/PGP encrypted e-mail's are accepted. The GPG key ID of the author is
258'FCE635A4'; the public 1024-bit key should be available at any keyserver;
259the fingerprint is: '88E8 F32F 7244 68BA 3958 5D40 99DA 5D2A FCE6 35A4'.
260
261
26211. Credits
263===========
264- Information about the chip internals needed to enable the I2C protocol have
265 been taken from the documentation of the ZC030x Video4Linux1 driver written
266 by Andrew Birkett <andy@nobugs.org>;
267- The initialization values of the ZC0301 controller connected to the PAS202BCB
268 and PB-0330 image sensors have been taken from the SPCA5XX driver maintained
269 by Michel Xhaard <mxhaard@magic.fr>;
270- Stanislav Lechev donated one camera.