1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * DVB USB library - provides a generic interface for a DVB USB device driver.
4  *
5  * dvb-usb-init.c
6  *
7  * Copyright (C) 2004-6 Patrick Boettcher (patrick.boettcher@posteo.de)
8  *
9  * see Documentation/driver-api/media/drivers/dvb-usb.rst for more information
10  */
11 #include "dvb-usb-common.h"
12 
13 /* debug */
14 int dvb_usb_debug;
15 module_param_named(debug, dvb_usb_debug, int, 0644);
16 MODULE_PARM_DESC(debug, "set debugging level (1=info,xfer=2,pll=4,ts=8,err=16,rc=32,fw=64,mem=128,uxfer=256  (or-able))." DVB_USB_DEBUG_STATUS);
17 
18 int dvb_usb_disable_rc_polling;
19 module_param_named(disable_rc_polling, dvb_usb_disable_rc_polling, int, 0644);
20 MODULE_PARM_DESC(disable_rc_polling, "disable remote control polling (default: 0).");
21 
22 static int dvb_usb_force_pid_filter_usage;
23 module_param_named(force_pid_filter_usage, dvb_usb_force_pid_filter_usage, int, 0444);
24 MODULE_PARM_DESC(force_pid_filter_usage, "force all dvb-usb-devices to use a PID filter, if any (default: 0).");
25 
26 static int dvb_usb_adapter_init(struct dvb_usb_device *d, short *adapter_nrs)
27 {
28 	struct dvb_usb_adapter *adap;
29 	int ret, n, o;
30 
31 	for (n = 0; n < d->props.num_adapters; n++) {
32 		adap = &d->adapter[n];
33 		adap->dev = d;
34 		adap->id  = n;
35 
36 		memcpy(&adap->props, &d->props.adapter[n], sizeof(struct dvb_usb_adapter_properties));
37 
38 		for (o = 0; o < adap->props.num_frontends; o++) {
39 			struct dvb_usb_adapter_fe_properties *props = &adap->props.fe[o];
40 			/* speed - when running at FULL speed we need a HW PID filter */
41 			if (d->udev->speed == USB_SPEED_FULL && !(props->caps & DVB_USB_ADAP_HAS_PID_FILTER)) {
42 				err("This USB2.0 device cannot be run on a USB1.1 port. (it lacks a hardware PID filter)");
43 				return -ENODEV;
44 			}
45 
46 			if ((d->udev->speed == USB_SPEED_FULL && props->caps & DVB_USB_ADAP_HAS_PID_FILTER) ||
47 				(props->caps & DVB_USB_ADAP_NEED_PID_FILTERING)) {
48 				info("will use the device's hardware PID filter (table count: %d).", props->pid_filter_count);
49 				adap->fe_adap[o].pid_filtering  = 1;
50 				adap->fe_adap[o].max_feed_count = props->pid_filter_count;
51 			} else {
52 				info("will pass the complete MPEG2 transport stream to the software demuxer.");
53 				adap->fe_adap[o].pid_filtering  = 0;
54 				adap->fe_adap[o].max_feed_count = 255;
55 			}
56 
57 			if (!adap->fe_adap[o].pid_filtering &&
58 				dvb_usb_force_pid_filter_usage &&
59 				props->caps & DVB_USB_ADAP_HAS_PID_FILTER) {
60 				info("pid filter enabled by module option.");
61 				adap->fe_adap[o].pid_filtering  = 1;
62 				adap->fe_adap[o].max_feed_count = props->pid_filter_count;
63 			}
64 
65 			if (props->size_of_priv > 0) {
66 				adap->fe_adap[o].priv = kzalloc(props->size_of_priv, GFP_KERNEL);
67 				if (adap->fe_adap[o].priv == NULL) {
68 					err("no memory for priv for adapter %d fe %d.", n, o);
69 					return -ENOMEM;
70 				}
71 			}
72 		}
73 
74 		if (adap->props.size_of_priv > 0) {
75 			adap->priv = kzalloc(adap->props.size_of_priv, GFP_KERNEL);
76 			if (adap->priv == NULL) {
77 				err("no memory for priv for adapter %d.", n);
78 				return -ENOMEM;
79 			}
80 		}
81 
82 		if ((ret = dvb_usb_adapter_stream_init(adap)) ||
83 			(ret = dvb_usb_adapter_dvb_init(adap, adapter_nrs)) ||
84 			(ret = dvb_usb_adapter_frontend_init(adap))) {
85 			return ret;
86 		}
87 
88 		/* use exclusive FE lock if there is multiple shared FEs */
89 		if (adap->fe_adap[1].fe)
90 			adap->dvb_adap.mfe_shared = 1;
91 
92 		d->num_adapters_initialized++;
93 		d->state |= DVB_USB_STATE_DVB;
94 	}
95 
96 	/*
97 	 * when reloading the driver w/o replugging the device
98 	 * sometimes a timeout occurs, this helps
99 	 */
100 	if (d->props.generic_bulk_ctrl_endpoint != 0) {
101 		usb_clear_halt(d->udev, usb_sndbulkpipe(d->udev, d->props.generic_bulk_ctrl_endpoint));
102 		usb_clear_halt(d->udev, usb_rcvbulkpipe(d->udev, d->props.generic_bulk_ctrl_endpoint));
103 	}
104 
105 	return 0;
106 }
107 
108 static int dvb_usb_adapter_exit(struct dvb_usb_device *d)
109 {
110 	int n;
111 
112 	for (n = 0; n < d->num_adapters_initialized; n++) {
113 		dvb_usb_adapter_frontend_exit(&d->adapter[n]);
114 		dvb_usb_adapter_dvb_exit(&d->adapter[n]);
115 		dvb_usb_adapter_stream_exit(&d->adapter[n]);
116 		kfree(d->adapter[n].priv);
117 	}
118 	d->num_adapters_initialized = 0;
119 	d->state &= ~DVB_USB_STATE_DVB;
120 	return 0;
121 }
122 
123 
124 /* general initialization functions */
125 static int dvb_usb_exit(struct dvb_usb_device *d)
126 {
127 	deb_info("state before exiting everything: %x\n", d->state);
128 	dvb_usb_remote_exit(d);
129 	dvb_usb_adapter_exit(d);
130 	dvb_usb_i2c_exit(d);
131 	deb_info("state should be zero now: %x\n", d->state);
132 	d->state = DVB_USB_STATE_INIT;
133 
134 	if (d->priv != NULL && d->props.priv_destroy != NULL)
135 		d->props.priv_destroy(d);
136 
137 	kfree(d->priv);
138 	kfree(d);
139 	return 0;
140 }
141 
142 static int dvb_usb_init(struct dvb_usb_device *d, short *adapter_nums)
143 {
144 	int ret = 0;
145 
146 	mutex_init(&d->data_mutex);
147 	mutex_init(&d->usb_mutex);
148 	mutex_init(&d->i2c_mutex);
149 
150 	d->state = DVB_USB_STATE_INIT;
151 
152 	if (d->props.size_of_priv > 0) {
153 		d->priv = kzalloc(d->props.size_of_priv, GFP_KERNEL);
154 		if (d->priv == NULL) {
155 			err("no memory for priv in 'struct dvb_usb_device'");
156 			return -ENOMEM;
157 		}
158 
159 		if (d->props.priv_init != NULL) {
160 			ret = d->props.priv_init(d);
161 			if (ret != 0)
162 				goto err_priv_init;
163 		}
164 	}
165 
166 	/* check the capabilities and set appropriate variables */
167 	dvb_usb_device_power_ctrl(d, 1);
168 
169 	ret = dvb_usb_i2c_init(d);
170 	if (ret)
171 		goto err_i2c_init;
172 	ret = dvb_usb_adapter_init(d, adapter_nums);
173 	if (ret)
174 		goto err_adapter_init;
175 
176 	if ((ret = dvb_usb_remote_init(d)))
177 		err("could not initialize remote control.");
178 
179 	dvb_usb_device_power_ctrl(d, 0);
180 
181 	return 0;
182 
183 err_adapter_init:
184 	dvb_usb_adapter_exit(d);
185 err_i2c_init:
186 	dvb_usb_i2c_exit(d);
187 	if (d->priv && d->props.priv_destroy)
188 		d->props.priv_destroy(d);
189 err_priv_init:
190 	kfree(d->priv);
191 	d->priv = NULL;
192 	return ret;
193 }
194 
195 /* determine the name and the state of the just found USB device */
196 static const struct dvb_usb_device_description *dvb_usb_find_device(struct usb_device *udev, const struct dvb_usb_device_properties *props, int *cold)
197 {
198 	int i, j;
199 	const struct dvb_usb_device_description *desc = NULL;
200 
201 	*cold = -1;
202 
203 	for (i = 0; i < props->num_device_descs; i++) {
204 
205 		for (j = 0; j < DVB_USB_ID_MAX_NUM && props->devices[i].cold_ids[j] != NULL; j++) {
206 			deb_info("check for cold %x %x\n", props->devices[i].cold_ids[j]->idVendor, props->devices[i].cold_ids[j]->idProduct);
207 			if (props->devices[i].cold_ids[j]->idVendor  == le16_to_cpu(udev->descriptor.idVendor) &&
208 				props->devices[i].cold_ids[j]->idProduct == le16_to_cpu(udev->descriptor.idProduct)) {
209 				*cold = 1;
210 				desc = &props->devices[i];
211 				break;
212 			}
213 		}
214 
215 		if (desc != NULL)
216 			break;
217 
218 		for (j = 0; j < DVB_USB_ID_MAX_NUM && props->devices[i].warm_ids[j] != NULL; j++) {
219 			deb_info("check for warm %x %x\n", props->devices[i].warm_ids[j]->idVendor, props->devices[i].warm_ids[j]->idProduct);
220 			if (props->devices[i].warm_ids[j]->idVendor == le16_to_cpu(udev->descriptor.idVendor) &&
221 				props->devices[i].warm_ids[j]->idProduct == le16_to_cpu(udev->descriptor.idProduct)) {
222 				*cold = 0;
223 				desc = &props->devices[i];
224 				break;
225 			}
226 		}
227 	}
228 
229 	if (desc != NULL && props->identify_state != NULL)
230 		props->identify_state(udev, props, &desc, cold);
231 
232 	return desc;
233 }
234 
235 int dvb_usb_device_power_ctrl(struct dvb_usb_device *d, int onoff)
236 {
237 	if (onoff)
238 		d->powered++;
239 	else
240 		d->powered--;
241 
242 	if (d->powered == 0 || (onoff && d->powered == 1)) { /* when switching from 1 to 0 or from 0 to 1 */
243 		deb_info("power control: %d\n", onoff);
244 		if (d->props.power_ctrl)
245 			return d->props.power_ctrl(d, onoff);
246 	}
247 	return 0;
248 }
249 
250 /*
251  * USB
252  */
253 int dvb_usb_device_init(struct usb_interface *intf,
254 			const struct dvb_usb_device_properties *props,
255 			struct module *owner, struct dvb_usb_device **du,
256 			short *adapter_nums)
257 {
258 	struct usb_device *udev = interface_to_usbdev(intf);
259 	struct dvb_usb_device *d = NULL;
260 	const struct dvb_usb_device_description *desc = NULL;
261 
262 	int ret = -ENOMEM, cold = 0;
263 
264 	if (du != NULL)
265 		*du = NULL;
266 
267 	d = kzalloc(sizeof(*d), GFP_KERNEL);
268 	if (!d) {
269 		err("no memory for 'struct dvb_usb_device'");
270 		return -ENOMEM;
271 	}
272 
273 	memcpy(&d->props, props, sizeof(struct dvb_usb_device_properties));
274 
275 	desc = dvb_usb_find_device(udev, &d->props, &cold);
276 	if (!desc) {
277 		deb_err("something went very wrong, device was not found in current device list - let's see what comes next.\n");
278 		ret = -ENODEV;
279 		goto error;
280 	}
281 
282 	if (cold) {
283 		info("found a '%s' in cold state, will try to load a firmware", desc->name);
284 		ret = dvb_usb_download_firmware(udev, props);
285 		if (!props->no_reconnect || ret != 0)
286 			goto error;
287 	}
288 
289 	info("found a '%s' in warm state.", desc->name);
290 	d->udev = udev;
291 	d->desc = desc;
292 	d->owner = owner;
293 
294 	usb_set_intfdata(intf, d);
295 
296 	ret = dvb_usb_init(d, adapter_nums);
297 	if (ret) {
298 		info("%s error while loading driver (%d)", desc->name, ret);
299 		goto error;
300 	}
301 
302 	if (du)
303 		*du = d;
304 
305 	info("%s successfully initialized and connected.", desc->name);
306 	return 0;
307 
308  error:
309 	usb_set_intfdata(intf, NULL);
310 	kfree(d);
311 	return ret;
312 }
313 EXPORT_SYMBOL(dvb_usb_device_init);
314 
315 void dvb_usb_device_exit(struct usb_interface *intf)
316 {
317 	struct dvb_usb_device *d = usb_get_intfdata(intf);
318 	const char *default_name = "generic DVB-USB module";
319 	char name[40];
320 
321 	usb_set_intfdata(intf, NULL);
322 	if (d != NULL && d->desc != NULL) {
323 		strscpy(name, d->desc->name, sizeof(name));
324 		dvb_usb_exit(d);
325 	} else {
326 		strscpy(name, default_name, sizeof(name));
327 	}
328 	info("%s successfully deinitialized and disconnected.", name);
329 
330 }
331 EXPORT_SYMBOL(dvb_usb_device_exit);
332 
333 MODULE_VERSION("1.0");
334 MODULE_AUTHOR("Patrick Boettcher <patrick.boettcher@posteo.de>");
335 MODULE_DESCRIPTION("A library module containing commonly used USB and DVB function USB DVB devices");
336 MODULE_LICENSE("GPL");
337