[deliverable/linux.git] / drivers / media / dvb / dvb-usb / dvb-usb-init.c

/*
 * DVB USB library - provides a generic interface for a DVB USB device driver.
 *
 * dvb-usb-init.c
 *
 * Copyright (C) 2004-6 Patrick Boettcher (patrick.boettcher@desy.de)
 *
 *	This program is free software; you can redistribute it and/or modify it
 *	under the terms of the GNU General Public License as published by the Free
 *	Software Foundation, version 2.
 *
 * see Documentation/dvb/README.dvb-usb for more information
 */
#include "dvb-usb-common.h"

/* debug */
int dvb_usb_debug;
module_param_named(debug,dvb_usb_debug, int, 0644);
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);

int dvb_usb_disable_rc_polling;
module_param_named(disable_rc_polling, dvb_usb_disable_rc_polling, int, 0644);
MODULE_PARM_DESC(disable_rc_polling, "disable remote control polling (default: 0).");

static int dvb_usb_force_pid_filter_usage;
module_param_named(force_pid_filter_usage, dvb_usb_force_pid_filter_usage, int, 0444);
MODULE_PARM_DESC(force_pid_filter_usage, "force all dvb-usb-devices to use a PID filter, if any (default: 0).");

static int dvb_usb_adapter_init(struct dvb_usb_device *d, short *adapter_nrs)
{
	struct dvb_usb_adapter *adap;
	int ret,n;

	for (n = 0; n < d->props.num_adapters; n++) {
		adap = &d->adapter[n];
		adap->dev = d;
		adap->id  = n;

		memcpy(&adap->props, &d->props.adapter[n], sizeof(struct dvb_usb_adapter_properties));

/* speed - when running at FULL speed we need a HW PID filter */
		if (d->udev->speed == USB_SPEED_FULL && !(adap->props.caps & DVB_USB_ADAP_HAS_PID_FILTER)) {
			err("This USB2.0 device cannot be run on a USB1.1 port. (it lacks a hardware PID filter)");
			return -ENODEV;
		}

		if ((d->udev->speed == USB_SPEED_FULL && adap->props.caps & DVB_USB_ADAP_HAS_PID_FILTER) ||
			(adap->props.caps & DVB_USB_ADAP_NEED_PID_FILTERING)) {
			info("will use the device's hardware PID filter (table count: %d).",adap->props.pid_filter_count);
			adap->pid_filtering  = 1;
			adap->max_feed_count = adap->props.pid_filter_count;
		} else {
			info("will pass the complete MPEG2 transport stream to the software demuxer.");
			adap->pid_filtering  = 0;
			adap->max_feed_count = 255;
		}

		if (!adap->pid_filtering &&
			dvb_usb_force_pid_filter_usage &&
			adap->props.caps & DVB_USB_ADAP_HAS_PID_FILTER) {
			info("pid filter enabled by module option.");
			adap->pid_filtering  = 1;
			adap->max_feed_count = adap->props.pid_filter_count;
		}

		if (adap->props.size_of_priv > 0) {
			adap->priv = kzalloc(adap->props.size_of_priv,GFP_KERNEL);
			if (adap->priv == NULL) {
				err("no memory for priv for adapter %d.",n);
				return -ENOMEM;
			}
		}

		if ((ret = dvb_usb_adapter_stream_init(adap)) ||
			(ret = dvb_usb_adapter_dvb_init(adap, adapter_nrs)) ||
			(ret = dvb_usb_adapter_frontend_init(adap))) {
			return ret;
		}

		d->num_adapters_initialized++;
		d->state |= DVB_USB_STATE_DVB;
	}

	/*
	 * when reloading the driver w/o replugging the device
	 * sometimes a timeout occures, this helps
	 */
	if (d->props.generic_bulk_ctrl_endpoint != 0) {
		usb_clear_halt(d->udev,usb_sndbulkpipe(d->udev,d->props.generic_bulk_ctrl_endpoint));
		usb_clear_halt(d->udev,usb_rcvbulkpipe(d->udev,d->props.generic_bulk_ctrl_endpoint));
	}

	return 0;
}

static int dvb_usb_adapter_exit(struct dvb_usb_device *d)
{
	int n;
	for (n = 0; n < d->num_adapters_initialized; n++) {
		dvb_usb_adapter_frontend_exit(&d->adapter[n]);
		dvb_usb_adapter_dvb_exit(&d->adapter[n]);
		dvb_usb_adapter_stream_exit(&d->adapter[n]);
		kfree(d->adapter[n].priv);
	}
	d->num_adapters_initialized = 0;
	d->state &= ~DVB_USB_STATE_DVB;
	return 0;
}


/* general initialization functions */
static int dvb_usb_exit(struct dvb_usb_device *d)
{
	deb_info("state before exiting everything: %x\n",d->state);
	dvb_usb_remote_exit(d);
	dvb_usb_adapter_exit(d);
	dvb_usb_i2c_exit(d);
	deb_info("state should be zero now: %x\n",d->state);
	d->state = DVB_USB_STATE_INIT;
	kfree(d->priv);
	kfree(d);
	return 0;
}

static int dvb_usb_init(struct dvb_usb_device *d, short *adapter_nums)
{
	int ret = 0;

	mutex_init(&d->usb_mutex);
	mutex_init(&d->i2c_mutex);

	d->state = DVB_USB_STATE_INIT;

	if (d->props.size_of_priv > 0) {
		d->priv = kzalloc(d->props.size_of_priv,GFP_KERNEL);
		if (d->priv == NULL) {
			err("no memory for priv in 'struct dvb_usb_device'");
			return -ENOMEM;
		}
	}

/* check the capabilities and set appropriate variables */
	dvb_usb_device_power_ctrl(d, 1);

	if ((ret = dvb_usb_i2c_init(d)) ||
		(ret = dvb_usb_adapter_init(d, adapter_nums))) {
		dvb_usb_exit(d);
		return ret;
	}

	if ((ret = dvb_usb_remote_init(d)))
		err("could not initialize remote control.");

	dvb_usb_device_power_ctrl(d, 0);

	return 0;
}

/* determine the name and the state of the just found USB device */
static struct dvb_usb_device_description * dvb_usb_find_device(struct usb_device *udev,struct dvb_usb_device_properties *props, int *cold)
{
	int i,j;
	struct dvb_usb_device_description *desc = NULL;
	*cold = -1;

	for (i = 0; i < props->num_device_descs; i++) {

		for (j = 0; j < DVB_USB_ID_MAX_NUM && props->devices[i].cold_ids[j] != NULL; j++) {
			deb_info("check for cold %x %x\n",props->devices[i].cold_ids[j]->idVendor, props->devices[i].cold_ids[j]->idProduct);
			if (props->devices[i].cold_ids[j]->idVendor  == le16_to_cpu(udev->descriptor.idVendor) &&
				props->devices[i].cold_ids[j]->idProduct == le16_to_cpu(udev->descriptor.idProduct)) {
				*cold = 1;
				desc = &props->devices[i];
				break;
			}
		}

		if (desc != NULL)
			break;

		for (j = 0; j < DVB_USB_ID_MAX_NUM && props->devices[i].warm_ids[j] != NULL; j++) {
			deb_info("check for warm %x %x\n",props->devices[i].warm_ids[j]->idVendor, props->devices[i].warm_ids[j]->idProduct);
			if (props->devices[i].warm_ids[j]->idVendor == le16_to_cpu(udev->descriptor.idVendor) &&
				props->devices[i].warm_ids[j]->idProduct == le16_to_cpu(udev->descriptor.idProduct)) {
				*cold = 0;
				desc = &props->devices[i];
				break;
			}
		}
	}

	if (desc != NULL && props->identify_state != NULL)
		props->identify_state(udev,props,&desc,cold);

	return desc;
}

int dvb_usb_device_power_ctrl(struct dvb_usb_device *d, int onoff)
{
	if (onoff)
		d->powered++;
	else
		d->powered--;

	if (d->powered == 0 || (onoff && d->powered == 1)) { // when switching from 1 to 0 or from 0 to 1
		deb_info("power control: %d\n", onoff);
		if (d->props.power_ctrl)
			return d->props.power_ctrl(d, onoff);
	}
	return 0;
}

/*
 * USB
 */
int dvb_usb_device_init(struct usb_interface *intf,
			struct dvb_usb_device_properties *props,
			struct module *owner, struct dvb_usb_device **du,
			short *adapter_nums)
{
	struct usb_device *udev = interface_to_usbdev(intf);
	struct dvb_usb_device *d = NULL;
	struct dvb_usb_device_description *desc = NULL;

	int ret = -ENOMEM,cold=0;

	if (du != NULL)
		*du = NULL;

	if ((desc = dvb_usb_find_device(udev,props,&cold)) == NULL) {
		deb_err("something went very wrong, device was not found in current device list - let's see what comes next.\n");
		return -ENODEV;
	}

	if (cold) {
		info("found a '%s' in cold state, will try to load a firmware",desc->name);
		ret = dvb_usb_download_firmware(udev,props);
		if (!props->no_reconnect || ret != 0)
			return ret;
	}

	info("found a '%s' in warm state.",desc->name);
		d = kzalloc(sizeof(struct dvb_usb_device),GFP_KERNEL);
	if (d == NULL) {
		err("no memory for 'struct dvb_usb_device'");
		return ret;
	}

	d->udev = udev;
	memcpy(&d->props,props,sizeof(struct dvb_usb_device_properties));
	d->desc = desc;
	d->owner = owner;

	usb_set_intfdata(intf, d);

	if (du != NULL)
		*du = d;

	ret = dvb_usb_init(d, adapter_nums);

	if (ret == 0)
		info("%s successfully initialized and connected.",desc->name);
	else
		info("%s error while loading driver (%d)",desc->name,ret);
	return ret;
}
EXPORT_SYMBOL(dvb_usb_device_init);

void dvb_usb_device_exit(struct usb_interface *intf)
{
	struct dvb_usb_device *d = usb_get_intfdata(intf);
	const char *name = "generic DVB-USB module";

	usb_set_intfdata(intf,NULL);
	if (d != NULL && d->desc != NULL) {
		name = d->desc->name;
		dvb_usb_exit(d);
	}
	info("%s successfully deinitialized and disconnected.",name);

}
EXPORT_SYMBOL(dvb_usb_device_exit);

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