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