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