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         struct mutex pib_lock;
  34
  35         /*
  36          * This is a PIB according to 802.15.4-2011.
  37          * We do not provide timing-related variables, as they
  38          * aren't used outside of driver
  39          */
  40         u8 current_channel;
  41         u8 current_page;
  42         u32 channels_supported[32];
  43         s8 transmit_power;
  44         u8 cca_mode;
  45         u8 min_be;
  46         u8 max_be;
  47         u8 csma_retries;
  48         s8 frame_retries;
  49
  50         bool lbt;
  51         s32 cca_ed_level;
  52
  53         struct device dev;
  54         int idx;
  55
  56         struct net_device *(*add_iface)(struct wpan_phy *phy,
  57                                         const char *name, int type);
  58         void (*del_iface)(struct wpan_phy *phy, struct net_device *dev);
  59
  60         int (*set_txpower)(struct wpan_phy *phy, int db);
  61         int (*set_lbt)(struct wpan_phy *phy, bool on);
  62         int (*set_cca_mode)(struct wpan_phy *phy, u8 cca_mode);
  63         int (*set_cca_ed_level)(struct wpan_phy *phy, int level);
  64         int (*set_csma_params)(struct wpan_phy *phy, u8 min_be, u8 max_be,
  65                                u8 retries);
  66         int (*set_frame_retries)(struct wpan_phy *phy, s8 retries);
  67
  68         char priv[0] __aligned(NETDEV_ALIGN);
  69 };
  70
  71 #define to_phy(_dev)    container_of(_dev, struct wpan_phy, dev)
  72
  73 struct wpan_phy *wpan_phy_alloc(size_t priv_size);
  74 static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
  75 {
  76         phy->dev.parent = dev;
  77 }
  78
  79 int wpan_phy_register(struct wpan_phy *phy);
  80 void wpan_phy_unregister(struct wpan_phy *phy);
  81 void wpan_phy_free(struct wpan_phy *phy);
  82 /* Same semantics as for class_for_each_device */
  83 int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
  84
  85 static inline void *wpan_phy_priv(struct wpan_phy *phy)
  86 {
  87         BUG_ON(!phy);
  88         return &phy->priv;
  89 }
  90
  91 struct wpan_phy *wpan_phy_find(const char *str);
  92
  93 static inline void wpan_phy_put(struct wpan_phy *phy)
  94 {
  95         put_device(&phy->dev);
  96 }
  97
  98 static inline const char *wpan_phy_name(struct wpan_phy *phy)
  99 {
 100         return dev_name(&phy->dev);
 101 }
 102
 103 #endif /* __NET_CFG802154_H */