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