Merge branch 'v4l_for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[linux-2.6.git] / drivers / media / video / tm6000 / tm6000.h
1 /*
2  *  tm6000.h - driver for TM5600/TM6000/TM6010 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 #include <linux/videodev2.h>
24 #include <media/v4l2-common.h>
25 #include <media/videobuf-vmalloc.h>
26 #include "tm6000-usb-isoc.h"
27 #include <linux/i2c.h>
28 #include <linux/mutex.h>
29 #include <media/v4l2-device.h>
30
31 #include <linux/dvb/frontend.h>
32 #include "dvb_demux.h"
33 #include "dvb_frontend.h"
34 #include "dmxdev.h"
35
36 #define TM6000_VERSION KERNEL_VERSION(0, 0, 2)
37
38 /* Inputs */
39 enum tm6000_itype {
40         TM6000_INPUT_TV = 1,
41         TM6000_INPUT_COMPOSITE1,
42         TM6000_INPUT_COMPOSITE2,
43         TM6000_INPUT_SVIDEO,
44         TM6000_INPUT_DVB,
45         TM6000_INPUT_RADIO,
46 };
47
48 enum tm6000_mux {
49         TM6000_VMUX_VIDEO_A = 1,
50         TM6000_VMUX_VIDEO_B,
51         TM6000_VMUX_VIDEO_AB,
52         TM6000_AMUX_ADC1,
53         TM6000_AMUX_ADC2,
54         TM6000_AMUX_SIF1,
55         TM6000_AMUX_SIF2,
56         TM6000_AMUX_I2S,
57 };
58
59 enum tm6000_devtype {
60         TM6000 = 0,
61         TM5600,
62         TM6010,
63 };
64
65 struct tm6000_input {
66         enum tm6000_itype       type;
67         enum tm6000_mux         vmux;
68         enum tm6000_mux         amux;
69         unsigned int            v_gpio;
70         unsigned int            a_gpio;
71 };
72
73 /* ------------------------------------------------------------------
74  *      Basic structures
75  * ------------------------------------------------------------------
76  */
77
78 struct tm6000_fmt {
79         char  *name;
80         u32   fourcc;          /* v4l2 format id */
81         int   depth;
82 };
83
84 /* buffer for one video frame */
85 struct tm6000_buffer {
86         /* common v4l buffer stuff -- must be first */
87         struct videobuf_buffer vb;
88
89         struct tm6000_fmt      *fmt;
90 };
91
92 struct tm6000_dmaqueue {
93         struct list_head       active;
94         struct list_head       queued;
95
96         /* thread for generating video stream*/
97         struct task_struct         *kthread;
98         wait_queue_head_t          wq;
99         /* Counters to control fps rate */
100         int                        frame;
101         int                        ini_jiffies;
102 };
103
104 /* device states */
105 enum tm6000_core_state {
106         DEV_INITIALIZED   = 0x01,
107         DEV_DISCONNECTED  = 0x02,
108         DEV_MISCONFIGURED = 0x04,
109 };
110
111 /* io methods */
112 enum tm6000_io_method {
113         IO_NONE,
114         IO_READ,
115         IO_MMAP,
116 };
117
118 enum tm6000_mode {
119         TM6000_MODE_UNKNOWN = 0,
120         TM6000_MODE_ANALOG,
121         TM6000_MODE_DIGITAL,
122 };
123
124 struct tm6000_gpio {
125         int             tuner_reset;
126         int             tuner_on;
127         int             demod_reset;
128         int             demod_on;
129         int             power_led;
130         int             dvb_led;
131         int             ir;
132 };
133
134 struct tm6000_capabilities {
135         unsigned int    has_tuner:1;
136         unsigned int    has_tda9874:1;
137         unsigned int    has_dvb:1;
138         unsigned int    has_zl10353:1;
139         unsigned int    has_eeprom:1;
140         unsigned int    has_remote:1;
141         unsigned int    has_radio:1;
142 };
143
144 struct tm6000_dvb {
145         struct dvb_adapter      adapter;
146         struct dvb_demux        demux;
147         struct dvb_frontend     *frontend;
148         struct dmxdev           dmxdev;
149         unsigned int            streams;
150         struct urb              *bulk_urb;
151         struct mutex            mutex;
152 };
153
154 struct snd_tm6000_card {
155         struct snd_card                 *card;
156         spinlock_t                      reg_lock;
157         struct tm6000_core              *core;
158         struct snd_pcm_substream        *substream;
159
160         /* temporary data for buffer fill processing */
161         unsigned                        buf_pos;
162         unsigned                        period_pos;
163 };
164
165 struct tm6000_endpoint {
166         struct usb_host_endpoint        *endp;
167         __u8                            bInterfaceNumber;
168         __u8                            bAlternateSetting;
169         unsigned                        maxsize;
170 };
171
172 #define TM6000_QUIRK_NO_USB_DELAY (1 << 0)
173
174 struct tm6000_core {
175         /* generic device properties */
176         char                            name[30];       /* name (including minor) of the device */
177         int                             model;          /* index in the device_data struct */
178         int                             devno;          /* marks the number of this device */
179         enum tm6000_devtype             dev_type;       /* type of device */
180         unsigned char                   eedata[256];    /* Eeprom data */
181         unsigned                        eedata_size;    /* Size of the eeprom info */
182
183         v4l2_std_id                     norm;           /* Current norm */
184         int                             width, height;  /* Selected resolution */
185
186         enum tm6000_core_state          state;
187
188         /* Device Capabilities*/
189         struct tm6000_capabilities      caps;
190
191         /* Used to load alsa/dvb */
192         struct work_struct              request_module_wk;
193
194         /* Tuner configuration */
195         int                             tuner_type;             /* type of the tuner */
196         int                             tuner_addr;             /* tuner address */
197
198         struct tm6000_gpio              gpio;
199
200         char                            *ir_codes;
201
202         __u8                            radio;
203
204         /* Demodulator configuration */
205         int                             demod_addr;     /* demodulator address */
206
207         int                             audio_bitrate;
208         /* i2c i/o */
209         struct i2c_adapter              i2c_adap;
210         struct i2c_client               i2c_client;
211
212
213         /* extension */
214         struct list_head                devlist;
215
216         /* video for linux */
217         int                             users;
218
219         /* various device info */
220         struct tm6000_fh                *resources;     /* Points to fh that is streaming */
221         bool                            is_res_read;
222
223         struct video_device             *vfd;
224         struct video_device             *radio_dev;
225         struct tm6000_dmaqueue          vidq;
226         struct v4l2_device              v4l2_dev;
227
228         int                             input;
229         struct tm6000_input             vinput[3];      /* video input */
230         struct tm6000_input             rinput;         /* radio input */
231
232         int                             freq;
233         unsigned int                    fourcc;
234
235         enum tm6000_mode                mode;
236
237         int                             ctl_mute;             /* audio */
238         int                             ctl_volume;
239         int                             amode;
240
241         /* DVB-T support */
242         struct tm6000_dvb               *dvb;
243
244         /* audio support */
245         struct snd_tm6000_card          *adev;
246         struct work_struct              wq_trigger;   /* Trigger to start/stop audio for alsa module */
247         atomic_t                        stream_started;  /* stream should be running if true */
248
249         struct tm6000_IR                *ir;
250
251         /* locks */
252         struct mutex                    lock;
253         struct mutex                    usb_lock;
254
255         /* usb transfer */
256         struct usb_device               *udev;          /* the usb device */
257
258         struct tm6000_endpoint          bulk_in, bulk_out, isoc_in, isoc_out;
259         struct tm6000_endpoint          int_in, int_out;
260
261         /* scaler!=0 if scaler is active*/
262         int                             scaler;
263
264                 /* Isoc control struct */
265         struct usb_isoc_ctl          isoc_ctl;
266
267         spinlock_t                   slock;
268
269         unsigned long quirks;
270 };
271
272 enum tm6000_ops_type {
273         TM6000_AUDIO = 0x10,
274         TM6000_DVB = 0x20,
275 };
276
277 struct tm6000_ops {
278         struct list_head        next;
279         char                    *name;
280         enum tm6000_ops_type    type;
281         int (*init)(struct tm6000_core *);
282         int (*fini)(struct tm6000_core *);
283         int (*fillbuf)(struct tm6000_core *, char *buf, int size);
284 };
285
286 struct tm6000_fh {
287         struct tm6000_core           *dev;
288         unsigned int                 radio;
289
290         /* video capture */
291         struct tm6000_fmt            *fmt;
292         unsigned int                 width, height;
293         struct videobuf_queue        vb_vidq;
294
295         enum v4l2_buf_type           type;
296 };
297
298 #define TM6000_STD      (V4L2_STD_PAL|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|    \
299                         V4L2_STD_PAL_M|V4L2_STD_PAL_60|V4L2_STD_NTSC_M| \
300                         V4L2_STD_NTSC_M_JP|V4L2_STD_SECAM)
301
302 /* In tm6000-cards.c */
303
304 int tm6000_tuner_callback(void *ptr, int component, int command, int arg);
305 int tm6000_xc5000_callback(void *ptr, int component, int command, int arg);
306 int tm6000_cards_setup(struct tm6000_core *dev);
307 void tm6000_flash_led(struct tm6000_core *dev, u8 state);
308
309 /* In tm6000-core.c */
310
311 int tm6000_read_write_usb(struct tm6000_core *dev, u8 reqtype, u8 req,
312                            u16 value, u16 index, u8 *buf, u16 len);
313 int tm6000_get_reg(struct tm6000_core *dev, u8 req, u16 value, u16 index);
314 int tm6000_get_reg16(struct tm6000_core *dev, u8 req, u16 value, u16 index);
315 int tm6000_get_reg32(struct tm6000_core *dev, u8 req, u16 value, u16 index);
316 int tm6000_set_reg(struct tm6000_core *dev, u8 req, u16 value, u16 index);
317 int tm6000_set_reg_mask(struct tm6000_core *dev, u8 req, u16 value,
318                                                 u16 index, u16 mask);
319 int tm6000_i2c_reset(struct tm6000_core *dev, u16 tsleep);
320 int tm6000_init(struct tm6000_core *dev);
321 int tm6000_reset(struct tm6000_core *dev);
322
323 int tm6000_init_analog_mode(struct tm6000_core *dev);
324 int tm6000_init_digital_mode(struct tm6000_core *dev);
325 int tm6000_set_audio_bitrate(struct tm6000_core *dev, int bitrate);
326 int tm6000_set_audio_rinput(struct tm6000_core *dev);
327 int tm6000_tvaudio_set_mute(struct tm6000_core *dev, u8 mute);
328 void tm6000_set_volume(struct tm6000_core *dev, int vol);
329
330 int tm6000_v4l2_register(struct tm6000_core *dev);
331 int tm6000_v4l2_unregister(struct tm6000_core *dev);
332 int tm6000_v4l2_exit(void);
333 void tm6000_set_fourcc_format(struct tm6000_core *dev);
334
335 void tm6000_remove_from_devlist(struct tm6000_core *dev);
336 void tm6000_add_into_devlist(struct tm6000_core *dev);
337 int tm6000_register_extension(struct tm6000_ops *ops);
338 void tm6000_unregister_extension(struct tm6000_ops *ops);
339 void tm6000_init_extension(struct tm6000_core *dev);
340 void tm6000_close_extension(struct tm6000_core *dev);
341 int tm6000_call_fillbuf(struct tm6000_core *dev, enum tm6000_ops_type type,
342                         char *buf, int size);
343
344
345 /* In tm6000-stds.c */
346 void tm6000_get_std_res(struct tm6000_core *dev);
347 int tm6000_set_standard(struct tm6000_core *dev);
348
349 /* In tm6000-i2c.c */
350 int tm6000_i2c_register(struct tm6000_core *dev);
351 int tm6000_i2c_unregister(struct tm6000_core *dev);
352
353 /* In tm6000-queue.c */
354
355 int tm6000_v4l2_mmap(struct file *filp, struct vm_area_struct *vma);
356
357 int tm6000_vidioc_streamon(struct file *file, void *priv,
358                            enum v4l2_buf_type i);
359 int tm6000_vidioc_streamoff(struct file *file, void *priv,
360                             enum v4l2_buf_type i);
361 int tm6000_vidioc_reqbufs(struct file *file, void *priv,
362                           struct v4l2_requestbuffers *rb);
363 int tm6000_vidioc_querybuf(struct file *file, void *priv,
364                            struct v4l2_buffer *b);
365 int tm6000_vidioc_qbuf(struct file *file, void *priv, struct v4l2_buffer *b);
366 int tm6000_vidioc_dqbuf(struct file *file, void *priv, struct v4l2_buffer *b);
367 ssize_t tm6000_v4l2_read(struct file *filp, char __user * buf, size_t count,
368                          loff_t *f_pos);
369 unsigned int tm6000_v4l2_poll(struct file *file,
370                               struct poll_table_struct *wait);
371 int tm6000_queue_init(struct tm6000_core *dev);
372
373 /* In tm6000-alsa.c */
374 /*int tm6000_audio_init(struct tm6000_core *dev, int idx);*/
375
376 /* In tm6000-input.c */
377 int tm6000_ir_init(struct tm6000_core *dev);
378 int tm6000_ir_fini(struct tm6000_core *dev);
379 void tm6000_ir_wait(struct tm6000_core *dev, u8 state);
380 int tm6000_ir_int_start(struct tm6000_core *dev);
381 void tm6000_ir_int_stop(struct tm6000_core *dev);
382
383 /* Debug stuff */
384
385 extern int tm6000_debug;
386
387 #define dprintk(dev, level, fmt, arg...) do {\
388         if (tm6000_debug & level) \
389                 printk(KERN_INFO "(%lu) %s %s :"fmt, jiffies, \
390                          dev->name, __func__ , ##arg); } while (0)
391
392 #define V4L2_DEBUG_REG          0x0004
393 #define V4L2_DEBUG_I2C          0x0008
394 #define V4L2_DEBUG_QUEUE        0x0010
395 #define V4L2_DEBUG_ISOC         0x0020
396 #define V4L2_DEBUG_RES_LOCK     0x0040  /* Resource locking */
397 #define V4L2_DEBUG_OPEN         0x0080  /* video open/close debug */
398
399 #define tm6000_err(fmt, arg...) do {\
400         printk(KERN_ERR "tm6000 %s :"fmt, \
401                 __func__ , ##arg); } while (0)