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