Commit | Line | Data |
---|---|---|
c79b339f AP |
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 | ||
78 | static inline u8 rc5_custom(struct rc_map_table *key) | |
79 | { | |
80 | return (key->scancode >> 8) & 0xff; | |
81 | } | |
82 | ||
83 | static inline u8 rc5_data(struct rc_map_table *key) | |
84 | { | |
85 | return key->scancode & 0xff; | |
86 | } | |
87 | ||
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 | #define DVB_USB_ADAP_RECEIVES_RAW_PAYLOAD 0x10 | |
145 | int caps; | |
146 | int pid_filter_count; | |
147 | ||
148 | int (*streaming_ctrl) (struct dvb_usb_adapter *, int); | |
149 | int (*pid_filter_ctrl) (struct dvb_usb_adapter *, int); | |
150 | int (*pid_filter) (struct dvb_usb_adapter *, int, u16, int); | |
151 | ||
152 | int (*frontend_attach) (struct dvb_usb_adapter *); | |
153 | int (*tuner_attach) (struct dvb_usb_adapter *); | |
154 | ||
155 | struct usb_data_stream_properties stream; | |
156 | ||
157 | int size_of_priv; | |
158 | }; | |
159 | ||
160 | #define MAX_NO_OF_FE_PER_ADAP 3 | |
161 | struct dvb_usb_adapter_properties { | |
162 | int size_of_priv; | |
163 | ||
164 | int (*frontend_ctrl) (struct dvb_frontend *, int); | |
165 | int (*fe_ioctl_override) (struct dvb_frontend *, | |
166 | unsigned int, void *, unsigned int); | |
167 | ||
168 | int num_frontends; | |
169 | struct dvb_usb_adapter_fe_properties fe[MAX_NO_OF_FE_PER_ADAP]; | |
170 | }; | |
171 | ||
172 | /** | |
173 | * struct dvb_rc_legacy - old properties of remote controller | |
174 | * @rc_map_table: a hard-wired array of struct rc_map_table (NULL to disable | |
175 | * remote control handling). | |
176 | * @rc_map_size: number of items in @rc_map_table. | |
177 | * @rc_query: called to query an event event. | |
178 | * @rc_interval: time in ms between two queries. | |
179 | */ | |
180 | struct dvb_rc_legacy { | |
181 | /* remote control properties */ | |
182 | #define REMOTE_NO_KEY_PRESSED 0x00 | |
183 | #define REMOTE_KEY_PRESSED 0x01 | |
184 | #define REMOTE_KEY_REPEAT 0x02 | |
185 | struct rc_map_table *rc_map_table; | |
186 | int rc_map_size; | |
187 | int (*rc_query) (struct dvb_usb_device *, u32 *, int *); | |
188 | int rc_interval; | |
189 | }; | |
190 | ||
191 | /** | |
192 | * struct dvb_rc properties of remote controller, using rc-core | |
193 | * @rc_codes: name of rc codes table | |
194 | * @protocol: type of protocol(s) currently used by the driver | |
195 | * @allowed_protos: protocol(s) supported by the driver | |
196 | * @driver_type: Used to point if a device supports raw mode | |
197 | * @change_protocol: callback to change protocol | |
198 | * @rc_query: called to query an event event. | |
199 | * @rc_interval: time in ms between two queries. | |
200 | * @bulk_mode: device supports bulk mode for RC (disable polling mode) | |
201 | */ | |
202 | struct dvb_rc { | |
203 | char *rc_codes; | |
204 | u64 protocol; | |
205 | u64 allowed_protos; | |
206 | enum rc_driver_type driver_type; | |
207 | int (*change_protocol)(struct rc_dev *dev, u64 rc_type); | |
208 | char *module_name; | |
209 | int (*rc_query) (struct dvb_usb_device *d); | |
210 | int rc_interval; | |
211 | bool bulk_mode; /* uses bulk mode */ | |
212 | }; | |
213 | ||
214 | /** | |
215 | * enum dvb_usb_mode - Specifies if it is using a legacy driver or a new one | |
216 | * based on rc-core | |
217 | * This is initialized/used only inside dvb-usb-remote.c. | |
218 | * It shouldn't be set by the drivers. | |
219 | */ | |
220 | enum dvb_usb_mode { | |
221 | DVB_RC_LEGACY, | |
222 | DVB_RC_CORE, | |
223 | }; | |
224 | ||
225 | /** | |
226 | * struct dvb_usb_device_properties - properties of a dvb-usb-device | |
654e62dc | 227 | * @owner: owner of the dvb_adapter |
c79b339f AP |
228 | * @usb_ctrl: which USB device-side controller is in use. Needed for firmware |
229 | * download. | |
230 | * @firmware: name of the firmware file. | |
231 | * @download_firmware: called to download the firmware when the usb_ctrl is | |
232 | * DEVICE_SPECIFIC. | |
233 | * @no_reconnect: device doesn't do a reconnect after downloading the firmware, | |
234 | * so do the warm initialization right after it | |
235 | * | |
236 | * @size_of_priv: how many bytes shall be allocated for the private field | |
237 | * of struct dvb_usb_device. | |
238 | * | |
239 | * @power_ctrl: called to enable/disable power of the device. | |
240 | * @read_mac_address: called to read the MAC address of the device. | |
241 | * @identify_state: called to determine the state (cold or warm), when it | |
242 | * is not distinguishable by the USB IDs. | |
dc786937 AP |
243 | * @init: called after adapters are created in order to finalize device |
244 | * configuration. | |
c79b339f AP |
245 | * |
246 | * @rc: remote controller properties | |
247 | * | |
248 | * @i2c_algo: i2c_algorithm if the device has I2CoverUSB. | |
249 | * | |
250 | * @generic_bulk_ctrl_endpoint: most of the DVB USB devices have a generic | |
251 | * endpoint which received control messages with bulk transfers. When this | |
252 | * is non-zero, one can use dvb_usb_generic_rw and dvb_usb_generic_write- | |
253 | * helper functions. | |
254 | * | |
255 | * @generic_bulk_ctrl_endpoint_response: some DVB USB devices use a separate | |
256 | * endpoint for responses to control messages sent with bulk transfers via | |
257 | * the generic_bulk_ctrl_endpoint. When this is non-zero, this will be used | |
258 | * instead of the generic_bulk_ctrl_endpoint when reading usb responses in | |
259 | * the dvb_usb_generic_rw helper function. | |
260 | * | |
261 | * @num_device_descs: number of struct dvb_usb_device_description in @devices | |
262 | * @devices: array of struct dvb_usb_device_description compatibles with these | |
263 | * properties. | |
264 | */ | |
265 | #define MAX_NO_OF_ADAPTER_PER_DEVICE 2 | |
266 | struct dvb_usb_device_properties { | |
654e62dc | 267 | struct module *owner; |
c79b339f AP |
268 | |
269 | #define DVB_USB_IS_AN_I2C_ADAPTER 0x01 | |
270 | int caps; | |
271 | ||
272 | #define DEVICE_SPECIFIC 0 | |
273 | #define CYPRESS_AN2135 1 | |
274 | #define CYPRESS_AN2235 2 | |
275 | #define CYPRESS_FX2 3 | |
276 | int usb_ctrl; | |
277 | int (*download_firmware) (struct usb_device *, const struct firmware *); | |
278 | const char *firmware; | |
279 | int no_reconnect; | |
280 | ||
281 | int size_of_priv; | |
282 | ||
283 | int num_adapters; | |
284 | struct dvb_usb_adapter_properties adapter[MAX_NO_OF_ADAPTER_PER_DEVICE]; | |
285 | ||
286 | int (*power_ctrl) (struct dvb_usb_device *, int); | |
287 | int (*read_mac_address) (struct dvb_usb_device *, u8 []); | |
288 | int (*identify_state) (struct usb_device *, struct dvb_usb_device_properties *, | |
289 | struct dvb_usb_device_description **, int *); | |
dc786937 | 290 | int (*init) (struct dvb_usb_device *); |
c79b339f AP |
291 | |
292 | struct { | |
293 | enum dvb_usb_mode mode; /* Drivers shouldn't touch on it */ | |
294 | struct dvb_rc_legacy legacy; | |
295 | struct dvb_rc core; | |
296 | } rc; | |
297 | ||
298 | struct i2c_algorithm *i2c_algo; | |
299 | ||
300 | int generic_bulk_ctrl_endpoint; | |
301 | int generic_bulk_ctrl_endpoint_response; | |
302 | ||
303 | int num_device_descs; | |
304 | struct dvb_usb_device_description devices[12]; | |
305 | }; | |
306 | ||
307 | /** | |
308 | * struct usb_data_stream - generic object of an USB stream | |
309 | * @buf_num: number of buffer allocated. | |
310 | * @buf_size: size of each buffer in buf_list. | |
311 | * @buf_list: array containing all allocate buffers for streaming. | |
312 | * @dma_addr: list of dma_addr_t for each buffer in buf_list. | |
313 | * | |
314 | * @urbs_initialized: number of URBs initialized. | |
315 | * @urbs_submitted: number of URBs submitted. | |
316 | */ | |
317 | #define MAX_NO_URBS_FOR_DATA_STREAM 10 | |
318 | struct usb_data_stream { | |
319 | struct usb_device *udev; | |
320 | struct usb_data_stream_properties props; | |
321 | ||
322 | #define USB_STATE_INIT 0x00 | |
323 | #define USB_STATE_URB_BUF 0x01 | |
324 | int state; | |
325 | ||
326 | void (*complete) (struct usb_data_stream *, u8 *, size_t); | |
327 | ||
328 | struct urb *urb_list[MAX_NO_URBS_FOR_DATA_STREAM]; | |
329 | int buf_num; | |
330 | unsigned long buf_size; | |
331 | u8 *buf_list[MAX_NO_URBS_FOR_DATA_STREAM]; | |
332 | dma_addr_t dma_addr[MAX_NO_URBS_FOR_DATA_STREAM]; | |
333 | ||
334 | int urbs_initialized; | |
335 | int urbs_submitted; | |
336 | ||
337 | void *user_priv; | |
338 | }; | |
339 | ||
340 | /** | |
341 | * struct dvb_usb_adapter - a DVB adapter on a USB device | |
342 | * @id: index of this adapter (starting with 0). | |
343 | * | |
344 | * @feedcount: number of reqested feeds (used for streaming-activation) | |
345 | * @pid_filtering: is hardware pid_filtering used or not. | |
346 | * | |
347 | * @pll_addr: I2C address of the tuner for programming | |
348 | * @pll_init: array containing the initialization buffer | |
349 | * @pll_desc: pointer to the appropriate struct dvb_pll_desc | |
350 | * @tuner_pass_ctrl: called to (de)activate tuner passthru of the demod or the board | |
351 | * | |
352 | * @dvb_adap: device's dvb_adapter. | |
353 | * @dmxdev: device's dmxdev. | |
354 | * @demux: device's software demuxer. | |
355 | * @dvb_net: device's dvb_net interfaces. | |
356 | * @dvb_frontend: device's frontend. | |
357 | * @max_feed_count: how many feeds can be handled simultaneously by this | |
358 | * device | |
359 | * | |
360 | * @fe_init: rerouted frontend-init (wakeup) function. | |
361 | * @fe_sleep: rerouted frontend-sleep function. | |
362 | * | |
363 | * @stream: the usb data stream. | |
364 | */ | |
365 | struct dvb_usb_fe_adapter { | |
366 | struct dvb_frontend *fe; | |
367 | ||
368 | int (*fe_init) (struct dvb_frontend *); | |
369 | int (*fe_sleep) (struct dvb_frontend *); | |
370 | ||
371 | struct usb_data_stream stream; | |
372 | ||
373 | int pid_filtering; | |
374 | int max_feed_count; | |
375 | ||
376 | void *priv; | |
377 | }; | |
378 | ||
379 | struct dvb_usb_adapter { | |
380 | struct dvb_usb_device *dev; | |
381 | struct dvb_usb_adapter_properties props; | |
382 | ||
383 | #define DVB_USB_ADAP_STATE_INIT 0x000 | |
384 | #define DVB_USB_ADAP_STATE_DVB 0x001 | |
385 | int state; | |
386 | ||
387 | u8 id; | |
388 | ||
389 | int feedcount; | |
390 | ||
391 | /* dvb */ | |
392 | struct dvb_adapter dvb_adap; | |
393 | struct dmxdev dmxdev; | |
394 | struct dvb_demux demux; | |
395 | struct dvb_net dvb_net; | |
396 | ||
397 | struct dvb_usb_fe_adapter fe_adap[MAX_NO_OF_FE_PER_ADAP]; | |
398 | int active_fe; | |
399 | int num_frontends_initialized; | |
400 | ||
401 | void *priv; | |
402 | }; | |
403 | ||
404 | /** | |
405 | * struct dvb_usb_device - object of a DVB USB device | |
406 | * @props: copy of the struct dvb_usb_properties this device belongs to. | |
407 | * @desc: pointer to the device's struct dvb_usb_device_description. | |
408 | * @state: initialization and runtime state of the device. | |
409 | * | |
410 | * @powered: indicated whether the device is power or not. | |
411 | * Powered is in/decremented for each call to modify the state. | |
412 | * @udev: pointer to the device's struct usb_device. | |
413 | * | |
414 | * @usb_mutex: semaphore of USB control messages (reading needs two messages) | |
415 | * @i2c_mutex: semaphore for i2c-transfers | |
416 | * | |
417 | * @i2c_adap: device's i2c_adapter if it uses I2CoverUSB | |
418 | * | |
419 | * @rc_dev: rc device for the remote control (rc-core mode) | |
420 | * @input_dev: input device for the remote control (legacy mode) | |
421 | * @rc_query_work: struct work_struct frequent rc queries | |
422 | * @last_event: last triggered event | |
423 | * @last_state: last state (no, pressed, repeat) | |
c79b339f AP |
424 | * @priv: private data of the actual driver (allocate by dvb-usb, size defined |
425 | * in size_of_priv of dvb_usb_properties). | |
426 | */ | |
427 | struct dvb_usb_device { | |
428 | struct dvb_usb_device_properties props; | |
429 | struct dvb_usb_device_description *desc; | |
430 | ||
431 | struct usb_device *udev; | |
432 | ||
433 | #define DVB_USB_STATE_INIT 0x000 | |
434 | #define DVB_USB_STATE_I2C 0x001 | |
435 | #define DVB_USB_STATE_DVB 0x002 | |
436 | #define DVB_USB_STATE_REMOTE 0x004 | |
437 | int state; | |
438 | ||
439 | int powered; | |
440 | ||
441 | /* locking */ | |
442 | struct mutex usb_mutex; | |
443 | ||
444 | /* i2c */ | |
445 | struct mutex i2c_mutex; | |
446 | struct i2c_adapter i2c_adap; | |
447 | ||
448 | int num_adapters_initialized; | |
449 | struct dvb_usb_adapter adapter[MAX_NO_OF_ADAPTER_PER_DEVICE]; | |
450 | ||
451 | /* remote control */ | |
452 | struct rc_dev *rc_dev; | |
453 | struct input_dev *input_dev; | |
454 | char rc_phys[64]; | |
455 | struct delayed_work rc_query_work; | |
456 | u32 last_event; | |
457 | int last_state; | |
458 | ||
c79b339f AP |
459 | void *priv; |
460 | }; | |
461 | ||
462 | extern int dvb_usbv2_device_init(struct usb_interface *, | |
65871deb | 463 | const struct usb_device_id *, |
c79b339f AP |
464 | short *adapter_nums); |
465 | extern void dvb_usbv2_device_exit(struct usb_interface *); | |
466 | ||
467 | /* the generic read/write method for device control */ | |
468 | extern int dvb_usbv2_generic_rw(struct dvb_usb_device *, u8 *, u16, u8 *, u16,int); | |
469 | extern int dvb_usbv2_generic_write(struct dvb_usb_device *, u8 *, u16); | |
470 | ||
471 | /* commonly used remote control parsing */ | |
472 | extern int dvb_usbv2_nec_rc_key_to_event(struct dvb_usb_device *, u8[], u32 *, int *); | |
473 | ||
474 | /* commonly used firmware download types and function */ | |
475 | struct hexline { | |
476 | u8 len; | |
477 | u32 addr; | |
478 | u8 type; | |
479 | u8 data[255]; | |
480 | u8 chk; | |
481 | }; | |
482 | extern int usbv2_cypress_load_firmware(struct usb_device *udev, const struct firmware *fw, int type); | |
483 | extern int dvb_usbv2_get_hexline(const struct firmware *fw, struct hexline *hx, int *pos); | |
484 | ||
485 | ||
486 | #endif |