V4L/DVB (8644): Add support for DViCO FusionHDTV DVB-T Dual Express
[linux-2.6] / drivers / media / video / cx23885 / cx23885.h
1 /*
2  *  Driver for the Conexant CX23885 PCIe bridge
3  *
4  *  Copyright (c) 2006 Steven Toth <stoth@linuxtv.org>
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 #include <linux/pci.h>
23 #include <linux/i2c.h>
24 #include <linux/i2c-algo-bit.h>
25 #include <linux/kdev_t.h>
26
27 #include <media/v4l2-common.h>
28 #include <media/tuner.h>
29 #include <media/tveeprom.h>
30 #include <media/videobuf-dma-sg.h>
31 #include <media/videobuf-dvb.h>
32
33 #include "btcx-risc.h"
34 #include "cx23885-reg.h"
35 #include "media/cx2341x.h"
36
37 #include <linux/version.h>
38 #include <linux/mutex.h>
39
40 #define CX23885_VERSION_CODE KERNEL_VERSION(0,0,1)
41
42 #define UNSET (-1U)
43
44 #define CX23885_MAXBOARDS 8
45
46 /* Max number of inputs by card */
47 #define MAX_CX23885_INPUT 8
48 #define INPUT(nr) (&cx23885_boards[dev->board].input[nr])
49 #define RESOURCE_OVERLAY       1
50 #define RESOURCE_VIDEO         2
51 #define RESOURCE_VBI           4
52
53 #define BUFFER_TIMEOUT     (HZ)  /* 0.5 seconds */
54
55 #define CX23885_BOARD_NOAUTO               UNSET
56 #define CX23885_BOARD_UNKNOWN                  0
57 #define CX23885_BOARD_HAUPPAUGE_HVR1800lp      1
58 #define CX23885_BOARD_HAUPPAUGE_HVR1800        2
59 #define CX23885_BOARD_HAUPPAUGE_HVR1250        3
60 #define CX23885_BOARD_DVICO_FUSIONHDTV_5_EXP   4
61 #define CX23885_BOARD_HAUPPAUGE_HVR1500Q       5
62 #define CX23885_BOARD_HAUPPAUGE_HVR1500        6
63 #define CX23885_BOARD_HAUPPAUGE_HVR1200        7
64 #define CX23885_BOARD_HAUPPAUGE_HVR1700        8
65 #define CX23885_BOARD_HAUPPAUGE_HVR1400        9
66 #define CX23885_BOARD_DVICO_FUSIONHDTV_7_DUAL_EXP 10
67 #define CX23885_BOARD_DVICO_FUSIONHDTV_DVB_T_DUAL_EXP 11
68
69 /* Currently unsupported by the driver: PAL/H, NTSC/Kr, SECAM B/G/H/LC */
70 #define CX23885_NORMS (\
71         V4L2_STD_NTSC_M |  V4L2_STD_NTSC_M_JP |  V4L2_STD_NTSC_443 | \
72         V4L2_STD_PAL_BG |  V4L2_STD_PAL_DK    |  V4L2_STD_PAL_I    | \
73         V4L2_STD_PAL_M  |  V4L2_STD_PAL_N     |  V4L2_STD_PAL_Nc   | \
74         V4L2_STD_PAL_60 |  V4L2_STD_SECAM_L   |  V4L2_STD_SECAM_DK)
75
76 struct cx23885_fmt {
77         char  *name;
78         u32   fourcc;          /* v4l2 format id */
79         int   depth;
80         int   flags;
81         u32   cxformat;
82 };
83
84 struct cx23885_ctrl {
85         struct v4l2_queryctrl v;
86         u32                   off;
87         u32                   reg;
88         u32                   mask;
89         u32                   shift;
90 };
91
92 struct cx23885_tvnorm {
93         char            *name;
94         v4l2_std_id     id;
95         u32             cxiformat;
96         u32             cxoformat;
97 };
98
99 struct cx23885_fh {
100         struct cx23885_dev         *dev;
101         enum v4l2_buf_type         type;
102         int                        radio;
103         u32                        resources;
104
105         /* video overlay */
106         struct v4l2_window         win;
107         struct v4l2_clip           *clips;
108         unsigned int               nclips;
109
110         /* video capture */
111         struct cx23885_fmt         *fmt;
112         unsigned int               width, height;
113
114         /* vbi capture */
115         struct videobuf_queue      vidq;
116         struct videobuf_queue      vbiq;
117
118         /* MPEG Encoder specifics ONLY */
119         struct videobuf_queue      mpegq;
120         atomic_t                   v4l_reading;
121 };
122
123 enum cx23885_itype {
124         CX23885_VMUX_COMPOSITE1 = 1,
125         CX23885_VMUX_COMPOSITE2,
126         CX23885_VMUX_COMPOSITE3,
127         CX23885_VMUX_COMPOSITE4,
128         CX23885_VMUX_SVIDEO,
129         CX23885_VMUX_TELEVISION,
130         CX23885_VMUX_CABLE,
131         CX23885_VMUX_DVB,
132         CX23885_VMUX_DEBUG,
133         CX23885_RADIO,
134 };
135
136 enum cx23885_src_sel_type {
137         CX23885_SRC_SEL_EXT_656_VIDEO = 0,
138         CX23885_SRC_SEL_PARALLEL_MPEG_VIDEO
139 };
140
141 /* buffer for one video frame */
142 struct cx23885_buffer {
143         /* common v4l buffer stuff -- must be first */
144         struct videobuf_buffer vb;
145
146         /* cx23885 specific */
147         unsigned int           bpl;
148         struct btcx_riscmem    risc;
149         struct cx23885_fmt     *fmt;
150         u32                    count;
151 };
152
153 struct cx23885_input {
154         enum cx23885_itype type;
155         unsigned int    vmux;
156         u32             gpio0, gpio1, gpio2, gpio3;
157 };
158
159 typedef enum {
160         CX23885_MPEG_UNDEFINED = 0,
161         CX23885_MPEG_DVB,
162         CX23885_ANALOG_VIDEO,
163         CX23885_MPEG_ENCODER,
164 } port_t;
165
166 struct cx23885_board {
167         char                    *name;
168         port_t                  porta, portb, portc;
169         unsigned int            tuner_type;
170         unsigned int            radio_type;
171         unsigned char           tuner_addr;
172         unsigned char           radio_addr;
173
174         /* Vendors can and do run the PCIe bridge at different
175          * clock rates, driven physically by crystals on the PCBs.
176          * The core has to accomodate this. This allows the user
177          * to add new boards with new frequencys. The value is
178          * expressed in Hz.
179          *
180          * The core framework will default this value based on
181          * current designs, but it can vary.
182          */
183         u32                     clk_freq;
184         struct cx23885_input    input[MAX_CX23885_INPUT];
185 };
186
187 struct cx23885_subid {
188         u16     subvendor;
189         u16     subdevice;
190         u32     card;
191 };
192
193 struct cx23885_i2c {
194         struct cx23885_dev *dev;
195
196         int                        nr;
197
198         /* i2c i/o */
199         struct i2c_adapter         i2c_adap;
200         struct i2c_algo_bit_data   i2c_algo;
201         struct i2c_client          i2c_client;
202         u32                        i2c_rc;
203
204         /* 885 registers used for raw addess */
205         u32                        i2c_period;
206         u32                        reg_ctrl;
207         u32                        reg_stat;
208         u32                        reg_addr;
209         u32                        reg_rdata;
210         u32                        reg_wdata;
211 };
212
213 struct cx23885_dmaqueue {
214         struct list_head       active;
215         struct list_head       queued;
216         struct timer_list      timeout;
217         struct btcx_riscmem    stopper;
218         u32                    count;
219 };
220
221 struct cx23885_tsport {
222         struct cx23885_dev *dev;
223
224         int                        nr;
225         int                        sram_chno;
226
227         struct videobuf_dvb        dvb;
228
229         /* dma queues */
230         struct cx23885_dmaqueue    mpegq;
231         u32                        ts_packet_size;
232         u32                        ts_packet_count;
233
234         int                        width;
235         int                        height;
236
237         spinlock_t                 slock;
238
239         /* registers */
240         u32                        reg_gpcnt;
241         u32                        reg_gpcnt_ctl;
242         u32                        reg_dma_ctl;
243         u32                        reg_lngth;
244         u32                        reg_hw_sop_ctrl;
245         u32                        reg_gen_ctrl;
246         u32                        reg_bd_pkt_status;
247         u32                        reg_sop_status;
248         u32                        reg_fifo_ovfl_stat;
249         u32                        reg_vld_misc;
250         u32                        reg_ts_clk_en;
251         u32                        reg_ts_int_msk;
252         u32                        reg_ts_int_stat;
253         u32                        reg_src_sel;
254
255         /* Default register vals */
256         int                        pci_irqmask;
257         u32                        dma_ctl_val;
258         u32                        ts_int_msk_val;
259         u32                        gen_ctrl_val;
260         u32                        ts_clk_en_val;
261         u32                        src_sel_val;
262         u32                        vld_misc_val;
263         u32                        hw_sop_ctrl_val;
264 };
265
266 struct cx23885_dev {
267         struct list_head           devlist;
268         atomic_t                   refcount;
269
270         /* pci stuff */
271         struct pci_dev             *pci;
272         unsigned char              pci_rev, pci_lat;
273         int                        pci_bus, pci_slot;
274         u32                        __iomem *lmmio;
275         u8                         __iomem *bmmio;
276         int                        pci_irqmask;
277         int                        hwrevision;
278
279         /* This valud is board specific and is used to configure the
280          * AV core so we see nice clean and stable video and audio. */
281         u32                        clk_freq;
282
283         /* I2C adapters: Master 1 & 2 (External) & Master 3 (Internal only) */
284         struct cx23885_i2c         i2c_bus[3];
285
286         int                        nr;
287         struct mutex               lock;
288
289         /* board details */
290         unsigned int               board;
291         char                       name[32];
292
293         struct cx23885_tsport      ts1, ts2;
294
295         /* sram configuration */
296         struct sram_channel        *sram_channels;
297
298         enum {
299                 CX23885_BRIDGE_UNDEFINED = 0,
300                 CX23885_BRIDGE_885 = 885,
301                 CX23885_BRIDGE_887 = 887,
302         } bridge;
303
304         /* Analog video */
305         u32                        resources;
306         unsigned int               input;
307         u32                        tvaudio;
308         v4l2_std_id                tvnorm;
309         unsigned int               tuner_type;
310         unsigned char              tuner_addr;
311         unsigned int               radio_type;
312         unsigned char              radio_addr;
313         unsigned int               has_radio;
314
315         /* V4l */
316         u32                        freq;
317         struct video_device        *video_dev;
318         struct video_device        *vbi_dev;
319         struct video_device        *radio_dev;
320
321         struct cx23885_dmaqueue    vidq;
322         struct cx23885_dmaqueue    vbiq;
323         spinlock_t                 slock;
324
325         /* MPEG Encoder ONLY settings */
326         u32                        cx23417_mailbox;
327         struct cx2341x_mpeg_params mpeg_params;
328         struct video_device        *v4l_device;
329         atomic_t                   v4l_reader_count;
330         struct cx23885_tvnorm      encodernorm;
331
332 };
333
334 extern struct list_head cx23885_devlist;
335
336 #define SRAM_CH01  0 /* Video A */
337 #define SRAM_CH02  1 /* VBI A */
338 #define SRAM_CH03  2 /* Video B */
339 #define SRAM_CH04  3 /* Transport via B */
340 #define SRAM_CH05  4 /* VBI B */
341 #define SRAM_CH06  5 /* Video C */
342 #define SRAM_CH07  6 /* Transport via C */
343 #define SRAM_CH08  7 /* Audio Internal A */
344 #define SRAM_CH09  8 /* Audio Internal B */
345 #define SRAM_CH10  9 /* Audio External */
346 #define SRAM_CH11 10 /* COMB_3D_N */
347 #define SRAM_CH12 11 /* Comb 3D N1 */
348 #define SRAM_CH13 12 /* Comb 3D N2 */
349 #define SRAM_CH14 13 /* MOE Vid */
350 #define SRAM_CH15 14 /* MOE RSLT */
351
352 struct sram_channel {
353         char *name;
354         u32  cmds_start;
355         u32  ctrl_start;
356         u32  cdt;
357         u32  fifo_start;;
358         u32  fifo_size;
359         u32  ptr1_reg;
360         u32  ptr2_reg;
361         u32  cnt1_reg;
362         u32  cnt2_reg;
363         u32  jumponly;
364 };
365
366 /* ----------------------------------------------------------- */
367
368 #define cx_read(reg)             readl(dev->lmmio + ((reg)>>2))
369 #define cx_write(reg,value)      writel((value), dev->lmmio + ((reg)>>2))
370
371 #define cx_andor(reg,mask,value) \
372   writel((readl(dev->lmmio+((reg)>>2)) & ~(mask)) |\
373   ((value) & (mask)), dev->lmmio+((reg)>>2))
374
375 #define cx_set(reg,bit)          cx_andor((reg),(bit),(bit))
376 #define cx_clear(reg,bit)        cx_andor((reg),(bit),0)
377
378 /* ----------------------------------------------------------- */
379 /* cx23885-core.c                                              */
380
381 extern int cx23885_sram_channel_setup(struct cx23885_dev *dev,
382         struct sram_channel *ch,
383         unsigned int bpl, u32 risc);
384
385 extern void cx23885_sram_channel_dump(struct cx23885_dev *dev,
386         struct sram_channel *ch);
387
388 extern int cx23885_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
389         u32 reg, u32 mask, u32 value);
390
391 extern int cx23885_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
392         struct scatterlist *sglist,
393         unsigned int top_offset, unsigned int bottom_offset,
394         unsigned int bpl, unsigned int padding, unsigned int lines);
395
396 void cx23885_cancel_buffers(struct cx23885_tsport *port);
397
398 extern int cx23885_restart_queue(struct cx23885_tsport *port,
399                                 struct cx23885_dmaqueue *q);
400
401 extern void cx23885_wakeup(struct cx23885_tsport *port,
402                            struct cx23885_dmaqueue *q, u32 count);
403
404
405 /* ----------------------------------------------------------- */
406 /* cx23885-cards.c                                             */
407 extern struct cx23885_board cx23885_boards[];
408 extern const unsigned int cx23885_bcount;
409
410 extern struct cx23885_subid cx23885_subids[];
411 extern const unsigned int cx23885_idcount;
412
413 extern int cx23885_xc5000_tuner_callback(void *priv, int command, int arg);
414 extern int cx23885_xc3028_tuner_callback(void *priv, int command, int arg);
415 extern void cx23885_card_list(struct cx23885_dev *dev);
416 extern int  cx23885_ir_init(struct cx23885_dev *dev);
417 extern void cx23885_gpio_setup(struct cx23885_dev *dev);
418 extern void cx23885_card_setup(struct cx23885_dev *dev);
419 extern void cx23885_card_setup_pre_i2c(struct cx23885_dev *dev);
420
421 extern int cx23885_dvb_register(struct cx23885_tsport *port);
422 extern int cx23885_dvb_unregister(struct cx23885_tsport *port);
423
424 extern int cx23885_buf_prepare(struct videobuf_queue *q,
425                                struct cx23885_tsport *port,
426                                struct cx23885_buffer *buf,
427                                enum v4l2_field field);
428 extern void cx23885_buf_queue(struct cx23885_tsport *port,
429                               struct cx23885_buffer *buf);
430 extern void cx23885_free_buffer(struct videobuf_queue *q,
431                                 struct cx23885_buffer *buf);
432
433 /* ----------------------------------------------------------- */
434 /* cx23885-video.c                                             */
435 /* Video */
436 extern int cx23885_video_register(struct cx23885_dev *dev);
437 extern void cx23885_video_unregister(struct cx23885_dev *dev);
438 extern int cx23885_video_irq(struct cx23885_dev *dev, u32 status);
439
440 /* ----------------------------------------------------------- */
441 /* cx23885-vbi.c                                               */
442 extern int cx23885_vbi_fmt(struct file *file, void *priv,
443         struct v4l2_format *f);
444 extern void cx23885_vbi_timeout(unsigned long data);
445 extern struct videobuf_queue_ops cx23885_vbi_qops;
446
447 /* cx23885-i2c.c                                                */
448 extern int cx23885_i2c_register(struct cx23885_i2c *bus);
449 extern int cx23885_i2c_unregister(struct cx23885_i2c *bus);
450 extern void cx23885_call_i2c_clients(struct cx23885_i2c *bus, unsigned int cmd,
451                                      void *arg);
452 extern void cx23885_av_clk(struct cx23885_dev *dev, int enable);
453
454 /* ----------------------------------------------------------- */
455 /* cx23885-417.c                                               */
456 extern int cx23885_417_register(struct cx23885_dev *dev);
457 extern void cx23885_417_unregister(struct cx23885_dev *dev);
458 extern int cx23885_irq_417(struct cx23885_dev *dev, u32 status);
459 extern void cx23885_417_check_encoder(struct cx23885_dev *dev);
460 extern void cx23885_mc417_init(struct cx23885_dev *dev);
461 extern int mc417_memory_read(struct cx23885_dev *dev, u32 address, u32 *value);
462 extern int mc417_memory_write(struct cx23885_dev *dev, u32 address, u32 value);
463
464
465 /* ----------------------------------------------------------- */
466 /* tv norms                                                    */
467
468 static inline unsigned int norm_maxw(v4l2_std_id norm)
469 {
470         return (norm & (V4L2_STD_MN & ~V4L2_STD_PAL_Nc)) ? 720 : 768;
471 }
472
473 static inline unsigned int norm_maxh(v4l2_std_id norm)
474 {
475         return (norm & V4L2_STD_625_50) ? 576 : 480;
476 }
477
478 static inline unsigned int norm_swidth(v4l2_std_id norm)
479 {
480         return (norm & (V4L2_STD_MN & ~V4L2_STD_PAL_Nc)) ? 754 : 922;
481 }
482
483
484 /*
485  * Local variables:
486  * c-basic-offset: 8
487  * End:
488  * kate: eol "unix"; indent-width 3; remove-trailing-space on; replace-trailing-space-save on; tab-width 8; replace-tabs off; space-indent off; mixed-indent off
489  */