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