net/mac802154/ieee802154_dev.c

   1 /*
   2  * Copyright (C) 2007-2012 Siemens AG
   3  *
   4  * Written by:
   5  * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
   6  *
   7  * Based on the code from 'linux-zigbee.sourceforge.net' project.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2
  11  * as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #include <linux/kernel.h>
  24 #include <linux/module.h>
  25 #include <linux/netdevice.h>
  26
  27 #include <net/netlink.h>
  28 #include <linux/nl802154.h>
  29 #include <net/mac802154.h>
  30 #include <net/ieee802154_netdev.h>
  31 #include <net/route.h>
  32 #include <net/wpan-phy.h>
  33
  34 #include "mac802154.h"
  35
  36 int mac802154_slave_open(struct net_device *dev)
  37 {
  38         struct mac802154_sub_if_data *priv = netdev_priv(dev);
  39         struct mac802154_sub_if_data *subif;
  40         struct mac802154_priv *ipriv = priv->hw;
  41         int res = 0;
  42
  43         ASSERT_RTNL();
  44
  45         if (priv->type == IEEE802154_DEV_WPAN) {
  46                 mutex_lock(&priv->hw->slaves_mtx);
  47                 list_for_each_entry(subif, &priv->hw->slaves, list) {
  48                         if (subif != priv && subif->type == priv->type &&
  49                             subif->running) {
  50                                 mutex_unlock(&priv->hw->slaves_mtx);
  51                                 return -EBUSY;
  52                         }
  53                 }
  54                 mutex_unlock(&priv->hw->slaves_mtx);
  55         }
  56
  57         mutex_lock(&priv->hw->slaves_mtx);
  58         priv->running = true;
  59         mutex_unlock(&priv->hw->slaves_mtx);
  60
  61         if (ipriv->open_count++ == 0) {
  62                 res = ipriv->ops->start(&ipriv->hw);
  63                 WARN_ON(res);
  64                 if (res)
  65                         goto err;
  66         }
  67
  68         if (ipriv->ops->ieee_addr) {
  69                 __le64 addr = ieee802154_devaddr_from_raw(dev->dev_addr);
  70
  71                 res = ipriv->ops->ieee_addr(&ipriv->hw, addr);
  72                 WARN_ON(res);
  73                 if (res)
  74                         goto err;
  75                 mac802154_dev_set_ieee_addr(dev);
  76         }
  77
  78         netif_start_queue(dev);
  79         return 0;
  80 err:
  81         priv->hw->open_count--;
  82
  83         return res;
  84 }
  85
  86 int mac802154_slave_close(struct net_device *dev)
  87 {
  88         struct mac802154_sub_if_data *priv = netdev_priv(dev);
  89         struct mac802154_priv *ipriv = priv->hw;
  90
  91         ASSERT_RTNL();
  92
  93         netif_stop_queue(dev);
  94
  95         mutex_lock(&priv->hw->slaves_mtx);
  96         priv->running = false;
  97         mutex_unlock(&priv->hw->slaves_mtx);
  98
  99         if (!--ipriv->open_count)
 100                 ipriv->ops->stop(&ipriv->hw);
 101
 102         return 0;
 103 }
 104
 105 static int
 106 mac802154_netdev_register(struct wpan_phy *phy, struct net_device *dev)
 107 {
 108         struct mac802154_sub_if_data *priv;
 109         struct mac802154_priv *ipriv;
 110         int err;
 111
 112         ipriv = wpan_phy_priv(phy);
 113
 114         priv = netdev_priv(dev);
 115         priv->dev = dev;
 116         priv->hw = ipriv;
 117
 118         dev->needed_headroom = ipriv->hw.extra_tx_headroom;
 119
 120         SET_NETDEV_DEV(dev, &ipriv->phy->dev);
 121
 122         mutex_lock(&ipriv->slaves_mtx);
 123         if (!ipriv->running) {
 124                 mutex_unlock(&ipriv->slaves_mtx);
 125                 return -ENODEV;
 126         }
 127         mutex_unlock(&ipriv->slaves_mtx);
 128
 129         err = register_netdev(dev);
 130         if (err < 0)
 131                 return err;
 132
 133         rtnl_lock();
 134         mutex_lock(&ipriv->slaves_mtx);
 135         list_add_tail_rcu(&priv->list, &ipriv->slaves);
 136         mutex_unlock(&ipriv->slaves_mtx);
 137         rtnl_unlock();
 138
 139         return 0;
 140 }
 141
 142 static void
 143 mac802154_del_iface(struct wpan_phy *phy, struct net_device *dev)
 144 {
 145         struct mac802154_sub_if_data *sdata;
 146
 147         ASSERT_RTNL();
 148
 149         sdata = netdev_priv(dev);
 150
 151         BUG_ON(sdata->hw->phy != phy);
 152
 153         mutex_lock(&sdata->hw->slaves_mtx);
 154         list_del_rcu(&sdata->list);
 155         mutex_unlock(&sdata->hw->slaves_mtx);
 156
 157         synchronize_rcu();
 158         unregister_netdevice(sdata->dev);
 159 }
 160
 161 static struct net_device *
 162 mac802154_add_iface(struct wpan_phy *phy, const char *name, int type)
 163 {
 164         struct net_device *dev;
 165         int err = -ENOMEM;
 166
 167         switch (type) {
 168         case IEEE802154_DEV_MONITOR:
 169                 dev = alloc_netdev(sizeof(struct mac802154_sub_if_data),
 170                                    name, NET_NAME_UNKNOWN,
 171                                    mac802154_monitor_setup);
 172                 break;
 173         case IEEE802154_DEV_WPAN:
 174                 dev = alloc_netdev(sizeof(struct mac802154_sub_if_data),
 175                                    name, NET_NAME_UNKNOWN,
 176                                    mac802154_wpan_setup);
 177                 break;
 178         default:
 179                 dev = NULL;
 180                 err = -EINVAL;
 181                 break;
 182         }
 183         if (!dev)
 184                 goto err;
 185
 186         err = mac802154_netdev_register(phy, dev);
 187         if (err)
 188                 goto err_free;
 189
 190         dev_hold(dev); /* we return an incremented device refcount */
 191         return dev;
 192
 193 err_free:
 194         free_netdev(dev);
 195 err:
 196         return ERR_PTR(err);
 197 }
 198
 199 static int mac802154_set_txpower(struct wpan_phy *phy, int db)
 200 {
 201         struct mac802154_priv *priv = wpan_phy_priv(phy);
 202
 203         return priv->ops->set_txpower(&priv->hw, db);
 204 }
 205
 206 static int mac802154_set_lbt(struct wpan_phy *phy, bool on)
 207 {
 208         struct mac802154_priv *priv = wpan_phy_priv(phy);
 209
 210         return priv->ops->set_lbt(&priv->hw, on);
 211 }
 212
 213 static int mac802154_set_cca_mode(struct wpan_phy *phy, u8 mode)
 214 {
 215         struct mac802154_priv *priv = wpan_phy_priv(phy);
 216
 217         return priv->ops->set_cca_mode(&priv->hw, mode);
 218 }
 219
 220 static int mac802154_set_cca_ed_level(struct wpan_phy *phy, s32 level)
 221 {
 222         struct mac802154_priv *priv = wpan_phy_priv(phy);
 223
 224         return priv->ops->set_cca_ed_level(&priv->hw, level);
 225 }
 226
 227 static int mac802154_set_csma_params(struct wpan_phy *phy, u8 min_be,
 228                                      u8 max_be, u8 retries)
 229 {
 230         struct mac802154_priv *priv = wpan_phy_priv(phy);
 231
 232         return priv->ops->set_csma_params(&priv->hw, min_be, max_be, retries);
 233 }
 234
 235 static int mac802154_set_frame_retries(struct wpan_phy *phy, s8 retries)
 236 {
 237         struct mac802154_priv *priv = wpan_phy_priv(phy);
 238
 239         return priv->ops->set_frame_retries(&priv->hw, retries);
 240 }
 241
 242 struct ieee802154_dev *
 243 ieee802154_alloc_device(size_t priv_data_len, struct ieee802154_ops *ops)
 244 {
 245         struct wpan_phy *phy;
 246         struct mac802154_priv *priv;
 247         size_t priv_size;
 248
 249         if (!ops || !ops->xmit || !ops->ed || !ops->start ||
 250             !ops->stop || !ops->set_channel) {
 251                 pr_err("undefined IEEE802.15.4 device operations\n");
 252                 return NULL;
 253         }
 254
 255         /* Ensure 32-byte alignment of our private data and hw private data.
 256          * We use the wpan_phy priv data for both our mac802154_priv and for
 257          * the driver's private data
 258          *
 259          * in memory it'll be like this:
 260          *
 261          * +-----------------------+
 262          * | struct wpan_phy       |
 263          * +-----------------------+
 264          * | struct mac802154_priv |
 265          * +-----------------------+
 266          * | driver's private data |
 267          * +-----------------------+
 268          *
 269          * Due to ieee802154 layer isn't aware of driver and MAC structures,
 270          * so lets allign them here.
 271          */
 272
 273         priv_size = ALIGN(sizeof(*priv), NETDEV_ALIGN) + priv_data_len;
 274
 275         phy = wpan_phy_alloc(priv_size);
 276         if (!phy) {
 277                 pr_err("failure to allocate master IEEE802.15.4 device\n");
 278                 return NULL;
 279         }
 280
 281         priv = wpan_phy_priv(phy);
 282         priv->phy = phy;
 283         priv->hw.phy = priv->phy;
 284         priv->hw.priv = (char *)priv + ALIGN(sizeof(*priv), NETDEV_ALIGN);
 285         priv->ops = ops;
 286
 287         INIT_LIST_HEAD(&priv->slaves);
 288         mutex_init(&priv->slaves_mtx);
 289
 290         return &priv->hw;
 291 }
 292 EXPORT_SYMBOL(ieee802154_alloc_device);
 293
 294 void ieee802154_free_device(struct ieee802154_dev *hw)
 295 {
 296         struct mac802154_priv *priv = mac802154_to_priv(hw);
 297
 298         BUG_ON(!list_empty(&priv->slaves));
 299
 300         mutex_destroy(&priv->slaves_mtx);
 301
 302         wpan_phy_free(priv->phy);
 303 }
 304 EXPORT_SYMBOL(ieee802154_free_device);
 305
 306 int ieee802154_register_device(struct ieee802154_dev *dev)
 307 {
 308         struct mac802154_priv *priv = mac802154_to_priv(dev);
 309         int rc = -ENOSYS;
 310
 311         if (dev->flags & IEEE802154_HW_TXPOWER) {
 312                 if (!priv->ops->set_txpower)
 313                         goto out;
 314
 315                 priv->phy->set_txpower = mac802154_set_txpower;
 316         }
 317
 318         if (dev->flags & IEEE802154_HW_LBT) {
 319                 if (!priv->ops->set_lbt)
 320                         goto out;
 321
 322                 priv->phy->set_lbt = mac802154_set_lbt;
 323         }
 324
 325         if (dev->flags & IEEE802154_HW_CCA_MODE) {
 326                 if (!priv->ops->set_cca_mode)
 327                         goto out;
 328
 329                 priv->phy->set_cca_mode = mac802154_set_cca_mode;
 330         }
 331
 332         if (dev->flags & IEEE802154_HW_CCA_ED_LEVEL) {
 333                 if (!priv->ops->set_cca_ed_level)
 334                         goto out;
 335
 336                 priv->phy->set_cca_ed_level = mac802154_set_cca_ed_level;
 337         }
 338
 339         if (dev->flags & IEEE802154_HW_CSMA_PARAMS) {
 340                 if (!priv->ops->set_csma_params)
 341                         goto out;
 342
 343                 priv->phy->set_csma_params = mac802154_set_csma_params;
 344         }
 345
 346         if (dev->flags & IEEE802154_HW_FRAME_RETRIES) {
 347                 if (!priv->ops->set_frame_retries)
 348                         goto out;
 349
 350                 priv->phy->set_frame_retries = mac802154_set_frame_retries;
 351         }
 352
 353         priv->dev_workqueue =
 354                 create_singlethread_workqueue(wpan_phy_name(priv->phy));
 355         if (!priv->dev_workqueue) {
 356                 rc = -ENOMEM;
 357                 goto out;
 358         }
 359
 360         wpan_phy_set_dev(priv->phy, priv->hw.parent);
 361
 362         priv->phy->add_iface = mac802154_add_iface;
 363         priv->phy->del_iface = mac802154_del_iface;
 364
 365         rc = wpan_phy_register(priv->phy);
 366         if (rc < 0)
 367                 goto out_wq;
 368
 369         rtnl_lock();
 370
 371         mutex_lock(&priv->slaves_mtx);
 372         priv->running = MAC802154_DEVICE_RUN;
 373         mutex_unlock(&priv->slaves_mtx);
 374
 375         rtnl_unlock();
 376
 377         return 0;
 378
 379 out_wq:
 380         destroy_workqueue(priv->dev_workqueue);
 381 out:
 382         return rc;
 383 }
 384 EXPORT_SYMBOL(ieee802154_register_device);
 385
 386 void ieee802154_unregister_device(struct ieee802154_dev *dev)
 387 {
 388         struct mac802154_priv *priv = mac802154_to_priv(dev);
 389         struct mac802154_sub_if_data *sdata, *next;
 390
 391         flush_workqueue(priv->dev_workqueue);
 392         destroy_workqueue(priv->dev_workqueue);
 393
 394         rtnl_lock();
 395
 396         mutex_lock(&priv->slaves_mtx);
 397         priv->running = MAC802154_DEVICE_STOPPED;
 398         mutex_unlock(&priv->slaves_mtx);
 399
 400         list_for_each_entry_safe(sdata, next, &priv->slaves, list) {
 401                 mutex_lock(&sdata->hw->slaves_mtx);
 402                 list_del(&sdata->list);
 403                 mutex_unlock(&sdata->hw->slaves_mtx);
 404
 405                 unregister_netdevice(sdata->dev);
 406         }
 407
 408         rtnl_unlock();
 409
 410         wpan_phy_unregister(priv->phy);
 411 }
 412 EXPORT_SYMBOL(ieee802154_unregister_device);
 413
 414 MODULE_DESCRIPTION("IEEE 802.15.4 implementation");
 415 MODULE_LICENSE("GPL v2");