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