blob: 46b7ad477ceb5caece92b5e0cab3d601895bf2ce [file] [log] [blame]
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * zoran - Iomega Buz driver
3 *
4 * Copyright (C) 1999 Rainer Johanni <Rainer@Johanni.de>
5 *
6 * based on
7 *
8 * zoran.0.0.3 Copyright (C) 1998 Dave Perks <dperks@ibm.net>
9 *
10 * and
11 *
12 * bttv - Bt848 frame grabber driver
13 * Copyright (C) 1996,97,98 Ralph Metzler (rjkm@thp.uni-koeln.de)
14 * & Marcus Metzler (mocm@thp.uni-koeln.de)
15 *
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 */
30
31#ifndef _BUZ_H_
32#define _BUZ_H_
33
34struct zoran_requestbuffers {
35 unsigned long count; /* Number of buffers for MJPEG grabbing */
36 unsigned long size; /* Size PER BUFFER in bytes */
37};
38
39struct zoran_sync {
40 unsigned long frame; /* number of buffer that has been free'd */
41 unsigned long length; /* number of code bytes in buffer (capture only) */
42 unsigned long seq; /* frame sequence number */
43 struct timeval timestamp; /* timestamp */
44};
45
46struct zoran_status {
47 int input; /* Input channel, has to be set prior to BUZIOC_G_STATUS */
48 int signal; /* Returned: 1 if valid video signal detected */
49 int norm; /* Returned: VIDEO_MODE_PAL or VIDEO_MODE_NTSC */
50 int color; /* Returned: 1 if color signal detected */
51};
52
53struct zoran_params {
54
55 /* The following parameters can only be queried */
56
57 int major_version; /* Major version number of driver */
58 int minor_version; /* Minor version number of driver */
59
60 /* Main control parameters */
61
62 int input; /* Input channel: 0 = Composite, 1 = S-VHS */
63 int norm; /* Norm: VIDEO_MODE_PAL or VIDEO_MODE_NTSC */
64 int decimation; /* decimation of captured video,
65 * enlargement of video played back.
66 * Valid values are 1, 2, 4 or 0.
67 * 0 is a special value where the user
68 * has full control over video scaling */
69
70 /* The following parameters only have to be set if decimation==0,
71 * for other values of decimation they provide the data how the image is captured */
72
73 int HorDcm; /* Horizontal decimation: 1, 2 or 4 */
74 int VerDcm; /* Vertical decimation: 1 or 2 */
75 int TmpDcm; /* Temporal decimation: 1 or 2,
76 * if TmpDcm==2 in capture every second frame is dropped,
77 * in playback every frame is played twice */
78 int field_per_buff; /* Number of fields per buffer: 1 or 2 */
79 int img_x; /* start of image in x direction */
80 int img_y; /* start of image in y direction */
81 int img_width; /* image width BEFORE decimation,
82 * must be a multiple of HorDcm*16 */
83 int img_height; /* image height BEFORE decimation,
84 * must be a multiple of VerDcm*8 */
85
86 /* --- End of parameters for decimation==0 only --- */
87
88 /* JPEG control parameters */
89
90 int quality; /* Measure for quality of compressed images.
91 * Scales linearly with the size of the compressed images.
92 * Must be beetween 0 and 100, 100 is a compression
93 * ratio of 1:4 */
94
95 int odd_even; /* Which field should come first ??? */
96
97 int APPn; /* Number of APP segment to be written, must be 0..15 */
98 int APP_len; /* Length of data in JPEG APPn segment */
99 char APP_data[60]; /* Data in the JPEG APPn segment. */
100
101 int COM_len; /* Length of data in JPEG COM segment */
102 char COM_data[60]; /* Data in JPEG COM segment */
103
104 unsigned long jpeg_markers; /* Which markers should go into the JPEG output.
105 * Unless you exactly know what you do, leave them untouched.
106 * Inluding less markers will make the resulting code
107 * smaller, but there will be fewer aplications
108 * which can read it.
109 * The presence of the APP and COM marker is
110 * influenced by APP0_len and COM_len ONLY! */
111#define JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
112#define JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
113#define JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
114#define JPEG_MARKER_COM (1<<6) /* Comment segment */
115#define JPEG_MARKER_APP (1<<7) /* App segment, driver will allways use APP0 */
116
117 int VFIFO_FB; /* Flag for enabling Video Fifo Feedback.
118 * If this flag is turned on and JPEG decompressing
119 * is going to the screen, the decompress process
120 * is stopped every time the Video Fifo is full.
121 * This enables a smooth decompress to the screen
122 * but the video output signal will get scrambled */
123
124 /* Misc */
125
126 char reserved[312]; /* Makes 512 bytes for this structure */
127};
128
129/*
130Private IOCTL to set up for displaying MJPEG
131*/
132#define BUZIOC_G_PARAMS _IOR ('v', BASE_VIDIOCPRIVATE+0, struct zoran_params)
133#define BUZIOC_S_PARAMS _IOWR('v', BASE_VIDIOCPRIVATE+1, struct zoran_params)
134#define BUZIOC_REQBUFS _IOWR('v', BASE_VIDIOCPRIVATE+2, struct zoran_requestbuffers)
135#define BUZIOC_QBUF_CAPT _IOW ('v', BASE_VIDIOCPRIVATE+3, int)
136#define BUZIOC_QBUF_PLAY _IOW ('v', BASE_VIDIOCPRIVATE+4, int)
137#define BUZIOC_SYNC _IOR ('v', BASE_VIDIOCPRIVATE+5, struct zoran_sync)
138#define BUZIOC_G_STATUS _IOWR('v', BASE_VIDIOCPRIVATE+6, struct zoran_status)
139
140
141#ifdef __KERNEL__
142
143#define MAJOR_VERSION 0 /* driver major version */
144#define MINOR_VERSION 9 /* driver minor version */
145#define RELEASE_VERSION 5 /* release version */
146
147#define ZORAN_NAME "ZORAN" /* name of the device */
148
149#define ZR_DEVNAME(zr) ((zr)->name)
150
151#define BUZ_MAX_WIDTH (zr->timing->Wa)
152#define BUZ_MAX_HEIGHT (zr->timing->Ha)
153#define BUZ_MIN_WIDTH 32 /* never display less than 32 pixels */
154#define BUZ_MIN_HEIGHT 24 /* never display less than 24 rows */
155
156#define BUZ_NUM_STAT_COM 4
157#define BUZ_MASK_STAT_COM 3
158
159#define BUZ_MAX_FRAME 256 /* Must be a power of 2 */
160#define BUZ_MASK_FRAME 255 /* Must be BUZ_MAX_FRAME-1 */
161
Martin Samuelssonfbe60da2006-04-27 10:17:00 -0300162#define BUZ_MAX_INPUT 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164#if VIDEO_MAX_FRAME <= 32
165# define V4L_MAX_FRAME 32
166#elif VIDEO_MAX_FRAME <= 64
167# define V4L_MAX_FRAME 64
168#else
169# error "Too many video frame buffers to handle"
170#endif
171#define V4L_MASK_FRAME (V4L_MAX_FRAME - 1)
172
173#define MAX_KMALLOC_MEM (128*1024)
174
175#include "zr36057.h"
176
177enum card_type {
178 UNKNOWN = -1,
179
180 /* Pinnacle/Miro */
181 DC10_old, /* DC30 like */
182 DC10_new, /* DC10plus like */
183 DC10plus,
184 DC30,
185 DC30plus,
186
187 /* Linux Media Labs */
188 LML33,
189 LML33R10,
190
191 /* Iomega */
192 BUZ,
193
Martin Samuelssonfbe60da2006-04-27 10:17:00 -0300194 /* AverMedia */
195 AVS6EYES,
196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 /* total number of cards */
198 NUM_CARDS
199};
200
201enum zoran_codec_mode {
202 BUZ_MODE_IDLE, /* nothing going on */
203 BUZ_MODE_MOTION_COMPRESS, /* grabbing frames */
204 BUZ_MODE_MOTION_DECOMPRESS, /* playing frames */
205 BUZ_MODE_STILL_COMPRESS, /* still frame conversion */
206 BUZ_MODE_STILL_DECOMPRESS /* still frame conversion */
207};
208
209enum zoran_buffer_state {
210 BUZ_STATE_USER, /* buffer is owned by application */
211 BUZ_STATE_PEND, /* buffer is queued in pend[] ready to feed to I/O */
212 BUZ_STATE_DMA, /* buffer is queued in dma[] for I/O */
213 BUZ_STATE_DONE /* buffer is ready to return to application */
214};
215
216enum zoran_map_mode {
217 ZORAN_MAP_MODE_RAW,
218 ZORAN_MAP_MODE_JPG_REC,
219#define ZORAN_MAP_MODE_JPG ZORAN_MAP_MODE_JPG_REC
220 ZORAN_MAP_MODE_JPG_PLAY,
221};
222
223enum gpio_type {
Mauro Carvalho Chehab61658942008-02-15 18:41:06 -0300224 ZR_GPIO_JPEG_SLEEP = 0,
225 ZR_GPIO_JPEG_RESET,
226 ZR_GPIO_JPEG_FRAME,
227 ZR_GPIO_VID_DIR,
228 ZR_GPIO_VID_EN,
229 ZR_GPIO_VID_RESET,
230 ZR_GPIO_CLK_SEL1,
231 ZR_GPIO_CLK_SEL2,
232 ZR_GPIO_MAX,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233};
234
235enum gpcs_type {
236 GPCS_JPEG_RESET = 0,
237 GPCS_JPEG_START,
238 GPCS_MAX,
239};
240
241struct zoran_format {
242 char *name;
Trent Piepho603d6f22007-07-17 18:29:44 -0300243#ifdef CONFIG_VIDEO_V4L1_COMPAT
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 int palette;
Trent Piepho603d6f22007-07-17 18:29:44 -0300245#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 __u32 fourcc;
247 int colorspace;
248 int depth;
249 __u32 flags;
Trent Piepho603d6f22007-07-17 18:29:44 -0300250 __u32 vfespfr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251};
252/* flags */
253#define ZORAN_FORMAT_COMPRESSED 1<<0
254#define ZORAN_FORMAT_OVERLAY 1<<1
255#define ZORAN_FORMAT_CAPTURE 1<<2
256#define ZORAN_FORMAT_PLAYBACK 1<<3
257
258/* overlay-settings */
259struct zoran_overlay_settings {
260 int is_set;
261 int x, y, width, height; /* position */
262 int clipcount; /* position and number of clips */
263 const struct zoran_format *format; /* overlay format */
264};
265
266/* v4l-capture settings */
267struct zoran_v4l_settings {
268 int width, height, bytesperline; /* capture size */
269 const struct zoran_format *format; /* capture format */
270};
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272/* jpg-capture/-playback settings */
273struct zoran_jpg_settings {
274 int decimation; /* this bit is used to set everything to default */
275 int HorDcm, VerDcm, TmpDcm; /* capture decimation settings (TmpDcm=1 means both fields) */
276 int field_per_buff, odd_even; /* field-settings (odd_even=1 (+TmpDcm=1) means top-field-first) */
277 int img_x, img_y, img_width, img_height; /* crop settings (subframe capture) */
278 struct v4l2_jpegcompression jpg_comp; /* JPEG-specific capture settings */
279};
280
281struct zoran_mapping {
282 struct file *file;
283 int count;
284};
285
286struct zoran_jpg_buffer {
287 struct zoran_mapping *map;
Al Viro581a7f12008-05-21 00:32:31 -0300288 __le32 *frag_tab; /* addresses of frag table */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 u32 frag_tab_bus; /* same value cached to save time in ISR */
290 enum zoran_buffer_state state; /* non-zero if corresponding buffer is in use in grab queue */
291 struct zoran_sync bs; /* DONE: info to return to application */
292};
293
294struct zoran_v4l_buffer {
295 struct zoran_mapping *map;
296 char *fbuffer; /* virtual address of frame buffer */
297 unsigned long fbuffer_phys; /* physical address of frame buffer */
298 unsigned long fbuffer_bus; /* bus address of frame buffer */
299 enum zoran_buffer_state state; /* state: unused/pending/done */
300 struct zoran_sync bs; /* DONE: info to return to application */
301};
302
303enum zoran_lock_activity {
304 ZORAN_FREE, /* free for use */
305 ZORAN_ACTIVE, /* active but unlocked */
306 ZORAN_LOCKED, /* locked */
307};
308
309/* buffer collections */
310struct zoran_jpg_struct {
311 enum zoran_lock_activity active; /* feature currently in use? */
312 struct zoran_jpg_buffer buffer[BUZ_MAX_FRAME]; /* buffers */
313 int num_buffers, buffer_size;
314 u8 allocated; /* Flag if buffers are allocated */
315 u8 ready_to_be_freed; /* hack - see zoran_driver.c */
316 u8 need_contiguous; /* Flag if contiguous buffers are needed */
317};
318
319struct zoran_v4l_struct {
320 enum zoran_lock_activity active; /* feature currently in use? */
321 struct zoran_v4l_buffer buffer[VIDEO_MAX_FRAME]; /* buffers */
322 int num_buffers, buffer_size;
323 u8 allocated; /* Flag if buffers are allocated */
324 u8 ready_to_be_freed; /* hack - see zoran_driver.c */
325};
326
327struct zoran;
328
329/* zoran_fh contains per-open() settings */
330struct zoran_fh {
331 struct zoran *zr;
332
333 enum zoran_map_mode map_mode; /* Flag which bufferset will map by next mmap() */
334
335 struct zoran_overlay_settings overlay_settings;
336 u32 *overlay_mask; /* overlay mask */
337 enum zoran_lock_activity overlay_active; /* feature currently in use? */
338
339 struct zoran_v4l_settings v4l_settings; /* structure with a lot of things to play with */
340 struct zoran_v4l_struct v4l_buffers; /* V4L buffers' info */
341
342 struct zoran_jpg_settings jpg_settings; /* structure with a lot of things to play with */
343 struct zoran_jpg_struct jpg_buffers; /* MJPEG buffers' info */
344};
345
346struct card_info {
347 enum card_type type;
348 char name[32];
349 u16 i2c_decoder, i2c_encoder; /* I2C types */
350 u16 video_vfe, video_codec; /* videocodec types */
351 u16 audio_chip; /* audio type */
352 u16 vendor_id, device_id; /* subsystem vendor/device ID */
353
354 int inputs; /* number of video inputs */
355 struct input {
356 int muxsel;
357 char name[32];
358 } input[BUZ_MAX_INPUT];
359
360 int norms;
361 struct tvnorm *tvn[3]; /* supported TV norms */
362
363 u32 jpeg_int; /* JPEG interrupt */
364 u32 vsync_int; /* VSYNC interrupt */
Mauro Carvalho Chehab61658942008-02-15 18:41:06 -0300365 s8 gpio[ZR_GPIO_MAX];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 u8 gpcs[GPCS_MAX];
367
368 struct vfe_polarity vfe_pol;
Mauro Carvalho Chehab61658942008-02-15 18:41:06 -0300369 u8 gpio_pol[ZR_GPIO_MAX];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
371 /* is the /GWS line conected? */
372 u8 gws_not_connected;
373
Martin Samuelssonfbe60da2006-04-27 10:17:00 -0300374 /* avs6eyes mux setting */
375 u8 input_mux;
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 void (*init) (struct zoran * zr);
378};
379
380struct zoran {
381 struct video_device *video_dev;
382
383 struct i2c_adapter i2c_adapter; /* */
384 struct i2c_algo_bit_data i2c_algo; /* */
385 u32 i2cbr;
386
387 struct i2c_client *decoder; /* video decoder i2c client */
388 struct i2c_client *encoder; /* video encoder i2c client */
389
390 struct videocodec *codec; /* video codec */
391 struct videocodec *vfe; /* video front end */
392
Ingo Molnar384c3682006-03-22 03:54:16 -0300393 struct mutex resource_lock; /* prevent evil stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 u8 initialized; /* flag if zoran has been correctly initalized */
396 int user; /* number of current users */
397 struct card_info card;
398 struct tvnorm *timing;
399
400 unsigned short id; /* number of this device */
401 char name[32]; /* name of this device */
402 struct pci_dev *pci_dev; /* PCI device */
403 unsigned char revision; /* revision of zr36057 */
404 unsigned int zr36057_adr; /* bus address of IO mem returned by PCI BIOS */
405 unsigned char __iomem *zr36057_mem;/* pointer to mapped IO memory */
406
407 spinlock_t spinlock; /* Spinlock */
408
409 /* Video for Linux parameters */
410 int input, norm; /* card's norm and input - norm=VIDEO_MODE_* */
411 int hue, saturation, contrast, brightness; /* Current picture params */
412 struct video_buffer buffer; /* Current buffer params */
413 struct zoran_overlay_settings overlay_settings;
414 u32 *overlay_mask; /* overlay mask */
415 enum zoran_lock_activity overlay_active; /* feature currently in use? */
416
417 wait_queue_head_t v4l_capq;
418
419 int v4l_overlay_active; /* Overlay grab is activated */
420 int v4l_memgrab_active; /* Memory grab is activated */
421
422 int v4l_grab_frame; /* Frame number being currently grabbed */
423#define NO_GRAB_ACTIVE (-1)
424 unsigned long v4l_grab_seq; /* Number of frames grabbed */
425 struct zoran_v4l_settings v4l_settings; /* structure with a lot of things to play with */
426
427 /* V4L grab queue of frames pending */
428 unsigned long v4l_pend_head;
429 unsigned long v4l_pend_tail;
430 unsigned long v4l_sync_tail;
431 int v4l_pend[V4L_MAX_FRAME];
432 struct zoran_v4l_struct v4l_buffers; /* V4L buffers' info */
433
434 /* Buz MJPEG parameters */
435 enum zoran_codec_mode codec_mode; /* status of codec */
436 struct zoran_jpg_settings jpg_settings; /* structure with a lot of things to play with */
437
438 wait_queue_head_t jpg_capq; /* wait here for grab to finish */
439
440 /* grab queue counts/indices, mask with BUZ_MASK_STAT_COM before using as index */
441 /* (dma_head - dma_tail) is number active in DMA, must be <= BUZ_NUM_STAT_COM */
442 /* (value & BUZ_MASK_STAT_COM) corresponds to index in stat_com table */
443 unsigned long jpg_que_head; /* Index where to put next buffer which is queued */
444 unsigned long jpg_dma_head; /* Index of next buffer which goes into stat_com */
445 unsigned long jpg_dma_tail; /* Index of last buffer in stat_com */
446 unsigned long jpg_que_tail; /* Index of last buffer in queue */
447 unsigned long jpg_seq_num; /* count of frames since grab/play started */
448 unsigned long jpg_err_seq; /* last seq_num before error */
449 unsigned long jpg_err_shift;
450 unsigned long jpg_queued_num; /* count of frames queued since grab/play started */
451
452 /* zr36057's code buffer table */
Al Viro581a7f12008-05-21 00:32:31 -0300453 __le32 *stat_com; /* stat_com[i] is indexed by dma_head/tail & BUZ_MASK_STAT_COM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455 /* (value & BUZ_MASK_FRAME) corresponds to index in pend[] queue */
456 int jpg_pend[BUZ_MAX_FRAME];
457
458 /* array indexed by frame number */
459 struct zoran_jpg_struct jpg_buffers; /* MJPEG buffers' info */
460
461 /* Additional stuff for testing */
462#ifdef CONFIG_PROC_FS
463 struct proc_dir_entry *zoran_proc;
464#else
465 void *zoran_proc;
466#endif
467 int testing;
468 int jpeg_error;
469 int intr_counter_GIRQ1;
470 int intr_counter_GIRQ0;
471 int intr_counter_CodRepIRQ;
472 int intr_counter_JPEGRepIRQ;
473 int field_counter;
474 int IRQ1_in;
475 int IRQ1_out;
476 int JPEG_in;
477 int JPEG_out;
478 int JPEG_0;
479 int JPEG_1;
480 int END_event_missed;
481 int JPEG_missed;
482 int JPEG_error;
483 int num_errors;
484 int JPEG_max_missed;
485 int JPEG_min_missed;
486
487 u32 last_isr;
488 unsigned long frame_num;
489
490 wait_queue_head_t test_q;
491};
492
493/*The following should be done in more portable way. It depends on define
494 of _ALPHA_BUZ in the Makefile.*/
495
496#ifdef _ALPHA_BUZ
497#define btwrite(dat,adr) writel((dat), zr->zr36057_adr+(adr))
498#define btread(adr) readl(zr->zr36057_adr+(adr))
499#else
500#define btwrite(dat,adr) writel((dat), zr->zr36057_mem+(adr))
501#define btread(adr) readl(zr->zr36057_mem+(adr))
502#endif
503
504#define btand(dat,adr) btwrite((dat) & btread(adr), adr)
505#define btor(dat,adr) btwrite((dat) | btread(adr), adr)
506#define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
507
508#endif /* __kernel__ */
509
510#endif