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 27 struct wpan_phy; 28 struct wpan_phy_cca; 29 30 struct 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 (*suspend)(struct wpan_phy *wpan_phy); 38 int (*resume)(struct wpan_phy *wpan_phy); 39 int (*add_virtual_intf)(struct wpan_phy *wpan_phy, 40 const char *name, 41 unsigned char name_assign_type, 42 enum nl802154_iftype type, 43 __le64 extended_addr); 44 int (*del_virtual_intf)(struct wpan_phy *wpan_phy, 45 struct wpan_dev *wpan_dev); 46 int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel); 47 int (*set_cca_mode)(struct wpan_phy *wpan_phy, 48 const struct wpan_phy_cca *cca); 49 int (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level); 50 int (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power); 51 int (*set_pan_id)(struct wpan_phy *wpan_phy, 52 struct wpan_dev *wpan_dev, __le16 pan_id); 53 int (*set_short_addr)(struct wpan_phy *wpan_phy, 54 struct wpan_dev *wpan_dev, __le16 short_addr); 55 int (*set_backoff_exponent)(struct wpan_phy *wpan_phy, 56 struct wpan_dev *wpan_dev, u8 min_be, 57 u8 max_be); 58 int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy, 59 struct wpan_dev *wpan_dev, 60 u8 max_csma_backoffs); 61 int (*set_max_frame_retries)(struct wpan_phy *wpan_phy, 62 struct wpan_dev *wpan_dev, 63 s8 max_frame_retries); 64 int (*set_lbt_mode)(struct wpan_phy *wpan_phy, 65 struct wpan_dev *wpan_dev, bool mode); 66 int (*set_ackreq_default)(struct wpan_phy *wpan_phy, 67 struct wpan_dev *wpan_dev, bool ackreq); 68 }; 69 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 87 struct wpan_phy_supported { 88 u32 channels[IEEE802154_MAX_PAGE + 1], 89 cca_modes, cca_opts, iftypes; 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; 96 }; 97 98 struct wpan_phy_cca { 99 enum nl802154_cca_modes mode; 100 enum nl802154_cca_opts opt; 101 }; 102 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 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 129 struct wpan_phy { 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 138 u32 flags; 139 140 /* 141 * This is a PIB according to 802.15.4-2011. 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; 147 struct wpan_phy_supported supported; 148 /* current transmit_power in mBm */ 149 s32 transmit_power; 150 struct wpan_phy_cca cca; 151 152 __le64 perm_extended_addr; 153 154 /* current cca ed threshold in mBm */ 155 s32 cca_ed_level; 156 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 165 struct device dev; 166 167 char priv[0] __aligned(NETDEV_ALIGN); 168 }; 169 170 struct wpan_dev { 171 struct wpan_phy *wpan_phy; 172 int iftype; 173 174 /* the remainder of this struct should be private to cfg802154 */ 175 struct list_head list; 176 struct net_device *netdev; 177 178 /* lowpan interface, set when the wpan_dev belongs to one lowpan_dev */ 179 struct net_device *lowpan_dev; 180 181 u32 identifier; 182 183 /* MAC PIB */ 184 __le16 pan_id; 185 __le16 short_addr; 186 __le64 extended_addr; 187 188 /* MAC BSN field */ 189 atomic_t bsn; 190 /* MAC DSN field */ 191 atomic_t dsn; 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; 201 202 /* fallback for acknowledgment bit setting */ 203 bool ackreq; 204 }; 205 206 #define to_phy(_dev) container_of(_dev, struct wpan_phy, dev) 207 208 struct wpan_phy * 209 wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size); 210 static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev) 211 { 212 phy->dev.parent = dev; 213 } 214 215 int wpan_phy_register(struct wpan_phy *phy); 216 void wpan_phy_unregister(struct wpan_phy *phy); 217 void wpan_phy_free(struct wpan_phy *phy); 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); 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); 228 229 static inline void wpan_phy_put(struct wpan_phy *phy) 230 { 231 put_device(&phy->dev); 232 } 233 234 static inline const char *wpan_phy_name(struct wpan_phy *phy) 235 { 236 return dev_name(&phy->dev); 237 } 238 239 #endif /* __NET_CFG802154_H */ 240