include/net/wpan-phy.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  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  *
  17  * Written by:
  18  * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
  19  */
  20
  21 #ifndef WPAN_PHY_H
  22 #define WPAN_PHY_H
  23
  24 #include <linux/netdevice.h>
  25 #include <linux/mutex.h>
  26 #include <linux/bug.h>
  27
  28 /* According to the IEEE 802.15.4 stadard the upper most significant bits of
  29  * the 32-bit channel bitmaps shall be used as an integer value to specify 32
  30  * possible channel pages. The lower 27 bits of the channel bit map shall be
  31  * used as a bit mask to specify channel numbers within a channel page.
  32  */
  33 #define WPAN_NUM_CHANNELS       27
  34 #define WPAN_NUM_PAGES          32
  35
  36 struct wpan_phy {
  37         struct mutex pib_lock;
  38
  39         /*
  40          * This is a PIB according to 802.15.4-2011.
  41          * We do not provide timing-related variables, as they
  42          * aren't used outside of driver
  43          */
  44         u8 current_channel;
  45         u8 current_page;
  46         u32 channels_supported[32];
  47         s8 transmit_power;
  48         u8 cca_mode;
  49         u8 min_be;
  50         u8 max_be;
  51         u8 csma_retries;
  52         s8 frame_retries;
  53
  54         bool lbt;
  55         s32 cca_ed_level;
  56
  57         struct device dev;
  58         int idx;
  59
  60         struct net_device *(*add_iface)(struct wpan_phy *phy,
  61                                         const char *name, int type);
  62         void (*del_iface)(struct wpan_phy *phy, struct net_device *dev);
  63
  64         int (*set_txpower)(struct wpan_phy *phy, int db);
  65         int (*set_lbt)(struct wpan_phy *phy, bool on);
  66         int (*set_cca_mode)(struct wpan_phy *phy, u8 cca_mode);
  67         int (*set_cca_ed_level)(struct wpan_phy *phy, int level);
  68         int (*set_csma_params)(struct wpan_phy *phy, u8 min_be, u8 max_be,
  69                                u8 retries);
  70         int (*set_frame_retries)(struct wpan_phy *phy, s8 retries);
  71
  72         char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
  73 };
  74
  75 #define to_phy(_dev)    container_of(_dev, struct wpan_phy, dev)
  76
  77 struct wpan_phy *wpan_phy_alloc(size_t priv_size);
  78 static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
  79 {
  80         phy->dev.parent = dev;
  81 }
  82 int wpan_phy_register(struct wpan_phy *phy);
  83 void wpan_phy_unregister(struct wpan_phy *phy);
  84 void wpan_phy_free(struct wpan_phy *phy);
  85 /* Same semantics as for class_for_each_device */
  86 int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
  87
  88 static inline void *wpan_phy_priv(struct wpan_phy *phy)
  89 {
  90         BUG_ON(!phy);
  91         return &phy->priv;
  92 }
  93
  94 struct wpan_phy *wpan_phy_find(const char *str);
  95
  96 static inline void wpan_phy_put(struct wpan_phy *phy)
  97 {
  98         put_device(&phy->dev);
  99 }
 100
 101 static inline const char *wpan_phy_name(struct wpan_phy *phy)
 102 {
 103         return dev_name(&phy->dev);
 104 }
 105 #endif