[PATCH] dvb: usb: add VideoWalker DVB-T USB ids
[linux-2.6.git] / drivers / media / dvb / dvb-usb / dvb-usb.h
1 /* dvb-usb.h is part of the DVB USB library.
2  *
3  * Copyright (C) 2004-5 Patrick Boettcher (patrick.boettcher@desy.de)
4  * see dvb-usb-init.c for copyright information.
5  *
6  * the headerfile, all dvb-usb-drivers have to include.
7  */
8 #ifndef __DVB_USB_H__
9 #define __DVB_USB_H__
10
11 #include <linux/config.h>
12 #include <linux/input.h>
13 #include <linux/module.h>
14 #include <linux/usb.h>
15
16 #include "dvb_frontend.h"
17 #include "dvb_demux.h"
18 #include "dvb_net.h"
19 #include "dmxdev.h"
20
21 #include "dvb-pll.h"
22
23 #include "dvb-usb-ids.h"
24
25 /* debug */
26 #ifdef CONFIG_DVB_USB_DEBUG
27 #define dprintk(var,level,args...) \
28             do { if ((var & level)) { printk(args); } } while (0)
29
30 #define debug_dump(b,l,func) {\
31         int loop_; \
32         for (loop_ = 0; loop_ < l; loop_++) func("%02x ", b[loop_]); \
33         func("\n");\
34 }
35 #define DVB_USB_DEBUG_STATUS
36 #else
37 #define dprintk(args...)
38 #define debug_dump(b,l,func)
39
40 #define DVB_USB_DEBUG_STATUS " (debugging is not enabled)"
41
42 #endif
43
44 /* generic log methods - taken from usb.h */
45 #ifndef DVB_USB_LOG_PREFIX
46  #define DVB_USB_LOG_PREFIX "dvb-usb (please define a log prefix)"
47 #endif
48
49 #undef err
50 #define err(format, arg...)  printk(KERN_ERR     DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
51 #undef info
52 #define info(format, arg...) printk(KERN_INFO    DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
53 #undef warn
54 #define warn(format, arg...) printk(KERN_WARNING DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
55
56 /**
57  * struct dvb_usb_device_description - name and its according USB IDs
58  * @name: real name of the box, regardless which DVB USB device class is in use
59  * @cold_ids: array of struct usb_device_id which describe the device in
60  *  pre-firmware state
61  * @warm_ids: array of struct usb_device_id which describe the device in
62  *  post-firmware state
63  *
64  * Each DVB USB device class can have one or more actual devices, this struct
65  * assigns a name to it.
66  */
67 struct dvb_usb_device_description {
68         const char *name;
69
70 #define DVB_USB_ID_MAX_NUM 15
71         struct usb_device_id *cold_ids[DVB_USB_ID_MAX_NUM];
72         struct usb_device_id *warm_ids[DVB_USB_ID_MAX_NUM];
73 };
74
75 /**
76  * struct dvb_usb_rc_key - a remote control key and its input-event
77  * @custom: the vendor/custom part of the key
78  * @data: the actual key part
79  * @event: the input event assigned to key identified by custom and data
80  */
81 struct dvb_usb_rc_key {
82         u8 custom,data;
83         u32 event;
84 };
85
86 struct dvb_usb_device;
87
88 /**
89  * struct dvb_usb_properties - properties of a dvb-usb-device
90  * @caps: capabilites of the DVB USB device.
91  * @pid_filter_count: number of PID filter position in the optional hardware
92  *  PID-filter.
93  *
94  * @usb_ctrl: which USB device-side controller is in use. Needed for firmware
95  *  download.
96  * @firmware: name of the firmware file.
97  *
98  * @size_of_priv: how many bytes shall be allocated for the private field
99  *  of struct dvb_usb_device.
100  *
101  * @power_ctrl: called to enable/disable power of the device.
102  * @streaming_crtl: called to start and stop the MPEG2-TS streaming of the
103  *  device (not URB submitting/killing).
104  * @pid_filter_ctrl: called to en/disable the PID filter, if any.
105  * @pid_filter: called to set/unset a PID for filtering.
106  *
107  * @read_mac_address: called to read the MAC address of the device.
108  *
109  * @frontend_attach: called to attach the possible frontends (fill fe-field
110  *  of struct dvb_usb_device).
111  * @tuner_attach: called to attach the correct tuner and to fill pll_addr,
112  *  pll_desc and pll_init_buf of struct dvb_usb_device).
113  * @identify_state: called to determine the state (cold or warm), when it
114  *  is not distinguishable by the USB IDs.
115  *
116  * @rc_key_map: a hard-wired array of struct dvb_usb_rc_key (NULL to disable
117  *  remote control handling).
118  * @rc_key_map_size: number of items in @rc_key_map.
119  * @rc_query: called to query an event event.
120  * @rc_interval: time in ms between two queries.
121  *
122  * @i2c_algo: i2c_algorithm if the device has I2CoverUSB.
123  *
124  * @generic_bulk_ctrl_endpoint: most of the DVB USB devices have a generic
125  *  endpoint which received control messages with bulk transfers. When this
126  *  is non-zero, one can use dvb_usb_generic_rw and dvb_usb_generic_write-
127  *  helper functions.
128  *
129  * @urb: describes the kind of USB transfer used for MPEG2-TS-streaming.
130  *  Currently only BULK is implemented
131  *
132  * @num_device_descs: number of struct dvb_usb_device_description in @devices
133  * @devices: array of struct dvb_usb_device_description compatibles with these
134  *  properties.
135  */
136 struct dvb_usb_properties {
137
138 #define DVB_USB_HAS_PID_FILTER               0x01
139 #define DVB_USB_PID_FILTER_CAN_BE_TURNED_OFF 0x02
140 #define DVB_USB_NEED_PID_FILTERING           0x04
141 #define DVB_USB_IS_AN_I2C_ADAPTER            0x08
142         int caps;
143         int pid_filter_count;
144
145 #define CYPRESS_AN2135  0
146 #define CYPRESS_AN2235  1
147 #define CYPRESS_FX2     2
148         int usb_ctrl;
149         const char *firmware;
150
151         int size_of_priv;
152
153         int (*power_ctrl) (struct dvb_usb_device *, int);
154         int (*streaming_ctrl) (struct dvb_usb_device *, int);
155         int (*pid_filter_ctrl) (struct dvb_usb_device *, int);
156         int (*pid_filter) (struct dvb_usb_device *, int, u16, int);
157
158         int (*read_mac_address) (struct dvb_usb_device *, u8 []);
159         int (*frontend_attach) (struct dvb_usb_device *);
160         int (*tuner_attach) (struct dvb_usb_device *);
161
162         int (*identify_state) (struct usb_device *, struct dvb_usb_properties *,
163                         struct dvb_usb_device_description **, int *);
164
165 /* remote control properties */
166 #define REMOTE_NO_KEY_PRESSED      0x00
167 #define REMOTE_KEY_PRESSED         0x01
168 #define REMOTE_KEY_REPEAT          0x02
169         struct dvb_usb_rc_key *rc_key_map;
170         int rc_key_map_size;
171         int (*rc_query) (struct dvb_usb_device *, u32 *, int *);
172         int rc_interval;
173
174         struct i2c_algorithm *i2c_algo;
175
176         int generic_bulk_ctrl_endpoint;
177
178         struct {
179 #define DVB_USB_BULK  1
180 #define DVB_USB_ISOC  2
181                 int type;
182                 int count;
183                 int endpoint;
184
185                 union {
186                         struct {
187                                 int buffersize; /* per URB */
188                         } bulk;
189                         struct {
190                                 int framesperurb;
191                                 int framesize;
192                                 int interval;
193                         } isoc;
194                 } u;
195         } urb;
196
197         int num_device_descs;
198         struct dvb_usb_device_description devices[9];
199 };
200
201
202 /**
203  * struct dvb_usb_device - object of a DVB USB device
204  * @props: copy of the struct dvb_usb_properties this device belongs to.
205  * @desc: pointer to the device's struct dvb_usb_device_description.
206  * @state: initialization and runtime state of the device.
207  *
208  * @udev: pointer to the device's struct usb_device.
209  * @urb_list: array of dynamically allocated struct urb for the MPEG2-TS-
210  *  streaming.
211  *
212  * @buf_num: number of buffer allocated.
213  * @buf_size: size of each buffer in buf_list.
214  * @buf_list: array containing all allocate buffers for streaming.
215  * @dma_addr: list of dma_addr_t for each buffer in buf_list.
216  *
217  * @urbs_initialized: number of URBs initialized.
218  * @urbs_submitted: number of URBs submitted.
219  *
220  * @feedcount: number of reqested feeds (used for streaming-activation)
221  * @pid_filtering: is hardware pid_filtering used or not.
222  *
223  * @usb_sem: semaphore of USB control messages (reading needs two messages)
224  * @i2c_sem: semaphore for i2c-transfers
225  *
226  * @i2c_adap: device's i2c_adapter if it uses I2CoverUSB
227  * @pll_addr: I2C address of the tuner for programming
228  * @pll_init: array containing the initialization buffer
229  * @pll_desc: pointer to the appropriate struct dvb_pll_desc
230  *
231  * @tuner_pass_ctrl: called to (de)activate tuner passthru of the demod or the board
232  *
233  * @dvb_adap: device's dvb_adapter.
234  * @dmxdev: device's dmxdev.
235  * @demux: device's software demuxer.
236  * @dvb_net: device's dvb_net interfaces.
237  * @dvb_frontend: device's frontend.
238  * @max_feed_count: how many feeds can be handled simultaneously by this
239  *  device
240  * @fe_sleep: rerouted frontend-sleep function.
241  * @fe_init: rerouted frontend-init (wakeup) function.
242  * @rc_input_dev: input device for the remote control.
243  * @rc_query_work: struct work_struct frequent rc queries
244  * @last_event: last triggered event
245  * @last_state: last state (no, pressed, repeat)
246  * @owner: owner of the dvb_adapter
247  * @priv: private data of the actual driver (allocate by dvb-usb, size defined
248  *  in size_of_priv of dvb_usb_properties).
249  */
250 struct dvb_usb_device {
251         struct dvb_usb_properties props;
252         struct dvb_usb_device_description *desc;
253
254 #define DVB_USB_STATE_INIT        0x000
255 #define DVB_USB_STATE_URB_LIST    0x001
256 #define DVB_USB_STATE_URB_BUF     0x002
257 #define DVB_USB_STATE_DVB         0x004
258 #define DVB_USB_STATE_I2C         0x008
259 #define DVB_USB_STATE_REMOTE      0x010
260 #define DVB_USB_STATE_URB_SUBMIT  0x020
261         int state;
262
263         /* usb */
264         struct usb_device *udev;
265         struct urb **urb_list;
266
267         int buf_num;
268         unsigned long buf_size;
269         u8 **buf_list;
270         dma_addr_t *dma_addr;
271
272         int urbs_initialized;
273         int urbs_submitted;
274
275         int feedcount;
276         int pid_filtering;
277
278         /* locking */
279         struct semaphore usb_sem;
280
281         /* i2c */
282         struct semaphore i2c_sem;
283         struct i2c_adapter i2c_adap;
284
285         /* tuner programming information */
286         u8 pll_addr;
287         u8 pll_init[4];
288         struct dvb_pll_desc *pll_desc;
289         int (*tuner_pass_ctrl)(struct dvb_frontend *, int, u8);
290
291         /* dvb */
292         struct dvb_adapter dvb_adap;
293         struct dmxdev dmxdev;
294         struct dvb_demux demux;
295         struct dvb_net dvb_net;
296         struct dvb_frontend* fe;
297         int max_feed_count;
298
299         int (*fe_sleep) (struct dvb_frontend *);
300         int (*fe_init)  (struct dvb_frontend *);
301
302         /* remote control */
303         struct input_dev rc_input_dev;
304         struct work_struct rc_query_work;
305         u32 last_event;
306         int last_state;
307
308         struct module *owner;
309
310         void *priv;
311 };
312
313 extern int dvb_usb_device_init(struct usb_interface *, struct dvb_usb_properties *, struct module *);
314 extern void dvb_usb_device_exit(struct usb_interface *);
315
316 /* the generic read/write method for device control */
317 extern int dvb_usb_generic_rw(struct dvb_usb_device *, u8 *, u16, u8 *, u16,int);
318 extern int dvb_usb_generic_write(struct dvb_usb_device *, u8 *, u16);
319
320 /* commonly used remote control parsing */
321 extern int dvb_usb_nec_rc_key_to_event(struct dvb_usb_device *, u8[], u32 *, int *);
322
323 /* commonly used pll init and set functions */
324 extern int dvb_usb_pll_init_i2c(struct dvb_frontend *);
325 extern int dvb_usb_pll_set(struct dvb_frontend *, struct dvb_frontend_parameters *, u8[]);
326 extern int dvb_usb_pll_set_i2c(struct dvb_frontend *, struct dvb_frontend_parameters *);
327
328
329 #endif