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