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 *
13 * Written by:
14 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
15 */
16
17#ifndef __NET_CFG802154_H
18#define __NET_CFG802154_H
19
20#include <linux/ieee802154.h>
21#include <linux/netdevice.h>
22#include <linux/mutex.h>
23#include <linux/bug.h>
24
25#include <net/nl802154.h>
26
27struct wpan_phy;
28struct wpan_phy_cca;
29
30struct cfg802154_ops {
31	struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
32							   const char *name,
33							   unsigned char name_assign_type,
34							   int type);
35	void	(*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
36					       struct net_device *dev);
37	int	(*add_virtual_intf)(struct wpan_phy *wpan_phy,
38				    const char *name,
39				    unsigned char name_assign_type,
40				    enum nl802154_iftype type,
41				    __le64 extended_addr);
42	int	(*del_virtual_intf)(struct wpan_phy *wpan_phy,
43				    struct wpan_dev *wpan_dev);
44	int	(*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel);
45	int	(*set_cca_mode)(struct wpan_phy *wpan_phy,
46				const struct wpan_phy_cca *cca);
47	int	(*set_pan_id)(struct wpan_phy *wpan_phy,
48			      struct wpan_dev *wpan_dev, __le16 pan_id);
49	int	(*set_short_addr)(struct wpan_phy *wpan_phy,
50				  struct wpan_dev *wpan_dev, __le16 short_addr);
51	int	(*set_backoff_exponent)(struct wpan_phy *wpan_phy,
52					struct wpan_dev *wpan_dev, u8 min_be,
53					u8 max_be);
54	int	(*set_max_csma_backoffs)(struct wpan_phy *wpan_phy,
55					 struct wpan_dev *wpan_dev,
56					 u8 max_csma_backoffs);
57	int	(*set_max_frame_retries)(struct wpan_phy *wpan_phy,
58					 struct wpan_dev *wpan_dev,
59					 s8 max_frame_retries);
60	int	(*set_lbt_mode)(struct wpan_phy *wpan_phy,
61				struct wpan_dev *wpan_dev, bool mode);
62};
63
64struct wpan_phy_cca {
65	enum nl802154_cca_modes mode;
66	enum nl802154_cca_opts opt;
67};
68
69struct wpan_phy {
70	struct mutex pib_lock;
71
72	/* If multiple wpan_phys are registered and you're handed e.g.
73	 * a regular netdev with assigned ieee802154_ptr, you won't
74	 * know whether it points to a wpan_phy your driver has registered
75	 * or not. Assign this to something global to your driver to
76	 * help determine whether you own this wpan_phy or not.
77	 */
78	const void *privid;
79
80	/*
81	 * This is a PIB according to 802.15.4-2011.
82	 * We do not provide timing-related variables, as they
83	 * aren't used outside of driver
84	 */
85	u8 current_channel;
86	u8 current_page;
87	u32 channels_supported[IEEE802154_MAX_PAGE + 1];
88	s8 transmit_power;
89	struct wpan_phy_cca cca;
90
91	__le64 perm_extended_addr;
92
93	s32 cca_ed_level;
94
95	/* PHY depended MAC PIB values */
96
97	/* 802.15.4 acronym: Tdsym in usec */
98	u8 symbol_duration;
99	/* lifs and sifs periods timing */
100	u16 lifs_period;
101	u16 sifs_period;
102
103	struct device dev;
104
105	char priv[0] __aligned(NETDEV_ALIGN);
106};
107
108struct wpan_dev {
109	struct wpan_phy *wpan_phy;
110	int iftype;
111
112	/* the remainder of this struct should be private to cfg802154 */
113	struct list_head list;
114	struct net_device *netdev;
115
116	u32 identifier;
117
118	/* MAC PIB */
119	__le16 pan_id;
120	__le16 short_addr;
121	__le64 extended_addr;
122
123	/* MAC BSN field */
124	u8 bsn;
125	/* MAC DSN field */
126	u8 dsn;
127
128	u8 min_be;
129	u8 max_be;
130	u8 csma_retries;
131	s8 frame_retries;
132
133	bool lbt;
134
135	bool promiscuous_mode;
136};
137
138#define to_phy(_dev)	container_of(_dev, struct wpan_phy, dev)
139
140struct wpan_phy *
141wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
142static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
143{
144	phy->dev.parent = dev;
145}
146
147int wpan_phy_register(struct wpan_phy *phy);
148void wpan_phy_unregister(struct wpan_phy *phy);
149void wpan_phy_free(struct wpan_phy *phy);
150/* Same semantics as for class_for_each_device */
151int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
152
153static inline void *wpan_phy_priv(struct wpan_phy *phy)
154{
155	BUG_ON(!phy);
156	return &phy->priv;
157}
158
159struct wpan_phy *wpan_phy_find(const char *str);
160
161static inline void wpan_phy_put(struct wpan_phy *phy)
162{
163	put_device(&phy->dev);
164}
165
166static inline const char *wpan_phy_name(struct wpan_phy *phy)
167{
168	return dev_name(&phy->dev);
169}
170
171#endif /* __NET_CFG802154_H */
172