3 bttv - Bt848 frame grabber driver
5 bttv's *private* header file -- nobody other than bttv itself
6 should ever include this file.
8 (c) 2000-2002 Gerd Knorr <kraxel@bytesex.org>
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.
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.
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.
28 #include <linux/version.h>
29 #define BTTV_VERSION_CODE KERNEL_VERSION(0,9,18)
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>
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/rc-core.h>
45 #include <media/ir-kbd-i2c.h>
49 #include "btcx-risc.h"
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
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
65 #define RESOURCE_OVERLAY 1
66 #define RESOURCE_VIDEO_STREAM 2
67 #define RESOURCE_VBI 4
68 #define RESOURCE_VIDEO_READ 8
75 /* Min. value in VDELAY register. */
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)
83 V4L2_STD_PAL | V4L2_STD_PAL_N | \
84 V4L2_STD_PAL_Nc | V4L2_STD_SECAM | \
85 V4L2_STD_NTSC | V4L2_STD_PAL_M | \
87 /* ---------------------------------------------------------- */
93 u16 swidth, sheight; /* scaled standard width, height */
95 u8 adelay, bdelay, iform;
97 u16 hdelayx1, hactivex1;
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. */
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;
111 extern const struct bttv_tvnorm bttv_tvnorms[];
115 int fourcc; /* video4linux 2 */
116 int btformat; /* BT848_COLOR_FMT_* */
117 int btswap; /* BT848_COLOR_CTL_* */
118 int depth; /* bit/pixel */
120 int hshift,vshift; /* for planar modes */
125 struct timer_list timer;
130 /* Usual gpio signalling */
137 int start; // What should RC5_START() be
138 int addr; // What RC5_ADDR() should be.
143 u32 last_bit; /* last raw bit seen */
144 u32 code; /* raw code under construction */
145 struct timeval base_time; /* time of last seen code */
146 bool active; /* building raw code */
150 /* ---------------------------------------------------------- */
152 struct bttv_geometry {
154 u16 width,hscale,hdelay;
155 u16 sheight,vscale,vdelay,vtotal;
159 /* common v4l buffer stuff -- must be first */
160 struct videobuf_buffer vb;
163 const struct bttv_format *fmt;
167 struct bttv_geometry geo;
168 struct btcx_riscmem top;
169 struct btcx_riscmem bottom;
170 struct v4l2_rect crop;
171 unsigned int vbi_skip[2];
172 unsigned int vbi_count[2];
175 struct bttv_buffer_set {
176 struct bttv_buffer *top; /* top field buffer */
177 struct bttv_buffer *bottom; /* bottom field buffer */
178 unsigned int top_irq;
179 unsigned int frame_irq;
182 struct bttv_overlay {
185 enum v4l2_field field;
186 struct v4l2_clip *clips;
191 struct bttv_vbi_fmt {
192 struct v4l2_vbi_format fmt;
194 /* fmt.start[] and count[] refer to this video standard. */
195 const struct bttv_tvnorm *tvnorm;
197 /* Earliest possible start of video capturing with this
198 v4l2_vbi_format, in struct bttv_crop.rect units. */
203 void bttv_vbi_fmt_reset(struct bttv_vbi_fmt *f, unsigned int norm);
206 /* A cropping rectangle in struct bttv_tvnorm.cropcap units. */
207 struct v4l2_rect rect;
209 /* Scaled image size limits with this crop rect. Divide
210 max_height, but not min_height, by two when capturing
211 single fields. See also bttv_crop_reset() and
212 bttv_crop_adjust() in bttv-driver.c. */
213 __s32 min_scaled_width;
214 __s32 min_scaled_height;
215 __s32 max_scaled_width;
216 __s32 max_scaled_height;
222 #ifdef VIDIOC_G_PRIORITY
223 enum v4l2_priority prio;
225 enum v4l2_buf_type type;
228 struct videobuf_queue cap;
229 const struct bttv_format *fmt;
234 const struct bttv_format *ovfmt;
235 struct bttv_overlay ov;
237 /* Application called VIDIOC_S_CROP. */
241 struct videobuf_queue vbi;
242 /* Current VBI capture window as seen through this fh (cannot
243 be global for compatibility with earlier drivers). Protected
244 by struct bttv.lock and struct bttv_fh.vbi.lock. */
245 struct bttv_vbi_fmt vbi_fmt;
248 /* ---------------------------------------------------------- */
251 /* risc code generators - capture */
252 int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
253 struct scatterlist *sglist,
254 unsigned int offset, unsigned int bpl,
255 unsigned int pitch, unsigned int skip_lines,
256 unsigned int store_lines);
258 /* control dma register + risc main loop */
259 void bttv_set_dma(struct bttv *btv, int override);
260 int bttv_risc_init_main(struct bttv *btv);
261 int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
264 /* capture buffer handling */
265 int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
266 int bttv_buffer_activate_video(struct bttv *btv,
267 struct bttv_buffer_set *set);
268 int bttv_buffer_activate_vbi(struct bttv *btv,
269 struct bttv_buffer *vbi);
270 void bttv_dma_free(struct videobuf_queue *q, struct bttv *btv,
271 struct bttv_buffer *buf);
273 /* overlay handling */
274 int bttv_overlay_risc(struct bttv *btv, struct bttv_overlay *ov,
275 const struct bttv_format *fmt,
276 struct bttv_buffer *buf);
279 /* ---------------------------------------------------------- */
282 int bttv_try_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
283 int bttv_g_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
284 int bttv_s_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
286 extern struct videobuf_queue_ops bttv_vbi_qops;
288 /* ---------------------------------------------------------- */
291 extern struct bus_type bttv_sub_bus_type;
292 int bttv_sub_add_device(struct bttv_core *core, char *name);
293 int bttv_sub_del_devices(struct bttv_core *core);
295 /* ---------------------------------------------------------- */
298 extern int no_overlay;
300 /* ---------------------------------------------------------- */
303 extern void init_bttv_i2c_ir(struct bttv *btv);
304 extern int fini_bttv_i2c(struct bttv *btv);
306 /* ---------------------------------------------------------- */
310 extern unsigned int bttv_verbose;
311 extern unsigned int bttv_debug;
312 extern unsigned int bttv_gpio;
313 extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
314 extern int init_bttv_i2c(struct bttv *btv);
316 #define bttv_printk if (bttv_verbose) printk
317 #define dprintk if (bttv_debug >= 1) printk
318 #define d2printk if (bttv_debug >= 2) printk
320 #define BTTV_MAX_FBUF 0x208000
321 #define BTTV_TIMEOUT msecs_to_jiffies(500) /* 0.5 seconds */
322 #define BTTV_FREE_IDLE msecs_to_jiffies(1000) /* one second */
325 struct bttv_pll_info {
326 unsigned int pll_ifreq; /* PLL input frequency */
327 unsigned int pll_ofreq; /* PLL output frequency */
328 unsigned int pll_crystal; /* Crystal used for input */
329 unsigned int pll_current; /* Currently programmed ofreq */
332 /* for gpio-connected remote control */
334 struct input_dev *dev;
341 struct bttv_suspend_state {
346 struct bttv_buffer_set video;
347 struct bttv_buffer *vbi;
353 /* pci device config */
355 unsigned char revision;
356 unsigned char __iomem *bt848_mmio; /* pointer to mmio */
358 /* card configuration info */
359 unsigned int cardid; /* pci subsystem id (bt878 based ones) */
360 unsigned int tuner_type; /* tuner chip type */
361 unsigned int tda9887_conf;
362 unsigned int svhs, dig;
363 unsigned int has_saa6588:1;
364 struct bttv_pll_info pll;
367 int (*custom_irq)(struct bttv *btv);
371 /* old gpio interface */
372 wait_queue_head_t gpioq;
375 void (*volume_gpio)(struct bttv *btv, __u16 volume);
376 void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
378 /* new gpio interface */
379 spinlock_t gpio_lock;
382 struct i2c_algo_bit_data i2c_algo;
383 struct i2c_client i2c_client;
384 int i2c_state, i2c_rc;
386 wait_queue_head_t i2c_queue;
387 struct v4l2_subdev *sd_msp34xx;
388 struct v4l2_subdev *sd_tvaudio;
390 /* video4linux (1) */
391 struct video_device *video_dev;
392 struct video_device *radio_dev;
393 struct video_device *vbi_dev;
395 /* infrared remote */
397 struct bttv_ir *remote;
399 /* I2C remote data */
400 struct IR_i2c_init_data init_data;
406 #ifdef VIDIOC_G_PRIORITY
407 struct v4l2_prio_state prio;
416 int hue, contrast, bright, saturation;
417 struct v4l2_framebuffer fbuf;
418 unsigned int field_count;
420 /* various options */
427 int opt_whitecrush_upper;
428 int opt_whitecrush_lower;
430 int opt_full_luma_range;
433 /* radio data/state */
437 /* miro/pinnacle + Aimslab VHX
438 philips matchbox (tea5757 radio tuner) support */
446 /* ISA stuff (Terratec Active Radio Upgrade) */
451 /* risc memory management data
452 - must acquire s_lock before changing these
453 - only the irq handler is supported to touch top + bottom + vcurr */
454 struct btcx_riscmem main;
455 struct bttv_buffer *screen; /* overlay */
456 struct list_head capture; /* video capture queue */
457 struct list_head vcapture; /* vbi capture queue */
458 struct bttv_buffer_set curr; /* active buffers */
459 struct bttv_buffer *cvbi; /* active vbi buffer */
463 unsigned long cap_ctl;
464 unsigned long dma_on;
465 struct timer_list timeout;
466 struct bttv_suspend_state state;
470 unsigned int framedrop;
471 unsigned int irq_total;
477 /* used to make dvb-bt8xx autoloadable */
478 struct work_struct request_module_wk;
480 /* Default (0) and current (1) video capturing and overlay
481 cropping parameters in bttv_tvnorm.cropcap units. Protected
483 struct bttv_crop crop[2];
485 /* Earliest possible start of video capturing in
486 bttv_tvnorm.cropcap line units. Set by check_alloc_btres()
487 and free_btres(). Protected by bttv.lock. */
490 /* Latest possible end of VBI capturing (= crop[x].rect.top when
491 VIDEO_RESOURCES are locked). Set by check_alloc_btres()
492 and free_btres(). Protected by bttv.lock. */
496 static inline struct bttv *to_bttv(struct v4l2_device *v4l2_dev)
498 return container_of(v4l2_dev, struct bttv, c.v4l2_dev);
503 extern unsigned int bttv_num;
504 extern struct bttv *bttvs[BTTV_MAX];
506 static inline unsigned int bttv_muxsel(const struct bttv *btv,
509 return (bttv_tvcards[btv->c.type].muxsel >> (input * 2)) & 3;
514 #define btwrite(dat,adr) writel((dat), btv->bt848_mmio+(adr))
515 #define btread(adr) readl(btv->bt848_mmio+(adr))
517 #define btand(dat,adr) btwrite((dat) & btread(adr), adr)
518 #define btor(dat,adr) btwrite((dat) | btread(adr), adr)
519 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
521 #endif /* _BTTVP_H_ */