[PATCH] v4l: (963) em28xx IR fixup
[safe/jmp/linux-2.6] / drivers / media / video / bttvp.h
1 /*
2
3     bttv - Bt848 frame grabber driver
4
5     bttv's *private* header file  --  nobody other than bttv itself
6     should ever include this file.
7
8     (c) 2000-2002 Gerd Knorr <kraxel@bytesex.org>
9
10     This program is free software; you can redistribute it and/or modify
11     it under the terms of the GNU General Public License as published by
12     the Free Software Foundation; either version 2 of the License, or
13     (at your option) any later version.
14
15     This program is distributed in the hope that it will be useful,
16     but WITHOUT ANY WARRANTY; without even the implied warranty of
17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18     GNU General Public License for more details.
19
20     You should have received a copy of the GNU General Public License
21     along with this program; if not, write to the Free Software
22     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 */
24
25 #ifndef _BTTVP_H_
26 #define _BTTVP_H_
27
28 #include <linux/version.h>
29 #define BTTV_VERSION_CODE KERNEL_VERSION(0,9,16)
30
31 #include <linux/types.h>
32 #include <linux/wait.h>
33 #include <linux/i2c.h>
34 #include <linux/i2c-algo-bit.h>
35 #include <linux/videodev.h>
36 #include <linux/pci.h>
37 #include <linux/input.h>
38 #include <asm/scatterlist.h>
39 #include <asm/io.h>
40
41 #include <linux/device.h>
42 #include <media/video-buf.h>
43 #include <media/audiochip.h>
44 #include <media/tuner.h>
45 #include <media/tveeprom.h>
46 #include <media/ir-common.h>
47
48 #include "bt848.h"
49 #include "bttv.h"
50 #include "btcx-risc.h"
51
52 #ifdef __KERNEL__
53
54 #define FORMAT_FLAGS_DITHER       0x01
55 #define FORMAT_FLAGS_PACKED       0x02
56 #define FORMAT_FLAGS_PLANAR       0x04
57 #define FORMAT_FLAGS_RAW          0x08
58 #define FORMAT_FLAGS_CrCb         0x10
59
60 #define RISC_SLOT_O_VBI        4
61 #define RISC_SLOT_O_FIELD      6
62 #define RISC_SLOT_E_VBI       10
63 #define RISC_SLOT_E_FIELD     12
64 #define RISC_SLOT_LOOP        14
65
66 #define RESOURCE_OVERLAY       1
67 #define RESOURCE_VIDEO         2
68 #define RESOURCE_VBI           4
69
70 #define RAW_LINES            640
71 #define RAW_BPL             1024
72
73 #define UNSET (-1U)
74
75 /* ---------------------------------------------------------- */
76
77 struct bttv_tvnorm {
78         int   v4l2_id;
79         char  *name;
80         u32   Fsc;
81         u16   swidth, sheight; /* scaled standard width, height */
82         u16   totalwidth;
83         u8    adelay, bdelay, iform;
84         u32   scaledtwidth;
85         u16   hdelayx1, hactivex1;
86         u16   vdelay;
87         u8    vbipack;
88         u16   vtotal;
89         int   sram;
90 };
91 extern const struct bttv_tvnorm bttv_tvnorms[];
92
93 struct bttv_format {
94         char *name;
95         int  palette;         /* video4linux 1      */
96         int  fourcc;          /* video4linux 2      */
97         int  btformat;        /* BT848_COLOR_FMT_*  */
98         int  btswap;          /* BT848_COLOR_CTL_*  */
99         int  depth;           /* bit/pixel          */
100         int  flags;
101         int  hshift,vshift;   /* for planar modes   */
102 };
103
104 /* ---------------------------------------------------------- */
105
106 struct bttv_geometry {
107         u8  vtc,crop,comb;
108         u16 width,hscale,hdelay;
109         u16 sheight,vscale,vdelay,vtotal;
110 };
111
112 struct bttv_buffer {
113         /* common v4l buffer stuff -- must be first */
114         struct videobuf_buffer     vb;
115
116         /* bttv specific */
117         const struct bttv_format   *fmt;
118         int                        tvnorm;
119         int                        btformat;
120         int                        btswap;
121         struct bttv_geometry       geo;
122         struct btcx_riscmem        top;
123         struct btcx_riscmem        bottom;
124 };
125
126 struct bttv_buffer_set {
127         struct bttv_buffer     *top;       /* top field buffer    */
128         struct bttv_buffer     *bottom;    /* bottom field buffer */
129         unsigned int           top_irq;
130         unsigned int           frame_irq;
131 };
132
133 struct bttv_overlay {
134         int                    tvnorm;
135         struct v4l2_rect       w;
136         enum v4l2_field        field;
137         struct v4l2_clip       *clips;
138         int                    nclips;
139         int                    setup_ok;
140 };
141
142 struct bttv_fh {
143         struct bttv              *btv;
144         int resources;
145 #ifdef VIDIOC_G_PRIORITY
146         enum v4l2_priority       prio;
147 #endif
148         enum v4l2_buf_type       type;
149
150         /* video capture */
151         struct videobuf_queue    cap;
152         const struct bttv_format *fmt;
153         int                      width;
154         int                      height;
155
156         /* current settings */
157         const struct bttv_format *ovfmt;
158         struct bttv_overlay      ov;
159
160         /* video overlay */
161         struct videobuf_queue    vbi;
162         int                      lines;
163 };
164
165 /* ---------------------------------------------------------- */
166 /* bttv-risc.c                                                */
167
168 /* risc code generators - capture */
169 int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
170                      struct scatterlist *sglist,
171                      unsigned int offset, unsigned int bpl,
172                      unsigned int pitch, unsigned int lines);
173
174 /* control dma register + risc main loop */
175 void bttv_set_dma(struct bttv *btv, int override);
176 int bttv_risc_init_main(struct bttv *btv);
177 int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
178                    int irqflags);
179
180 /* capture buffer handling */
181 int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
182 int bttv_buffer_activate_video(struct bttv *btv,
183                                struct bttv_buffer_set *set);
184 int bttv_buffer_activate_vbi(struct bttv *btv,
185                              struct bttv_buffer *vbi);
186 void bttv_dma_free(struct bttv *btv, struct bttv_buffer *buf);
187
188 /* overlay handling */
189 int bttv_overlay_risc(struct bttv *btv, struct bttv_overlay *ov,
190                       const struct bttv_format *fmt,
191                       struct bttv_buffer *buf);
192
193
194 /* ---------------------------------------------------------- */
195 /* bttv-vbi.c                                                 */
196
197 void bttv_vbi_try_fmt(struct bttv_fh *fh, struct v4l2_format *f);
198 void bttv_vbi_get_fmt(struct bttv_fh *fh, struct v4l2_format *f);
199 void bttv_vbi_setlines(struct bttv_fh *fh, struct bttv *btv, int lines);
200
201 extern struct videobuf_queue_ops bttv_vbi_qops;
202
203 /* ---------------------------------------------------------- */
204 /* bttv-gpio.c */
205
206
207 extern struct bus_type bttv_sub_bus_type;
208 int bttv_sub_add_device(struct bttv_core *core, char *name);
209 int bttv_sub_del_devices(struct bttv_core *core);
210 void bttv_gpio_irq(struct bttv_core *core);
211 int bttv_any_irq(struct bttv_core *core);
212
213
214 /* ---------------------------------------------------------- */
215 /* bttv-driver.c                                              */
216
217 /* insmod options */
218 extern unsigned int bttv_verbose;
219 extern unsigned int bttv_debug;
220 extern unsigned int bttv_gpio;
221 extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
222 extern int init_bttv_i2c(struct bttv *btv);
223 extern int fini_bttv_i2c(struct bttv *btv);
224
225 #define bttv_printk if (bttv_verbose) printk
226 #define dprintk  if (bttv_debug >= 1) printk
227 #define d2printk if (bttv_debug >= 2) printk
228
229 #define BTTV_MAX_FBUF   0x208000
230 #define VBIBUF_SIZE     (2048*VBI_MAXLINES*2)
231 #define BTTV_TIMEOUT    (HZ/2) /* 0.5 seconds */
232 #define BTTV_FREE_IDLE  (HZ)   /* one second */
233
234
235 struct bttv_pll_info {
236         unsigned int pll_ifreq;    /* PLL input frequency        */
237         unsigned int pll_ofreq;    /* PLL output frequency       */
238         unsigned int pll_crystal;  /* Crystal used for input     */
239         unsigned int pll_current;  /* Currently programmed ofreq */
240 };
241
242 /* for gpio-connected remote control */
243 struct bttv_input {
244         struct input_dev      *dev;
245         struct ir_input_state ir;
246         char                  name[32];
247         char                  phys[32];
248         u32                   mask_keycode;
249         u32                   mask_keydown;
250 };
251
252 struct bttv_suspend_state {
253         u32  gpio_enable;
254         u32  gpio_data;
255         int  disabled;
256         int  loop_irq;
257         struct bttv_buffer_set video;
258         struct bttv_buffer     *vbi;
259 };
260
261 struct bttv {
262         struct bttv_core c;
263
264         /* pci device config */
265         unsigned short id;
266         unsigned char revision;
267         unsigned char __iomem *bt848_mmio;   /* pointer to mmio */
268
269         /* card configuration info */
270         unsigned int cardid;   /* pci subsystem id (bt878 based ones) */
271         unsigned int tuner_type;  /* tuner chip type */
272         unsigned int pinnacle_id;
273         unsigned int svhs;
274         struct bttv_pll_info pll;
275         int triton1;
276         int gpioirq;
277         int any_irq;
278         int use_i2c_hw;
279
280         /* old gpio interface */
281         wait_queue_head_t gpioq;
282         int shutdown;
283         void (*audio_hook)(struct bttv *btv, struct video_audio *v, int set);
284
285         /* new gpio interface */
286         spinlock_t gpio_lock;
287
288         /* i2c layer */
289         struct i2c_algo_bit_data   i2c_algo;
290         struct i2c_client          i2c_client;
291         int                        i2c_state, i2c_rc;
292         int                        i2c_done;
293         wait_queue_head_t          i2c_queue;
294
295         /* video4linux (1) */
296         struct video_device *video_dev;
297         struct video_device *radio_dev;
298         struct video_device *vbi_dev;
299
300         /* infrared remote */
301         int has_remote;
302         struct bttv_input *remote;
303
304         /* locking */
305         spinlock_t s_lock;
306         struct semaphore lock;
307         int resources;
308         struct semaphore reslock;
309 #ifdef VIDIOC_G_PRIORITY
310         struct v4l2_prio_state prio;
311 #endif
312
313         /* video state */
314         unsigned int input;
315         unsigned int audio;
316         unsigned long freq;
317         int tvnorm,hue,contrast,bright,saturation;
318         struct v4l2_framebuffer fbuf;
319         unsigned int field_count;
320
321         /* various options */
322         int opt_combfilter;
323         int opt_lumafilter;
324         int opt_automute;
325         int opt_chroma_agc;
326         int opt_adc_crush;
327         int opt_vcr_hack;
328         int opt_whitecrush_upper;
329         int opt_whitecrush_lower;
330         int opt_uv_ratio;
331         int opt_full_luma_range;
332         int opt_coring;
333
334         /* radio data/state */
335         int has_radio;
336         int radio_user;
337
338         /* miro/pinnacle + Aimslab VHX
339            philips matchbox (tea5757 radio tuner) support */
340         int has_matchbox;
341         int mbox_we;
342         int mbox_data;
343         int mbox_clk;
344         int mbox_most;
345         int mbox_mask;
346
347         /* ISA stuff (Terratec Active Radio Upgrade) */
348         int mbox_ior;
349         int mbox_iow;
350         int mbox_csel;
351
352         /* risc memory management data
353            - must aquire s_lock before changing these
354            - only the irq handler is supported to touch top + bottom + vcurr */
355         struct btcx_riscmem     main;
356         struct bttv_buffer      *screen;    /* overlay             */
357         struct list_head        capture;    /* video capture queue */
358         struct list_head        vcapture;   /* vbi capture queue   */
359         struct bttv_buffer_set  curr;       /* active buffers      */
360         struct bttv_buffer      *cvbi;      /* active vbi buffer   */
361         int                     loop_irq;
362         int                     new_input;
363
364         unsigned long cap_ctl;
365         unsigned long dma_on;
366         struct timer_list timeout;
367         struct bttv_suspend_state state;
368
369         /* stats */
370         unsigned int errors;
371         unsigned int framedrop;
372         unsigned int irq_total;
373         unsigned int irq_me;
374
375         unsigned int users;
376         struct bttv_fh init;
377 };
378
379 /* our devices */
380 #define BTTV_MAX 16
381 extern unsigned int bttv_num;
382 extern struct bttv bttvs[BTTV_MAX];
383
384 /* private ioctls */
385 #define BTTV_VERSION            _IOR('v' , BASE_VIDIOCPRIVATE+6, int)
386 #define BTTV_VBISIZE            _IOR('v' , BASE_VIDIOCPRIVATE+8, int)
387
388 #endif
389
390 #define btwrite(dat,adr)    writel((dat), btv->bt848_mmio+(adr))
391 #define btread(adr)         readl(btv->bt848_mmio+(adr))
392
393 #define btand(dat,adr)      btwrite((dat) & btread(adr), adr)
394 #define btor(dat,adr)       btwrite((dat) | btread(adr), adr)
395 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
396
397 #endif /* _BTTVP_H_ */
398
399 /*
400  * Local variables:
401  * c-basic-offset: 8
402  * End:
403  */