This commit was generated by cvs2svn to compensate for changes in r1129,
[linux-2.6.git] / Documentation / usb / w9968cf.txt
index f52d65e..9d46cd0 100644 (file)
@@ -8,26 +8,30 @@
 
 Index
 =====
-1. Copyright
-2. License
-3. Overview
-4. Supported devices
-5. Module dependencies
-6. Module loading
-7. Module paramaters
-8. Contact information
-9. Credits
+1.  Copyright
+2.  Disclaimer
+3.  License
+4.  Overview
+5.  Supported devices
+6.  Module dependencies
+7.  Module loading
+8.  Module paramaters
+9.  Contact information
+10. Credits
 
 
 1. Copyright
 ============
 Copyright (C) 2002-2004 by Luca Risolia <luca.risolia@studio.unibo.it>
 
+
+2. Disclaimer
+=============
 Winbond is a trademark of Winbond Electronics Corporation.
-This driver is not sponsored or developed by Winbond.
+This software is not sponsored or developed by Winbond.
 
 
-2. License
+3. License
 ==========
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -44,7 +48,7 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
 
-3. Overview
+4. Overview
 ===========
 This driver supports the video streaming capabilities of the devices mounting
 Winbond W9967CF and Winbond W9968CF JPEG USB Dual Mode Camera Chips. OV681
@@ -53,19 +57,15 @@ based cameras should be supported as well.
 The driver is divided into two modules: the basic one, "w9968cf", is needed for
 the supported devices to work; the second one, "w9968cf-vpp", is an optional
 module, which provides some useful video post-processing functions like video
-decoding, up-scaling and colour conversions. Once the driver is installed,
-every time an application tries to open a recognized device, "w9968cf" checks
-the presence of the "w9968cf-vpp" module and loads it automatically by default.
+decoding, up-scaling and colour conversions.
 
-Please keep in mind that official kernels do NOT include the second module for
-performance purposes. However it is always recommended to download and install
-the latest and complete release of the driver, replacing the existing one, if
-present: it will be still even possible not to load the "w9968cf-vpp" module at
-all, if you ever want to. Another important missing feature of the version in
-the official Linux 2.4 kernels is the writeable /proc filesystem interface.
+Note that the official kernels do neither include nor support the second
+module for performance purposes. Therefore, it is always recommended to
+download and install the latest and complete release of the driver,
+replacing the existing one, if present.
 
 The latest and full-featured version of the W996[87]CF driver can be found at:
-http://go.lamarinapunto.com/ . Please refer to the documentation included in
+http://www.linux-projects.org. Please refer to the documentation included in
 that package, if you are going to use it.
 
 Up to 32 cameras can be handled at the same time. They can be connected and
@@ -83,7 +83,7 @@ will be automatically loaded by default (provided that the kernel has been
 compiled with the automatic module loading option).
 
 
-4. Supported devices
+5. Supported devices
 ====================
 At the moment, known W996[87]CF and OV681 based devices are:
 - Aroma Digi Pen VGA Dual Mode ADG-5000 (unknown image sensor)
@@ -99,11 +99,9 @@ At the moment, known W996[87]CF and OV681 based devices are:
 
 If you know any other W996[87]CF or OV681 based cameras, please contact me.
 
-The list above does NOT imply that all those devices work with this driver: up
+The list above does not imply that all those devices work with this driver: up
 until now only webcams that have an image sensor supported by the "ovcamchip"
-module work. 
-For a list of supported image sensors, please visit the author's homepage on
-this module: http://alpha.dyndns.org/ov511/
+module work. Kernel messages will always tell you whether this is case.
 
 Possible external microcontrollers of those webcams are not supported: this
 means that still images cannot be downloaded from the device memory.
@@ -113,7 +111,7 @@ Furthermore, it's worth to note that I was only able to run tests on my
 additional testing and full support, would be much appreciated.
 
 
-5. Module dependencies
+6. Module dependencies
 ======================
 For it to work properly, the driver needs kernel support for Video4Linux, USB
 and I2C, and the "ovcamchip" module for the image sensor. Make sure you are not
@@ -157,7 +155,7 @@ And finally:
        CONFIG_USB_W9968CF=m
 
 
-6. Module loading
+7. Module loading
 =================
 To use the driver, it is necessary to load the "w9968cf" module into memory
 after every other module required.
@@ -166,6 +164,7 @@ Loading can be done this way, from root:
 
        [root@localhost home]# modprobe usbcore
        [root@localhost home]# modprobe i2c-core
+       [root@localhost home]# modprobe videodev
        [root@localhost home]# modprobe w9968cf
 
 At this point the pertinent devices should be recognized: "dmesg" can be used
@@ -181,7 +180,7 @@ explanation about them and which syntax to use, it is recommended to run the
        [root@locahost home]# modinfo w9968cf
 
 
-7. Module parameters
+8. Module parameters
 ====================
 Module parameters are listed below:
 -------------------------------------------------------------------------------
@@ -198,22 +197,6 @@ Note:            The kernel must be compiled with the CONFIG_KMOD option
                  enabled for the 'ovcamchip' module to be loaded and for
                  this parameter to be present.
 -------------------------------------------------------------------------------
-Name:           vppmod_load
-Type:           bool
-Syntax:         <0|1>
-Description:    Automatic 'w9968cf-vpp' module loading: 0 disabled, 1 enabled.
-                If enabled, every time an application attempts to open a
-                camera, 'insmod' searches for the video post-processing module
-                in the system and loads it automatically (if present).
-                The optional 'w9968cf-vpp' module adds extra image manipulation
-                capabilities to the 'w9968cf' module,like software up-scaling,
-                colour conversions and video decompression for very high frame
-                rates.
-Default:        1
-Note:           The kernel must be compiled with the CONFIG_KMOD option
-                enabled for the 'w9968cf-vpp' module to be loaded and for
-                this parameter to be present.
--------------------------------------------------------------------------------
 Name:           simcams 
 Type:           int 
 Syntax:         <n> 
@@ -452,7 +435,7 @@ Default:        0
 -------------------------------------------------------------------------------
 
 
-8. Contact information
+9. Contact information
 ======================
 I may be contacted by e-mail at <luca.risolia@studio.unibo.it>.
 
@@ -461,7 +444,7 @@ My public 1024-bit key should be available at your keyserver; the fingerprint
 is: '88E8 F32F 7244 68BA 3958  5D40 99DA 5D2A FCE6 35A4'.
 
 
-9. Credits
+10. Credits
 ==========
 The development would not have proceed much further without having looked at
 the source code of other drivers and without the help of several persons; in