[mirror_ubuntu-bionic-kernel.git] / net / wireless / mesh.c

#include <linux/ieee80211.h>
#include <linux/export.h>
#include <net/cfg80211.h>
#include "nl80211.h"
#include "core.h"

/* Default values, timeouts in ms */
#define MESH_TTL 		31
#define MESH_DEFAULT_ELEMENT_TTL 31
#define MESH_MAX_RETR	 	3
#define MESH_RET_T 		100
#define MESH_CONF_T 		100
#define MESH_HOLD_T 		100

#define MESH_PATH_TIMEOUT	5000
#define MESH_RANN_INTERVAL      5000
#define MESH_PATH_TO_ROOT_TIMEOUT      6000
#define MESH_ROOT_INTERVAL     5000
#define MESH_ROOT_CONFIRMATION_INTERVAL 2000

/*
 * Minimum interval between two consecutive PREQs originated by the same
 * interface
 */
#define MESH_PREQ_MIN_INT	10
#define MESH_PERR_MIN_INT	100
#define MESH_DIAM_TRAVERSAL_TIME 50

#define MESH_RSSI_THRESHOLD	0

/*
 * A path will be refreshed if it is used PATH_REFRESH_TIME milliseconds
 * before timing out.  This way it will remain ACTIVE and no data frames
 * will be unnecessarily held in the pending queue.
 */
#define MESH_PATH_REFRESH_TIME			1000
#define MESH_MIN_DISCOVERY_TIMEOUT (2 * MESH_DIAM_TRAVERSAL_TIME)

/* Default maximum number of established plinks per interface */
#define MESH_MAX_ESTAB_PLINKS	32

#define MESH_MAX_PREQ_RETRIES	4

#define MESH_SYNC_NEIGHBOR_OFFSET_MAX 50

const struct mesh_config default_mesh_config = {
	.dot11MeshRetryTimeout = MESH_RET_T,
	.dot11MeshConfirmTimeout = MESH_CONF_T,
	.dot11MeshHoldingTimeout = MESH_HOLD_T,
	.dot11MeshMaxRetries = MESH_MAX_RETR,
	.dot11MeshTTL = MESH_TTL,
	.element_ttl = MESH_DEFAULT_ELEMENT_TTL,
	.auto_open_plinks = true,
	.dot11MeshMaxPeerLinks = MESH_MAX_ESTAB_PLINKS,
	.dot11MeshNbrOffsetMaxNeighbor = MESH_SYNC_NEIGHBOR_OFFSET_MAX,
	.dot11MeshHWMPactivePathTimeout = MESH_PATH_TIMEOUT,
	.dot11MeshHWMPpreqMinInterval = MESH_PREQ_MIN_INT,
	.dot11MeshHWMPperrMinInterval = MESH_PERR_MIN_INT,
	.dot11MeshHWMPnetDiameterTraversalTime = MESH_DIAM_TRAVERSAL_TIME,
	.dot11MeshHWMPmaxPREQretries = MESH_MAX_PREQ_RETRIES,
	.path_refresh_time = MESH_PATH_REFRESH_TIME,
	.min_discovery_timeout = MESH_MIN_DISCOVERY_TIMEOUT,
	.dot11MeshHWMPRannInterval = MESH_RANN_INTERVAL,
	.dot11MeshGateAnnouncementProtocol = false,
	.dot11MeshForwarding = true,
	.rssi_threshold = MESH_RSSI_THRESHOLD,
	.ht_opmode = IEEE80211_HT_OP_MODE_PROTECTION_NONHT_MIXED,
	.dot11MeshHWMPactivePathToRootTimeout = MESH_PATH_TO_ROOT_TIMEOUT,
	.dot11MeshHWMProotInterval = MESH_ROOT_INTERVAL,
	.dot11MeshHWMPconfirmationInterval = MESH_ROOT_CONFIRMATION_INTERVAL,
};

const struct mesh_setup default_mesh_setup = {
	/* cfg80211_join_mesh() will pick a channel if needed */
	.channel = NULL,
	.channel_type = NL80211_CHAN_NO_HT,
	.sync_method = IEEE80211_SYNC_METHOD_NEIGHBOR_OFFSET,
	.path_sel_proto = IEEE80211_PATH_PROTOCOL_HWMP,
	.path_metric = IEEE80211_PATH_METRIC_AIRTIME,
	.ie = NULL,
	.ie_len = 0,
	.is_secure = false,
};

int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
			 struct net_device *dev,
			 struct mesh_setup *setup,
			 const struct mesh_config *conf)
{
	struct wireless_dev *wdev = dev->ieee80211_ptr;
	int err;

	BUILD_BUG_ON(IEEE80211_MAX_SSID_LEN != IEEE80211_MAX_MESH_ID_LEN);

	ASSERT_WDEV_LOCK(wdev);

	if (dev->ieee80211_ptr->iftype != NL80211_IFTYPE_MESH_POINT)
		return -EOPNOTSUPP;

	if (!(rdev->wiphy.flags & WIPHY_FLAG_MESH_AUTH) &&
	      setup->is_secure)
		return -EOPNOTSUPP;

	if (wdev->mesh_id_len)
		return -EALREADY;

	if (!setup->mesh_id_len)
		return -EINVAL;

	if (!rdev->ops->join_mesh)
		return -EOPNOTSUPP;

	if (!setup->channel) {
		/* if no channel explicitly given, use preset channel */
		setup->channel = wdev->preset_chan;
		setup->channel_type = wdev->preset_chantype;
	}

	if (!setup->channel) {
		/* if we don't have that either, use the first usable channel */
		enum ieee80211_band band;

		for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
			struct ieee80211_supported_band *sband;
			struct ieee80211_channel *chan;
			int i;

			sband = rdev->wiphy.bands[band];
			if (!sband)
				continue;

			for (i = 0; i < sband->n_channels; i++) {
				chan = &sband->channels[i];
				if (chan->flags & (IEEE80211_CHAN_NO_IBSS |
						   IEEE80211_CHAN_PASSIVE_SCAN |
						   IEEE80211_CHAN_DISABLED |
						   IEEE80211_CHAN_RADAR))
					continue;
				setup->channel = chan;
				break;
			}

			if (setup->channel)
				break;
		}

		/* no usable channel ... */
		if (!setup->channel)
			return -EINVAL;

		setup->channel_type = NL80211_CHAN_NO_HT;
	}

	if (!cfg80211_can_beacon_sec_chan(&rdev->wiphy, setup->channel,
					  setup->channel_type))
		return -EINVAL;

	err = cfg80211_can_use_chan(rdev, wdev, setup->channel,
				    CHAN_MODE_SHARED);
	if (err)
		return err;

	err = rdev->ops->join_mesh(&rdev->wiphy, dev, conf, setup);
	if (!err) {
		memcpy(wdev->ssid, setup->mesh_id, setup->mesh_id_len);
		wdev->mesh_id_len = setup->mesh_id_len;
		wdev->channel = setup->channel;
	}

	return err;
}

int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
		       struct net_device *dev,
		       struct mesh_setup *setup,
		       const struct mesh_config *conf)
{
	struct wireless_dev *wdev = dev->ieee80211_ptr;
	int err;

	mutex_lock(&rdev->devlist_mtx);
	wdev_lock(wdev);
	err = __cfg80211_join_mesh(rdev, dev, setup, conf);
	wdev_unlock(wdev);
	mutex_unlock(&rdev->devlist_mtx);

	return err;
}

int cfg80211_set_mesh_freq(struct cfg80211_registered_device *rdev,
			   struct wireless_dev *wdev, int freq,
			   enum nl80211_channel_type channel_type)
{
	struct ieee80211_channel *channel;
	int err;

	channel = rdev_freq_to_chan(rdev, freq, channel_type);
	if (!channel || !cfg80211_can_beacon_sec_chan(&rdev->wiphy,
						      channel,
						      channel_type)) {
		return -EINVAL;
	}

	/*
	 * Workaround for libertas (only!), it puts the interface
	 * into mesh mode but doesn't implement join_mesh. Instead,
	 * it is configured via sysfs and then joins the mesh when
	 * you set the channel. Note that the libertas mesh isn't
	 * compatible with 802.11 mesh.
	 */
	if (rdev->ops->libertas_set_mesh_channel) {
		if (channel_type != NL80211_CHAN_NO_HT)
			return -EINVAL;

		if (!netif_running(wdev->netdev))
			return -ENETDOWN;

		err = cfg80211_can_use_chan(rdev, wdev, channel,
					    CHAN_MODE_SHARED);
		if (err)
			return err;

		err = rdev->ops->libertas_set_mesh_channel(&rdev->wiphy,
							   wdev->netdev,
							   channel);
		if (!err)
			wdev->channel = channel;

		return err;
	}

	if (wdev->mesh_id_len)
		return -EBUSY;

	wdev->preset_chan = channel;
	wdev->preset_chantype = channel_type;
	return 0;
}

void cfg80211_notify_new_peer_candidate(struct net_device *dev,
		const u8 *macaddr, const u8* ie, u8 ie_len, gfp_t gfp)
{
	struct wireless_dev *wdev = dev->ieee80211_ptr;

	if (WARN_ON(wdev->iftype != NL80211_IFTYPE_MESH_POINT))
		return;

	nl80211_send_new_peer_candidate(wiphy_to_dev(wdev->wiphy), dev,
			macaddr, ie, ie_len, gfp);
}
EXPORT_SYMBOL(cfg80211_notify_new_peer_candidate);

static int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
				 struct net_device *dev)
{
	struct wireless_dev *wdev = dev->ieee80211_ptr;
	int err;

	ASSERT_WDEV_LOCK(wdev);

	if (dev->ieee80211_ptr->iftype != NL80211_IFTYPE_MESH_POINT)
		return -EOPNOTSUPP;

	if (!rdev->ops->leave_mesh)
		return -EOPNOTSUPP;

	if (!wdev->mesh_id_len)
		return -ENOTCONN;

	err = rdev->ops->leave_mesh(&rdev->wiphy, dev);
	if (!err) {
		wdev->mesh_id_len = 0;
		wdev->channel = NULL;
	}

	return err;
}

int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
			struct net_device *dev)
{
	struct wireless_dev *wdev = dev->ieee80211_ptr;
	int err;

	wdev_lock(wdev);
	err = __cfg80211_leave_mesh(rdev, dev);
	wdev_unlock(wdev);

	return err;
}
Commit	Line	Data
29cbe68c	1	#include <linux/ieee80211.h>
bc3b2d7f	2	#include <linux/export.h>
29cbe68c	3	#include <net/cfg80211.h>
c93b5e71	4	#include "nl80211.h"
29cbe68c JB	5	#include "core.h"
	6
	7	/* Default values, timeouts in ms */
	8	#define MESH_TTL 31
	9	#define MESH_DEFAULT_ELEMENT_TTL 31
	10	#define MESH_MAX_RETR 3
	11	#define MESH_RET_T 100
	12	#define MESH_CONF_T 100
	13	#define MESH_HOLD_T 100
	14
	15	#define MESH_PATH_TIMEOUT 5000
0507e159	16	#define MESH_RANN_INTERVAL 5000
ac1073a6 CYY	17	#define MESH_PATH_TO_ROOT_TIMEOUT 6000
ac1073a6 CYY	18	#define MESH_ROOT_INTERVAL 5000
728b19e5	19	#define MESH_ROOT_CONFIRMATION_INTERVAL 2000
29cbe68c JB	20
	21	/*
	22	* Minimum interval between two consecutive PREQs originated by the same
	23	* interface
	24	*/
	25	#define MESH_PREQ_MIN_INT 10
dca7e943	26	#define MESH_PERR_MIN_INT 100
29cbe68c JB	27	#define MESH_DIAM_TRAVERSAL_TIME 50
29cbe68c JB	28
55335137 AN	29	#define MESH_RSSI_THRESHOLD 0
55335137 AN	30
29cbe68c JB	31	/*
	32	* A path will be refreshed if it is used PATH_REFRESH_TIME milliseconds
	33	* before timing out. This way it will remain ACTIVE and no data frames
	34	* will be unnecessarily held in the pending queue.
	35	*/
	36	#define MESH_PATH_REFRESH_TIME 1000
	37	#define MESH_MIN_DISCOVERY_TIMEOUT (2 * MESH_DIAM_TRAVERSAL_TIME)
	38
	39	/* Default maximum number of established plinks per interface */
	40	#define MESH_MAX_ESTAB_PLINKS 32
	41
	42	#define MESH_MAX_PREQ_RETRIES 4
	43
d299a1f2	44	#define MESH_SYNC_NEIGHBOR_OFFSET_MAX 50
29cbe68c JB	45
	46	const struct mesh_config default_mesh_config = {
	47	.dot11MeshRetryTimeout = MESH_RET_T,
	48	.dot11MeshConfirmTimeout = MESH_CONF_T,
	49	.dot11MeshHoldingTimeout = MESH_HOLD_T,
	50	.dot11MeshMaxRetries = MESH_MAX_RETR,
	51	.dot11MeshTTL = MESH_TTL,
	52	.element_ttl = MESH_DEFAULT_ELEMENT_TTL,
	53	.auto_open_plinks = true,
	54	.dot11MeshMaxPeerLinks = MESH_MAX_ESTAB_PLINKS,
d299a1f2	55	.dot11MeshNbrOffsetMaxNeighbor = MESH_SYNC_NEIGHBOR_OFFSET_MAX,
29cbe68c JB	56	.dot11MeshHWMPactivePathTimeout = MESH_PATH_TIMEOUT,
29cbe68c JB	57	.dot11MeshHWMPpreqMinInterval = MESH_PREQ_MIN_INT,
dca7e943	58	.dot11MeshHWMPperrMinInterval = MESH_PERR_MIN_INT,
29cbe68c JB	59	.dot11MeshHWMPnetDiameterTraversalTime = MESH_DIAM_TRAVERSAL_TIME,
	60	.dot11MeshHWMPmaxPREQretries = MESH_MAX_PREQ_RETRIES,
	61	.path_refresh_time = MESH_PATH_REFRESH_TIME,
	62	.min_discovery_timeout = MESH_MIN_DISCOVERY_TIMEOUT,
0507e159	63	.dot11MeshHWMPRannInterval = MESH_RANN_INTERVAL,
16dd7267	64	.dot11MeshGateAnnouncementProtocol = false,
94f90656	65	.dot11MeshForwarding = true,
55335137	66	.rssi_threshold = MESH_RSSI_THRESHOLD,
70c33eaa	67	.ht_opmode = IEEE80211_HT_OP_MODE_PROTECTION_NONHT_MIXED,
ac1073a6 CYY	68	.dot11MeshHWMPactivePathToRootTimeout = MESH_PATH_TO_ROOT_TIMEOUT,
ac1073a6 CYY	69	.dot11MeshHWMProotInterval = MESH_ROOT_INTERVAL,
728b19e5	70	.dot11MeshHWMPconfirmationInterval = MESH_ROOT_CONFIRMATION_INTERVAL,
29cbe68c JB	71	};
29cbe68c JB	72
c80d545d	73	const struct mesh_setup default_mesh_setup = {
cc1d2806 JB	74	/* cfg80211_join_mesh() will pick a channel if needed */
	75	.channel = NULL,
	76	.channel_type = NL80211_CHAN_NO_HT,
d299a1f2	77	.sync_method = IEEE80211_SYNC_METHOD_NEIGHBOR_OFFSET,
c80d545d JC	78	.path_sel_proto = IEEE80211_PATH_PROTOCOL_HWMP,
c80d545d JC	79	.path_metric = IEEE80211_PATH_METRIC_AIRTIME,
581a8b0f JC	80	.ie = NULL,
581a8b0f JC	81	.ie_len = 0,
5cff5e01	82	.is_secure = false,
c80d545d	83	};
29cbe68c JB	84
	85	int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
	86	struct net_device *dev,
cc1d2806	87	struct mesh_setup *setup,
29cbe68c JB	88	const struct mesh_config *conf)
	89	{
	90	struct wireless_dev *wdev = dev->ieee80211_ptr;
29cbe68c JB	91	int err;
	92
	93	BUILD_BUG_ON(IEEE80211_MAX_SSID_LEN != IEEE80211_MAX_MESH_ID_LEN);
	94
	95	ASSERT_WDEV_LOCK(wdev);
	96
	97	if (dev->ieee80211_ptr->iftype != NL80211_IFTYPE_MESH_POINT)
	98	return -EOPNOTSUPP;
	99
15d5dda6 JC	100	if (!(rdev->wiphy.flags & WIPHY_FLAG_MESH_AUTH) &&
	101	setup->is_secure)
	102	return -EOPNOTSUPP;
	103
29cbe68c JB	104	if (wdev->mesh_id_len)
	105	return -EALREADY;
	106
c80d545d	107	if (!setup->mesh_id_len)
29cbe68c JB	108	return -EINVAL;
	109
	110	if (!rdev->ops->join_mesh)
	111	return -EOPNOTSUPP;
	112
cc1d2806 JB	113	if (!setup->channel) {
	114	/* if no channel explicitly given, use preset channel */
	115	setup->channel = wdev->preset_chan;
	116	setup->channel_type = wdev->preset_chantype;
	117	}
	118
	119	if (!setup->channel) {
	120	/* if we don't have that either, use the first usable channel */
	121	enum ieee80211_band band;
	122
	123	for (band = 0; band < IEEE80211_NUM_BANDS; band++) {
	124	struct ieee80211_supported_band *sband;
	125	struct ieee80211_channel *chan;
	126	int i;
	127
	128	sband = rdev->wiphy.bands[band];
	129	if (!sband)
	130	continue;
	131
	132	for (i = 0; i < sband->n_channels; i++) {
	133	chan = &sband->channels[i];
	134	if (chan->flags & (IEEE80211_CHAN_NO_IBSS \|
	135	IEEE80211_CHAN_PASSIVE_SCAN \|
	136	IEEE80211_CHAN_DISABLED \|
	137	IEEE80211_CHAN_RADAR))
	138	continue;
	139	setup->channel = chan;
	140	break;
	141	}
	142
	143	if (setup->channel)
	144	break;
	145	}
	146
	147	/* no usable channel ... */
	148	if (!setup->channel)
	149	return -EINVAL;
	150
	151	setup->channel_type = NL80211_CHAN_NO_HT;
	152	}
	153
	154	if (!cfg80211_can_beacon_sec_chan(&rdev->wiphy, setup->channel,
	155	setup->channel_type))
	156	return -EINVAL;
	157
e4e32459 MK	158	err = cfg80211_can_use_chan(rdev, wdev, setup->channel,
	159	CHAN_MODE_SHARED);
	160	if (err)
	161	return err;
	162
c80d545d	163	err = rdev->ops->join_mesh(&rdev->wiphy, dev, conf, setup);
29cbe68c	164	if (!err) {
c80d545d JC	165	memcpy(wdev->ssid, setup->mesh_id, setup->mesh_id_len);
c80d545d JC	166	wdev->mesh_id_len = setup->mesh_id_len;
f4489ebe	167	wdev->channel = setup->channel;
29cbe68c JB	168	}
	169
	170	return err;
	171	}
	172
	173	int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
	174	struct net_device *dev,
cc1d2806	175	struct mesh_setup *setup,
29cbe68c JB	176	const struct mesh_config *conf)
	177	{
	178	struct wireless_dev *wdev = dev->ieee80211_ptr;
	179	int err;
	180
e4e32459	181	mutex_lock(&rdev->devlist_mtx);
29cbe68c	182	wdev_lock(wdev);
c80d545d	183	err = __cfg80211_join_mesh(rdev, dev, setup, conf);
29cbe68c	184	wdev_unlock(wdev);
e4e32459	185	mutex_unlock(&rdev->devlist_mtx);
29cbe68c JB	186
	187	return err;
	188	}
	189
cc1d2806 JB	190	int cfg80211_set_mesh_freq(struct cfg80211_registered_device *rdev,
	191	struct wireless_dev *wdev, int freq,
	192	enum nl80211_channel_type channel_type)
	193	{
	194	struct ieee80211_channel *channel;
f4489ebe	195	int err;
cc1d2806	196
e8c9bd5b JB	197	channel = rdev_freq_to_chan(rdev, freq, channel_type);
	198	if (!channel \|\| !cfg80211_can_beacon_sec_chan(&rdev->wiphy,
	199	channel,
	200	channel_type)) {
	201	return -EINVAL;
	202	}
	203
cc1d2806 JB	204	/*
	205	* Workaround for libertas (only!), it puts the interface
	206	* into mesh mode but doesn't implement join_mesh. Instead,
	207	* it is configured via sysfs and then joins the mesh when
	208	* you set the channel. Note that the libertas mesh isn't
	209	* compatible with 802.11 mesh.
	210	*/
e8c9bd5b JB	211	if (rdev->ops->libertas_set_mesh_channel) {
	212	if (channel_type != NL80211_CHAN_NO_HT)
	213	return -EINVAL;
cc1d2806 JB	214
	215	if (!netif_running(wdev->netdev))
	216	return -ENETDOWN;
f4489ebe	217
e4e32459 MK	218	err = cfg80211_can_use_chan(rdev, wdev, channel,
	219	CHAN_MODE_SHARED);
	220	if (err)
	221	return err;
	222
f4489ebe MK	223	err = rdev->ops->libertas_set_mesh_channel(&rdev->wiphy,
	224	wdev->netdev,
	225	channel);
	226	if (!err)
	227	wdev->channel = channel;
	228
	229	return err;
cc1d2806 JB	230	}
	231
	232	if (wdev->mesh_id_len)
	233	return -EBUSY;
	234
cc1d2806 JB	235	wdev->preset_chan = channel;
	236	wdev->preset_chantype = channel_type;
	237	return 0;
	238	}
	239
c93b5e71 JC	240	void cfg80211_notify_new_peer_candidate(struct net_device *dev,
	241	const u8 macaddr, const u8 ie, u8 ie_len, gfp_t gfp)
	242	{
	243	struct wireless_dev *wdev = dev->ieee80211_ptr;
	244
	245	if (WARN_ON(wdev->iftype != NL80211_IFTYPE_MESH_POINT))
	246	return;
	247
	248	nl80211_send_new_peer_candidate(wiphy_to_dev(wdev->wiphy), dev,
	249	macaddr, ie, ie_len, gfp);
	250	}
	251	EXPORT_SYMBOL(cfg80211_notify_new_peer_candidate);
	252
29cbe68c JB	253	static int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
	254	struct net_device *dev)
	255	{
	256	struct wireless_dev *wdev = dev->ieee80211_ptr;
	257	int err;
	258
	259	ASSERT_WDEV_LOCK(wdev);
	260
	261	if (dev->ieee80211_ptr->iftype != NL80211_IFTYPE_MESH_POINT)
	262	return -EOPNOTSUPP;
	263
	264	if (!rdev->ops->leave_mesh)
	265	return -EOPNOTSUPP;
	266
	267	if (!wdev->mesh_id_len)
	268	return -ENOTCONN;
	269
	270	err = rdev->ops->leave_mesh(&rdev->wiphy, dev);
f4489ebe	271	if (!err) {
29cbe68c	272	wdev->mesh_id_len = 0;
f4489ebe MK	273	wdev->channel = NULL;
	274	}
	275
29cbe68c JB	276	return err;
	277	}
	278
	279	int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
	280	struct net_device *dev)
	281	{
	282	struct wireless_dev *wdev = dev->ieee80211_ptr;
	283	int err;
	284
	285	wdev_lock(wdev);
	286	err = __cfg80211_leave_mesh(rdev, dev);
	287	wdev_unlock(wdev);
	288
	289	return err;
	290	}