blob: 290a9a69af0788794619b0ededc4a6ccfbab5e07 [file] [log] [blame]
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +04001/*
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 *
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040013 * Written by:
14 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
15 */
16
Alexander Aring5ad60d32014-10-25 09:41:02 +020017#ifndef __NET_CFG802154_H
18#define __NET_CFG802154_H
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040019
Alexander Aringcb41c8d2014-11-17 08:20:54 +010020#include <linux/ieee802154.h>
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040021#include <linux/netdevice.h>
22#include <linux/mutex.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050023#include <linux/bug.h>
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040024
Alexander Aringf3ea5e42014-11-17 08:20:51 +010025#include <net/nl802154.h>
26
Alexander Aringa5dd1d72014-11-02 04:18:35 +010027struct wpan_phy;
Alexander Aringba2a9502014-12-10 15:33:13 +010028struct wpan_phy_cca;
Alexander Aringa5dd1d72014-11-02 04:18:35 +010029
30struct cfg802154_ops {
Alexander Aring4a9a8162014-11-02 04:18:38 +010031 struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
32 const char *name,
Varka Bhadram5b4a10392015-04-30 17:44:57 +020033 unsigned char name_assign_type,
Alexander Aring4a9a8162014-11-02 04:18:38 +010034 int type);
Alexander Aring9d30a8c2014-11-12 03:36:54 +010035 void (*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
36 struct net_device *dev);
Alexander Aringf3ea5e42014-11-17 08:20:51 +010037 int (*add_virtual_intf)(struct wpan_phy *wpan_phy,
38 const char *name,
Varka Bhadram5b4a10392015-04-30 17:44:57 +020039 unsigned char name_assign_type,
Alexander Aring0e575472014-11-17 08:20:52 +010040 enum nl802154_iftype type,
41 __le64 extended_addr);
Alexander Aringb821ecd2014-11-17 08:20:53 +010042 int (*del_virtual_intf)(struct wpan_phy *wpan_phy,
43 struct wpan_dev *wpan_dev);
Alexander Aringab0bd562014-11-12 03:36:55 +010044 int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel);
Alexander Aringba2a9502014-12-10 15:33:13 +010045 int (*set_cca_mode)(struct wpan_phy *wpan_phy,
46 const struct wpan_phy_cca *cca);
Alexander Aringb69644c2015-05-27 13:42:10 +020047 int (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level);
Varka Bhadram0f999b02015-05-27 09:10:54 +053048 int (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power);
Alexander Aring702bf372014-11-12 03:36:57 +010049 int (*set_pan_id)(struct wpan_phy *wpan_phy,
Alexander Aringee7b9052014-11-17 08:20:55 +010050 struct wpan_dev *wpan_dev, __le16 pan_id);
Alexander Aring9830c622014-11-12 03:36:58 +010051 int (*set_short_addr)(struct wpan_phy *wpan_phy,
Alexander Aringee7b9052014-11-17 08:20:55 +010052 struct wpan_dev *wpan_dev, __le16 short_addr);
Alexander Aring656a9992014-11-12 03:36:59 +010053 int (*set_backoff_exponent)(struct wpan_phy *wpan_phy,
54 struct wpan_dev *wpan_dev, u8 min_be,
55 u8 max_be);
Alexander Aringa01ba762014-11-12 03:37:01 +010056 int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy,
57 struct wpan_dev *wpan_dev,
58 u8 max_csma_backoffs);
Alexander Aring17a3a462014-11-12 03:37:03 +010059 int (*set_max_frame_retries)(struct wpan_phy *wpan_phy,
60 struct wpan_dev *wpan_dev,
61 s8 max_frame_retries);
Alexander Aringc8937a1d2014-11-12 03:37:05 +010062 int (*set_lbt_mode)(struct wpan_phy *wpan_phy,
63 struct wpan_dev *wpan_dev, bool mode);
Alexander Aringa5dd1d72014-11-02 04:18:35 +010064};
65
Alexander Aringfea33182015-05-17 21:44:43 +020066static inline bool
67wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st)
68{
69 switch (st) {
70 case NL802154_SUPPORTED_BOOL_TRUE:
71 return b;
72 case NL802154_SUPPORTED_BOOL_FALSE:
73 return !b;
74 case NL802154_SUPPORTED_BOOL_BOTH:
75 return true;
76 default:
77 WARN_ON(1);
78 }
79
80 return false;
81}
82
Alexander Aring72f655e2015-05-17 21:44:42 +020083struct wpan_phy_supported {
Alexander Aringfea33182015-05-17 21:44:43 +020084 u32 channels[IEEE802154_MAX_PAGE + 1],
Alexander Aring65318682015-05-17 21:44:47 +020085 cca_modes, cca_opts, iftypes;
Alexander Aringfea33182015-05-17 21:44:43 +020086 enum nl802154_supported_bool_states lbt;
87 u8 min_minbe, max_minbe, min_maxbe, max_maxbe,
88 min_csma_backoffs, max_csma_backoffs;
89 s8 min_frame_retries, max_frame_retries;
90 size_t tx_powers_size, cca_ed_levels_size;
91 const s32 *tx_powers, *cca_ed_levels;
Alexander Aring72f655e2015-05-17 21:44:42 +020092};
93
Alexander Aring7fe9a382014-12-10 15:33:12 +010094struct wpan_phy_cca {
95 enum nl802154_cca_modes mode;
96 enum nl802154_cca_opts opt;
97};
98
Alexander Aring791021b2015-05-17 21:44:44 +020099static inline bool
100wpan_phy_cca_cmp(const struct wpan_phy_cca *a, const struct wpan_phy_cca *b)
101{
102 if (a->mode != b->mode)
103 return false;
104
105 if (a->mode == NL802154_CCA_ENERGY_CARRIER)
106 return a->opt == b->opt;
107
108 return true;
109}
110
Alexander Aringedea8f72015-05-17 21:44:46 +0200111/**
112 * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
113 * transmit power setting.
114 * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
115 * level setting.
116 * @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode
117 * setting.
118 */
119enum wpan_phy_flags {
120 WPAN_PHY_FLAG_TXPOWER = BIT(1),
121 WPAN_PHY_FLAG_CCA_ED_LEVEL = BIT(2),
122 WPAN_PHY_FLAG_CCA_MODE = BIT(3),
123};
124
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400125struct wpan_phy {
Alexander Aring6322d502014-11-12 03:36:51 +0100126 /* If multiple wpan_phys are registered and you're handed e.g.
127 * a regular netdev with assigned ieee802154_ptr, you won't
128 * know whether it points to a wpan_phy your driver has registered
129 * or not. Assign this to something global to your driver to
130 * help determine whether you own this wpan_phy or not.
131 */
132 const void *privid;
133
Alexander Aringedea8f72015-05-17 21:44:46 +0200134 u32 flags;
135
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400136 /*
Phoebe Buckheister9b2777d2014-02-17 11:34:08 +0100137 * This is a PIB according to 802.15.4-2011.
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400138 * We do not provide timing-related variables, as they
139 * aren't used outside of driver
140 */
141 u8 current_channel;
142 u8 current_page;
Alexander Aring72f655e2015-05-17 21:44:42 +0200143 struct wpan_phy_supported supported;
Alexander Aringe2eb1732015-05-17 21:44:40 +0200144 /* current transmit_power in mBm */
Alexander Aring1a19cb62015-05-17 21:44:39 +0200145 s32 transmit_power;
Alexander Aring7fe9a382014-12-10 15:33:12 +0100146 struct wpan_phy_cca cca;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400147
Alexander Aringdee56d142014-11-05 20:51:25 +0100148 __le64 perm_extended_addr;
149
Alexander Aring32b23552015-05-17 21:44:41 +0200150 /* current cca ed threshold in mBm */
Phoebe Buckheister6ca00192014-02-17 11:34:12 +0100151 s32 cca_ed_level;
Phoebe Buckheister84dda3c2014-02-17 11:34:10 +0100152
Alexander Aring61f2dcb2014-11-12 19:51:56 +0100153 /* PHY depended MAC PIB values */
154
155 /* 802.15.4 acronym: Tdsym in usec */
156 u8 symbol_duration;
157 /* lifs and sifs periods timing */
158 u16 lifs_period;
159 u16 sifs_period;
160
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400161 struct device dev;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400162
Alexander Aring48961672014-10-25 05:25:10 +0200163 char priv[0] __aligned(NETDEV_ALIGN);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400164};
165
Alexander Aringd5ae67b2014-11-05 20:51:17 +0100166struct wpan_dev {
167 struct wpan_phy *wpan_phy;
Alexander Aring190ac1c2014-11-09 08:36:49 +0100168 int iftype;
Alexander Aring863e88f2014-11-09 08:36:45 +0100169
Alexander Aringfcf39e62014-11-09 08:36:50 +0100170 /* the remainder of this struct should be private to cfg802154 */
171 struct list_head list;
172 struct net_device *netdev;
173
174 u32 identifier;
175
Alexander Aring863e88f2014-11-09 08:36:45 +0100176 /* MAC PIB */
177 __le16 pan_id;
178 __le16 short_addr;
179 __le64 extended_addr;
180
181 /* MAC BSN field */
Alexander Aring344f8c12015-05-22 17:43:53 +0200182 atomic_t bsn;
Alexander Aring863e88f2014-11-09 08:36:45 +0100183 /* MAC DSN field */
Alexander Aring344f8c12015-05-22 17:43:53 +0200184 atomic_t dsn;
Alexander Aring863e88f2014-11-09 08:36:45 +0100185
186 u8 min_be;
187 u8 max_be;
188 u8 csma_retries;
189 s8 frame_retries;
190
191 bool lbt;
192
193 bool promiscuous_mode;
Alexander Aringd5ae67b2014-11-05 20:51:17 +0100194};
195
Dmitry Eremin-Solenikov42723442009-11-04 17:53:23 +0300196#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
197
Alexander Aringa5dd1d72014-11-02 04:18:35 +0100198struct wpan_phy *
Alexander Aringf6013792014-11-09 08:36:47 +0100199wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +0400200static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
201{
202 phy->dev.parent = dev;
203}
Alexander Aringe72740d2014-10-25 05:25:11 +0200204
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +0400205int wpan_phy_register(struct wpan_phy *phy);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400206void wpan_phy_unregister(struct wpan_phy *phy);
207void wpan_phy_free(struct wpan_phy *phy);
Dmitry Eremin-Solenikov1c889f42009-09-15 16:57:04 +0400208/* Same semantics as for class_for_each_device */
209int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400210
211static inline void *wpan_phy_priv(struct wpan_phy *phy)
212{
213 BUG_ON(!phy);
214 return &phy->priv;
215}
216
217struct wpan_phy *wpan_phy_find(const char *str);
Dmitry Eremin-Solenikov69d9ab92009-09-14 18:11:03 +0400218
219static inline void wpan_phy_put(struct wpan_phy *phy)
220{
221 put_device(&phy->dev);
222}
223
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400224static inline const char *wpan_phy_name(struct wpan_phy *phy)
225{
226 return dev_name(&phy->dev);
227}
Alexander Aring5ad60d32014-10-25 09:41:02 +0200228
229#endif /* __NET_CFG802154_H */