[PATCH] 2.5.12 - make usbvideo_register take a usb_device_id table
[opensuse:kernel.git] / drivers / usb / media / usbvideo.h
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation; either version 2, or (at your option)
5  * any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
15  */
16 #ifndef usbvideo_h
17 #define usbvideo_h
18
19 #include <linux/config.h>
20 #include <linux/proc_fs.h>
21 #include <linux/videodev.h>
22 #include <linux/usb.h>
23
24 /* Most helpful debugging aid */
25 #define assert(expr) ((void) ((expr) ? 0 : (err("assert failed at line %d",__LINE__))))
26
27 #define USES_PROC_FS    (defined(CONFIG_PROC_FS) && defined(CONFIG_VIDEO_PROC_FS))
28 #define USBVIDEO_REPORT_STATS   1       /* Set to 0 to block statistics on close */
29
30 /* Bit flags (options) */
31 #define FLAGS_RETRY_VIDIOCSYNC          (1 << 0)
32 #define FLAGS_MONOCHROME                (1 << 1)
33 #define FLAGS_DISPLAY_HINTS             (1 << 2)
34 #define FLAGS_OVERLAY_STATS             (1 << 3)
35 #define FLAGS_FORCE_TESTPATTERN         (1 << 4)
36 #define FLAGS_SEPARATE_FRAMES           (1 << 5)
37 #define FLAGS_CLEAN_FRAMES              (1 << 6)
38 #define FLAGS_NO_DECODING               (1 << 7)
39
40 /* Bit flags for frames (apply to the frame where they are specified) */
41 #define USBVIDEO_FRAME_FLAG_SOFTWARE_CONTRAST   (1 << 0)
42
43 /* Camera capabilities (maximum) */
44 #define CAMERA_URB_FRAMES       32
45 #define CAMERA_MAX_ISO_PACKET   1023 /* 1022 actually sent by camera */
46 #define FRAMES_PER_DESC         (CAMERA_URB_FRAMES)
47 #define FRAME_SIZE_PER_DESC     (CAMERA_MAX_ISO_PACKET)
48
49 /* This macro restricts an int variable to an inclusive range */
50 #define RESTRICT_TO_RANGE(v,mi,ma) { if ((v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); }
51
52 #define V4L_BYTES_PER_PIXEL     3       /* Because we produce RGB24 */
53
54 /*
55  * Use this macro to construct constants for different video sizes.
56  * We have to deal with different video sizes that have to be
57  * configured in the device or compared against when we receive
58  * a data. Normally one would define a bunch of VIDEOSIZE_x_by_y
59  * #defines and that's the end of story. However this solution
60  * does not allow to convert between real pixel sizes and the
61  * constant (integer) value that may be used to tag a frame or
62  * whatever. The set of macros below constructs videosize constants
63  * from the pixel size and allows to reconstruct the pixel size
64  * from the combined value later.
65  */
66 #define VIDEOSIZE(x,y)  (((x) & 0xFFFFL) | (((y) & 0xFFFFL) << 16))
67 #define VIDEOSIZE_X(vs) ((vs) & 0xFFFFL)
68 #define VIDEOSIZE_Y(vs) (((vs) >> 16) & 0xFFFFL)
69 typedef unsigned long videosize_t;
70
71 /*
72  * This macro checks if the camera is still operational. The 'uvd'
73  * pointer must be valid, uvd->dev must be valid, we are not
74  * removing the device and the device has not erred on us.
75  */
76 #define CAMERA_IS_OPERATIONAL(uvd) (\
77         (uvd != NULL) && \
78         ((uvd)->dev != NULL) && \
79         ((uvd)->last_error == 0) && \
80         (!(uvd)->remove_pending))
81
82 /*
83  * We use macros to do YUV -> RGB conversion because this is
84  * very important for speed and totally unimportant for size.
85  *
86  * YUV -> RGB Conversion
87  * ---------------------
88  *
89  * B = 1.164*(Y-16)                 + 2.018*(V-128)
90  * G = 1.164*(Y-16) - 0.813*(U-128) - 0.391*(V-128)
91  * R = 1.164*(Y-16) + 1.596*(U-128)
92  *
93  * If you fancy integer arithmetics (as you should), hear this:
94  *
95  * 65536*B = 76284*(Y-16)                 + 132252*(V-128)
96  * 65536*G = 76284*(Y-16) -  53281*(U-128) -  25625*(V-128)
97  * 65536*R = 76284*(Y-16) + 104595*(U-128)
98  *
99  * Make sure the output values are within [0..255] range.
100  */
101 #define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x)))
102 #define YUV_TO_RGB_BY_THE_BOOK(my,mu,mv,mr,mg,mb) { \
103     int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \
104     mm_y = (my) - 16;  \
105     mm_u = (mu) - 128; \
106     mm_v = (mv) - 128; \
107     mm_yc= mm_y * 76284; \
108     mm_b = (mm_yc               + 132252*mm_v   ) >> 16; \
109     mm_g = (mm_yc -  53281*mm_u -  25625*mm_v   ) >> 16; \
110     mm_r = (mm_yc + 104595*mm_u                 ) >> 16; \
111     mb = LIMIT_RGB(mm_b); \
112     mg = LIMIT_RGB(mm_g); \
113     mr = LIMIT_RGB(mm_r); \
114 }
115
116 #define RING_QUEUE_ADVANCE_INDEX(rq,ind,n) (rq)->ind = ((rq)->ind + (n)) % (rq)->length
117 #define RING_QUEUE_DEQUEUE_BYTES(rq,n) RING_QUEUE_ADVANCE_INDEX(rq,ri,n)
118 #define RING_QUEUE_PEEK(rq,ofs) ((rq)->queue[((ofs) + (rq)->ri) % (rq)->length])
119
120 typedef struct {
121         unsigned char *queue;   /* Data from the Isoc data pump */
122         int length;             /* How many bytes allocated for the queue */
123         int wi;                 /* That's where we write */
124         int ri;                 /* Read from here until you hit write index */
125         wait_queue_head_t wqh;  /* Processes waiting */
126 } RingQueue_t;
127
128 typedef enum {
129         ScanState_Scanning,     /* Scanning for header */
130         ScanState_Lines         /* Parsing lines */
131 } ScanState_t;
132
133 /* Completion states of the data parser */
134 typedef enum {
135         scan_Continue,          /* Just parse next item */
136         scan_NextFrame,         /* Frame done, send it to V4L */
137         scan_Out,               /* Not enough data for frame */
138         scan_EndParse           /* End parsing */
139 } ParseState_t;
140
141 typedef enum {
142         FrameState_Unused,      /* Unused (no MCAPTURE) */
143         FrameState_Ready,       /* Ready to start grabbing */
144         FrameState_Grabbing,    /* In the process of being grabbed into */
145         FrameState_Done,        /* Finished grabbing, but not been synced yet */
146         FrameState_Done_Hold,   /* Are syncing or reading */
147         FrameState_Error,       /* Something bad happened while processing */
148 } FrameState_t;
149
150 /*
151  * Some frames may contain only even or odd lines. This type
152  * specifies what type of deinterlacing is required.
153  */
154 typedef enum {
155         Deinterlace_None=0,
156         Deinterlace_FillOddLines,
157         Deinterlace_FillEvenLines
158 } Deinterlace_t;
159
160 struct usb_device;
161
162 #define USBVIDEO_NUMFRAMES      2       /* How many frames we work with */
163 #define USBVIDEO_NUMSBUF        2       /* How many URBs linked in a ring */
164
165 /* This structure represents one Isoc request - URB and buffer */
166 typedef struct {
167         char *data;
168         struct urb *urb;
169 } usbvideo_sbuf_t;
170
171 typedef struct {
172         char *data;             /* Frame buffer */
173         unsigned long header;   /* Significant bits from the header */
174
175         videosize_t canvas;     /* The canvas (max. image) allocated */
176         videosize_t request;    /* That's what the application asked for */
177         unsigned short palette; /* The desired format */
178
179         FrameState_t frameState;/* State of grabbing */
180         ScanState_t scanstate;  /* State of scanning */
181         Deinterlace_t deinterlace;
182         int flags;              /* USBVIDEO_FRAME_FLAG_xxx bit flags */
183
184         int curline;            /* Line of frame we're working on */
185
186         long seqRead_Length;    /* Raw data length of frame */
187         long seqRead_Index;     /* Amount of data that has been already read */
188
189         void *user;             /* Additional data that user may need */
190 } usbvideo_frame_t;
191
192 /* Statistics that can be overlaid on screen */
193 typedef struct {
194         unsigned long frame_num;        /* Sequential number of the frame */
195         unsigned long urb_count;        /* How many URBs we received so far */
196         unsigned long urb_length;       /* Length of last URB */
197         unsigned long data_count;       /* How many bytes we received */
198         unsigned long header_count;     /* How many frame headers we found */
199         unsigned long iso_skip_count;   /* How many empty ISO packets received */
200         unsigned long iso_err_count;    /* How many bad ISO packets received */
201 } usbvideo_statistics_t;
202
203 struct s_usbvideo_t;
204
205 typedef struct {
206         struct video_device vdev;       /* Must be the first field! */
207         struct usb_device *dev;
208         struct s_usbvideo_t *handle;    /* Points back to the usbvideo_t */
209         void *user_data;                /* Camera-dependent data */
210         int user_size;                  /* Size of that camera-dependent data */
211         int debug;                      /* Debug level for usbvideo */
212         unsigned char iface;            /* Video interface number */
213         unsigned char video_endp;
214         unsigned char ifaceAltActive;
215         unsigned char ifaceAltInactive; /* Alt settings */
216         unsigned long flags;            /* FLAGS_USBVIDEO_xxx */
217         unsigned long paletteBits;      /* Which palettes we accept? */
218         unsigned short defaultPalette;  /* What palette to use for read() */
219         struct semaphore lock;
220         int user;               /* user count for exclusive use */
221
222         videosize_t videosize;  /* Current setting */
223         videosize_t canvas;     /* This is the width,height of the V4L canvas */
224         int max_frame_size;     /* Bytes in one video frame */
225
226         int uvd_used;           /* Is this structure in use? */
227         int streaming;          /* Are we streaming Isochronous? */
228         int grabbing;           /* Are we grabbing? */
229         int settingsAdjusted;   /* Have we adjusted contrast etc.? */
230         int last_error;         /* What calamity struck us? */
231
232         char *fbuf;             /* Videodev buffer area */
233         int fbuf_size;          /* Videodev buffer size */
234
235         int curframe;
236         int iso_packet_len;     /* Videomode-dependent, saves bus bandwidth */
237
238         RingQueue_t dp;         /* Isoc data pump */
239         usbvideo_frame_t frame[USBVIDEO_NUMFRAMES];
240         usbvideo_sbuf_t sbuf[USBVIDEO_NUMSBUF];
241
242         volatile int remove_pending;    /* If set then about to exit */
243
244         struct video_picture vpic, vpic_old;    /* Picture settings */
245         struct video_capability vcap;           /* Video capabilities */
246         struct video_channel vchan;     /* May be used for tuner support */
247         usbvideo_statistics_t stats;
248         struct proc_dir_entry *procfs_vEntry;   /* /proc/video/MYDRIVER/video2 */
249         char videoName[32];             /* Holds name like "video7" */
250 } uvd_t;
251
252 /*
253  * usbvideo callbacks (virtual methods). They are set when usbvideo
254  * services are registered. All of these default to NULL, except those
255  * that default to usbvideo-provided methods.
256  */
257 typedef struct {
258         void *(*probe)(struct usb_device *, unsigned int,const struct usb_device_id *);
259         void (*userFree)(uvd_t *);
260         void (*disconnect)(struct usb_device *, void *);
261         int (*setupOnOpen)(uvd_t *);
262         void (*videoStart)(uvd_t *);
263         void (*videoStop)(uvd_t *);
264         void (*processData)(uvd_t *, usbvideo_frame_t *);
265         void (*postProcess)(uvd_t *, usbvideo_frame_t *);
266         void (*adjustPicture)(uvd_t *);
267         int (*getFPS)(uvd_t *);
268         int (*overlayHook)(uvd_t *, usbvideo_frame_t *);
269         int (*getFrame)(uvd_t *, int);
270         int (*procfs_read)(char *page,char **start,off_t off,int count,int *eof,void *data);
271         int (*procfs_write)(struct file *file,const char *buffer,unsigned long count,void *data);
272         int (*startDataPump)(uvd_t *uvd);
273         void (*stopDataPump)(uvd_t *uvd);
274 } usbvideo_cb_t;
275
276 struct s_usbvideo_t {
277         int num_cameras;                /* As allocated */
278         struct usb_driver usbdrv;       /* Interface to the USB stack */
279         char drvName[80];               /* Driver name */
280         struct semaphore lock;          /* Mutex protecting camera structures */
281         usbvideo_cb_t cb;               /* Table of callbacks (virtual methods) */
282         struct video_device vdt;        /* Video device template */
283         uvd_t *cam;                     /* Array of camera structures */
284         int uses_procfs;                /* Non-zero if we create /proc entries */
285         struct proc_dir_entry *procfs_dEntry;   /* /proc/video/MYDRIVER */
286         struct module *md_module;       /* Minidriver module */
287 };
288 typedef struct s_usbvideo_t usbvideo_t;
289
290 /*
291  * This macro retrieves callback address from the uvd_t object.
292  * No validity checks are done here, so be sure to check the
293  * callback beforehand with VALID_CALLBACK.
294  */
295 #define GET_CALLBACK(uvd,cbName) ((uvd)->handle->cb.cbName)
296
297 /*
298  * This macro returns either callback pointer or NULL. This is safe
299  * macro, meaning that most of components of data structures involved
300  * may be NULL - this only results in NULL being returned. You may
301  * wish to use this macro to make sure that the callback is callable.
302  * However keep in mind that those checks take time.
303  */
304 #define VALID_CALLBACK(uvd,cbName) ((((uvd) != NULL) && \
305                 ((uvd)->handle != NULL)) ? GET_CALLBACK(uvd,cbName) : NULL)
306
307 int  RingQueue_Dequeue(RingQueue_t *rq, unsigned char *dst, int len);
308 int  RingQueue_Enqueue(RingQueue_t *rq, const unsigned char *cdata, int n);
309 int  RingQueue_GetLength(const RingQueue_t *rq);
310 void RingQueue_WakeUpInterruptible(RingQueue_t *rq);
311
312 void usbvideo_DrawLine(
313         usbvideo_frame_t *frame,
314         int x1, int y1,
315         int x2, int y2,
316         unsigned char cr, unsigned char cg, unsigned char cb);
317 void usbvideo_HexDump(const unsigned char *data, int len);
318 void usbvideo_SayAndWait(const char *what);
319 void usbvideo_TestPattern(uvd_t *uvd, int fullframe, int pmode);
320
321 /* Memory allocation routines */
322 unsigned long usbvideo_kvirt_to_pa(unsigned long adr);
323
324 int usbvideo_register(
325         usbvideo_t **pCams,
326         const int num_cams,
327         const int num_extra,
328         const char *driverName,
329         const usbvideo_cb_t *cbTable,
330         struct module *md,
331         const struct usb_device_id *id_table);
332 uvd_t *usbvideo_AllocateDevice(usbvideo_t *cams);
333 int usbvideo_RegisterVideoDevice(uvd_t *uvd);
334 void usbvideo_Deregister(usbvideo_t **uvt);
335
336 int usbvideo_v4l_initialize(struct video_device *dev);
337
338 void usbvideo_DeinterlaceFrame(uvd_t *uvd, usbvideo_frame_t *frame);
339
340 /*
341  * This code performs bounds checking - use it when working with
342  * new formats, or else you may get oopses all over the place.
343  * If pixel falls out of bounds then it gets shoved back (as close
344  * to place of offence as possible) and is painted bright red.
345  *
346  * There are two important concepts: frame width, height and
347  * V4L canvas width, height. The former is the area requested by
348  * the application -for this very frame-. The latter is the largest
349  * possible frame that we can serve (we advertise that via V4L ioctl).
350  * The frame data is expected to be formatted as lines of length
351  * VIDEOSIZE_X(fr->request), total VIDEOSIZE_Y(frame->request) lines.
352  */
353 static inline void RGB24_PUTPIXEL(
354         usbvideo_frame_t *fr,
355         int ix, int iy,
356         unsigned char vr,
357         unsigned char vg,
358         unsigned char vb)
359 {
360         register unsigned char *pf;
361         int limiter = 0, mx, my;
362         mx = ix;
363         my = iy;
364         if (mx < 0) {
365                 mx=0;
366                 limiter++;
367         } else if (mx >= VIDEOSIZE_X((fr)->request)) {
368                 mx= VIDEOSIZE_X((fr)->request) - 1;
369                 limiter++;
370         }
371         if (my < 0) {
372                 my = 0;
373                 limiter++;
374         } else if (my >= VIDEOSIZE_Y((fr)->request)) {
375                 my = VIDEOSIZE_Y((fr)->request) - 1;
376                 limiter++;
377         }
378         pf = (fr)->data + V4L_BYTES_PER_PIXEL*((iy)*VIDEOSIZE_X((fr)->request) + (ix));
379         if (limiter) {
380                 *pf++ = 0;
381                 *pf++ = 0;
382                 *pf++ = 0xFF;
383         } else {
384                 *pf++ = (vb);
385                 *pf++ = (vg);
386                 *pf++ = (vr);
387         }
388 }
389
390 #endif /* usbvideo_h */