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