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