README

   1 Microdia USB 2.0 Webcam Drivers
   2 ===============================
   3
   4 This Driver is essentially a fork of the Syntek Webcam drivers for Linux by Nicolas,
   5 specifically to accomodate Microdia chipset based Webcams.
   6
   7 Warning :
   8 The Microdia USB 2.0 Webcam Drivers for Microdia chipset based Webcams is currently under development.
   9 Using this driver can result in damage. Use this driver only if you know what you are doing.
  10
  11 ---------------------------------------------------------------------------------------------------
  12
  13 Table of contents :
  14
  15 1. Requirements
  16
  17 2. Compilation
  18  2.1 Documentation
  19  2.2 Kernel module
  20
  21 3. Installation
  22
  23 4. Usage
  24  4.1 Option "fps" module
  25  4.2 Options "hflip" and "vflip" module
  26  4.3 Options "contrast", "colour", "whiteness" and "brightness"
  27  4.4 Use the "sysfs"
  28
  29 5. Status of project
  30
  31 6. Test experimental
  32
  33 7. Debug
  34  7.1. 'lsusb' output
  35  7.2. USB logs from Windows
  36  7.3. USB logs from Linux
  37  7.4. Enable module traces
  38
  39 8. Licence
  40
  41 ---------------------------------------------------------------------------------------------------
  42
  43 1. Requirements
  44
  45 Kernel 2.6.18 or higher
  46 Doxygen in order to compile the documentation
  47
  48 ---------------------------------------------------------------------------------------------------
  49
  50 2. Compilation
  51
  52  2.1 Documentation
  53
  54    To build documentation :
  55    $ make doc
  56    $ make cleandoc
  57
  58  2.2 Kernel module
  59
  60    To build the kernel module :
  61    $ make
  62      or
  63    $ make driver
  64
  65    $ make clean
  66
  67 ---------------------------------------------------------------------------------------------------
  68
  69 3. Installation
  70
  71 TODO...
  72
  73 ---------------------------------------------------------------------------------------------------
  74
  75 4. Usage
  76
  77  4.1 Option "fps" module
  78
  79    The microdia module waits the option "fps" (10, 15, 20, 25, 30) :
  80    $ modprobe microdia fps=30
  81
  82    By default, the fps is set to '25'.
  83
  84  4.2 Options "hflip" and "vflip" module
  85
  86    The microdia module waits the options "hflip" and "vflip" (values are 0 or 1):
  87    $ modprobe microdia hflip=0 vflip=1
  88
  89    By default, the hflip and vflip are set to '1'.
  90
  91  4.3 Options "contrast", "colour", "brightness" and "whiteness"
  92
  93    The microdia module waits the options "contrast", "colour", "brightness" and "whiteness" :
  94    $ modprobe microdia contrast=0x7F00 colour=0x7F00
  95
  96    By default, the value of these options is set to '0x7F00'.
  97
  98  4.4 Use the "sysfs"
  99
 100    In the directory : /sys/class/video4linux/videoX (by sample video0), you
 101    can read and write some parameters :
 102    $ cat hflip
 103    $ echo 0 > hflip
 104
 105    To display informations about driver :
 106    $ cat informations
 107
 108          It is a register editor implemented. You can display and change the camera registers.
 109          To use this register editor see follow examples below:
 110
 111          0) open a shell and move to your video device (normaly video0)
 112           $ cd /sys/class/video4linux/video0
 113
 114          1) Set and display register adress 0x11b8
 115           $ echo 11b8 > adr     // set the adress value to 0x11b8
 116           $ cat adr             // command to display the adress value
 117           $ 0x11b8              // output
 118
 119          2) display the value from register 0x11b8
 120           $ cat reg             // command to display the register value
 121           $ 0x11b8 = 0x3a       // output
 122
 123          3) Set value from register 0x11b8 to 0x10
 124           $ echo 10 > reg
 125
 126
 127          I2C Interface:
 128
 129          4) I2C Interface: set read/write count,
 130             (how many bytes we want to read/write = 1/2)
 131                         (we are using the adr value for this)
 132
 133                 $ echo 1 > adr        // we want only to read / write one byte
 134
 135          5) I2C Interface: set i2c slave to 0x30
 136           $ echo 30 > i2cslave  // set the I2c slave adress to 0x30
 137           $ cat i2cslave        // command to display the I2cadress value
 138           $ 0x30                // output
 139
 140          6) I2C Interface: set i2c adress to 0x12
 141           $ echo 12 > i2cadr    // set the I2cadress value to 0x12
 142           $ cat i2cadr          // command to display the I2cadress value
 143           $ 0x12                // output
 144
 145          7) I2C Interface: Display I2c-register 0x12 (0x22 isn't valid, count is (1))
 146           $ cat i2creg          // command to display the I2c register value
 147           $ I2C-register 0x12 = 0x40 0x22 (1)
 148
 149          8) I2C Interface: Set I2c-register
 150          (you have to enter the values for 2 registers)
 151
 152           $ echo 4100 > i2creg  // set the I2c register value to 0x41
 153           $ cat i2creg          // command to display the I2c register value
 154           $ I2C-register 0x12 = 0x41 0x22 (1)
 155
 156
 157
 158
 159 ---------------------------------------------------------------------------------------------------
 160
 161 5. Status
 162
 163 The kernel module is currently under active development.
 164
 165 The driver supports following webcam models :
 166 - 0x0c45:0x627b :
 167 - 0x0c45:0x624e :
 168 - 0x0c45:0x624f :
 169
 170 To request support, please contact us on Microdia Mailing List:
 171
 172     http://groups.google.com/group/microdia
 173
 174 ---------------------------------------------------------------------------------------------------
 175
 176 6. Test experimental
 177
 178 To build and load the driver, follow the steps :
 179
 180 $ make -f Makefile clean
 181 $ make -f Makefile
 182 $ modprobe videodev
 183 $ insmod microdia.ko
 184
 185 To test the driver with the V4L v1 API (map methode) :
 186
 187 $ camorama -D --width=640 --height=480
 188
 189 To test the driver with the V4L v1 API (read methode) :
 190
 191 $ camorama -D -R --width=640 --height=480
 192
 193 To test the driver with the V4L v2 :
 194
 195 $ xawtv
 196
 197 To use mplayer / mencoder :
 198
 199 $ mplayer tv:// -tv driver=v4l:width=640:height=480
 200 $ mplayer tv:// -tv driver=v4l2:width=320:height=240:fps=25:outfmt=rgb24:device=/dev/video0
 201 $ mplayer tv:// -tv driver=v4l2:width=320:height=240:fps=25:outfmt=yuy2:device=/dev/video0
 202 $ mplayer tv:// -tv driver=v4l2:width=320:height=240:fps=25:outfmt=uyvy:device=/dev/video0
 203
 204 $ mencoder tv:// -tv driver=v4l:width=640:height=480:outfmt=rgb24:device=/dev/video0 -nosound -ovc lavc -o out.avi
 205 $ mencoder tv:// -tv driver=v4l2:width=320:height=240:fps=25:outfmt=rgb24:device=/dev/video0 -nosound -ovc lavc -o out.avi
 206
 207 ---------------------------------------------------------------------------------------------------
 208
 209 7. Debug
 210
 211  7.1. 'lsusb' output
 212
 213    [root@Dahlia driver]$ lsusb
 214    Bus 005 Device 003: ID 0c45:624f Microdia                    <== Our Webcam
 215    Bus 005 Device 001: ID 0000:0000
 216    Bus 004 Device 001: ID 0000:0000
 217    Bus 003 Device 002: ID 08ff:2580 AuthenTec, Inc.
 218    Bus 003 Device 001: ID 0000:0000
 219    Bus 002 Device 001: ID 0000:0000
 220    Bus 001 Device 004: ID 0a5c:2101 Broadcom Corp.
 221    Bus 001 Device 001: ID 0000:0000
 222
 223    [root@Dahlia driver]$ lsusb -d 0c45:624f -vvv > lsusb.txt
 224
 225  7.2. USB logs from Windows
 226    There are 3 useful USB logs :
 227    - Log 1 : when you plug your webcam
 228    - Log 2 : when you run VideoView.exe (with the default settings)
 229    - Log 3 : when you run VideoView.exe, then change the resolution to 1280x1024
 230
 231  7.3. USB logs from Linux
 232    Use the kernel module usbmon (enable option debugfs in the kernel)
 233
 234  7.4. Enable module traces
 235    You can enable : CONFIG_STK11XX_DEBUG and CONFIG_STK11XX_DEBUG_STREAM
 236
 237 ---------------------------------------------------------------------------------------------------
 238
 239 8. Licence
 240
 241 Microdia USB 2.0 Webcam Driver is distributed under the GPL licence (version 2 or later).
 242