pwc.h 9.43 KB
Newer Older
Nemosoft Unv's avatar
Nemosoft Unv committed
1
/* (C) 1999-2003 Nemosoft Unv. (webcam@smcc.demon.nl)
Linus Torvalds's avatar
Linus Torvalds committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

   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

21 22
#include <linux/version.h>

Linus Torvalds's avatar
Linus Torvalds committed
23
#include <linux/config.h>
Linus Torvalds's avatar
Linus Torvalds committed
24
#include <linux/module.h>
25
#include <linux/smp_lock.h>
Linus Torvalds's avatar
Linus Torvalds committed
26
#include <linux/spinlock.h>
27
#include <linux/usb.h>
Linus Torvalds's avatar
Linus Torvalds committed
28 29 30
#include <linux/videodev.h>
#include <linux/wait.h>

Linus Torvalds's avatar
Linus Torvalds committed
31 32 33
#include <asm/semaphore.h>
#include <asm/errno.h>

34 35
#include "pwc-ioctl.h"

Linus Torvalds's avatar
Linus Torvalds committed
36 37 38 39 40
/* Defines and structures for the Philips webcam */
/* Used for checking memory corruption/pointer validation */
#define PWC_MAGIC 0x89DC10ABUL
#undef PWC_MAGIC

Linus Torvalds's avatar
Linus Torvalds committed
41
/* Turn some debugging options on/off */
Linus Torvalds's avatar
Linus Torvalds committed
42 43
#define PWC_DEBUG 0

Linus Torvalds's avatar
Linus Torvalds committed
44
/* Trace certain actions in the driver */
Linus Torvalds's avatar
Linus Torvalds committed
45 46 47 48 49 50 51
#define TRACE_MODULE	0x0001
#define TRACE_PROBE	0x0002
#define TRACE_OPEN	0x0004
#define TRACE_READ	0x0008
#define TRACE_MEMORY	0x0010
#define TRACE_FLOW	0x0020
#define TRACE_SIZE	0x0040
Linus Torvalds's avatar
Linus Torvalds committed
52
#define TRACE_PWCX	0x0080
Linus Torvalds's avatar
Linus Torvalds committed
53 54
#define TRACE_SEQUENCE	0x1000

Linus Torvalds's avatar
Linus Torvalds committed
55 56 57 58
#define Trace(R, A...) if (pwc_trace & R) printk(KERN_DEBUG PWC_NAME " " A)
#define Debug(A...) printk(KERN_DEBUG PWC_NAME " " A)
#define Info(A...)  printk(KERN_INFO  PWC_NAME " " A)
#define Err(A...)   printk(KERN_ERR   PWC_NAME " " A)
Linus Torvalds's avatar
Linus Torvalds committed
59 60 61 62 63 64


/* Defines for ToUCam cameras */
#define TOUCAM_HEADER_SIZE		8
#define TOUCAM_TRAILER_SIZE		4

65 66
#define FEATURE_MOTOR_PANTILT		0x0001

Linus Torvalds's avatar
Linus Torvalds committed
67
/* Version block */
Linus Torvalds's avatar
Linus Torvalds committed
68
#define PWC_MAJOR	8
69 70
#define PWC_MINOR	12
#define PWC_VERSION 	"8.12"
Linus Torvalds's avatar
Linus Torvalds committed
71
#define PWC_NAME 	"pwc"
Linus Torvalds's avatar
Linus Torvalds committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87

/* 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 */
Linus Torvalds's avatar
Linus Torvalds committed
88
#define PWC_FRAME_SIZE 		(460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
Linus Torvalds's avatar
Linus Torvalds committed
89 90

/* Absolute maximum number of buffers available for mmap() */
Nemosoft Unv's avatar
Nemosoft Unv committed
91
#define MAX_IMAGES 		10
Linus Torvalds's avatar
Linus Torvalds committed
92 93 94 95 96 97 98 99 100 101 102 103 104

struct pwc_coord
{
	int x, y;		/* guess what */
	int size;		/* size, or offset */
};

/* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
struct pwc_iso_buf
{
	void *data;
	int  length;
	int  read;
Linus Torvalds's avatar
Linus Torvalds committed
105
	struct urb *urb;
Linus Torvalds's avatar
Linus Torvalds committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
};

/* 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 */
#if PWC_DEBUG
   int sequence;		/* Sequence number */
#endif
};

struct pwc_device
{
Nemosoft Unv's avatar
Nemosoft Unv committed
121
   struct video_device vdev;
Linus Torvalds's avatar
Linus Torvalds committed
122 123 124 125 126 127
#ifdef PWC_MAGIC
   int magic;
#endif
   /* Pointer to our usb_device */
   struct usb_device *udev;
   
128
   int type;                    /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
Linus Torvalds's avatar
Linus Torvalds committed
129
   int release;			/* release number */
130
   int features;		/* feature bits */
Nemosoft Unv's avatar
Nemosoft Unv committed
131
   int error_status;		/* set when something goes wrong with the cam (unplugged, USB errors) */
Linus Torvalds's avatar
Linus Torvalds committed
132 133 134 135 136 137 138 139 140 141 142 143 144
   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 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 */
Nemosoft Unv's avatar
Nemosoft Unv committed
145
   int visoc_errors;		/* number of contiguous ISOC errors */
Linus Torvalds's avatar
Linus Torvalds committed
146 147 148 149
   int vcompression;		/* desired compression factor */
   int vbandlength;		/* compressed band length; 0 is uncompressed */
   char vsnapshot;		/* snapshot mode */
   char vsync;			/* used by isoc handler */
Nemosoft Unv's avatar
Nemosoft Unv committed
150 151
   char vmirror;		/* for ToUCaM series */

Linus Torvalds's avatar
Linus Torvalds committed
152
   /* The image acquisition requires 3 to 4 steps:
Linus Torvalds's avatar
Linus Torvalds committed
153 154
      1. data is gathered in short packets from the USB controller
      2. data is synchronized and packed into a frame buffer
Linus Torvalds's avatar
Linus Torvalds committed
155 156
      3a. in case data is compressed, decompress it directly into image buffer
      3b. in case data is uncompressed, copy into image buffer with viewport
157
      4. data is transferred to the user process
Linus Torvalds's avatar
Linus Torvalds committed
158

Nemosoft Unv's avatar
Nemosoft Unv committed
159
      Note that MAX_ISO_BUFS != MAX_FRAMES != MAX_IMAGES....
Linus Torvalds's avatar
Linus Torvalds committed
160 161 162 163 164
      We have in effect a back-to-back-double-buffer system.
    */
   /* 1: isoc */
   struct pwc_iso_buf sbuf[MAX_ISO_BUFS];
   char iso_init;
Nemosoft Unv's avatar
Nemosoft Unv committed
165

Linus Torvalds's avatar
Linus Torvalds committed
166
   /* 2: frame */
Linus Torvalds's avatar
Linus Torvalds committed
167 168 169
   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 */
Linus Torvalds's avatar
Linus Torvalds committed
170
   struct pwc_frame_buf *fill_frame;	/* frame currently being filled */
Linus Torvalds's avatar
Linus Torvalds committed
171
   struct pwc_frame_buf *read_frame;	/* frame currently read by user process */
Linus Torvalds's avatar
Linus Torvalds committed
172 173 174 175 176 177
   int frame_size;
   int frame_header_size, frame_trailer_size;
   int drop_frames;
#if PWC_DEBUG
   int sequence;			/* Debugging aid */
#endif
Nemosoft Unv's avatar
Nemosoft Unv committed
178

Linus Torvalds's avatar
Linus Torvalds committed
179 180 181 182 183 184 185
   /* 3: decompression */
   struct pwc_decompressor *decompressor;	/* function block with decompression routines */
   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
Nemosoft Unv's avatar
Nemosoft Unv committed
186
      program. The camera image is centered in this viewport, laced with
Linus Torvalds's avatar
Linus Torvalds committed
187 188 189 190 191 192 193 194 195 196
      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 sizes */
   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 ... */
   void *image_ptr[MAX_IMAGES];		/* ...several images... */
   int fill_image;			/* ...which are rotated. */
Linus Torvalds's avatar
Linus Torvalds committed
197
   int len_per_image;			/* length per image */
Linus Torvalds's avatar
Linus Torvalds committed
198 199 200 201 202 203
   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 semaphore modlock;		/* to prevent races in video_open(), etc */
   spinlock_t ptrlock;			/* for manipulating the buffer pointers */

204 205 206 207 208
   /*** 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 */

Linus Torvalds's avatar
Linus Torvalds committed
209 210 211 212
   /*** 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 */
Nemosoft Unv's avatar
Nemosoft Unv committed
213
#endif
Linus Torvalds's avatar
Linus Torvalds committed
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
};

/* Enumeration of image sizes */
#define PSZ_SQCIF	0x00
#define PSZ_QSIF	0x01
#define PSZ_QCIF	0x02
#define PSZ_SIF		0x03
#define PSZ_CIF		0x04
#define PSZ_VGA		0x05
#define PSZ_MAX		6



#ifdef __cplusplus
extern "C" {
#endif

/* Global variables */
extern int pwc_trace;
extern int pwc_preferred_compression;

/** 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);

/** Functions in pwc-misc.c */
/* sizes in pixels */
extern 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);
/* Calculate the number of bytes per image (not frame) */
extern void pwc_set_image_buffer_size(struct pwc_device *pdev);

/* 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);
extern int pwc_set_saturation(struct pwc_device *pdev, int value);
Linus Torvalds's avatar
Linus Torvalds committed
260 261
extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
extern int pwc_get_leds(struct pwc_device *pdev, int *on_value, int *off_value);
Nemosoft Unv's avatar
Nemosoft Unv committed
262
extern int pwc_get_cmos_sensor(struct pwc_device *pdev);
Linus Torvalds's avatar
Linus Torvalds committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280

/* 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);


/** 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