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/types.h>
29 #include <linux/wait.h>
30 #include <linux/i2c.h>
31 #include <linux/i2c-algo-bit.h>
32 #include <linux/pci.h>
33 #include <linux/input.h>
34 #include <linux/mutex.h>
35 #include <linux/scatterlist.h>
36 #include <linux/device.h>
37 #include <asm/io.h>
38 #include <media/v4l2-common.h>
39 #include <media/v4l2-ctrls.h>
40 #include <media/v4l2-fh.h>
41 #include <media/videobuf-dma-sg.h>
42 #include <media/tveeprom.h>
43 #include <media/rc-core.h>
44 #include <media/i2c/ir-kbd-i2c.h>
45 #include <media/drv-intf/tea575x.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 struct bttv_ir {
124 struct rc_dev *dev;
125 struct bttv *btv;
126 struct timer_list timer;
127
128 char name[32];
129 char phys[32];
130
131 /* Usual gpio signalling */
132 u32 mask_keycode;
133 u32 mask_keydown;
134 u32 mask_keyup;
135 u32 polling;
136 u32 last_gpio;
137 int shift_by;
138 int rc5_remote_gap;
139
140 /* RC5 gpio */
141 bool rc5_gpio; /* Is RC5 legacy GPIO enabled? */
142 u32 last_bit; /* last raw bit seen */
143 u32 code; /* raw code under construction */
144 ktime_t base_time; /* time of last seen code */
145 bool active; /* building raw code */
146 };
147
148
149 /* ---------------------------------------------------------- */
150
151 struct bttv_geometry {
152 u8 vtc,crop,comb;
153 u16 width,hscale,hdelay;
154 u16 sheight,vscale,vdelay,vtotal;
155 };
156
157 struct bttv_buffer {
158 /* common v4l buffer stuff -- must be first */
159 struct videobuf_buffer vb;
160
161 /* bttv specific */
162 const struct bttv_format *fmt;
163 unsigned int tvnorm;
164 int btformat;
165 int btswap;
166 struct bttv_geometry geo;
167 struct btcx_riscmem top;
168 struct btcx_riscmem bottom;
169 struct v4l2_rect crop;
170 unsigned int vbi_skip[2];
171 unsigned int vbi_count[2];
172 };
173
174 struct bttv_buffer_set {
175 struct bttv_buffer *top; /* top field buffer */
176 struct bttv_buffer *bottom; /* bottom field buffer */
177 unsigned int top_irq;
178 unsigned int frame_irq;
179 };
180
181 struct bttv_overlay {
182 unsigned int tvnorm;
183 struct v4l2_rect w;
184 enum v4l2_field field;
185 struct v4l2_clip *clips;
186 int nclips;
187 int setup_ok;
188 };
189
190 struct bttv_vbi_fmt {
191 struct v4l2_vbi_format fmt;
192
193 /* fmt.start[] and count[] refer to this video standard. */
194 const struct bttv_tvnorm *tvnorm;
195
196 /* Earliest possible start of video capturing with this
197 v4l2_vbi_format, in struct bttv_crop.rect units. */
198 __s32 end;
199 };
200
201 /* bttv-vbi.c */
202 void bttv_vbi_fmt_reset(struct bttv_vbi_fmt *f, unsigned int norm);
203
204 struct bttv_crop {
205 /* A cropping rectangle in struct bttv_tvnorm.cropcap units. */
206 struct v4l2_rect rect;
207
208 /* Scaled image size limits with this crop rect. Divide
209 max_height, but not min_height, by two when capturing
210 single fields. See also bttv_crop_reset() and
211 bttv_crop_adjust() in bttv-driver.c. */
212 __s32 min_scaled_width;
213 __s32 min_scaled_height;
214 __s32 max_scaled_width;
215 __s32 max_scaled_height;
216 };
217
218 struct bttv_fh {
219 /* This must be the first field in this struct */
220 struct v4l2_fh fh;
221
222 struct bttv *btv;
223 int resources;
224 enum v4l2_buf_type type;
225
226 /* video capture */
227 struct videobuf_queue cap;
228 const struct bttv_format *fmt;
229 int width;
230 int height;
231
232 /* video overlay */
233 const struct bttv_format *ovfmt;
234 struct bttv_overlay ov;
235
236 /* Application called VIDIOC_S_SELECTION. */
237 int do_crop;
238
239 /* vbi capture */
240 struct videobuf_queue vbi;
241 /* Current VBI capture window as seen through this fh (cannot
242 be global for compatibility with earlier drivers). Protected
243 by struct bttv.lock and struct bttv_fh.vbi.lock. */
244 struct bttv_vbi_fmt vbi_fmt;
245 };
246
247 /* ---------------------------------------------------------- */
248 /* bttv-risc.c */
249
250 /* risc code generators - capture */
251 int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
252 struct scatterlist *sglist,
253 unsigned int offset, unsigned int bpl,
254 unsigned int pitch, unsigned int skip_lines,
255 unsigned int store_lines);
256
257 /* control dma register + risc main loop */
258 void bttv_set_dma(struct bttv *btv, int override);
259 int bttv_risc_init_main(struct bttv *btv);
260 int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
261 int irqflags);
262
263 /* capture buffer handling */
264 int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
265 int bttv_buffer_activate_video(struct bttv *btv,
266 struct bttv_buffer_set *set);
267 int bttv_buffer_activate_vbi(struct bttv *btv,
268 struct bttv_buffer *vbi);
269 void bttv_dma_free(struct videobuf_queue *q, struct bttv *btv,
270 struct bttv_buffer *buf);
271
272 /* overlay handling */
273 int bttv_overlay_risc(struct bttv *btv, struct bttv_overlay *ov,
274 const struct bttv_format *fmt,
275 struct bttv_buffer *buf);
276
277
278 /* ---------------------------------------------------------- */
279 /* bttv-vbi.c */
280
281 int bttv_try_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
282 int bttv_g_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
283 int bttv_s_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
284
285 extern const struct videobuf_queue_ops bttv_vbi_qops;
286
287 /* ---------------------------------------------------------- */
288 /* bttv-gpio.c */
289
290 extern struct bus_type bttv_sub_bus_type;
291 int bttv_sub_add_device(struct bttv_core *core, char *name);
292 int bttv_sub_del_devices(struct bttv_core *core);
293
294 /* ---------------------------------------------------------- */
295 /* bttv-cards.c */
296
297 extern int no_overlay;
298
299 /* ---------------------------------------------------------- */
300 /* bttv-input.c */
301
302 extern void init_bttv_i2c_ir(struct bttv *btv);
303
304 /* ---------------------------------------------------------- */
305 /* bttv-i2c.c */
306 extern int init_bttv_i2c(struct bttv *btv);
307 extern int fini_bttv_i2c(struct bttv *btv);
308
309 /* ---------------------------------------------------------- */
310 /* bttv-driver.c */
311
312 /* insmod options */
313 extern unsigned int bttv_verbose;
314 extern unsigned int bttv_debug;
315 extern unsigned int bttv_gpio;
316 extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
317
318 #define dprintk(fmt, ...) \
319 do { \
320 if (bttv_debug >= 1) \
321 pr_debug(fmt, ##__VA_ARGS__); \
322 } while (0)
323 #define dprintk_cont(fmt, ...) \
324 do { \
325 if (bttv_debug >= 1) \
326 pr_cont(fmt, ##__VA_ARGS__); \
327 } while (0)
328 #define d2printk(fmt, ...) \
329 do { \
330 if (bttv_debug >= 2) \
331 printk(fmt, ##__VA_ARGS__); \
332 } while (0)
333
334 #define BTTV_MAX_FBUF 0x208000
335 #define BTTV_TIMEOUT msecs_to_jiffies(500) /* 0.5 seconds */
336 #define BTTV_FREE_IDLE msecs_to_jiffies(1000) /* one second */
337
338
339 struct bttv_pll_info {
340 unsigned int pll_ifreq; /* PLL input frequency */
341 unsigned int pll_ofreq; /* PLL output frequency */
342 unsigned int pll_crystal; /* Crystal used for input */
343 unsigned int pll_current; /* Currently programmed ofreq */
344 };
345
346 /* for gpio-connected remote control */
347 struct bttv_input {
348 struct input_dev *dev;
349 char name[32];
350 char phys[32];
351 u32 mask_keycode;
352 u32 mask_keydown;
353 };
354
355 struct bttv_suspend_state {
356 u32 gpio_enable;
357 u32 gpio_data;
358 int disabled;
359 int loop_irq;
360 struct bttv_buffer_set video;
361 struct bttv_buffer *vbi;
362 };
363
364 struct bttv_tea575x_gpio {
365 u8 data, clk, wren, most;
366 };
367
368 struct bttv {
369 struct bttv_core c;
370
371 /* pci device config */
372 unsigned short id;
373 unsigned char revision;
374 unsigned char __iomem *bt848_mmio; /* pointer to mmio */
375
376 /* card configuration info */
377 unsigned int cardid; /* pci subsystem id (bt878 based ones) */
378 unsigned int tuner_type; /* tuner chip type */
379 unsigned int tda9887_conf;
380 unsigned int svhs, dig;
381 unsigned int has_saa6588:1;
382 struct bttv_pll_info pll;
383 int triton1;
384 int gpioirq;
385
386 int use_i2c_hw;
387
388 /* old gpio interface */
389 int shutdown;
390
391 void (*volume_gpio)(struct bttv *btv, __u16 volume);
392 void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
393
394 /* new gpio interface */
395 spinlock_t gpio_lock;
396
397 /* i2c layer */
398 struct i2c_algo_bit_data i2c_algo;
399 struct i2c_client i2c_client;
400 int i2c_state, i2c_rc;
401 int i2c_done;
402 wait_queue_head_t i2c_queue;
403 struct v4l2_subdev *sd_msp34xx;
404 struct v4l2_subdev *sd_tvaudio;
405 struct v4l2_subdev *sd_tda7432;
406
407 /* video4linux (1) */
408 struct video_device video_dev;
409 struct video_device radio_dev;
410 struct video_device vbi_dev;
411
412 /* controls */
413 struct v4l2_ctrl_handler ctrl_handler;
414 struct v4l2_ctrl_handler radio_ctrl_handler;
415
416 /* infrared remote */
417 int has_remote;
418 struct bttv_ir *remote;
419
420 /* I2C remote data */
421 struct IR_i2c_init_data init_data;
422
423 /* locking */
424 spinlock_t s_lock;
425 struct mutex lock;
426 int resources;
427
428 /* video state */
429 unsigned int input;
430 unsigned int audio_input;
431 unsigned int mute;
432 unsigned long tv_freq;
433 unsigned int tvnorm;
434 v4l2_std_id std;
435 int hue, contrast, bright, saturation;
436 struct v4l2_framebuffer fbuf;
437 unsigned int field_count;
438
439 /* various options */
440 int opt_combfilter;
441 int opt_automute;
442 int opt_vcr_hack;
443 int opt_uv_ratio;
444
445 /* radio data/state */
446 int has_radio;
447 int has_radio_tuner;
448 int radio_user;
449 int radio_uses_msp_demodulator;
450 unsigned long radio_freq;
451
452 /* miro/pinnacle + Aimslab VHX
453 philips matchbox (tea5757 radio tuner) support */
454 int has_tea575x;
455 struct bttv_tea575x_gpio tea_gpio;
456 struct snd_tea575x tea;
457
458 /* ISA stuff (Terratec Active Radio Upgrade) */
459 int mbox_ior;
460 int mbox_iow;
461 int mbox_csel;
462
463 /* switch status for multi-controller cards */
464 char sw_status[4];
465
466 /* risc memory management data
467 - must acquire s_lock before changing these
468 - only the irq handler is supported to touch top + bottom + vcurr */
469 struct btcx_riscmem main;
470 struct bttv_buffer *screen; /* overlay */
471 struct list_head capture; /* video capture queue */
472 struct list_head vcapture; /* vbi capture queue */
473 struct bttv_buffer_set curr; /* active buffers */
474 struct bttv_buffer *cvbi; /* active vbi buffer */
475 int loop_irq;
476 int new_input;
477
478 unsigned long cap_ctl;
479 unsigned long dma_on;
480 struct timer_list timeout;
481 struct bttv_suspend_state state;
482
483 /* stats */
484 unsigned int errors;
485 unsigned int framedrop;
486 unsigned int irq_total;
487 unsigned int irq_me;
488
489 unsigned int users;
490 struct bttv_fh init;
491
492 /* used to make dvb-bt8xx autoloadable */
493 struct work_struct request_module_wk;
494
495 /* Default (0) and current (1) video capturing and overlay
496 cropping parameters in bttv_tvnorm.cropcap units. Protected
497 by bttv.lock. */
498 struct bttv_crop crop[2];
499
500 /* Earliest possible start of video capturing in
501 bttv_tvnorm.cropcap line units. Set by check_alloc_btres()
502 and free_btres(). Protected by bttv.lock. */
503 __s32 vbi_end;
504
505 /* Latest possible end of VBI capturing (= crop[x].rect.top when
506 VIDEO_RESOURCES are locked). Set by check_alloc_btres()
507 and free_btres(). Protected by bttv.lock. */
508 __s32 crop_start;
509 };
510
to_bttv(struct v4l2_device * v4l2_dev)511 static inline struct bttv *to_bttv(struct v4l2_device *v4l2_dev)
512 {
513 return container_of(v4l2_dev, struct bttv, c.v4l2_dev);
514 }
515
516 /* our devices */
517 #define BTTV_MAX 32
518 extern unsigned int bttv_num;
519 extern struct bttv *bttvs[BTTV_MAX];
520
bttv_muxsel(const struct bttv * btv,unsigned int input)521 static inline unsigned int bttv_muxsel(const struct bttv *btv,
522 unsigned int input)
523 {
524 return (bttv_tvcards[btv->c.type].muxsel >> (input * 2)) & 3;
525 }
526
527 #endif
528
529 #define btwrite(dat,adr) writel((dat), btv->bt848_mmio+(adr))
530 #define btread(adr) readl(btv->bt848_mmio+(adr))
531
532 #define btand(dat,adr) btwrite((dat) & btread(adr), adr)
533 #define btor(dat,adr) btwrite((dat) | btread(adr), adr)
534 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
535
536 #endif /* _BTTVP_H_ */
537
