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