V4L/DVB (12848): tm6000: Add README with todo list
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / staging / tm6000 / tm6000.h
CommitLineData
9701dc94
MCC
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
3169c9b2
ML
6 Copyright (C) 2007 Michel Ludwig <michel.ludwig@gmail.com>
7 - DVB-T support
8
9701dc94
MCC
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
3169c9b2
ML
33#include <linux/dvb/frontend.h>
34#include "dvb_demux.h"
35#include "dvb_frontend.h"
36#include "dmxdev.h"
37
9701dc94
MCC
38#define TM6000_VERSION KERNEL_VERSION(0, 0, 1)
39
40/* Inputs */
c85cba3f
MCC
41
42enum tm6000_itype {
43 TM6000_INPUT_TV = 0,
44 TM6000_INPUT_COMPOSITE,
45 TM6000_INPUT_SVIDEO,
46};
47
29c389be
MCC
48enum tm6000_devtype {
49 TM6000 = 0,
50 TM5600,
51 TM6010,
52};
9701dc94
MCC
53
54/* ------------------------------------------------------------------
55 Basic structures
56 ------------------------------------------------------------------*/
57
58struct tm6000_fmt {
59 char *name;
60 u32 fourcc; /* v4l2 format id */
61 int depth;
62};
63
64/* buffer for one video frame */
65struct tm6000_buffer {
66 /* common v4l buffer stuff -- must be first */
67 struct videobuf_buffer vb;
68
69 struct tm6000_fmt *fmt;
70};
71
72struct tm6000_dmaqueue {
73 struct list_head active;
74 struct list_head queued;
9701dc94
MCC
75
76 /* thread for generating video stream*/
77 struct task_struct *kthread;
78 wait_queue_head_t wq;
79 /* Counters to control fps rate */
80 int frame;
81 int ini_jiffies;
82};
83
84/* device states */
85enum tm6000_core_state {
86 DEV_INITIALIZED = 0x01,
87 DEV_DISCONNECTED = 0x02,
88 DEV_MISCONFIGURED = 0x04,
89};
90
91/* io methods */
92enum tm6000_io_method {
93 IO_NONE,
94 IO_READ,
95 IO_MMAP,
96};
97
98enum tm6000_mode {
99 TM6000_MODE_UNKNOWN=0,
100 TM6000_MODE_ANALOG,
101 TM6000_MODE_DIGITAL,
102};
103
104struct tm6000_capabilities {
105 unsigned int has_tuner:1;
106 unsigned int has_tda9874:1;
107 unsigned int has_dvb:1;
108 unsigned int has_zl10353:1;
109 unsigned int has_eeprom:1;
4386136d 110 unsigned int has_remote:1;
9701dc94
MCC
111};
112
3169c9b2
ML
113struct tm6000_dvb {
114 struct dvb_adapter adapter;
115 struct dvb_demux demux;
116 struct dvb_frontend *frontend;
117 struct dmxdev dmxdev;
118 unsigned int streams;
119 struct urb *bulk_urb;
120 struct mutex mutex;
121};
122
9701dc94
MCC
123struct tm6000_core {
124 /* generic device properties */
125 char name[30]; /* name (including minor) of the device */
126 int model; /* index in the device_data struct */
127 int devno; /* marks the number of this device */
29c389be 128 enum tm6000_devtype dev_type; /* type of device */
3169c9b2
ML
129
130 v4l2_std_id norm; /* Current norm */
4475c044 131 int width,height; /* Selected resolution */
9701dc94
MCC
132
133 enum tm6000_core_state state;
134
135 /* Device Capabilities*/
136 struct tm6000_capabilities caps;
137
138 /* Tuner configuration */
95a83824
ML
139 int tuner_type; /* type of the tuner */
140 int tuner_addr; /* tuner address */
141 int tuner_reset_gpio; /* GPIO used for tuner reset */
142
143 /* Demodulator configuration */
144 int demod_addr; /* demodulator address */
9701dc94 145
c13dd704 146 int audio_bitrate;
9701dc94
MCC
147 /* i2c i/o */
148 struct i2c_adapter i2c_adap;
149 struct i2c_client i2c_client;
150
151 /* video for linux */
152 struct list_head tm6000_corelist;
153 int users;
154
155 /* various device info */
156 unsigned int resources;
7c3f53ec 157 struct video_device *vfd;
9701dc94
MCC
158 struct tm6000_dmaqueue vidq;
159
160 int input;
161 int freq;
162 unsigned int fourcc;
163
164 enum tm6000_mode mode;
165
3169c9b2
ML
166 /* DVB-T support */
167 struct tm6000_dvb *dvb;
168
9701dc94
MCC
169 /* locks */
170 struct mutex lock;
171
172 /* usb transfer */
173 struct usb_device *udev; /* the usb device */
174
175 struct usb_host_endpoint *bulk_in, *bulk_out, *isoc_in, *isoc_out;
176 unsigned int max_bulk_in, max_bulk_out;
177 unsigned int max_isoc_in, max_isoc_out;
178
179 /* scaler!=0 if scaler is active*/
180 int scaler;
181
182 /* Isoc control struct */
183 struct usb_isoc_ctl isoc_ctl;
184
185 spinlock_t slock;
186};
187
188struct tm6000_fh {
189 struct tm6000_core *dev;
190
191 /* video capture */
192 struct tm6000_fmt *fmt;
193 unsigned int width,height;
194 struct videobuf_queue vb_vidq;
195
196 enum v4l2_buf_type type;
197};
198
199#define TM6000_STD V4L2_STD_PAL|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc| \
200 V4L2_STD_PAL_M|V4L2_STD_PAL_60|V4L2_STD_NTSC_M| \
201 V4L2_STD_NTSC_M_JP|V4L2_STD_SECAM
202
203/* In tm6000-core.c */
9701dc94
MCC
204
205int tm6000_read_write_usb (struct tm6000_core *dev, u8 reqtype, u8 req,
206 u16 value, u16 index, u8 *buf, u16 len);
207int tm6000_get_reg (struct tm6000_core *dev, u8 req, u16 value, u16 index);
208int tm6000_set_reg (struct tm6000_core *dev, u8 req, u16 value, u16 index);
209int tm6000_init (struct tm6000_core *dev);
210int tm6000_init_after_firmware (struct tm6000_core *dev);
211
212int tm6000_init_analog_mode (struct tm6000_core *dev);
3169c9b2 213int tm6000_init_digital_mode (struct tm6000_core *dev);
9701dc94
MCC
214int tm6000_set_audio_bitrate (struct tm6000_core *dev, int bitrate);
215
3169c9b2
ML
216int tm6000_dvb_register(struct tm6000_core *dev);
217void tm6000_dvb_unregister(struct tm6000_core *dev);
218
9701dc94
MCC
219int tm6000_v4l2_register(struct tm6000_core *dev);
220int tm6000_v4l2_unregister(struct tm6000_core *dev);
221int tm6000_v4l2_exit(void);
222void tm6000_set_fourcc_format(struct tm6000_core *dev);
223
5200401a
MCC
224/* In tm6000-stds.c */
225void tm6000_get_std_res(struct tm6000_core *dev);
226int tm6000_set_standard (struct tm6000_core *dev, v4l2_std_id *norm);
227
9701dc94
MCC
228/* In tm6000-i2c.c */
229int tm6000_i2c_register(struct tm6000_core *dev);
230int tm6000_i2c_unregister(struct tm6000_core *dev);
231void tm6000_i2c_call_clients(struct tm6000_core *dev, unsigned int cmd,
232 void *arg);
233
234/* In tm6000-queue.c */
235
236int tm6000_v4l2_mmap(struct file *filp, struct vm_area_struct *vma);
237
238int tm6000_vidioc_streamon(struct file *file, void *priv,
239 enum v4l2_buf_type i);
240int tm6000_vidioc_streamoff(struct file *file, void *priv,
241 enum v4l2_buf_type i);
242int tm6000_vidioc_reqbufs (struct file *file, void *priv,
243 struct v4l2_requestbuffers *rb);
244int tm6000_vidioc_querybuf (struct file *file, void *priv,
245 struct v4l2_buffer *b);
246int tm6000_vidioc_qbuf (struct file *file, void *priv, struct v4l2_buffer *b);
247int tm6000_vidioc_dqbuf (struct file *file, void *priv, struct v4l2_buffer *b);
248ssize_t tm6000_v4l2_read(struct file *filp, char __user * buf, size_t count,
249 loff_t * f_pos);
250unsigned int tm6000_v4l2_poll(struct file *file,
251 struct poll_table_struct *wait);
252int tm6000_queue_init(struct tm6000_core *dev);
253
576d5739
MCC
254/* In tm6000-alsa.c */
255int tm6000_audio_init(struct tm6000_core *dev, int idx);
256
257
9701dc94
MCC
258/* Debug stuff */
259
260extern int tm6000_debug;
261
262#define dprintk(dev, level, fmt, arg...) do {\
263 if (tm6000_debug & level) \
264 printk(KERN_INFO "(%lu) %s %s :"fmt, jiffies, \
265 dev->name, __FUNCTION__ , ##arg); } while (0)
266
267#define V4L2_DEBUG_REG 0x0004
268#define V4L2_DEBUG_I2C 0x0008
269#define V4L2_DEBUG_QUEUE 0x0010
270#define V4L2_DEBUG_ISOC 0x0020
271#define V4L2_DEBUG_RES_LOCK 0x0040 /* Resource locking */
272#define V4L2_DEBUG_OPEN 0x0080 /* video open/close debug */
273
274#define tm6000_err(fmt, arg...) do {\
275 printk(KERN_ERR "tm6000 %s :"fmt, \
276 __FUNCTION__ , ##arg); } while (0)
277
278