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