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 (*add_virtual_intf)(struct wpan_phy *wpan_phy, 38 const char *name, 39 unsigned char name_assign_type, 40 enum nl802154_iftype type, 41 __le64 extended_addr); 42 int (*del_virtual_intf)(struct wpan_phy *wpan_phy, 43 struct wpan_dev *wpan_dev); 44 int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel); 45 int (*set_cca_mode)(struct wpan_phy *wpan_phy, 46 const struct wpan_phy_cca *cca); 47 int (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level); 48 int (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power); 49 int (*set_pan_id)(struct wpan_phy *wpan_phy, 50 struct wpan_dev *wpan_dev, __le16 pan_id); 51 int (*set_short_addr)(struct wpan_phy *wpan_phy, 52 struct wpan_dev *wpan_dev, __le16 short_addr); 53 int (*set_backoff_exponent)(struct wpan_phy *wpan_phy, 54 struct wpan_dev *wpan_dev, u8 min_be, 55 u8 max_be); 56 int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy, 57 struct wpan_dev *wpan_dev, 58 u8 max_csma_backoffs); 59 int (*set_max_frame_retries)(struct wpan_phy *wpan_phy, 60 struct wpan_dev *wpan_dev, 61 s8 max_frame_retries); 62 int (*set_lbt_mode)(struct wpan_phy *wpan_phy, 63 struct wpan_dev *wpan_dev, bool mode); 64 }; 65 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 83 struct wpan_phy_supported { 84 u32 channels[IEEE802154_MAX_PAGE + 1], 85 cca_modes, cca_opts, iftypes; 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; 92 }; 93 94 struct wpan_phy_cca { 95 enum nl802154_cca_modes mode; 96 enum nl802154_cca_opts opt; 97 }; 98 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 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 125 struct wpan_phy { 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 134 u32 flags; 135 136 /* 137 * This is a PIB according to 802.15.4-2011. 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; 143 struct wpan_phy_supported supported; 144 /* current transmit_power in mBm */ 145 s32 transmit_power; 146 struct wpan_phy_cca cca; 147 148 __le64 perm_extended_addr; 149 150 /* current cca ed threshold in mBm */ 151 s32 cca_ed_level; 152 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 161 struct device dev; 162 163 char priv[0] __aligned(NETDEV_ALIGN); 164 }; 165 166 struct wpan_dev { 167 struct wpan_phy *wpan_phy; 168 int iftype; 169 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 176 /* MAC PIB */ 177 __le16 pan_id; 178 __le16 short_addr; 179 __le64 extended_addr; 180 181 /* MAC BSN field */ 182 atomic_t bsn; 183 /* MAC DSN field */ 184 atomic_t dsn; 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; 194 }; 195 196 #define to_phy(_dev) container_of(_dev, struct wpan_phy, dev) 197 198 struct wpan_phy * 199 wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size); 200 static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev) 201 { 202 phy->dev.parent = dev; 203 } 204 205 int wpan_phy_register(struct wpan_phy *phy); 206 void wpan_phy_unregister(struct wpan_phy *phy); 207 void wpan_phy_free(struct wpan_phy *phy); 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); 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); 218 219 static inline void wpan_phy_put(struct wpan_phy *phy) 220 { 221 put_device(&phy->dev); 222 } 223 224 static inline const char *wpan_phy_name(struct wpan_phy *phy) 225 { 226 return dev_name(&phy->dev); 227 } 228 229 #endif /* __NET_CFG802154_H */ 230