Blame view
Documentation/video4linux/zc0301.txt
8.38 KB
60f780528 [PATCH] USB: Add ... |
1 |
|
0230185d3 V4L/DVB (3838): Z... |
2 3 4 |
ZC0301 and ZC0301P Image Processor and Control Chip Driver for Linux =================================================== |
60f780528 [PATCH] USB: Add ... |
5 |
|
0230185d3 V4L/DVB (3838): Z... |
6 |
- Documentation - |
60f780528 [PATCH] USB: Add ... |
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
Index ===== 1. Copyright 2. Disclaimer 3. License 4. Overview and features 5. Module dependencies 6. Module loading 7. Module parameters 8. Supported devices 9. Notes for V4L2 application developers 10. Contact information 11. Credits 1. Copyright ============ |
7e3a06607 V4L/DVB (5063): Z... |
26 |
Copyright (C) 2006-2007 by Luca Risolia <luca.risolia@studio.unibo.it> |
60f780528 [PATCH] USB: Add ... |
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
2. Disclaimer ============= This software is not developed or sponsored by Z-Star Microelectronics Corp. Trademarks are property of their respective owner. 3. License ========== This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 4. Overview and features ======================== |
0230185d3 V4L/DVB (3838): Z... |
54 55 |
This driver supports the video interface of the devices mounting the ZC0301 or ZC0301P Image Processors and Control Chips. |
60f780528 [PATCH] USB: Add ... |
56 57 58 |
The driver relies on the Video4Linux2 and USB core modules. It has been designed to run properly on SMP systems as well. |
0230185d3 V4L/DVB (3838): Z... |
59 |
The latest version of the ZC0301[P] driver can be found at the following URL: |
60f780528 [PATCH] USB: Add ... |
60 61 62 63 64 65 66 67 68 |
http://www.linux-projects.org/ Some of the features of the driver are: - full compliance with the Video4Linux2 API (see also "Notes for V4L2 application developers" paragraph); - available mmap or read/poll methods for video streaming through isochronous data transfers; - automatic detection of image sensor; |
9e47a52bf [PATCH] USB: ZC03... |
69 |
- video format is standard JPEG; |
60f780528 [PATCH] USB: Add ... |
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
- dynamic driver control thanks to various module parameters (see "Module parameters" paragraph); - up to 64 cameras can be handled at the same time; they can be connected and disconnected from the host many times without turning off the computer, if the system supports hotplugging; 5. Module dependencies ====================== For it to work properly, the driver needs kernel support for Video4Linux and USB. The following options of the kernel configuration file must be enabled and corresponding modules must be compiled: # Multimedia devices # CONFIG_VIDEO_DEV=m # USB support # CONFIG_USB=m In addition, depending on the hardware being used, the modules below are necessary: # USB Host Controller Drivers # CONFIG_USB_EHCI_HCD=m CONFIG_USB_UHCI_HCD=m CONFIG_USB_OHCI_HCD=m The ZC0301 controller also provides a built-in microphone interface. It is supported by the USB Audio driver thanks to the ALSA API: # Sound # CONFIG_SOUND=y # Advanced Linux Sound Architecture # CONFIG_SND=m # USB devices # CONFIG_SND_USB_AUDIO=m And finally: |
0230185d3 V4L/DVB (3838): Z... |
118 |
# V4L USB devices |
60f780528 [PATCH] USB: Add ... |
119 120 121 122 123 124 125 |
# CONFIG_USB_ZC0301=m 6. Module loading ================= To use the driver, it is necessary to load the "zc0301" module into memory |
7e3a06607 V4L/DVB (5063): Z... |
126 127 128 |
after every other module required: "videodev", "v4l2_common", "compat_ioctl32", "usbcore" and, depending on the USB host controller you have, "ehci-hcd", "uhci-hcd" or "ohci-hcd". |
60f780528 [PATCH] USB: Add ... |
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
Loading can be done as shown below: [root@localhost home]# modprobe zc0301 At this point the devices should be recognized. You can invoke "dmesg" to analyze kernel messages and verify that the loading process has gone well: [user@localhost home]$ dmesg 7. Module parameters ==================== Module parameters are listed below: ------------------------------------------------------------------------------- Name: video_nr Type: short array (min = 0, max = 64) Syntax: <-1|n[,...]> Description: Specify V4L2 minor mode number: |
0230185d3 V4L/DVB (3838): Z... |
148 149 150 151 152 153 154 |
-1 = use next available n = use minor number n You can specify up to 64 cameras this way. For example: video_nr=-1,2,-1 would assign minor number 2 to the second registered camera and use auto for the first one and for every other camera. |
60f780528 [PATCH] USB: Add ... |
155 156 157 158 159 160 |
Default: -1 ------------------------------------------------------------------------------- Name: force_munmap Type: bool array (min = 0, max = 64) Syntax: <0|1[,...]> Description: Force the application to unmap previously mapped buffer memory |
0230185d3 V4L/DVB (3838): Z... |
161 162 163 164 165 |
before calling any VIDIOC_S_CROP or VIDIOC_S_FMT ioctl's. Not all the applications support this feature. This parameter is specific for each detected camera. 0 = do not force memory unmapping 1 = force memory unmapping (save memory) |
60f780528 [PATCH] USB: Add ... |
166 167 |
Default: 0 ------------------------------------------------------------------------------- |
a84742390 [PATCH] USB: ZC03... |
168 169 170 171 |
Name: frame_timeout Type: uint array (min = 0, max = 64) Syntax: <n[,...]> Description: Timeout for a video frame in seconds. This parameter is |
0230185d3 V4L/DVB (3838): Z... |
172 173 |
specific for each detected camera. This parameter can be changed at runtime thanks to the /sys filesystem interface. |
a84742390 [PATCH] USB: ZC03... |
174 175 |
Default: 2 ------------------------------------------------------------------------------- |
60f780528 [PATCH] USB: Add ... |
176 177 178 179 |
Name: debug Type: ushort Syntax: <n> Description: Debugging information level, from 0 to 3: |
0230185d3 V4L/DVB (3838): Z... |
180 181 |
0 = none (use carefully) 1 = critical errors |
f65e51d74 Documentation: fi... |
182 |
2 = significant information |
0230185d3 V4L/DVB (3838): Z... |
183 184 |
3 = more verbose messages Level 3 is useful for testing only, when only one device |
f65e51d74 Documentation: fi... |
185 |
is used at the same time. It also shows some information |
0230185d3 V4L/DVB (3838): Z... |
186 187 |
about the hardware being detected. This module parameter can be changed at runtime thanks to the /sys filesystem interface. |
60f780528 [PATCH] USB: Add ... |
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
Default: 2 ------------------------------------------------------------------------------- 8. Supported devices ==================== None of the names of the companies as well as their products will be mentioned here. They have never collaborated with the author, so no advertising. From the point of view of a driver, what unambiguously identify a device are its vendor and product USB identifiers. Below is a list of known identifiers of devices mounting the ZC0301 Image Processor and Control Chips: Vendor ID Product ID --------- ---------- |
6e0755a4b [PATCH] USB: ZC03... |
203 204 205 |
0x041e 0x4017 0x041e 0x401c 0x041e 0x401e |
0230185d3 V4L/DVB (3838): Z... |
206 207 |
0x041e 0x401f 0x041e 0x4022 |
6e0755a4b [PATCH] USB: ZC03... |
208 209 |
0x041e 0x4034 0x041e 0x4035 |
0230185d3 V4L/DVB (3838): Z... |
210 211 212 |
0x041e 0x4036 0x041e 0x403a 0x0458 0x7007 |
7e3a06607 V4L/DVB (5063): Z... |
213 |
0x0458 0x700c |
0230185d3 V4L/DVB (3838): Z... |
214 215 216 217 |
0x0458 0x700f 0x046d 0x08ae 0x055f 0xd003 0x055f 0xd004 |
a84742390 [PATCH] USB: ZC03... |
218 |
0x0ac8 0x0301 |
0230185d3 V4L/DVB (3838): Z... |
219 220 221 |
0x0ac8 0x301b 0x0ac8 0x303b 0x10fd 0x0128 |
6e0755a4b [PATCH] USB: ZC03... |
222 |
0x10fd 0x8050 |
0230185d3 V4L/DVB (3838): Z... |
223 |
0x10fd 0x804e |
60f780528 [PATCH] USB: Add ... |
224 |
|
a84742390 [PATCH] USB: ZC03... |
225 226 227 |
The list above does not imply that all those devices work with this driver: up until now only the ones that mount the following image sensors are supported; kernel messages will always tell you whether this is the case: |
60f780528 [PATCH] USB: Add ... |
228 229 230 231 |
Model Manufacturer ----- ------------ PAS202BCB PixArt Imaging, Inc. |
0230185d3 V4L/DVB (3838): Z... |
232 |
PB-0330 Photobit Corporation |
60f780528 [PATCH] USB: Add ... |
233 |
|
60f780528 [PATCH] USB: Add ... |
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
9. Notes for V4L2 application developers ======================================== This driver follows the V4L2 API specifications. In particular, it enforces two rules: - exactly one I/O method, either "mmap" or "read", is associated with each file descriptor. Once it is selected, the application must close and reopen the device to switch to the other I/O method; - although it is not mandatory, previously mapped buffer memory should always be unmapped before calling any "VIDIOC_S_CROP" or "VIDIOC_S_FMT" ioctl's. The same number of buffers as before will be allocated again to match the size of the new video frames, so you have to map the buffers again before any I/O attempts on them. |
60f780528 [PATCH] USB: Add ... |
249 250 251 252 253 254 255 256 257 258 259 260 |
10. Contact information ======================= The author may be contacted by e-mail at <luca.risolia@studio.unibo.it>. GPG/PGP encrypted e-mail's are accepted. The GPG key ID of the author is 'FCE635A4'; the public 1024-bit key should be available at any keyserver; the fingerprint is: '88E8 F32F 7244 68BA 3958 5D40 99DA 5D2A FCE6 35A4'. 11. Credits =========== |
f65e51d74 Documentation: fi... |
261 |
- Information about the chip internals needed to enable the I2C protocol have |
9e47a52bf [PATCH] USB: ZC03... |
262 263 |
been taken from the documentation of the ZC030x Video4Linux1 driver written by Andrew Birkett <andy@nobugs.org>; |
a84742390 [PATCH] USB: ZC03... |
264 |
- The initialization values of the ZC0301 controller connected to the PAS202BCB |
0230185d3 V4L/DVB (3838): Z... |
265 266 267 |
and PB-0330 image sensors have been taken from the SPCA5XX driver maintained by Michel Xhaard <mxhaard@magic.fr>; - Stanislav Lechev donated one camera. |