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