]> Pileus Git - ~andy/linux/blob - drivers/media/video/bt8xx/bttvp.h
[media] ir-core: remove remaining users of the ir-functions keyhandlers
[~andy/linux] / 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,18)
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/pci.h>
36 #include <linux/input.h>
37 #include <linux/mutex.h>
38 #include <linux/scatterlist.h>
39 #include <asm/io.h>
40 #include <media/v4l2-common.h>
41 #include <linux/device.h>
42 #include <media/videobuf-dma-sg.h>
43 #include <media/tveeprom.h>
44 #include <media/ir-common.h>
45 #include <media/ir-kbd-i2c.h>
46
47 #include "bt848.h"
48 #include "bttv.h"
49 #include "btcx-risc.h"
50
51 #ifdef __KERNEL__
52
53 #define FORMAT_FLAGS_DITHER       0x01
54 #define FORMAT_FLAGS_PACKED       0x02
55 #define FORMAT_FLAGS_PLANAR       0x04
56 #define FORMAT_FLAGS_RAW          0x08
57 #define FORMAT_FLAGS_CrCb         0x10
58
59 #define RISC_SLOT_O_VBI        4
60 #define RISC_SLOT_O_FIELD      6
61 #define RISC_SLOT_E_VBI       10
62 #define RISC_SLOT_E_FIELD     12
63 #define RISC_SLOT_LOOP        14
64
65 #define RESOURCE_OVERLAY       1
66 #define RESOURCE_VIDEO_STREAM  2
67 #define RESOURCE_VBI           4
68 #define RESOURCE_VIDEO_READ    8
69
70 #define RAW_LINES            640
71 #define RAW_BPL             1024
72
73 #define UNSET (-1U)
74
75 /* Min. value in VDELAY register. */
76 #define MIN_VDELAY 2
77 /* Even to get Cb first, odd for Cr. */
78 #define MAX_HDELAY (0x3FF & -2)
79 /* Limits scaled width, which must be a multiple of 4. */
80 #define MAX_HACTIVE (0x3FF & -4)
81
82 #define BTTV_NORMS    (\
83                 V4L2_STD_PAL    | V4L2_STD_PAL_N | \
84                 V4L2_STD_PAL_Nc | V4L2_STD_SECAM | \
85                 V4L2_STD_NTSC   | V4L2_STD_PAL_M | \
86                 V4L2_STD_PAL_60)
87 /* ---------------------------------------------------------- */
88
89 struct bttv_tvnorm {
90         int   v4l2_id;
91         char  *name;
92         u32   Fsc;
93         u16   swidth, sheight; /* scaled standard width, height */
94         u16   totalwidth;
95         u8    adelay, bdelay, iform;
96         u32   scaledtwidth;
97         u16   hdelayx1, hactivex1;
98         u16   vdelay;
99         u8    vbipack;
100         u16   vtotal;
101         int   sram;
102         /* ITU-R frame line number of the first VBI line we can
103            capture, of the first and second field. The last possible line
104            is determined by cropcap.bounds. */
105         u16   vbistart[2];
106         /* Horizontally this counts fCLKx1 samples following the leading
107            edge of the horizontal sync pulse, vertically ITU-R frame line
108            numbers of the first field times two (2, 4, 6, ... 524 or 624). */
109         struct v4l2_cropcap cropcap;
110 };
111 extern const struct bttv_tvnorm bttv_tvnorms[];
112
113 struct bttv_format {
114         char *name;
115         int  fourcc;          /* video4linux 2      */
116         int  btformat;        /* BT848_COLOR_FMT_*  */
117         int  btswap;          /* BT848_COLOR_CTL_*  */
118         int  depth;           /* bit/pixel          */
119         int  flags;
120         int  hshift,vshift;   /* for planar modes   */
121 };
122
123 /* ---------------------------------------------------------- */
124
125 struct bttv_geometry {
126         u8  vtc,crop,comb;
127         u16 width,hscale,hdelay;
128         u16 sheight,vscale,vdelay,vtotal;
129 };
130
131 struct bttv_buffer {
132         /* common v4l buffer stuff -- must be first */
133         struct videobuf_buffer     vb;
134
135         /* bttv specific */
136         const struct bttv_format   *fmt;
137         unsigned int               tvnorm;
138         int                        btformat;
139         int                        btswap;
140         struct bttv_geometry       geo;
141         struct btcx_riscmem        top;
142         struct btcx_riscmem        bottom;
143         struct v4l2_rect           crop;
144         unsigned int               vbi_skip[2];
145         unsigned int               vbi_count[2];
146 };
147
148 struct bttv_buffer_set {
149         struct bttv_buffer     *top;       /* top field buffer    */
150         struct bttv_buffer     *bottom;    /* bottom field buffer */
151         unsigned int           top_irq;
152         unsigned int           frame_irq;
153 };
154
155 struct bttv_overlay {
156         unsigned int           tvnorm;
157         struct v4l2_rect       w;
158         enum v4l2_field        field;
159         struct v4l2_clip       *clips;
160         int                    nclips;
161         int                    setup_ok;
162 };
163
164 struct bttv_vbi_fmt {
165         struct v4l2_vbi_format fmt;
166
167         /* fmt.start[] and count[] refer to this video standard. */
168         const struct bttv_tvnorm *tvnorm;
169
170         /* Earliest possible start of video capturing with this
171            v4l2_vbi_format, in struct bttv_crop.rect units. */
172         __s32                  end;
173 };
174
175 /* bttv-vbi.c */
176 void bttv_vbi_fmt_reset(struct bttv_vbi_fmt *f, unsigned int norm);
177
178 struct bttv_crop {
179         /* A cropping rectangle in struct bttv_tvnorm.cropcap units. */
180         struct v4l2_rect       rect;
181
182         /* Scaled image size limits with this crop rect. Divide
183            max_height, but not min_height, by two when capturing
184            single fields. See also bttv_crop_reset() and
185            bttv_crop_adjust() in bttv-driver.c. */
186         __s32                  min_scaled_width;
187         __s32                  min_scaled_height;
188         __s32                  max_scaled_width;
189         __s32                  max_scaled_height;
190 };
191
192 struct bttv_fh {
193         struct bttv              *btv;
194         int resources;
195 #ifdef VIDIOC_G_PRIORITY
196         enum v4l2_priority       prio;
197 #endif
198         enum v4l2_buf_type       type;
199
200         /* video capture */
201         struct videobuf_queue    cap;
202         const struct bttv_format *fmt;
203         int                      width;
204         int                      height;
205
206         /* video overlay */
207         const struct bttv_format *ovfmt;
208         struct bttv_overlay      ov;
209
210         /* Application called VIDIOC_S_CROP. */
211         int                      do_crop;
212
213         /* vbi capture */
214         struct videobuf_queue    vbi;
215         /* Current VBI capture window as seen through this fh (cannot
216            be global for compatibility with earlier drivers). Protected
217            by struct bttv.lock and struct bttv_fh.vbi.lock. */
218         struct bttv_vbi_fmt      vbi_fmt;
219 };
220
221 /* ---------------------------------------------------------- */
222 /* bttv-risc.c                                                */
223
224 /* risc code generators - capture */
225 int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
226                      struct scatterlist *sglist,
227                      unsigned int offset, unsigned int bpl,
228                      unsigned int pitch, unsigned int skip_lines,
229                      unsigned int store_lines);
230
231 /* control dma register + risc main loop */
232 void bttv_set_dma(struct bttv *btv, int override);
233 int bttv_risc_init_main(struct bttv *btv);
234 int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
235                    int irqflags);
236
237 /* capture buffer handling */
238 int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
239 int bttv_buffer_activate_video(struct bttv *btv,
240                                struct bttv_buffer_set *set);
241 int bttv_buffer_activate_vbi(struct bttv *btv,
242                              struct bttv_buffer *vbi);
243 void bttv_dma_free(struct videobuf_queue *q, struct bttv *btv,
244                    struct bttv_buffer *buf);
245
246 /* overlay handling */
247 int bttv_overlay_risc(struct bttv *btv, struct bttv_overlay *ov,
248                       const struct bttv_format *fmt,
249                       struct bttv_buffer *buf);
250
251
252 /* ---------------------------------------------------------- */
253 /* bttv-vbi.c                                                 */
254
255 int bttv_try_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
256 int bttv_g_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
257 int bttv_s_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
258
259 extern struct videobuf_queue_ops bttv_vbi_qops;
260
261 /* ---------------------------------------------------------- */
262 /* bttv-gpio.c */
263
264 extern struct bus_type bttv_sub_bus_type;
265 int bttv_sub_add_device(struct bttv_core *core, char *name);
266 int bttv_sub_del_devices(struct bttv_core *core);
267
268 /* ---------------------------------------------------------- */
269 /* bttv-cards.c                                               */
270
271 extern int no_overlay;
272
273 /* ---------------------------------------------------------- */
274 /* bttv-input.c                                               */
275
276 extern void init_bttv_i2c_ir(struct bttv *btv);
277 extern int fini_bttv_i2c(struct bttv *btv);
278
279 /* ---------------------------------------------------------- */
280 /* bttv-driver.c                                              */
281
282 /* insmod options */
283 extern unsigned int bttv_verbose;
284 extern unsigned int bttv_debug;
285 extern unsigned int bttv_gpio;
286 extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
287 extern int init_bttv_i2c(struct bttv *btv);
288
289 #define bttv_printk if (bttv_verbose) printk
290 #define dprintk  if (bttv_debug >= 1) printk
291 #define d2printk if (bttv_debug >= 2) printk
292
293 #define BTTV_MAX_FBUF   0x208000
294 #define BTTV_TIMEOUT    msecs_to_jiffies(500)    /* 0.5 seconds */
295 #define BTTV_FREE_IDLE  msecs_to_jiffies(1000)   /* one second */
296
297
298 struct bttv_pll_info {
299         unsigned int pll_ifreq;    /* PLL input frequency        */
300         unsigned int pll_ofreq;    /* PLL output frequency       */
301         unsigned int pll_crystal;  /* Crystal used for input     */
302         unsigned int pll_current;  /* Currently programmed ofreq */
303 };
304
305 /* for gpio-connected remote control */
306 struct bttv_input {
307         struct input_dev      *dev;
308         char                  name[32];
309         char                  phys[32];
310         u32                   mask_keycode;
311         u32                   mask_keydown;
312 };
313
314 struct bttv_suspend_state {
315         u32  gpio_enable;
316         u32  gpio_data;
317         int  disabled;
318         int  loop_irq;
319         struct bttv_buffer_set video;
320         struct bttv_buffer     *vbi;
321 };
322
323 struct bttv {
324         struct bttv_core c;
325
326         /* pci device config */
327         unsigned short id;
328         unsigned char revision;
329         unsigned char __iomem *bt848_mmio;   /* pointer to mmio */
330
331         /* card configuration info */
332         unsigned int cardid;   /* pci subsystem id (bt878 based ones) */
333         unsigned int tuner_type;  /* tuner chip type */
334         unsigned int tda9887_conf;
335         unsigned int svhs, dig;
336         unsigned int has_saa6588:1;
337         struct bttv_pll_info pll;
338         int triton1;
339         int gpioirq;
340         int (*custom_irq)(struct bttv *btv);
341
342         int use_i2c_hw;
343
344         /* old gpio interface */
345         wait_queue_head_t gpioq;
346         int shutdown;
347
348         void (*volume_gpio)(struct bttv *btv, __u16 volume);
349         void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
350
351         /* new gpio interface */
352         spinlock_t gpio_lock;
353
354         /* i2c layer */
355         struct i2c_algo_bit_data   i2c_algo;
356         struct i2c_client          i2c_client;
357         int                        i2c_state, i2c_rc;
358         int                        i2c_done;
359         wait_queue_head_t          i2c_queue;
360         struct v4l2_subdev        *sd_msp34xx;
361         struct v4l2_subdev        *sd_tvaudio;
362
363         /* video4linux (1) */
364         struct video_device *video_dev;
365         struct video_device *radio_dev;
366         struct video_device *vbi_dev;
367
368         /* infrared remote */
369         int has_remote;
370         struct card_ir *remote;
371
372         /* I2C remote data */
373         struct IR_i2c_init_data    init_data;
374
375         /* locking */
376         spinlock_t s_lock;
377         struct mutex lock;
378         int resources;
379 #ifdef VIDIOC_G_PRIORITY
380         struct v4l2_prio_state prio;
381 #endif
382
383         /* video state */
384         unsigned int input;
385         unsigned int audio;
386         unsigned int mute;
387         unsigned long freq;
388         unsigned int tvnorm;
389         int hue, contrast, bright, saturation;
390         struct v4l2_framebuffer fbuf;
391         unsigned int field_count;
392
393         /* various options */
394         int opt_combfilter;
395         int opt_lumafilter;
396         int opt_automute;
397         int opt_chroma_agc;
398         int opt_adc_crush;
399         int opt_vcr_hack;
400         int opt_whitecrush_upper;
401         int opt_whitecrush_lower;
402         int opt_uv_ratio;
403         int opt_full_luma_range;
404         int opt_coring;
405
406         /* radio data/state */
407         int has_radio;
408         int radio_user;
409
410         /* miro/pinnacle + Aimslab VHX
411            philips matchbox (tea5757 radio tuner) support */
412         int has_matchbox;
413         int mbox_we;
414         int mbox_data;
415         int mbox_clk;
416         int mbox_most;
417         int mbox_mask;
418
419         /* ISA stuff (Terratec Active Radio Upgrade) */
420         int mbox_ior;
421         int mbox_iow;
422         int mbox_csel;
423
424         /* risc memory management data
425            - must acquire s_lock before changing these
426            - only the irq handler is supported to touch top + bottom + vcurr */
427         struct btcx_riscmem     main;
428         struct bttv_buffer      *screen;    /* overlay             */
429         struct list_head        capture;    /* video capture queue */
430         struct list_head        vcapture;   /* vbi capture queue   */
431         struct bttv_buffer_set  curr;       /* active buffers      */
432         struct bttv_buffer      *cvbi;      /* active vbi buffer   */
433         int                     loop_irq;
434         int                     new_input;
435
436         unsigned long cap_ctl;
437         unsigned long dma_on;
438         struct timer_list timeout;
439         struct bttv_suspend_state state;
440
441         /* stats */
442         unsigned int errors;
443         unsigned int framedrop;
444         unsigned int irq_total;
445         unsigned int irq_me;
446
447         unsigned int users;
448         struct bttv_fh init;
449
450         /* used to make dvb-bt8xx autoloadable */
451         struct work_struct request_module_wk;
452
453         /* Default (0) and current (1) video capturing and overlay
454            cropping parameters in bttv_tvnorm.cropcap units. Protected
455            by bttv.lock. */
456         struct bttv_crop crop[2];
457
458         /* Earliest possible start of video capturing in
459            bttv_tvnorm.cropcap line units. Set by check_alloc_btres()
460            and free_btres(). Protected by bttv.lock. */
461         __s32                   vbi_end;
462
463         /* Latest possible end of VBI capturing (= crop[x].rect.top when
464            VIDEO_RESOURCES are locked). Set by check_alloc_btres()
465            and free_btres(). Protected by bttv.lock. */
466         __s32                   crop_start;
467 };
468
469 static inline struct bttv *to_bttv(struct v4l2_device *v4l2_dev)
470 {
471         return container_of(v4l2_dev, struct bttv, c.v4l2_dev);
472 }
473
474 /* our devices */
475 #define BTTV_MAX 32
476 extern unsigned int bttv_num;
477 extern struct bttv *bttvs[BTTV_MAX];
478
479 static inline unsigned int bttv_muxsel(const struct bttv *btv,
480                                        unsigned int input)
481 {
482         return (bttv_tvcards[btv->c.type].muxsel >> (input * 2)) & 3;
483 }
484
485 #endif
486
487 #define btwrite(dat,adr)    writel((dat), btv->bt848_mmio+(adr))
488 #define btread(adr)         readl(btv->bt848_mmio+(adr))
489
490 #define btand(dat,adr)      btwrite((dat) & btread(adr), adr)
491 #define btor(dat,adr)       btwrite((dat) | btread(adr), adr)
492 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
493
494 #endif /* _BTTVP_H_ */
495
496 /*
497  * Local variables:
498  * c-basic-offset: 8
499  * End:
500  */