include/net/cfg802154.h

   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_pan_id)(struct wpan_phy *wpan_phy,
  48                               struct wpan_dev *wpan_dev, __le16 pan_id);
  49         int     (*set_short_addr)(struct wpan_phy *wpan_phy,
  50                                   struct wpan_dev *wpan_dev, __le16 short_addr);
  51         int     (*set_backoff_exponent)(struct wpan_phy *wpan_phy,
  52                                         struct wpan_dev *wpan_dev, u8 min_be,
  53                                         u8 max_be);
  54         int     (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy,
  55                                          struct wpan_dev *wpan_dev,
  56                                          u8 max_csma_backoffs);
  57         int     (*set_max_frame_retries)(struct wpan_phy *wpan_phy,
  58                                          struct wpan_dev *wpan_dev,
  59                                          s8 max_frame_retries);
  60         int     (*set_lbt_mode)(struct wpan_phy *wpan_phy,
  61                                 struct wpan_dev *wpan_dev, bool mode);
  62 };
  63
  64 static inline bool
  65 wpan_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
  81 struct wpan_phy_supported {
  82         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;
  90 };
  91
  92 struct wpan_phy_cca {
  93         enum nl802154_cca_modes mode;
  94         enum nl802154_cca_opts opt;
  95 };
  96
  97 static inline bool
  98 wpan_phy_cca_cmp(const struct wpan_phy_cca *a, const struct wpan_phy_cca *b)
  99 {
 100         if (a->mode != b->mode)
 101                 return false;
 102
 103         if (a->mode == NL802154_CCA_ENERGY_CARRIER)
 104                 return a->opt == b->opt;
 105
 106         return true;
 107 }
 108
 109 /**
 110  * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
 111  *      transmit power setting.
 112  * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
 113  *      level setting.
 114  * @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode
 115  *      setting.
 116  */
 117 enum wpan_phy_flags {
 118         WPAN_PHY_FLAG_TXPOWER           = BIT(1),
 119         WPAN_PHY_FLAG_CCA_ED_LEVEL      = BIT(2),
 120         WPAN_PHY_FLAG_CCA_MODE          = BIT(3),
 121 };
 122
 123 struct wpan_phy {
 124         struct mutex pib_lock;
 125
 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         u8 bsn;
 183         /* MAC DSN field */
 184         u8 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 */