[mirror_ubuntu-jammy-kernel.git] / include / net / cfg802154.h

/*
 * Copyright (C) 2007, 2008, 2009 Siemens AG
 *
 * 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.
 *
 * Written by:
 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
 */

#ifndef __NET_CFG802154_H
#define __NET_CFG802154_H

#include <linux/ieee802154.h>
#include <linux/netdevice.h>
#include <linux/mutex.h>
#include <linux/bug.h>

#include <net/nl802154.h>

struct wpan_phy;
struct wpan_phy_cca;

struct cfg802154_ops {
	struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
							   const char *name,
							   unsigned char name_assign_type,
							   int type);
	void	(*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
					       struct net_device *dev);
	int	(*suspend)(struct wpan_phy *wpan_phy);
	int	(*resume)(struct wpan_phy *wpan_phy);
	int	(*add_virtual_intf)(struct wpan_phy *wpan_phy,
				    const char *name,
				    unsigned char name_assign_type,
				    enum nl802154_iftype type,
				    __le64 extended_addr);
	int	(*del_virtual_intf)(struct wpan_phy *wpan_phy,
				    struct wpan_dev *wpan_dev);
	int	(*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel);
	int	(*set_cca_mode)(struct wpan_phy *wpan_phy,
				const struct wpan_phy_cca *cca);
	int     (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level);
	int     (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power);
	int	(*set_pan_id)(struct wpan_phy *wpan_phy,
			      struct wpan_dev *wpan_dev, __le16 pan_id);
	int	(*set_short_addr)(struct wpan_phy *wpan_phy,
				  struct wpan_dev *wpan_dev, __le16 short_addr);
	int	(*set_backoff_exponent)(struct wpan_phy *wpan_phy,
					struct wpan_dev *wpan_dev, u8 min_be,
					u8 max_be);
	int	(*set_max_csma_backoffs)(struct wpan_phy *wpan_phy,
					 struct wpan_dev *wpan_dev,
					 u8 max_csma_backoffs);
	int	(*set_max_frame_retries)(struct wpan_phy *wpan_phy,
					 struct wpan_dev *wpan_dev,
					 s8 max_frame_retries);
	int	(*set_lbt_mode)(struct wpan_phy *wpan_phy,
				struct wpan_dev *wpan_dev, bool mode);
};

static inline bool
wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st)
{
	switch (st) {
	case NL802154_SUPPORTED_BOOL_TRUE:
		return b;
	case NL802154_SUPPORTED_BOOL_FALSE:
		return !b;
	case NL802154_SUPPORTED_BOOL_BOTH:
		return true;
	default:
		WARN_ON(1);
	}

	return false;
}

struct wpan_phy_supported {
	u32 channels[IEEE802154_MAX_PAGE + 1],
	    cca_modes, cca_opts, iftypes;
	enum nl802154_supported_bool_states lbt;
	u8 min_minbe, max_minbe, min_maxbe, max_maxbe,
	   min_csma_backoffs, max_csma_backoffs;
	s8 min_frame_retries, max_frame_retries;
	size_t tx_powers_size, cca_ed_levels_size;
	const s32 *tx_powers, *cca_ed_levels;
};

struct wpan_phy_cca {
	enum nl802154_cca_modes mode;
	enum nl802154_cca_opts opt;
};

static inline bool
wpan_phy_cca_cmp(const struct wpan_phy_cca *a, const struct wpan_phy_cca *b)
{
	if (a->mode != b->mode)
		return false;

	if (a->mode == NL802154_CCA_ENERGY_CARRIER)
		return a->opt == b->opt;

	return true;
}

/**
 * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
 *	transmit power setting.
 * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
 *	level setting.
 * @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode
 *	setting.
 */
enum wpan_phy_flags {
	WPAN_PHY_FLAG_TXPOWER		= BIT(1),
	WPAN_PHY_FLAG_CCA_ED_LEVEL	= BIT(2),
	WPAN_PHY_FLAG_CCA_MODE		= BIT(3),
};

struct wpan_phy {
	/* If multiple wpan_phys are registered and you're handed e.g.
	 * a regular netdev with assigned ieee802154_ptr, you won't
	 * know whether it points to a wpan_phy your driver has registered
	 * or not. Assign this to something global to your driver to
	 * help determine whether you own this wpan_phy or not.
	 */
	const void *privid;

	u32 flags;

	/*
	 * This is a PIB according to 802.15.4-2011.
	 * We do not provide timing-related variables, as they
	 * aren't used outside of driver
	 */
	u8 current_channel;
	u8 current_page;
	struct wpan_phy_supported supported;
	/* current transmit_power in mBm */
	s32 transmit_power;
	struct wpan_phy_cca cca;

	__le64 perm_extended_addr;

	/* current cca ed threshold in mBm */
	s32 cca_ed_level;

	/* PHY depended MAC PIB values */

	/* 802.15.4 acronym: Tdsym in usec */
	u8 symbol_duration;
	/* lifs and sifs periods timing */
	u16 lifs_period;
	u16 sifs_period;

	struct device dev;

	char priv[0] __aligned(NETDEV_ALIGN);
};

struct wpan_dev {
	struct wpan_phy *wpan_phy;
	int iftype;

	/* the remainder of this struct should be private to cfg802154 */
	struct list_head list;
	struct net_device *netdev;

	u32 identifier;

	/* MAC PIB */
	__le16 pan_id;
	__le16 short_addr;
	__le64 extended_addr;

	/* MAC BSN field */
	atomic_t bsn;
	/* MAC DSN field */
	atomic_t dsn;

	u8 min_be;
	u8 max_be;
	u8 csma_retries;
	s8 frame_retries;

	bool lbt;

	bool promiscuous_mode;
};

#define to_phy(_dev)	container_of(_dev, struct wpan_phy, dev)

struct wpan_phy *
wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
{
	phy->dev.parent = dev;
}

int wpan_phy_register(struct wpan_phy *phy);
void wpan_phy_unregister(struct wpan_phy *phy);
void wpan_phy_free(struct wpan_phy *phy);
/* Same semantics as for class_for_each_device */
int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);

static inline void *wpan_phy_priv(struct wpan_phy *phy)
{
	BUG_ON(!phy);
	return &phy->priv;
}

struct wpan_phy *wpan_phy_find(const char *str);

static inline void wpan_phy_put(struct wpan_phy *phy)
{
	put_device(&phy->dev);
}

static inline const char *wpan_phy_name(struct wpan_phy *phy)
{
	return dev_name(&phy->dev);
}

#endif /* __NET_CFG802154_H */
Commit	Line	Data
2bfb1070 DB	1	/*
	2	* Copyright (C) 2007, 2008, 2009 Siemens AG
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License version 2
	6	* as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
2bfb1070 DB	13	* Written by:
	14	* Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
	15	*/
	16
5ad60d36 AA	17	#ifndef __NET_CFG802154_H
5ad60d36 AA	18	#define __NET_CFG802154_H
2bfb1070	19
cb41c8dd	20	#include <linux/ieee802154.h>
2bfb1070 DB	21	#include <linux/netdevice.h>
2bfb1070 DB	22	#include <linux/mutex.h>
187f1882	23	#include <linux/bug.h>
2bfb1070	24
f3ea5e44 AA	25	#include <net/nl802154.h>
f3ea5e44 AA	26
a5dd1d72	27	struct wpan_phy;
ba2a9506	28	struct wpan_phy_cca;
a5dd1d72 AA	29
a5dd1d72 AA	30	struct cfg802154_ops {
4a9a816a AA	31	struct net_device * (add_virtual_intf_deprecated)(struct wpan_phy wpan_phy,
4a9a816a AA	32	const char *name,
5b4a1039	33	unsigned char name_assign_type,
4a9a816a	34	int type);
9d30a8cf AA	35	void (del_virtual_intf_deprecated)(struct wpan_phy wpan_phy,
9d30a8cf AA	36	struct net_device *dev);
a6cb869b VB	37	int (suspend)(struct wpan_phy wpan_phy);
a6cb869b VB	38	int (resume)(struct wpan_phy wpan_phy);
f3ea5e44 AA	39	int (add_virtual_intf)(struct wpan_phy wpan_phy,
f3ea5e44 AA	40	const char *name,
5b4a1039	41	unsigned char name_assign_type,
0e57547e AA	42	enum nl802154_iftype type,
0e57547e AA	43	__le64 extended_addr);
b821ecd4 AA	44	int (del_virtual_intf)(struct wpan_phy wpan_phy,
b821ecd4 AA	45	struct wpan_dev *wpan_dev);
ab0bd561	46	int (set_channel)(struct wpan_phy wpan_phy, u8 page, u8 channel);
ba2a9506 AA	47	int (set_cca_mode)(struct wpan_phy wpan_phy,
ba2a9506 AA	48	const struct wpan_phy_cca *cca);
b69644c1	49	int (set_cca_ed_level)(struct wpan_phy wpan_phy, s32 ed_level);
0f999b09	50	int (set_tx_power)(struct wpan_phy wpan_phy, s32 power);
702bf371	51	int (set_pan_id)(struct wpan_phy wpan_phy,
ee7b9053	52	struct wpan_dev *wpan_dev, __le16 pan_id);
9830c62a	53	int (set_short_addr)(struct wpan_phy wpan_phy,
ee7b9053	54	struct wpan_dev *wpan_dev, __le16 short_addr);
656a999e AA	55	int (set_backoff_exponent)(struct wpan_phy wpan_phy,
	56	struct wpan_dev *wpan_dev, u8 min_be,
	57	u8 max_be);
a01ba765 AA	58	int (set_max_csma_backoffs)(struct wpan_phy wpan_phy,
	59	struct wpan_dev *wpan_dev,
	60	u8 max_csma_backoffs);
17a3a46b AA	61	int (set_max_frame_retries)(struct wpan_phy wpan_phy,
	62	struct wpan_dev *wpan_dev,
	63	s8 max_frame_retries);
c8937a1d AA	64	int (set_lbt_mode)(struct wpan_phy wpan_phy,
c8937a1d AA	65	struct wpan_dev *wpan_dev, bool mode);
a5dd1d72 AA	66	};
a5dd1d72 AA	67
fea3318d AA	68	static inline bool
	69	wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st)
	70	{
	71	switch (st) {
	72	case NL802154_SUPPORTED_BOOL_TRUE:
	73	return b;
	74	case NL802154_SUPPORTED_BOOL_FALSE:
	75	return !b;
	76	case NL802154_SUPPORTED_BOOL_BOTH:
	77	return true;
	78	default:
	79	WARN_ON(1);
	80	}
	81
	82	return false;
	83	}
	84
72f655e4	85	struct wpan_phy_supported {
fea3318d	86	u32 channels[IEEE802154_MAX_PAGE + 1],
65318680	87	cca_modes, cca_opts, iftypes;
fea3318d AA	88	enum nl802154_supported_bool_states lbt;
	89	u8 min_minbe, max_minbe, min_maxbe, max_maxbe,
	90	min_csma_backoffs, max_csma_backoffs;
	91	s8 min_frame_retries, max_frame_retries;
	92	size_t tx_powers_size, cca_ed_levels_size;
	93	const s32 tx_powers, cca_ed_levels;
72f655e4 AA	94	};
72f655e4 AA	95
7fe9a388 AA	96	struct wpan_phy_cca {
	97	enum nl802154_cca_modes mode;
	98	enum nl802154_cca_opts opt;
	99	};
	100
791021bf AA	101	static inline bool
	102	wpan_phy_cca_cmp(const struct wpan_phy_cca a, const struct wpan_phy_cca b)
	103	{
	104	if (a->mode != b->mode)
	105	return false;
	106
	107	if (a->mode == NL802154_CCA_ENERGY_CARRIER)
	108	return a->opt == b->opt;
	109
	110	return true;
	111	}
	112
edea8f7c AA	113	/**
	114	* @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
	115	* transmit power setting.
	116	* @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
	117	* level setting.
	118	* @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode
	119	* setting.
	120	*/
	121	enum wpan_phy_flags {
	122	WPAN_PHY_FLAG_TXPOWER = BIT(1),
	123	WPAN_PHY_FLAG_CCA_ED_LEVEL = BIT(2),
	124	WPAN_PHY_FLAG_CCA_MODE = BIT(3),
	125	};
	126
2bfb1070	127	struct wpan_phy {
6322d50d AA	128	/* If multiple wpan_phys are registered and you're handed e.g.
	129	* a regular netdev with assigned ieee802154_ptr, you won't
	130	* know whether it points to a wpan_phy your driver has registered
	131	* or not. Assign this to something global to your driver to
	132	* help determine whether you own this wpan_phy or not.
	133	*/
	134	const void *privid;
	135
edea8f7c AA	136	u32 flags;
edea8f7c AA	137
2bfb1070	138	/*
9b2777d6	139	* This is a PIB according to 802.15.4-2011.
2bfb1070 DB	140	* We do not provide timing-related variables, as they
	141	* aren't used outside of driver
	142	*/
	143	u8 current_channel;
	144	u8 current_page;
72f655e4	145	struct wpan_phy_supported supported;
e2eb173a	146	/* current transmit_power in mBm */
1a19cb68	147	s32 transmit_power;
7fe9a388	148	struct wpan_phy_cca cca;
dee56d14 AA	149
dee56d14 AA	150	__le64 perm_extended_addr;
2bfb1070	151
32b23550	152	/* current cca ed threshold in mBm */
6ca00197	153	s32 cca_ed_level;
84dda3c6	154
61f2dcba AA	155	/* PHY depended MAC PIB values */
	156
	157	/* 802.15.4 acronym: Tdsym in usec */
	158	u8 symbol_duration;
	159	/* lifs and sifs periods timing */
	160	u16 lifs_period;
	161	u16 sifs_period;
	162
2bfb1070	163	struct device dev;
2bfb1070	164
4896167d	165	char priv[0] __aligned(NETDEV_ALIGN);
2bfb1070 DB	166	};
2bfb1070 DB	167
d5ae67ba AA	168	struct wpan_dev {
d5ae67ba AA	169	struct wpan_phy *wpan_phy;
190ac1ca	170	int iftype;
863e88f2	171
fcf39e6e AA	172	/* the remainder of this struct should be private to cfg802154 */
	173	struct list_head list;
	174	struct net_device *netdev;
	175
	176	u32 identifier;
	177
863e88f2 AA	178	/* MAC PIB */
	179	__le16 pan_id;
	180	__le16 short_addr;
	181	__le64 extended_addr;
	182
	183	/* MAC BSN field */
344f8c11	184	atomic_t bsn;
863e88f2	185	/* MAC DSN field */
344f8c11	186	atomic_t dsn;
863e88f2 AA	187
	188	u8 min_be;
	189	u8 max_be;
	190	u8 csma_retries;
	191	s8 frame_retries;
	192
	193	bool lbt;
	194
	195	bool promiscuous_mode;
d5ae67ba AA	196	};
d5ae67ba AA	197
42723448 DB	198	#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
42723448 DB	199
a5dd1d72	200	struct wpan_phy *
f601379f	201	wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
e9cf356c DB	202	static inline void wpan_phy_set_dev(struct wpan_phy phy, struct device dev)
	203	{
	204	phy->dev.parent = dev;
	205	}
e72740d0	206
e9cf356c	207	int wpan_phy_register(struct wpan_phy *phy);
2bfb1070 DB	208	void wpan_phy_unregister(struct wpan_phy *phy);
2bfb1070 DB	209	void wpan_phy_free(struct wpan_phy *phy);
1c889f4d DB	210	/* Same semantics as for class_for_each_device */
1c889f4d DB	211	int wpan_phy_for_each(int (fn)(struct wpan_phy phy, void data), void data);
2bfb1070 DB	212
	213	static inline void wpan_phy_priv(struct wpan_phy phy)
	214	{
	215	BUG_ON(!phy);
	216	return &phy->priv;
	217	}
	218
	219	struct wpan_phy wpan_phy_find(const char str);
69d9ab96 DB	220
	221	static inline void wpan_phy_put(struct wpan_phy *phy)
	222	{
	223	put_device(&phy->dev);
	224	}
	225
2bfb1070 DB	226	static inline const char wpan_phy_name(struct wpan_phy phy)
	227	{
	228	return dev_name(&phy->dev);
	229	}
5ad60d36 AA	230
5ad60d36 AA	231	#endif /* __NET_CFG802154_H */