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