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 };
  52
  53 struct wpan_phy {
  54         struct mutex pib_lock;
  55
  56         /* If multiple wpan_phys are registered and you're handed e.g.
  57          * a regular netdev with assigned ieee802154_ptr, you won't
  58          * know whether it points to a wpan_phy your driver has registered
  59          * or not. Assign this to something global to your driver to
  60          * help determine whether you own this wpan_phy or not.
  61          */
  62         const void *privid;
  63
  64         /*
  65          * This is a PIB according to 802.15.4-2011.
  66          * We do not provide timing-related variables, as they
  67          * aren't used outside of driver
  68          */
  69         u8 current_channel;
  70         u8 current_page;
  71         u32 channels_supported[32];
  72         s8 transmit_power;
  73         u8 cca_mode;
  74
  75         __le64 perm_extended_addr;
  76
  77         s32 cca_ed_level;
  78
  79         struct device dev;
  80
  81         char priv[0] __aligned(NETDEV_ALIGN);
  82 };
  83
  84 struct wpan_dev {
  85         struct wpan_phy *wpan_phy;
  86         int iftype;
  87
  88         /* the remainder of this struct should be private to cfg802154 */
  89         struct list_head list;
  90         struct net_device *netdev;
  91
  92         u32 identifier;
  93
  94         /* MAC PIB */
  95         __le16 pan_id;
  96         __le16 short_addr;
  97         __le64 extended_addr;
  98
  99         /* MAC BSN field */
 100         u8 bsn;
 101         /* MAC DSN field */
 102         u8 dsn;
 103
 104         u8 min_be;
 105         u8 max_be;
 106         u8 csma_retries;
 107         s8 frame_retries;
 108
 109         bool lbt;
 110
 111         bool promiscuous_mode;
 112 };
 113
 114 #define to_phy(_dev)    container_of(_dev, struct wpan_phy, dev)
 115
 116 struct wpan_phy *
 117 wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
 118 static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
 119 {
 120         phy->dev.parent = dev;
 121 }
 122
 123 int wpan_phy_register(struct wpan_phy *phy);
 124 void wpan_phy_unregister(struct wpan_phy *phy);
 125 void wpan_phy_free(struct wpan_phy *phy);
 126 /* Same semantics as for class_for_each_device */
 127 int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
 128
 129 static inline void *wpan_phy_priv(struct wpan_phy *phy)
 130 {
 131         BUG_ON(!phy);
 132         return &phy->priv;
 133 }
 134
 135 struct wpan_phy *wpan_phy_find(const char *str);
 136
 137 static inline void wpan_phy_put(struct wpan_phy *phy)
 138 {
 139         put_device(&phy->dev);
 140 }
 141
 142 static inline const char *wpan_phy_name(struct wpan_phy *phy)
 143 {
 144         return dev_name(&phy->dev);
 145 }
 146
 147 #endif /* __NET_CFG802154_H */