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