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