README

   1 Microdia USB 2.0 Webcam Driver
   2 ==============================
   3
   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.
   6
   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.
  10
  11 This driver currently supports Skype v2.x, Ekiga v2.x & even aMSN
  12
  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 --------------------------------------------------------------------------------
  18
  19 Table of contents :
  20
  21 1. Requirements
  22  1.1 Kernel module
  23  1.2 Documentation
  24  1.3 Decoder
  25
  26 2. Available Packages
  27
  28 3. Compilation
  29  3.1 Kernel module
  30  3.2 Documentation
  31
  32 4. Testing
  33
  34 5. Installation
  35
  36 6. Usage
  37
  38 7. Status of project
  39
  40 8. Documentation & References
  41
  42 9. Contact
  43
  44 10. Licence
  45
  46 11. Disclaimer
  47
  48 --------------------------------------------------------------------------------
  49
  50 1. Requirements
  51
  52  1.1 Kernel module
  53
  54    To compile the driver you need :
  55      Kernel 2.6.22 or higher
  56      Kernel headers
  57      make
  58      gcc
  59
  60  1.2 Documentation
  61
  62    To compile the documentation you need :
  63      doxygen
  64      graphviz
  65
  66  1.3 Decoder
  67
  68    Most video applications do not support the image encoding SN9C20x-based
  69    webcams offer. To convert the image stream for such applications use
  70    "libv4l". Most distributions offer precompiled packages. If yours does not,
  71    the sources are available here :
  72      http://freshmeat.net/projects/libv4l/
  73
  74    Instructions for use of libv4l are available here (chapter "V4L library") :
  75      http://moinejf.free.fr/gspca_README.txt
  76
  77 --------------------------------------------------------------------------------
  78
  79 2. Available Packages
  80
  81   There are packages for various distributions available here :
  82     http://repo.or.cz/w/pkgmicrodia.git
  83
  84 --------------------------------------------------------------------------------
  85
  86 3. Compilation
  87
  88  3.1 Kernel module
  89
  90    To build the kernel module ("driver") :
  91      $ make
  92      (This will create the kernel object file called "microdia.ko".)
  93
  94  3.2 Documentation
  95
  96    To build the documentation :
  97      $ make doc
  98      $ make cleandoc
  99
 100 --------------------------------------------------------------------------------
 101
 102 4. Testing
 103
 104   To load the driver, follow these steps (as root) :
 105     # modprobe videodev
 106     # modprobe compat-ioctl32  // Only required for 64-bit Linux OS
 107     # make insmod
 108
 109   To test the driver with a V4L2 compliant application, try mplayer :
 110     $ mplayer tv:// -tv driver=v4l2:width=640:height=480:fps=25:device=/dev/video0 -vo x11
 111     $ mplayer tv:// -tv driver=v4l2:width=640:height=480:fps=25:device=/dev/video0 -vo xv
 112
 113   Note: Some applications require libv4l for decoding. (see "1.3 Decoder")
 114
 115 --------------------------------------------------------------------------------
 116
 117 5. Install
 118
 119   $ strip -g microdia.ko
 120   And as root :
 121   # cp microdia.ko /lib/modules/`uname -r`/kernel/drivers/media/video/usbvideo/
 122   # depmod -a
 123
 124 --------------------------------------------------------------------------------
 125
 126 6. Usage
 127
 128   We recommend to use v4l2ucp to improve image quality.
 129     http://sourceforge.net/projects/v4l2ucp/
 130
 131   We also develop our own GUI, available here :
 132     http://repo.or.cz/r/guimicrodia.git
 133
 134 --------------------------------------------------------------------------------
 135
 136 7. Status
 137
 138   The kernel module is currently under active development.
 139
 140   Currently the driver supports following webcam models :
 141     0c45:6242
 142     0c45:624e
 143     0c45:624f
 144     0c45:6253
 145     0c45:6260
 146     0c45:6270
 147     0c45:627b
 148     0c45:627f
 149     0c45:6288
 150   The full list can be found here :
 151     http://groups.google.com/group/microdia/web/project-status
 152
 153 --------------------------------------------------------------------------------
 154
 155 8. Contact
 156
 157   To request support, please contact us on Microdia Mailing List :
 158     https://groups.google.com/group/microdia/
 159     microdia@googlegroups.com
 160
 161 --------------------------------------------------------------------------------
 162
 163 9. More Documentation & References
 164
 165   All documentation and references for microdia webcam driver can be found at
 166     http://groups.google.com/group/microdia/web
 167
 168   Latest version of this driver is usually available at the following location
 169     http://repo.or.cz/w/microdia.git
 170
 171 --------------------------------------------------------------------------------
 172
 173 10. Licence
 174
 175   Microdia USB 2.0 Webcam Driver is distributed under the GPL licence version 2
 176   or later (GPLv2+).
 177
 178 --------------------------------------------------------------------------------
 179
 180 11. Disclaimer
 181
 182   The Microdia Linux driver has no connection to "MICRODIA Ltd." or "Sonix
 183   Technology Co., Ltd.". They are not responsible for anything we do or our
 184   driver does and we are not responsible for their actions or their hardware.