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