V4L/DVB (12801): tm6000: Add support for ADSTech Mini Dual TV (PTV-339).
[safe/jmp/linux-2.6] / drivers / staging / tm6000 / tm6000.h
1 /*
2    tm6000.h - driver for TM5600/TM6000 USB video capture devices
3
4    Copyright (C) 2006-2007 Mauro Carvalho Chehab <mchehab@infradead.org>
5
6    Copyright (C) 2007 Michel Ludwig <michel.ludwig@gmail.com>
7         - DVB-T support
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation version 2
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21  */
22
23 // Use the tm6000-hack, instead of the proper initialization code
24 //#define HACK 1
25
26 #include <linux/videodev2.h>
27 #include <media/v4l2-common.h>
28 #include <media/videobuf-vmalloc.h>
29 #include "tm6000-usb-isoc.h"
30 #include <linux/i2c.h>
31 #include <linux/mutex.h>
32
33 #include <linux/dvb/frontend.h>
34 #include "dvb_demux.h"
35 #include "dvb_frontend.h"
36 #include "dmxdev.h"
37
38 #define TM6000_VERSION KERNEL_VERSION(0, 0, 1)
39
40 /* Inputs */
41
42 enum tm6000_itype {
43         TM6000_INPUT_TV = 0,
44         TM6000_INPUT_COMPOSITE,
45         TM6000_INPUT_SVIDEO,
46 };
47
48
49 /* ------------------------------------------------------------------
50         Basic structures
51    ------------------------------------------------------------------*/
52
53 struct tm6000_fmt {
54         char  *name;
55         u32   fourcc;          /* v4l2 format id */
56         int   depth;
57 };
58
59 /* buffer for one video frame */
60 struct tm6000_buffer {
61         /* common v4l buffer stuff -- must be first */
62         struct videobuf_buffer vb;
63
64         struct tm6000_fmt      *fmt;
65 };
66
67 struct tm6000_dmaqueue {
68         struct list_head       active;
69         struct list_head       queued;
70         struct timer_list      timeout;
71
72         /* thread for generating video stream*/
73         struct task_struct         *kthread;
74         wait_queue_head_t          wq;
75         /* Counters to control fps rate */
76         int                        frame;
77         int                        ini_jiffies;
78 };
79
80 /* device states */
81 enum tm6000_core_state {
82         DEV_INITIALIZED   = 0x01,
83         DEV_DISCONNECTED  = 0x02,
84         DEV_MISCONFIGURED = 0x04,
85 };
86
87 /* io methods */
88 enum tm6000_io_method {
89         IO_NONE,
90         IO_READ,
91         IO_MMAP,
92 };
93
94 enum tm6000_mode {
95         TM6000_MODE_UNKNOWN=0,
96         TM6000_MODE_ANALOG,
97         TM6000_MODE_DIGITAL,
98 };
99
100 struct tm6000_capabilities {
101         unsigned int    has_tuner:1;
102         unsigned int    has_tda9874:1;
103         unsigned int    has_dvb:1;
104         unsigned int    has_zl10353:1;
105         unsigned int    has_eeprom:1;
106         unsigned int    has_remote:1;
107 };
108
109 struct tm6000_dvb {
110         struct dvb_adapter      adapter;
111         struct dvb_demux        demux;
112         struct dvb_frontend     *frontend;
113         struct dmxdev           dmxdev;
114         unsigned int            streams;
115         struct urb              *bulk_urb;
116         struct mutex            mutex;
117 };
118
119 struct tm6000_core {
120         /* generic device properties */
121         char                            name[30];       /* name (including minor) of the device */
122         int                             model;          /* index in the device_data struct */
123         int                             devno;          /* marks the number of this device */
124
125         v4l2_std_id                     norm;           /* Current norm */
126         int                             width,height;   /* Selected resolution */
127
128         enum tm6000_core_state          state;
129
130         /* Device Capabilities*/
131         struct tm6000_capabilities      caps;
132
133         /* Tuner configuration */
134         int                             tuner_type;             /* type of the tuner */
135         int                             tuner_addr;             /* tuner address */
136         int                             tuner_reset_gpio;       /* GPIO used for tuner reset */
137
138         /* Demodulator configuration */
139         int                             demod_addr;     /* demodulator address */
140
141         int                             audio_bitrate;
142         /* i2c i/o */
143         struct i2c_adapter              i2c_adap;
144         struct i2c_client               i2c_client;
145
146         /* video for linux */
147         struct list_head                tm6000_corelist;
148         int                             users;
149
150         /* various device info */
151         unsigned int                    resources;
152         struct video_device             *vfd;
153         struct tm6000_dmaqueue          vidq;
154
155         int                             input;
156         int                             freq;
157         unsigned int                    fourcc;
158
159         enum tm6000_mode                mode;
160
161         /* DVB-T support */
162         struct tm6000_dvb               *dvb;
163
164         /* locks */
165         struct mutex                    lock;
166
167         /* usb transfer */
168         struct usb_device               *udev;          /* the usb device */
169
170         struct usb_host_endpoint        *bulk_in, *bulk_out, *isoc_in, *isoc_out;
171         unsigned int                    max_bulk_in, max_bulk_out;
172         unsigned int                    max_isoc_in, max_isoc_out;
173
174         /* scaler!=0 if scaler is active*/
175         int                             scaler;
176
177                 /* Isoc control struct */
178         struct usb_isoc_ctl          isoc_ctl;
179
180         spinlock_t                   slock;
181 };
182
183 struct tm6000_fh {
184         struct tm6000_core           *dev;
185
186         /* video capture */
187         struct tm6000_fmt            *fmt;
188         unsigned int                 width,height;
189         struct videobuf_queue        vb_vidq;
190
191         enum v4l2_buf_type           type;
192 };
193
194 #define TM6000_STD      V4L2_STD_PAL|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|    \
195                         V4L2_STD_PAL_M|V4L2_STD_PAL_60|V4L2_STD_NTSC_M| \
196                         V4L2_STD_NTSC_M_JP|V4L2_STD_SECAM
197
198 /* In tm6000-core.c */
199 extern unsigned long tm6000_devused;
200
201 int tm6000_read_write_usb (struct tm6000_core *dev, u8 reqtype, u8 req,
202                            u16 value, u16 index, u8 *buf, u16 len);
203 int tm6000_get_reg (struct tm6000_core *dev, u8 req, u16 value, u16 index);
204 int tm6000_set_reg (struct tm6000_core *dev, u8 req, u16 value, u16 index);
205 int tm6000_init (struct tm6000_core *dev);
206 int tm6000_init_after_firmware (struct tm6000_core *dev);
207
208 int tm6000_init_analog_mode (struct tm6000_core *dev);
209 int tm6000_init_digital_mode (struct tm6000_core *dev);
210 void tm6000_get_std_res(struct tm6000_core *dev);
211 int tm6000_set_standard (struct tm6000_core *dev, v4l2_std_id *norm);
212 int tm6000_set_audio_bitrate (struct tm6000_core *dev, int bitrate);
213
214 int tm6000_dvb_register(struct tm6000_core *dev);
215 void tm6000_dvb_unregister(struct tm6000_core *dev);
216
217 int tm6000_v4l2_register(struct tm6000_core *dev);
218 int tm6000_v4l2_unregister(struct tm6000_core *dev);
219 int tm6000_v4l2_exit(void);
220 void tm6000_set_fourcc_format(struct tm6000_core *dev);
221
222 /* In tm6000-i2c.c */
223 int tm6000_i2c_register(struct tm6000_core *dev);
224 int tm6000_i2c_unregister(struct tm6000_core *dev);
225 void tm6000_i2c_call_clients(struct tm6000_core *dev, unsigned int cmd,
226                              void *arg);
227
228 /* In tm6000-queue.c */
229
230 int tm6000_v4l2_mmap(struct file *filp, struct vm_area_struct *vma);
231
232 int tm6000_vidioc_streamon(struct file *file, void *priv,
233                            enum v4l2_buf_type i);
234 int tm6000_vidioc_streamoff(struct file *file, void *priv,
235                             enum v4l2_buf_type i);
236 int tm6000_vidioc_reqbufs (struct file *file, void *priv,
237                            struct v4l2_requestbuffers *rb);
238 int tm6000_vidioc_querybuf (struct file *file, void *priv,
239                             struct v4l2_buffer *b);
240 int tm6000_vidioc_qbuf (struct file *file, void *priv, struct v4l2_buffer *b);
241 int tm6000_vidioc_dqbuf (struct file *file, void *priv, struct v4l2_buffer *b);
242 ssize_t tm6000_v4l2_read(struct file *filp, char __user * buf, size_t count,
243                          loff_t * f_pos);
244 unsigned int tm6000_v4l2_poll(struct file *file,
245                               struct poll_table_struct *wait);
246 int tm6000_queue_init(struct tm6000_core *dev);
247
248 /* Debug stuff */
249
250 extern int tm6000_debug;
251
252 #define dprintk(dev, level, fmt, arg...) do {\
253         if (tm6000_debug & level) \
254                 printk(KERN_INFO "(%lu) %s %s :"fmt, jiffies,           \
255                          dev->name, __FUNCTION__ , ##arg); } while (0)
256
257 #define V4L2_DEBUG_REG          0x0004
258 #define V4L2_DEBUG_I2C          0x0008
259 #define V4L2_DEBUG_QUEUE        0x0010
260 #define V4L2_DEBUG_ISOC         0x0020
261 #define V4L2_DEBUG_RES_LOCK     0x0040  /* Resource locking */
262 #define V4L2_DEBUG_OPEN         0x0080  /* video open/close debug */
263
264 #define tm6000_err(fmt, arg...) do {\
265         printk(KERN_ERR "tm6000 %s :"fmt, \
266                 __FUNCTION__ , ##arg); } while (0)
267
268