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  * @pid_filter_ctrl: called to en/disable the PID filter, if any.
133  * @pid_filter: called to set/unset a PID for filtering.
134  * @frontend_attach: called to attach the possible frontends (fill fe-field
135  *  of struct dvb_usb_device).
136  * @tuner_attach: called to attach the correct tuner and to fill pll_addr,
137  *  pll_desc and pll_init_buf of struct dvb_usb_device).
138  * @stream: configuration of the USB streaming
139  */
140 struct dvb_usb_adapter_fe_properties {
141 #define DVB_USB_ADAP_HAS_PID_FILTER               0x01
142 #define DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF 0x02
143 #define DVB_USB_ADAP_NEED_PID_FILTERING           0x04
144 #define DVB_USB_ADAP_RECEIVES_204_BYTE_TS         0x08
145 #define DVB_USB_ADAP_RECEIVES_RAW_PAYLOAD         0x10
146 	int caps;
147 	int pid_filter_count;
148 
149 	int (*streaming_ctrl)  (struct dvb_usb_adapter *, int);
150 	int (*pid_filter_ctrl) (struct dvb_usb_adapter *, int);
151 	int (*pid_filter)      (struct dvb_usb_adapter *, int, u16, int);
152 
153 	int (*frontend_attach) (struct dvb_usb_adapter *);
154 	int (*tuner_attach)    (struct dvb_usb_adapter *);
155 
156 	struct usb_data_stream_properties stream;
157 
158 	int size_of_priv;
159 };
160 
161 #define MAX_NO_OF_FE_PER_ADAP 3
162 struct dvb_usb_adapter_properties {
163 	int size_of_priv;
164 
165 	int (*frontend_ctrl)   (struct dvb_frontend *, 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_proto);
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 	u32 scancode_mask;
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
227  * @usb_ctrl: which USB device-side controller is in use. Needed for firmware
228  *  download.
229  * @firmware: name of the firmware file.
230  * @download_firmware: called to download the firmware when the usb_ctrl is
231  *  DEVICE_SPECIFIC.
232  * @no_reconnect: device doesn't do a reconnect after downloading the firmware,
233  *  so do the warm initialization right after it
234  *
235  * @size_of_priv: how many bytes shall be allocated for the private field
236  *  of struct dvb_usb_device.
237  *
238  * @power_ctrl: called to enable/disable power of the device.
239  * @read_mac_address: called to read the MAC address of the device.
240  * @identify_state: called to determine the state (cold or warm), when it
241  *  is not distinguishable by the USB IDs.
242  *
243  * @rc: remote controller properties
244  *
245  * @i2c_algo: i2c_algorithm if the device has I2CoverUSB.
246  *
247  * @generic_bulk_ctrl_endpoint: most of the DVB USB devices have a generic
248  *  endpoint which received control messages with bulk transfers. When this
249  *  is non-zero, one can use dvb_usb_generic_rw and dvb_usb_generic_write-
250  *  helper functions.
251  *
252  * @generic_bulk_ctrl_endpoint_response: some DVB USB devices use a separate
253  *  endpoint for responses to control messages sent with bulk transfers via
254  *  the generic_bulk_ctrl_endpoint. When this is non-zero, this will be used
255  *  instead of the generic_bulk_ctrl_endpoint when reading usb responses in
256  *  the dvb_usb_generic_rw helper function.
257  *
258  * @num_device_descs: number of struct dvb_usb_device_description in @devices
259  * @devices: array of struct dvb_usb_device_description compatibles with these
260  *  properties.
261  */
262 #define MAX_NO_OF_ADAPTER_PER_DEVICE 2
263 struct dvb_usb_device_properties {
264 
265 #define DVB_USB_IS_AN_I2C_ADAPTER            0x01
266 	int caps;
267 
268 #define DEVICE_SPECIFIC 0
269 #define CYPRESS_AN2135  1
270 #define CYPRESS_AN2235  2
271 #define CYPRESS_FX2     3
272 	int        usb_ctrl;
273 	int        (*download_firmware) (struct usb_device *, const struct firmware *);
274 	const char *firmware;
275 	int        no_reconnect;
276 
277 	int size_of_priv;
278 
279 	int num_adapters;
280 	struct dvb_usb_adapter_properties adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];
281 
282 	int (*power_ctrl)       (struct dvb_usb_device *, int);
283 	int (*read_mac_address) (struct dvb_usb_device *, u8 []);
284 	int (*identify_state)   (struct usb_device *, struct dvb_usb_device_properties *,
285 			struct dvb_usb_device_description **, int *);
286 
287 	struct {
288 		enum dvb_usb_mode mode;	/* Drivers shouldn't touch on it */
289 		struct dvb_rc_legacy legacy;
290 		struct dvb_rc core;
291 	} rc;
292 
293 	struct i2c_algorithm *i2c_algo;
294 
295 	int generic_bulk_ctrl_endpoint;
296 	int generic_bulk_ctrl_endpoint_response;
297 
298 	int num_device_descs;
299 	struct dvb_usb_device_description devices[12];
300 };
301 
302 /**
303  * struct usb_data_stream - generic object of an USB stream
304  * @buf_num: number of buffer allocated.
305  * @buf_size: size of each buffer in buf_list.
306  * @buf_list: array containing all allocate buffers for streaming.
307  * @dma_addr: list of dma_addr_t for each buffer in buf_list.
308  *
309  * @urbs_initialized: number of URBs initialized.
310  * @urbs_submitted: number of URBs submitted.
311  */
312 #define MAX_NO_URBS_FOR_DATA_STREAM 10
313 struct usb_data_stream {
314 	struct usb_device                 *udev;
315 	struct usb_data_stream_properties  props;
316 
317 #define USB_STATE_INIT    0x00
318 #define USB_STATE_URB_BUF 0x01
319 	int state;
320 
321 	void (*complete) (struct usb_data_stream *, u8 *, size_t);
322 
323 	struct urb    *urb_list[MAX_NO_URBS_FOR_DATA_STREAM];
324 	int            buf_num;
325 	unsigned long  buf_size;
326 	u8            *buf_list[MAX_NO_URBS_FOR_DATA_STREAM];
327 	dma_addr_t     dma_addr[MAX_NO_URBS_FOR_DATA_STREAM];
328 
329 	int urbs_initialized;
330 	int urbs_submitted;
331 
332 	void *user_priv;
333 };
334 
335 /**
336  * struct dvb_usb_adapter - a DVB adapter on a USB device
337  * @id: index of this adapter (starting with 0).
338  *
339  * @feedcount: number of requested feeds (used for streaming-activation)
340  * @pid_filtering: is hardware pid_filtering used or not.
341  *
342  * @pll_addr: I2C address of the tuner for programming
343  * @pll_init: array containing the initialization buffer
344  * @pll_desc: pointer to the appropriate struct dvb_pll_desc
345  * @tuner_pass_ctrl: called to (de)activate tuner passthru of the demod or the board
346  *
347  * @dvb_adap: device's dvb_adapter.
348  * @dmxdev: device's dmxdev.
349  * @demux: device's software demuxer.
350  * @dvb_net: device's dvb_net interfaces.
351  * @dvb_frontend: device's frontend.
352  * @max_feed_count: how many feeds can be handled simultaneously by this
353  *  device
354  *
355  * @fe_init:  rerouted frontend-init (wakeup) function.
356  * @fe_sleep: rerouted frontend-sleep function.
357  *
358  * @stream: the usb data stream.
359  */
360 struct dvb_usb_fe_adapter {
361 	struct dvb_frontend *fe;
362 
363 	int (*fe_init)  (struct dvb_frontend *);
364 	int (*fe_sleep) (struct dvb_frontend *);
365 
366 	struct usb_data_stream stream;
367 
368 	int pid_filtering;
369 	int max_feed_count;
370 
371 	void *priv;
372 };
373 
374 struct dvb_usb_adapter {
375 	struct dvb_usb_device *dev;
376 	struct dvb_usb_adapter_properties props;
377 
378 #define DVB_USB_ADAP_STATE_INIT 0x000
379 #define DVB_USB_ADAP_STATE_DVB  0x001
380 	int state;
381 
382 	u8  id;
383 
384 	int feedcount;
385 
386 	/* dvb */
387 	struct dvb_adapter   dvb_adap;
388 	struct dmxdev        dmxdev;
389 	struct dvb_demux     demux;
390 	struct dvb_net       dvb_net;
391 
392 	struct dvb_usb_fe_adapter fe_adap[MAX_NO_OF_FE_PER_ADAP];
393 	int active_fe;
394 	int num_frontends_initialized;
395 
396 	void *priv;
397 };
398 
399 /**
400  * struct dvb_usb_device - object of a DVB USB device
401  * @props: copy of the struct dvb_usb_properties this device belongs to.
402  * @desc: pointer to the device's struct dvb_usb_device_description.
403  * @state: initialization and runtime state of the device.
404  *
405  * @powered: indicated whether the device is power or not.
406  *  Powered is in/decremented for each call to modify the state.
407  * @udev: pointer to the device's struct usb_device.
408  *
409  * @data_mutex: mutex to protect the data structure used to store URB data
410  * @usb_mutex: mutex of USB control messages (reading needs two messages).
411  *	Please notice that this mutex is used internally at the generic
412  *	URB control functions. So, drivers using dvb_usb_generic_rw() and
413  *	derivated functions should not lock it internally.
414  * @i2c_mutex: mutex for i2c-transfers
415  *
416  * @i2c_adap: device's i2c_adapter if it uses I2CoverUSB
417  *
418  * @rc_dev: rc device for the remote control (rc-core mode)
419  * @input_dev: input device for the remote control (legacy mode)
420  * @rc_query_work: struct work_struct frequent rc queries
421  * @last_event: last triggered event
422  * @last_state: last state (no, pressed, repeat)
423  * @owner: owner of the dvb_adapter
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 data_mutex;
443 	struct mutex usb_mutex;
444 
445 	/* i2c */
446 	struct mutex i2c_mutex;
447 	struct i2c_adapter i2c_adap;
448 
449 	int                    num_adapters_initialized;
450 	struct dvb_usb_adapter adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];
451 
452 	/* remote control */
453 	struct rc_dev *rc_dev;
454 	struct input_dev *input_dev;
455 	char rc_phys[64];
456 	struct delayed_work rc_query_work;
457 	u32 last_event;
458 	int last_state;
459 
460 	struct module *owner;
461 
462 	void *priv;
463 };
464 
465 extern int dvb_usb_device_init(struct usb_interface *,
466 			       struct dvb_usb_device_properties *,
467 			       struct module *, struct dvb_usb_device **,
468 			       short *adapter_nums);
469 extern void dvb_usb_device_exit(struct usb_interface *);
470 
471 /* the generic read/write method for device control */
472 extern int __must_check
473 dvb_usb_generic_rw(struct dvb_usb_device *, u8 *, u16, u8 *, u16, int);
474 extern int __must_check
475 dvb_usb_generic_write(struct dvb_usb_device *, u8 *, u16);
476 
477 /* commonly used remote control parsing */
478 extern int dvb_usb_nec_rc_key_to_event(struct dvb_usb_device *, u8[], u32 *, int *);
479 
480 /* commonly used firmware download types and function */
481 struct hexline {
482 	u8 len;
483 	u32 addr;
484 	u8 type;
485 	u8 data[255];
486 	u8 chk;
487 };
488 extern int usb_cypress_load_firmware(struct usb_device *udev, const struct firmware *fw, int type);
489 extern int dvb_usb_get_hexline(const struct firmware *fw, struct hexline *hx, int *pos);
490 
491 
492 #endif
493