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