1 /* SPDX-License-Identifier: GPL-2.0-or-later */
4 bttv - Bt848 frame grabber driver
6 bttv's *private* header file -- nobody other than bttv itself
7 should ever include this file.
9 (c) 2000-2002 Gerd Knorr <kraxel@bytesex.org>
16 #include <linux/types.h>
17 #include <linux/wait.h>
18 #include <linux/i2c.h>
19 #include <linux/i2c-algo-bit.h>
20 #include <linux/pci.h>
21 #include <linux/input.h>
22 #include <linux/mutex.h>
23 #include <linux/scatterlist.h>
24 #include <linux/device.h>
26 #include <media/v4l2-common.h>
27 #include <media/v4l2-ctrls.h>
28 #include <media/v4l2-fh.h>
29 #include <media/videobuf-dma-sg.h>
30 #include <media/tveeprom.h>
31 #include <media/rc-core.h>
32 #include <media/i2c/ir-kbd-i2c.h>
33 #include <media/drv-intf/tea575x.h>
37 #include "btcx-risc.h"
41 #define FORMAT_FLAGS_DITHER 0x01
42 #define FORMAT_FLAGS_PACKED 0x02
43 #define FORMAT_FLAGS_PLANAR 0x04
44 #define FORMAT_FLAGS_RAW 0x08
45 #define FORMAT_FLAGS_CrCb 0x10
47 #define RISC_SLOT_O_VBI 4
48 #define RISC_SLOT_O_FIELD 6
49 #define RISC_SLOT_E_VBI 10
50 #define RISC_SLOT_E_FIELD 12
51 #define RISC_SLOT_LOOP 14
53 #define RESOURCE_VIDEO_STREAM 2
54 #define RESOURCE_VBI 4
55 #define RESOURCE_VIDEO_READ 8
62 /* Min. value in VDELAY register. */
64 /* Even to get Cb first, odd for Cr. */
65 #define MAX_HDELAY (0x3FF & -2)
66 /* Limits scaled width, which must be a multiple of 4. */
67 #define MAX_HACTIVE (0x3FF & -4)
70 V4L2_STD_PAL | V4L2_STD_PAL_N | \
71 V4L2_STD_PAL_Nc | V4L2_STD_SECAM | \
72 V4L2_STD_NTSC | V4L2_STD_PAL_M | \
74 /* ---------------------------------------------------------- */
80 u16 swidth, sheight; /* scaled standard width, height */
82 u8 adelay, bdelay, iform;
84 u16 hdelayx1, hactivex1;
89 /* ITU-R frame line number of the first VBI line we can
90 capture, of the first and second field. The last possible line
91 is determined by cropcap.bounds. */
93 /* Horizontally this counts fCLKx1 samples following the leading
94 edge of the horizontal sync pulse, vertically ITU-R frame line
95 numbers of the first field times two (2, 4, 6, ... 524 or 624). */
96 struct v4l2_cropcap cropcap;
98 extern const struct bttv_tvnorm bttv_tvnorms[];
101 int fourcc; /* video4linux 2 */
102 int btformat; /* BT848_COLOR_FMT_* */
103 int btswap; /* BT848_COLOR_CTL_* */
104 int depth; /* bit/pixel */
106 int hshift,vshift; /* for planar modes */
112 struct timer_list timer;
117 /* Usual gpio signalling */
127 bool rc5_gpio; /* Is RC5 legacy GPIO enabled? */
128 u32 last_bit; /* last raw bit seen */
129 u32 code; /* raw code under construction */
130 ktime_t base_time; /* time of last seen code */
131 bool active; /* building raw code */
135 /* ---------------------------------------------------------- */
137 struct bttv_geometry {
139 u16 width,hscale,hdelay;
140 u16 sheight,vscale,vdelay,vtotal;
144 /* common v4l buffer stuff -- must be first */
145 struct videobuf_buffer vb;
148 const struct bttv_format *fmt;
152 struct bttv_geometry geo;
153 struct btcx_riscmem top;
154 struct btcx_riscmem bottom;
155 struct v4l2_rect crop;
156 unsigned int vbi_skip[2];
157 unsigned int vbi_count[2];
160 struct bttv_buffer_set {
161 struct bttv_buffer *top; /* top field buffer */
162 struct bttv_buffer *bottom; /* bottom field buffer */
163 unsigned int top_irq;
164 unsigned int frame_irq;
167 struct bttv_vbi_fmt {
168 struct v4l2_vbi_format fmt;
170 /* fmt.start[] and count[] refer to this video standard. */
171 const struct bttv_tvnorm *tvnorm;
173 /* Earliest possible start of video capturing with this
174 v4l2_vbi_format, in struct bttv_crop.rect units. */
179 void bttv_vbi_fmt_reset(struct bttv_vbi_fmt *f, unsigned int norm);
182 /* A cropping rectangle in struct bttv_tvnorm.cropcap units. */
183 struct v4l2_rect rect;
185 /* Scaled image size limits with this crop rect. Divide
186 max_height, but not min_height, by two when capturing
187 single fields. See also bttv_crop_reset() and
188 bttv_crop_adjust() in bttv-driver.c. */
189 __s32 min_scaled_width;
190 __s32 min_scaled_height;
191 __s32 max_scaled_width;
192 __s32 max_scaled_height;
196 /* This must be the first field in this struct */
201 enum v4l2_buf_type type;
204 struct videobuf_queue cap;
205 const struct bttv_format *fmt;
209 /* Application called VIDIOC_S_SELECTION. */
213 struct videobuf_queue vbi;
214 /* Current VBI capture window as seen through this fh (cannot
215 be global for compatibility with earlier drivers). Protected
216 by struct bttv.lock and struct bttv_fh.vbi.lock. */
217 struct bttv_vbi_fmt vbi_fmt;
220 /* ---------------------------------------------------------- */
223 /* risc code generators - capture */
224 int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
225 struct scatterlist *sglist,
226 unsigned int offset, unsigned int bpl,
227 unsigned int pitch, unsigned int skip_lines,
228 unsigned int store_lines);
230 /* control dma register + risc main loop */
231 void bttv_set_dma(struct bttv *btv, int override);
232 int bttv_risc_init_main(struct bttv *btv);
233 int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
236 /* capture buffer handling */
237 int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
238 int bttv_buffer_activate_video(struct bttv *btv,
239 struct bttv_buffer_set *set);
240 int bttv_buffer_activate_vbi(struct bttv *btv,
241 struct bttv_buffer *vbi);
242 void bttv_dma_free(struct videobuf_queue *q, struct bttv *btv,
243 struct bttv_buffer *buf);
245 /* ---------------------------------------------------------- */
248 int bttv_try_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
249 int bttv_g_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
250 int bttv_s_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
252 extern const struct videobuf_queue_ops bttv_vbi_qops;
254 /* ---------------------------------------------------------- */
257 extern struct bus_type bttv_sub_bus_type;
258 int bttv_sub_add_device(struct bttv_core *core, char *name);
259 int bttv_sub_del_devices(struct bttv_core *core);
261 /* ---------------------------------------------------------- */
264 extern void init_bttv_i2c_ir(struct bttv *btv);
266 /* ---------------------------------------------------------- */
268 extern int init_bttv_i2c(struct bttv *btv);
269 extern int fini_bttv_i2c(struct bttv *btv);
271 /* ---------------------------------------------------------- */
275 extern unsigned int bttv_verbose;
276 extern unsigned int bttv_debug;
277 extern unsigned int bttv_gpio;
278 extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
280 #define dprintk(fmt, ...) \
282 if (bttv_debug >= 1) \
283 pr_debug(fmt, ##__VA_ARGS__); \
285 #define dprintk_cont(fmt, ...) \
287 if (bttv_debug >= 1) \
288 pr_cont(fmt, ##__VA_ARGS__); \
290 #define d2printk(fmt, ...) \
292 if (bttv_debug >= 2) \
293 printk(fmt, ##__VA_ARGS__); \
296 #define BTTV_MAX_FBUF 0x208000
297 #define BTTV_TIMEOUT msecs_to_jiffies(500) /* 0.5 seconds */
298 #define BTTV_FREE_IDLE msecs_to_jiffies(1000) /* one second */
301 struct bttv_pll_info {
302 unsigned int pll_ifreq; /* PLL input frequency */
303 unsigned int pll_ofreq; /* PLL output frequency */
304 unsigned int pll_crystal; /* Crystal used for input */
305 unsigned int pll_current; /* Currently programmed ofreq */
308 /* for gpio-connected remote control */
310 struct input_dev *dev;
317 struct bttv_suspend_state {
322 struct bttv_buffer_set video;
323 struct bttv_buffer *vbi;
326 struct bttv_tea575x_gpio {
327 u8 data, clk, wren, most;
333 /* pci device config */
335 unsigned char revision;
336 unsigned char __iomem *bt848_mmio; /* pointer to mmio */
338 /* card configuration info */
339 unsigned int cardid; /* pci subsystem id (bt878 based ones) */
340 unsigned int tuner_type; /* tuner chip type */
341 unsigned int tda9887_conf;
342 unsigned int svhs, dig;
343 unsigned int has_saa6588:1;
344 struct bttv_pll_info pll;
350 /* old gpio interface */
353 void (*volume_gpio)(struct bttv *btv, __u16 volume);
354 void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
356 /* new gpio interface */
357 spinlock_t gpio_lock;
360 struct i2c_algo_bit_data i2c_algo;
361 struct i2c_client i2c_client;
362 int i2c_state, i2c_rc;
364 wait_queue_head_t i2c_queue;
365 struct v4l2_subdev *sd_msp34xx;
366 struct v4l2_subdev *sd_tvaudio;
367 struct v4l2_subdev *sd_tda7432;
369 /* video4linux (1) */
370 struct video_device video_dev;
371 struct video_device radio_dev;
372 struct video_device vbi_dev;
375 struct v4l2_ctrl_handler ctrl_handler;
376 struct v4l2_ctrl_handler radio_ctrl_handler;
378 /* infrared remote */
380 struct bttv_ir *remote;
382 /* I2C remote data */
383 struct IR_i2c_init_data init_data;
392 unsigned int audio_input;
394 unsigned long tv_freq;
397 int hue, contrast, bright, saturation;
398 struct v4l2_framebuffer fbuf;
399 unsigned int field_count;
401 /* various options */
407 /* radio data/state */
411 int radio_uses_msp_demodulator;
412 unsigned long radio_freq;
414 /* miro/pinnacle + Aimslab VHX
415 philips matchbox (tea5757 radio tuner) support */
417 struct bttv_tea575x_gpio tea_gpio;
418 struct snd_tea575x tea;
420 /* ISA stuff (Terratec Active Radio Upgrade) */
425 /* switch status for multi-controller cards */
428 /* risc memory management data
429 - must acquire s_lock before changing these
430 - only the irq handler is supported to touch top + bottom + vcurr */
431 struct btcx_riscmem main;
432 struct list_head capture; /* video capture queue */
433 struct list_head vcapture; /* vbi capture queue */
434 struct bttv_buffer_set curr; /* active buffers */
435 struct bttv_buffer *cvbi; /* active vbi buffer */
439 unsigned long cap_ctl;
440 unsigned long dma_on;
441 struct timer_list timeout;
442 struct bttv_suspend_state state;
446 unsigned int framedrop;
447 unsigned int irq_total;
453 /* used to make dvb-bt8xx autoloadable */
454 struct work_struct request_module_wk;
456 /* Default (0) and current (1) video capturing
457 cropping parameters in bttv_tvnorm.cropcap units. Protected
459 struct bttv_crop crop[2];
461 /* Earliest possible start of video capturing in
462 bttv_tvnorm.cropcap line units. Set by check_alloc_btres()
463 and free_btres(). Protected by bttv.lock. */
466 /* Latest possible end of VBI capturing (= crop[x].rect.top when
467 VIDEO_RESOURCES are locked). Set by check_alloc_btres()
468 and free_btres(). Protected by bttv.lock. */
472 static inline struct bttv *to_bttv(struct v4l2_device *v4l2_dev)
474 return container_of(v4l2_dev, struct bttv, c.v4l2_dev);
479 extern unsigned int bttv_num;
480 extern struct bttv *bttvs[BTTV_MAX];
482 static inline unsigned int bttv_muxsel(const struct bttv *btv,
485 return (bttv_tvcards[btv->c.type].muxsel >> (input * 2)) & 3;
490 #define btwrite(dat,adr) writel((dat), btv->bt848_mmio+(adr))
491 #define btread(adr) readl(btv->bt848_mmio+(adr))
493 #define btand(dat,adr) btwrite((dat) & btread(adr), adr)
494 #define btor(dat,adr) btwrite((dat) | btread(adr), adr)
495 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
497 #endif /* _BTTVP_H_ */