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