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