README

   1 Syntek USB 2.0 Video Camera
   2 ===========================
   3
   4 Note : The syntek USB 2.0 video camera driver for DC-1125 ans STK-1135 is currently being developed
   5 on Linux. This driver can do damages. Use this driver only if you know what you are doing.
   6
   7 ---------------------------------------------------------------------------------------------------
   8
   9 Table of contents :
  10
  11 1. Requirements
  12
  13 2. Compilation
  14  2.1 Documentation
  15  2.2 Kernel module
  16
  17 3. Installation
  18
  19 4. Usage
  20  4.1 Option "fps" module
  21  4.2 Options "hflip" and "vflip" module
  22  4.3 Options "contrast", "colour", "whiteness" and "brightness"
  23  4.4 Use the "sysfs"
  24
  25 5. Status of project
  26
  27 6. Test experimental
  28
  29 7. Debug
  30  7.1. 'lsusb' output
  31  7.2. USB logs from Windows
  32  7.3. USB logs from Linux
  33  7.4. Enable module traces
  34
  35 8. Licence
  36
  37 ---------------------------------------------------------------------------------------------------
  38
  39 1. Requirements
  40
  41 Kernel 2.6.18 or higher
  42 Doxygen to compile the documentation
  43
  44 ---------------------------------------------------------------------------------------------------
  45
  46 2. Compilation
  47
  48  2.1 Documentation
  49
  50    To build documentation :
  51    $ make -f Makefile.standalone doc
  52    $ make -f Makefile.standalone cleandoc
  53
  54  2.2 Kernel module
  55
  56    To build the kernel module :
  57    $ make -f Makefile.standalone
  58      or
  59    $ make -f Makefile.standalone driver
  60
  61    $ make -f Makefile.standalone clean
  62
  63 ---------------------------------------------------------------------------------------------------
  64
  65 3. Installation
  66
  67 TODO...
  68
  69 ---------------------------------------------------------------------------------------------------
  70
  71 4. Usage
  72
  73  4.1 Option "fps" module
  74
  75    The syntek module waits the option "fps" (10, 15, 20, 25, 30) :
  76    $ modprobe stk11xx fps=30
  77
  78    By default, the fps is set to '25'.
  79
  80  4.2 Options "hflip" and "vflip" module
  81
  82    The syntek module waits the options "hflip" and "vflip" (values are 0 or 1):
  83    $ modprobe stk11xx hflip=0 vflip=1
  84
  85    By default, the hflip and vflip are set to '1'.
  86
  87  4.3 Options "contrast", "colour", "brightness" and "whiteness"
  88
  89    The syntek module waits the options "contrast", "colour", "brightness" and "whiteness" :
  90    $ modprobe stk11xx contrast=0x7F00 colour=0x7F00
  91
  92    By default, the value of these options is set to '0x7F00'.
  93
  94  4.4 Use the "sysfs"
  95
  96    In the directory : /sys/class/video4linux/videoX (by sample video0), you
  97    can read and write some parameters :
  98    $ cat hflip
  99    $ echo 0 > hflip
 100
 101    To display informations about driver :
 102    $ cat informations
 103
 104 ---------------------------------------------------------------------------------------------------
 105
 106 5. Status
 107
 108 The kernel module is currently being developped.
 109
 110 The driver supports several webcam models :
 111 - 0x174F:0xA311 : Quiet good supported (developper's model)
 112 - 0x174F:0xA821 : Supported (only the video stream)
 113 - 0x174F:0x6A31 : Supported (only the video stream)
 114 - 0x05E1:0x0501 : Like '0x174F:0xA311' (it's the same model)
 115
 116 To increase the support, I need some help... Or somebody gives me the webcam !
 117
 118 ---------------------------------------------------------------------------------------------------
 119
 120 6. Test experimental
 121
 122 To build and load the driver, follow the steps :
 123
 124 $ make -f Makefile.standalone clean
 125 $ make -f Makefile.standalone
 126 $ modprobe videodev
 127 $ insmod stk11xx.ko
 128
 129 To test the driver with the V4L v1 API (map methode) :
 130
 131 $ camorama -D --width=640 --height=480
 132
 133 To test the driver with the V4L v1 API (read methode) :
 134
 135 $ camorama -D -R --width=640 --height=480
 136
 137 To test the driver with the V4L v2 :
 138
 139 $ xawtv
 140
 141 To use mplayer / mencoder :
 142
 143 $ mplayer tv:// -tv driver=v4l:width=640:height=480
 144 $ mplayer tv:// -tv driver=v4l2:width=320:height=240:fps=25:outfmt=rgb24:device=/dev/video0
 145 $ mplayer tv:// -tv driver=v4l2:width=320:height=240:fps=25:outfmt=yuy2:device=/dev/video0
 146 $ mplayer tv:// -tv driver=v4l2:width=320:height=240:fps=25:outfmt=uyvy:device=/dev/video0
 147
 148 $ mencoder tv:// -tv driver=v4l:width=640:height=480:outfmt=rgb24:device=/dev/video0 -nosound -ovc lavc -o out.avi
 149 $ mencoder tv:// -tv driver=v4l2:width=320:height=240:fps=25:outfmt=rgb24:device=/dev/video0 -nosound -ovc lavc -o out.avi
 150
 151 ---------------------------------------------------------------------------------------------------
 152
 153 7. Debug
 154
 155  7.1. 'lsusb' output
 156
 157    [root@Dahlia driver]$ lsusb
 158    Bus 002 Device 002: ID 046d:c047 Logitech, Inc.
 159    Bus 002 Device 001: ID 0000:0000
 160    Bus 005 Device 001: ID 0000:0000
 161    Bus 004 Device 002: ID 0b05:1712 ASUSTek Computer, Inc.
 162    Bus 004 Device 001: ID 0000:0000
 163    Bus 003 Device 001: ID 0000:0000
 164    Bus 001 Device 004: ID 174f:a311                     <== Our Webcam
 165    Bus 001 Device 001: ID 0000:0000
 166
 167    [root@Dahlia driver]$ lsusb -d 174f:a311 -vvv > lsusb.txt
 168
 169  7.2. USB logs from Windows
 170    There is 3 USB logs useful :
 171    - Log 1 : when you plug your webcam
 172    - Log 2 : when you run VideoView.exe (with the default settings)
 173    - Log 3 : when you run VideoView.exe, then change the resolution to 1280x1024
 174
 175  7.3. USB logs from Linux
 176    Use the kernel module usbmon (enable option debugfs in the kernel)
 177
 178  7.4. Enable module traces
 179    You can enable : CONFIG_STK11XX_DEBUG and CONFIG_STK11XX_DEBUG_STREAM
 180
 181 ---------------------------------------------------------------------------------------------------
 182
 183 8. Licence
 184
 185 The kernel module is distributed under the licence GPL.
 186