Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 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 | * |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 13 | * Written by: |
| 14 | * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com> |
| 15 | */ |
| 16 | |
Alexander Aring | 5ad60d3 | 2014-10-25 09:41:02 +0200 | [diff] [blame] | 17 | #ifndef __NET_CFG802154_H |
| 18 | #define __NET_CFG802154_H |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 19 | |
Alexander Aring | cb41c8d | 2014-11-17 08:20:54 +0100 | [diff] [blame] | 20 | #include <linux/ieee802154.h> |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 21 | #include <linux/netdevice.h> |
| 22 | #include <linux/mutex.h> |
Paul Gortmaker | 187f188 | 2011-11-23 20:12:59 -0500 | [diff] [blame] | 23 | #include <linux/bug.h> |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 24 | |
Alexander Aring | f3ea5e4 | 2014-11-17 08:20:51 +0100 | [diff] [blame] | 25 | #include <net/nl802154.h> |
| 26 | |
Alexander Aring | a5dd1d7 | 2014-11-02 04:18:35 +0100 | [diff] [blame] | 27 | struct wpan_phy; |
Alexander Aring | ba2a950 | 2014-12-10 15:33:13 +0100 | [diff] [blame] | 28 | struct wpan_phy_cca; |
Alexander Aring | a5dd1d7 | 2014-11-02 04:18:35 +0100 | [diff] [blame] | 29 | |
| 30 | struct cfg802154_ops { |
Alexander Aring | 4a9a816 | 2014-11-02 04:18:38 +0100 | [diff] [blame] | 31 | struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy, |
| 32 | const char *name, |
Varka Bhadram | 5b4a1039 | 2015-04-30 17:44:57 +0200 | [diff] [blame] | 33 | unsigned char name_assign_type, |
Alexander Aring | 4a9a816 | 2014-11-02 04:18:38 +0100 | [diff] [blame] | 34 | int type); |
Alexander Aring | 9d30a8c | 2014-11-12 03:36:54 +0100 | [diff] [blame] | 35 | void (*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy, |
| 36 | struct net_device *dev); |
Alexander Aring | f3ea5e4 | 2014-11-17 08:20:51 +0100 | [diff] [blame] | 37 | int (*add_virtual_intf)(struct wpan_phy *wpan_phy, |
| 38 | const char *name, |
Varka Bhadram | 5b4a1039 | 2015-04-30 17:44:57 +0200 | [diff] [blame] | 39 | unsigned char name_assign_type, |
Alexander Aring | 0e57547 | 2014-11-17 08:20:52 +0100 | [diff] [blame] | 40 | enum nl802154_iftype type, |
| 41 | __le64 extended_addr); |
Alexander Aring | b821ecd | 2014-11-17 08:20:53 +0100 | [diff] [blame] | 42 | int (*del_virtual_intf)(struct wpan_phy *wpan_phy, |
| 43 | struct wpan_dev *wpan_dev); |
Alexander Aring | ab0bd56 | 2014-11-12 03:36:55 +0100 | [diff] [blame] | 44 | int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel); |
Alexander Aring | ba2a950 | 2014-12-10 15:33:13 +0100 | [diff] [blame] | 45 | int (*set_cca_mode)(struct wpan_phy *wpan_phy, |
| 46 | const struct wpan_phy_cca *cca); |
Alexander Aring | b69644c | 2015-05-27 13:42:10 +0200 | [diff] [blame] | 47 | int (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level); |
Varka Bhadram | 0f999b0 | 2015-05-27 09:10:54 +0530 | [diff] [blame] | 48 | int (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power); |
Alexander Aring | 702bf37 | 2014-11-12 03:36:57 +0100 | [diff] [blame] | 49 | int (*set_pan_id)(struct wpan_phy *wpan_phy, |
Alexander Aring | ee7b905 | 2014-11-17 08:20:55 +0100 | [diff] [blame] | 50 | struct wpan_dev *wpan_dev, __le16 pan_id); |
Alexander Aring | 9830c62 | 2014-11-12 03:36:58 +0100 | [diff] [blame] | 51 | int (*set_short_addr)(struct wpan_phy *wpan_phy, |
Alexander Aring | ee7b905 | 2014-11-17 08:20:55 +0100 | [diff] [blame] | 52 | struct wpan_dev *wpan_dev, __le16 short_addr); |
Alexander Aring | 656a999 | 2014-11-12 03:36:59 +0100 | [diff] [blame] | 53 | int (*set_backoff_exponent)(struct wpan_phy *wpan_phy, |
| 54 | struct wpan_dev *wpan_dev, u8 min_be, |
| 55 | u8 max_be); |
Alexander Aring | a01ba76 | 2014-11-12 03:37:01 +0100 | [diff] [blame] | 56 | int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy, |
| 57 | struct wpan_dev *wpan_dev, |
| 58 | u8 max_csma_backoffs); |
Alexander Aring | 17a3a46 | 2014-11-12 03:37:03 +0100 | [diff] [blame] | 59 | int (*set_max_frame_retries)(struct wpan_phy *wpan_phy, |
| 60 | struct wpan_dev *wpan_dev, |
| 61 | s8 max_frame_retries); |
Alexander Aring | c8937a1d | 2014-11-12 03:37:05 +0100 | [diff] [blame] | 62 | int (*set_lbt_mode)(struct wpan_phy *wpan_phy, |
| 63 | struct wpan_dev *wpan_dev, bool mode); |
Alexander Aring | a5dd1d7 | 2014-11-02 04:18:35 +0100 | [diff] [blame] | 64 | }; |
| 65 | |
Alexander Aring | fea3318 | 2015-05-17 21:44:43 +0200 | [diff] [blame] | 66 | static inline bool |
| 67 | wpan_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 Aring | 72f655e | 2015-05-17 21:44:42 +0200 | [diff] [blame] | 83 | struct wpan_phy_supported { |
Alexander Aring | fea3318 | 2015-05-17 21:44:43 +0200 | [diff] [blame] | 84 | u32 channels[IEEE802154_MAX_PAGE + 1], |
Alexander Aring | 6531868 | 2015-05-17 21:44:47 +0200 | [diff] [blame] | 85 | cca_modes, cca_opts, iftypes; |
Alexander Aring | fea3318 | 2015-05-17 21:44:43 +0200 | [diff] [blame] | 86 | 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 Aring | 72f655e | 2015-05-17 21:44:42 +0200 | [diff] [blame] | 92 | }; |
| 93 | |
Alexander Aring | 7fe9a38 | 2014-12-10 15:33:12 +0100 | [diff] [blame] | 94 | struct wpan_phy_cca { |
| 95 | enum nl802154_cca_modes mode; |
| 96 | enum nl802154_cca_opts opt; |
| 97 | }; |
| 98 | |
Alexander Aring | 791021b | 2015-05-17 21:44:44 +0200 | [diff] [blame] | 99 | static inline bool |
| 100 | wpan_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 Aring | edea8f7 | 2015-05-17 21:44:46 +0200 | [diff] [blame] | 111 | /** |
| 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 | */ |
| 119 | enum 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-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 125 | struct wpan_phy { |
Alexander Aring | 6322d50 | 2014-11-12 03:36:51 +0100 | [diff] [blame] | 126 | /* 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 Aring | edea8f7 | 2015-05-17 21:44:46 +0200 | [diff] [blame] | 134 | u32 flags; |
| 135 | |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 136 | /* |
Phoebe Buckheister | 9b2777d | 2014-02-17 11:34:08 +0100 | [diff] [blame] | 137 | * This is a PIB according to 802.15.4-2011. |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 138 | * 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 Aring | 72f655e | 2015-05-17 21:44:42 +0200 | [diff] [blame] | 143 | struct wpan_phy_supported supported; |
Alexander Aring | e2eb173 | 2015-05-17 21:44:40 +0200 | [diff] [blame] | 144 | /* current transmit_power in mBm */ |
Alexander Aring | 1a19cb6 | 2015-05-17 21:44:39 +0200 | [diff] [blame] | 145 | s32 transmit_power; |
Alexander Aring | 7fe9a38 | 2014-12-10 15:33:12 +0100 | [diff] [blame] | 146 | struct wpan_phy_cca cca; |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 147 | |
Alexander Aring | dee56d14 | 2014-11-05 20:51:25 +0100 | [diff] [blame] | 148 | __le64 perm_extended_addr; |
| 149 | |
Alexander Aring | 32b2355 | 2015-05-17 21:44:41 +0200 | [diff] [blame] | 150 | /* current cca ed threshold in mBm */ |
Phoebe Buckheister | 6ca0019 | 2014-02-17 11:34:12 +0100 | [diff] [blame] | 151 | s32 cca_ed_level; |
Phoebe Buckheister | 84dda3c | 2014-02-17 11:34:10 +0100 | [diff] [blame] | 152 | |
Alexander Aring | 61f2dcb | 2014-11-12 19:51:56 +0100 | [diff] [blame] | 153 | /* 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-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 161 | struct device dev; |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 162 | |
Alexander Aring | 4896167 | 2014-10-25 05:25:10 +0200 | [diff] [blame] | 163 | char priv[0] __aligned(NETDEV_ALIGN); |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 164 | }; |
| 165 | |
Alexander Aring | d5ae67b | 2014-11-05 20:51:17 +0100 | [diff] [blame] | 166 | struct wpan_dev { |
| 167 | struct wpan_phy *wpan_phy; |
Alexander Aring | 190ac1c | 2014-11-09 08:36:49 +0100 | [diff] [blame] | 168 | int iftype; |
Alexander Aring | 863e88f | 2014-11-09 08:36:45 +0100 | [diff] [blame] | 169 | |
Alexander Aring | fcf39e6 | 2014-11-09 08:36:50 +0100 | [diff] [blame] | 170 | /* 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 Aring | 863e88f | 2014-11-09 08:36:45 +0100 | [diff] [blame] | 176 | /* MAC PIB */ |
| 177 | __le16 pan_id; |
| 178 | __le16 short_addr; |
| 179 | __le64 extended_addr; |
| 180 | |
| 181 | /* MAC BSN field */ |
Alexander Aring | 344f8c1 | 2015-05-22 17:43:53 +0200 | [diff] [blame] | 182 | atomic_t bsn; |
Alexander Aring | 863e88f | 2014-11-09 08:36:45 +0100 | [diff] [blame] | 183 | /* MAC DSN field */ |
Alexander Aring | 344f8c1 | 2015-05-22 17:43:53 +0200 | [diff] [blame] | 184 | atomic_t dsn; |
Alexander Aring | 863e88f | 2014-11-09 08:36:45 +0100 | [diff] [blame] | 185 | |
| 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 Aring | d5ae67b | 2014-11-05 20:51:17 +0100 | [diff] [blame] | 194 | }; |
| 195 | |
Dmitry Eremin-Solenikov | 4272344 | 2009-11-04 17:53:23 +0300 | [diff] [blame] | 196 | #define to_phy(_dev) container_of(_dev, struct wpan_phy, dev) |
| 197 | |
Alexander Aring | a5dd1d7 | 2014-11-02 04:18:35 +0100 | [diff] [blame] | 198 | struct wpan_phy * |
Alexander Aring | f601379 | 2014-11-09 08:36:47 +0100 | [diff] [blame] | 199 | wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size); |
Dmitry Eremin-Solenikov | e9cf356 | 2009-09-28 19:01:20 +0400 | [diff] [blame] | 200 | static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev) |
| 201 | { |
| 202 | phy->dev.parent = dev; |
| 203 | } |
Alexander Aring | e72740d | 2014-10-25 05:25:11 +0200 | [diff] [blame] | 204 | |
Dmitry Eremin-Solenikov | e9cf356 | 2009-09-28 19:01:20 +0400 | [diff] [blame] | 205 | int wpan_phy_register(struct wpan_phy *phy); |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 206 | void wpan_phy_unregister(struct wpan_phy *phy); |
| 207 | void wpan_phy_free(struct wpan_phy *phy); |
Dmitry Eremin-Solenikov | 1c889f4 | 2009-09-15 16:57:04 +0400 | [diff] [blame] | 208 | /* Same semantics as for class_for_each_device */ |
| 209 | int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data); |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 210 | |
| 211 | static inline void *wpan_phy_priv(struct wpan_phy *phy) |
| 212 | { |
| 213 | BUG_ON(!phy); |
| 214 | return &phy->priv; |
| 215 | } |
| 216 | |
| 217 | struct wpan_phy *wpan_phy_find(const char *str); |
Dmitry Eremin-Solenikov | 69d9ab9 | 2009-09-14 18:11:03 +0400 | [diff] [blame] | 218 | |
| 219 | static inline void wpan_phy_put(struct wpan_phy *phy) |
| 220 | { |
| 221 | put_device(&phy->dev); |
| 222 | } |
| 223 | |
Dmitry Eremin-Solenikov | 2bfb107 | 2009-08-14 16:13:12 +0400 | [diff] [blame] | 224 | static inline const char *wpan_phy_name(struct wpan_phy *phy) |
| 225 | { |
| 226 | return dev_name(&phy->dev); |
| 227 | } |
Alexander Aring | 5ad60d3 | 2014-10-25 09:41:02 +0200 | [diff] [blame] | 228 | |
| 229 | #endif /* __NET_CFG802154_H */ |