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