drivers/media/dvb/dvb-usb/m920x.c

/* DVB USB compliant linux driver for MSI Mega Sky 580 DVB-T USB2.0 receiver
 *
 * Copyright (C) 2006 Aapo Tahkola (aet@rasterburn.org)
 *
 *	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 "m920x.h"

#include "mt352.h"
#include "mt352_priv.h"
#include "qt1010.h"

/* debug */
int dvb_usb_m920x_debug;
module_param_named(debug,dvb_usb_m920x_debug, int, 0644);
MODULE_PARM_DESC(debug, "set debugging level (1=rc (or-able))." DVB_USB_DEBUG_STATUS);

static struct dvb_usb_rc_key megasky_rc_keys [] = {
	{ 0x0, 0x12, KEY_POWER },
	{ 0x0, 0x1e, KEY_CYCLEWINDOWS }, /* min/max */
	{ 0x0, 0x02, KEY_CHANNELUP },
	{ 0x0, 0x05, KEY_CHANNELDOWN },
	{ 0x0, 0x03, KEY_VOLUMEUP },
	{ 0x0, 0x06, KEY_VOLUMEDOWN },
	{ 0x0, 0x04, KEY_MUTE },
	{ 0x0, 0x07, KEY_OK }, /* TS */
	{ 0x0, 0x08, KEY_STOP },
	{ 0x0, 0x09, KEY_MENU }, /* swap */
	{ 0x0, 0x0a, KEY_REWIND },
	{ 0x0, 0x1b, KEY_PAUSE },
	{ 0x0, 0x1f, KEY_FASTFORWARD },
	{ 0x0, 0x0c, KEY_RECORD },
	{ 0x0, 0x0d, KEY_CAMERA }, /* screenshot */
	{ 0x0, 0x0e, KEY_COFFEE }, /* "MTS" */
};

static inline int m9206_read(struct usb_device *udev, u8 request, u16 value, u16 index, void *data, int size)
{
	int ret;

	ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
			      request, USB_TYPE_VENDOR | USB_DIR_IN,
			      value, index, data, size, 2000);
	if (ret < 0)
		return ret;

	if (ret != size)
		return -EIO;

	return 0;
}

static inline int m9206_write(struct usb_device *udev, u8 request, u16 value, u16 index)
{
	int ret;

	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			      request, USB_TYPE_VENDOR | USB_DIR_OUT,
			      value, index, NULL, 0, 2000);
	return ret;
}

static int m9206_rc_init(struct usb_device *udev)
{
	int ret = 0;

	/* Remote controller init. */
	if ((ret = m9206_write(udev, M9206_CORE, 0xa8, M9206_RC_INIT2)) != 0)
		return ret;

	if ((ret = m9206_write(udev, M9206_CORE, 0x51, M9206_RC_INIT1)) != 0)
		return ret;

	return ret;
}

static int m9206_rc_query(struct dvb_usb_device *d, u32 *event, int *state)
{
	struct m9206_state *m = d->priv;
	int i, ret = 0;
	u8 rc_state[2];

	if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
		return -EAGAIN;

	if ((ret = m9206_read(d->udev, M9206_CORE, 0x0, M9206_RC_STATE, rc_state, 1)) != 0)
		goto unlock;

	if ((ret = m9206_read(d->udev, M9206_CORE, 0x0, M9206_RC_KEY, rc_state + 1, 1)) != 0)
		goto unlock;

	for (i = 0; i < ARRAY_SIZE(megasky_rc_keys); i++)
		if (megasky_rc_keys[i].data == rc_state[1]) {
			*event = megasky_rc_keys[i].event;

			switch(rc_state[0]) {
			case 0x80:
				*state = REMOTE_NO_KEY_PRESSED;
				goto unlock;

			case 0x93:
			case 0x92:
				m->rep_count = 0;
				*state = REMOTE_KEY_PRESSED;
				goto unlock;

			case 0x91:
				/* For comfort. */
				if (++m->rep_count > 2)
					*state = REMOTE_KEY_REPEAT;
				goto unlock;

			default:
				deb_rc("Unexpected rc response %x\n", rc_state[0]);
				*state = REMOTE_NO_KEY_PRESSED;
				goto unlock;
			}
		}

	if (rc_state[1] != 0)
		deb_rc("Unknown rc key %x\n", rc_state[1]);

	*state = REMOTE_NO_KEY_PRESSED;

	unlock:
	mutex_unlock(&d->i2c_mutex);

	return ret;
}

/* I2C */

static int m9206_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msg[], int num)
{
	struct dvb_usb_device *d = i2c_get_adapdata(adap);
	int i;
	int ret = 0;

	/* Need to access d->adapter[0] */
	if (d->num_adapters_initialized != 1) {
		deb_rc("Impossible happened!\n");
		return -EINVAL;
	}

	if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
		return -EAGAIN;

	if (num > 2)
		return -EINVAL;

	for (i = 0; i < num; i++) {
		u8 w_len;

		if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].addr, 0x80)) != 0)
			goto unlock;

		if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].buf[0], 0x0)) != 0)
			goto unlock;

		if (i + 1 < num && msg[i + 1].flags & I2C_M_RD) {
			/* Possibly device dependant */
			if (msg[i].addr == d->adapter[0].pll_addr)
				w_len = 0xc5;
			else
				w_len = 0x1f;

			if ((ret = m9206_write(d->udev, M9206_I2C, w_len, 0x80)) != 0)
				goto unlock;

			if ((ret = m9206_read(d->udev, M9206_I2C, 0x0, 0x60, msg[i + 1].buf, msg[i + 1].len)) != 0)
				goto unlock;

			i++;
		} else {
			if (msg[i].len != 2)
				return -EINVAL;

			if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].buf[1], 0x40)) != 0)
				goto unlock;
		}
	}
	ret = i;
	unlock:
	mutex_unlock(&d->i2c_mutex);

	return ret;
}

static u32 m9206_i2c_func(struct i2c_adapter *adapter)
{
	return I2C_FUNC_I2C;
}

static struct i2c_algorithm m9206_i2c_algo = {
	.master_xfer   = m9206_i2c_xfer,
	.functionality = m9206_i2c_func,
};

/* Callbacks for DVB USB */
static int megasky_identify_state(struct usb_device *udev,
				  struct dvb_usb_device_properties *props,
				  struct dvb_usb_device_description **desc,
				  int *cold)
{
	struct usb_host_interface *alt;

	alt = usb_altnum_to_altsetting(usb_ifnum_to_if(udev, 0), 1);
	*cold = (alt == NULL) ? 1 : 0;

	return 0;
}

static int megasky_mt352_demod_init(struct dvb_frontend *fe)
{
	u8 config[] = { CONFIG, 0x3d };
	u8 clock[] = { CLOCK_CTL, 0x30 };
	u8 reset[] = { RESET, 0x80 };
	u8 adc_ctl[] = { ADC_CTL_1, 0x40 };
	u8 agc[] = { AGC_TARGET, 0x1c, 0x20 };
	u8 sec_agc[] = { 0x69, 0x00, 0xff, 0xff, 0x40, 0xff, 0x00, 0x40, 0x40 };
	u8 unk1[] = { 0x93, 0x1a };
	u8 unk2[] = { 0xb5, 0x7a };

	mt352_write(fe, config, ARRAY_SIZE(config));
	mt352_write(fe, clock, ARRAY_SIZE(clock));
	mt352_write(fe, reset, ARRAY_SIZE(reset));
	mt352_write(fe, adc_ctl, ARRAY_SIZE(adc_ctl));
	mt352_write(fe, agc, ARRAY_SIZE(agc));
	mt352_write(fe, sec_agc, ARRAY_SIZE(sec_agc));
	mt352_write(fe, unk1, ARRAY_SIZE(unk1));
	mt352_write(fe, unk2, ARRAY_SIZE(unk2));

	deb_rc("Demod init!\n");

	return 0;
}

struct mt352_state;

static struct mt352_config megasky_mt352_config = {
	.demod_address = 0x1e,
	.no_tuner = 1,
	.demod_init = megasky_mt352_demod_init,
};

static int megasky_frontend_attach(struct dvb_usb_adapter *adap)
{
	deb_rc("megasky_frontend_attach!\n");

	if ((adap->fe = dvb_attach(mt352_attach, &megasky_mt352_config, &adap->dev->i2c_adap)) != NULL) {
		return 0;
	}
	return -EIO;
}

static int megasky_tuner_attach(struct dvb_usb_adapter *adap)
{
	adap->pll_addr = 0xc4;
	adap->pll_desc = NULL;
	adap->fe->ops.tuner_ops.set_params = qt1010_set_params;

	return 0;
}

/* DVB USB Driver stuff */
static struct dvb_usb_device_properties megasky_properties;

static int m920x_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct usb_device *udev = interface_to_usbdev(intf);
	struct dvb_usb_device *d;
	struct usb_host_interface *alt;
	struct dvb_usb_device_properties props;
	int ret;

	memcpy(&props, &megasky_properties, sizeof(struct dvb_usb_device_properties));

	/* Hardware pid filtering isn't quite perfect so dont use unless have to. */
	if (udev->speed == USB_SPEED_FULL)
		props.caps |= DVB_USB_ADAP_HAS_PID_FILTER |
			      DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF;

	if ((ret = dvb_usb_device_init(intf, &props, THIS_MODULE, &d)) == 0) {
		deb_rc("probed!\n");

		alt = usb_altnum_to_altsetting(intf, 1);
		if (alt == NULL) {
			deb_rc("not alt found!\n");
			return -ENODEV;
		}

		ret = usb_set_interface(d->udev, alt->desc.bInterfaceNumber, alt->desc.bAlternateSetting);
		if (ret < 0)
			return ret;

		deb_rc("Changed to alternate setting!\n");

		if ((ret = m9206_rc_init(d->udev)) != 0)
			return ret;
	}
	return ret;
}

static struct usb_device_id m920x_table [] = {
		{ USB_DEVICE(USB_VID_MSI, USB_PID_MSI_MEGASKY580) },
		{ }		/* Terminating entry */
};
MODULE_DEVICE_TABLE (usb, m920x_table);

static int set_filter(struct dvb_usb_adapter *adap, int type, int idx, int pid)
{
	int ret = 0;

	if (pid >= 0x8000)
		return -EINVAL;

	pid |= 0x8000;

	if ((ret = m9206_write(adap->dev->udev, M9206_FILTER, pid, (type << 8) | (idx * 4) )) != 0)
		return ret;

	if ((ret = m9206_write(adap->dev->udev, M9206_FILTER, 0, (type << 8) | (idx * 4) )) != 0)
		return ret;

	return ret;
}

static int m9206_update_filters(struct dvb_usb_adapter *adap)
{
	struct m9206_state *m = adap->dev->priv;
	int enabled = m->filtering_enabled;
	int i, ret = 0, filter = 0;

	for (i = 0; i < M9206_MAX_FILTERS; i++)
		if (m->filters[i] == 8192)
			enabled = 0;

	/* Disable all filters */
	if ((ret = set_filter(adap, 0x81, 1, enabled)) != 0)
		return ret;

	for (i = 0; i < M9206_MAX_FILTERS; i++)
		if ((ret = set_filter(adap, 0x81, i + 2, 0)) != 0)
			return ret;

	if ((ret = set_filter(adap, 0x82, 0, 0x0)) != 0)
		return ret;

	/* Set */
	if (enabled) {
		for (i = 0; i < M9206_MAX_FILTERS; i++) {
			if (m->filters[i] == 0)
				continue;

			if ((ret = set_filter(adap, 0x81, filter + 2, m->filters[i])) != 0)
				return ret;

			filter++;
		}
	}

	if ((ret = set_filter(adap, 0x82, 0, 0x02f5)) != 0)
		return ret;

	return ret;
}

static int m9206_pid_filter_ctrl(struct dvb_usb_adapter *adap, int onoff)
{
	struct m9206_state *m = adap->dev->priv;

	m->filtering_enabled = onoff ? 1 : 0;

	return m9206_update_filters(adap);
}

static int m9206_pid_filter(struct dvb_usb_adapter *adap, int index, u16 pid, int onoff)
{
	struct m9206_state *m = adap->dev->priv;

	m->filters[index] = onoff ? pid : 0;

	return m9206_update_filters(adap);
}

static int m9206_firmware_download(struct usb_device *udev, const struct firmware *fw)
{
	u16 value, index, size;
	u8 read[4], *buff;
	int i, pass, ret = 0;

	buff = kmalloc(65536, GFP_KERNEL);

	if ((ret = m9206_read(udev, M9206_FILTER, 0x0, 0x8000, read, 4)) != 0)
		goto done;
	deb_rc("%x %x %x %x\n", read[0], read[1], read[2], read[3]);

	if ((ret = m9206_read(udev, M9206_FW, 0x0, 0x0, read, 1)) != 0)
		goto done;
	deb_rc("%x\n", read[0]);

	for (pass = 0; pass < 2; pass++) {
		for (i = 0; i + (sizeof(u16) * 3) < fw->size;) {
			value = le16_to_cpu(*(u16 *)(fw->data + i));
			i += sizeof(u16);

			index = le16_to_cpu(*(u16 *)(fw->data + i));
			i += sizeof(u16);

			size = le16_to_cpu(*(u16 *)(fw->data + i));
			i += sizeof(u16);

			if (pass == 1) {
				/* Will stall if using fw->data ... */
				memcpy(buff, fw->data + i, size);

				ret = usb_control_msg(udev, usb_sndctrlpipe(udev,0),
					    M9206_FW,
					    USB_TYPE_VENDOR | USB_DIR_OUT,
					    value, index, buff, size, 20);
				if (ret != size) {
					deb_rc("error while uploading fw!\n");
					ret = -EIO;
					goto done;
				}
				msleep(3);
			}
			i += size;
		}
		if (i != fw->size) {
			ret = -EINVAL;
			goto done;
		}
	}

	msleep(36);

	/* m9206 will disconnect itself from the bus after this. */
	(void) m9206_write(udev, M9206_CORE, 0x01, M9206_FW_GO);
	deb_rc("firmware uploaded!\n");

	done:
	kfree(buff);

	return ret;
}

static struct dvb_usb_device_properties megasky_properties = {
	.usb_ctrl = DEVICE_SPECIFIC,
	.firmware = "dvb-usb-megasky-02.fw",
	.download_firmware = m9206_firmware_download,

	.rc_interval      = 100,
	.rc_key_map       = megasky_rc_keys,
	.rc_key_map_size  = ARRAY_SIZE(megasky_rc_keys),
	.rc_query         = m9206_rc_query,

	.size_of_priv     = sizeof(struct m9206_state),

	.identify_state   = megasky_identify_state,
	.num_adapters = 1,
	.adapter = {{
		.caps = DVB_USB_IS_AN_I2C_ADAPTER,
		.pid_filter_count = 8,
		.pid_filter       = m9206_pid_filter,
		.pid_filter_ctrl  = m9206_pid_filter_ctrl,

		.frontend_attach  = megasky_frontend_attach,
		.tuner_attach     = megasky_tuner_attach,

		.stream = {
			.type = USB_BULK,
			.count = 8,
			.endpoint = 0x81,
			.u = {
				.bulk = {
					.buffersize = 512,
				}
			}
		},
	}},
	.i2c_algo         = &m9206_i2c_algo,

	.generic_bulk_ctrl_endpoint = 0x01,

	.num_device_descs = 1,
	.devices = {
		{   "MSI Mega Sky 580 DVB-T USB2.0",
			{ &m920x_table[0], NULL },
			{ NULL },
		},
		{ NULL },
	}
};

static struct usb_driver m920x_driver = {
	.name		= "dvb_usb_m920x",
	.probe		= m920x_probe,
	.disconnect	= dvb_usb_device_exit,
	.id_table	= m920x_table,
};

/* module stuff */
static int __init m920x_module_init(void)
{
	int ret;

	if ((ret = usb_register(&m920x_driver))) {
		err("usb_register failed. Error number %d", ret);
		return ret;
	}

	return 0;
}

static void __exit m920x_module_exit(void)
{
	/* deregister this driver from the USB subsystem */
	usb_deregister(&m920x_driver);
}

module_init (m920x_module_init);
module_exit (m920x_module_exit);

MODULE_AUTHOR("Aapo Tahkola <aet@rasterburn.org>");
MODULE_DESCRIPTION("Driver MSI Mega Sky 580 DVB-T USB2.0 / Uli m920x");
MODULE_VERSION("0.1");
MODULE_LICENSE("GPL");