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