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