[mirror_ubuntu-bionic-kernel.git] / net / mac802154 / ieee802154_dev.c

/*
 * Copyright (C) 2007-2012 Siemens AG
 *
 * Written by:
 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
 *
 * Based on the code from 'linux-zigbee.sourceforge.net' project.
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/netdevice.h>

#include <net/netlink.h>
#include <linux/nl802154.h>
#include <net/mac802154.h>
#include <net/route.h>
#include <net/wpan-phy.h>

#include "mac802154.h"

int mac802154_slave_open(struct net_device *dev)
{
	struct mac802154_sub_if_data *priv = netdev_priv(dev);
	struct mac802154_priv *ipriv = priv->hw;
	int res = 0;

	if (ipriv->open_count++ == 0) {
		res = ipriv->ops->start(&ipriv->hw);
		WARN_ON(res);
		if (res)
			goto err;
	}

	if (ipriv->ops->ieee_addr) {
		res = ipriv->ops->ieee_addr(&ipriv->hw, dev->dev_addr);
		WARN_ON(res);
		if (res)
			goto err;
		mac802154_dev_set_ieee_addr(dev);
	}

	netif_start_queue(dev);
	return 0;
err:
	priv->hw->open_count--;

	return res;
}

int mac802154_slave_close(struct net_device *dev)
{
	struct mac802154_sub_if_data *priv = netdev_priv(dev);
	struct mac802154_priv *ipriv = priv->hw;

	netif_stop_queue(dev);

	if (!--ipriv->open_count)
		ipriv->ops->stop(&ipriv->hw);

	return 0;
}

static int
mac802154_netdev_register(struct wpan_phy *phy, struct net_device *dev)
{
	struct mac802154_sub_if_data *priv;
	struct mac802154_priv *ipriv;
	int err;

	ipriv = wpan_phy_priv(phy);

	priv = netdev_priv(dev);
	priv->dev = dev;
	priv->hw = ipriv;

	dev->needed_headroom = ipriv->hw.extra_tx_headroom;

	SET_NETDEV_DEV(dev, &ipriv->phy->dev);

	mutex_lock(&ipriv->slaves_mtx);
	if (!ipriv->running) {
		mutex_unlock(&ipriv->slaves_mtx);
		return -ENODEV;
	}
	mutex_unlock(&ipriv->slaves_mtx);

	err = register_netdev(dev);
	if (err < 0)
		return err;

	rtnl_lock();
	mutex_lock(&ipriv->slaves_mtx);
	list_add_tail_rcu(&priv->list, &ipriv->slaves);
	mutex_unlock(&ipriv->slaves_mtx);
	rtnl_unlock();

	return 0;
}

static void
mac802154_del_iface(struct wpan_phy *phy, struct net_device *dev)
{
	struct mac802154_sub_if_data *sdata;
	ASSERT_RTNL();

	sdata = netdev_priv(dev);

	BUG_ON(sdata->hw->phy != phy);

	mutex_lock(&sdata->hw->slaves_mtx);
	list_del_rcu(&sdata->list);
	mutex_unlock(&sdata->hw->slaves_mtx);

	synchronize_rcu();
	unregister_netdevice(sdata->dev);
}

static struct net_device *
mac802154_add_iface(struct wpan_phy *phy, const char *name, int type)
{
	struct net_device *dev;
	int err = -ENOMEM;

	switch (type) {
	case IEEE802154_DEV_MONITOR:
		dev = alloc_netdev(sizeof(struct mac802154_sub_if_data),
				   name, mac802154_monitor_setup);
		break;
	case IEEE802154_DEV_WPAN:
		dev = alloc_netdev(sizeof(struct mac802154_sub_if_data),
				   name, mac802154_wpan_setup);
		break;
	default:
		dev = NULL;
		err = -EINVAL;
		break;
	}
	if (!dev)
		goto err;

	err = mac802154_netdev_register(phy, dev);
	if (err)
		goto err_free;

	dev_hold(dev); /* we return an incremented device refcount */
	return dev;

err_free:
	free_netdev(dev);
err:
	return ERR_PTR(err);
}

static int mac802154_set_txpower(struct wpan_phy *phy, int db)
{
	struct mac802154_priv *priv = wpan_phy_priv(phy);

	if (!priv->ops->set_txpower)
		return -ENOTSUPP;

	return priv->ops->set_txpower(&priv->hw, db);
}

struct ieee802154_dev *
ieee802154_alloc_device(size_t priv_data_len, struct ieee802154_ops *ops)
{
	struct wpan_phy *phy;
	struct mac802154_priv *priv;
	size_t priv_size;

	if (!ops || !ops->xmit || !ops->ed || !ops->start ||
	    !ops->stop || !ops->set_channel) {
		pr_err("undefined IEEE802.15.4 device operations\n");
		return NULL;
	}

	/* Ensure 32-byte alignment of our private data and hw private data.
	 * We use the wpan_phy priv data for both our mac802154_priv and for
	 * the driver's private data
	 *
	 * in memory it'll be like this:
	 *
	 * +-----------------------+
	 * | struct wpan_phy       |
	 * +-----------------------+
	 * | struct mac802154_priv |
	 * +-----------------------+
	 * | driver's private data |
	 * +-----------------------+
	 *
	 * Due to ieee802154 layer isn't aware of driver and MAC structures,
	 * so lets allign them here.
	 */

	priv_size = ALIGN(sizeof(*priv), NETDEV_ALIGN) + priv_data_len;

	phy = wpan_phy_alloc(priv_size);
	if (!phy) {
		pr_err("failure to allocate master IEEE802.15.4 device\n");
		return NULL;
	}

	priv = wpan_phy_priv(phy);
	priv->hw.phy = priv->phy = phy;
	priv->hw.priv = (char *)priv + ALIGN(sizeof(*priv), NETDEV_ALIGN);
	priv->ops = ops;

	INIT_LIST_HEAD(&priv->slaves);
	mutex_init(&priv->slaves_mtx);

	return &priv->hw;
}
EXPORT_SYMBOL(ieee802154_alloc_device);

void ieee802154_free_device(struct ieee802154_dev *hw)
{
	struct mac802154_priv *priv = mac802154_to_priv(hw);

	BUG_ON(!list_empty(&priv->slaves));

	mutex_destroy(&priv->slaves_mtx);

	wpan_phy_free(priv->phy);
}
EXPORT_SYMBOL(ieee802154_free_device);

int ieee802154_register_device(struct ieee802154_dev *dev)
{
	struct mac802154_priv *priv = mac802154_to_priv(dev);
	int rc = -ENOMEM;

	priv->dev_workqueue =
		create_singlethread_workqueue(wpan_phy_name(priv->phy));
	if (!priv->dev_workqueue)
		goto out;

	wpan_phy_set_dev(priv->phy, priv->hw.parent);

	priv->phy->add_iface = mac802154_add_iface;
	priv->phy->del_iface = mac802154_del_iface;
	priv->phy->set_txpower = mac802154_set_txpower;

	rc = wpan_phy_register(priv->phy);
	if (rc < 0)
		goto out_wq;

	rtnl_lock();

	mutex_lock(&priv->slaves_mtx);
	priv->running = MAC802154_DEVICE_RUN;
	mutex_unlock(&priv->slaves_mtx);

	rtnl_unlock();

	return 0;

out_wq:
	destroy_workqueue(priv->dev_workqueue);
out:
	return rc;
}
EXPORT_SYMBOL(ieee802154_register_device);

void ieee802154_unregister_device(struct ieee802154_dev *dev)
{
	struct mac802154_priv *priv = mac802154_to_priv(dev);
	struct mac802154_sub_if_data *sdata, *next;

	flush_workqueue(priv->dev_workqueue);
	destroy_workqueue(priv->dev_workqueue);

	rtnl_lock();

	mutex_lock(&priv->slaves_mtx);
	priv->running = MAC802154_DEVICE_STOPPED;
	mutex_unlock(&priv->slaves_mtx);

	list_for_each_entry_safe(sdata, next, &priv->slaves, list) {
		mutex_lock(&sdata->hw->slaves_mtx);
		list_del(&sdata->list);
		mutex_unlock(&sdata->hw->slaves_mtx);

		unregister_netdevice(sdata->dev);
	}

	rtnl_unlock();

	wpan_phy_unregister(priv->phy);
}
EXPORT_SYMBOL(ieee802154_unregister_device);

MODULE_DESCRIPTION("IEEE 802.15.4 implementation");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
1010f540	1	/*
	2	* Copyright (C) 2007-2012 Siemens AG
	3	*
	4	* Written by:
	5	* Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
	6	*
	7	* Based on the code from 'linux-zigbee.sourceforge.net' project.
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2
	11	* as published by the Free Software Foundation.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License along
	19	* with this program; if not, write to the Free Software Foundation, Inc.,
	20	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	21	*/
	22
	23	#include <linux/kernel.h>
	24	#include <linux/module.h>
	25	#include <linux/netdevice.h>
	26
62610ad2	27	#include <net/netlink.h>
62610ad2	28	#include <linux/nl802154.h>
1010f540	29	#include <net/mac802154.h>
	30	#include <net/route.h>
	31	#include <net/wpan-phy.h>
	32
	33	#include "mac802154.h"
	34
62610ad2	35	int mac802154_slave_open(struct net_device *dev)
	36	{
	37	struct mac802154_sub_if_data *priv = netdev_priv(dev);
	38	struct mac802154_priv *ipriv = priv->hw;
	39	int res = 0;
	40
	41	if (ipriv->open_count++ == 0) {
	42	res = ipriv->ops->start(&ipriv->hw);
	43	WARN_ON(res);
	44	if (res)
	45	goto err;
	46	}
	47
	48	if (ipriv->ops->ieee_addr) {
	49	res = ipriv->ops->ieee_addr(&ipriv->hw, dev->dev_addr);
	50	WARN_ON(res);
	51	if (res)
	52	goto err;
	53	mac802154_dev_set_ieee_addr(dev);
	54	}
	55
	56	netif_start_queue(dev);
	57	return 0;
	58	err:
	59	priv->hw->open_count--;
	60
	61	return res;
	62	}
	63
	64	int mac802154_slave_close(struct net_device *dev)
	65	{
	66	struct mac802154_sub_if_data *priv = netdev_priv(dev);
	67	struct mac802154_priv *ipriv = priv->hw;
	68
	69	netif_stop_queue(dev);
	70
	71	if (!--ipriv->open_count)
	72	ipriv->ops->stop(&ipriv->hw);
	73
	74	return 0;
	75	}
	76
	77	static int
	78	mac802154_netdev_register(struct wpan_phy phy, struct net_device dev)
	79	{
	80	struct mac802154_sub_if_data *priv;
	81	struct mac802154_priv *ipriv;
	82	int err;
	83
	84	ipriv = wpan_phy_priv(phy);
	85
	86	priv = netdev_priv(dev);
	87	priv->dev = dev;
	88	priv->hw = ipriv;
	89
	90	dev->needed_headroom = ipriv->hw.extra_tx_headroom;
	91
	92	SET_NETDEV_DEV(dev, &ipriv->phy->dev);
	93
	94	mutex_lock(&ipriv->slaves_mtx);
	95	if (!ipriv->running) {
	96	mutex_unlock(&ipriv->slaves_mtx);
	97	return -ENODEV;
	98	}
99	mutex_unlock(&ipriv->slaves_mtx);
100
101	err = register_netdev(dev);
102	if (err < 0)
103	return err;
104
105	rtnl_lock();
106	mutex_lock(&ipriv->slaves_mtx);
107	list_add_tail_rcu(&priv->list, &ipriv->slaves);
108	mutex_unlock(&ipriv->slaves_mtx);
109	rtnl_unlock();
110
111	return 0;
112	}
113
114	static void
115	mac802154_del_iface(struct wpan_phy phy, struct net_device dev)
116	{
117	struct mac802154_sub_if_data *sdata;
118	ASSERT_RTNL();
119
120	sdata = netdev_priv(dev);
121
122	BUG_ON(sdata->hw->phy != phy);
123
124	mutex_lock(&sdata->hw->slaves_mtx);
125	list_del_rcu(&sdata->list);
126	mutex_unlock(&sdata->hw->slaves_mtx);
127
128	synchronize_rcu();
129	unregister_netdevice(sdata->dev);
130	}
131
132	static struct net_device *
133	mac802154_add_iface(struct wpan_phy phy, const char name, int type)
134	{
135	struct net_device *dev;
136	int err = -ENOMEM;
137
62610ad2	138	switch (type) {
0606069d	139	case IEEE802154_DEV_MONITOR:
	140	dev = alloc_netdev(sizeof(struct mac802154_sub_if_data),
	141	name, mac802154_monitor_setup);
	142	break;
32bad7e3	143	case IEEE802154_DEV_WPAN:
	144	dev = alloc_netdev(sizeof(struct mac802154_sub_if_data),
	145	name, mac802154_wpan_setup);
	146	break;
62610ad2	147	default:
	148	dev = NULL;
	149	err = -EINVAL;
	150	break;
	151	}
	152	if (!dev)
	153	goto err;
	154
	155	err = mac802154_netdev_register(phy, dev);
	156	if (err)
	157	goto err_free;
	158
	159	dev_hold(dev); /* we return an incremented device refcount */
	160	return dev;
	161
	162	err_free:
	163	free_netdev(dev);
	164	err:
	165	return ERR_PTR(err);
	166	}
	167
9b2777d6 PB	168	static int mac802154_set_txpower(struct wpan_phy *phy, int db)
	169	{
	170	struct mac802154_priv *priv = wpan_phy_priv(phy);
	171
	172	if (!priv->ops->set_txpower)
	173	return -ENOTSUPP;
	174
	175	return priv->ops->set_txpower(&priv->hw, db);
	176	}
	177
1010f540	178	struct ieee802154_dev *
	179	ieee802154_alloc_device(size_t priv_data_len, struct ieee802154_ops *ops)
	180	{
	181	struct wpan_phy *phy;
	182	struct mac802154_priv *priv;
	183	size_t priv_size;
	184
	185	if (!ops \|\| !ops->xmit \|\| !ops->ed \|\| !ops->start \|\|
	186	!ops->stop \|\| !ops->set_channel) {
83a1a7ce	187	pr_err("undefined IEEE802.15.4 device operations\n");
1010f540	188	return NULL;
	189	}
	190
	191	/* Ensure 32-byte alignment of our private data and hw private data.
	192	* We use the wpan_phy priv data for both our mac802154_priv and for
	193	* the driver's private data
	194	*
	195	* in memory it'll be like this:
	196	*
	197	* +-----------------------+
	198	* \| struct wpan_phy \|
	199	* +-----------------------+
	200	* \| struct mac802154_priv \|
	201	* +-----------------------+
	202	* \| driver's private data \|
	203	* +-----------------------+
	204	*
	205	* Due to ieee802154 layer isn't aware of driver and MAC structures,
	206	* so lets allign them here.
	207	*/
	208
	209	priv_size = ALIGN(sizeof(*priv), NETDEV_ALIGN) + priv_data_len;
	210
	211	phy = wpan_phy_alloc(priv_size);
	212	if (!phy) {
83a1a7ce	213	pr_err("failure to allocate master IEEE802.15.4 device\n");
1010f540	214	return NULL;
	215	}
	216
	217	priv = wpan_phy_priv(phy);
	218	priv->hw.phy = priv->phy = phy;
	219	priv->hw.priv = (char )priv + ALIGN(sizeof(priv), NETDEV_ALIGN);
	220	priv->ops = ops;
	221
	222	INIT_LIST_HEAD(&priv->slaves);
	223	mutex_init(&priv->slaves_mtx);
	224
	225	return &priv->hw;
	226	}
	227	EXPORT_SYMBOL(ieee802154_alloc_device);
	228
	229	void ieee802154_free_device(struct ieee802154_dev *hw)
	230	{
	231	struct mac802154_priv *priv = mac802154_to_priv(hw);
	232
62610ad2	233	BUG_ON(!list_empty(&priv->slaves));
62610ad2	234
1010f540	235	mutex_destroy(&priv->slaves_mtx);
1e9f9545 KK	236
1e9f9545 KK	237	wpan_phy_free(priv->phy);
1010f540	238	}
	239	EXPORT_SYMBOL(ieee802154_free_device);
	240
	241	int ieee802154_register_device(struct ieee802154_dev *dev)
	242	{
	243	struct mac802154_priv *priv = mac802154_to_priv(dev);
	244	int rc = -ENOMEM;
	245
	246	priv->dev_workqueue =
	247	create_singlethread_workqueue(wpan_phy_name(priv->phy));
	248	if (!priv->dev_workqueue)
	249	goto out;
	250
	251	wpan_phy_set_dev(priv->phy, priv->hw.parent);
	252
62610ad2	253	priv->phy->add_iface = mac802154_add_iface;
62610ad2	254	priv->phy->del_iface = mac802154_del_iface;
9b2777d6	255	priv->phy->set_txpower = mac802154_set_txpower;
62610ad2	256
1010f540	257	rc = wpan_phy_register(priv->phy);
	258	if (rc < 0)
	259	goto out_wq;
	260
	261	rtnl_lock();
	262
	263	mutex_lock(&priv->slaves_mtx);
	264	priv->running = MAC802154_DEVICE_RUN;
	265	mutex_unlock(&priv->slaves_mtx);
	266
	267	rtnl_unlock();
	268
	269	return 0;
	270
	271	out_wq:
	272	destroy_workqueue(priv->dev_workqueue);
	273	out:
	274	return rc;
	275	}
	276	EXPORT_SYMBOL(ieee802154_register_device);
	277
	278	void ieee802154_unregister_device(struct ieee802154_dev *dev)
	279	{
	280	struct mac802154_priv *priv = mac802154_to_priv(dev);
62610ad2	281	struct mac802154_sub_if_data sdata, next;
1010f540	282
	283	flush_workqueue(priv->dev_workqueue);
	284	destroy_workqueue(priv->dev_workqueue);
	285
	286	rtnl_lock();
	287
	288	mutex_lock(&priv->slaves_mtx);
	289	priv->running = MAC802154_DEVICE_STOPPED;
	290	mutex_unlock(&priv->slaves_mtx);
	291
62610ad2	292	list_for_each_entry_safe(sdata, next, &priv->slaves, list) {
	293	mutex_lock(&sdata->hw->slaves_mtx);
	294	list_del(&sdata->list);
	295	mutex_unlock(&sdata->hw->slaves_mtx);
	296
	297	unregister_netdevice(sdata->dev);
	298	}
	299
1010f540	300	rtnl_unlock();
	301
	302	wpan_phy_unregister(priv->phy);
	303	}
	304	EXPORT_SYMBOL(ieee802154_unregister_device);
	305
	306	MODULE_DESCRIPTION("IEEE 802.15.4 implementation");
	307	MODULE_LICENSE("GPL v2");