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 };
  41
  42 struct wpan_phy {
  43         struct mutex pib_lock;
  44
  45         /*
  46          * This is a PIB according to 802.15.4-2011.
  47          * We do not provide timing-related variables, as they
  48          * aren't used outside of driver
  49          */
  50         u8 current_channel;
  51         u8 current_page;
  52         u32 channels_supported[32];
  53         s8 transmit_power;
  54         u8 cca_mode;
  55
  56         __le64 perm_extended_addr;
  57
  58         s32 cca_ed_level;
  59
  60         struct device dev;
  61
  62         char priv[0] __aligned(NETDEV_ALIGN);
  63 };
  64
  65 struct wpan_dev {
  66         struct wpan_phy *wpan_phy;
  67
  68         /* MAC PIB */
  69         __le16 pan_id;
  70         __le16 short_addr;
  71         __le64 extended_addr;
  72
  73         /* MAC BSN field */
  74         u8 bsn;
  75         /* MAC DSN field */
  76         u8 dsn;
  77
  78         u8 min_be;
  79         u8 max_be;
  80         u8 csma_retries;
  81         s8 frame_retries;
  82
  83         bool lbt;
  84
  85         bool promiscuous_mode;
  86 };
  87
  88 #define to_phy(_dev)    container_of(_dev, struct wpan_phy, dev)
  89
  90 struct wpan_phy *
  91 wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
  92 static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
  93 {
  94         phy->dev.parent = dev;
  95 }
  96
  97 int wpan_phy_register(struct wpan_phy *phy);
  98 void wpan_phy_unregister(struct wpan_phy *phy);
  99 void wpan_phy_free(struct wpan_phy *phy);
 100 /* Same semantics as for class_for_each_device */
 101 int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
 102
 103 static inline void *wpan_phy_priv(struct wpan_phy *phy)
 104 {
 105         BUG_ON(!phy);
 106         return &phy->priv;
 107 }
 108
 109 struct wpan_phy *wpan_phy_find(const char *str);
 110
 111 static inline void wpan_phy_put(struct wpan_phy *phy)
 112 {
 113         put_device(&phy->dev);
 114 }
 115
 116 static inline const char *wpan_phy_name(struct wpan_phy *phy)
 117 {
 118         return dev_name(&phy->dev);
 119 }
 120
 121 #endif /* __NET_CFG802154_H */