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