blob: 23abd08a310a0dadbae2da5a6fce0f78f2b76dae [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 <[email protected]>
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 Aring9d30a8cf2014-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 Aring702bf372014-11-12 03:36:57 +010047 int (*set_pan_id)(struct wpan_phy *wpan_phy,
Alexander Aringee7b9052014-11-17 08:20:55 +010048 struct wpan_dev *wpan_dev, __le16 pan_id);
Alexander Aring9830c622014-11-12 03:36:58 +010049 int (*set_short_addr)(struct wpan_phy *wpan_phy,
Alexander Aringee7b9052014-11-17 08:20:55 +010050 struct wpan_dev *wpan_dev, __le16 short_addr);
Alexander Aring656a9992014-11-12 03:36:59 +010051 int (*set_backoff_exponent)(struct wpan_phy *wpan_phy,
52 struct wpan_dev *wpan_dev, u8 min_be,
53 u8 max_be);
Alexander Aringa01ba762014-11-12 03:37:01 +010054 int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy,
55 struct wpan_dev *wpan_dev,
56 u8 max_csma_backoffs);
Alexander Aring17a3a462014-11-12 03:37:03 +010057 int (*set_max_frame_retries)(struct wpan_phy *wpan_phy,
58 struct wpan_dev *wpan_dev,
59 s8 max_frame_retries);
Alexander Aringc8937a1d2014-11-12 03:37:05 +010060 int (*set_lbt_mode)(struct wpan_phy *wpan_phy,
61 struct wpan_dev *wpan_dev, bool mode);
Alexander Aringa5dd1d72014-11-02 04:18:35 +010062};
63
Alexander Aringfea33182015-05-17 21:44:43 +020064static inline bool
65wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st)
66{
67 switch (st) {
68 case NL802154_SUPPORTED_BOOL_TRUE:
69 return b;
70 case NL802154_SUPPORTED_BOOL_FALSE:
71 return !b;
72 case NL802154_SUPPORTED_BOOL_BOTH:
73 return true;
74 default:
75 WARN_ON(1);
76 }
77
78 return false;
79}
80
Alexander Aring72f655e2015-05-17 21:44:42 +020081struct wpan_phy_supported {
Alexander Aringfea33182015-05-17 21:44:43 +020082 u32 channels[IEEE802154_MAX_PAGE + 1],
83 cca_modes, cca_opts;
84 enum nl802154_supported_bool_states lbt;
85 u8 min_minbe, max_minbe, min_maxbe, max_maxbe,
86 min_csma_backoffs, max_csma_backoffs;
87 s8 min_frame_retries, max_frame_retries;
88 size_t tx_powers_size, cca_ed_levels_size;
89 const s32 *tx_powers, *cca_ed_levels;
Alexander Aring72f655e2015-05-17 21:44:42 +020090};
91
Alexander Aring7fe9a382014-12-10 15:33:12 +010092struct wpan_phy_cca {
93 enum nl802154_cca_modes mode;
94 enum nl802154_cca_opts opt;
95};
96
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +040097struct wpan_phy {
98 struct mutex pib_lock;
99
Alexander Aring6322d502014-11-12 03:36:51 +0100100 /* If multiple wpan_phys are registered and you're handed e.g.
101 * a regular netdev with assigned ieee802154_ptr, you won't
102 * know whether it points to a wpan_phy your driver has registered
103 * or not. Assign this to something global to your driver to
104 * help determine whether you own this wpan_phy or not.
105 */
106 const void *privid;
107
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400108 /*
Phoebe Buckheister9b2777d62014-02-17 11:34:08 +0100109 * This is a PIB according to 802.15.4-2011.
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400110 * We do not provide timing-related variables, as they
111 * aren't used outside of driver
112 */
113 u8 current_channel;
114 u8 current_page;
Alexander Aring72f655e2015-05-17 21:44:42 +0200115 struct wpan_phy_supported supported;
Alexander Aringe2eb1732015-05-17 21:44:40 +0200116 /* current transmit_power in mBm */
Alexander Aring1a19cb62015-05-17 21:44:39 +0200117 s32 transmit_power;
Alexander Aring7fe9a382014-12-10 15:33:12 +0100118 struct wpan_phy_cca cca;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400119
Alexander Aringdee56d142014-11-05 20:51:25 +0100120 __le64 perm_extended_addr;
121
Alexander Aring32b23552015-05-17 21:44:41 +0200122 /* current cca ed threshold in mBm */
Phoebe Buckheister6ca00192014-02-17 11:34:12 +0100123 s32 cca_ed_level;
Phoebe Buckheister84dda3c2014-02-17 11:34:10 +0100124
Alexander Aring61f2dcb2014-11-12 19:51:56 +0100125 /* PHY depended MAC PIB values */
126
127 /* 802.15.4 acronym: Tdsym in usec */
128 u8 symbol_duration;
129 /* lifs and sifs periods timing */
130 u16 lifs_period;
131 u16 sifs_period;
132
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400133 struct device dev;
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400134
Alexander Aring48961672014-10-25 05:25:10 +0200135 char priv[0] __aligned(NETDEV_ALIGN);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400136};
137
Alexander Aringd5ae67b2014-11-05 20:51:17 +0100138struct wpan_dev {
139 struct wpan_phy *wpan_phy;
Alexander Aring190ac1c2014-11-09 08:36:49 +0100140 int iftype;
Alexander Aring863e88f2014-11-09 08:36:45 +0100141
Alexander Aringfcf39e62014-11-09 08:36:50 +0100142 /* the remainder of this struct should be private to cfg802154 */
143 struct list_head list;
144 struct net_device *netdev;
145
146 u32 identifier;
147
Alexander Aring863e88f2014-11-09 08:36:45 +0100148 /* MAC PIB */
149 __le16 pan_id;
150 __le16 short_addr;
151 __le64 extended_addr;
152
153 /* MAC BSN field */
154 u8 bsn;
155 /* MAC DSN field */
156 u8 dsn;
157
158 u8 min_be;
159 u8 max_be;
160 u8 csma_retries;
161 s8 frame_retries;
162
163 bool lbt;
164
165 bool promiscuous_mode;
Alexander Aringd5ae67b2014-11-05 20:51:17 +0100166};
167
Dmitry Eremin-Solenikov42723442009-11-04 17:53:23 +0300168#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
169
Alexander Aringa5dd1d72014-11-02 04:18:35 +0100170struct wpan_phy *
Alexander Aringf6013792014-11-09 08:36:47 +0100171wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +0400172static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
173{
174 phy->dev.parent = dev;
175}
Alexander Aringe72740d2014-10-25 05:25:11 +0200176
Dmitry Eremin-Solenikove9cf3562009-09-28 19:01:20 +0400177int wpan_phy_register(struct wpan_phy *phy);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400178void wpan_phy_unregister(struct wpan_phy *phy);
179void wpan_phy_free(struct wpan_phy *phy);
Dmitry Eremin-Solenikov1c889f42009-09-15 16:57:04 +0400180/* Same semantics as for class_for_each_device */
181int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400182
183static inline void *wpan_phy_priv(struct wpan_phy *phy)
184{
185 BUG_ON(!phy);
186 return &phy->priv;
187}
188
189struct wpan_phy *wpan_phy_find(const char *str);
Dmitry Eremin-Solenikov69d9ab92009-09-14 18:11:03 +0400190
191static inline void wpan_phy_put(struct wpan_phy *phy)
192{
193 put_device(&phy->dev);
194}
195
Dmitry Eremin-Solenikov2bfb1072009-08-14 16:13:12 +0400196static inline const char *wpan_phy_name(struct wpan_phy *phy)
197{
198 return dev_name(&phy->dev);
199}
Alexander Aring5ad60d32014-10-25 09:41:02 +0200200
201#endif /* __NET_CFG802154_H */