V4L/DVB: usbvision: remove BKL from usbvision
[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>
3ff4ad81 29#define BTTV_VERSION_CODE KERNEL_VERSION(0,9,18)
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>
1da177e4
LT
35#include <linux/pci.h>
36#include <linux/input.h>
bd5f0ac9 37#include <linux/mutex.h>
87ae9afd 38#include <linux/scatterlist.h>
1da177e4 39#include <asm/io.h>
18f3fa1e 40#include <media/v4l2-common.h>
1da177e4 41#include <linux/device.h>
c1accaa2 42#include <media/videobuf-dma-sg.h>
1da177e4
LT
43#include <media/tveeprom.h>
44#include <media/ir-common.h>
45
674434c6 46
1da177e4
LT
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
e5bd0260 66#define RESOURCE_VIDEO_STREAM 2
1da177e4 67#define RESOURCE_VBI 4
e5bd0260 68#define RESOURCE_VIDEO_READ 8
1da177e4
LT
69
70#define RAW_LINES 640
71#define RAW_BPL 1024
72
73#define UNSET (-1U)
74
e5bd0260
MS
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
402aa76a
DSL
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)
1da177e4
LT
87/* ---------------------------------------------------------- */
88
89struct bttv_tvnorm {
90 int v4l2_id;
91 char *name;
4ac97914
MCC
92 u32 Fsc;
93 u16 swidth, sheight; /* scaled standard width, height */
1da177e4
LT
94 u16 totalwidth;
95 u8 adelay, bdelay, iform;
96 u32 scaledtwidth;
97 u16 hdelayx1, hactivex1;
98 u16 vdelay;
4ac97914 99 u8 vbipack;
1da177e4
LT
100 u16 vtotal;
101 int sram;
67f1570a 102 /* ITU-R frame line number of the first VBI line we can
e5bd0260
MS
103 capture, of the first and second field. The last possible line
104 is determined by cropcap.bounds. */
67f1570a 105 u16 vbistart[2];
e5bd0260
MS
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;
1da177e4
LT
110};
111extern const struct bttv_tvnorm bttv_tvnorms[];
112
113struct bttv_format {
114 char *name;
1da177e4
LT
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
125struct bttv_geometry {
126 u8 vtc,crop,comb;
127 u16 width,hscale,hdelay;
128 u16 sheight,vscale,vdelay,vtotal;
129};
130
131struct 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;
4ef2ccc2 137 unsigned int tvnorm;
1da177e4
LT
138 int btformat;
139 int btswap;
140 struct bttv_geometry geo;
141 struct btcx_riscmem top;
142 struct btcx_riscmem bottom;
e5bd0260
MS
143 struct v4l2_rect crop;
144 unsigned int vbi_skip[2];
145 unsigned int vbi_count[2];
1da177e4
LT
146};
147
148struct 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
155struct bttv_overlay {
4ef2ccc2 156 unsigned int tvnorm;
1da177e4
LT
157 struct v4l2_rect w;
158 enum v4l2_field field;
159 struct v4l2_clip *clips;
160 int nclips;
161 int setup_ok;
162};
163
e5bd0260
MS
164struct 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 */
4ef2ccc2 176void bttv_vbi_fmt_reset(struct bttv_vbi_fmt *f, unsigned int norm);
e5bd0260
MS
177
178struct 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
1da177e4
LT
192struct 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
e5bd0260 206 /* video overlay */
1da177e4
LT
207 const struct bttv_format *ovfmt;
208 struct bttv_overlay ov;
209
e5bd0260
MS
210 /* Application called VIDIOC_S_CROP. */
211 int do_crop;
212
213 /* vbi capture */
1da177e4 214 struct videobuf_queue vbi;
e5bd0260
MS
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;
1da177e4
LT
219};
220
221/* ---------------------------------------------------------- */
222/* bttv-risc.c */
223
224/* risc code generators - capture */
225int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
226 struct scatterlist *sglist,
227 unsigned int offset, unsigned int bpl,
e5bd0260
MS
228 unsigned int pitch, unsigned int skip_lines,
229 unsigned int store_lines);
1da177e4
LT
230
231/* control dma register + risc main loop */
232void bttv_set_dma(struct bttv *btv, int override);
233int bttv_risc_init_main(struct bttv *btv);
234int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
235 int irqflags);
236
237/* capture buffer handling */
238int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
239int bttv_buffer_activate_video(struct bttv *btv,
240 struct bttv_buffer_set *set);
241int bttv_buffer_activate_vbi(struct bttv *btv,
242 struct bttv_buffer *vbi);
c7b0ac05
MCC
243void bttv_dma_free(struct videobuf_queue *q, struct bttv *btv,
244 struct bttv_buffer *buf);
1da177e4
LT
245
246/* overlay handling */
247int 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
78b526a4
HV
255int bttv_try_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
256int bttv_g_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
257int bttv_s_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
1da177e4
LT
258
259extern struct videobuf_queue_ops bttv_vbi_qops;
260
261/* ---------------------------------------------------------- */
262/* bttv-gpio.c */
263
1da177e4
LT
264extern struct bus_type bttv_sub_bus_type;
265int bttv_sub_add_device(struct bttv_core *core, char *name);
266int bttv_sub_del_devices(struct bttv_core *core);
1da177e4 267
c6eb8eaf
HV
268/* ---------------------------------------------------------- */
269/* bttv-cards.c */
270
271extern int no_overlay;
272
1da177e4
LT
273/* ---------------------------------------------------------- */
274/* bttv-driver.c */
275
276/* insmod options */
277extern unsigned int bttv_verbose;
278extern unsigned int bttv_debug;
279extern unsigned int bttv_gpio;
280extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
281extern int init_bttv_i2c(struct bttv *btv);
24344664 282extern void init_bttv_i2c_ir(struct bttv *btv);
1da177e4
LT
283extern int fini_bttv_i2c(struct bttv *btv);
284
e1e70a26 285#define bttv_printk if (bttv_verbose) printk
1da177e4
LT
286#define dprintk if (bttv_debug >= 1) printk
287#define d2printk if (bttv_debug >= 2) printk
288
1da177e4 289#define BTTV_MAX_FBUF 0x208000
fe06fe0a
MCC
290#define BTTV_TIMEOUT msecs_to_jiffies(500) /* 0.5 seconds */
291#define BTTV_FREE_IDLE msecs_to_jiffies(1000) /* one second */
1da177e4
LT
292
293
294struct bttv_pll_info {
295 unsigned int pll_ifreq; /* PLL input frequency */
296 unsigned int pll_ofreq; /* PLL output frequency */
297 unsigned int pll_crystal; /* Crystal used for input */
298 unsigned int pll_current; /* Currently programmed ofreq */
299};
300
301/* for gpio-connected remote control */
302struct bttv_input {
b7df3910 303 struct input_dev *dev;
1da177e4
LT
304 struct ir_input_state ir;
305 char name[32];
306 char phys[32];
307 u32 mask_keycode;
308 u32 mask_keydown;
309};
310
311struct bttv_suspend_state {
312 u32 gpio_enable;
313 u32 gpio_data;
314 int disabled;
315 int loop_irq;
316 struct bttv_buffer_set video;
317 struct bttv_buffer *vbi;
318};
319
320struct bttv {
321 struct bttv_core c;
322
323 /* pci device config */
324 unsigned short id;
325 unsigned char revision;
326 unsigned char __iomem *bt848_mmio; /* pointer to mmio */
327
328 /* card configuration info */
329 unsigned int cardid; /* pci subsystem id (bt878 based ones) */
4ac97914 330 unsigned int tuner_type; /* tuner chip type */
39e8f40d 331 unsigned int tda9887_conf;
5221e21e 332 unsigned int svhs, dig;
859f0277 333 unsigned int has_saa6588:1;
1da177e4
LT
334 struct bttv_pll_info pll;
335 int triton1;
336 int gpioirq;
4abdfed5
RC
337 int (*custom_irq)(struct bttv *btv);
338
1da177e4
LT
339 int use_i2c_hw;
340
341 /* old gpio interface */
342 wait_queue_head_t gpioq;
343 int shutdown;
4b9b936f
NS
344
345 void (*volume_gpio)(struct bttv *btv, __u16 volume);
346 void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
347
1da177e4
LT
348 /* new gpio interface */
349 spinlock_t gpio_lock;
350
351 /* i2c layer */
352 struct i2c_algo_bit_data i2c_algo;
353 struct i2c_client i2c_client;
354 int i2c_state, i2c_rc;
355 int i2c_done;
356 wait_queue_head_t i2c_queue;
859f0277
HV
357 struct v4l2_subdev *sd_msp34xx;
358 struct v4l2_subdev *sd_tvaudio;
1da177e4
LT
359
360 /* video4linux (1) */
361 struct video_device *video_dev;
362 struct video_device *radio_dev;
363 struct video_device *vbi_dev;
364
365 /* infrared remote */
366 int has_remote;
9160723e 367 struct card_ir *remote;
1da177e4
LT
368
369 /* locking */
370 spinlock_t s_lock;
bd5f0ac9 371 struct mutex lock;
1da177e4 372 int resources;
1da177e4
LT
373#ifdef VIDIOC_G_PRIORITY
374 struct v4l2_prio_state prio;
375#endif
376
377 /* video state */
378 unsigned int input;
379 unsigned int audio;
8bf2f8e7 380 unsigned int mute;
1da177e4 381 unsigned long freq;
4ef2ccc2
TP
382 unsigned int tvnorm;
383 int hue, contrast, bright, saturation;
1da177e4
LT
384 struct v4l2_framebuffer fbuf;
385 unsigned int field_count;
386
387 /* various options */
388 int opt_combfilter;
389 int opt_lumafilter;
390 int opt_automute;
391 int opt_chroma_agc;
392 int opt_adc_crush;
393 int opt_vcr_hack;
394 int opt_whitecrush_upper;
395 int opt_whitecrush_lower;
060d3027
MCC
396 int opt_uv_ratio;
397 int opt_full_luma_range;
398 int opt_coring;
1da177e4
LT
399
400 /* radio data/state */
401 int has_radio;
402 int radio_user;
403
404 /* miro/pinnacle + Aimslab VHX
405 philips matchbox (tea5757 radio tuner) support */
406 int has_matchbox;
407 int mbox_we;
408 int mbox_data;
409 int mbox_clk;
410 int mbox_most;
411 int mbox_mask;
412
413 /* ISA stuff (Terratec Active Radio Upgrade) */
414 int mbox_ior;
415 int mbox_iow;
416 int mbox_csel;
417
418 /* risc memory management data
0418726b 419 - must acquire s_lock before changing these
1da177e4
LT
420 - only the irq handler is supported to touch top + bottom + vcurr */
421 struct btcx_riscmem main;
422 struct bttv_buffer *screen; /* overlay */
423 struct list_head capture; /* video capture queue */
424 struct list_head vcapture; /* vbi capture queue */
425 struct bttv_buffer_set curr; /* active buffers */
426 struct bttv_buffer *cvbi; /* active vbi buffer */
427 int loop_irq;
428 int new_input;
429
430 unsigned long cap_ctl;
431 unsigned long dma_on;
432 struct timer_list timeout;
433 struct bttv_suspend_state state;
434
435 /* stats */
436 unsigned int errors;
437 unsigned int framedrop;
438 unsigned int irq_total;
439 unsigned int irq_me;
440
441 unsigned int users;
442 struct bttv_fh init;
e5bd0260 443
f992a497
JW
444 /* used to make dvb-bt8xx autoloadable */
445 struct work_struct request_module_wk;
446
e5bd0260
MS
447 /* Default (0) and current (1) video capturing and overlay
448 cropping parameters in bttv_tvnorm.cropcap units. Protected
449 by bttv.lock. */
450 struct bttv_crop crop[2];
451
452 /* Earliest possible start of video capturing in
453 bttv_tvnorm.cropcap line units. Set by check_alloc_btres()
454 and free_btres(). Protected by bttv.lock. */
455 __s32 vbi_end;
456
457 /* Latest possible end of VBI capturing (= crop[x].rect.top when
458 VIDEO_RESOURCES are locked). Set by check_alloc_btres()
459 and free_btres(). Protected by bttv.lock. */
460 __s32 crop_start;
1da177e4 461};
2d03e289 462
74fc7bd9
HV
463static inline struct bttv *to_bttv(struct v4l2_device *v4l2_dev)
464{
465 return container_of(v4l2_dev, struct bttv, c.v4l2_dev);
466}
467
2d03e289 468/* our devices */
2499abe7 469#define BTTV_MAX 32
2d03e289 470extern unsigned int bttv_num;
4b10d3b6 471extern struct bttv *bttvs[BTTV_MAX];
1da177e4 472
6f98700a
TP
473static inline unsigned int bttv_muxsel(const struct bttv *btv,
474 unsigned int input)
475{
476 return (bttv_tvcards[btv->c.type].muxsel >> (input * 2)) & 3;
477}
478
1da177e4
LT
479#endif
480
481#define btwrite(dat,adr) writel((dat), btv->bt848_mmio+(adr))
482#define btread(adr) readl(btv->bt848_mmio+(adr))
483
484#define btand(dat,adr) btwrite((dat) & btread(adr), adr)
485#define btor(dat,adr) btwrite((dat) | btread(adr), adr)
486#define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
487
488#endif /* _BTTVP_H_ */
489
490/*
491 * Local variables:
492 * c-basic-offset: 8
493 * End:
494 */