Commit 60f78052 authored by Luca Risolia's avatar Luca Risolia Committed by Greg Kroah-Hartman
Browse files

[PATCH] USB: Add ZC0301 Video4Linux2 driver



This patch adds a Video4Linux2 driver for ZC0301
Image Processor and Control Chip.
Signed-off-by: default avatarLuca Risolia <luca.risolia@studio.unibo.it>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@suse.de>
parent c4a1745a
ZC0301 Image Processor and Control Chip
Driver for Linux
=======================================
- Documentation -
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
============
Copyright (C) 2006 by Luca Risolia <luca.risolia@studio.unibo.it>
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
========================
This driver supports the video interface of the devices mounting the ZC0301
Image Processor and Control Chip.
The driver relies on the Video4Linux2 and USB core modules. It has been
designed to run properly on SMP systems as well.
The latest version of the ZC0301 driver can be found at the following URL:
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;
- video formats is standard JPEG in various compression qualities
(see also "Notes for V4L2 application developers" paragraph);
- full support for the capabilities of every possible image sensors that can
be connected to the ZC0301 bridges, including, for istance, red, green,
blue and global gain adjustments and exposure control (see "Supported
devices" paragraph for details);
- use of default color settings for sunlight conditions;
- 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:
# USB Multimedia devices
#
CONFIG_USB_ZC0301=m
6. Module loading
=================
To use the driver, it is necessary to load the "zc0301" module into memory
after every other module required: "videodev", "usbcore" and, depending on
the USB host controller you have, "ehci-hcd", "uhci-hcd" or "ohci-hcd".
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:
-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.
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
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)
Default: 0
-------------------------------------------------------------------------------
Name: debug
Type: ushort
Syntax: <n>
Description: Debugging information level, from 0 to 3:
0 = none (use carefully)
1 = critical errors
2 = significant informations
3 = more verbose messages
Level 3 is useful for testing only, when only one device
is used at the same time. It also shows some more informations
about the hardware being detected. This module parameter can be
changed at runtime thanks to the /sys filesystem interface.
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
--------- ----------
0x046d 0x08ae
The following image sensors are supported:
Model Manufacturer
----- ------------
PAS202BCB PixArt Imaging, Inc.
All the available control settings of each image sensor are supported through
the V4L2 interface.
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.
This driver supports the standard JPEG video format. The current compression
quality may vary from 0 to 3 and can be selected or queried thanks to the
VIDIOC_S_JPEGCOMP and VIDIOC_G_JPEGCOMP V4L2 ioctl's.
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
===========
- Informations about the chip internals to enable the I2C protocol have been
taken from the documentation of the ZC030x Video4Linux1 driver written by
Andrew Birkett <andy@nobugs.org>;
- Initialization values of the ZC0301 connected to the PAS202BCB image sensor
have been taken from the SPCA5XX driver maintained by
Michel Xhaard <mxhaard@magic.fr>
......@@ -2902,6 +2902,14 @@ L: video4linux-list@redhat.com
W: http://www.linux-projects.org
S: Maintained
USB ZC0301 DRIVER
P: Luca Risolia
M: luca.risolia@studio.unibo.it
L: linux-usb-devel@lists.sourceforge.net
L: video4linux-list@redhat.com
W: http://www.linux-projects.org
S: Maintained
USB ZD1201 DRIVER
P: Jeroen Vreeken
M: pe1rxq@amsat.org
......
......@@ -48,6 +48,7 @@ obj-$(CONFIG_USB_SN9C102) += media/
obj-$(CONFIG_USB_STV680) += media/
obj-$(CONFIG_USB_VICAM) += media/
obj-$(CONFIG_USB_W9968CF) += media/
obj-$(CONFIG_USB_ZC0301) += media/
obj-$(CONFIG_USB_CATC) += net/
obj-$(CONFIG_USB_KAWETH) += net/
......
......@@ -191,6 +191,21 @@ config USB_W9968CF
To compile this driver as a module, choose M here: the
module will be called w9968cf.
config USB_ZC0301
tristate "USB ZC0301 Image Processor and Control Chip support"
depends on USB && VIDEO_DEV
---help---
Say Y here if you want support for cameras based on the ZC0301
Image Processor and Control Chip.
See <file:Documentation/usb/zc0301.txt> for more informations.
This driver uses the Video For Linux API. You must say Y or M to
"Video For Linux" to use this driver.
To compile this driver as a module, choose M here: the
module will be called zc0301.
config USB_PWC
tristate "USB Philips Cameras"
depends on USB && VIDEO_DEV
......
......@@ -4,6 +4,7 @@
sn9c102-objs := sn9c102_core.o sn9c102_hv7131d.o sn9c102_mi0343.o sn9c102_ov7630.o sn9c102_pas106b.o sn9c102_pas202bcb.o sn9c102_tas5110c1b.o sn9c102_tas5130d1b.o
et61x251-objs := et61x251_core.o et61x251_tas5130d1b.o
zc0301-objs := zc0301_core.o zc0301_pas202bcb.o
obj-$(CONFIG_USB_DABUSB) += dabusb.o
obj-$(CONFIG_USB_DSBR) += dsbr100.o
......@@ -16,4 +17,5 @@ obj-$(CONFIG_USB_SN9C102) += sn9c102.o
obj-$(CONFIG_USB_STV680) += stv680.o
obj-$(CONFIG_USB_VICAM) += vicam.o usbvideo.o
obj-$(CONFIG_USB_W9968CF) += w9968cf.o
obj-$(CONFIG_USB_ZC0301) += zc0301.o
obj-$(CONFIG_USB_PWC) += pwc/
/***************************************************************************
* V4L2 driver for ZC0301 Image Processor and Control Chip *
* *
* Copyright (C) 2006 by Luca Risolia <luca.risolia@studio.unibo.it> *
* *
* 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. *
***************************************************************************/
#ifndef _ZC0301_H_
#define _ZC0301_H_
#include <linux/version.h>
#include <linux/usb.h>
#include <linux/videodev2.h>
#include <media/v4l2-common.h>
#include <linux/device.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/time.h>
#include <linux/wait.h>
#include <linux/types.h>
#include <linux/param.h>
#include <linux/mutex.h>
#include <linux/rwsem.h>
#include <asm/semaphore.h>
#include "zc0301_sensor.h"
/*****************************************************************************/
#define ZC0301_DEBUG
#define ZC0301_DEBUG_LEVEL 2
#define ZC0301_MAX_DEVICES 64
#define ZC0301_FORCE_MUNMAP 0
#define ZC0301_MAX_FRAMES 32
#define ZC0301_COMPRESSION_QUALITY 2
#define ZC0301_URBS 2
#define ZC0301_ISO_PACKETS 7
#define ZC0301_ALTERNATE_SETTING 7
#define ZC0301_URB_TIMEOUT msecs_to_jiffies(2 * ZC0301_ISO_PACKETS)
#define ZC0301_CTRL_TIMEOUT 100
#define ZC0301_FRAME_TIMEOUT 2 * 1000 * msecs_to_jiffies(1)
/*****************************************************************************/
ZC0301_ID_TABLE
ZC0301_SENSOR_TABLE
enum zc0301_frame_state {
F_UNUSED,
F_QUEUED,
F_GRABBING,
F_DONE,
F_ERROR,
};
struct zc0301_frame_t {
void* bufmem;
struct v4l2_buffer buf;
enum zc0301_frame_state state;
struct list_head frame;
unsigned long vma_use_count;
};
enum zc0301_dev_state {
DEV_INITIALIZED = 0x01,
DEV_DISCONNECTED = 0x02,
DEV_MISCONFIGURED = 0x04,
};
enum zc0301_io_method {
IO_NONE,
IO_READ,
IO_MMAP,
};
enum zc0301_stream_state {
STREAM_OFF,
STREAM_INTERRUPT,
STREAM_ON,
};
struct zc0301_module_param {
u8 force_munmap;
};
static DECLARE_RWSEM(zc0301_disconnect);
struct zc0301_device {
struct video_device* v4ldev;
struct zc0301_sensor* sensor;
struct usb_device* usbdev;
struct urb* urb[ZC0301_URBS];
void* transfer_buffer[ZC0301_URBS];
u8* control_buffer;
struct zc0301_frame_t *frame_current, frame[ZC0301_MAX_FRAMES];
struct list_head inqueue, outqueue;
u32 frame_count, nbuffers, nreadbuffers;
enum zc0301_io_method io;
enum zc0301_stream_state stream;
struct v4l2_jpegcompression compression;
struct zc0301_module_param module_param;
enum zc0301_dev_state state;
u8 users;
struct mutex dev_mutex, fileop_mutex;
spinlock_t queue_lock;
wait_queue_head_t open, wait_frame, wait_stream;
};
/*****************************************************************************/
void
zc0301_attach_sensor(struct zc0301_device* cam, struct zc0301_sensor* sensor)
{
cam->sensor = sensor;
cam->sensor->usbdev = cam->usbdev;
}
/*****************************************************************************/
#undef DBG
#undef KDBG
#ifdef ZC0301_DEBUG
# define DBG(level, fmt, args...) \
do { \
if (debug >= (level)) { \
if ((level) == 1) \
dev_err(&cam->usbdev->dev, fmt "\n", ## args); \
else if ((level) == 2) \
dev_info(&cam->usbdev->dev, fmt "\n", ## args); \
else if ((level) >= 3) \
dev_info(&cam->usbdev->dev, "[%s:%d] " fmt "\n", \
__FUNCTION__, __LINE__ , ## args); \
} \
} while (0)
# define KDBG(level, fmt, args...) \
do { \
if (debug >= (level)) { \
if ((level) == 1 || (level) == 2) \
pr_info("zc0301: " fmt "\n", ## args); \
else if ((level) == 3) \
pr_debug("zc0301: [%s:%d] " fmt "\n", __FUNCTION__, \
__LINE__ , ## args); \
} \
} while (0)
# define V4LDBG(level, name, cmd) \
do { \
if (debug >= (level)) \
v4l_print_ioctl(name, cmd); \
} while (0)
#else
# define DBG(level, fmt, args...) do {;} while(0)
# define KDBG(level, fmt, args...) do {;} while(0)
# define V4LDBG(level, name, cmd) do {;} while(0)
#endif
#undef PDBG
#define PDBG(fmt, args...) \
dev_info(&cam->usbdev->dev, "[%s:%d] " fmt "\n", \
__FUNCTION__, __LINE__ , ## args)
#undef PDBGG
#define PDBGG(fmt, args...) do {;} while(0) /* placeholder */
#endif /* _ZC0301_H_ */
This diff is collapsed.
/***************************************************************************
* Plug-in for PAS202BCB image sensor connected to the ZC030! Image *
* Processor and Control Chip *
* *
* Copyright (C) 2006 by Luca Risolia <luca.risolia@studio.unibo.it> *
* *
* Initialization values of the ZC0301 have been taken from the SPCA5XX *
* driver maintained by Michel Xhaard <mxhaard@magic.fr> *
* *
* 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. *
***************************************************************************/
#include <linux/delay.h>
#include "zc0301_sensor.h"
static struct zc0301_sensor pas202bcb;
static int pas202bcb_init(struct zc0301_device* cam)
{
int err = 0;
err += zc0301_write_reg(cam, 0x0002, 0x00);
err += zc0301_write_reg(cam, 0x0003, 0x02);
err += zc0301_write_reg(cam, 0x0004, 0x80);
err += zc0301_write_reg(cam, 0x0005, 0x01);
err += zc0301_write_reg(cam, 0x0006, 0xE0);
err += zc0301_write_reg(cam, 0x0098, 0x00);
err += zc0301_write_reg(cam, 0x009A, 0x03);
err += zc0301_write_reg(cam, 0x011A, 0x00);
err += zc0301_write_reg(cam, 0x011C, 0x03);
err += zc0301_write_reg(cam, 0x009B, 0x01);
err += zc0301_write_reg(cam, 0x009C, 0xE6);
err += zc0301_write_reg(cam, 0x009D, 0x02);
err += zc0301_write_reg(cam, 0x009E, 0x86);
err += zc0301_i2c_write(cam, 0x02, 0x02);
err += zc0301_i2c_write(cam, 0x0A, 0x01);
err += zc0301_i2c_write(cam, 0x0B, 0x01);
err += zc0301_i2c_write(cam, 0x0D, 0x00);
err += zc0301_i2c_write(cam, 0x12, 0x05);
err += zc0301_i2c_write(cam, 0x13, 0x63);
err += zc0301_i2c_write(cam, 0x15, 0x70);
err += zc0301_write_reg(cam, 0x0101, 0xB7);
err += zc0301_write_reg(cam, 0x0100, 0x0D);
err += zc0301_write_reg(cam, 0x0189, 0x06);
err += zc0301_write_reg(cam, 0x01AD, 0x00);
err += zc0301_write_reg(cam, 0x01C5, 0x03);
err += zc0301_write_reg(cam, 0x01CB, 0x13);
err += zc0301_write_reg(cam, 0x0250, 0x08);
err += zc0301_write_reg(cam, 0x0301, 0x08);
err += zc0301_write_reg(cam, 0x018D, 0x70);
err += zc0301_write_reg(cam, 0x0008, 0x03);
err += zc0301_write_reg(cam, 0x01C6, 0x04);
err += zc0301_write_reg(cam, 0x01CB, 0x07);
err += zc0301_write_reg(cam, 0x0120, 0x11);
err += zc0301_write_reg(cam, 0x0121, 0x37);
err += zc0301_write_reg(cam, 0x0122, 0x58);
err += zc0301_write_reg(cam, 0x0123, 0x79);
err += zc0301_write_reg(cam, 0x0124, 0x91);
err += zc0301_write_reg(cam, 0x0125, 0xA6);
err += zc0301_write_reg(cam, 0x0126, 0xB8);
err += zc0301_write_reg(cam, 0x0127, 0xC7);
err += zc0301_write_reg(cam, 0x0128, 0xD3);
err += zc0301_write_reg(cam, 0x0129, 0xDE);
err += zc0301_write_reg(cam, 0x012A, 0xE6);
err += zc0301_write_reg(cam, 0x012B, 0xED);
err += zc0301_write_reg(cam, 0x012C, 0xF3);
err += zc0301_write_reg(cam, 0x012D, 0xF8);
err += zc0301_write_reg(cam, 0x012E, 0xFB);
err += zc0301_write_reg(cam, 0x012F, 0xFF);
err += zc0301_write_reg(cam, 0x0130, 0x26);
err += zc0301_write_reg(cam, 0x0131, 0x23);
err += zc0301_write_reg(cam, 0x0132, 0x20);
err += zc0301_write_reg(cam, 0x0133, 0x1C);
err += zc0301_write_reg(cam, 0x0134, 0x16);
err += zc0301_write_reg(cam, 0x0135, 0x13);
err += zc0301_write_reg(cam, 0x0136, 0x10);
err += zc0301_write_reg(cam, 0x0137, 0x0D);
err += zc0301_write_reg(cam, 0x0138, 0x0B);
err += zc0301_write_reg(cam, 0x0139, 0x09);
err += zc0301_write_reg(cam, 0x013A, 0x07);
err += zc0301_write_reg(cam, 0x013B, 0x06);
err += zc0301_write_reg(cam, 0x013C, 0x05);
err += zc0301_write_reg(cam, 0x013D, 0x04);
err += zc0301_write_reg(cam, 0x013E, 0x03);
err += zc0301_write_reg(cam, 0x013F, 0x02);
err += zc0301_write_reg(cam, 0x010A, 0x4C);
err += zc0301_write_reg(cam, 0x010B, 0xF5);
err += zc0301_write_reg(cam, 0x010C, 0xFF);
err += zc0301_write_reg(cam, 0x010D, 0xF9);
err += zc0301_write_reg(cam, 0x010E, 0x51);
err += zc0301_write_reg(cam, 0x010F, 0xF5);
err += zc0301_write_reg(cam, 0x0110, 0xFB);
err += zc0301_write_reg(cam, 0x0111, 0xED);
err += zc0301_write_reg(cam, 0x0112, 0x5F);
err += zc0301_write_reg(cam, 0x0180, 0x00);
err += zc0301_write_reg(cam, 0x0019, 0x00);
err += zc0301_write_reg(cam, 0x0087, 0x20);
err += zc0301_write_reg(cam, 0x0088, 0x21);
err += zc0301_i2c_write(cam, 0x20, 0x02);
err += zc0301_i2c_write(cam, 0x21, 0x1B);
err += zc0301_i2c_write(cam, 0x03, 0x44);
err += zc0301_i2c_write(cam, 0x0E, 0x01);
err += zc0301_i2c_write(cam, 0x0F, 0x00);
err += zc0301_write_reg(cam, 0x01A9, 0x14);
err += zc0301_write_reg(cam, 0x01AA, 0x24);
err += zc0301_write_reg(cam, 0x0190, 0x00);
err += zc0301_write_reg(cam, 0x0191, 0x02);
err += zc0301_write_reg(cam, 0x0192, 0x1B);
err += zc0301_write_reg(cam, 0x0195, 0x00);
err += zc0301_write_reg(cam, 0x0196,