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 int type); 34 void (*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy, 35 struct net_device *dev); 36 int (*add_virtual_intf)(struct wpan_phy *wpan_phy, 37 const char *name, 38 enum nl802154_iftype type, 39 __le64 extended_addr); 40 int (*del_virtual_intf)(struct wpan_phy *wpan_phy, 41 struct wpan_dev *wpan_dev); 42 int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel); 43 int (*set_cca_mode)(struct wpan_phy *wpan_phy, 44 const struct wpan_phy_cca *cca); 45 int (*set_pan_id)(struct wpan_phy *wpan_phy, 46 struct wpan_dev *wpan_dev, __le16 pan_id); 47 int (*set_short_addr)(struct wpan_phy *wpan_phy, 48 struct wpan_dev *wpan_dev, __le16 short_addr); 49 int (*set_backoff_exponent)(struct wpan_phy *wpan_phy, 50 struct wpan_dev *wpan_dev, u8 min_be, 51 u8 max_be); 52 int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy, 53 struct wpan_dev *wpan_dev, 54 u8 max_csma_backoffs); 55 int (*set_max_frame_retries)(struct wpan_phy *wpan_phy, 56 struct wpan_dev *wpan_dev, 57 s8 max_frame_retries); 58 int (*set_lbt_mode)(struct wpan_phy *wpan_phy, 59 struct wpan_dev *wpan_dev, bool mode); 60 }; 61 62 struct wpan_phy_cca { 63 enum nl802154_cca_modes mode; 64 enum nl802154_cca_opts opt; 65 }; 66 67 struct wpan_phy { 68 struct mutex pib_lock; 69 70 /* If multiple wpan_phys are registered and you're handed e.g. 71 * a regular netdev with assigned ieee802154_ptr, you won't 72 * know whether it points to a wpan_phy your driver has registered 73 * or not. Assign this to something global to your driver to 74 * help determine whether you own this wpan_phy or not. 75 */ 76 const void *privid; 77 78 /* 79 * This is a PIB according to 802.15.4-2011. 80 * We do not provide timing-related variables, as they 81 * aren't used outside of driver 82 */ 83 u8 current_channel; 84 u8 current_page; 85 u32 channels_supported[IEEE802154_MAX_PAGE + 1]; 86 s8 transmit_power; 87 struct wpan_phy_cca cca; 88 89 __le64 perm_extended_addr; 90 91 s32 cca_ed_level; 92 93 /* PHY depended MAC PIB values */ 94 95 /* 802.15.4 acronym: Tdsym in usec */ 96 u8 symbol_duration; 97 /* lifs and sifs periods timing */ 98 u16 lifs_period; 99 u16 sifs_period; 100 101 struct device dev; 102 103 char priv[0] __aligned(NETDEV_ALIGN); 104 }; 105 106 struct wpan_dev { 107 struct wpan_phy *wpan_phy; 108 int iftype; 109 110 /* the remainder of this struct should be private to cfg802154 */ 111 struct list_head list; 112 struct net_device *netdev; 113 114 u32 identifier; 115 116 /* MAC PIB */ 117 __le16 pan_id; 118 __le16 short_addr; 119 __le64 extended_addr; 120 121 /* MAC BSN field */ 122 u8 bsn; 123 /* MAC DSN field */ 124 u8 dsn; 125 126 u8 min_be; 127 u8 max_be; 128 u8 csma_retries; 129 s8 frame_retries; 130 131 bool lbt; 132 133 bool promiscuous_mode; 134 }; 135 136 #define to_phy(_dev) container_of(_dev, struct wpan_phy, dev) 137 138 struct wpan_phy * 139 wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size); 140 static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev) 141 { 142 phy->dev.parent = dev; 143 } 144 145 int wpan_phy_register(struct wpan_phy *phy); 146 void wpan_phy_unregister(struct wpan_phy *phy); 147 void wpan_phy_free(struct wpan_phy *phy); 148 /* Same semantics as for class_for_each_device */ 149 int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data); 150 151 static inline void *wpan_phy_priv(struct wpan_phy *phy) 152 { 153 BUG_ON(!phy); 154 return &phy->priv; 155 } 156 157 struct wpan_phy *wpan_phy_find(const char *str); 158 159 static inline void wpan_phy_put(struct wpan_phy *phy) 160 { 161 put_device(&phy->dev); 162 } 163 164 static inline const char *wpan_phy_name(struct wpan_phy *phy) 165 { 166 return dev_name(&phy->dev); 167 } 168 169 #endif /* __NET_CFG802154_H */ 170