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