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