Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

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