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