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