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