| /* (C) 1999-2003 Nemosoft Unv. |
| (C) 2004-2006 Luc Saillard (luc@saillard.org) |
| |
| NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx |
| driver and thus may have bugs that are not present in the original version. |
| Please send bug reports and support requests to <luc@saillard.org>. |
| The decompression routines have been implemented by reverse-engineering the |
| Nemosoft binary pwcx module. Caveat emptor. |
| |
| 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| */ |
| |
| #ifndef PWC_H |
| #define PWC_H |
| |
| #include <linux/module.h> |
| #include <linux/usb.h> |
| #include <linux/spinlock.h> |
| #include <linux/wait.h> |
| #include <linux/smp_lock.h> |
| #include <linux/version.h> |
| #include <linux/mutex.h> |
| #include <linux/mm.h> |
| #include <asm/errno.h> |
| #include <linux/videodev.h> |
| #include <media/v4l2-common.h> |
| #include <media/v4l2-ioctl.h> |
| |
| #include "pwc-uncompress.h" |
| #include <media/pwc-ioctl.h> |
| |
| /* Version block */ |
| #define PWC_MAJOR 10 |
| #define PWC_MINOR 0 |
| #define PWC_EXTRAMINOR 12 |
| #define PWC_VERSION_CODE KERNEL_VERSION(PWC_MAJOR,PWC_MINOR,PWC_EXTRAMINOR) |
| #define PWC_VERSION "10.0.13" |
| #define PWC_NAME "pwc" |
| #define PFX PWC_NAME ": " |
| |
| |
| /* Trace certain actions in the driver */ |
| #define PWC_DEBUG_LEVEL_MODULE (1<<0) |
| #define PWC_DEBUG_LEVEL_PROBE (1<<1) |
| #define PWC_DEBUG_LEVEL_OPEN (1<<2) |
| #define PWC_DEBUG_LEVEL_READ (1<<3) |
| #define PWC_DEBUG_LEVEL_MEMORY (1<<4) |
| #define PWC_DEBUG_LEVEL_FLOW (1<<5) |
| #define PWC_DEBUG_LEVEL_SIZE (1<<6) |
| #define PWC_DEBUG_LEVEL_IOCTL (1<<7) |
| #define PWC_DEBUG_LEVEL_TRACE (1<<8) |
| |
| #define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args) |
| #define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args) |
| #define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args) |
| #define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args) |
| #define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args) |
| #define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args) |
| #define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args) |
| #define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args) |
| #define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args) |
| |
| |
| #ifdef CONFIG_USB_PWC_DEBUG |
| |
| #define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE) |
| |
| #define PWC_DEBUG(level, fmt, args...) do {\ |
| if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \ |
| printk(KERN_DEBUG PFX fmt, ##args); \ |
| } while(0) |
| |
| #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args) |
| #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args) |
| #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args) |
| #define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args) |
| |
| #else /* if ! CONFIG_USB_PWC_DEBUG */ |
| |
| #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args) |
| #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args) |
| #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args) |
| #define PWC_TRACE(fmt, args...) do { } while(0) |
| #define PWC_DEBUG(level, fmt, args...) do { } while(0) |
| |
| #define pwc_trace 0 |
| |
| #endif |
| |
| /* Defines for ToUCam cameras */ |
| #define TOUCAM_HEADER_SIZE 8 |
| #define TOUCAM_TRAILER_SIZE 4 |
| |
| #define FEATURE_MOTOR_PANTILT 0x0001 |
| #define FEATURE_CODEC1 0x0002 |
| #define FEATURE_CODEC2 0x0004 |
| |
| /* Turn certain features on/off */ |
| #define PWC_INT_PIPE 0 |
| |
| /* Ignore errors in the first N frames, to allow for startup delays */ |
| #define FRAME_LOWMARK 5 |
| |
| /* Size and number of buffers for the ISO pipe. */ |
| #define MAX_ISO_BUFS 2 |
| #define ISO_FRAMES_PER_DESC 10 |
| #define ISO_MAX_FRAME_SIZE 960 |
| #define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE) |
| |
| /* Frame buffers: contains compressed or uncompressed video data. */ |
| #define MAX_FRAMES 5 |
| /* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */ |
| #define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE) |
| |
| /* Absolute maximum number of buffers available for mmap() */ |
| #define MAX_IMAGES 10 |
| |
| /* Some macros to quickly find the type of a webcam */ |
| #define DEVICE_USE_CODEC1(x) ((x)<675) |
| #define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700) |
| #define DEVICE_USE_CODEC3(x) ((x)>=700) |
| #define DEVICE_USE_CODEC23(x) ((x)>=675) |
| |
| |
| #ifndef V4L2_PIX_FMT_PWC1 |
| #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1') |
| #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2') |
| #endif |
| |
| /* The following structures were based on cpia.h. Why reinvent the wheel? :-) */ |
| struct pwc_iso_buf |
| { |
| void *data; |
| int length; |
| int read; |
| struct urb *urb; |
| }; |
| |
| /* intermediate buffers with raw data from the USB cam */ |
| struct pwc_frame_buf |
| { |
| void *data; |
| volatile int filled; /* number of bytes filled */ |
| struct pwc_frame_buf *next; /* list */ |
| }; |
| |
| /* additionnal informations used when dealing image between kernel and userland */ |
| struct pwc_imgbuf |
| { |
| unsigned long offset; /* offset of this buffer in the big array of image_data */ |
| int vma_use_count; /* count the number of time this memory is mapped */ |
| }; |
| |
| struct pwc_device |
| { |
| struct video_device *vdev; |
| |
| /* Pointer to our usb_device */ |
| struct usb_device *udev; |
| |
| int type; /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */ |
| int release; /* release number */ |
| int features; /* feature bits */ |
| char serial[30]; /* serial number (string) */ |
| int error_status; /* set when something goes wrong with the cam (unplugged, USB errors) */ |
| int usb_init; /* set when the cam has been initialized over USB */ |
| |
| /*** Video data ***/ |
| int vopen; /* flag */ |
| int vendpoint; /* video isoc endpoint */ |
| int vcinterface; /* video control interface */ |
| int valternate; /* alternate interface needed */ |
| int vframes, vsize; /* frames-per-second & size (see PSZ_*) */ |
| int vpalette; /* palette: 420P, RAW or RGBBAYER */ |
| int vframe_count; /* received frames */ |
| int vframes_dumped; /* counter for dumped frames */ |
| int vframes_error; /* frames received in error */ |
| int vmax_packet_size; /* USB maxpacket size */ |
| int vlast_packet_size; /* for frame synchronisation */ |
| int visoc_errors; /* number of contiguous ISOC errors */ |
| int vcompression; /* desired compression factor */ |
| int vbandlength; /* compressed band length; 0 is uncompressed */ |
| char vsnapshot; /* snapshot mode */ |
| char vsync; /* used by isoc handler */ |
| char vmirror; /* for ToUCaM series */ |
| char unplugged; |
| |
| int cmd_len; |
| unsigned char cmd_buf[13]; |
| |
| /* The image acquisition requires 3 to 4 steps: |
| 1. data is gathered in short packets from the USB controller |
| 2. data is synchronized and packed into a frame buffer |
| 3a. in case data is compressed, decompress it directly into image buffer |
| 3b. in case data is uncompressed, copy into image buffer with viewport |
| 4. data is transferred to the user process |
| |
| Note that MAX_ISO_BUFS != MAX_FRAMES != MAX_IMAGES.... |
| We have in effect a back-to-back-double-buffer system. |
| */ |
| /* 1: isoc */ |
| struct pwc_iso_buf sbuf[MAX_ISO_BUFS]; |
| char iso_init; |
| |
| /* 2: frame */ |
| struct pwc_frame_buf *fbuf; /* all frames */ |
| struct pwc_frame_buf *empty_frames, *empty_frames_tail; /* all empty frames */ |
| struct pwc_frame_buf *full_frames, *full_frames_tail; /* all filled frames */ |
| struct pwc_frame_buf *fill_frame; /* frame currently being filled */ |
| struct pwc_frame_buf *read_frame; /* frame currently read by user process */ |
| int frame_header_size, frame_trailer_size; |
| int frame_size; |
| int frame_total_size; /* including header & trailer */ |
| int drop_frames; |
| |
| /* 3: decompression */ |
| void *decompress_data; /* private data for decompression engine */ |
| |
| /* 4: image */ |
| /* We have an 'image' and a 'view', where 'image' is the fixed-size image |
| as delivered by the camera, and 'view' is the size requested by the |
| program. The camera image is centered in this viewport, laced with |
| a gray or black border. view_min <= image <= view <= view_max; |
| */ |
| int image_mask; /* bitmask of supported sizes */ |
| struct pwc_coord view_min, view_max; /* minimum and maximum viewable sizes */ |
| struct pwc_coord abs_max; /* maximum supported size with compression */ |
| struct pwc_coord image, view; /* image and viewport size */ |
| struct pwc_coord offset; /* offset within the viewport */ |
| |
| void *image_data; /* total buffer, which is subdivided into ... */ |
| struct pwc_imgbuf images[MAX_IMAGES];/* ...several images... */ |
| int fill_image; /* ...which are rotated. */ |
| int len_per_image; /* length per image */ |
| int image_read_pos; /* In case we read data in pieces, keep track of were we are in the imagebuffer */ |
| int image_used[MAX_IMAGES]; /* For MCAPTURE and SYNC */ |
| |
| struct mutex modlock; /* to prevent races in video_open(), etc */ |
| spinlock_t ptrlock; /* for manipulating the buffer pointers */ |
| |
| /*** motorized pan/tilt feature */ |
| struct pwc_mpt_range angle_range; |
| int pan_angle; /* in degrees * 100 */ |
| int tilt_angle; /* absolute angle; 0,0 is home position */ |
| int snapshot_button_status; /* set to 1 when the user push the button, reset to 0 when this value is read */ |
| |
| /*** Misc. data ***/ |
| wait_queue_head_t frameq; /* When waiting for a frame to finish... */ |
| #if PWC_INT_PIPE |
| void *usb_int_handler; /* for the interrupt endpoint */ |
| #endif |
| }; |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* Global variables */ |
| #ifdef CONFIG_USB_PWC_DEBUG |
| extern int pwc_trace; |
| #endif |
| extern int pwc_mbufs; |
| |
| /** functions in pwc-if.c */ |
| int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot); |
| int pwc_handle_frame(struct pwc_device *pdev); |
| void pwc_next_image(struct pwc_device *pdev); |
| int pwc_isoc_init(struct pwc_device *pdev); |
| void pwc_isoc_cleanup(struct pwc_device *pdev); |
| |
| /** Functions in pwc-misc.c */ |
| /* sizes in pixels */ |
| extern const struct pwc_coord pwc_image_sizes[PSZ_MAX]; |
| |
| int pwc_decode_size(struct pwc_device *pdev, int width, int height); |
| void pwc_construct(struct pwc_device *pdev); |
| |
| /** Functions in pwc-ctrl.c */ |
| /* Request a certain video mode. Returns < 0 if not possible */ |
| extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot); |
| extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size); |
| /* Calculate the number of bytes per image (not frame) */ |
| extern int pwc_mpt_reset(struct pwc_device *pdev, int flags); |
| extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt); |
| |
| /* Various controls; should be obvious. Value 0..65535, or < 0 on error */ |
| extern int pwc_get_brightness(struct pwc_device *pdev); |
| extern int pwc_set_brightness(struct pwc_device *pdev, int value); |
| extern int pwc_get_contrast(struct pwc_device *pdev); |
| extern int pwc_set_contrast(struct pwc_device *pdev, int value); |
| extern int pwc_get_gamma(struct pwc_device *pdev); |
| extern int pwc_set_gamma(struct pwc_device *pdev, int value); |
| extern int pwc_get_saturation(struct pwc_device *pdev, int *value); |
| extern int pwc_set_saturation(struct pwc_device *pdev, int value); |
| extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value); |
| extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor); |
| extern int pwc_restore_user(struct pwc_device *pdev); |
| extern int pwc_save_user(struct pwc_device *pdev); |
| extern int pwc_restore_factory(struct pwc_device *pdev); |
| |
| /* exported for use by v4l2 controls */ |
| extern int pwc_get_red_gain(struct pwc_device *pdev, int *value); |
| extern int pwc_set_red_gain(struct pwc_device *pdev, int value); |
| extern int pwc_get_blue_gain(struct pwc_device *pdev, int *value); |
| extern int pwc_set_blue_gain(struct pwc_device *pdev, int value); |
| extern int pwc_get_awb(struct pwc_device *pdev); |
| extern int pwc_set_awb(struct pwc_device *pdev, int mode); |
| extern int pwc_set_agc(struct pwc_device *pdev, int mode, int value); |
| extern int pwc_get_agc(struct pwc_device *pdev, int *value); |
| extern int pwc_set_shutter_speed(struct pwc_device *pdev, int mode, int value); |
| extern int pwc_get_shutter_speed(struct pwc_device *pdev, int *value); |
| |
| extern int pwc_set_colour_mode(struct pwc_device *pdev, int colour); |
| extern int pwc_get_colour_mode(struct pwc_device *pdev, int *colour); |
| extern int pwc_set_contour(struct pwc_device *pdev, int contour); |
| extern int pwc_get_contour(struct pwc_device *pdev, int *contour); |
| extern int pwc_set_backlight(struct pwc_device *pdev, int backlight); |
| extern int pwc_get_backlight(struct pwc_device *pdev, int *backlight); |
| extern int pwc_set_flicker(struct pwc_device *pdev, int flicker); |
| extern int pwc_get_flicker(struct pwc_device *pdev, int *flicker); |
| extern int pwc_set_dynamic_noise(struct pwc_device *pdev, int noise); |
| extern int pwc_get_dynamic_noise(struct pwc_device *pdev, int *noise); |
| |
| /* Power down or up the camera; not supported by all models */ |
| extern int pwc_camera_power(struct pwc_device *pdev, int power); |
| |
| /* Private ioctl()s; see pwc-ioctl.h */ |
| extern int pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg); |
| |
| /** Functions in pwc-v4l.c */ |
| extern int pwc_video_do_ioctl(struct inode *inode, struct file *file, |
| unsigned int cmd, void *arg); |
| |
| /** pwc-uncompress.c */ |
| /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */ |
| extern int pwc_decompress(struct pwc_device *pdev); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| |
| #endif |
| /* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */ |