Fix 6288 camera to work with hardware resolution changing
[microdia.git] / README
blobcd71b28f5a69915dd18bc72e8980827d290b4822
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. Compilation
26  2.1 Kernel module
27  2.2 Documentation
29 3. Testing
31 4. Installation
33 5. Usage
35 6. Status of project
37 7. Documentation & References
39 8. Contact
41 9. Licence
43 10. Disclaimer
45 --------------------------------------------------------------------------------
47 1. Requirements
49  1.1 Kernel module
51    To compile the driver you need :
52      Kernel 2.6.18 or higher
53      Kernel headers
54      make
55      gcc
57  1.2 Documentation
59    To compile the documentation you need :
60      doxygen
61      graphviz
63 --------------------------------------------------------------------------------
65 2. Compilation
67  2.1 Kernel module
69    To build the kernel module ("driver") :
70      $ make
71      (This will create the kernel object file called "microdia.ko".)
73  2.2 Documentation
75    To build the documentation :
76      $ make doc
77      $ make cleandoc
79 --------------------------------------------------------------------------------
81 3. Testing
83   To load the driver, follow these steps (as root) :
84     # modprobe videodev
85     # modprobe compat-ioctl32  // Only required for 64-bit Linux OS
86     # make insmod
88   To test the driver with a V4L2 compliant application, try mplayer :
89     $ mplayer tv:// -tv driver=v4l2:width=640:height=480:fps=25:device=/dev/video0 -vo x11
90     $ mplayer tv:// -tv driver=v4l2:width=640:height=480:fps=25:device=/dev/video0 -vo xv
92 --------------------------------------------------------------------------------
94 4. Install
96   $ strip -g microdia.ko
97   And as root :
98   # cp microdia.ko /lib/modules/`uname -r`/kernel/drivers/media/video/usbvideo/
99   # depmod -a
101 --------------------------------------------------------------------------------
103 5. Usage
105   We recommend to use v4l2ucp to improve image quality.
106     http://sourceforge.net/projects/v4l2ucp/
108 --------------------------------------------------------------------------------
110 6. Status
112   The kernel module is currently under active development.
114   Currently the driver supports following webcam models :
115     0c45:6242
116     0c45:624e
117     0c45:624f
118     0c45:6253
119     0c45:6260
120     0c45:6270
121     0c45:627b
122     0c45:627f
123     0c45:6288
124   The full list can be found here :
125     http://groups.google.com/group/microdia/web/project-status
127 --------------------------------------------------------------------------------
129 7. Contact
131   To request support, please contact us on Microdia Mailing List :
132     https://groups.google.com/group/microdia/
133     microdia@googlegroups.com
135 --------------------------------------------------------------------------------
136 8. More Documentation & References
138   All documentation & references for microdia webcam driver can be found at
139     http://groups.google.com/group/microdia/web
141   Latest version of this driver is usually available at the following location
142     http://repo.or.cz/w/microdia.git
143 --------------------------------------------------------------------------------
145 9. Licence
147   Microdia USB 2.0 Webcam Driver is distributed under the GPL licence version 2
148   or later (GPLv2+).
150 --------------------------------------------------------------------------------
152 10. Disclaimer
154   The Microdia Linux driver has no connection to "MICRODIA Ltd.". They are not
155   responsible for anything we do or our driver does and we are not responsible
156   for their actions or their hardware.