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