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                 usb_free_urb(urb);
 344                 n--;
 345         }
 346         return 0;
 347 }
 348
 349 /* ----- IEEE 802.15.4 interface operations -------------------------------- */
 350
 351 static void atusb_xmit_complete(struct urb *urb)
 352 {
 353         dev_dbg(&urb->dev->dev, "atusb_xmit urb completed");
 354 }
 355
 356 static int atusb_xmit(struct ieee802154_hw *hw, struct sk_buff *skb)
 357 {
 358         struct atusb *atusb = hw->priv;
 359         struct usb_device *usb_dev = atusb->usb_dev;
 360         int ret;
 361
 362         dev_dbg(&usb_dev->dev, "atusb_xmit (%d)\n", skb->len);
 363         atusb->tx_skb = skb;
 364         atusb->tx_ack_seq++;
 365         atusb->tx_dr.wIndex = cpu_to_le16(atusb->tx_ack_seq);
 366         atusb->tx_dr.wLength = cpu_to_le16(skb->len);
 367
 368         usb_fill_control_urb(atusb->tx_urb, usb_dev,
 369                              usb_sndctrlpipe(usb_dev, 0),
 370                              (unsigned char *)&atusb->tx_dr, skb->data,
 371                              skb->len, atusb_xmit_complete, NULL);
 372         ret = usb_submit_urb(atusb->tx_urb, GFP_ATOMIC);
 373         dev_dbg(&usb_dev->dev, "atusb_xmit done (%d)\n", ret);
 374         return ret;
 375 }
 376
 377 static int atusb_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
 378 {
 379         struct atusb *atusb = hw->priv;
 380         int ret;
 381
 382         /* This implicitly sets the CCA (Clear Channel Assessment) mode to 0,
 383          * "Mode 3a, Carrier sense OR energy above threshold".
 384          * We should probably make this configurable. @@@
 385          */
 386         ret = atusb_write_reg(atusb, RG_PHY_CC_CCA, channel);
 387         if (ret < 0)
 388                 return ret;
 389         msleep(1);      /* @@@ ugly synchronization */
 390         return 0;
 391 }
 392
 393 static int atusb_ed(struct ieee802154_hw *hw, u8 *level)
 394 {
 395         BUG_ON(!level);
 396         *level = 0xbe;
 397         return 0;
 398 }
 399
 400 static int atusb_set_hw_addr_filt(struct ieee802154_hw *hw,
 401                                   struct ieee802154_hw_addr_filt *filt,
 402                                   unsigned long changed)
 403 {
 404         struct atusb *atusb = hw->priv;
 405         struct device *dev = &atusb->usb_dev->dev;
 406
 407         if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
 408                 u16 addr = le16_to_cpu(filt->short_addr);
 409
 410                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for saddr\n");
 411                 atusb_write_reg(atusb, RG_SHORT_ADDR_0, addr);
 412                 atusb_write_reg(atusb, RG_SHORT_ADDR_1, addr >> 8);
 413         }
 414
 415         if (changed & IEEE802154_AFILT_PANID_CHANGED) {
 416                 u16 pan = le16_to_cpu(filt->pan_id);
 417
 418                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for pan id\n");
 419                 atusb_write_reg(atusb, RG_PAN_ID_0, pan);
 420                 atusb_write_reg(atusb, RG_PAN_ID_1, pan >> 8);
 421         }
 422
 423         if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
 424                 u8 i, addr[IEEE802154_EXTENDED_ADDR_LEN];
 425
 426                 memcpy(addr, &filt->ieee_addr, IEEE802154_EXTENDED_ADDR_LEN);
 427                 dev_vdbg(dev, "atusb_set_hw_addr_filt called for IEEE addr\n");
 428                 for (i = 0; i < 8; i++)
 429                         atusb_write_reg(atusb, RG_IEEE_ADDR_0 + i, addr[i]);
 430         }
 431
 432         if (changed & IEEE802154_AFILT_PANC_CHANGED) {
 433                 dev_vdbg(dev,
 434                          "atusb_set_hw_addr_filt called for panc change\n");
 435                 if (filt->pan_coord)
 436                         atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 1);
 437                 else
 438                         atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 0);
 439         }
 440
 441         return atusb_get_and_clear_error(atusb);
 442 }
 443
 444 static int atusb_start(struct ieee802154_hw *hw)
 445 {
 446         struct atusb *atusb = hw->priv;
 447         struct usb_device *usb_dev = atusb->usb_dev;
 448         int ret;
 449
 450         dev_dbg(&usb_dev->dev, "atusb_start\n");
 451         schedule_delayed_work(&atusb->work, 0);
 452         atusb_command(atusb, ATUSB_RX_MODE, 1);
 453         ret = atusb_get_and_clear_error(atusb);
 454         if (ret < 0)
 455                 usb_kill_anchored_urbs(&atusb->idle_urbs);
 456         return ret;
 457 }
 458
 459 static void atusb_stop(struct ieee802154_hw *hw)
 460 {
 461         struct atusb *atusb = hw->priv;
 462         struct usb_device *usb_dev = atusb->usb_dev;
 463
 464         dev_dbg(&usb_dev->dev, "atusb_stop\n");
 465         usb_kill_anchored_urbs(&atusb->idle_urbs);
 466         atusb_command(atusb, ATUSB_RX_MODE, 0);
 467         atusb_get_and_clear_error(atusb);
 468 }
 469
 470 #define ATUSB_MAX_TX_POWERS 0xF
 471 static const s32 atusb_powers[ATUSB_MAX_TX_POWERS + 1] = {
 472         300, 280, 230, 180, 130, 70, 0, -100, -200, -300, -400, -500, -700,
 473         -900, -1200, -1700,
 474 };
 475
 476 static int
 477 atusb_set_txpower(struct ieee802154_hw *hw, s32 mbm)
 478 {
 479         struct atusb *atusb = hw->priv;
 480         u32 i;
 481
 482         for (i = 0; i < hw->phy->supported.tx_powers_size; i++) {
 483                 if (hw->phy->supported.tx_powers[i] == mbm)
 484                         return atusb_write_subreg(atusb, SR_TX_PWR_23X, i);
 485         }
 486
 487         return -EINVAL;
 488 }
 489
 490 static int
 491 atusb_set_promiscuous_mode(struct ieee802154_hw *hw, const bool on)
 492 {
 493         struct atusb *atusb = hw->priv;
 494         int ret;
 495
 496         if (on) {
 497                 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 1);
 498                 if (ret < 0)
 499                         return ret;
 500
 501                 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 1);
 502                 if (ret < 0)
 503                         return ret;
 504         } else {
 505                 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 0);
 506                 if (ret < 0)
 507                         return ret;
 508
 509                 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 0);
 510                 if (ret < 0)
 511                         return ret;
 512         }
 513
 514         return 0;
 515 }
 516
 517 static struct ieee802154_ops atusb_ops = {
 518         .owner                  = THIS_MODULE,
 519         .xmit_async             = atusb_xmit,
 520         .ed                     = atusb_ed,
 521         .set_channel            = atusb_channel,
 522         .start                  = atusb_start,
 523         .stop                   = atusb_stop,
 524         .set_hw_addr_filt       = atusb_set_hw_addr_filt,
 525         .set_txpower            = atusb_set_txpower,
 526         .set_promiscuous_mode   = atusb_set_promiscuous_mode,
 527 };
 528
 529 /* ----- Firmware and chip version information ----------------------------- */
 530
 531 static int atusb_get_and_show_revision(struct atusb *atusb)
 532 {
 533         struct usb_device *usb_dev = atusb->usb_dev;
 534         unsigned char *buffer;
 535         int ret;
 536
 537         buffer = kmalloc(3, GFP_KERNEL);
 538         if (!buffer)
 539                 return -ENOMEM;
 540
 541         /* Get a couple of the ATMega Firmware values */
 542         ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
 543                                 ATUSB_ID, ATUSB_REQ_FROM_DEV, 0, 0,
 544                                 buffer, 3, 1000);
 545         if (ret >= 0)
 546                 dev_info(&usb_dev->dev,
 547                          "Firmware: major: %u, minor: %u, hardware type: %u\n",
 548                          buffer[0], buffer[1], buffer[2]);
 549         if (buffer[0] == 0 && buffer[1] < 2) {
 550                 dev_info(&usb_dev->dev,
 551                          "Firmware version (%u.%u) is predates our first public release.",
 552                          buffer[0], buffer[1]);
 553                 dev_info(&usb_dev->dev, "Please update to version 0.2 or newer");
 554         }
 555
 556         kfree(buffer);
 557         return ret;
 558 }
 559
 560 static int atusb_get_and_show_build(struct atusb *atusb)
 561 {
 562         struct usb_device *usb_dev = atusb->usb_dev;
 563         char *build;
 564         int ret;
 565
 566         build = kmalloc(ATUSB_BUILD_SIZE + 1, GFP_KERNEL);
 567         if (!build)
 568                 return -ENOMEM;
 569
 570         ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
 571                                 ATUSB_BUILD, ATUSB_REQ_FROM_DEV, 0, 0,
 572                                 build, ATUSB_BUILD_SIZE, 1000);
 573         if (ret >= 0) {
 574                 build[ret] = 0;
 575                 dev_info(&usb_dev->dev, "Firmware: build %s\n", build);
 576         }
 577
 578         kfree(build);
 579         return ret;
 580 }
 581
 582 static int atusb_get_and_show_chip(struct atusb *atusb)
 583 {
 584         struct usb_device *usb_dev = atusb->usb_dev;
 585         uint8_t man_id_0, man_id_1, part_num, version_num;
 586         const char *chip;
 587
 588         man_id_0 = atusb_read_reg(atusb, RG_MAN_ID_0);
 589         man_id_1 = atusb_read_reg(atusb, RG_MAN_ID_1);
 590         part_num = atusb_read_reg(atusb, RG_PART_NUM);
 591         version_num = atusb_read_reg(atusb, RG_VERSION_NUM);
 592
 593         if (atusb->err)
 594                 return atusb->err;
 595
 596         if ((man_id_1 << 8 | man_id_0) != ATUSB_JEDEC_ATMEL) {
 597                 dev_err(&usb_dev->dev,
 598                         "non-Atmel transceiver xxxx%02x%02x\n",
 599                         man_id_1, man_id_0);
 600                 goto fail;
 601         }
 602
 603         switch (part_num) {
 604         case 2:
 605                 chip = "AT86RF230";
 606                 break;
 607         case 3:
 608                 chip = "AT86RF231";
 609                 break;
 610         default:
 611                 dev_err(&usb_dev->dev,
 612                         "unexpected transceiver, part 0x%02x version 0x%02x\n",
 613                         part_num, version_num);
 614                 goto fail;
 615         }
 616
 617         dev_info(&usb_dev->dev, "ATUSB: %s version %d\n", chip, version_num);
 618
 619         return 0;
 620
 621 fail:
 622         atusb->err = -ENODEV;
 623         return -ENODEV;
 624 }
 625
 626 /* ----- Setup ------------------------------------------------------------- */
 627
 628 static int atusb_probe(struct usb_interface *interface,
 629                        const struct usb_device_id *id)
 630 {
 631         struct usb_device *usb_dev = interface_to_usbdev(interface);
 632         struct ieee802154_hw *hw;
 633         struct atusb *atusb = NULL;
 634         int ret = -ENOMEM;
 635
 636         hw = ieee802154_alloc_hw(sizeof(struct atusb), &atusb_ops);
 637         if (!hw)
 638                 return -ENOMEM;
 639
 640         atusb = hw->priv;
 641         atusb->hw = hw;
 642         atusb->usb_dev = usb_get_dev(usb_dev);
 643         usb_set_intfdata(interface, atusb);
 644
 645         atusb->shutdown = 0;
 646         atusb->err = 0;
 647         INIT_DELAYED_WORK(&atusb->work, atusb_work_urbs);
 648         init_usb_anchor(&atusb->idle_urbs);
 649         init_usb_anchor(&atusb->rx_urbs);
 650
 651         if (atusb_alloc_urbs(atusb, ATUSB_NUM_RX_URBS))
 652                 goto fail;
 653
 654         atusb->tx_dr.bRequestType = ATUSB_REQ_TO_DEV;
 655         atusb->tx_dr.bRequest = ATUSB_TX;
 656         atusb->tx_dr.wValue = cpu_to_le16(0);
 657
 658         atusb->tx_urb = usb_alloc_urb(0, GFP_ATOMIC);
 659         if (!atusb->tx_urb)
 660                 goto fail;
 661
 662         hw->parent = &usb_dev->dev;
 663         hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_AFILT |
 664                     IEEE802154_HW_PROMISCUOUS;
 665
 666         hw->phy->flags = WPAN_PHY_FLAG_TXPOWER;
 667
 668         hw->phy->current_page = 0;
 669         hw->phy->current_channel = 11;  /* reset default */
 670         hw->phy->supported.channels[0] = 0x7FFF800;
 671         hw->phy->supported.tx_powers = atusb_powers;
 672         hw->phy->supported.tx_powers_size = ARRAY_SIZE(atusb_powers);
 673         hw->phy->transmit_power = hw->phy->supported.tx_powers[0];
 674         ieee802154_random_extended_addr(&hw->phy->perm_extended_addr);
 675
 676         atusb_command(atusb, ATUSB_RF_RESET, 0);
 677         atusb_get_and_show_chip(atusb);
 678         atusb_get_and_show_revision(atusb);
 679         atusb_get_and_show_build(atusb);
 680         ret = atusb_get_and_clear_error(atusb);
 681         if (ret) {
 682                 dev_err(&atusb->usb_dev->dev,
 683                         "%s: initialization failed, error = %d\n",
 684                         __func__, ret);
 685                 goto fail;
 686         }
 687
 688         ret = ieee802154_register_hw(hw);
 689         if (ret)
 690                 goto fail;
 691
 692         /* If we just powered on, we're now in P_ON and need to enter TRX_OFF
 693          * explicitly. Any resets after that will send us straight to TRX_OFF,
 694          * making the command below redundant.
 695          */
 696         atusb_write_reg(atusb, RG_TRX_STATE, STATE_FORCE_TRX_OFF);
 697         msleep(1);      /* reset => TRX_OFF, tTR13 = 37 us */
 698
 699 #if 0
 700         /* Calculating the maximum time available to empty the frame buffer
 701          * on reception:
 702          *
 703          * According to [1], the inter-frame gap is
 704          * R * 20 * 16 us + 128 us
 705          * where R is a random number from 0 to 7. Furthermore, we have 20 bit
 706          * times (80 us at 250 kbps) of SHR of the next frame before the
 707          * transceiver begins storing data in the frame buffer.
 708          *
 709          * This yields a minimum time of 208 us between the last data of a
 710          * frame and the first data of the next frame. This time is further
 711          * reduced by interrupt latency in the atusb firmware.
 712          *
 713          * atusb currently needs about 500 us to retrieve a maximum-sized
 714          * frame. We therefore have to allow reception of a new frame to begin
 715          * while we retrieve the previous frame.
 716          *
 717          * [1] "JN-AN-1035 Calculating data rates in an IEEE 802.15.4-based
 718          *      network", Jennic 2006.
 719          *     http://www.jennic.com/download_file.php?supportFile=JN-AN-1035%20Calculating%20802-15-4%20Data%20Rates-1v0.pdf
 720          */
 721
 722         atusb_write_subreg(atusb, SR_RX_SAFE_MODE, 1);
 723 #endif
 724         atusb_write_reg(atusb, RG_IRQ_MASK, 0xff);
 725
 726         ret = atusb_get_and_clear_error(atusb);
 727         if (!ret)
 728                 return 0;
 729
 730         dev_err(&atusb->usb_dev->dev,
 731                 "%s: setup failed, error = %d\n",
 732                 __func__, ret);
 733
 734         ieee802154_unregister_hw(hw);
 735 fail:
 736         atusb_free_urbs(atusb);
 737         usb_kill_urb(atusb->tx_urb);
 738         usb_free_urb(atusb->tx_urb);
 739         usb_put_dev(usb_dev);
 740         ieee802154_free_hw(hw);
 741         return ret;
 742 }
 743
 744 static void atusb_disconnect(struct usb_interface *interface)
 745 {
 746         struct atusb *atusb = usb_get_intfdata(interface);
 747
 748         dev_dbg(&atusb->usb_dev->dev, "atusb_disconnect\n");
 749
 750         atusb->shutdown = 1;
 751         cancel_delayed_work_sync(&atusb->work);
 752
 753         usb_kill_anchored_urbs(&atusb->rx_urbs);
 754         atusb_free_urbs(atusb);
 755         usb_kill_urb(atusb->tx_urb);
 756         usb_free_urb(atusb->tx_urb);
 757
 758         ieee802154_unregister_hw(atusb->hw);
 759
 760         usb_put_dev(atusb->usb_dev);
 761
 762         ieee802154_free_hw(atusb->hw);
 763
 764         usb_set_intfdata(interface, NULL);
 765
 766         pr_debug("atusb_disconnect done\n");
 767 }
 768
 769 /* The devices we work with */
 770 static const struct usb_device_id atusb_device_table[] = {
 771         {
 772                 .match_flags            = USB_DEVICE_ID_MATCH_DEVICE |
 773                                           USB_DEVICE_ID_MATCH_INT_INFO,
 774                 .idVendor               = ATUSB_VENDOR_ID,
 775                 .idProduct              = ATUSB_PRODUCT_ID,
 776                 .bInterfaceClass        = USB_CLASS_VENDOR_SPEC
 777         },
 778         /* end with null element */
 779         {}
 780 };
 781 MODULE_DEVICE_TABLE(usb, atusb_device_table);
 782
 783 static struct usb_driver atusb_driver = {
 784         .name           = "atusb",
 785         .probe          = atusb_probe,
 786         .disconnect     = atusb_disconnect,
 787         .id_table       = atusb_device_table,
 788 };
 789 module_usb_driver(atusb_driver);
 790
 791 MODULE_AUTHOR("Alexander Aring <alex.aring@gmail.com>");
 792 MODULE_AUTHOR("Richard Sharpe <realrichardsharpe@gmail.com>");
 793 MODULE_AUTHOR("Stefan Schmidt <stefan@datenfreihafen.org>");
 794 MODULE_AUTHOR("Werner Almesberger <werner@almesberger.net>");
 795 MODULE_DESCRIPTION("ATUSB IEEE 802.15.4 Driver");
 796 MODULE_LICENSE("GPL");