V4L/DVB (6163): cx23885: remove old comments
[powerpc.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/video-buf.h>
31 #if defined(CONFIG_VIDEO_BUF_DVB) || defined(CONFIG_VIDEO_BUF_DVB_MODULE)
32 #include <media/video-buf-dvb.h>
33 #endif
34
35 #include "btcx-risc.h"
36 #include "cx23885-reg.h"
37
38 #include <linux/version.h>
39 #include <linux/mutex.h>
40
41 #define CX23885_VERSION_CODE KERNEL_VERSION(0,0,1)
42
43 #define UNSET (-1U)
44
45 #define CX23885_MAXBOARDS 8
46
47 /* Max number of inputs by card */
48 #define MAX_CX23885_INPUT 8
49
50 #define BUFFER_TIMEOUT     (HZ)  /* 0.5 seconds */
51
52 #define CX23885_BOARD_NOAUTO               UNSET
53 #define CX23885_BOARD_UNKNOWN                  0
54 #define CX23885_BOARD_HAUPPAUGE_HVR1800lp      1
55 #define CX23885_BOARD_HAUPPAUGE_HVR1800        2
56
57 enum cx23885_itype {
58         CX23885_VMUX_COMPOSITE1 = 1,
59         CX23885_VMUX_COMPOSITE2,
60         CX23885_VMUX_COMPOSITE3,
61         CX23885_VMUX_COMPOSITE4,
62         CX23885_VMUX_SVIDEO,
63         CX23885_VMUX_TELEVISION,
64         CX23885_VMUX_CABLE,
65         CX23885_VMUX_DVB,
66         CX23885_VMUX_DEBUG,
67         CX23885_RADIO,
68 };
69
70 /* buffer for one video frame */
71 struct cx23885_buffer {
72         /* common v4l buffer stuff -- must be first */
73         struct videobuf_buffer vb;
74
75         /* cx23885 specific */
76         unsigned int           bpl;
77         struct btcx_riscmem    risc;
78         struct cx23885_fmt     *fmt;
79         u32                    count;
80 };
81
82 struct cx23885_input {
83         enum cx23885_itype type;
84         unsigned int    vmux;
85         u32             gpio0, gpio1, gpio2, gpio3;
86 };
87
88 struct cx23885_board {
89         char                    *name;
90         enum {
91                 CX23885_MPEG_UNDEFINED = 0,
92                 CX23885_MPEG_DVB
93         } portc;
94         struct cx23885_input    input[MAX_CX23885_INPUT];
95 };
96
97 struct cx23885_subid {
98         u16     subvendor;
99         u16     subdevice;
100         u32     card;
101 };
102
103 struct cx23885_i2c {
104         struct cx23885_dev *dev;
105
106         int                        nr;
107
108         /* i2c i/o */
109         struct i2c_adapter         i2c_adap;
110         struct i2c_algo_bit_data   i2c_algo;
111         struct i2c_client          i2c_client;
112         u32                        i2c_rc;
113
114         /* 885 registers used for raw addess */
115         u32                        i2c_period;
116         u32                        reg_ctrl;
117         u32                        reg_stat;
118         u32                        reg_addr;
119         u32                        reg_rdata;
120         u32                        reg_wdata;
121 };
122
123 struct cx23885_dmaqueue {
124         struct list_head       active;
125         struct list_head       queued;
126         struct timer_list      timeout;
127         struct btcx_riscmem    stopper;
128         u32                    count;
129 };
130
131 struct cx23885_tsport {
132         struct cx23885_dev *dev;
133
134         int                        nr;
135         int                        sram_chno;
136
137         struct videobuf_dvb        dvb;
138
139         /* dma queues */
140         struct cx23885_dmaqueue    mpegq;
141         u32                        ts_packet_size;
142         u32                        ts_packet_count;
143
144         int                        width;
145         int                        height;
146
147         spinlock_t                 slock;
148
149         /* registers */
150         u32                        reg_gpcnt;
151         u32                        reg_gpcnt_ctl;
152         u32                        reg_dma_ctl;
153         u32                        reg_lngth;
154         u32                        reg_hw_sop_ctrl;
155         u32                        reg_gen_ctrl;
156         u32                        reg_bd_pkt_status;
157         u32                        reg_sop_status;
158         u32                        reg_fifo_ovfl_stat;
159         u32                        reg_vld_misc;
160         u32                        reg_ts_clk_en;
161         u32                        reg_ts_int_msk;
162
163         /* Default register vals */
164         int                        pci_irqmask;
165         u32                        dma_ctl_val;
166         u32                        ts_int_msk_val;
167         u32                        gen_ctrl_val;
168         u32                        ts_clk_en_val;
169 };
170
171 struct cx23885_dev {
172         struct list_head           devlist;
173         atomic_t                   refcount;
174
175         /* pci stuff */
176         struct pci_dev             *pci;
177         unsigned char              pci_rev, pci_lat;
178         int                        pci_bus, pci_slot;
179         u32                        __iomem *lmmio;
180         u8                         __iomem *bmmio;
181         int                        pci_irqmask;
182
183         /* I2C adapters: Master 1 & 2 (External) & Master 3 (Internal only) */
184         struct cx23885_i2c         i2c_bus[3];
185
186         int                        nr;
187         struct mutex               lock;
188
189         /* board details */
190         unsigned int               board;
191         char                       name[32];
192
193         struct cx23885_tsport      ts2;
194
195         /* sram configuration */
196         struct sram_channel        *sram_channels;
197
198         enum {
199                 CX23885_BRIDGE_UNDEFINED = 0,
200                 CX23885_BRIDGE_885 = 885,
201                 CX23885_BRIDGE_887 = 887,
202         } bridge;
203 };
204
205 #define SRAM_CH01  0 /* Video A */
206 #define SRAM_CH02  1 /* VBI A */
207 #define SRAM_CH03  2 /* Video B */
208 #define SRAM_CH04  3 /* Transport via B */
209 #define SRAM_CH05  4 /* VBI B */
210 #define SRAM_CH06  5 /* Video C */
211 #define SRAM_CH07  6 /* Transport via C */
212 #define SRAM_CH08  7 /* Audio Internal A */
213 #define SRAM_CH09  8 /* Audio Internal B */
214 #define SRAM_CH10  9 /* Audio External */
215 #define SRAM_CH11 10 /* COMB_3D_N */
216 #define SRAM_CH12 11 /* Comb 3D N1 */
217 #define SRAM_CH13 12 /* Comb 3D N2 */
218 #define SRAM_CH14 13 /* MOE Vid */
219 #define SRAM_CH15 14 /* MOE RSLT */
220
221 struct sram_channel {
222         char *name;
223         u32  cmds_start;
224         u32  ctrl_start;
225         u32  cdt;
226         u32  fifo_start;;
227         u32  fifo_size;
228         u32  ptr1_reg;
229         u32  ptr2_reg;
230         u32  cnt1_reg;
231         u32  cnt2_reg;
232         u32  jumponly;
233 };
234
235 /* ----------------------------------------------------------- */
236
237 #define cx_read(reg)             readl(dev->lmmio + ((reg)>>2))
238 #define cx_write(reg,value)      writel((value), dev->lmmio + ((reg)>>2))
239
240 #define cx_andor(reg,mask,value) \
241   writel((readl(dev->lmmio+((reg)>>2)) & ~(mask)) |\
242   ((value) & (mask)), dev->lmmio+((reg)>>2))
243
244 #define cx_set(reg,bit)          cx_andor((reg),(bit),(bit))
245 #define cx_clear(reg,bit)        cx_andor((reg),(bit),0)
246
247
248 extern int cx23885_sram_channel_setup(struct cx23885_dev *dev,
249         struct sram_channel *ch,
250         unsigned int bpl, u32 risc);
251
252 /* ----------------------------------------------------------- */
253 /* cx23885-cards.c                                                */
254
255 extern struct cx23885_board cx23885_boards[];
256 extern const unsigned int cx23885_bcount;
257
258 extern struct cx23885_subid cx23885_subids[];
259 extern const unsigned int cx23885_idcount;
260
261 extern void cx23885_card_list(struct cx23885_dev *dev);
262 extern void cx23885_card_setup(struct cx23885_dev *dev);
263 extern void cx23885_card_setup_pre_i2c(struct cx23885_dev *dev);
264
265 extern int cx23885_dvb_register(struct cx23885_tsport *port);
266 extern int cx23885_dvb_unregister(struct cx23885_tsport *port);
267
268 extern int cx23885_buf_prepare(struct videobuf_queue *q,
269                                struct cx23885_tsport *port,
270                                struct cx23885_buffer *buf,
271                                enum v4l2_field field);
272
273 extern void cx23885_buf_queue(struct cx23885_tsport *port,
274                               struct cx23885_buffer *buf);
275 extern void cx23885_free_buffer(struct videobuf_queue *q,
276                                 struct cx23885_buffer *buf);
277
278 /* ----------------------------------------------------------- */
279 /* cx23885-i2c.c                                                */
280 extern int cx23885_i2c_register(struct cx23885_i2c *bus);
281 extern int cx23885_i2c_unregister(struct cx23885_i2c *bus);
282 extern void cx23885_call_i2c_clients(struct cx23885_i2c *bus, unsigned int cmd,
283                                      void *arg);
284
285 /*
286  * Local variables:
287  * c-basic-offset: 8
288  * End:
289  * 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
290  */