[mirror_ubuntu-artful-kernel.git] / drivers / bluetooth / btwilink.c

/*
 *  Texas Instrument's Bluetooth Driver For Shared Transport.
 *
 *  Bluetooth Driver acts as interface between HCI core and
 *  TI Shared Transport Layer.
 *
 *  Copyright (C) 2009-2010 Texas Instruments
 *  Author: Raja Mani <raja_mani@ti.com>
 *	Pavan Savoy <pavan_savoy@ti.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include <linux/platform_device.h>
#include <net/bluetooth/bluetooth.h>
#include <net/bluetooth/hci_core.h>
#include <net/bluetooth/hci.h>

#include <linux/ti_wilink_st.h>
#include <linux/module.h>

/* Bluetooth Driver Version */
#define VERSION               "1.0"
#define MAX_BT_CHNL_IDS		3

/* Number of seconds to wait for registration completion
 * when ST returns PENDING status.
 */
#define BT_REGISTER_TIMEOUT   6000	/* 6 sec */

/**
 * struct ti_st - driver operation structure
 * @hdev: hci device pointer which binds to bt driver
 * @reg_status: ST registration callback status
 * @st_write: write function provided by the ST driver
 *	to be used by the driver during send_frame.
 * @wait_reg_completion - completion sync between ti_st_open
 *	and st_reg_completion_cb.
 */
struct ti_st {
	struct hci_dev *hdev;
	int reg_status;
	long (*st_write) (struct sk_buff *);
	struct completion wait_reg_completion;
};

/* Increments HCI counters based on pocket ID (cmd,acl,sco) */
static inline void ti_st_tx_complete(struct ti_st *hst, int pkt_type)
{
	struct hci_dev *hdev = hst->hdev;

	/* Update HCI stat counters */
	switch (pkt_type) {
	case HCI_COMMAND_PKT:
		hdev->stat.cmd_tx++;
		break;

	case HCI_ACLDATA_PKT:
		hdev->stat.acl_tx++;
		break;

	case HCI_SCODATA_PKT:
		hdev->stat.sco_tx++;
		break;
	}
}

/* ------- Interfaces to Shared Transport ------ */

/* Called by ST layer to indicate protocol registration completion
 * status.ti_st_open() function will wait for signal from this
 * API when st_register() function returns ST_PENDING.
 */
static void st_reg_completion_cb(void *priv_data, int data)
{
	struct ti_st *lhst = priv_data;

	/* Save registration status for use in ti_st_open() */
	lhst->reg_status = data;
	/* complete the wait in ti_st_open() */
	complete(&lhst->wait_reg_completion);
}

/* Called by Shared Transport layer when receive data is
 * available */
static long st_receive(void *priv_data, struct sk_buff *skb)
{
	struct ti_st *lhst = priv_data;
	int err;

	if (!skb)
		return -EFAULT;

	if (!lhst) {
		kfree_skb(skb);
		return -EFAULT;
	}

	/* Forward skb to HCI core layer */
	err = hci_recv_frame(lhst->hdev, skb);
	if (err < 0) {
		BT_ERR("Unable to push skb to HCI core(%d)", err);
		return err;
	}

	lhst->hdev->stat.byte_rx += skb->len;

	return 0;
}

/* ------- Interfaces to HCI layer ------ */
/* protocol structure registered with shared transport */
static struct st_proto_s ti_st_proto[MAX_BT_CHNL_IDS] = {
	{
		.chnl_id = HCI_EVENT_PKT, /* HCI Events */
		.hdr_len = sizeof(struct hci_event_hdr),
		.offset_len_in_hdr = offsetof(struct hci_event_hdr, plen),
		.len_size = 1, /* sizeof(plen) in struct hci_event_hdr */
		.reserve = 8,
	},
	{
		.chnl_id = HCI_ACLDATA_PKT, /* ACL */
		.hdr_len = sizeof(struct hci_acl_hdr),
		.offset_len_in_hdr = offsetof(struct hci_acl_hdr, dlen),
		.len_size = 2,	/* sizeof(dlen) in struct hci_acl_hdr */
		.reserve = 8,
	},
	{
		.chnl_id = HCI_SCODATA_PKT, /* SCO */
		.hdr_len = sizeof(struct hci_sco_hdr),
		.offset_len_in_hdr = offsetof(struct hci_sco_hdr, dlen),
		.len_size = 1, /* sizeof(dlen) in struct hci_sco_hdr */
		.reserve = 8,
	},
};

/* Called from HCI core to initialize the device */
static int ti_st_open(struct hci_dev *hdev)
{
	unsigned long timeleft;
	struct ti_st *hst;
	int err, i;

	BT_DBG("%s %p", hdev->name, hdev);

	/* provide contexts for callbacks from ST */
	hst = hci_get_drvdata(hdev);

	for (i = 0; i < MAX_BT_CHNL_IDS; i++) {
		ti_st_proto[i].priv_data = hst;
		ti_st_proto[i].max_frame_size = HCI_MAX_FRAME_SIZE;
		ti_st_proto[i].recv = st_receive;
		ti_st_proto[i].reg_complete_cb = st_reg_completion_cb;

		/* Prepare wait-for-completion handler */
		init_completion(&hst->wait_reg_completion);
		/* Reset ST registration callback status flag,
		 * this value will be updated in
		 * st_reg_completion_cb()
		 * function whenever it called from ST driver.
		 */
		hst->reg_status = -EINPROGRESS;

		err = st_register(&ti_st_proto[i]);
		if (!err)
			goto done;

		if (err != -EINPROGRESS) {
			BT_ERR("st_register failed %d", err);
			return err;
		}

		/* ST is busy with either protocol
		 * registration or firmware download.
		 */
		BT_DBG("waiting for registration "
				"completion signal from ST");
		timeleft = wait_for_completion_timeout
			(&hst->wait_reg_completion,
			 msecs_to_jiffies(BT_REGISTER_TIMEOUT));
		if (!timeleft) {
			BT_ERR("Timeout(%d sec),didn't get reg "
					"completion signal from ST",
					BT_REGISTER_TIMEOUT / 1000);
			return -ETIMEDOUT;
		}

		/* Is ST registration callback
		 * called with ERROR status? */
		if (hst->reg_status != 0) {
			BT_ERR("ST registration completed with invalid "
					"status %d", hst->reg_status);
			return -EAGAIN;
		}

done:
		hst->st_write = ti_st_proto[i].write;
		if (!hst->st_write) {
			BT_ERR("undefined ST write function");
			for (i = 0; i < MAX_BT_CHNL_IDS; i++) {
				/* Undo registration with ST */
				err = st_unregister(&ti_st_proto[i]);
				if (err)
					BT_ERR("st_unregister() failed with "
							"error %d", err);
				hst->st_write = NULL;
			}
			return -EIO;
		}
	}
	return 0;
}

/* Close device */
static int ti_st_close(struct hci_dev *hdev)
{
	int err, i;
	struct ti_st *hst = hci_get_drvdata(hdev);

	for (i = MAX_BT_CHNL_IDS-1; i >= 0; i--) {
		err = st_unregister(&ti_st_proto[i]);
		if (err)
			BT_ERR("st_unregister(%d) failed with error %d",
					ti_st_proto[i].chnl_id, err);
	}

	hst->st_write = NULL;

	return err;
}

static int ti_st_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
{
	struct ti_st *hst;
	long len;
	int pkt_type;

	hst = hci_get_drvdata(hdev);

	/* Prepend skb with frame type */
	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);

	BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
	       skb->len);

	/* Insert skb to shared transport layer's transmit queue.
	 * Freeing skb memory is taken care in shared transport layer,
	 * so don't free skb memory here.
	 */
	pkt_type = hci_skb_pkt_type(skb);
	len = hst->st_write(skb);
	if (len < 0) {
		BT_ERR("ST write failed (%ld)", len);
		/* Try Again, would only fail if UART has gone bad */
		return -EAGAIN;
	}

	/* ST accepted our skb. So, Go ahead and do rest */
	hdev->stat.byte_tx += len;
	ti_st_tx_complete(hst, pkt_type);

	return 0;
}

static int bt_ti_probe(struct platform_device *pdev)
{
	static struct ti_st *hst;
	struct hci_dev *hdev;
	int err;

	hst = devm_kzalloc(&pdev->dev, sizeof(struct ti_st), GFP_KERNEL);
	if (!hst)
		return -ENOMEM;

	/* Expose "hciX" device to user space */
	hdev = hci_alloc_dev();
	if (!hdev)
		return -ENOMEM;

	BT_DBG("hdev %p", hdev);

	hst->hdev = hdev;
	hdev->bus = HCI_UART;
	hci_set_drvdata(hdev, hst);
	hdev->open = ti_st_open;
	hdev->close = ti_st_close;
	hdev->flush = NULL;
	hdev->send = ti_st_send_frame;

	err = hci_register_dev(hdev);
	if (err < 0) {
		BT_ERR("Can't register HCI device error %d", err);
		hci_free_dev(hdev);
		return err;
	}

	BT_DBG("HCI device registered (hdev %p)", hdev);

	dev_set_drvdata(&pdev->dev, hst);
	return 0;
}

static int bt_ti_remove(struct platform_device *pdev)
{
	struct hci_dev *hdev;
	struct ti_st *hst = dev_get_drvdata(&pdev->dev);

	if (!hst)
		return -EFAULT;

	BT_DBG("%s", hst->hdev->name);

	hdev = hst->hdev;
	ti_st_close(hdev);
	hci_unregister_dev(hdev);

	hci_free_dev(hdev);

	dev_set_drvdata(&pdev->dev, NULL);
	return 0;
}

static struct platform_driver btwilink_driver = {
	.probe = bt_ti_probe,
	.remove = bt_ti_remove,
	.driver = {
		.name = "btwilink",
	},
};

module_platform_driver(btwilink_driver);

/* ------ Module Info ------ */

MODULE_AUTHOR("Raja Mani <raja_mani@ti.com>");
MODULE_DESCRIPTION("Bluetooth Driver for TI Shared Transport" VERSION);
MODULE_VERSION(VERSION);
MODULE_LICENSE("GPL");
Commit	Line	Data
363907af PS	1	/*
	2	* Texas Instrument's Bluetooth Driver For Shared Transport.
	3	*
	4	* Bluetooth Driver acts as interface between HCI core and
	5	* TI Shared Transport Layer.
	6	*
	7	* Copyright (C) 2009-2010 Texas Instruments
	8	* Author: Raja Mani <raja_mani@ti.com>
	9	* Pavan Savoy <pavan_savoy@ti.com>
	10	*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of the GNU General Public License version 2 as
	13	* published by the Free Software Foundation.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	23	*
	24	*/
4541c561	25
363907af PS	26	#include <linux/platform_device.h>
	27	#include <net/bluetooth/bluetooth.h>
	28	#include <net/bluetooth/hci_core.h>
	29	#include <net/bluetooth/hci.h>
	30
	31	#include <linux/ti_wilink_st.h>
a59b968e	32	#include <linux/module.h>
363907af PS	33
	34	/* Bluetooth Driver Version */
	35	#define VERSION "1.0"
	36	#define MAX_BT_CHNL_IDS 3
	37
	38	/* Number of seconds to wait for registration completion
	39	* when ST returns PENDING status.
	40	*/
	41	#define BT_REGISTER_TIMEOUT 6000 /* 6 sec */
	42
	43	/**
	44	* struct ti_st - driver operation structure
	45	* @hdev: hci device pointer which binds to bt driver
	46	* @reg_status: ST registration callback status
	47	* @st_write: write function provided by the ST driver
	48	* to be used by the driver during send_frame.
	49	* @wait_reg_completion - completion sync between ti_st_open
	50	* and st_reg_completion_cb.
	51	*/
	52	struct ti_st {
	53	struct hci_dev *hdev;
4360fa22	54	int reg_status;
363907af PS	55	long (st_write) (struct sk_buff );
	56	struct completion wait_reg_completion;
	57	};
	58
	59	/* Increments HCI counters based on pocket ID (cmd,acl,sco) */
	60	static inline void ti_st_tx_complete(struct ti_st *hst, int pkt_type)
	61	{
	62	struct hci_dev *hdev = hst->hdev;
	63
	64	/* Update HCI stat counters */
	65	switch (pkt_type) {
	66	case HCI_COMMAND_PKT:
	67	hdev->stat.cmd_tx++;
	68	break;
	69
	70	case HCI_ACLDATA_PKT:
	71	hdev->stat.acl_tx++;
	72	break;
	73
	74	case HCI_SCODATA_PKT:
	75	hdev->stat.sco_tx++;
	76	break;
	77	}
	78	}
	79
	80	/* ------- Interfaces to Shared Transport ------ */
	81
	82	/* Called by ST layer to indicate protocol registration completion
	83	* status.ti_st_open() function will wait for signal from this
	84	* API when st_register() function returns ST_PENDING.
	85	*/
4360fa22	86	static void st_reg_completion_cb(void *priv_data, int data)
363907af PS	87	{
	88	struct ti_st *lhst = priv_data;
	89
	90	/* Save registration status for use in ti_st_open() */
	91	lhst->reg_status = data;
	92	/* complete the wait in ti_st_open() */
	93	complete(&lhst->wait_reg_completion);
	94	}
	95
	96	/* Called by Shared Transport layer when receive data is
	97	* available */
	98	static long st_receive(void priv_data, struct sk_buff skb)
	99	{
	100	struct ti_st *lhst = priv_data;
	101	int err;
	102
	103	if (!skb)
	104	return -EFAULT;
	105
	106	if (!lhst) {
	107	kfree_skb(skb);
	108	return -EFAULT;
	109	}
	110
363907af	111	/* Forward skb to HCI core layer */
e1a26170	112	err = hci_recv_frame(lhst->hdev, skb);
363907af PS	113	if (err < 0) {
	114	BT_ERR("Unable to push skb to HCI core(%d)", err);
	115	return err;
	116	}
	117
	118	lhst->hdev->stat.byte_rx += skb->len;
	119
	120	return 0;
	121	}
	122
	123	/* ------- Interfaces to HCI layer ------ */
	124	/* protocol structure registered with shared transport */
	125	static struct st_proto_s ti_st_proto[MAX_BT_CHNL_IDS] = {
8be964d2 CG	126	{
	127	.chnl_id = HCI_EVENT_PKT, /* HCI Events */
	128	.hdr_len = sizeof(struct hci_event_hdr),
	129	.offset_len_in_hdr = offsetof(struct hci_event_hdr, plen),
	130	.len_size = 1, /* sizeof(plen) in struct hci_event_hdr */
	131	.reserve = 8,
	132	},
363907af PS	133	{
	134	.chnl_id = HCI_ACLDATA_PKT, /* ACL */
	135	.hdr_len = sizeof(struct hci_acl_hdr),
	136	.offset_len_in_hdr = offsetof(struct hci_acl_hdr, dlen),
	137	.len_size = 2, /* sizeof(dlen) in struct hci_acl_hdr */
	138	.reserve = 8,
	139	},
	140	{
	141	.chnl_id = HCI_SCODATA_PKT, /* SCO */
	142	.hdr_len = sizeof(struct hci_sco_hdr),
	143	.offset_len_in_hdr = offsetof(struct hci_sco_hdr, dlen),
	144	.len_size = 1, /* sizeof(dlen) in struct hci_sco_hdr */
	145	.reserve = 8,
	146	},
363907af PS	147	};
	148
	149	/* Called from HCI core to initialize the device */
	150	static int ti_st_open(struct hci_dev *hdev)
	151	{
	152	unsigned long timeleft;
	153	struct ti_st *hst;
	154	int err, i;
	155
	156	BT_DBG("%s %p", hdev->name, hdev);
	157
363907af	158	/* provide contexts for callbacks from ST */
155961e8	159	hst = hci_get_drvdata(hdev);
363907af PS	160
	161	for (i = 0; i < MAX_BT_CHNL_IDS; i++) {
	162	ti_st_proto[i].priv_data = hst;
	163	ti_st_proto[i].max_frame_size = HCI_MAX_FRAME_SIZE;
	164	ti_st_proto[i].recv = st_receive;
	165	ti_st_proto[i].reg_complete_cb = st_reg_completion_cb;
	166
	167	/* Prepare wait-for-completion handler */
	168	init_completion(&hst->wait_reg_completion);
	169	/* Reset ST registration callback status flag,
	170	* this value will be updated in
	171	* st_reg_completion_cb()
	172	* function whenever it called from ST driver.
	173	*/
	174	hst->reg_status = -EINPROGRESS;
	175
	176	err = st_register(&ti_st_proto[i]);
	177	if (!err)
	178	goto done;
	179
	180	if (err != -EINPROGRESS) {
363907af PS	181	BT_ERR("st_register failed %d", err);
	182	return err;
	183	}
	184
	185	/* ST is busy with either protocol
	186	* registration or firmware download.
	187	*/
	188	BT_DBG("waiting for registration "
	189	"completion signal from ST");
	190	timeleft = wait_for_completion_timeout
	191	(&hst->wait_reg_completion,
	192	msecs_to_jiffies(BT_REGISTER_TIMEOUT));
	193	if (!timeleft) {
363907af PS	194	BT_ERR("Timeout(%d sec),didn't get reg "
	195	"completion signal from ST",
	196	BT_REGISTER_TIMEOUT / 1000);
	197	return -ETIMEDOUT;
	198	}
	199
	200	/* Is ST registration callback
	201	* called with ERROR status? */
	202	if (hst->reg_status != 0) {
363907af PS	203	BT_ERR("ST registration completed with invalid "
	204	"status %d", hst->reg_status);
	205	return -EAGAIN;
	206	}
	207
	208	done:
	209	hst->st_write = ti_st_proto[i].write;
	210	if (!hst->st_write) {
	211	BT_ERR("undefined ST write function");
363907af PS	212	for (i = 0; i < MAX_BT_CHNL_IDS; i++) {
	213	/* Undo registration with ST */
	214	err = st_unregister(&ti_st_proto[i]);
	215	if (err)
	216	BT_ERR("st_unregister() failed with "
	217	"error %d", err);
	218	hst->st_write = NULL;
	219	}
	220	return -EIO;
	221	}
	222	}
	223	return 0;
	224	}
	225
	226	/* Close device */
	227	static int ti_st_close(struct hci_dev *hdev)
	228	{
	229	int err, i;
155961e8	230	struct ti_st *hst = hci_get_drvdata(hdev);
363907af	231
8be964d2	232	for (i = MAX_BT_CHNL_IDS-1; i >= 0; i--) {
363907af PS	233	err = st_unregister(&ti_st_proto[i]);
	234	if (err)
	235	BT_ERR("st_unregister(%d) failed with error %d",
	236	ti_st_proto[i].chnl_id, err);
	237	}
	238
	239	hst->st_write = NULL;
	240
	241	return err;
	242	}
	243
7bd8f09f	244	static int ti_st_send_frame(struct hci_dev hdev, struct sk_buff skb)
363907af	245	{
363907af PS	246	struct ti_st *hst;
363907af PS	247	long len;
acf91ec3	248	int pkt_type;
363907af	249
155961e8	250	hst = hci_get_drvdata(hdev);
363907af PS	251
363907af PS	252	/* Prepend skb with frame type */
618e8bc2	253	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
363907af	254
618e8bc2 MH	255	BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
618e8bc2 MH	256	skb->len);
363907af PS	257
	258	/* Insert skb to shared transport layer's transmit queue.
	259	* Freeing skb memory is taken care in shared transport layer,
	260	* so don't free skb memory here.
	261	*/
acf91ec3	262	pkt_type = hci_skb_pkt_type(skb);
363907af PS	263	len = hst->st_write(skb);
363907af PS	264	if (len < 0) {
363907af PS	265	BT_ERR("ST write failed (%ld)", len);
	266	/* Try Again, would only fail if UART has gone bad */
	267	return -EAGAIN;
	268	}
	269
	270	/* ST accepted our skb. So, Go ahead and do rest */
	271	hdev->stat.byte_tx += len;
acf91ec3	272	ti_st_tx_complete(hst, pkt_type);
363907af PS	273
	274	return 0;
	275	}
	276
363907af PS	277	static int bt_ti_probe(struct platform_device *pdev)
	278	{
	279	static struct ti_st *hst;
	280	struct hci_dev *hdev;
	281	int err;
	282
4f8d8158	283	hst = devm_kzalloc(&pdev->dev, sizeof(struct ti_st), GFP_KERNEL);
363907af PS	284	if (!hst)
	285	return -ENOMEM;
	286
	287	/* Expose "hciX" device to user space */
	288	hdev = hci_alloc_dev();
4f8d8158	289	if (!hdev)
363907af	290	return -ENOMEM;
363907af PS	291
	292	BT_DBG("hdev %p", hdev);
	293
	294	hst->hdev = hdev;
	295	hdev->bus = HCI_UART;
155961e8	296	hci_set_drvdata(hdev, hst);
363907af PS	297	hdev->open = ti_st_open;
	298	hdev->close = ti_st_close;
	299	hdev->flush = NULL;
	300	hdev->send = ti_st_send_frame;
363907af PS	301
	302	err = hci_register_dev(hdev);
	303	if (err < 0) {
	304	BT_ERR("Can't register HCI device error %d", err);
363907af PS	305	hci_free_dev(hdev);
	306	return err;
	307	}
	308
	309	BT_DBG("HCI device registered (hdev %p)", hdev);
	310
	311	dev_set_drvdata(&pdev->dev, hst);
6add49ff	312	return 0;
363907af PS	313	}
	314
	315	static int bt_ti_remove(struct platform_device *pdev)
	316	{
	317	struct hci_dev *hdev;
	318	struct ti_st *hst = dev_get_drvdata(&pdev->dev);
	319
	320	if (!hst)
	321	return -EFAULT;
	322
	323	BT_DBG("%s", hst->hdev->name);
	324
	325	hdev = hst->hdev;
	326	ti_st_close(hdev);
	327	hci_unregister_dev(hdev);
	328
	329	hci_free_dev(hdev);
363907af PS	330
	331	dev_set_drvdata(&pdev->dev, NULL);
	332	return 0;
	333	}
	334
	335	static struct platform_driver btwilink_driver = {
	336	.probe = bt_ti_probe,
	337	.remove = bt_ti_remove,
	338	.driver = {
	339	.name = "btwilink",
363907af PS	340	},
	341	};
	342
9712ba0b	343	module_platform_driver(btwilink_driver);
363907af PS	344
	345	/* ------ Module Info ------ */
	346
	347	MODULE_AUTHOR("Raja Mani <raja_mani@ti.com>");
	348	MODULE_DESCRIPTION("Bluetooth Driver for TI Shared Transport" VERSION);
	349	MODULE_VERSION(VERSION);
	350	MODULE_LICENSE("GPL");