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