1 /* dvb-usb.h is part of the DVB USB library.
2 *
3 * Copyright (C) 2004-6 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 * TODO: clean-up the structures for unused fields and update the comments
9 */
10 #ifndef __DVB_USB_H__
11 #define __DVB_USB_H__
12
13 #include <linux/input.h>
14 #include <linux/usb.h>
15 #include <linux/firmware.h>
16 #include <linux/mutex.h>
17 #include <media/rc-core.h>
18
19 #include "dvb_frontend.h"
20 #include "dvb_demux.h"
21 #include "dvb_net.h"
22 #include "dmxdev.h"
23
24 #include "dvb-pll.h"
25
26 #include "dvb-usb-ids.h"
27
28 /* debug */
29 #ifdef CONFIG_DVB_USB_DEBUG
30 #define dprintk(var,level,args...) \
31 do { if ((var & level)) { printk(args); } } while (0)
32
33 #define debug_dump(b,l,func) {\
34 int loop_; \
35 for (loop_ = 0; loop_ < l; loop_++) func("%02x ", b[loop_]); \
36 func("\n");\
37 }
38 #define DVB_USB_DEBUG_STATUS
39 #else
40 #define dprintk(args...)
41 #define debug_dump(b,l,func)
42
43 #define DVB_USB_DEBUG_STATUS " (debugging is not enabled)"
44
45 #endif
46
47 /* generic log methods - taken from usb.h */
48 #ifndef DVB_USB_LOG_PREFIX
49 #define DVB_USB_LOG_PREFIX "dvb-usb (please define a log prefix)"
50 #endif
51
52 #undef err
53 #define err(format, arg...) printk(KERN_ERR DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
54 #undef info
55 #define info(format, arg...) printk(KERN_INFO DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
56 #undef warn
57 #define warn(format, arg...) printk(KERN_WARNING DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
58
59 /**
60 * struct dvb_usb_device_description - name and its according USB IDs
61 * @name: real name of the box, regardless which DVB USB device class is in use
62 * @cold_ids: array of struct usb_device_id which describe the device in
63 * pre-firmware state
64 * @warm_ids: array of struct usb_device_id which describe the device in
65 * post-firmware state
66 *
67 * Each DVB USB device class can have one or more actual devices, this struct
68 * assigns a name to it.
69 */
70 struct dvb_usb_device_description {
71 const char *name;
72
73 #define DVB_USB_ID_MAX_NUM 15
74 struct usb_device_id *cold_ids[DVB_USB_ID_MAX_NUM];
75 struct usb_device_id *warm_ids[DVB_USB_ID_MAX_NUM];
76 };
77
rc5_custom(struct rc_map_table * key)78 static inline u8 rc5_custom(struct rc_map_table *key)
79 {
80 return (key->scancode >> 8) & 0xff;
81 }
82
rc5_data(struct rc_map_table * key)83 static inline u8 rc5_data(struct rc_map_table *key)
84 {
85 return key->scancode & 0xff;
86 }
87
rc5_scan(struct rc_map_table * key)88 static inline u16 rc5_scan(struct rc_map_table *key)
89 {
90 return key->scancode & 0xffff;
91 }
92
93 struct dvb_usb_device;
94 struct dvb_usb_adapter;
95 struct usb_data_stream;
96
97 /**
98 * Properties of USB streaming - TODO this structure should be somewhere else
99 * describes the kind of USB transfer used for data-streaming.
100 * (BULK or ISOC)
101 */
102 struct usb_data_stream_properties {
103 #define USB_BULK 1
104 #define USB_ISOC 2
105 int type;
106 int count;
107 int endpoint;
108
109 union {
110 struct {
111 int buffersize; /* per URB */
112 } bulk;
113 struct {
114 int framesperurb;
115 int framesize;
116 int interval;
117 } isoc;
118 } u;
119 };
120
121 /**
122 * struct dvb_usb_adapter_properties - properties of a dvb-usb-adapter.
123 * A DVB-USB-Adapter is basically a dvb_adapter which is present on a USB-device.
124 * @caps: capabilities of the DVB USB device.
125 * @pid_filter_count: number of PID filter position in the optional hardware
126 * PID-filter.
127 * @num_frontends: number of frontends of the DVB USB adapter.
128 * @frontend_ctrl: called to power on/off active frontend.
129 * @streaming_ctrl: called to start and stop the MPEG2-TS streaming of the
130 * device (not URB submitting/killing).
131 * @pid_filter_ctrl: called to en/disable the PID filter, if any.
132 * @pid_filter: called to set/unset a PID for filtering.
133 * @frontend_attach: called to attach the possible frontends (fill fe-field
134 * of struct dvb_usb_device).
135 * @tuner_attach: called to attach the correct tuner and to fill pll_addr,
136 * pll_desc and pll_init_buf of struct dvb_usb_device).
137 * @stream: configuration of the USB streaming
138 */
139 struct dvb_usb_adapter_fe_properties {
140 #define DVB_USB_ADAP_HAS_PID_FILTER 0x01
141 #define DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF 0x02
142 #define DVB_USB_ADAP_NEED_PID_FILTERING 0x04
143 #define DVB_USB_ADAP_RECEIVES_204_BYTE_TS 0x08
144 int caps;
145 int pid_filter_count;
146
147 int (*streaming_ctrl) (struct dvb_usb_adapter *, int);
148 int (*pid_filter_ctrl) (struct dvb_usb_adapter *, int);
149 int (*pid_filter) (struct dvb_usb_adapter *, int, u16, int);
150
151 int (*frontend_attach) (struct dvb_usb_adapter *);
152 int (*tuner_attach) (struct dvb_usb_adapter *);
153
154 struct usb_data_stream_properties stream;
155
156 int size_of_priv;
157 };
158
159 #define MAX_NO_OF_FE_PER_ADAP 2
160 struct dvb_usb_adapter_properties {
161 int size_of_priv;
162
163 int (*frontend_ctrl) (struct dvb_frontend *, int);
164 int (*fe_ioctl_override) (struct dvb_frontend *,
165 unsigned int, void *, unsigned int);
166
167 int num_frontends;
168 struct dvb_usb_adapter_fe_properties fe[MAX_NO_OF_FE_PER_ADAP];
169 };
170
171 /**
172 * struct dvb_rc_legacy - old properties of remote controller
173 * @rc_map_table: a hard-wired array of struct rc_map_table (NULL to disable
174 * remote control handling).
175 * @rc_map_size: number of items in @rc_map_table.
176 * @rc_query: called to query an event event.
177 * @rc_interval: time in ms between two queries.
178 */
179 struct dvb_rc_legacy {
180 /* remote control properties */
181 #define REMOTE_NO_KEY_PRESSED 0x00
182 #define REMOTE_KEY_PRESSED 0x01
183 #define REMOTE_KEY_REPEAT 0x02
184 struct rc_map_table *rc_map_table;
185 int rc_map_size;
186 int (*rc_query) (struct dvb_usb_device *, u32 *, int *);
187 int rc_interval;
188 };
189
190 /**
191 * struct dvb_rc properties of remote controller, using rc-core
192 * @rc_codes: name of rc codes table
193 * @protocol: type of protocol(s) currently used by the driver
194 * @allowed_protos: protocol(s) supported by the driver
195 * @driver_type: Used to point if a device supports raw mode
196 * @change_protocol: callback to change protocol
197 * @rc_query: called to query an event event.
198 * @rc_interval: time in ms between two queries.
199 * @bulk_mode: device supports bulk mode for RC (disable polling mode)
200 */
201 struct dvb_rc {
202 char *rc_codes;
203 u64 protocol;
204 u64 allowed_protos;
205 enum rc_driver_type driver_type;
206 int (*change_protocol)(struct rc_dev *dev, u64 rc_type);
207 char *module_name;
208 int (*rc_query) (struct dvb_usb_device *d);
209 int rc_interval;
210 bool bulk_mode; /* uses bulk mode */
211 };
212
213 /**
214 * enum dvb_usb_mode - Specifies if it is using a legacy driver or a new one
215 * based on rc-core
216 * This is initialized/used only inside dvb-usb-remote.c.
217 * It shouldn't be set by the drivers.
218 */
219 enum dvb_usb_mode {
220 DVB_RC_LEGACY,
221 DVB_RC_CORE,
222 };
223
224 /**
225 * struct dvb_usb_device_properties - properties of a dvb-usb-device
226 * @usb_ctrl: which USB device-side controller is in use. Needed for firmware
227 * download.
228 * @firmware: name of the firmware file.
229 * @download_firmware: called to download the firmware when the usb_ctrl is
230 * DEVICE_SPECIFIC.
231 * @no_reconnect: device doesn't do a reconnect after downloading the firmware,
232 * so do the warm initialization right after it
233 *
234 * @size_of_priv: how many bytes shall be allocated for the private field
235 * of struct dvb_usb_device.
236 *
237 * @power_ctrl: called to enable/disable power of the device.
238 * @read_mac_address: called to read the MAC address of the device.
239 * @identify_state: called to determine the state (cold or warm), when it
240 * is not distinguishable by the USB IDs.
241 *
242 * @rc: remote controller properties
243 *
244 * @i2c_algo: i2c_algorithm if the device has I2CoverUSB.
245 *
246 * @generic_bulk_ctrl_endpoint: most of the DVB USB devices have a generic
247 * endpoint which received control messages with bulk transfers. When this
248 * is non-zero, one can use dvb_usb_generic_rw and dvb_usb_generic_write-
249 * helper functions.
250 *
251 * @generic_bulk_ctrl_endpoint_response: some DVB USB devices use a separate
252 * endpoint for responses to control messages sent with bulk transfers via
253 * the generic_bulk_ctrl_endpoint. When this is non-zero, this will be used
254 * instead of the generic_bulk_ctrl_endpoint when reading usb responses in
255 * the dvb_usb_generic_rw helper function.
256 *
257 * @num_device_descs: number of struct dvb_usb_device_description in @devices
258 * @devices: array of struct dvb_usb_device_description compatibles with these
259 * properties.
260 */
261 #define MAX_NO_OF_ADAPTER_PER_DEVICE 2
262 struct dvb_usb_device_properties {
263
264 #define DVB_USB_IS_AN_I2C_ADAPTER 0x01
265 int caps;
266
267 #define DEVICE_SPECIFIC 0
268 #define CYPRESS_AN2135 1
269 #define CYPRESS_AN2235 2
270 #define CYPRESS_FX2 3
271 int usb_ctrl;
272 int (*download_firmware) (struct usb_device *, const struct firmware *);
273 const char *firmware;
274 int no_reconnect;
275
276 int size_of_priv;
277
278 int num_adapters;
279 struct dvb_usb_adapter_properties adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];
280
281 int (*power_ctrl) (struct dvb_usb_device *, int);
282 int (*read_mac_address) (struct dvb_usb_device *, u8 []);
283 int (*identify_state) (struct usb_device *, struct dvb_usb_device_properties *,
284 struct dvb_usb_device_description **, int *);
285
286 struct {
287 enum dvb_usb_mode mode; /* Drivers shouldn't touch on it */
288 struct dvb_rc_legacy legacy;
289 struct dvb_rc core;
290 } rc;
291
292 struct i2c_algorithm *i2c_algo;
293
294 int generic_bulk_ctrl_endpoint;
295 int generic_bulk_ctrl_endpoint_response;
296
297 int num_device_descs;
298 struct dvb_usb_device_description devices[12];
299 };
300
301 /**
302 * struct usb_data_stream - generic object of an USB stream
303 * @buf_num: number of buffer allocated.
304 * @buf_size: size of each buffer in buf_list.
305 * @buf_list: array containing all allocate buffers for streaming.
306 * @dma_addr: list of dma_addr_t for each buffer in buf_list.
307 *
308 * @urbs_initialized: number of URBs initialized.
309 * @urbs_submitted: number of URBs submitted.
310 */
311 #define MAX_NO_URBS_FOR_DATA_STREAM 10
312 struct usb_data_stream {
313 struct usb_device *udev;
314 struct usb_data_stream_properties props;
315
316 #define USB_STATE_INIT 0x00
317 #define USB_STATE_URB_BUF 0x01
318 int state;
319
320 void (*complete) (struct usb_data_stream *, u8 *, size_t);
321
322 struct urb *urb_list[MAX_NO_URBS_FOR_DATA_STREAM];
323 int buf_num;
324 unsigned long buf_size;
325 u8 *buf_list[MAX_NO_URBS_FOR_DATA_STREAM];
326 dma_addr_t dma_addr[MAX_NO_URBS_FOR_DATA_STREAM];
327
328 int urbs_initialized;
329 int urbs_submitted;
330
331 void *user_priv;
332 };
333
334 /**
335 * struct dvb_usb_adapter - a DVB adapter on a USB device
336 * @id: index of this adapter (starting with 0).
337 *
338 * @feedcount: number of reqested feeds (used for streaming-activation)
339 * @pid_filtering: is hardware pid_filtering used or not.
340 *
341 * @pll_addr: I2C address of the tuner for programming
342 * @pll_init: array containing the initialization buffer
343 * @pll_desc: pointer to the appropriate struct dvb_pll_desc
344 * @tuner_pass_ctrl: called to (de)activate tuner passthru of the demod or the board
345 *
346 * @dvb_adap: device's dvb_adapter.
347 * @dmxdev: device's dmxdev.
348 * @demux: device's software demuxer.
349 * @dvb_net: device's dvb_net interfaces.
350 * @dvb_frontend: device's frontend.
351 * @max_feed_count: how many feeds can be handled simultaneously by this
352 * device
353 *
354 * @fe_init: rerouted frontend-init (wakeup) function.
355 * @fe_sleep: rerouted frontend-sleep function.
356 *
357 * @stream: the usb data stream.
358 */
359 struct dvb_usb_fe_adapter {
360 struct dvb_frontend *fe;
361
362 int (*fe_init) (struct dvb_frontend *);
363 int (*fe_sleep) (struct dvb_frontend *);
364
365 struct usb_data_stream stream;
366
367 int pid_filtering;
368 int max_feed_count;
369
370 void *priv;
371 };
372
373 struct dvb_usb_adapter {
374 struct dvb_usb_device *dev;
375 struct dvb_usb_adapter_properties props;
376
377 #define DVB_USB_ADAP_STATE_INIT 0x000
378 #define DVB_USB_ADAP_STATE_DVB 0x001
379 int state;
380
381 u8 id;
382
383 int feedcount;
384
385 /* dvb */
386 struct dvb_adapter dvb_adap;
387 struct dmxdev dmxdev;
388 struct dvb_demux demux;
389 struct dvb_net dvb_net;
390
391 struct dvb_usb_fe_adapter fe_adap[MAX_NO_OF_FE_PER_ADAP];
392 int active_fe;
393 int num_frontends_initialized;
394
395 void *priv;
396 };
397
398 /**
399 * struct dvb_usb_device - object of a DVB USB device
400 * @props: copy of the struct dvb_usb_properties this device belongs to.
401 * @desc: pointer to the device's struct dvb_usb_device_description.
402 * @state: initialization and runtime state of the device.
403 *
404 * @powered: indicated whether the device is power or not.
405 * Powered is in/decremented for each call to modify the state.
406 * @udev: pointer to the device's struct usb_device.
407 *
408 * @usb_mutex: semaphore of USB control messages (reading needs two messages)
409 * @i2c_mutex: semaphore for i2c-transfers
410 *
411 * @i2c_adap: device's i2c_adapter if it uses I2CoverUSB
412 *
413 * @rc_dev: rc device for the remote control (rc-core mode)
414 * @input_dev: input device for the remote control (legacy mode)
415 * @rc_query_work: struct work_struct frequent rc queries
416 * @last_event: last triggered event
417 * @last_state: last state (no, pressed, repeat)
418 * @owner: owner of the dvb_adapter
419 * @priv: private data of the actual driver (allocate by dvb-usb, size defined
420 * in size_of_priv of dvb_usb_properties).
421 */
422 struct dvb_usb_device {
423 struct dvb_usb_device_properties props;
424 struct dvb_usb_device_description *desc;
425
426 struct usb_device *udev;
427
428 #define DVB_USB_STATE_INIT 0x000
429 #define DVB_USB_STATE_I2C 0x001
430 #define DVB_USB_STATE_DVB 0x002
431 #define DVB_USB_STATE_REMOTE 0x004
432 int state;
433
434 int powered;
435
436 /* locking */
437 struct mutex usb_mutex;
438
439 /* i2c */
440 struct mutex i2c_mutex;
441 struct i2c_adapter i2c_adap;
442
443 int num_adapters_initialized;
444 struct dvb_usb_adapter adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];
445
446 /* remote control */
447 struct rc_dev *rc_dev;
448 struct input_dev *input_dev;
449 char rc_phys[64];
450 struct delayed_work rc_query_work;
451 u32 last_event;
452 int last_state;
453
454 struct module *owner;
455
456 void *priv;
457 };
458
459 extern int dvb_usb_device_init(struct usb_interface *,
460 struct dvb_usb_device_properties *,
461 struct module *, struct dvb_usb_device **,
462 short *adapter_nums);
463 extern void dvb_usb_device_exit(struct usb_interface *);
464
465 /* the generic read/write method for device control */
466 extern int dvb_usb_generic_rw(struct dvb_usb_device *, u8 *, u16, u8 *, u16,int);
467 extern int dvb_usb_generic_write(struct dvb_usb_device *, u8 *, u16);
468
469 /* commonly used remote control parsing */
470 extern int dvb_usb_nec_rc_key_to_event(struct dvb_usb_device *, u8[], u32 *, int *);
471
472 /* commonly used firmware download types and function */
473 struct hexline {
474 u8 len;
475 u32 addr;
476 u8 type;
477 u8 data[255];
478 u8 chk;
479 };
480 extern int usb_cypress_load_firmware(struct usb_device *udev, const struct firmware *fw, int type);
481 extern int dvb_usb_get_hexline(const struct firmware *fw, struct hexline *hx, int *pos);
482
483
484 #endif
485