path: root/drivers/net/wimax/cmc7xx/wimax_sdio.c

/*
 * Copyright (C) 2011 Samsung Electronics.
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 */
#include "headers.h"
#include "ctl_types.h"
#include "download.h"

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/netdevice.h>
#include <linux/miscdevice.h>
#include <linux/etherdevice.h>
#include <linux/ethtool.h>
#include <linux/mmc/sdio_ids.h>
#include <linux/mmc/pm.h>
#include <linux/mmc/sdio_func.h>
#include <asm/byteorder.h>
#include <linux/uaccess.h>
#include <linux/delay.h>
#include <linux/fs.h>
#include <linux/platform_device.h>

/* driver Information */
#define WIMAX_DRIVER_VERSION_STRING "3.0.4"
#define DRIVER_AUTHOR "Samsung"
#define DRIVER_DESC "Samsung WiMAX SDIO Device Driver"

#define UWBRBDEVMINOR	233
#define SWMXGPIOMINOR	234

/* use ethtool to change the level for any given device */
static int msg_level = -1;
module_param(msg_level, int, 0);

static long swmxdev_ioctl(struct file *file, u32 cmd,
							unsigned long arg)
{
	int	ret = 0;
	u8	val = ((u8 *)arg)[0];
	struct wimax732_platform_data *gpdata =
		(struct wimax732_platform_data *)(file->private_data);

	pr_debug("CMD: %x, PID: %d", cmd, current->tgid);

	switch (cmd) {
	case CONTROL_IOCTL_WIMAX_POWER_CTL: {
		pr_debug("CONTROL_IOCTL_WIMAX_POWER_CTL..");
		if (val == 0) {
			pr_debug("WIMAX POWER OFF");
			ret = gpdata->power(0);
		} else {
			pr_debug("WIMAX POWER ON");
			ret = gpdata->power(1);
		}
		break;
	}
	case CONTROL_IOCTL_WIMAX_MODE_CHANGE: {
		pr_debug("CONTROL_IOCTL_WIMAX_MODE_CHANGE to 0x%02x..", val);

		if ((val < 0) || (val > AUTH_MODE)) {
			pr_debug("Wrong mode 0x%02x", val);
			return 0;
		}

		gpdata->power(0);
		gpdata->g_cfg->wimax_mode = val;
		ret = gpdata->power(1);
		break;
	}
	}	/* switch (cmd) */

	return ret;
}

static int swmxdev_open(struct inode *inode, struct file *file)
{
	struct wimax732_platform_data *pdata =
		container_of(file->private_data,
				struct wimax732_platform_data, swmxctl_dev);
	file->private_data = pdata;
	return 0;
}

static const struct file_operations swmx_fops = {
	.owner = THIS_MODULE,
	.open = swmxdev_open,
	.unlocked_ioctl = swmxdev_ioctl,
};

/*
*	uwibro functions
*	(send and receive control packet with WiMAX modem)
*/
static int uwbrdev_open(struct inode *inode, struct file *file)
{
	struct net_adapter	*adapter = container_of(file->private_data,
			struct net_adapter, uwibro_dev);
	struct process_descriptor	*procdsc;

	if ((adapter == NULL) || adapter->halted) {
		pr_debug("can't find adapter or Device Removed");
		return -ENODEV;
	}

	file->private_data = adapter;
	pr_debug("open: tgid=%d", current->tgid);

	if (!adapter->mac_ready || adapter->halted) {
		pr_debug("Device not ready Retry..");
		return -ENXIO;
	}

	/* init new process descriptor */
	procdsc = kmalloc(sizeof(*procdsc), GFP_KERNEL);
	if (procdsc == NULL) {
		pr_debug("uwbrdev_open: kmalloc fail!!");
		return -ENOMEM;
	}

	procdsc->id = current->tgid;
	procdsc->irp = false;
	procdsc->type = 0;
	init_waitqueue_head(&procdsc->read_wait);
	spin_lock(&adapter->ctl.apps.lock);
	list_add_tail(&procdsc->list, &adapter->ctl.apps.process_list);
	spin_unlock(&adapter->ctl.apps.lock);
	return 0;
}

static int uwbrdev_release(struct inode *inode, struct file *file)
{
	struct net_adapter		*adapter;
	struct process_descriptor	*procdsc;
	int				current_tgid = 0;

	pr_debug("release: tgid=%d, pid=%d", current->tgid, current->pid);

	adapter = (struct net_adapter *)(file->private_data);
	if (adapter == NULL) {
		pr_debug("can't find adapter");
		return -ENODEV;
	}

	current_tgid = current->tgid;
	procdsc = process_by_id(adapter, current_tgid);

	/* process is not exist. (open process != close process) */
	if (procdsc == NULL) {
		current_tgid = adapter->pdata->g_cfg->temp_tgid;
		pr_debug("release: pid changed: %d", current_tgid);
		procdsc = process_by_id(adapter, current_tgid);
	}

	if (procdsc == NULL) {
		/*not found */
		pr_debug("process %d not found", current_tgid);
		return -ESRCH;
	}

	/* RELEASE READ THREAD */
	if (procdsc->irp) {
		procdsc->irp = false;
		wake_up_interruptible(&procdsc->read_wait);
	}
	spin_lock(&adapter->ctl.apps.lock);
	remove_process(adapter, current_tgid);
	spin_unlock(&adapter->ctl.apps.lock);

	return 0;
}

static long uwbrdev_ioctl(struct file *file, u32 cmd,
			  unsigned long arg)
{
	struct net_adapter		*adapter;
	struct process_descriptor	*procdsc;
	int				ret = 0;
	struct eth_header *ctlhdr;
	u8				*tx_buffer;
	int length;

	adapter = (struct net_adapter *)(file->private_data);

	if ((adapter == NULL) || adapter->halted) {
		pr_debug("can't find adapter or Device Removed");
		return -ENODEV;
	}

	if (cmd != CONTROL_IOCTL_WRITE_REQUEST) {
		pr_debug("uwbrdev_ioctl: unknown ioctl cmd: 0x%x", cmd);
		return -EINVAL;
	}

	if ((char *)arg == NULL) {
		pr_debug("arg == NULL: return -EFAULT");
		return -EFAULT;
	}

	length = ((int *)arg)[0];

	if (length >= WIMAX_MAX_TOTAL_SIZE)
		return -EFBIG;

	tx_buffer = kmalloc(length, GFP_KERNEL);
	if (!tx_buffer) {
		pr_err("%s: not enough memory to allocate tx_buffer\n",
								__func__);
		return -ENOMEM;
	}

	if (copy_from_user(tx_buffer, (void *)(arg + sizeof(int)), length)) {
		pr_err("%s: error copying buffer from user space\n", __func__);
		ret = -EFAULT;
		goto err_copy;
	}

	spin_lock(&adapter->ctl.apps.lock);
	procdsc = process_by_id(adapter, current->tgid);
	if (procdsc == NULL) {
		pr_debug("process %d not found", current->tgid);
		ret = -EFAULT;
		goto err_process;
	}
	ctlhdr = (struct eth_header *)tx_buffer;
	procdsc->type = ctlhdr->type;

	control_send(adapter, tx_buffer, length);

err_process:
	spin_unlock(&adapter->ctl.apps.lock);
err_copy:
	kfree(tx_buffer);
	return ret;
}

static ssize_t uwbrdev_read(struct file *file, char *buf, size_t count,
								loff_t *ppos)
{
	struct buffer_descriptor	*bufdsc;
	struct net_adapter		*adapter;
	struct process_descriptor	*procdsc;
	int				rlen = 0;

	adapter = (struct net_adapter *)(file->private_data);
	if ((adapter == NULL) || adapter->halted) {
		pr_debug("can't find adapter or Device Removed");
		return -ENODEV;
	}

	if (buf == NULL) {
		pr_debug("BUFFER is NULL");
		return -EFAULT; /* bad address */
	}

	procdsc = process_by_id(adapter, current->tgid);
	if (procdsc == NULL) {
		pr_debug("uwbrdev_read: process %d not exist", current->tgid);
		return -ESRCH;
	}

	if (procdsc->irp == true) {
		pr_warn("%s: Read was sent twice by process %d\n", __func__,
								current->tgid);
		return -EEXIST;
	}

	bufdsc = buffer_by_type(adapter, procdsc->type);
	if (bufdsc == NULL) {
		procdsc->irp = true;
		if (wait_event_interruptible(procdsc->read_wait,
				((procdsc->irp == false) ||
				(adapter->halted == true)))) {
			procdsc->irp = false;
			adapter->pdata->g_cfg->temp_tgid = current->tgid;
			return -ERESTARTSYS;
		}
		if (adapter->halted) {
			pr_debug("uwbrdev_read: Card Removed"
					"Indicated to Appln...");
			procdsc->irp = false;
			adapter->pdata->g_cfg->temp_tgid = current->tgid;
			return -ENODEV;
		}
	}

	if (count == 1500) {	/* app passes read count as 1500 */
		spin_lock(&adapter->ctl.apps.lock);
		bufdsc = buffer_by_type(adapter, procdsc->type);
		if (!bufdsc) {
			pr_debug("uwbrdev_read: Fail...node is null");
			spin_unlock(&adapter->ctl.apps.lock);
			return -1;
		}
		spin_unlock(&adapter->ctl.apps.lock);

		if (copy_to_user(buf, bufdsc->buffer, bufdsc->length)) {
			pr_debug("uwbrdev_read: copy_to_user	\
				failed len=%u !!", bufdsc->length);
			return -EFAULT;
		}

		spin_lock(&adapter->ctl.apps.lock);
		rlen = bufdsc->length;
		list_del(&bufdsc->list);
		kfree(bufdsc->buffer);
		kfree(bufdsc);
		spin_unlock(&adapter->ctl.apps.lock);
	}

	return rlen;
}

static const struct file_operations uwbr_fops = {
	.owner = THIS_MODULE,
	.open = uwbrdev_open,
	.release	= uwbrdev_release,
	.unlocked_ioctl	= uwbrdev_ioctl,
	.read		= uwbrdev_read,
};

static int netdev_ethtool_ioctl(struct net_device *dev,
		void *useraddr)
{
	u32	ethcmd;
	struct ethtool_drvinfo info = {ETHTOOL_GDRVINFO};

	if (copy_from_user(&ethcmd, useraddr, sizeof(ethcmd)))
		return -EFAULT;

	if (ethcmd != ETHTOOL_GDRVINFO)
		return -EOPNOTSUPP;

	strncpy(info.driver, "C730USB", sizeof(info.driver) - 1);
	if (copy_to_user(useraddr, &info, sizeof(info)))
		return -EFAULT;

	return 0;
}

static struct net_device_stats *adapter_netdev_stats(struct net_device *dev)
{
	return &((struct net_adapter *)netdev_priv(dev))->netstats;
}

static int adapter_start_xmit(struct sk_buff *skb, struct net_device *net)
{
	struct net_adapter	*adapter = netdev_priv(net);
	int			len;

	if (!adapter->media_state || adapter->halted) {
		pr_debug("Driver already halted. Returning Failure...");
		dev_kfree_skb(skb);
		adapter->netstats.tx_dropped++;
		net->trans_start = jiffies;
		adapter->XmitErr += 1;
		return 0;
	}

	len = ((skb->len) & 0x3f) ? skb->len : skb->len + 1;
	hw_send_data(adapter, skb->data, len);
	dev_kfree_skb(skb);

	if (!adapter->media_state)
		netif_stop_queue(net);

	return 0;
}

static int adapter_open(struct net_device *net)
{
	struct net_adapter	*adapter;
	int			res = 0;

	adapter = netdev_priv(net);

	if (adapter == NULL || adapter->halted) {
		pr_debug("can't find adapter or halted");
		return -ENODEV;
	}

	if (adapter->media_state)
		netif_wake_queue(net);
	else
		netif_stop_queue(net);

	if (netif_msg_ifup(adapter))
		pr_debug("netif msg if up");

	res = 0;

	pr_debug("adapter driver open success!!!!!!!");

	return res;
}

static int adapter_close(struct net_device *net)
{
	pr_debug("adapter driver close success!!!!!!!");

	netif_stop_queue(net);
	return 0;
}

static int adapter_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
{
	struct net_adapter	*adapter = netdev_priv(net);

	if (adapter->halted) {
		pr_debug("Driver already halted. Returning Failure...");
		return STATUS_UNSUCCESSFUL;
	}

	switch (cmd) {
	case SIOCETHTOOL:
		return netdev_ethtool_ioctl(net, (void *)rq->ifr_data);
	default:
		return -EOPNOTSUPP;
	}

	return 0;
}

static void adapter_interrupt(struct sdio_func *func)
{
	struct hw_private_packet	hdr;
	struct net_adapter		*adapter = sdio_get_drvdata(func);
	int				err = 1;
	int				intrd = 0;

	wake_lock_timeout(&adapter->pdata->g_cfg->wimax_rxtx_lock, 0.2 * HZ);

	if (likely(!adapter->halted)) {
		/* read interrupt identification register */
		intrd = sdio_readb(func, SDIO_INT_STATUS_REG, NULL);

		sdio_writeb(func, intrd, SDIO_INT_STATUS_CLR_REG, NULL);

		if (likely(intrd & SDIO_INT_DATA_READY)) {
			adapter->rx_data_available = true;
			wake_up_interruptible(&adapter->receive_event);
		} else if (intrd & SDIO_INT_ERROR) {
			adapter->netstats.rx_errors++;
			pr_debug("adapter_sdio_rx_packet intrd ="
					"SDIO_INT_ERROR occurred!!");
		}
	} else {
		pr_debug("adapter->halted=true in	\
				adapter_interrupt !!!!!!!!!");

		/* send stop message */
		hdr.id0	 = 'W';
		hdr.id1	 = 'P';
		hdr.code  = HWCODEHALTEDINDICATION;
		hdr.value = 0;

		err = sd_send(adapter, (unsigned char *)&hdr,
				sizeof(struct hw_private_packet));
		if (err < 0) {
			pr_debug("adapter->halted=true and send"
				"HaltIndication to FW err = (%d) !!", err);
			return;
		}
	}
}

static struct net_device_ops wimax_net_ops = {
	.ndo_open				=	adapter_open,
	.ndo_stop				=	adapter_close,
	.ndo_get_stats			=	adapter_netdev_stats,
	.ndo_do_ioctl			=	adapter_ioctl,
	.ndo_start_xmit			=	adapter_start_xmit,
};

static int adapter_probe(struct sdio_func *func,
		const struct sdio_device_id *id)
{
	struct net_adapter	*adapter = NULL;
	struct net_device	*net;
	int			err = -ENOMEM;
	u8			 node_id[ETH_ALEN];

	pr_debug("probe");

	net = alloc_etherdev(sizeof(*adapter));
	if (!net) {
		pr_debug("adapter_probe: error can't allocate device");
		goto alloceth_fail;
	}

	adapter = netdev_priv(net);
	memset(adapter, 0, sizeof(*adapter));

	adapter->pdata = (struct wimax732_platform_data *) id->driver_data;
	adapter->pdata->g_cfg->card_removed = false;

	/* Initialize control */
	control_init(adapter);

	/* initialize hardware */
	err = wimax_hw_init(adapter);
	if (err) {
		pr_debug("adapter_probe: error can't allocate"
				"receive buffer");
		goto hwInit_fail;
	}

	strcpy(net->name, "uwbr%d");

	adapter->func = func;
	adapter->net = net;
	net->netdev_ops = &wimax_net_ops;
	net->watchdog_timeo = ADAPTER_TIMEOUT;
	net->mtu = WIMAX_MTU_SIZE;
	adapter->msg_enable = netif_msg_init(msg_level, NETIF_MSG_DRV
					| NETIF_MSG_PROBE | NETIF_MSG_LINK);

	ether_setup(net);
	net->flags |= IFF_NOARP;

	adapter->downloading = true;

	sdio_set_drvdata(func, adapter);

	SET_NETDEV_DEV(net, &func->dev);
	err = register_netdev(net);
	if (err)
		goto regdev_fail;

	netif_carrier_off(net);
	netif_tx_stop_all_queues(net);

	sdio_claim_host(adapter->func);
	err = sdio_enable_func(adapter->func);
	if (err < 0) {
		pr_debug("sdio_enable func error = %d", err);
		goto sdioen_fail;
	}

	err = sdio_claim_irq(adapter->func, adapter_interrupt);
	if (err < 0) {
		pr_debug("sdio_claim_irq = %d", err);
		goto sdioirq_fail;
	}
	sdio_set_block_size(adapter->func, 512);
	sdio_release_host(adapter->func);

	adapter->uwibro_dev.minor = UWBRBDEVMINOR;
	adapter->uwibro_dev.name = "uwibro";
	adapter->uwibro_dev.fops = &uwbr_fops;

	if (misc_register(&adapter->uwibro_dev) != 0) {
		pr_debug("adapter_probe: misc_register() failed");
		goto regchar_fail;
	}

	/* Dummy value for "ifconfig up" for 2.6.24 */
	random_ether_addr(node_id);
	memcpy(net->dev_addr, node_id, sizeof(node_id));

	err = wimax_hw_start(adapter);
	if (err) {
		/* Free the resources and stop the driver processing */
		misc_deregister(&adapter->uwibro_dev);
		pr_debug("wimax_hw_start failed");
		goto regchar_fail;
		goto regchar_fail;
	}

	return 0;

regchar_fail:
	adapter->halted = true;
	wake_up_interruptible(&adapter->send_event);
	wake_up_interruptible(&adapter->receive_event);
	sdio_claim_host(adapter->func);
	sdio_release_irq(adapter->func);
sdioirq_fail:
	sdio_disable_func(adapter->func);
sdioen_fail:
	sdio_release_host(adapter->func);
	unregister_netdev(adapter->net);
regdev_fail:
	sdio_set_drvdata(func, NULL);
	wimax_hw_remove(adapter);
hwInit_fail:
	free_netdev(net);
alloceth_fail:
	adapter->pdata->g_cfg->card_removed = true;
	adapter->pdata->power(0);
	return err;
}

static void adapter_remove(struct sdio_func *func)
{
	struct net_adapter	*adapter = sdio_get_drvdata(func);

	/* remove adapter from adapters array */

	wake_up_interruptible(&adapter->send_event);
	wake_up_interruptible(&adapter->receive_event);

	if (!adapter) {
		pr_debug("unregistering non-bound device?");
		return;
	}

	if (adapter->media_state == MEDIA_CONNECTED) {
		netif_stop_queue(adapter->net);
		adapter->media_state = MEDIA_DISCONNECTED;
	}

	if (!adapter->removed)
		wimax_hw_stop(adapter);	/* free hw in and out buffer */

	if (adapter->downloading) {
		adapter->removed = true;
		adapter->download_complete = true;
		wake_up_interruptible(&adapter->download_event);
	}

	if (!completion_done(&adapter->wakeup_event))
		complete(&adapter->wakeup_event);

	/* remove control process list */
	control_remove(adapter);
	/*remove hardware interface */
	wimax_hw_remove(adapter);

	misc_deregister(&adapter->uwibro_dev);
	if (adapter->net) {
		unregister_netdev(adapter->net);
		free_netdev(adapter->net);
	}
	adapter->pdata->g_cfg->card_removed = true;

	return;
}

static struct sdio_device_id adapter_table[] = {
	{ SDIO_DEVICE(0x98, 0x1) },
	{ }	/* Terminating entry */
};

/* wimax suspend function */
int wimax_suspend(struct platform_device *pdev, pm_message_t state)
{
	struct wimax732_platform_data	*pdata = pdev->dev.platform_data;

	pr_debug("wimax_suspend");
	if (pdata->g_cfg->card_removed)
		return 0;

	pdata = pdev->dev.platform_data;
	if (!mutex_trylock(&pdata->g_cfg->suspend_mutex)) {
		pr_debug("wimax send processing\n");
		return -EBUSY;
	}
	/* AP active pin LOW */
	pdata->signal_ap_active(0);

	/*
	* VI/Idle setting is controlled by framework.
	* We always set the the pin for Idle
	*/
	if (pdata->g_cfg->wimax_status == WIMAX_STATE_IDLE
		|| pdata->g_cfg->wimax_status == WIMAX_STATE_NORMAL) {
		/* set driver status IDLE */
		pdata->g_cfg->wimax_status = WIMAX_STATE_IDLE;
		pr_debug("WIMAX IDLE");
	} else
		pr_debug("WIMAX STATE NOT CHANGED!!");
	return 0;
}

/* wimax resume function */
int wimax_resume(struct platform_device *pdev)
{
	struct wimax732_platform_data	*pdata = pdev->dev.platform_data;

	pr_debug("wimax_resume");
	if (pdata->g_cfg->card_removed)
		return 0;

	/* AP active pin HIGH */
	pdata->signal_ap_active(1);

	/* wait wakeup noti for 1 sec otherwise suspend again */
	wake_lock_timeout(&pdata->g_cfg->wimax_wake_lock, 1 * HZ);

	mutex_unlock(&pdata->g_cfg->suspend_mutex);
	return 0;
}

static struct sdio_driver adapter_driver = {
	.name		= "C730SDIO",
	.probe		= adapter_probe,
	.remove		= adapter_remove,
	.id_table	= adapter_table,
};

static int wimax_probe(struct platform_device *pdev)
{
	struct wimax732_platform_data	*pdata = pdev->dev.platform_data;
	int error = 0;
	int	i;

	pr_debug("SDIO driver installing... " WIMAX_DRIVER_VERSION_STRING);

	pdata->swmxctl_dev.minor = SWMXGPIOMINOR;
	pdata->swmxctl_dev.name = "swmxctl";
	pdata->swmxctl_dev.fops = &swmx_fops;

	misc_register(&pdata->swmxctl_dev);

	if (error < 0) {
		pr_debug("misc_register() failed");
		return error;
	}
	mutex_init(&pdata->g_cfg->suspend_mutex);

	for (i = 0; i < ARRAY_SIZE(adapter_table); i++)
		adapter_table[i].driver_data =
			(unsigned long) pdev->dev.platform_data;

	/* register SDIO driver */
	error = sdio_register_driver(&adapter_driver);
	if (error < 0) {
		pr_debug("sdio_register_driver() failed");
		return error;
	}

	pdata->g_cfg->card_removed = true;
	pdata->power(0);

	/* initialize wake locks */
	wake_lock_init(&pdata->g_cfg->wimax_wake_lock,
			WAKE_LOCK_SUSPEND, "wimax_wakeup");
	wake_lock_init(&pdata->g_cfg->wimax_rxtx_lock,
			WAKE_LOCK_SUSPEND, "wimax_rxtx");
	wake_lock_init(&pdata->g_cfg->wimax_tx_lock,
			WAKE_LOCK_SUSPEND, "wimax_tx");

	return error;
}

static int wimax_remove(struct platform_device *pdev)
{
	struct wimax732_platform_data	*pdata = pdev->dev.platform_data;
	pr_debug("SDIO driver Uninstall");

	/* destroy wake locks */
	wake_lock_destroy(&pdata->g_cfg->wimax_wake_lock);
	wake_lock_destroy(&pdata->g_cfg->wimax_rxtx_lock);
	wake_lock_destroy(&pdata->g_cfg->wimax_tx_lock);

	sdio_unregister_driver(&adapter_driver);
	misc_deregister(&pdata->swmxctl_dev);
	return 0;
}

static struct platform_driver wimax_driver = {
	.probe          = wimax_probe,
	.remove         = wimax_remove,
	.suspend		= wimax_suspend,
	.resume			= wimax_resume,
	.driver         = {
	.name   = "wimax732_driver",
	}
};

static int __init adapter_init_module(void)
{
	return platform_driver_register(&wimax_driver);
}

static void __exit adapter_deinit_module(void)
{
	platform_driver_unregister(&wimax_driver);
}


module_init(adapter_init_module);
module_exit(adapter_deinit_module);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_PARM_DESC(msg_level, "Override default message level");
MODULE_DEVICE_TABLE(sdio, adapter_table);
MODULE_VERSION(WIMAX_DRIVER_VERSION_STRING);
MODULE_LICENSE("GPL");