Updated README
[microdia.git] / README
blob49827bf20a41de68c1336d9a068544e532a84ff5
1 Microdia USB 2.0 Webcam Driver
2 ==============================
4 This Driver is essentially a fork of the Syntek Webcam drivers for Linux
5 by Nicolas Vivien, specifically to accomodate SN9C20x chipset based Webcams.
7 The driver currently supports the latest version of Video For Linux i.e
8 V4L2. V4L1 is deprecated, and applications like Camorama that use only V4L1 will
9 no longer work.
11 This driver currently supports Skype v2.x, Ekiga v2.x & even aMSN
13 Warning :
14 The Microdia USB 2.0 Webcam Driver for SN9C20x chipset based Webcams is
15 currently under development. Using this driver can result in damage.
16 Use this driver only if you know what you are doing.
17 --------------------------------------------------------------------------------
19 Table of contents :
21 1. Requirements
22  1.1 Kernel module
23  1.2 Documentation
25 2. Available Packages
27 3. Compilation
28  3.1 Kernel module
29  3.2 Documentation
31 4. Testing
33 5. Installation
35 6. Usage
37 7. Status of project
39 8. Documentation & References
41 9. Contact
43 10. Licence
45 11. Disclaimer
47 --------------------------------------------------------------------------------
49 1. Requirements
51  1.1 Kernel module
53    To compile the driver you need :
54      Kernel 2.6.18 or higher
55      Kernel headers
56      make
57      gcc
59  1.2 Documentation
61    To compile the documentation you need :
62      doxygen
63      graphviz
65 --------------------------------------------------------------------------------
67 2. Available Packages
69   There are packages for various distributions available here:
70     http://repo.or.cz/w/pkgmicrodia.git
72 --------------------------------------------------------------------------------
74 3. Compilation
76  3.1 Kernel module
78    To build the kernel module ("driver") :
79      $ make
80      (This will create the kernel object file called "microdia.ko".)
82  3.2 Documentation
84    To build the documentation :
85      $ make doc
86      $ make cleandoc
88 --------------------------------------------------------------------------------
90 4. Testing
92   To load the driver, follow these steps (as root) :
93     # modprobe videodev
94     # modprobe compat-ioctl32  // Only required for 64-bit Linux OS
95     # make insmod
97   To test the driver with a V4L2 compliant application, try mplayer :
98     $ mplayer tv:// -tv driver=v4l2:width=640:height=480:fps=25:device=/dev/video0 -vo x11
99     $ mplayer tv:// -tv driver=v4l2:width=640:height=480:fps=25:device=/dev/video0 -vo xv
101 --------------------------------------------------------------------------------
103 5. Install
105   $ strip -g microdia.ko
106   And as root :
107   # cp microdia.ko /lib/modules/`uname -r`/kernel/drivers/media/video/usbvideo/
108   # depmod -a
110 --------------------------------------------------------------------------------
112 6. Usage
114   We recommend to use v4l2ucp to improve image quality.
115     http://sourceforge.net/projects/v4l2ucp/
117   We also develop our own gui, available here:
118     http://repo.or.cz/r/guimicrodia.git
120 --------------------------------------------------------------------------------
122 7. Status
124   The kernel module is currently under active development.
126   Currently the driver supports following webcam models :
127     0c45:6242
128     0c45:624e
129     0c45:624f
130     0c45:6253
131     0c45:6260
132     0c45:6270
133     0c45:627b
134     0c45:627f
135     0c45:6288
136   The full list can be found here :
137     http://groups.google.com/group/microdia/web/project-status
139 --------------------------------------------------------------------------------
141 8. Contact
143   To request support, please contact us on Microdia Mailing List :
144     https://groups.google.com/group/microdia/
145     microdia@googlegroups.com
147 --------------------------------------------------------------------------------
149 9. More Documentation & References
151   All documentation and references for microdia webcam driver can be found at
152     http://groups.google.com/group/microdia/web
154   Latest version of this driver is usually available at the following location
155     http://repo.or.cz/w/microdia.git
157 --------------------------------------------------------------------------------
159 10. Licence
161   Microdia USB 2.0 Webcam Driver is distributed under the GPL licence version 2
162   or later (GPLv2+).
164 --------------------------------------------------------------------------------
166 11. Disclaimer
168   The Microdia Linux driver has no connection to "MICRODIA Ltd.". They are not
169   responsible for anything we do or our driver does and we are not responsible
170   for their actions or their hardware.