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