kernel/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 *buffer;
 114         uint8_t value;
 115
 116         buffer = kmalloc(1, GFP_KERNEL);
 117         if (!buffer)
 118                 return -ENOMEM;
 119
 120         dev_dbg(&usb_dev->dev, "atusb: reg = 0x%x\n", reg);
 121         ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
 122                                 ATUSB_REG_READ, ATUSB_REQ_FROM_DEV,
 123                                 0, reg, buffer, 1, 1000);
 124
 125         if (ret >= 0) {
 126                 value = buffer[0];
 127                 kfree(buffer);
 128                 return value;
 129         } else {
 130                 kfree(buffer);
 131                 return ret;
 132         }
 133 }
 134
 135 static int atusb_write_subreg(struct atusb *atusb, uint8_t reg, uint8_t mask,
 136                               uint8_t shift, uint8_t value)
 137 {
 138         struct usb_device *usb_dev = atusb->usb_dev;
 139         uint8_t orig, tmp;
 140         int ret = 0;
 141
 142         dev_dbg(&usb_dev->dev, "atusb_write_subreg: 0x%02x <- 0x%02x\n",
 143                 reg, value);
 144
 145         orig = atusb_read_reg(atusb, reg);
 146
 147         /* Write the value only into that part of the register which is allowed
 148          * by the mask. All other bits stay as before.
 149          */
 150         tmp = orig & ~mask;
 151         tmp |= (value << shift) & mask;
 152
 153         if (tmp != orig)
 154                 ret = atusb_write_reg(atusb, reg, tmp);
 155
 156         return ret;
 157 }
 158
 159 static int atusb_get_and_clear_error(struct atusb *atusb)
 160 {
 161         int err = atusb->err;
 162
 163         atusb->err = 0;
 164         return err;
 165 }
 166
 167 /* ----- skb allocation ---------------------------------------------------- */
 168
 169 #define MAX_PSDU        127
 170 #define MAX_RX_XFER     (1 + MAX_PSDU + 2 + 1)  /* PHR+PSDU+CRC+LQI */
 171
 172 #define SKB_ATUSB(skb)  (*(struct atusb **)(skb)->cb)
 173
 174 static void atusb_in(struct urb *urb);
 175
 176 static int atusb_submit_rx_urb(struct atusb *atusb, struct urb *urb)
 177 {
 178         struct usb_device *usb_dev = atusb->usb_dev;
 179         struct sk_buff *skb = urb->context;
 180         int ret;
 181
 182         if (!skb) {
 183                 skb = alloc_skb(MAX_RX_XFER, GFP_KERNEL);
 184                 if (!skb) {
 185                         dev_warn_ratelimited(&usb_dev->dev,
 186                                              "atusb_in: can't allocate skb\n");
 187                         return -ENOMEM;
 188                 }
 189                 skb_put(skb, MAX_RX_XFER);
 190                 SKB_ATUSB(skb) = atusb;
 191         }
 192
 193         usb_fill_bulk_urb(urb, usb_dev, usb_rcvbulkpipe(usb_dev, 1),
 194                           skb->data, MAX_RX_XFER, atusb_in, skb);
 195         usb_anchor_urb(urb, &atusb->rx_urbs);
 196
 197         ret = usb_submit_urb(urb, GFP_KERNEL);
 198         if (ret) {
 199                 usb_unanchor_urb(urb);
 200                 kfree_skb(skb);
 201                 urb->context = NULL;
 202         }
 203         return ret;
 204 }
 205
 206 static void atusb_work_urbs(struct work_struct *work)
 207 {
 208         struct atusb *atusb =
 209             container_of(to_delayed_work(work), struct atusb, work);
 210         struct usb_device *usb_dev = atusb->usb_dev;
 211         struct urb *urb;
 212         int ret;
 213
 214         if (atusb->shutdown)
 215                 return;
 216
 217         do {
 218                 urb = usb_get_from_anchor(&atusb->idle_urbs);
 219                 if (!urb)
 220                         return;
 221                 ret = atusb_submit_rx_urb(atusb, urb);
 222         } while (!ret);
 223
 224         usb_anchor_urb(urb, &atusb->idle_urbs);
 225         dev_warn_ratelimited(&usb_dev->dev,
 226                              "atusb_in: can't allocate/submit URB (%d)\n", ret);
 227         schedule_delayed_work(&atusb->work,
 228                               msecs_to_jiffies(ATUSB_ALLOC_DELAY_MS) + 1);
 229 }
 230
 231 /* ----- Asynchronous USB -------------------------------------------------- */
 232
 233 static void atusb_tx_done(struct atusb *atusb, uint8_t seq)
 234 {
 235         struct usb_device *usb_dev = atusb->usb_dev;
 236         uint8_t expect = atusb->tx_ack_seq;
 237
 238         dev_dbg(&usb_dev->dev, "atusb_tx_done (0x%02x/0x%02x)\n", seq, expect);
 239         if (seq == expect) {
 240                 /* TODO check for ifs handling in firmware */
 241                 ieee802154_xmit_complete(atusb->hw, atusb->tx_skb, false);
 242         } else {
 243                 /* TODO I experience this case when atusb has a tx complete
 244                  * irq before probing, we should fix the firmware it's an
 245                  * unlikely case now that seq == expect is then true, but can
 246                  * happen and fail with a tx_skb = NULL;
 247                  */
 248                 ieee802154_wake_queue(atusb->hw);
 249                 if (atusb->tx_skb)
 250                         dev_kfree_skb_irq(atusb->tx_skb);
 251         }
 252 }
 253
 254 static void atusb_in_good(struct urb *urb)
 255 {
 256         struct usb_device *usb_dev = urb->dev;
 257         struct sk_buff *skb = urb->context;
 258         struct atusb *atusb = SKB_ATUSB(skb);
 259         uint8_t len, lqi;
 260
 261         if (!urb->actual_length) {
 262                 dev_dbg(&usb_dev->dev, "atusb_in: zero-sized URB ?\n");
 263                 return;
 264         }
 265
 266         len = *skb->data;
 267
 268         if (urb->actual_length == 1) {
 269                 atusb_tx_done(atusb, len);
 270                 return;
 271         }
 272
 273         if (len + 1 > urb->actual_length - 1) {
 274                 dev_dbg(&usb_dev->dev, "atusb_in: frame len %d+1 > URB %u-1\n",
 275                         len, urb->actual_length);
 276                 return;
 277         }
 278
 279         if (!ieee802154_is_valid_psdu_len(len)) {
 280                 dev_dbg(&usb_dev->dev, "atusb_in: frame corrupted\n");
 281                 return;
 282         }
 283
 284         lqi = skb->data[len + 1];
 285         dev_dbg(&usb_dev->dev, "atusb_in: rx len %d lqi 0x%02x\n", len, lqi);
 286         skb_pull(skb, 1);       /* remove PHR */
 287         skb_trim(skb, len);     /* get payload only */
 288         ieee802154_rx_irqsafe(atusb->hw, skb, lqi);
 289         urb->context = NULL;    /* skb is gone */
 290 }
 291
 292 static void atusb_in(struct urb *urb)
 293 {
 294         struct usb_device *usb_dev = urb->dev;
 295         struct sk_buff *skb = urb->context;
 296         struct atusb *atusb = SKB_ATUSB(skb);
 297
 298         dev_dbg(&usb_dev->dev, "atusb_in: status %d len %d\n",
 299                 urb->status, urb->actual_length);
 300         if (urb->status) {
 301                 if (urb->status == -ENOENT) { /* being killed */
 302                         kfree_skb(skb);
 303                         urb->context = NULL;
 304                         return;
 305                 }
 306                 dev_dbg(&usb_dev->dev, "atusb_in: URB error %d\n", urb->status);
 307         } else {
 308                 atusb_in_good(urb);
 309         }
 310
 311         usb_anchor_urb(urb, &atusb->idle_urbs);
 312         if (!atusb->shutdown)
 313                 schedule_delayed_work(&atusb->work, 0);
 314 }
 315
 316 /* ----- URB allocation/deallocation --------------------------------------- */
 317
 318 static void atusb_free_urbs(struct atusb *atusb)
 319 {
 320         struct urb *urb;
 321
 322         while (1) {
 323                 urb = usb_get_from_anchor(&atusb->idle_urbs);
 324                 if (!urb)
 325                         break;
 326                 if (urb->context)
 327                         kfree_skb(urb->context);
 328                 usb_free_urb(urb);
 329         }
 330 }
 331
 332 static int atusb_alloc_urbs(struct atusb *atusb, int n)
 333 {
 334         struct urb *urb;
 335
 336         while (n) {
 337                 urb = usb_alloc_urb(0, GFP_KERNEL);
 338                 if (!urb) {
 339                         atusb_free_urbs(atusb);
 340                         return -ENOMEM;
 341                 }
 342                 usb_anchor_urb(urb, &atusb->idle_urbs);
 343                 n--;
 344         }
 345         return 0;
 346 }
 347
 348 /* ----- IEEE 802.15.4 interface operations -------------------------------- */
 349
 350 static void atusb_xmit_complete(struct urb *urb)
 351 {
 352         dev_dbg(&urb->dev->dev, "atusb_xmit urb completed");
 353 }
 354
 355 static int atusb_xmit(struct ieee802154_hw *hw, struct sk_buff *skb)
 356 {
 357         struct atusb *atusb = hw->priv;
 358         struct usb_device *usb_dev = atusb->usb_dev;
 359         int ret;
 360
 361         dev_dbg(&usb_dev->dev, "atusb_xmit (%d)\n", skb->len);
 362         atusb->tx_skb = skb;
 363         atusb->tx_ack_seq++;
 364         atusb->tx_dr.wIndex = cpu_to_le16(atusb->tx_ack_seq);
 365         atusb->tx_dr.wLength = cpu_to_le16(skb->len);
 366
 367         usb_fill_control_urb(atusb->tx_urb, usb_dev,
 368                              usb_sndctrlpipe(usb_dev, 0),
 369                              (unsigned char *)&atusb->tx_dr, skb->data,
 370                              skb->len, atusb_xmit_complete, NULL);
 371         ret = usb_submit_urb(atusb->tx_urb, GFP_ATOMIC);
 372         dev_dbg(&usb_dev->dev, "atusb_xmit done (%d)\n", ret);
 373         return ret;
 374 }
 375
 376 static int atusb_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
 377 {
 378         struct atusb *atusb = hw->priv;
 379         int ret;
 380
 381         /* This implicitly sets the CCA (Clear Channel Assessment) mode to 0,
 382          * "Mode 3a, Carrier sense OR energy above threshold".
 383          * We should probably make this configurable. @@@
 384          */
 385         ret = atusb_write_reg(atusb, RG_PHY_CC_CCA, channel);
 386         if (ret < 0)
 387                 return ret;
 388         msleep(1);      /* @@@ ugly synchronization */
 389         return 0;
 390 }
 391
 392 static int atusb_ed(struct ieee802154_hw *hw, u8 *level)
 393 {
 394         BUG_ON(!level);
 395         *level = 0xbe;
 396         return 0;
 397 }
 398
 399 static int atusb_set_hw_addr_filt(struct ieee802154_hw *hw,
 400                                   struct ieee802154_hw_addr_filt *filt,
 401                                   unsigned long changed)
 402 {
 403         struct atusb *atusb = hw->priv;
 404         struct device *dev = &atusb->usb_dev->dev;
 405
 406         if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
 407                 u16 addr = le16_to_cpu(filt->short_addr);
 408
 409                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for saddr\n");
 410                 atusb_write_reg(atusb, RG_SHORT_ADDR_0, addr);
 411                 atusb_write_reg(atusb, RG_SHORT_ADDR_1, addr >> 8);
 412         }
 413
 414         if (changed & IEEE802154_AFILT_PANID_CHANGED) {
 415                 u16 pan = le16_to_cpu(filt->pan_id);
 416
 417                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for pan id\n");
 418                 atusb_write_reg(atusb, RG_PAN_ID_0, pan);
 419                 atusb_write_reg(atusb, RG_PAN_ID_1, pan >> 8);
 420         }
 421
 422         if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
 423                 u8 i, addr[IEEE802154_EXTENDED_ADDR_LEN];
 424
 425                 memcpy(addr, &filt->ieee_addr, IEEE802154_EXTENDED_ADDR_LEN);
 426                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for IEEE addr\n");
 427                 for (i = 0; i < 8; i++)
 428                         atusb_write_reg(atusb, RG_IEEE_ADDR_0 + i, addr[i]);
 429         }
 430
 431         if (changed & IEEE802154_AFILT_PANC_CHANGED) {
 432                 dev_vdbg(dev,
 433                          "atusb_set_hw_addr_filt called for panc change\n");
 434                 if (filt->pan_coord)
 435                         atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 1);
 436                 else
 437                         atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 0);
 438         }
 439
 440         return atusb_get_and_clear_error(atusb);
 441 }
 442
 443 static int atusb_start(struct ieee802154_hw *hw)
 444 {
 445         struct atusb *atusb = hw->priv;
 446         struct usb_device *usb_dev = atusb->usb_dev;
 447         int ret;
 448
 449         dev_dbg(&usb_dev->dev, "atusb_start\n");
 450         schedule_delayed_work(&atusb->work, 0);
 451         atusb_command(atusb, ATUSB_RX_MODE, 1);
 452         ret = atusb_get_and_clear_error(atusb);
 453         if (ret < 0)
 454                 usb_kill_anchored_urbs(&atusb->idle_urbs);
 455         return ret;
 456 }
 457
 458 static void atusb_stop(struct ieee802154_hw *hw)
 459 {
 460         struct atusb *atusb = hw->priv;
 461         struct usb_device *usb_dev = atusb->usb_dev;
 462
 463         dev_dbg(&usb_dev->dev, "atusb_stop\n");
 464         usb_kill_anchored_urbs(&atusb->idle_urbs);
 465         atusb_command(atusb, ATUSB_RX_MODE, 0);
 466         atusb_get_and_clear_error(atusb);
 467 }
 468
 469 #define ATUSB_MAX_TX_POWERS 0xF
 470 static const s32 atusb_powers[ATUSB_MAX_TX_POWERS + 1] = {
 471         300, 280, 230, 180, 130, 70, 0, -100, -200, -300, -400, -500, -700,
 472         -900, -1200, -1700,
 473 };
 474
 475 static int
 476 atusb_set_txpower(struct ieee802154_hw *hw, s32 mbm)
 477 {
 478         struct atusb *atusb = hw->priv;
 479         u32 i;
 480
 481         for (i = 0; i < hw->phy->supported.tx_powers_size; i++) {
 482                 if (hw->phy->supported.tx_powers[i] == mbm)
 483                         return atusb_write_subreg(atusb, SR_TX_PWR_23X, i);
 484         }
 485
 486         return -EINVAL;
 487 }
 488
 489 static int
 490 atusb_set_promiscuous_mode(struct ieee802154_hw *hw, const bool on)
 491 {
 492         struct atusb *atusb = hw->priv;
 493         int ret;
 494
 495         if (on) {
 496                 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 1);
 497                 if (ret < 0)
 498                         return ret;
 499
 500                 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 1);
 501                 if (ret < 0)
 502                         return ret;
 503         } else {
 504                 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 0);
 505                 if (ret < 0)
 506                         return ret;
 507
 508                 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 0);
 509                 if (ret < 0)
 510                         return ret;
 511         }
 512
 513         return 0;
 514 }
 515
 516 static struct ieee802154_ops atusb_ops = {
 517         .owner                  = THIS_MODULE,
 518         .xmit_async             = atusb_xmit,
 519         .ed                     = atusb_ed,
 520         .set_channel            = atusb_channel,
 521         .start                  = atusb_start,
 522         .stop                   = atusb_stop,
 523         .set_hw_addr_filt       = atusb_set_hw_addr_filt,
 524         .set_txpower            = atusb_set_txpower,
 525         .set_promiscuous_mode   = atusb_set_promiscuous_mode,
 526 };
 527
 528 /* ----- Firmware and chip version information ----------------------------- */
 529
 530 static int atusb_get_and_show_revision(struct atusb *atusb)
 531 {
 532         struct usb_device *usb_dev = atusb->usb_dev;
 533         unsigned char *buffer;
 534         int ret;
 535
 536         buffer = kmalloc(3, GFP_KERNEL);
 537         if (!buffer)
 538                 return -ENOMEM;
 539
 540         /* Get a couple of the ATMega Firmware values */
 541         ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
 542                                 ATUSB_ID, ATUSB_REQ_FROM_DEV, 0, 0,
 543                                 buffer, 3, 1000);
 544         if (ret >= 0)
 545                 dev_info(&usb_dev->dev,
 546                          "Firmware: major: %u, minor: %u, hardware type: %u\n",
 547                          buffer[0], buffer[1], buffer[2]);
 548         if (buffer[0] == 0 && buffer[1] < 2) {
 549                 dev_info(&usb_dev->dev,
 550                          "Firmware version (%u.%u) is predates our first public release.",
 551                          buffer[0], buffer[1]);
 552                 dev_info(&usb_dev->dev, "Please update to version 0.2 or newer");
 553         }
 554
 555         kfree(buffer);
 556         return ret;
 557 }
 558
 559 static int atusb_get_and_show_build(struct atusb *atusb)
 560 {
 561         struct usb_device *usb_dev = atusb->usb_dev;
 562         char *build;
 563         int ret;
 564
 565         build = kmalloc(ATUSB_BUILD_SIZE + 1, GFP_KERNEL);
 566         if (!build)
 567                 return -ENOMEM;
 568
 569         ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
 570                                 ATUSB_BUILD, ATUSB_REQ_FROM_DEV, 0, 0,
 571                                 build, ATUSB_BUILD_SIZE, 1000);
 572         if (ret >= 0) {
 573                 build[ret] = 0;
 574                 dev_info(&usb_dev->dev, "Firmware: build %s\n", build);
 575         }
 576
 577         kfree(build);
 578         return ret;
 579 }
 580
 581 static int atusb_get_and_show_chip(struct atusb *atusb)
 582 {
 583         struct usb_device *usb_dev = atusb->usb_dev;
 584         uint8_t man_id_0, man_id_1, part_num, version_num;
 585         const char *chip;
 586
 587         man_id_0 = atusb_read_reg(atusb, RG_MAN_ID_0);
 588         man_id_1 = atusb_read_reg(atusb, RG_MAN_ID_1);
 589         part_num = atusb_read_reg(atusb, RG_PART_NUM);
 590         version_num = atusb_read_reg(atusb, RG_VERSION_NUM);
 591
 592         if (atusb->err)
 593                 return atusb->err;
 594
 595         if ((man_id_1 << 8 | man_id_0) != ATUSB_JEDEC_ATMEL) {
 596                 dev_err(&usb_dev->dev,
 597                         "non-Atmel transceiver xxxx%02x%02x\n",
 598                         man_id_1, man_id_0);
 599                 goto fail;
 600         }
 601
 602         switch (part_num) {
 603         case 2:
 604                 chip = "AT86RF230";
 605                 break;
 606         case 3:
 607                 chip = "AT86RF231";
 608                 break;
 609         default:
 610                 dev_err(&usb_dev->dev,
 611                         "unexpected transceiver, part 0x%02x version 0x%02x\n",
 612                         part_num, version_num);
 613                 goto fail;
 614         }
 615
 616         dev_info(&usb_dev->dev, "ATUSB: %s version %d\n", chip, version_num);
 617
 618         return 0;
 619
 620 fail:
 621         atusb->err = -ENODEV;
 622         return -ENODEV;
 623 }
 624
 625 /* ----- Setup ------------------------------------------------------------- */
 626
 627 static int atusb_probe(struct usb_interface *interface,
 628                        const struct usb_device_id *id)
 629 {
 630         struct usb_device *usb_dev = interface_to_usbdev(interface);
 631         struct ieee802154_hw *hw;
 632         struct atusb *atusb = NULL;
 633         int ret = -ENOMEM;
 634
 635         hw = ieee802154_alloc_hw(sizeof(struct atusb), &atusb_ops);
 636         if (!hw)
 637                 return -ENOMEM;
 638
 639         atusb = hw->priv;
 640         atusb->hw = hw;
 641         atusb->usb_dev = usb_get_dev(usb_dev);
 642         usb_set_intfdata(interface, atusb);
 643
 644         atusb->shutdown = 0;
 645         atusb->err = 0;
 646         INIT_DELAYED_WORK(&atusb->work, atusb_work_urbs);
 647         init_usb_anchor(&atusb->idle_urbs);
 648         init_usb_anchor(&atusb->rx_urbs);
 649
 650         if (atusb_alloc_urbs(atusb, ATUSB_NUM_RX_URBS))
 651                 goto fail;
 652
 653         atusb->tx_dr.bRequestType = ATUSB_REQ_TO_DEV;
 654         atusb->tx_dr.bRequest = ATUSB_TX;
 655         atusb->tx_dr.wValue = cpu_to_le16(0);
 656
 657         atusb->tx_urb = usb_alloc_urb(0, GFP_ATOMIC);
 658         if (!atusb->tx_urb)
 659                 goto fail;
 660
 661         hw->parent = &usb_dev->dev;
 662         hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_AFILT |
 663                     IEEE802154_HW_PROMISCUOUS;
 664
 665         hw->phy->flags = WPAN_PHY_FLAG_TXPOWER;
 666
 667         hw->phy->current_page = 0;
 668         hw->phy->current_channel = 11;  /* reset default */
 669         hw->phy->supported.channels[0] = 0x7FFF800;
 670         hw->phy->supported.tx_powers = atusb_powers;
 671         hw->phy->supported.tx_powers_size = ARRAY_SIZE(atusb_powers);
 672         hw->phy->transmit_power = hw->phy->supported.tx_powers[0];
 673         ieee802154_random_extended_addr(&hw->phy->perm_extended_addr);
 674
 675         atusb_command(atusb, ATUSB_RF_RESET, 0);
 676         atusb_get_and_show_chip(atusb);
 677         atusb_get_and_show_revision(atusb);
 678         atusb_get_and_show_build(atusb);
 679         ret = atusb_get_and_clear_error(atusb);
 680         if (ret) {
 681                 dev_err(&atusb->usb_dev->dev,
 682                         "%s: initialization failed, error = %d\n",
 683                         __func__, ret);
 684                 goto fail;
 685         }
 686
 687         ret = ieee802154_register_hw(hw);
 688         if (ret)
 689                 goto fail;
 690
 691         /* If we just powered on, we're now in P_ON and need to enter TRX_OFF
 692          * explicitly. Any resets after that will send us straight to TRX_OFF,
 693          * making the command below redundant.
 694          */
 695         atusb_write_reg(atusb, RG_TRX_STATE, STATE_FORCE_TRX_OFF);
 696         msleep(1);      /* reset => TRX_OFF, tTR13 = 37 us */
 697
 698 #if 0
 699         /* Calculating the maximum time available to empty the frame buffer
 700          * on reception:
 701          *
 702          * According to [1], the inter-frame gap is
 703          * R * 20 * 16 us + 128 us
 704          * where R is a random number from 0 to 7. Furthermore, we have 20 bit
 705          * times (80 us at 250 kbps) of SHR of the next frame before the
 706          * transceiver begins storing data in the frame buffer.
 707          *
 708          * This yields a minimum time of 208 us between the last data of a
 709          * frame and the first data of the next frame. This time is further
 710          * reduced by interrupt latency in the atusb firmware.
 711          *
 712          * atusb currently needs about 500 us to retrieve a maximum-sized
 713          * frame. We therefore have to allow reception of a new frame to begin
 714          * while we retrieve the previous frame.
 715          *
 716          * [1] "JN-AN-1035 Calculating data rates in an IEEE 802.15.4-based
 717          *      network", Jennic 2006.
 718          *     http://www.jennic.com/download_file.php?supportFile=JN-AN-1035%20Calculating%20802-15-4%20Data%20Rates-1v0.pdf
 719          */
 720
 721         atusb_write_subreg(atusb, SR_RX_SAFE_MODE, 1);
 722 #endif
 723         atusb_write_reg(atusb, RG_IRQ_MASK, 0xff);
 724
 725         ret = atusb_get_and_clear_error(atusb);
 726         if (!ret)
 727                 return 0;
 728
 729         dev_err(&atusb->usb_dev->dev,
 730                 "%s: setup failed, error = %d\n",
 731                 __func__, ret);
 732
 733         ieee802154_unregister_hw(hw);
 734 fail:
 735         atusb_free_urbs(atusb);
 736         usb_kill_urb(atusb->tx_urb);
 737         usb_free_urb(atusb->tx_urb);
 738         usb_put_dev(usb_dev);
 739         ieee802154_free_hw(hw);
 740         return ret;
 741 }
 742
 743 static void atusb_disconnect(struct usb_interface *interface)
 744 {
 745         struct atusb *atusb = usb_get_intfdata(interface);
 746
 747         dev_dbg(&atusb->usb_dev->dev, "atusb_disconnect\n");
 748
 749         atusb->shutdown = 1;
 750         cancel_delayed_work_sync(&atusb->work);
 751
 752         usb_kill_anchored_urbs(&atusb->rx_urbs);
 753         atusb_free_urbs(atusb);
 754         usb_kill_urb(atusb->tx_urb);
 755         usb_free_urb(atusb->tx_urb);
 756
 757         ieee802154_unregister_hw(atusb->hw);
 758
 759         ieee802154_free_hw(atusb->hw);
 760
 761         usb_set_intfdata(interface, NULL);
 762         usb_put_dev(atusb->usb_dev);
 763
 764         pr_debug("atusb_disconnect done\n");
 765 }
 766
 767 /* The devices we work with */
 768 static const struct usb_device_id atusb_device_table[] = {
 769         {
 770                 .match_flags            = USB_DEVICE_ID_MATCH_DEVICE |
 771                                           USB_DEVICE_ID_MATCH_INT_INFO,
 772                 .idVendor               = ATUSB_VENDOR_ID,
 773                 .idProduct              = ATUSB_PRODUCT_ID,
 774                 .bInterfaceClass        = USB_CLASS_VENDOR_SPEC
 775         },
 776         /* end with null element */
 777         {}
 778 };
 779 MODULE_DEVICE_TABLE(usb, atusb_device_table);
 780
 781 static struct usb_driver atusb_driver = {
 782         .name           = "atusb",
 783         .probe          = atusb_probe,
 784         .disconnect     = atusb_disconnect,
 785         .id_table       = atusb_device_table,
 786 };
 787 module_usb_driver(atusb_driver);
 788
 789 MODULE_AUTHOR("Alexander Aring <alex.aring@gmail.com>");
 790 MODULE_AUTHOR("Richard Sharpe <realrichardsharpe@gmail.com>");
 791 MODULE_AUTHOR("Stefan Schmidt <stefan@datenfreihafen.org>");
 792 MODULE_AUTHOR("Werner Almesberger <werner@almesberger.net>");
 793 MODULE_DESCRIPTION("ATUSB IEEE 802.15.4 Driver");
 794 MODULE_LICENSE("GPL");