[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-5 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 (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).");

/* 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_fe_exit(d);
	dvb_usb_i2c_exit(d);
	dvb_usb_dvb_exit(d);
	dvb_usb_urb_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)
{
	int ret = 0;

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

	d->state = DVB_USB_STATE_INIT;

/* check the capabilities and set appropriate variables */

/* speed - when running at FULL speed we need a HW PID filter */
	if (d->udev->speed == USB_SPEED_FULL && !(d->props.caps & DVB_USB_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 && d->props.caps & DVB_USB_HAS_PID_FILTER) ||
		(d->props.caps & DVB_USB_NEED_PID_FILTERING)) {
		info("will use the device's hardware PID filter (table count: %d).",d->props.pid_filter_count);
		d->pid_filtering = 1;
		d->max_feed_count = d->props.pid_filter_count;
	} else {
		info("will pass the complete MPEG2 transport stream to the software demuxer.");
		d->pid_filtering = 0;
		d->max_feed_count = 255;
	}

	if (d->props.power_ctrl)
		d->props.power_ctrl(d,1);

	if ((ret = dvb_usb_urb_init(d)) ||
		(ret = dvb_usb_dvb_init(d)) ||
		(ret = dvb_usb_i2c_init(d)) ||
		(ret = dvb_usb_fe_init(d))) {
		dvb_usb_exit(d);
		return ret;
	}

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

	if (d->props.power_ctrl)
		d->props.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_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;
}

/*
 * USB
 */

int dvb_usb_device_init(struct usb_interface *intf, struct dvb_usb_properties
		*props, struct module *owner,struct dvb_usb_device **du)
{
	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)
			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_properties));
	d->desc = desc;
	d->owner = owner;

	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'");
			kfree(d);
			return -ENOMEM;
		}
	}

	usb_set_intfdata(intf, d);

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

	ret = dvb_usb_init(d);

	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("0.3");
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	*
	6	* Copyright (C) 2004-5 Patrick Boettcher (patrick.boettcher@desy.de)
	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);
	19	MODULE_PARM_DESC(debug, "set debugging level (1=info,xfer=2,pll=4,ts=8,err=16,rc=32,fw=64 (or-able))." DVB_USB_DEBUG_STATUS);
	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
776338e1	25	/* general initialization functions */
15ac8e66	26	static int dvb_usb_exit(struct dvb_usb_device *d)
776338e1 JS	27	{
	28	deb_info("state before exiting everything: %x\n",d->state);
	29	dvb_usb_remote_exit(d);
	30	dvb_usb_fe_exit(d);
	31	dvb_usb_i2c_exit(d);
	32	dvb_usb_dvb_exit(d);
	33	dvb_usb_urb_exit(d);
	34	deb_info("state should be zero now: %x\n",d->state);
	35	d->state = DVB_USB_STATE_INIT;
	36	kfree(d->priv);
	37	kfree(d);
	38	return 0;
	39	}
	40
	41	static int dvb_usb_init(struct dvb_usb_device *d)
	42	{
	43	int ret = 0;
	44
3593cab5 IM	45	mutex_init(&d->usb_mutex);
3593cab5 IM	46	mutex_init(&d->i2c_mutex);
776338e1 JS	47
	48	d->state = DVB_USB_STATE_INIT;
	49
be787ace	50	/* check the capabilities and set appropriate variables */
776338e1 JS	51
	52	/* speed - when running at FULL speed we need a HW PID filter */
	53	if (d->udev->speed == USB_SPEED_FULL && !(d->props.caps & DVB_USB_HAS_PID_FILTER)) {
8df3d460	54	err("This USB2.0 device cannot be run on a USB1.1 port. (it lacks a hardware PID filter)");
776338e1 JS	55	return -ENODEV;
	56	}
	57
	58	if ((d->udev->speed == USB_SPEED_FULL && d->props.caps & DVB_USB_HAS_PID_FILTER) \|\|
	59	(d->props.caps & DVB_USB_NEED_PID_FILTERING)) {
8df3d460	60	info("will use the device's hardware PID filter (table count: %d).",d->props.pid_filter_count);
776338e1 JS	61	d->pid_filtering = 1;
	62	d->max_feed_count = d->props.pid_filter_count;
	63	} else {
8df3d460	64	info("will pass the complete MPEG2 transport stream to the software demuxer.");
776338e1 JS	65	d->pid_filtering = 0;
	66	d->max_feed_count = 255;
	67	}
	68
	69	if (d->props.power_ctrl)
	70	d->props.power_ctrl(d,1);
	71
	72	if ((ret = dvb_usb_urb_init(d)) \|\|
	73	(ret = dvb_usb_dvb_init(d)) \|\|
	74	(ret = dvb_usb_i2c_init(d)) \|\|
	75	(ret = dvb_usb_fe_init(d))) {
	76	dvb_usb_exit(d);
	77	return ret;
	78	}
	79
	80	if ((ret = dvb_usb_remote_init(d)))
	81	err("could not initialize remote control.");
	82
	83	if (d->props.power_ctrl)
	84	d->props.power_ctrl(d,0);
	85
	86	return 0;
	87	}
	88
	89	/* determine the name and the state of the just found USB device */
	90	static struct dvb_usb_device_description * dvb_usb_find_device(struct usb_device udev,struct dvb_usb_properties props, int *cold)
	91	{
	92	int i,j;
	93	struct dvb_usb_device_description *desc = NULL;
	94	*cold = -1;
	95
	96	for (i = 0; i < props->num_device_descs; i++) {
	97
	98	for (j = 0; j < DVB_USB_ID_MAX_NUM && props->devices[i].cold_ids[j] != NULL; j++) {
	99	deb_info("check for cold %x %x\n",props->devices[i].cold_ids[j]->idVendor, props->devices[i].cold_ids[j]->idProduct);
	100	if (props->devices[i].cold_ids[j]->idVendor == le16_to_cpu(udev->descriptor.idVendor) &&
	101	props->devices[i].cold_ids[j]->idProduct == le16_to_cpu(udev->descriptor.idProduct)) {
	102	*cold = 1;
	103	desc = &props->devices[i];
	104	break;
	105	}
	106	}
	107
	108	if (desc != NULL)
	109	break;
	110
	111	for (j = 0; j < DVB_USB_ID_MAX_NUM && props->devices[i].warm_ids[j] != NULL; j++) {
	112	deb_info("check for warm %x %x\n",props->devices[i].warm_ids[j]->idVendor, props->devices[i].warm_ids[j]->idProduct);
	113	if (props->devices[i].warm_ids[j]->idVendor == le16_to_cpu(udev->descriptor.idVendor) &&
	114	props->devices[i].warm_ids[j]->idProduct == le16_to_cpu(udev->descriptor.idProduct)) {
	115	*cold = 0;
	116	desc = &props->devices[i];
	117	break;
	118	}
	119	}
	120	}
	121
	122	if (desc != NULL && props->identify_state != NULL)
	123	props->identify_state(udev,props,&desc,cold);
	124
	125	return desc;
	126	}
	127
	128	/*
129	* USB
130	*/
47dc3d68 PB	131
	132	int dvb_usb_device_init(struct usb_interface *intf, struct dvb_usb_properties
	133	props, struct module owner,struct dvb_usb_device **du)
776338e1 JS	134	{
	135	struct usb_device *udev = interface_to_usbdev(intf);
	136	struct dvb_usb_device *d = NULL;
	137	struct dvb_usb_device_description *desc = NULL;
	138
	139	int ret = -ENOMEM,cold=0;
	140
6ff5ef28 PB	141	if (du != NULL)
	142	*du = NULL;
	143
776338e1 JS	144	if ((desc = dvb_usb_find_device(udev,props,&cold)) == NULL) {
	145	deb_err("something went very wrong, device was not found in current device list - let's see what comes next.\n");
	146	return -ENODEV;
	147	}
	148
	149	if (cold) {
	150	info("found a '%s' in cold state, will try to load a firmware",desc->name);
d3707add PB	151	ret = dvb_usb_download_firmware(udev,props);
d3707add PB	152	if (!props->no_reconnect)
776338e1	153	return ret;
d3707add PB	154	}
	155
	156	info("found a '%s' in warm state.",desc->name);
7408187d	157	d = kzalloc(sizeof(struct dvb_usb_device),GFP_KERNEL);
d3707add PB	158	if (d == NULL) {
	159	err("no memory for 'struct dvb_usb_device'");
	160	return ret;
	161	}
d3707add PB	162
	163	d->udev = udev;
	164	memcpy(&d->props,props,sizeof(struct dvb_usb_properties));
	165	d->desc = desc;
	166	d->owner = owner;
	167
	168	if (d->props.size_of_priv > 0) {
7408187d	169	d->priv = kzalloc(d->props.size_of_priv,GFP_KERNEL);
d3707add PB	170	if (d->priv == NULL) {
	171	err("no memory for priv in 'struct dvb_usb_device'");
	172	kfree(d);
	173	return -ENOMEM;
776338e1	174	}
d3707add	175	}
776338e1	176
d3707add	177	usb_set_intfdata(intf, d);
776338e1	178
d3707add PB	179	if (du != NULL)
d3707add PB	180	*du = d;
47dc3d68	181
d3707add	182	ret = dvb_usb_init(d);
776338e1 JS	183
	184	if (ret == 0)
	185	info("%s successfully initialized and connected.",desc->name);
	186	else
	187	info("%s error while loading driver (%d)",desc->name,ret);
	188	return ret;
	189	}
	190	EXPORT_SYMBOL(dvb_usb_device_init);
	191
	192	void dvb_usb_device_exit(struct usb_interface *intf)
	193	{
	194	struct dvb_usb_device *d = usb_get_intfdata(intf);
	195	const char *name = "generic DVB-USB module";
	196
	197	usb_set_intfdata(intf,NULL);
	198	if (d != NULL && d->desc != NULL) {
	199	name = d->desc->name;
	200	dvb_usb_exit(d);
	201	}
	202	info("%s successfully deinitialized and disconnected.",name);
	203
	204	}
	205	EXPORT_SYMBOL(dvb_usb_device_exit);
	206
776338e1 JS	207	MODULE_VERSION("0.3");
	208	MODULE_AUTHOR("Patrick Boettcher <patrick.boettcher@desy.de>");
	209	MODULE_DESCRIPTION("A library module containing commonly used USB and DVB function USB DVB devices");
	210	MODULE_LICENSE("GPL");