Documentation/usb/sn9c102.txt

   1
   2                          SN9C10x PC Camera Controllers
   3                                 Driver for Linux
   4                          =============================
   5
   6                                - Documentation -
   7
   8
   9 Index
  10 =====
  11 1.  Copyright
  12 2.  Disclaimer
  13 3.  License
  14 4.  Overview and features
  15 5.  Module dependencies
  16 6.  Module loading
  17 7.  Module parameters
  18 8.  Optional device control through "sysfs"
  19 9.  Supported devices
  20 10. Notes for V4L2 application developers
  21 11. Video frame formats
  22 12. Contact information
  23 13. Credits
  24
  25
  26 1. Copyright
  27 ============
  28 Copyright (C) 2004-2006 by Luca Risolia <luca.risolia@studio.unibo.it>
  29
  30
  31 2. Disclaimer
  32 =============
  33 SONiX is a trademark of SONiX Technology Company Limited, inc.
  34 This software is not sponsored or developed by SONiX.
  35
  36
  37 3. License
  38 ==========
  39 This program is free software; you can redistribute it and/or modify
  40 it under the terms of the GNU General Public License as published by
  41 the Free Software Foundation; either version 2 of the License, or
  42 (at your option) any later version.
  43
  44 This program is distributed in the hope that it will be useful,
  45 but WITHOUT ANY WARRANTY; without even the implied warranty of
  46 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  47 GNU General Public License for more details.
  48
  49 You should have received a copy of the GNU General Public License
  50 along with this program; if not, write to the Free Software
  51 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  52
  53
  54 4. Overview and features
  55 ========================
  56 This driver attempts to support the video interface of the devices mounting the
  57 SONiX SN9C101, SN9C102 and SN9C103 PC Camera Controllers.
  58
  59 It's worth to note that SONiX has never collaborated with the author during the
  60 development of this project, despite several requests for enough detailed
  61 specifications of the register tables, compression engine and video data format
  62 of the above chips. Nevertheless, these informations are no longer necessary,
  63 becouse all the aspects related to these chips are known and have been
  64 described in detail in this documentation.
  65
  66 The driver relies on the Video4Linux2 and USB core modules. It has been
  67 designed to run properly on SMP systems as well.
  68
  69 The latest version of the SN9C10x driver can be found at the following URL:
  70 http://www.linux-projects.org/
  71
  72 Some of the features of the driver are:
  73
  74 - full compliance with the Video4Linux2 API (see also "Notes for V4L2
  75   application developers" paragraph);
  76 - available mmap or read/poll methods for video streaming through isochronous
  77   data transfers;
  78 - automatic detection of image sensor;
  79 - support for built-in microphone interface;
  80 - support for any window resolutions and optional panning within the maximum
  81   pixel area of image sensor;
  82 - image downscaling with arbitrary scaling factors from 1, 2 and 4 in both
  83   directions (see "Notes for V4L2 application developers" paragraph);
  84 - two different video formats for uncompressed or compressed data in low or
  85   high compression quality (see also "Notes for V4L2 application developers"
  86   and "Video frame formats" paragraphs);
  87 - full support for the capabilities of many of the possible image sensors that
  88   can be connected to the SN9C10x bridges, including, for istance, red, green,
  89   blue and global gain adjustments and exposure (see "Supported devices"
  90   paragraph for details);
  91 - use of default color settings for sunlight conditions;
  92 - dynamic I/O interface for both SN9C10x and image sensor control and
  93   monitoring (see "Optional device control through 'sysfs'" paragraph);
  94 - dynamic driver control thanks to various module parameters (see "Module
  95   parameters" paragraph);
  96 - up to 64 cameras can be handled at the same time; they can be connected and
  97   disconnected from the host many times without turning off the computer, if
  98   the system supports hotplugging;
  99 - no known bugs.
 100
 101
 102 5. Module dependencies
 103 ======================
 104 For it to work properly, the driver needs kernel support for Video4Linux and
 105 USB.
 106
 107 The following options of the kernel configuration file must be enabled and
 108 corresponding modules must be compiled:
 109
 110         # Multimedia devices
 111         #
 112         CONFIG_VIDEO_DEV=m
 113
 114 To enable advanced debugging functionality on the device through /sysfs:
 115
 116         # Multimedia devices
 117         #
 118         CONFIG_VIDEO_ADV_DEBUG=y
 119
 120         # USB support
 121         #
 122         CONFIG_USB=m
 123
 124 In addition, depending on the hardware being used, the modules below are
 125 necessary:
 126
 127         # USB Host Controller Drivers
 128         #
 129         CONFIG_USB_EHCI_HCD=m
 130         CONFIG_USB_UHCI_HCD=m
 131         CONFIG_USB_OHCI_HCD=m
 132
 133 The SN9C103 controller also provides a built-in microphone interface. It is
 134 supported by the USB Audio driver thanks to the ALSA API:
 135
 136         # Sound
 137         #
 138         CONFIG_SOUND=y
 139
 140         # Advanced Linux Sound Architecture
 141         #
 142         CONFIG_SND=m
 143
 144         # USB devices
 145         #
 146         CONFIG_SND_USB_AUDIO=m
 147
 148 And finally:
 149
 150         # USB Multimedia devices
 151         #
 152         CONFIG_USB_SN9C102=m
 153
 154
 155 6. Module loading
 156 =================
 157 To use the driver, it is necessary to load the "sn9c102" module into memory
 158 after every other module required: "videodev", "usbcore" and, depending on
 159 the USB host controller you have, "ehci-hcd", "uhci-hcd" or "ohci-hcd".
 160
 161 Loading can be done as shown below:
 162
 163         [root@localhost home]# modprobe sn9c102
 164
 165 At this point the devices should be recognized. You can invoke "dmesg" to
 166 analyze kernel messages and verify that the loading process has gone well:
 167
 168         [user@localhost home]$ dmesg
 169
 170
 171 7. Module parameters
 172 ====================
 173 Module parameters are listed below:
 174 -------------------------------------------------------------------------------
 175 Name:           video_nr
 176 Type:           short array (min = 0, max = 64)
 177 Syntax:         <-1|n[,...]>
 178 Description:    Specify V4L2 minor mode number:
 179                 -1 = use next available
 180                  n = use minor number n
 181                 You can specify up to 64 cameras this way.
 182                 For example:
 183                 video_nr=-1,2,-1 would assign minor number 2 to the second
 184                 recognized camera and use auto for the first one and for every
 185                 other camera.
 186 Default:        -1
 187 -------------------------------------------------------------------------------
 188 Name:           force_munmap
 189 Type:           bool array (min = 0, max = 64)
 190 Syntax:         <0|1[,...]>
 191 Description:    Force the application to unmap previously mapped buffer memory
 192                 before calling any VIDIOC_S_CROP or VIDIOC_S_FMT ioctl's. Not
 193                 all the applications support this feature. This parameter is
 194                 specific for each detected camera.
 195                 0 = do not force memory unmapping
 196                 1 = force memory unmapping (save memory)
 197 Default:        0
 198 -------------------------------------------------------------------------------
 199 Name:           debug
 200 Type:           ushort
 201 Syntax:         <n>
 202 Description:    Debugging information level, from 0 to 3:
 203                 0 = none (use carefully)
 204                 1 = critical errors
 205                 2 = significant informations
 206                 3 = more verbose messages
 207                 Level 3 is useful for testing only, when only one device
 208                 is used. It also shows some more informations about the
 209                 hardware being detected. This parameter can be changed at
 210                 runtime thanks to the /sys filesystem interface.
 211 Default:        2
 212 -------------------------------------------------------------------------------
 213
 214
 215 8. Optional device control through "sysfs" [1]
 216 ==========================================
 217 If the kernel has been compiled with the CONFIG_VIDEO_ADV_DEBUG option enabled,
 218 it is possible to read and write both the SN9C10x and the image sensor
 219 registers by using the "sysfs" filesystem interface.
 220
 221 Every time a supported device is recognized, a write-only file named "green" is
 222 created in the /sys/class/video4linux/videoX directory. You can set the green
 223 channel's gain by writing the desired value to it. The value may range from 0
 224 to 15 for SN9C101 or SN9C102 bridges, from 0 to 127 for SN9C103 bridges.
 225 Similarly, only for SN9C103 controllers, blue and red gain control files are
 226 available in the same directory, for which accepted values may range from 0 to
 227 127.
 228
 229 There are other four entries in the directory above for each registered camera:
 230 "reg", "val", "i2c_reg" and "i2c_val". The first two files control the
 231 SN9C10x bridge, while the other two control the sensor chip. "reg" and
 232 "i2c_reg" hold the values of the current register index where the following
 233 reading/writing operations are addressed at through "val" and "i2c_val". Their
 234 use is not intended for end-users. Note that "i2c_reg" and "i2c_val" will not
 235 be created if the sensor does not actually support the standard I2C protocol or
 236 its registers are not 8-bit long. Also, remember that you must be logged in as
 237 root before writing to them.
 238
 239 As an example, suppose we were to want to read the value contained in the
 240 register number 1 of the sensor register table - which is usually the product
 241 identifier - of the camera registered as "/dev/video0":
 242
 243         [root@localhost #] cd /sys/class/video4linux/video0
 244         [root@localhost #] echo 1 > i2c_reg
 245         [root@localhost #] cat i2c_val
 246
 247 Note that "cat" will fail if sensor registers cannot be read.
 248
 249 Now let's set the green gain's register of the SN9C101 or SN9C102 chips to 2:
 250
 251         [root@localhost #] echo 0x11 > reg
 252         [root@localhost #] echo 2 > val
 253
 254 Note that the SN9C10x always returns 0 when some of its registers are read.
 255 To avoid race conditions, all the I/O accesses to the above files are
 256 serialized.
 257
 258 The sysfs interface also provides the "frame_header" entry, which exports the
 259 frame header of the most recent requested and captured video frame. The header
 260 is always 18-bytes long and is appended to every video frame by the SN9C10x
 261 controllers. As an example, this additional information can be used by the user
 262 application for implementing auto-exposure features via software.
 263
 264 The following table describes the frame header:
 265
 266 Byte #  Value         Description
 267 ------  -----         -----------
 268 0x00    0xFF          Frame synchronisation pattern.
 269 0x01    0xFF          Frame synchronisation pattern.
 270 0x02    0x00          Frame synchronisation pattern.
 271 0x03    0xC4          Frame synchronisation pattern.
 272 0x04    0xC4          Frame synchronisation pattern.
 273 0x05    0x96          Frame synchronisation pattern.
 274 0x06    0xXX          Unknown meaning. The exact value depends on the chip;
 275                       possible values are 0x00, 0x01 and 0x20.
 276 0x07    0xXX          Variable value, whose bits are ff00uzzc, where ff is a
 277                       frame counter, u is unknown, zz is a size indicator
 278                       (00 = VGA, 01 = SIF, 10 = QSIF) and c stands for
 279                       "compression enabled" (1 = yes, 0 = no).
 280 0x08    0xXX          Brightness sum inside Auto-Exposure area (low-byte).
 281 0x09    0xXX          Brightness sum inside Auto-Exposure area (high-byte).
 282                       For a pure white image, this number will be equal to 500
 283                       times the area of the specified AE area. For images
 284                       that are not pure white, the value scales down according
 285                       to relative whiteness.
 286 0x0A    0xXX          Brightness sum outside Auto-Exposure area (low-byte).
 287 0x0B    0xXX          Brightness sum outside Auto-Exposure area (high-byte).
 288                       For a pure white image, this number will be equal to 125
 289                       times the area outside of the specified AE area. For
 290                       images that are not pure white, the value scales down
 291                       according to relative whiteness.
 292                       according to relative whiteness.
 293
 294 The following bytes are used by the SN9C103 bridge only:
 295
 296 0x0C    0xXX          Unknown meaning
 297 0x0D    0xXX          Unknown meaning
 298 0x0E    0xXX          Unknown meaning
 299 0x0F    0xXX          Unknown meaning
 300 0x10    0xXX          Unknown meaning
 301 0x11    0xXX          Unknown meaning
 302
 303 The AE area (sx, sy, ex, ey) in the active window can be set by programming the
 304 registers 0x1c, 0x1d, 0x1e and 0x1f of the SN9C10x controllers, where one unit
 305 corresponds to 32 pixels.
 306
 307 [1] Part of the meaning of the frame header has been documented by Bertrik
 308     Sikken.
 309
 310
 311 9. Supported devices
 312 ====================
 313 None of the names of the companies as well as their products will be mentioned
 314 here. They have never collaborated with the author, so no advertising.
 315
 316 From the point of view of a driver, what unambiguously identify a device are
 317 its vendor and product USB identifiers. Below is a list of known identifiers of
 318 devices mounting the SN9C10x PC camera controllers:
 319
 320 Vendor ID  Product ID
 321 ---------  ----------
 322 0x0c45     0x6001
 323 0x0c45     0x6005
 324 0x0c45     0x6009
 325 0x0c45     0x600d
 326 0x0c45     0x6024
 327 0x0c45     0x6025
 328 0x0c45     0x6028
 329 0x0c45     0x6029
 330 0x0c45     0x602a
 331 0x0c45     0x602b
 332 0x0c45     0x602c
 333 0x0c45     0x602d
 334 0x0c45     0x602e
 335 0x0c45     0x6030
 336 0x0c45     0x6080
 337 0x0c45     0x6082
 338 0x0c45     0x6083
 339 0x0c45     0x6088
 340 0x0c45     0x608a
 341 0x0c45     0x608b
 342 0x0c45     0x608c
 343 0x0c45     0x608e
 344 0x0c45     0x608f
 345 0x0c45     0x60a0
 346 0x0c45     0x60a2
 347 0x0c45     0x60a3
 348 0x0c45     0x60a8
 349 0x0c45     0x60aa
 350 0x0c45     0x60ab
 351 0x0c45     0x60ac
 352 0x0c45     0x60ae
 353 0x0c45     0x60af
 354 0x0c45     0x60b0
 355 0x0c45     0x60b2
 356 0x0c45     0x60b3
 357 0x0c45     0x60b8
 358 0x0c45     0x60ba
 359 0x0c45     0x60bb
 360 0x0c45     0x60bc
 361 0x0c45     0x60be
 362
 363 The list above does not imply that all those devices work with this driver: up
 364 until now only the ones that mount the following image sensors are supported;
 365 kernel messages will always tell you whether this is the case:
 366
 367 Model       Manufacturer
 368 -----       ------------
 369 HV7131D     Hynix Semiconductor, Inc.
 370 MI-0343     Micron Technology, Inc.
 371 OV7630      OmniVision Technologies, Inc.
 372 PAS106B     PixArt Imaging, Inc.
 373 PAS202BCB   PixArt Imaging, Inc.
 374 TAS5110C1B  Taiwan Advanced Sensor Corporation
 375 TAS5130D1B  Taiwan Advanced Sensor Corporation
 376
 377 All the available control settings of each image sensor are supported through
 378 the V4L2 interface.
 379
 380 Donations of new models for further testing and support would be much
 381 appreciated. Non-available hardware will not be supported by the author of this
 382 driver.
 383
 384
 385 10. Notes for V4L2 application developers
 386 =========================================
 387 This driver follows the V4L2 API specifications. In particular, it enforces two
 388 rules:
 389
 390 - exactly one I/O method, either "mmap" or "read", is associated with each
 391 file descriptor. Once it is selected, the application must close and reopen the
 392 device to switch to the other I/O method;
 393
 394 - although it is not mandatory, previously mapped buffer memory should always
 395 be unmapped before calling any "VIDIOC_S_CROP" or "VIDIOC_S_FMT" ioctl's.
 396 The same number of buffers as before will be allocated again to match the size
 397 of the new video frames, so you have to map the buffers again before any I/O
 398 attempts on them.
 399
 400 Consistently with the hardware limits, this driver also supports image
 401 downscaling with arbitrary scaling factors from 1, 2 and 4 in both directions.
 402 However, the V4L2 API specifications don't correctly define how the scaling
 403 factor can be chosen arbitrarily by the "negotiation" of the "source" and
 404 "target" rectangles. To work around this flaw, we have added the convention
 405 that, during the negotiation, whenever the "VIDIOC_S_CROP" ioctl is issued, the
 406 scaling factor is restored to 1.
 407
 408 This driver supports two different video formats: the first one is the "8-bit
 409 Sequential Bayer" format and can be used to obtain uncompressed video data
 410 from the device through the current I/O method, while the second one provides
 411 "raw" compressed video data (without frame headers not related to the
 412 compressed data). The compression quality may vary from 0 to 1 and can be
 413 selected or queried thanks to the VIDIOC_S_JPEGCOMP and VIDIOC_G_JPEGCOMP V4L2
 414 ioctl's. For maximum flexibility, both the default active video format and the
 415 default compression quality depend on how the image sensor being used is
 416 initialized (as described in the documentation of the API for the image sensors
 417 supplied by this driver).
 418
 419
 420 11. Video frame formats [1]
 421 =======================
 422 The SN9C10x PC Camera Controllers can send images in two possible video
 423 formats over the USB: either native "Sequential RGB Bayer" or Huffman
 424 compressed. The latter is used to achieve high frame rates. The current video
 425 format may be selected or queried from the user application by calling the
 426 VIDIOC_S_FMT or VIDIOC_G_FMT ioctl's, as described in the V4L2 API
 427 specifications.
 428
 429 The name "Sequential Bayer" indicates the organization of the red, green and
 430 blue pixels in one video frame. Each pixel is associated with a 8-bit long
 431 value and is disposed in memory according to the pattern shown below:
 432
 433 B[0]   G[1]    B[2]    G[3]    ...   B[m-2]         G[m-1]
 434 G[m]   R[m+1]  G[m+2]  R[m+2]  ...   G[2m-2]        R[2m-1]
 435 ...
 436 ...                                  B[(n-1)(m-2)]  G[(n-1)(m-1)]
 437 ...                                  G[n(m-2)]      R[n(m-1)]
 438
 439 The above matrix also represents the sequential or progressive read-out mode of
 440 the (n, m) Bayer color filter array used in many CCD/CMOS image sensors.
 441
 442 One compressed video frame consists of a bitstream that encodes for every R, G,
 443 or B pixel the difference between the value of the pixel itself and some
 444 reference pixel value. Pixels are organised in the Bayer pattern and the Bayer
 445 sub-pixels are tracked individually and alternatingly. For example, in the
 446 first line values for the B and G1 pixels are alternatingly encoded, while in
 447 the second line values for the G2 and R pixels are alternatingly encoded.
 448
 449 The pixel reference value is calculated as follows:
 450 - the 4 top left pixels are encoded in raw uncompressed 8-bit format;
 451 - the value in the top two rows is the value of the pixel left of the current
 452   pixel;
 453 - the value in the left column is the value of the pixel above the current
 454   pixel;
 455 - for all other pixels, the reference value is the average of the value of the
 456   pixel on the left and the value of the pixel above the current pixel;
 457 - there is one code in the bitstream that specifies the value of a pixel
 458   directly (in 4-bit resolution);
 459 - pixel values need to be clamped inside the range [0..255] for proper
 460   decoding.
 461
 462 The algorithm purely describes the conversion from compressed Bayer code used
 463 in the SN9C10x chips to uncompressed Bayer. Additional steps are required to
 464 convert this to a color image (i.e. a color interpolation algorithm).
 465
 466 The following Huffman codes have been found:
 467 0: +0 (relative to reference pixel value)
 468 100: +4
 469 101: -4?
 470 1110xxxx: set absolute value to xxxx.0000
 471 1101: +11
 472 1111: -11
 473 11001: +20
 474 110000: -20
 475 110001: ??? - these codes are apparently not used
 476
 477 [1] The Huffman compression algorithm has been reverse-engineered and
 478     documented by Bertrik Sikken.
 479
 480
 481 12. Contact information
 482 =======================
 483 The author may be contacted by e-mail at <luca.risolia@studio.unibo.it>.
 484
 485 GPG/PGP encrypted e-mail's are accepted. The GPG key ID of the author is
 486 'FCE635A4'; the public 1024-bit key should be available at any keyserver;
 487 the fingerprint is: '88E8 F32F 7244 68BA 3958  5D40 99DA 5D2A FCE6 35A4'.
 488
 489
 490 13. Credits
 491 ===========
 492 Many thanks to following persons for their contribute (listed in alphabetical
 493 order):
 494
 495 - Luca Capello for the donation of a webcam;
 496 - Joao Rodrigo Fuzaro, Joao Limirio, Claudio Filho and Caio Begotti for the
 497   donation of a webcam;
 498 - Jon Hollstrom for the donation of a webcam;
 499 - Carlos Eduardo Medaglia Dyonisio, who added the support for the PAS202BCB
 500   image sensor;
 501 - Stefano Mozzi, who donated 45 EU;
 502 - Andrew Pearce for the donation of a webcam;
 503 - Bertrik Sikken, who reverse-engineered and documented the Huffman compression
 504   algorithm used in the SN9C10x controllers and implemented the first decoder;
 505 - Mizuno Takafumi for the donation of a webcam;
 506 - an "anonymous" donator (who didn't want his name to be revealed) for the
 507   donation of a webcam.