drivers/net/ieee802154/atusb.c

   1 /*
   2  * atusb.c - Driver for the ATUSB IEEE 802.15.4 dongle
   3  *
   4  * Written 2013 by Werner Almesberger <werner@almesberger.net>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation, version 2
   9  *
  10  * Based on at86rf230.c and spi_atusb.c.
  11  * at86rf230.c is
  12  * Copyright (C) 2009 Siemens AG
  13  * Written by: Dmitry Eremin-Solenikov <dmitry.baryshkov@siemens.com>
  14  *
  15  * spi_atusb.c is
  16  * Copyright (c) 2011 Richard Sharpe <realrichardsharpe@gmail.com>
  17  * Copyright (c) 2011 Stefan Schmidt <stefan@datenfreihafen.org>
  18  * Copyright (c) 2011 Werner Almesberger <werner@almesberger.net>
  19  *
  20  * USB initialization is
  21  * Copyright (c) 2013 Alexander Aring <alex.aring@gmail.com>
  22  */
  23
  24 #include <linux/kernel.h>
  25 #include <linux/slab.h>
  26 #include <linux/module.h>
  27 #include <linux/jiffies.h>
  28 #include <linux/usb.h>
  29 #include <linux/skbuff.h>
  30
  31 #include <net/cfg802154.h>
  32 #include <net/mac802154.h>
  33
  34 #include "at86rf230.h"
  35 #include "atusb.h"
  36
  37 #define ATUSB_JEDEC_ATMEL       0x1f    /* JEDEC manufacturer ID */
  38
  39 #define ATUSB_NUM_RX_URBS       4       /* allow for a bit of local latency */
  40 #define ATUSB_ALLOC_DELAY_MS    100     /* delay after failed allocation */
  41 #define ATUSB_TX_TIMEOUT_MS     200     /* on the air timeout */
  42
  43 struct atusb {
  44         struct ieee802154_hw *hw;
  45         struct usb_device *usb_dev;
  46         int shutdown;                   /* non-zero if shutting down */
  47         int err;                        /* set by first error */
  48
  49         /* RX variables */
  50         struct delayed_work work;       /* memory allocations */
  51         struct usb_anchor idle_urbs;    /* URBs waiting to be submitted */
  52         struct usb_anchor rx_urbs;      /* URBs waiting for reception */
  53
  54         /* TX variables */
  55         struct usb_ctrlrequest tx_dr;
  56         struct urb *tx_urb;
  57         struct sk_buff *tx_skb;
  58         uint8_t tx_ack_seq;             /* current TX ACK sequence number */
  59 };
  60
  61 /* ----- USB commands without data ----------------------------------------- */
  62
  63 /* To reduce the number of error checks in the code, we record the first error
  64  * in atusb->err and reject all subsequent requests until the error is cleared.
  65  */
  66
  67 static int atusb_control_msg(struct atusb *atusb, unsigned int pipe,
  68                              __u8 request, __u8 requesttype,
  69                              __u16 value, __u16 index,
  70                              void *data, __u16 size, int timeout)
  71 {
  72         struct usb_device *usb_dev = atusb->usb_dev;
  73         int ret;
  74
  75         if (atusb->err)
  76                 return atusb->err;
  77
  78         ret = usb_control_msg(usb_dev, pipe, request, requesttype,
  79                               value, index, data, size, timeout);
  80         if (ret < 0) {
  81                 atusb->err = ret;
  82                 dev_err(&usb_dev->dev,
  83                         "atusb_control_msg: req 0x%02x val 0x%x idx 0x%x, error %d\n",
  84                         request, value, index, ret);
  85         }
  86         return ret;
  87 }
  88
  89 static int atusb_command(struct atusb *atusb, uint8_t cmd, uint8_t arg)
  90 {
  91         struct usb_device *usb_dev = atusb->usb_dev;
  92
  93         dev_dbg(&usb_dev->dev, "atusb_command: cmd = 0x%x\n", cmd);
  94         return atusb_control_msg(atusb, usb_sndctrlpipe(usb_dev, 0),
  95                                  cmd, ATUSB_REQ_TO_DEV, arg, 0, NULL, 0, 1000);
  96 }
  97
  98 static int atusb_write_reg(struct atusb *atusb, uint8_t reg, uint8_t value)
  99 {
 100         struct usb_device *usb_dev = atusb->usb_dev;
 101
 102         dev_dbg(&usb_dev->dev, "atusb_write_reg: 0x%02x <- 0x%02x\n",
 103                 reg, value);
 104         return atusb_control_msg(atusb, usb_sndctrlpipe(usb_dev, 0),
 105                                  ATUSB_REG_WRITE, ATUSB_REQ_TO_DEV,
 106                                  value, reg, NULL, 0, 1000);
 107 }
 108
 109 static int atusb_read_reg(struct atusb *atusb, uint8_t reg)
 110 {
 111         struct usb_device *usb_dev = atusb->usb_dev;
 112         int ret;
 113         uint8_t value;
 114
 115         dev_dbg(&usb_dev->dev, "atusb: reg = 0x%x\n", reg);
 116         ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
 117                                 ATUSB_REG_READ, ATUSB_REQ_FROM_DEV,
 118                                 0, reg, &value, 1, 1000);
 119         return ret >= 0 ? value : ret;
 120 }
 121
 122 static int atusb_write_subreg(struct atusb *atusb, uint8_t reg, uint8_t mask,
 123                               uint8_t shift, uint8_t value)
 124 {
 125         struct usb_device *usb_dev = atusb->usb_dev;
 126         uint8_t orig, tmp;
 127         int ret = 0;
 128
 129         dev_dbg(&usb_dev->dev, "atusb_write_subreg: 0x%02x <- 0x%02x\n",
 130                 reg, value);
 131
 132         orig = atusb_read_reg(atusb, reg);
 133
 134         /* Write the value only into that part of the register which is allowed
 135          * by the mask. All other bits stay as before.
 136          */
 137         tmp = orig & ~mask;
 138         tmp |= (value << shift) & mask;
 139
 140         if (tmp != orig)
 141                 ret = atusb_write_reg(atusb, reg, tmp);
 142
 143         return ret;
 144 }
 145
 146 static int atusb_get_and_clear_error(struct atusb *atusb)
 147 {
 148         int err = atusb->err;
 149
 150         atusb->err = 0;
 151         return err;
 152 }
 153
 154 /* ----- skb allocation ---------------------------------------------------- */
 155
 156 #define MAX_PSDU        127
 157 #define MAX_RX_XFER     (1 + MAX_PSDU + 2 + 1)  /* PHR+PSDU+CRC+LQI */
 158
 159 #define SKB_ATUSB(skb)  (*(struct atusb **)(skb)->cb)
 160
 161 static void atusb_in(struct urb *urb);
 162
 163 static int atusb_submit_rx_urb(struct atusb *atusb, struct urb *urb)
 164 {
 165         struct usb_device *usb_dev = atusb->usb_dev;
 166         struct sk_buff *skb = urb->context;
 167         int ret;
 168
 169         if (!skb) {
 170                 skb = alloc_skb(MAX_RX_XFER, GFP_KERNEL);
 171                 if (!skb) {
 172                         dev_warn_ratelimited(&usb_dev->dev,
 173                                              "atusb_in: can't allocate skb\n");
 174                         return -ENOMEM;
 175                 }
 176                 skb_put(skb, MAX_RX_XFER);
 177                 SKB_ATUSB(skb) = atusb;
 178         }
 179
 180         usb_fill_bulk_urb(urb, usb_dev, usb_rcvbulkpipe(usb_dev, 1),
 181                           skb->data, MAX_RX_XFER, atusb_in, skb);
 182         usb_anchor_urb(urb, &atusb->rx_urbs);
 183
 184         ret = usb_submit_urb(urb, GFP_KERNEL);
 185         if (ret) {
 186                 usb_unanchor_urb(urb);
 187                 kfree_skb(skb);
 188                 urb->context = NULL;
 189         }
 190         return ret;
 191 }
 192
 193 static void atusb_work_urbs(struct work_struct *work)
 194 {
 195         struct atusb *atusb =
 196             container_of(to_delayed_work(work), struct atusb, work);
 197         struct usb_device *usb_dev = atusb->usb_dev;
 198         struct urb *urb;
 199         int ret;
 200
 201         if (atusb->shutdown)
 202                 return;
 203
 204         do {
 205                 urb = usb_get_from_anchor(&atusb->idle_urbs);
 206                 if (!urb)
 207                         return;
 208                 ret = atusb_submit_rx_urb(atusb, urb);
 209         } while (!ret);
 210
 211         usb_anchor_urb(urb, &atusb->idle_urbs);
 212         dev_warn_ratelimited(&usb_dev->dev,
 213                              "atusb_in: can't allocate/submit URB (%d)\n", ret);
 214         schedule_delayed_work(&atusb->work,
 215                               msecs_to_jiffies(ATUSB_ALLOC_DELAY_MS) + 1);
 216 }
 217
 218 /* ----- Asynchronous USB -------------------------------------------------- */
 219
 220 static void atusb_tx_done(struct atusb *atusb, uint8_t seq)
 221 {
 222         struct usb_device *usb_dev = atusb->usb_dev;
 223         uint8_t expect = atusb->tx_ack_seq;
 224
 225         dev_dbg(&usb_dev->dev, "atusb_tx_done (0x%02x/0x%02x)\n", seq, expect);
 226         if (seq == expect) {
 227                 /* TODO check for ifs handling in firmware */
 228                 ieee802154_xmit_complete(atusb->hw, atusb->tx_skb, false);
 229         } else {
 230                 /* TODO I experience this case when atusb has a tx complete
 231                  * irq before probing, we should fix the firmware it's an
 232                  * unlikely case now that seq == expect is then true, but can
 233                  * happen and fail with a tx_skb = NULL;
 234                  */
 235                 ieee802154_wake_queue(atusb->hw);
 236                 if (atusb->tx_skb)
 237                         dev_kfree_skb_irq(atusb->tx_skb);
 238         }
 239 }
 240
 241 static void atusb_in_good(struct urb *urb)
 242 {
 243         struct usb_device *usb_dev = urb->dev;
 244         struct sk_buff *skb = urb->context;
 245         struct atusb *atusb = SKB_ATUSB(skb);
 246         uint8_t len, lqi;
 247
 248         if (!urb->actual_length) {
 249                 dev_dbg(&usb_dev->dev, "atusb_in: zero-sized URB ?\n");
 250                 return;
 251         }
 252
 253         len = *skb->data;
 254
 255         if (urb->actual_length == 1) {
 256                 atusb_tx_done(atusb, len);
 257                 return;
 258         }
 259
 260         if (len + 1 > urb->actual_length - 1) {
 261                 dev_dbg(&usb_dev->dev, "atusb_in: frame len %d+1 > URB %u-1\n",
 262                         len, urb->actual_length);
 263                 return;
 264         }
 265
 266         if (!ieee802154_is_valid_psdu_len(len)) {
 267                 dev_dbg(&usb_dev->dev, "atusb_in: frame corrupted\n");
 268                 return;
 269         }
 270
 271         lqi = skb->data[len + 1];
 272         dev_dbg(&usb_dev->dev, "atusb_in: rx len %d lqi 0x%02x\n", len, lqi);
 273         skb_pull(skb, 1);       /* remove PHR */
 274         skb_trim(skb, len);     /* get payload only */
 275         ieee802154_rx_irqsafe(atusb->hw, skb, lqi);
 276         urb->context = NULL;    /* skb is gone */
 277 }
 278
 279 static void atusb_in(struct urb *urb)
 280 {
 281         struct usb_device *usb_dev = urb->dev;
 282         struct sk_buff *skb = urb->context;
 283         struct atusb *atusb = SKB_ATUSB(skb);
 284
 285         dev_dbg(&usb_dev->dev, "atusb_in: status %d len %d\n",
 286                 urb->status, urb->actual_length);
 287         if (urb->status) {
 288                 if (urb->status == -ENOENT) { /* being killed */
 289                         kfree_skb(skb);
 290                         urb->context = NULL;
 291                         return;
 292                 }
 293                 dev_dbg(&usb_dev->dev, "atusb_in: URB error %d\n", urb->status);
 294         } else {
 295                 atusb_in_good(urb);
 296         }
 297
 298         usb_anchor_urb(urb, &atusb->idle_urbs);
 299         if (!atusb->shutdown)
 300                 schedule_delayed_work(&atusb->work, 0);
 301 }
 302
 303 /* ----- URB allocation/deallocation --------------------------------------- */
 304
 305 static void atusb_free_urbs(struct atusb *atusb)
 306 {
 307         struct urb *urb;
 308
 309         while (1) {
 310                 urb = usb_get_from_anchor(&atusb->idle_urbs);
 311                 if (!urb)
 312                         break;
 313                 kfree_skb(urb->context);
 314                 usb_free_urb(urb);
 315         }
 316 }
 317
 318 static int atusb_alloc_urbs(struct atusb *atusb, int n)
 319 {
 320         struct urb *urb;
 321
 322         while (n) {
 323                 urb = usb_alloc_urb(0, GFP_KERNEL);
 324                 if (!urb) {
 325                         atusb_free_urbs(atusb);
 326                         return -ENOMEM;
 327                 }
 328                 usb_anchor_urb(urb, &atusb->idle_urbs);
 329                 n--;
 330         }
 331         return 0;
 332 }
 333
 334 /* ----- IEEE 802.15.4 interface operations -------------------------------- */
 335
 336 static void atusb_xmit_complete(struct urb *urb)
 337 {
 338         dev_dbg(&urb->dev->dev, "atusb_xmit urb completed");
 339 }
 340
 341 static int atusb_xmit(struct ieee802154_hw *hw, struct sk_buff *skb)
 342 {
 343         struct atusb *atusb = hw->priv;
 344         struct usb_device *usb_dev = atusb->usb_dev;
 345         int ret;
 346
 347         dev_dbg(&usb_dev->dev, "atusb_xmit (%d)\n", skb->len);
 348         atusb->tx_skb = skb;
 349         atusb->tx_ack_seq++;
 350         atusb->tx_dr.wIndex = cpu_to_le16(atusb->tx_ack_seq);
 351         atusb->tx_dr.wLength = cpu_to_le16(skb->len);
 352
 353         usb_fill_control_urb(atusb->tx_urb, usb_dev,
 354                              usb_sndctrlpipe(usb_dev, 0),
 355                              (unsigned char *)&atusb->tx_dr, skb->data,
 356                              skb->len, atusb_xmit_complete, NULL);
 357         ret = usb_submit_urb(atusb->tx_urb, GFP_ATOMIC);
 358         dev_dbg(&usb_dev->dev, "atusb_xmit done (%d)\n", ret);
 359         return ret;
 360 }
 361
 362 static int atusb_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
 363 {
 364         struct atusb *atusb = hw->priv;
 365         int ret;
 366
 367         /* This implicitly sets the CCA (Clear Channel Assessment) mode to 0,
 368          * "Mode 3a, Carrier sense OR energy above threshold".
 369          * We should probably make this configurable. @@@
 370          */
 371         ret = atusb_write_reg(atusb, RG_PHY_CC_CCA, channel);
 372         if (ret < 0)
 373                 return ret;
 374         msleep(1);      /* @@@ ugly synchronization */
 375         return 0;
 376 }
 377
 378 static int atusb_ed(struct ieee802154_hw *hw, u8 *level)
 379 {
 380         BUG_ON(!level);
 381         *level = 0xbe;
 382         return 0;
 383 }
 384
 385 static int atusb_set_hw_addr_filt(struct ieee802154_hw *hw,
 386                                   struct ieee802154_hw_addr_filt *filt,
 387                                   unsigned long changed)
 388 {
 389         struct atusb *atusb = hw->priv;
 390         struct device *dev = &atusb->usb_dev->dev;
 391
 392         if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
 393                 u16 addr = le16_to_cpu(filt->short_addr);
 394
 395                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for saddr\n");
 396                 atusb_write_reg(atusb, RG_SHORT_ADDR_0, addr);
 397                 atusb_write_reg(atusb, RG_SHORT_ADDR_1, addr >> 8);
 398         }
 399
 400         if (changed & IEEE802154_AFILT_PANID_CHANGED) {
 401                 u16 pan = le16_to_cpu(filt->pan_id);
 402
 403                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for pan id\n");
 404                 atusb_write_reg(atusb, RG_PAN_ID_0, pan);
 405                 atusb_write_reg(atusb, RG_PAN_ID_1, pan >> 8);
 406         }
 407
 408         if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
 409                 u8 i, addr[IEEE802154_EXTENDED_ADDR_LEN];
 410
 411                 memcpy(addr, &filt->ieee_addr, IEEE802154_EXTENDED_ADDR_LEN);
 412                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for IEEE addr\n");
 413                 for (i = 0; i < 8; i++)
 414                         atusb_write_reg(atusb, RG_IEEE_ADDR_0 + i, addr[i]);
 415         }
 416
 417         if (changed & IEEE802154_AFILT_PANC_CHANGED) {
 418                 dev_vdbg(dev,
 419                          "atusb_set_hw_addr_filt called for panc change\n");
 420                 if (filt->pan_coord)
 421                         atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 1);
 422                 else
 423                         atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 0);
 424         }
 425
 426         return atusb_get_and_clear_error(atusb);
 427 }
 428
 429 static int atusb_start(struct ieee802154_hw *hw)
 430 {
 431         struct atusb *atusb = hw->priv;
 432         struct usb_device *usb_dev = atusb->usb_dev;
 433         int ret;
 434
 435         dev_dbg(&usb_dev->dev, "atusb_start\n");
 436         schedule_delayed_work(&atusb->work, 0);
 437         atusb_command(atusb, ATUSB_RX_MODE, 1);
 438         ret = atusb_get_and_clear_error(atusb);
 439         if (ret < 0)
 440                 usb_kill_anchored_urbs(&atusb->idle_urbs);
 441         return ret;
 442 }
 443
 444 static void atusb_stop(struct ieee802154_hw *hw)
 445 {
 446         struct atusb *atusb = hw->priv;
 447         struct usb_device *usb_dev = atusb->usb_dev;
 448
 449         dev_dbg(&usb_dev->dev, "atusb_stop\n");
 450         usb_kill_anchored_urbs(&atusb->idle_urbs);
 451         atusb_command(atusb, ATUSB_RX_MODE, 0);
 452         atusb_get_and_clear_error(atusb);
 453 }
 454
 455 #define ATUSB_MAX_TX_POWERS 0xF
 456 static const s32 atusb_powers[ATUSB_MAX_TX_POWERS + 1] = {
 457         300, 280, 230, 180, 130, 70, 0, -100, -200, -300, -400, -500, -700,
 458         -900, -1200, -1700,
 459 };
 460
 461 static int
 462 atusb_set_txpower(struct ieee802154_hw *hw, s32 mbm)
 463 {
 464         struct atusb *atusb = hw->priv;
 465         u32 i;
 466
 467         for (i = 0; i < hw->phy->supported.tx_powers_size; i++) {
 468                 if (hw->phy->supported.tx_powers[i] == mbm)
 469                         return atusb_write_subreg(atusb, SR_TX_PWR_23X, i);
 470         }
 471
 472         return -EINVAL;
 473 }
 474
 475 #define ATUSB_MAX_ED_LEVELS 0xF
 476 static const s32 atusb_ed_levels[ATUSB_MAX_ED_LEVELS + 1] = {
 477         -9100, -8900, -8700, -8500, -8300, -8100, -7900, -7700, -7500, -7300,
 478         -7100, -6900, -6700, -6500, -6300, -6100,
 479 };
 480
 481 static int
 482 atusb_set_cca_mode(struct ieee802154_hw *hw, const struct wpan_phy_cca *cca)
 483 {
 484         struct atusb *atusb = hw->priv;
 485         u8 val;
 486
 487         /* mapping 802.15.4 to driver spec */
 488         switch (cca->mode) {
 489         case NL802154_CCA_ENERGY:
 490                 val = 1;
 491                 break;
 492         case NL802154_CCA_CARRIER:
 493                 val = 2;
 494                 break;
 495         case NL802154_CCA_ENERGY_CARRIER:
 496                 switch (cca->opt) {
 497                 case NL802154_CCA_OPT_ENERGY_CARRIER_AND:
 498                         val = 3;
 499                         break;
 500                 case NL802154_CCA_OPT_ENERGY_CARRIER_OR:
 501                         val = 0;
 502                         break;
 503                 default:
 504                         return -EINVAL;
 505                 }
 506                 break;
 507         default:
 508                 return -EINVAL;
 509         }
 510
 511         return atusb_write_subreg(atusb, SR_CCA_MODE, val);
 512 }
 513
 514 static int
 515 atusb_set_cca_ed_level(struct ieee802154_hw *hw, s32 mbm)
 516 {
 517         struct atusb *atusb = hw->priv;
 518         u32 i;
 519
 520         for (i = 0; i < hw->phy->supported.cca_ed_levels_size; i++) {
 521                 if (hw->phy->supported.cca_ed_levels[i] == mbm)
 522                         return atusb_write_subreg(atusb, SR_CCA_ED_THRES, i);
 523         }
 524
 525         return -EINVAL;
 526 }
 527
 528 static int
 529 atusb_set_csma_params(struct ieee802154_hw *hw, u8 min_be, u8 max_be, u8 retries)
 530 {
 531         struct atusb *atusb = hw->priv;
 532         int ret;
 533
 534         ret = atusb_write_subreg(atusb, SR_MIN_BE, min_be);
 535         if (ret)
 536                 return ret;
 537
 538         ret = atusb_write_subreg(atusb, SR_MAX_BE, max_be);
 539         if (ret)
 540                 return ret;
 541
 542         return atusb_write_subreg(atusb, SR_MAX_CSMA_RETRIES, retries);
 543 }
 544
 545 static int
 546 atusb_set_promiscuous_mode(struct ieee802154_hw *hw, const bool on)
 547 {
 548         struct atusb *atusb = hw->priv;
 549         int ret;
 550
 551         if (on) {
 552                 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 1);
 553                 if (ret < 0)
 554                         return ret;
 555
 556                 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 1);
 557                 if (ret < 0)
 558                         return ret;
 559         } else {
 560                 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 0);
 561                 if (ret < 0)
 562                         return ret;
 563
 564                 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 0);
 565                 if (ret < 0)
 566                         return ret;
 567         }
 568
 569         return 0;
 570 }
 571
 572 static struct ieee802154_ops atusb_ops = {
 573         .owner                  = THIS_MODULE,
 574         .xmit_async             = atusb_xmit,
 575         .ed                     = atusb_ed,
 576         .set_channel            = atusb_channel,
 577         .start                  = atusb_start,
 578         .stop                   = atusb_stop,
 579         .set_hw_addr_filt       = atusb_set_hw_addr_filt,
 580         .set_txpower            = atusb_set_txpower,
 581         .set_cca_mode           = atusb_set_cca_mode,
 582         .set_cca_ed_level       = atusb_set_cca_ed_level,
 583         .set_csma_params        = atusb_set_csma_params,
 584         .set_promiscuous_mode   = atusb_set_promiscuous_mode,
 585 };
 586
 587 /* ----- Firmware and chip version information ----------------------------- */
 588
 589 static int atusb_get_and_show_revision(struct atusb *atusb)
 590 {
 591         struct usb_device *usb_dev = atusb->usb_dev;
 592         unsigned char buffer[3];
 593         int ret;
 594
 595         /* Get a couple of the ATMega Firmware values */
 596         ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
 597                                 ATUSB_ID, ATUSB_REQ_FROM_DEV, 0, 0,
 598                                 buffer, 3, 1000);
 599         if (ret >= 0)
 600                 dev_info(&usb_dev->dev,
 601                          "Firmware: major: %u, minor: %u, hardware type: %u\n",
 602                          buffer[0], buffer[1], buffer[2]);
 603         if (buffer[0] == 0 && buffer[1] < 2) {
 604                 dev_info(&usb_dev->dev,
 605                          "Firmware version (%u.%u) is predates our first public release.",
 606                          buffer[0], buffer[1]);
 607                 dev_info(&usb_dev->dev, "Please update to version 0.2 or newer");
 608         }
 609
 610         return ret;
 611 }
 612
 613 static int atusb_get_and_show_build(struct atusb *atusb)
 614 {
 615         struct usb_device *usb_dev = atusb->usb_dev;
 616         char build[ATUSB_BUILD_SIZE + 1];
 617         int ret;
 618
 619         ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
 620                                 ATUSB_BUILD, ATUSB_REQ_FROM_DEV, 0, 0,
 621                                 build, ATUSB_BUILD_SIZE, 1000);
 622         if (ret >= 0) {
 623                 build[ret] = 0;
 624                 dev_info(&usb_dev->dev, "Firmware: build %s\n", build);
 625         }
 626
 627         return ret;
 628 }
 629
 630 static int atusb_get_and_show_chip(struct atusb *atusb)
 631 {
 632         struct usb_device *usb_dev = atusb->usb_dev;
 633         uint8_t man_id_0, man_id_1, part_num, version_num;
 634         const char *chip;
 635
 636         man_id_0 = atusb_read_reg(atusb, RG_MAN_ID_0);
 637         man_id_1 = atusb_read_reg(atusb, RG_MAN_ID_1);
 638         part_num = atusb_read_reg(atusb, RG_PART_NUM);
 639         version_num = atusb_read_reg(atusb, RG_VERSION_NUM);
 640
 641         if (atusb->err)
 642                 return atusb->err;
 643
 644         if ((man_id_1 << 8 | man_id_0) != ATUSB_JEDEC_ATMEL) {
 645                 dev_err(&usb_dev->dev,
 646                         "non-Atmel transceiver xxxx%02x%02x\n",
 647                         man_id_1, man_id_0);
 648                 goto fail;
 649         }
 650
 651         switch (part_num) {
 652         case 2:
 653                 chip = "AT86RF230";
 654                 break;
 655         case 3:
 656                 chip = "AT86RF231";
 657                 break;
 658         default:
 659                 dev_err(&usb_dev->dev,
 660                         "unexpected transceiver, part 0x%02x version 0x%02x\n",
 661                         part_num, version_num);
 662                 goto fail;
 663         }
 664
 665         dev_info(&usb_dev->dev, "ATUSB: %s version %d\n", chip, version_num);
 666
 667         return 0;
 668
 669 fail:
 670         atusb->err = -ENODEV;
 671         return -ENODEV;
 672 }
 673
 674 /* ----- Setup ------------------------------------------------------------- */
 675
 676 static int atusb_probe(struct usb_interface *interface,
 677                        const struct usb_device_id *id)
 678 {
 679         struct usb_device *usb_dev = interface_to_usbdev(interface);
 680         struct ieee802154_hw *hw;
 681         struct atusb *atusb = NULL;
 682         int ret = -ENOMEM;
 683
 684         hw = ieee802154_alloc_hw(sizeof(struct atusb), &atusb_ops);
 685         if (!hw)
 686                 return -ENOMEM;
 687
 688         atusb = hw->priv;
 689         atusb->hw = hw;
 690         atusb->usb_dev = usb_get_dev(usb_dev);
 691         usb_set_intfdata(interface, atusb);
 692
 693         atusb->shutdown = 0;
 694         atusb->err = 0;
 695         INIT_DELAYED_WORK(&atusb->work, atusb_work_urbs);
 696         init_usb_anchor(&atusb->idle_urbs);
 697         init_usb_anchor(&atusb->rx_urbs);
 698
 699         if (atusb_alloc_urbs(atusb, ATUSB_NUM_RX_URBS))
 700                 goto fail;
 701
 702         atusb->tx_dr.bRequestType = ATUSB_REQ_TO_DEV;
 703         atusb->tx_dr.bRequest = ATUSB_TX;
 704         atusb->tx_dr.wValue = cpu_to_le16(0);
 705
 706         atusb->tx_urb = usb_alloc_urb(0, GFP_ATOMIC);
 707         if (!atusb->tx_urb)
 708                 goto fail;
 709
 710         hw->parent = &usb_dev->dev;
 711         hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_AFILT |
 712                     IEEE802154_HW_PROMISCUOUS | IEEE802154_HW_CSMA_PARAMS;
 713
 714         hw->phy->flags = WPAN_PHY_FLAG_TXPOWER | WPAN_PHY_FLAG_CCA_ED_LEVEL |
 715                          WPAN_PHY_FLAG_CCA_MODE;
 716
 717         hw->phy->supported.cca_modes = BIT(NL802154_CCA_ENERGY) |
 718                 BIT(NL802154_CCA_CARRIER) | BIT(NL802154_CCA_ENERGY_CARRIER);
 719         hw->phy->supported.cca_opts = BIT(NL802154_CCA_OPT_ENERGY_CARRIER_AND) |
 720                 BIT(NL802154_CCA_OPT_ENERGY_CARRIER_OR);
 721
 722         hw->phy->supported.cca_ed_levels = atusb_ed_levels;
 723         hw->phy->supported.cca_ed_levels_size = ARRAY_SIZE(atusb_ed_levels);
 724
 725         hw->phy->cca.mode = NL802154_CCA_ENERGY;
 726
 727         hw->phy->current_page = 0;
 728         hw->phy->current_channel = 11;  /* reset default */
 729         hw->phy->supported.channels[0] = 0x7FFF800;
 730         hw->phy->supported.tx_powers = atusb_powers;
 731         hw->phy->supported.tx_powers_size = ARRAY_SIZE(atusb_powers);
 732         hw->phy->transmit_power = hw->phy->supported.tx_powers[0];
 733         ieee802154_random_extended_addr(&hw->phy->perm_extended_addr);
 734         hw->phy->cca_ed_level = hw->phy->supported.cca_ed_levels[7];
 735
 736         atusb_command(atusb, ATUSB_RF_RESET, 0);
 737         atusb_get_and_show_chip(atusb);
 738         atusb_get_and_show_revision(atusb);
 739         atusb_get_and_show_build(atusb);
 740         ret = atusb_get_and_clear_error(atusb);
 741         if (ret) {
 742                 dev_err(&atusb->usb_dev->dev,
 743                         "%s: initialization failed, error = %d\n",
 744                         __func__, ret);
 745                 goto fail;
 746         }
 747
 748         ret = ieee802154_register_hw(hw);
 749         if (ret)
 750                 goto fail;
 751
 752         /* If we just powered on, we're now in P_ON and need to enter TRX_OFF
 753          * explicitly. Any resets after that will send us straight to TRX_OFF,
 754          * making the command below redundant.
 755          */
 756         atusb_write_reg(atusb, RG_TRX_STATE, STATE_FORCE_TRX_OFF);
 757         msleep(1);      /* reset => TRX_OFF, tTR13 = 37 us */
 758
 759 #if 0
 760         /* Calculating the maximum time available to empty the frame buffer
 761          * on reception:
 762          *
 763          * According to [1], the inter-frame gap is
 764          * R * 20 * 16 us + 128 us
 765          * where R is a random number from 0 to 7. Furthermore, we have 20 bit
 766          * times (80 us at 250 kbps) of SHR of the next frame before the
 767          * transceiver begins storing data in the frame buffer.
 768          *
 769          * This yields a minimum time of 208 us between the last data of a
 770          * frame and the first data of the next frame. This time is further
 771          * reduced by interrupt latency in the atusb firmware.
 772          *
 773          * atusb currently needs about 500 us to retrieve a maximum-sized
 774          * frame. We therefore have to allow reception of a new frame to begin
 775          * while we retrieve the previous frame.
 776          *
 777          * [1] "JN-AN-1035 Calculating data rates in an IEEE 802.15.4-based
 778          *      network", Jennic 2006.
 779          *     http://www.jennic.com/download_file.php?supportFile=JN-AN-1035%20Calculating%20802-15-4%20Data%20Rates-1v0.pdf
 780          */
 781
 782         atusb_write_subreg(atusb, SR_RX_SAFE_MODE, 1);
 783 #endif
 784         atusb_write_reg(atusb, RG_IRQ_MASK, 0xff);
 785
 786         ret = atusb_get_and_clear_error(atusb);
 787         if (!ret)
 788                 return 0;
 789
 790         dev_err(&atusb->usb_dev->dev,
 791                 "%s: setup failed, error = %d\n",
 792                 __func__, ret);
 793
 794         ieee802154_unregister_hw(hw);
 795 fail:
 796         atusb_free_urbs(atusb);
 797         usb_kill_urb(atusb->tx_urb);
 798         usb_free_urb(atusb->tx_urb);
 799         usb_put_dev(usb_dev);
 800         ieee802154_free_hw(hw);
 801         return ret;
 802 }
 803
 804 static void atusb_disconnect(struct usb_interface *interface)
 805 {
 806         struct atusb *atusb = usb_get_intfdata(interface);
 807
 808         dev_dbg(&atusb->usb_dev->dev, "atusb_disconnect\n");
 809
 810         atusb->shutdown = 1;
 811         cancel_delayed_work_sync(&atusb->work);
 812
 813         usb_kill_anchored_urbs(&atusb->rx_urbs);
 814         atusb_free_urbs(atusb);
 815         usb_kill_urb(atusb->tx_urb);
 816         usb_free_urb(atusb->tx_urb);
 817
 818         ieee802154_unregister_hw(atusb->hw);
 819
 820         ieee802154_free_hw(atusb->hw);
 821
 822         usb_set_intfdata(interface, NULL);
 823         usb_put_dev(atusb->usb_dev);
 824
 825         pr_debug("atusb_disconnect done\n");
 826 }
 827
 828 /* The devices we work with */
 829 static const struct usb_device_id atusb_device_table[] = {
 830         {
 831                 .match_flags            = USB_DEVICE_ID_MATCH_DEVICE |
 832                                           USB_DEVICE_ID_MATCH_INT_INFO,
 833                 .idVendor               = ATUSB_VENDOR_ID,
 834                 .idProduct              = ATUSB_PRODUCT_ID,
 835                 .bInterfaceClass        = USB_CLASS_VENDOR_SPEC
 836         },
 837         /* end with null element */
 838         {}
 839 };
 840 MODULE_DEVICE_TABLE(usb, atusb_device_table);
 841
 842 static struct usb_driver atusb_driver = {
 843         .name           = "atusb",
 844         .probe          = atusb_probe,
 845         .disconnect     = atusb_disconnect,
 846         .id_table       = atusb_device_table,
 847 };
 848 module_usb_driver(atusb_driver);
 849
 850 MODULE_AUTHOR("Alexander Aring <alex.aring@gmail.com>");
 851 MODULE_AUTHOR("Richard Sharpe <realrichardsharpe@gmail.com>");
 852 MODULE_AUTHOR("Stefan Schmidt <stefan@datenfreihafen.org>");
 853 MODULE_AUTHOR("Werner Almesberger <werner@almesberger.net>");
 854 MODULE_DESCRIPTION("ATUSB IEEE 802.15.4 Driver");
 855 MODULE_LICENSE("GPL");