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