1 /*
2    cx231xx.h - driver for Conexant Cx23100/101/102 USB video capture devices
3 
4    Copyright (C) 2008 <srinivasa.deevi at conexant dot com>
5 	Based on em28xx driver
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
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 #ifndef _CX231XX_H
23 #define _CX231XX_H
24 
25 #include <linux/videodev2.h>
26 #include <linux/types.h>
27 #include <linux/ioctl.h>
28 #include <linux/i2c.h>
29 #include <linux/workqueue.h>
30 #include <linux/mutex.h>
31 
32 #include <media/cx2341x.h>
33 
34 #include <media/videobuf-vmalloc.h>
35 #include <media/v4l2-device.h>
36 #include <media/v4l2-ctrls.h>
37 #include <media/v4l2-fh.h>
38 #include <media/rc-core.h>
39 #include <media/ir-kbd-i2c.h>
40 #include <media/videobuf-dvb.h>
41 
42 #include "cx231xx-reg.h"
43 #include "cx231xx-pcb-cfg.h"
44 #include "cx231xx-conf-reg.h"
45 
46 #define DRIVER_NAME                     "cx231xx"
47 #define PWR_SLEEP_INTERVAL              10
48 
49 /* I2C addresses for control block in Cx231xx */
50 #define     AFE_DEVICE_ADDRESS		0x60
51 #define     I2S_BLK_DEVICE_ADDRESS	0x98
52 #define     VID_BLK_I2C_ADDRESS		0x88
53 #define     VERVE_I2C_ADDRESS           0x40
54 #define     DIF_USE_BASEBAND            0xFFFFFFFF
55 
56 /* Boards supported by driver */
57 #define CX231XX_BOARD_UNKNOWN		    0
58 #define CX231XX_BOARD_CNXT_CARRAERA	1
59 #define CX231XX_BOARD_CNXT_SHELBY	2
60 #define CX231XX_BOARD_CNXT_RDE_253S	3
61 #define CX231XX_BOARD_CNXT_RDU_253S	4
62 #define CX231XX_BOARD_CNXT_VIDEO_GRABBER	5
63 #define CX231XX_BOARD_CNXT_RDE_250	6
64 #define CX231XX_BOARD_CNXT_RDU_250	7
65 #define CX231XX_BOARD_HAUPPAUGE_EXETER  8
66 #define CX231XX_BOARD_HAUPPAUGE_USBLIVE2 9
67 #define CX231XX_BOARD_PV_PLAYTV_USB_HYBRID 10
68 #define CX231XX_BOARD_PV_XCAPTURE_USB 11
69 #define CX231XX_BOARD_KWORLD_UB430_USB_HYBRID 12
70 #define CX231XX_BOARD_ICONBIT_U100 13
71 #define CX231XX_BOARD_HAUPPAUGE_USB2_FM_PAL 14
72 #define CX231XX_BOARD_HAUPPAUGE_USB2_FM_NTSC 15
73 #define CX231XX_BOARD_ELGATO_VIDEO_CAPTURE_V2 16
74 #define CX231XX_BOARD_OTG102 17
75 
76 /* Limits minimum and default number of buffers */
77 #define CX231XX_MIN_BUF                 4
78 #define CX231XX_DEF_BUF                 12
79 #define CX231XX_DEF_VBI_BUF             6
80 
81 #define VBI_LINE_COUNT                  17
82 #define VBI_LINE_LENGTH                 1440
83 
84 /*Limits the max URB message size */
85 #define URB_MAX_CTRL_SIZE               80
86 
87 /* Params for validated field */
88 #define CX231XX_BOARD_NOT_VALIDATED     1
89 #define CX231XX_BOARD_VALIDATED		0
90 
91 /* maximum number of cx231xx boards */
92 #define CX231XX_MAXBOARDS               8
93 
94 /* maximum number of frames that can be queued */
95 #define CX231XX_NUM_FRAMES              5
96 
97 /* number of buffers for isoc transfers */
98 #define CX231XX_NUM_BUFS                8
99 
100 /* number of packets for each buffer
101    windows requests only 40 packets .. so we better do the same
102    this is what I found out for all alternate numbers there!
103  */
104 #define CX231XX_NUM_PACKETS             40
105 
106 /* default alternate; 0 means choose the best */
107 #define CX231XX_PINOUT                  0
108 
109 #define CX231XX_INTERLACED_DEFAULT      1
110 
111 /* time to wait when stopping the isoc transfer */
112 #define CX231XX_URB_TIMEOUT		\
113 		msecs_to_jiffies(CX231XX_NUM_BUFS * CX231XX_NUM_PACKETS)
114 
115 #define CX231xx_NORMS (\
116 	V4L2_STD_NTSC_M |  V4L2_STD_NTSC_M_JP |  V4L2_STD_NTSC_443 | \
117 	V4L2_STD_PAL_BG |  V4L2_STD_PAL_DK    |  V4L2_STD_PAL_I    | \
118 	V4L2_STD_PAL_M  |  V4L2_STD_PAL_N     |  V4L2_STD_PAL_Nc   | \
119 	V4L2_STD_PAL_60 |  V4L2_STD_SECAM_L   |  V4L2_STD_SECAM_DK)
120 
121 #define SLEEP_S5H1432    30
122 #define CX23417_OSC_EN   8
123 #define CX23417_RESET    9
124 
125 struct cx23417_fmt {
126 	char  *name;
127 	u32   fourcc;          /* v4l2 format id */
128 	int   depth;
129 	int   flags;
130 	u32   cxformat;
131 };
132 enum cx231xx_mode {
133 	CX231XX_SUSPEND,
134 	CX231XX_ANALOG_MODE,
135 	CX231XX_DIGITAL_MODE,
136 };
137 
138 enum cx231xx_std_mode {
139 	CX231XX_TV_AIR = 0,
140 	CX231XX_TV_CABLE
141 };
142 
143 enum cx231xx_stream_state {
144 	STREAM_OFF,
145 	STREAM_INTERRUPT,
146 	STREAM_ON,
147 };
148 
149 struct cx231xx;
150 
151 struct cx231xx_isoc_ctl {
152 	/* max packet size of isoc transaction */
153 	int max_pkt_size;
154 
155 	/* number of allocated urbs */
156 	int num_bufs;
157 
158 	/* urb for isoc transfers */
159 	struct urb **urb;
160 
161 	/* transfer buffers for isoc transfer */
162 	char **transfer_buffer;
163 
164 	/* Last buffer command and region */
165 	u8 cmd;
166 	int pos, size, pktsize;
167 
168 	/* Last field: ODD or EVEN? */
169 	int field;
170 
171 	/* Stores incomplete commands */
172 	u32 tmp_buf;
173 	int tmp_buf_len;
174 
175 	/* Stores already requested buffers */
176 	struct cx231xx_buffer *buf;
177 
178 	/* Stores the number of received fields */
179 	int nfields;
180 
181 	/* isoc urb callback */
182 	int (*isoc_copy) (struct cx231xx *dev, struct urb *urb);
183 };
184 
185 struct cx231xx_bulk_ctl {
186 	/* max packet size of bulk transaction */
187 	int max_pkt_size;
188 
189 	/* number of allocated urbs */
190 	int num_bufs;
191 
192 	/* urb for bulk transfers */
193 	struct urb **urb;
194 
195 	/* transfer buffers for bulk transfer */
196 	char **transfer_buffer;
197 
198 	/* Last buffer command and region */
199 	u8 cmd;
200 	int pos, size, pktsize;
201 
202 	/* Last field: ODD or EVEN? */
203 	int field;
204 
205 	/* Stores incomplete commands */
206 	u32 tmp_buf;
207 	int tmp_buf_len;
208 
209 	/* Stores already requested buffers */
210 	struct cx231xx_buffer *buf;
211 
212 	/* Stores the number of received fields */
213 	int nfields;
214 
215 	/* bulk urb callback */
216 	int (*bulk_copy) (struct cx231xx *dev, struct urb *urb);
217 };
218 
219 struct cx231xx_fmt {
220 	char *name;
221 	u32 fourcc;		/* v4l2 format id */
222 	int depth;
223 	int reg;
224 };
225 
226 /* buffer for one video frame */
227 struct cx231xx_buffer {
228 	/* common v4l buffer stuff -- must be first */
229 	struct videobuf_buffer vb;
230 
231 	struct list_head frame;
232 	int top_field;
233 	int receiving;
234 };
235 
236 enum ps_package_head {
237 	CX231XX_NEED_ADD_PS_PACKAGE_HEAD = 0,
238 	CX231XX_NONEED_PS_PACKAGE_HEAD
239 };
240 
241 struct cx231xx_dmaqueue {
242 	struct list_head active;
243 	struct list_head queued;
244 
245 	wait_queue_head_t wq;
246 
247 	/* Counters to control buffer fill */
248 	int pos;
249 	u8 is_partial_line;
250 	u8 partial_buf[8];
251 	u8 last_sav;
252 	int current_field;
253 	u32 bytes_left_in_line;
254 	u32 lines_completed;
255 	u8 field1_done;
256 	u32 lines_per_field;
257 
258 	/*Mpeg2 control buffer*/
259 	u8 *p_left_data;
260 	u32 left_data_count;
261 	u8 mpeg_buffer_done;
262 	u32 mpeg_buffer_completed;
263 	enum ps_package_head add_ps_package_head;
264 	char ps_head[10];
265 };
266 
267 /* inputs */
268 
269 #define MAX_CX231XX_INPUT               4
270 
271 enum cx231xx_itype {
272 	CX231XX_VMUX_COMPOSITE1 = 1,
273 	CX231XX_VMUX_SVIDEO,
274 	CX231XX_VMUX_TELEVISION,
275 	CX231XX_VMUX_CABLE,
276 	CX231XX_RADIO,
277 	CX231XX_VMUX_DVB,
278 	CX231XX_VMUX_DEBUG
279 };
280 
281 enum cx231xx_v_input {
282 	CX231XX_VIN_1_1 = 0x1,
283 	CX231XX_VIN_2_1,
284 	CX231XX_VIN_3_1,
285 	CX231XX_VIN_4_1,
286 	CX231XX_VIN_1_2 = 0x01,
287 	CX231XX_VIN_2_2,
288 	CX231XX_VIN_3_2,
289 	CX231XX_VIN_1_3 = 0x1,
290 	CX231XX_VIN_2_3,
291 	CX231XX_VIN_3_3,
292 };
293 
294 /* cx231xx has two audio inputs: tuner and line in */
295 enum cx231xx_amux {
296 	/* This is the only entry for cx231xx tuner input */
297 	CX231XX_AMUX_VIDEO,	/* cx231xx tuner */
298 	CX231XX_AMUX_LINE_IN,	/* Line In */
299 };
300 
301 struct cx231xx_reg_seq {
302 	unsigned char bit;
303 	unsigned char val;
304 	int sleep;
305 };
306 
307 struct cx231xx_input {
308 	enum cx231xx_itype type;
309 	unsigned int vmux;
310 	enum cx231xx_amux amux;
311 	struct cx231xx_reg_seq *gpio;
312 };
313 
314 #define INPUT(nr) (&cx231xx_boards[dev->model].input[nr])
315 
316 enum cx231xx_decoder {
317 	CX231XX_NODECODER,
318 	CX231XX_AVDECODER
319 };
320 
321 enum CX231XX_I2C_MASTER_PORT {
322 	I2C_0 = 0,
323 	I2C_1 = 1,
324 	I2C_2 = 2,
325 	I2C_3 = 3
326 };
327 
328 struct cx231xx_board {
329 	char *name;
330 	int vchannels;
331 	int tuner_type;
332 	int tuner_addr;
333 	v4l2_std_id norm;	/* tv norm */
334 
335 	/* demod related */
336 	int demod_addr;
337 	u8 demod_xfer_mode;	/* 0 - Serial; 1 - parallel */
338 
339 	/* GPIO Pins */
340 	struct cx231xx_reg_seq *dvb_gpio;
341 	struct cx231xx_reg_seq *suspend_gpio;
342 	struct cx231xx_reg_seq *tuner_gpio;
343 		/* Negative means don't use it */
344 	s8 tuner_sif_gpio;
345 	s8 tuner_scl_gpio;
346 	s8 tuner_sda_gpio;
347 
348 	/* PIN ctrl */
349 	u32 ctl_pin_status_mask;
350 	u8 agc_analog_digital_select_gpio;
351 	u32 gpio_pin_status_mask;
352 
353 	/* i2c masters */
354 	u8 tuner_i2c_master;
355 	u8 demod_i2c_master;
356 	u8 ir_i2c_master;
357 
358 	/* for devices with I2C chips for IR */
359 	char *rc_map_name;
360 
361 	unsigned int max_range_640_480:1;
362 	unsigned int has_dvb:1;
363 	unsigned int has_417:1;
364 	unsigned int valid:1;
365 	unsigned int no_alt_vanc:1;
366 	unsigned int external_av:1;
367 	unsigned int dont_use_port_3:1;
368 
369 	unsigned char xclk, i2c_speed;
370 
371 	enum cx231xx_decoder decoder;
372 	int output_mode;
373 
374 	struct cx231xx_input input[MAX_CX231XX_INPUT];
375 	struct cx231xx_input radio;
376 	struct rc_map *ir_codes;
377 };
378 
379 /* device states */
380 enum cx231xx_dev_state {
381 	DEV_INITIALIZED = 0x01,
382 	DEV_DISCONNECTED = 0x02,
383 };
384 
385 enum AFE_MODE {
386 	AFE_MODE_LOW_IF,
387 	AFE_MODE_BASEBAND,
388 	AFE_MODE_EU_HI_IF,
389 	AFE_MODE_US_HI_IF,
390 	AFE_MODE_JAPAN_HI_IF
391 };
392 
393 enum AUDIO_INPUT {
394 	AUDIO_INPUT_MUTE,
395 	AUDIO_INPUT_LINE,
396 	AUDIO_INPUT_TUNER_TV,
397 	AUDIO_INPUT_SPDIF,
398 	AUDIO_INPUT_TUNER_FM
399 };
400 
401 #define CX231XX_AUDIO_BUFS              5
402 #define CX231XX_NUM_AUDIO_PACKETS       16
403 #define CX231XX_ISO_NUM_AUDIO_PACKETS	64
404 
405 /* cx231xx extensions */
406 #define CX231XX_AUDIO                   0x10
407 #define CX231XX_DVB                     0x20
408 
409 struct cx231xx_audio {
410 	char name[50];
411 	char *transfer_buffer[CX231XX_AUDIO_BUFS];
412 	struct urb *urb[CX231XX_AUDIO_BUFS];
413 	struct usb_device *udev;
414 	unsigned int capture_transfer_done;
415 	struct snd_pcm_substream *capture_pcm_substream;
416 
417 	unsigned int hwptr_done_capture;
418 	struct snd_card *sndcard;
419 
420 	int users, shutdown;
421 	/* locks */
422 	spinlock_t slock;
423 
424 	int alt;		/* alternate */
425 	int max_pkt_size;	/* max packet size of isoc transaction */
426 	int num_alt;		/* Number of alternative settings */
427 	unsigned int *alt_max_pkt_size;	/* array of wMaxPacketSize */
428 	u16 end_point_addr;
429 };
430 
431 struct cx231xx;
432 
433 struct cx231xx_fh {
434 	struct v4l2_fh fh;
435 	struct cx231xx *dev;
436 	unsigned int stream_on:1;	/* Locks streams */
437 	enum v4l2_buf_type type;
438 
439 	struct videobuf_queue vb_vidq;
440 
441 	/* vbi capture */
442 	struct videobuf_queue      vidq;
443 	struct videobuf_queue      vbiq;
444 
445 	/* MPEG Encoder specifics ONLY */
446 
447 	atomic_t                   v4l_reading;
448 };
449 
450 /*****************************************************************/
451 /* set/get i2c */
452 /* 00--1Mb/s, 01-400kb/s, 10--100kb/s, 11--5Mb/s */
453 #define I2C_SPEED_1M            0x0
454 #define I2C_SPEED_400K          0x1
455 #define I2C_SPEED_100K          0x2
456 #define I2C_SPEED_5M            0x3
457 
458 /* 0-- STOP transaction */
459 #define I2C_STOP                0x0
460 /* 1-- do not transmit STOP at end of transaction */
461 #define I2C_NOSTOP              0x1
462 /* 1--allow slave to insert clock wait states */
463 #define I2C_SYNC                0x1
464 
465 struct cx231xx_i2c {
466 	struct cx231xx *dev;
467 
468 	int nr;
469 
470 	/* i2c i/o */
471 	struct i2c_adapter i2c_adap;
472 	struct i2c_client i2c_client;
473 	u32 i2c_rc;
474 
475 	/* different settings for each bus */
476 	u8 i2c_period;
477 	u8 i2c_nostop;
478 	u8 i2c_reserve;
479 };
480 
481 struct cx231xx_i2c_xfer_data {
482 	u8 dev_addr;
483 	u8 direction;		/* 1 - IN, 0 - OUT */
484 	u8 saddr_len;		/* sub address len */
485 	u16 saddr_dat;		/* sub addr data */
486 	u8 buf_size;		/* buffer size */
487 	u8 *p_buffer;		/* pointer to the buffer */
488 };
489 
490 struct VENDOR_REQUEST_IN {
491 	u8 bRequest;
492 	u16 wValue;
493 	u16 wIndex;
494 	u16 wLength;
495 	u8 direction;
496 	u8 bData;
497 	u8 *pBuff;
498 };
499 
500 struct cx231xx_tvnorm {
501 	char		*name;
502 	v4l2_std_id	id;
503 	u32		cxiformat;
504 	u32		cxoformat;
505 };
506 
507 enum TRANSFER_TYPE {
508 	Raw_Video = 0,
509 	Audio,
510 	Vbi,			/* VANC */
511 	Sliced_cc,		/* HANC */
512 	TS1_serial_mode,
513 	TS2,
514 	TS1_parallel_mode
515 } ;
516 
517 struct cx231xx_video_mode {
518 	/* Isoc control struct */
519 	struct cx231xx_dmaqueue vidq;
520 	struct cx231xx_isoc_ctl isoc_ctl;
521 	struct cx231xx_bulk_ctl bulk_ctl;
522 	/* locks */
523 	spinlock_t slock;
524 
525 	/* usb transfer */
526 	int alt;		/* alternate */
527 	int max_pkt_size;	/* max packet size of isoc transaction */
528 	int num_alt;		/* Number of alternative settings */
529 	unsigned int *alt_max_pkt_size;	/* array of wMaxPacketSize */
530 	u16 end_point_addr;
531 };
532 /*
533 struct cx23885_dmaqueue {
534 	struct list_head       active;
535 	struct list_head       queued;
536 	struct timer_list      timeout;
537 	struct btcx_riscmem    stopper;
538 	u32                    count;
539 };
540 */
541 struct cx231xx_tsport {
542 	struct cx231xx *dev;
543 
544 	int                        nr;
545 	int                        sram_chno;
546 
547 	struct videobuf_dvb_frontends frontends;
548 
549 	/* dma queues */
550 
551 	u32                        ts_packet_size;
552 	u32                        ts_packet_count;
553 
554 	int                        width;
555 	int                        height;
556 
557 	/* locks */
558 	spinlock_t                 slock;
559 
560 	/* registers */
561 	u32                        reg_gpcnt;
562 	u32                        reg_gpcnt_ctl;
563 	u32                        reg_dma_ctl;
564 	u32                        reg_lngth;
565 	u32                        reg_hw_sop_ctrl;
566 	u32                        reg_gen_ctrl;
567 	u32                        reg_bd_pkt_status;
568 	u32                        reg_sop_status;
569 	u32                        reg_fifo_ovfl_stat;
570 	u32                        reg_vld_misc;
571 	u32                        reg_ts_clk_en;
572 	u32                        reg_ts_int_msk;
573 	u32                        reg_ts_int_stat;
574 	u32                        reg_src_sel;
575 
576 	/* Default register vals */
577 	int                        pci_irqmask;
578 	u32                        dma_ctl_val;
579 	u32                        ts_int_msk_val;
580 	u32                        gen_ctrl_val;
581 	u32                        ts_clk_en_val;
582 	u32                        src_sel_val;
583 	u32                        vld_misc_val;
584 	u32                        hw_sop_ctrl_val;
585 
586 	/* Allow a single tsport to have multiple frontends */
587 	u32                        num_frontends;
588 	void                       *port_priv;
589 };
590 
591 /* main device struct */
592 struct cx231xx {
593 	/* generic device properties */
594 	char name[30];		/* name (including minor) of the device */
595 	int model;		/* index in the device_data struct */
596 	int devno;		/* marks the number of this device */
597 
598 	struct cx231xx_board board;
599 
600 	/* For I2C IR support */
601 	struct IR_i2c_init_data    init_data;
602 	struct i2c_client          *ir_i2c_client;
603 
604 	unsigned int stream_on:1;	/* Locks streams */
605 	unsigned int vbi_stream_on:1;	/* Locks streams for VBI */
606 	unsigned int has_audio_class:1;
607 	unsigned int has_alsa_audio:1;
608 
609 	struct cx231xx_fmt *format;
610 
611 	struct v4l2_device v4l2_dev;
612 	struct v4l2_subdev *sd_cx25840;
613 	struct v4l2_subdev *sd_tuner;
614 	struct v4l2_ctrl_handler ctrl_handler;
615 	struct v4l2_ctrl_handler radio_ctrl_handler;
616 	struct cx2341x_handler mpeg_ctrl_handler;
617 
618 	struct work_struct wq_trigger;		/* Trigger to start/stop audio for alsa module */
619 	atomic_t	   stream_started;	/* stream should be running if true */
620 
621 	struct list_head devlist;
622 
623 	int tuner_type;		/* type of the tuner */
624 	int tuner_addr;		/* tuner address */
625 
626 	/* I2C adapters: Master 1 & 2 (External) & Master 3 (Internal only) */
627 	struct cx231xx_i2c i2c_bus[3];
628 	unsigned int xc_fw_load_done:1;
629 	/* locks */
630 	struct mutex gpio_i2c_lock;
631 	struct mutex i2c_lock;
632 
633 	/* video for linux */
634 	int users;		/* user count for exclusive use */
635 	struct video_device *vdev;	/* video for linux device struct */
636 	v4l2_std_id norm;	/* selected tv norm */
637 	int ctl_freq;		/* selected frequency */
638 	unsigned int ctl_ainput;	/* selected audio input */
639 
640 	/* frame properties */
641 	int width;		/* current frame width */
642 	int height;		/* current frame height */
643 	int interlaced;		/* 1=interlace fileds, 0=just top fileds */
644 
645 	struct cx231xx_audio adev;
646 
647 	/* states */
648 	enum cx231xx_dev_state state;
649 
650 	struct work_struct request_module_wk;
651 
652 	/* locks */
653 	struct mutex lock;
654 	struct mutex ctrl_urb_lock;	/* protects urb_buf */
655 	struct list_head inqueue, outqueue;
656 	wait_queue_head_t open, wait_frame, wait_stream;
657 	struct video_device *vbi_dev;
658 	struct video_device *radio_dev;
659 
660 	unsigned char eedata[256];
661 
662 	struct cx231xx_video_mode video_mode;
663 	struct cx231xx_video_mode vbi_mode;
664 	struct cx231xx_video_mode sliced_cc_mode;
665 	struct cx231xx_video_mode ts1_mode;
666 
667 	atomic_t devlist_count;
668 
669 	struct usb_device *udev;	/* the usb device */
670 	char urb_buf[URB_MAX_CTRL_SIZE];	/* urb control msg buffer */
671 
672 	/* helper funcs that call usb_control_msg */
673 	int (*cx231xx_read_ctrl_reg) (struct cx231xx *dev, u8 req, u16 reg,
674 				      char *buf, int len);
675 	int (*cx231xx_write_ctrl_reg) (struct cx231xx *dev, u8 req, u16 reg,
676 				       char *buf, int len);
677 	int (*cx231xx_send_usb_command) (struct cx231xx_i2c *i2c_bus,
678 				struct cx231xx_i2c_xfer_data *req_data);
679 	int (*cx231xx_gpio_i2c_read) (struct cx231xx *dev, u8 dev_addr,
680 				      u8 *buf, u8 len);
681 	int (*cx231xx_gpio_i2c_write) (struct cx231xx *dev, u8 dev_addr,
682 				       u8 *buf, u8 len);
683 
684 	int (*cx231xx_set_analog_freq) (struct cx231xx *dev, u32 freq);
685 	int (*cx231xx_reset_analog_tuner) (struct cx231xx *dev);
686 
687 	enum cx231xx_mode mode;
688 
689 	struct cx231xx_dvb *dvb;
690 
691 	/* Cx231xx supported PCB config's */
692 	struct pcb_config current_pcb_config;
693 	u8 current_scenario_idx;
694 	u8 interface_count;
695 	u8 max_iad_interface_count;
696 
697 	/* GPIO related register direction and values */
698 	u32 gpio_dir;
699 	u32 gpio_val;
700 
701 	/* Power Modes */
702 	int power_mode;
703 
704 	/* afe parameters */
705 	enum AFE_MODE afe_mode;
706 	u32 afe_ref_count;
707 
708 	/* video related parameters */
709 	u32 video_input;
710 	u32 active_mode;
711 	u8 vbi_or_sliced_cc_mode;	/* 0 - vbi ; 1 - sliced cc mode */
712 	enum cx231xx_std_mode std_mode;	/* 0 - Air; 1 - cable */
713 
714 	/*mode: digital=1 or analog=0*/
715 	u8 mode_tv;
716 
717 	u8 USE_ISO;
718 	struct cx231xx_tvnorm      encodernorm;
719 	struct cx231xx_tsport      ts1, ts2;
720 	struct video_device        *v4l_device;
721 	atomic_t                   v4l_reader_count;
722 	u32                        freq;
723 	unsigned int               input;
724 	u32                        cx23417_mailbox;
725 	u32                        __iomem *lmmio;
726 	u8                         __iomem *bmmio;
727 };
728 
729 extern struct list_head cx231xx_devlist;
730 
731 #define cx25840_call(cx231xx, o, f, args...) \
732 	v4l2_subdev_call(cx231xx->sd_cx25840, o, f, ##args)
733 #define tuner_call(cx231xx, o, f, args...) \
734 	v4l2_subdev_call(cx231xx->sd_tuner, o, f, ##args)
735 #define call_all(dev, o, f, args...) \
736 	v4l2_device_call_until_err(&dev->v4l2_dev, 0, o, f, ##args)
737 
738 struct cx231xx_ops {
739 	struct list_head next;
740 	char *name;
741 	int id;
742 	int (*init) (struct cx231xx *);
743 	int (*fini) (struct cx231xx *);
744 };
745 
746 /* call back functions in dvb module */
747 int cx231xx_set_analog_freq(struct cx231xx *dev, u32 freq);
748 int cx231xx_reset_analog_tuner(struct cx231xx *dev);
749 
750 /* Provided by cx231xx-i2c.c */
751 void cx231xx_do_i2c_scan(struct cx231xx *dev, struct i2c_client *c);
752 int cx231xx_i2c_register(struct cx231xx_i2c *bus);
753 int cx231xx_i2c_unregister(struct cx231xx_i2c *bus);
754 
755 /* Internal block control functions */
756 int cx231xx_read_i2c_master(struct cx231xx *dev, u8 dev_addr, u16 saddr,
757 		 u8 saddr_len, u32 *data, u8 data_len, int master);
758 int cx231xx_write_i2c_master(struct cx231xx *dev, u8 dev_addr, u16 saddr,
759 		 u8 saddr_len, u32 data, u8 data_len, int master);
760 int cx231xx_read_i2c_data(struct cx231xx *dev, u8 dev_addr,
761 			  u16 saddr, u8 saddr_len, u32 *data, u8 data_len);
762 int cx231xx_write_i2c_data(struct cx231xx *dev, u8 dev_addr,
763 			   u16 saddr, u8 saddr_len, u32 data, u8 data_len);
764 int cx231xx_reg_mask_write(struct cx231xx *dev, u8 dev_addr, u8 size,
765 			   u16 register_address, u8 bit_start, u8 bit_end,
766 			   u32 value);
767 int cx231xx_read_modify_write_i2c_dword(struct cx231xx *dev, u8 dev_addr,
768 					u16 saddr, u32 mask, u32 value);
769 u32 cx231xx_set_field(u32 field_mask, u32 data);
770 
771 /*verve r/w*/
772 void initGPIO(struct cx231xx *dev);
773 void uninitGPIO(struct cx231xx *dev);
774 /* afe related functions */
775 int cx231xx_afe_init_super_block(struct cx231xx *dev, u32 ref_count);
776 int cx231xx_afe_init_channels(struct cx231xx *dev);
777 int cx231xx_afe_setup_AFE_for_baseband(struct cx231xx *dev);
778 int cx231xx_afe_set_input_mux(struct cx231xx *dev, u32 input_mux);
779 int cx231xx_afe_set_mode(struct cx231xx *dev, enum AFE_MODE mode);
780 int cx231xx_afe_update_power_control(struct cx231xx *dev,
781 					enum AV_MODE avmode);
782 int cx231xx_afe_adjust_ref_count(struct cx231xx *dev, u32 video_input);
783 
784 /* i2s block related functions */
785 int cx231xx_i2s_blk_initialize(struct cx231xx *dev);
786 int cx231xx_i2s_blk_update_power_control(struct cx231xx *dev,
787 					enum AV_MODE avmode);
788 int cx231xx_i2s_blk_set_audio_input(struct cx231xx *dev, u8 audio_input);
789 
790 /* DIF related functions */
791 int cx231xx_dif_configure_C2HH_for_low_IF(struct cx231xx *dev, u32 mode,
792 					  u32 function_mode, u32 standard);
793 void cx231xx_set_Colibri_For_LowIF(struct cx231xx *dev, u32 if_freq,
794 					 u8 spectral_invert, u32 mode);
795 u32 cx231xx_Get_Colibri_CarrierOffset(u32 mode, u32 standerd);
796 void cx231xx_set_DIF_bandpass(struct cx231xx *dev, u32 if_freq,
797 					 u8 spectral_invert, u32 mode);
798 void cx231xx_Setup_AFE_for_LowIF(struct cx231xx *dev);
799 void reset_s5h1432_demod(struct cx231xx *dev);
800 void cx231xx_dump_HH_reg(struct cx231xx *dev);
801 void update_HH_register_after_set_DIF(struct cx231xx *dev);
802 void cx231xx_dump_SC_reg(struct cx231xx *dev);
803 
804 
805 
806 int cx231xx_dif_set_standard(struct cx231xx *dev, u32 standard);
807 int cx231xx_tuner_pre_channel_change(struct cx231xx *dev);
808 int cx231xx_tuner_post_channel_change(struct cx231xx *dev);
809 
810 /* video parser functions */
811 u8 cx231xx_find_next_SAV_EAV(u8 *p_buffer, u32 buffer_size,
812 			     u32 *p_bytes_used);
813 u8 cx231xx_find_boundary_SAV_EAV(u8 *p_buffer, u8 *partial_buf,
814 				 u32 *p_bytes_used);
815 int cx231xx_do_copy(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
816 		    u8 *p_buffer, u32 bytes_to_copy);
817 void cx231xx_reset_video_buffer(struct cx231xx *dev,
818 				struct cx231xx_dmaqueue *dma_q);
819 u8 cx231xx_is_buffer_done(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q);
820 u32 cx231xx_copy_video_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
821 			    u8 *p_line, u32 length, int field_number);
822 u32 cx231xx_get_video_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
823 			   u8 sav_eav, u8 *p_buffer, u32 buffer_size);
824 void cx231xx_swab(u16 *from, u16 *to, u16 len);
825 
826 /* Provided by cx231xx-core.c */
827 
828 u32 cx231xx_request_buffers(struct cx231xx *dev, u32 count);
829 void cx231xx_queue_unusedframes(struct cx231xx *dev);
830 void cx231xx_release_buffers(struct cx231xx *dev);
831 
832 /* read from control pipe */
833 int cx231xx_read_ctrl_reg(struct cx231xx *dev, u8 req, u16 reg,
834 			  char *buf, int len);
835 
836 /* write to control pipe */
837 int cx231xx_write_ctrl_reg(struct cx231xx *dev, u8 req, u16 reg,
838 			   char *buf, int len);
839 int cx231xx_mode_register(struct cx231xx *dev, u16 address, u32 mode);
840 
841 int cx231xx_send_vendor_cmd(struct cx231xx *dev,
842 				struct VENDOR_REQUEST_IN *ven_req);
843 int cx231xx_send_usb_command(struct cx231xx_i2c *i2c_bus,
844 				struct cx231xx_i2c_xfer_data *req_data);
845 
846 /* Gpio related functions */
847 int cx231xx_send_gpio_cmd(struct cx231xx *dev, u32 gpio_bit, u8 *gpio_val,
848 			  u8 len, u8 request, u8 direction);
849 int cx231xx_set_gpio_value(struct cx231xx *dev, int pin_number, int pin_value);
850 int cx231xx_set_gpio_direction(struct cx231xx *dev, int pin_number,
851 			       int pin_value);
852 
853 int cx231xx_gpio_i2c_start(struct cx231xx *dev);
854 int cx231xx_gpio_i2c_end(struct cx231xx *dev);
855 int cx231xx_gpio_i2c_write_byte(struct cx231xx *dev, u8 data);
856 int cx231xx_gpio_i2c_read_byte(struct cx231xx *dev, u8 *buf);
857 int cx231xx_gpio_i2c_read_ack(struct cx231xx *dev);
858 int cx231xx_gpio_i2c_write_ack(struct cx231xx *dev);
859 int cx231xx_gpio_i2c_write_nak(struct cx231xx *dev);
860 
861 int cx231xx_gpio_i2c_read(struct cx231xx *dev, u8 dev_addr, u8 *buf, u8 len);
862 int cx231xx_gpio_i2c_write(struct cx231xx *dev, u8 dev_addr, u8 *buf, u8 len);
863 
864 /* audio related functions */
865 int cx231xx_set_audio_decoder_input(struct cx231xx *dev,
866 				    enum AUDIO_INPUT audio_input);
867 
868 int cx231xx_capture_start(struct cx231xx *dev, int start, u8 media_type);
869 int cx231xx_set_video_alternate(struct cx231xx *dev);
870 int cx231xx_set_alt_setting(struct cx231xx *dev, u8 index, u8 alt);
871 int is_fw_load(struct cx231xx *dev);
872 int cx231xx_check_fw(struct cx231xx *dev);
873 int cx231xx_init_isoc(struct cx231xx *dev, int max_packets,
874 		      int num_bufs, int max_pkt_size,
875 		      int (*isoc_copy) (struct cx231xx *dev,
876 					struct urb *urb));
877 int cx231xx_init_bulk(struct cx231xx *dev, int max_packets,
878 		      int num_bufs, int max_pkt_size,
879 		      int (*bulk_copy) (struct cx231xx *dev,
880 					struct urb *urb));
881 void cx231xx_stop_TS1(struct cx231xx *dev);
882 void cx231xx_start_TS1(struct cx231xx *dev);
883 void cx231xx_uninit_isoc(struct cx231xx *dev);
884 void cx231xx_uninit_bulk(struct cx231xx *dev);
885 int cx231xx_set_mode(struct cx231xx *dev, enum cx231xx_mode set_mode);
886 int cx231xx_unmute_audio(struct cx231xx *dev);
887 int cx231xx_ep5_bulkout(struct cx231xx *dev, u8 *firmware, u16 size);
888 void cx231xx_disable656(struct cx231xx *dev);
889 void cx231xx_enable656(struct cx231xx *dev);
890 int cx231xx_demod_reset(struct cx231xx *dev);
891 int cx231xx_gpio_set(struct cx231xx *dev, struct cx231xx_reg_seq *gpio);
892 
893 /* Device list functions */
894 void cx231xx_release_resources(struct cx231xx *dev);
895 void cx231xx_release_analog_resources(struct cx231xx *dev);
896 int cx231xx_register_analog_devices(struct cx231xx *dev);
897 void cx231xx_remove_from_devlist(struct cx231xx *dev);
898 void cx231xx_add_into_devlist(struct cx231xx *dev);
899 void cx231xx_init_extension(struct cx231xx *dev);
900 void cx231xx_close_extension(struct cx231xx *dev);
901 
902 /* hardware init functions */
903 int cx231xx_dev_init(struct cx231xx *dev);
904 void cx231xx_dev_uninit(struct cx231xx *dev);
905 void cx231xx_config_i2c(struct cx231xx *dev);
906 int cx231xx_config(struct cx231xx *dev);
907 
908 /* Stream control functions */
909 int cx231xx_start_stream(struct cx231xx *dev, u32 ep_mask);
910 int cx231xx_stop_stream(struct cx231xx *dev, u32 ep_mask);
911 
912 int cx231xx_initialize_stream_xfer(struct cx231xx *dev, u32 media_type);
913 
914 /* Power control functions */
915 int cx231xx_set_power_mode(struct cx231xx *dev, enum AV_MODE mode);
916 int cx231xx_power_suspend(struct cx231xx *dev);
917 
918 /* chip specific control functions */
919 int cx231xx_init_ctrl_pin_status(struct cx231xx *dev);
920 int cx231xx_set_agc_analog_digital_mux_select(struct cx231xx *dev,
921 					      u8 analog_or_digital);
922 int cx231xx_enable_i2c_port_3(struct cx231xx *dev, bool is_port_3);
923 
924 /* video audio decoder related functions */
925 void video_mux(struct cx231xx *dev, int index);
926 int cx231xx_set_video_input_mux(struct cx231xx *dev, u8 input);
927 int cx231xx_set_decoder_video_input(struct cx231xx *dev, u8 pin_type, u8 input);
928 int cx231xx_do_mode_ctrl_overrides(struct cx231xx *dev);
929 int cx231xx_set_audio_input(struct cx231xx *dev, u8 input);
930 
931 /* Provided by cx231xx-video.c */
932 int cx231xx_register_extension(struct cx231xx_ops *dev);
933 void cx231xx_unregister_extension(struct cx231xx_ops *dev);
934 void cx231xx_init_extension(struct cx231xx *dev);
935 void cx231xx_close_extension(struct cx231xx *dev);
936 int cx231xx_querycap(struct file *file, void *priv,
937 			   struct v4l2_capability *cap);
938 int cx231xx_g_tuner(struct file *file, void *priv, struct v4l2_tuner *t);
939 int cx231xx_s_tuner(struct file *file, void *priv, const struct v4l2_tuner *t);
940 int cx231xx_g_frequency(struct file *file, void *priv,
941 			      struct v4l2_frequency *f);
942 int cx231xx_s_frequency(struct file *file, void *priv,
943 			      const struct v4l2_frequency *f);
944 int cx231xx_enum_input(struct file *file, void *priv,
945 			     struct v4l2_input *i);
946 int cx231xx_g_input(struct file *file, void *priv, unsigned int *i);
947 int cx231xx_s_input(struct file *file, void *priv, unsigned int i);
948 int cx231xx_g_chip_info(struct file *file, void *fh, struct v4l2_dbg_chip_info *chip);
949 int cx231xx_g_register(struct file *file, void *priv,
950 			     struct v4l2_dbg_register *reg);
951 int cx231xx_s_register(struct file *file, void *priv,
952 			     const struct v4l2_dbg_register *reg);
953 
954 /* Provided by cx231xx-cards.c */
955 extern void cx231xx_pre_card_setup(struct cx231xx *dev);
956 extern void cx231xx_card_setup(struct cx231xx *dev);
957 extern struct cx231xx_board cx231xx_boards[];
958 extern struct usb_device_id cx231xx_id_table[];
959 extern const unsigned int cx231xx_bcount;
960 int cx231xx_tuner_callback(void *ptr, int component, int command, int arg);
961 
962 /* cx23885-417.c                                               */
963 extern int cx231xx_417_register(struct cx231xx *dev);
964 extern void cx231xx_417_unregister(struct cx231xx *dev);
965 
966 /* cx23885-input.c                                             */
967 
968 #if defined(CONFIG_VIDEO_CX231XX_RC)
969 int cx231xx_ir_init(struct cx231xx *dev);
970 void cx231xx_ir_exit(struct cx231xx *dev);
971 #else
972 #define cx231xx_ir_init(dev)	(0)
973 #define cx231xx_ir_exit(dev)	(0)
974 #endif
975 
976 
977 /* printk macros */
978 
979 #define cx231xx_err(fmt, arg...) do {\
980 	printk(KERN_ERR fmt , ##arg); } while (0)
981 
982 #define cx231xx_errdev(fmt, arg...) do {\
983 	printk(KERN_ERR "%s: "fmt,\
984 			dev->name , ##arg); } while (0)
985 
986 #define cx231xx_info(fmt, arg...) do {\
987 	printk(KERN_INFO "%s: "fmt,\
988 			dev->name , ##arg); } while (0)
989 #define cx231xx_warn(fmt, arg...) do {\
990 	printk(KERN_WARNING "%s: "fmt,\
991 			dev->name , ##arg); } while (0)
992 
993 static inline unsigned int norm_maxw(struct cx231xx *dev)
994 {
995 	if (dev->board.max_range_640_480)
996 		return 640;
997 	else
998 		return 720;
999 }
1000 
1001 static inline unsigned int norm_maxh(struct cx231xx *dev)
1002 {
1003 	if (dev->board.max_range_640_480)
1004 		return 480;
1005 	else
1006 		return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
1007 }
1008 #endif
1009