2 * atusb.c - Driver for the ATUSB IEEE 802.15.4 dongle
4 * Written 2013 by Werner Almesberger <werner@almesberger.net>
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
10 * Based on at86rf230.c and spi_atusb.c.
12 * Copyright (C) 2009 Siemens AG
13 * Written by: Dmitry Eremin-Solenikov <dmitry.baryshkov@siemens.com>
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>
20 * USB initialization is
21 * Copyright (c) 2013 Alexander Aring <alex.aring@gmail.com>
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>
31 #include <net/cfg802154.h>
32 #include <net/mac802154.h>
34 #include "at86rf230.h"
37 #define ATUSB_JEDEC_ATMEL 0x1f /* JEDEC manufacturer ID */
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 */
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 */
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 */
55 struct usb_ctrlrequest tx_dr;
57 struct sk_buff *tx_skb;
58 uint8_t tx_ack_seq; /* current TX ACK sequence number */
61 /* ----- USB commands without data ----------------------------------------- */
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.
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)
72 struct usb_device *usb_dev = atusb->usb_dev;
78 ret = usb_control_msg(usb_dev, pipe, request, requesttype,
79 value, index, data, size, timeout);
82 dev_err(&usb_dev->dev,
83 "atusb_control_msg: req 0x%02x val 0x%x idx 0x%x, error %d\n",
84 request, value, index, ret);
89 static int atusb_command(struct atusb *atusb, uint8_t cmd, uint8_t arg)
91 struct usb_device *usb_dev = atusb->usb_dev;
93 dev_dbg(&usb_dev->dev, "atusb_command: cmd = 0x%x\n", cmd);
94 return atusb_control_msg(atusb, usb_sndctrlpipe(usb_dev, 0),
95 cmd, ATUSB_REQ_TO_DEV, arg, 0, NULL, 0, 1000);
98 static int atusb_write_reg(struct atusb *atusb, uint8_t reg, uint8_t value)
100 struct usb_device *usb_dev = atusb->usb_dev;
102 dev_dbg(&usb_dev->dev, "atusb_write_reg: 0x%02x <- 0x%02x\n",
104 return atusb_control_msg(atusb, usb_sndctrlpipe(usb_dev, 0),
105 ATUSB_REG_WRITE, ATUSB_REQ_TO_DEV,
106 value, reg, NULL, 0, 1000);
109 static int atusb_read_reg(struct atusb *atusb, uint8_t reg)
111 struct usb_device *usb_dev = atusb->usb_dev;
116 buffer = kmalloc(1, GFP_KERNEL);
120 dev_dbg(&usb_dev->dev, "atusb: reg = 0x%x\n", reg);
121 ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
122 ATUSB_REG_READ, ATUSB_REQ_FROM_DEV,
123 0, reg, buffer, 1, 1000);
135 static int atusb_write_subreg(struct atusb *atusb, uint8_t reg, uint8_t mask,
136 uint8_t shift, uint8_t value)
138 struct usb_device *usb_dev = atusb->usb_dev;
142 dev_dbg(&usb_dev->dev, "atusb_write_subreg: 0x%02x <- 0x%02x\n",
145 orig = atusb_read_reg(atusb, reg);
147 /* Write the value only into that part of the register which is allowed
148 * by the mask. All other bits stay as before.
151 tmp |= (value << shift) & mask;
154 ret = atusb_write_reg(atusb, reg, tmp);
159 static int atusb_get_and_clear_error(struct atusb *atusb)
161 int err = atusb->err;
167 /* ----- skb allocation ---------------------------------------------------- */
170 #define MAX_RX_XFER (1 + MAX_PSDU + 2 + 1) /* PHR+PSDU+CRC+LQI */
172 #define SKB_ATUSB(skb) (*(struct atusb **)(skb)->cb)
174 static void atusb_in(struct urb *urb);
176 static int atusb_submit_rx_urb(struct atusb *atusb, struct urb *urb)
178 struct usb_device *usb_dev = atusb->usb_dev;
179 struct sk_buff *skb = urb->context;
183 skb = alloc_skb(MAX_RX_XFER, GFP_KERNEL);
185 dev_warn_ratelimited(&usb_dev->dev,
186 "atusb_in: can't allocate skb\n");
189 skb_put(skb, MAX_RX_XFER);
190 SKB_ATUSB(skb) = atusb;
193 usb_fill_bulk_urb(urb, usb_dev, usb_rcvbulkpipe(usb_dev, 1),
194 skb->data, MAX_RX_XFER, atusb_in, skb);
195 usb_anchor_urb(urb, &atusb->rx_urbs);
197 ret = usb_submit_urb(urb, GFP_KERNEL);
199 usb_unanchor_urb(urb);
206 static void atusb_work_urbs(struct work_struct *work)
208 struct atusb *atusb =
209 container_of(to_delayed_work(work), struct atusb, work);
210 struct usb_device *usb_dev = atusb->usb_dev;
218 urb = usb_get_from_anchor(&atusb->idle_urbs);
221 ret = atusb_submit_rx_urb(atusb, urb);
224 usb_anchor_urb(urb, &atusb->idle_urbs);
225 dev_warn_ratelimited(&usb_dev->dev,
226 "atusb_in: can't allocate/submit URB (%d)\n", ret);
227 schedule_delayed_work(&atusb->work,
228 msecs_to_jiffies(ATUSB_ALLOC_DELAY_MS) + 1);
231 /* ----- Asynchronous USB -------------------------------------------------- */
233 static void atusb_tx_done(struct atusb *atusb, uint8_t seq)
235 struct usb_device *usb_dev = atusb->usb_dev;
236 uint8_t expect = atusb->tx_ack_seq;
238 dev_dbg(&usb_dev->dev, "atusb_tx_done (0x%02x/0x%02x)\n", seq, expect);
240 /* TODO check for ifs handling in firmware */
241 ieee802154_xmit_complete(atusb->hw, atusb->tx_skb, false);
243 /* TODO I experience this case when atusb has a tx complete
244 * irq before probing, we should fix the firmware it's an
245 * unlikely case now that seq == expect is then true, but can
246 * happen and fail with a tx_skb = NULL;
248 ieee802154_wake_queue(atusb->hw);
250 dev_kfree_skb_irq(atusb->tx_skb);
254 static void atusb_in_good(struct urb *urb)
256 struct usb_device *usb_dev = urb->dev;
257 struct sk_buff *skb = urb->context;
258 struct atusb *atusb = SKB_ATUSB(skb);
261 if (!urb->actual_length) {
262 dev_dbg(&usb_dev->dev, "atusb_in: zero-sized URB ?\n");
268 if (urb->actual_length == 1) {
269 atusb_tx_done(atusb, len);
273 if (len + 1 > urb->actual_length - 1) {
274 dev_dbg(&usb_dev->dev, "atusb_in: frame len %d+1 > URB %u-1\n",
275 len, urb->actual_length);
279 if (!ieee802154_is_valid_psdu_len(len)) {
280 dev_dbg(&usb_dev->dev, "atusb_in: frame corrupted\n");
284 lqi = skb->data[len + 1];
285 dev_dbg(&usb_dev->dev, "atusb_in: rx len %d lqi 0x%02x\n", len, lqi);
286 skb_pull(skb, 1); /* remove PHR */
287 skb_trim(skb, len); /* get payload only */
288 ieee802154_rx_irqsafe(atusb->hw, skb, lqi);
289 urb->context = NULL; /* skb is gone */
292 static void atusb_in(struct urb *urb)
294 struct usb_device *usb_dev = urb->dev;
295 struct sk_buff *skb = urb->context;
296 struct atusb *atusb = SKB_ATUSB(skb);
298 dev_dbg(&usb_dev->dev, "atusb_in: status %d len %d\n",
299 urb->status, urb->actual_length);
301 if (urb->status == -ENOENT) { /* being killed */
306 dev_dbg(&usb_dev->dev, "atusb_in: URB error %d\n", urb->status);
311 usb_anchor_urb(urb, &atusb->idle_urbs);
312 if (!atusb->shutdown)
313 schedule_delayed_work(&atusb->work, 0);
316 /* ----- URB allocation/deallocation --------------------------------------- */
318 static void atusb_free_urbs(struct atusb *atusb)
323 urb = usb_get_from_anchor(&atusb->idle_urbs);
327 kfree_skb(urb->context);
332 static int atusb_alloc_urbs(struct atusb *atusb, int n)
337 urb = usb_alloc_urb(0, GFP_KERNEL);
339 atusb_free_urbs(atusb);
342 usb_anchor_urb(urb, &atusb->idle_urbs);
349 /* ----- IEEE 802.15.4 interface operations -------------------------------- */
351 static void atusb_xmit_complete(struct urb *urb)
353 dev_dbg(&urb->dev->dev, "atusb_xmit urb completed");
356 static int atusb_xmit(struct ieee802154_hw *hw, struct sk_buff *skb)
358 struct atusb *atusb = hw->priv;
359 struct usb_device *usb_dev = atusb->usb_dev;
362 dev_dbg(&usb_dev->dev, "atusb_xmit (%d)\n", skb->len);
365 atusb->tx_dr.wIndex = cpu_to_le16(atusb->tx_ack_seq);
366 atusb->tx_dr.wLength = cpu_to_le16(skb->len);
368 usb_fill_control_urb(atusb->tx_urb, usb_dev,
369 usb_sndctrlpipe(usb_dev, 0),
370 (unsigned char *)&atusb->tx_dr, skb->data,
371 skb->len, atusb_xmit_complete, NULL);
372 ret = usb_submit_urb(atusb->tx_urb, GFP_ATOMIC);
373 dev_dbg(&usb_dev->dev, "atusb_xmit done (%d)\n", ret);
377 static int atusb_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
379 struct atusb *atusb = hw->priv;
382 /* This implicitly sets the CCA (Clear Channel Assessment) mode to 0,
383 * "Mode 3a, Carrier sense OR energy above threshold".
384 * We should probably make this configurable. @@@
386 ret = atusb_write_reg(atusb, RG_PHY_CC_CCA, channel);
389 msleep(1); /* @@@ ugly synchronization */
393 static int atusb_ed(struct ieee802154_hw *hw, u8 *level)
400 static int atusb_set_hw_addr_filt(struct ieee802154_hw *hw,
401 struct ieee802154_hw_addr_filt *filt,
402 unsigned long changed)
404 struct atusb *atusb = hw->priv;
405 struct device *dev = &atusb->usb_dev->dev;
407 if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
408 u16 addr = le16_to_cpu(filt->short_addr);
410 dev_vdbg(dev, "atusb_set_hw_addr_filt called for saddr\n");
411 atusb_write_reg(atusb, RG_SHORT_ADDR_0, addr);
412 atusb_write_reg(atusb, RG_SHORT_ADDR_1, addr >> 8);
415 if (changed & IEEE802154_AFILT_PANID_CHANGED) {
416 u16 pan = le16_to_cpu(filt->pan_id);
418 dev_vdbg(dev, "atusb_set_hw_addr_filt called for pan id\n");
419 atusb_write_reg(atusb, RG_PAN_ID_0, pan);
420 atusb_write_reg(atusb, RG_PAN_ID_1, pan >> 8);
423 if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
424 u8 i, addr[IEEE802154_EXTENDED_ADDR_LEN];
426 memcpy(addr, &filt->ieee_addr, IEEE802154_EXTENDED_ADDR_LEN);
427 dev_vdbg(dev, "atusb_set_hw_addr_filt called for IEEE addr\n");
428 for (i = 0; i < 8; i++)
429 atusb_write_reg(atusb, RG_IEEE_ADDR_0 + i, addr[i]);
432 if (changed & IEEE802154_AFILT_PANC_CHANGED) {
434 "atusb_set_hw_addr_filt called for panc change\n");
436 atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 1);
438 atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 0);
441 return atusb_get_and_clear_error(atusb);
444 static int atusb_start(struct ieee802154_hw *hw)
446 struct atusb *atusb = hw->priv;
447 struct usb_device *usb_dev = atusb->usb_dev;
450 dev_dbg(&usb_dev->dev, "atusb_start\n");
451 schedule_delayed_work(&atusb->work, 0);
452 atusb_command(atusb, ATUSB_RX_MODE, 1);
453 ret = atusb_get_and_clear_error(atusb);
455 usb_kill_anchored_urbs(&atusb->idle_urbs);
459 static void atusb_stop(struct ieee802154_hw *hw)
461 struct atusb *atusb = hw->priv;
462 struct usb_device *usb_dev = atusb->usb_dev;
464 dev_dbg(&usb_dev->dev, "atusb_stop\n");
465 usb_kill_anchored_urbs(&atusb->idle_urbs);
466 atusb_command(atusb, ATUSB_RX_MODE, 0);
467 atusb_get_and_clear_error(atusb);
470 #define ATUSB_MAX_TX_POWERS 0xF
471 static const s32 atusb_powers[ATUSB_MAX_TX_POWERS + 1] = {
472 300, 280, 230, 180, 130, 70, 0, -100, -200, -300, -400, -500, -700,
477 atusb_set_txpower(struct ieee802154_hw *hw, s32 mbm)
479 struct atusb *atusb = hw->priv;
482 for (i = 0; i < hw->phy->supported.tx_powers_size; i++) {
483 if (hw->phy->supported.tx_powers[i] == mbm)
484 return atusb_write_subreg(atusb, SR_TX_PWR_23X, i);
491 atusb_set_promiscuous_mode(struct ieee802154_hw *hw, const bool on)
493 struct atusb *atusb = hw->priv;
497 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 1);
501 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 1);
505 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 0);
509 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 0);
517 static struct ieee802154_ops atusb_ops = {
518 .owner = THIS_MODULE,
519 .xmit_async = atusb_xmit,
521 .set_channel = atusb_channel,
522 .start = atusb_start,
524 .set_hw_addr_filt = atusb_set_hw_addr_filt,
525 .set_txpower = atusb_set_txpower,
526 .set_promiscuous_mode = atusb_set_promiscuous_mode,
529 /* ----- Firmware and chip version information ----------------------------- */
531 static int atusb_get_and_show_revision(struct atusb *atusb)
533 struct usb_device *usb_dev = atusb->usb_dev;
534 unsigned char *buffer;
537 buffer = kmalloc(3, GFP_KERNEL);
541 /* Get a couple of the ATMega Firmware values */
542 ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
543 ATUSB_ID, ATUSB_REQ_FROM_DEV, 0, 0,
546 dev_info(&usb_dev->dev,
547 "Firmware: major: %u, minor: %u, hardware type: %u\n",
548 buffer[0], buffer[1], buffer[2]);
549 if (buffer[0] == 0 && buffer[1] < 2) {
550 dev_info(&usb_dev->dev,
551 "Firmware version (%u.%u) is predates our first public release.",
552 buffer[0], buffer[1]);
553 dev_info(&usb_dev->dev, "Please update to version 0.2 or newer");
560 static int atusb_get_and_show_build(struct atusb *atusb)
562 struct usb_device *usb_dev = atusb->usb_dev;
566 build = kmalloc(ATUSB_BUILD_SIZE + 1, GFP_KERNEL);
570 ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
571 ATUSB_BUILD, ATUSB_REQ_FROM_DEV, 0, 0,
572 build, ATUSB_BUILD_SIZE, 1000);
575 dev_info(&usb_dev->dev, "Firmware: build %s\n", build);
582 static int atusb_get_and_show_chip(struct atusb *atusb)
584 struct usb_device *usb_dev = atusb->usb_dev;
585 uint8_t man_id_0, man_id_1, part_num, version_num;
588 man_id_0 = atusb_read_reg(atusb, RG_MAN_ID_0);
589 man_id_1 = atusb_read_reg(atusb, RG_MAN_ID_1);
590 part_num = atusb_read_reg(atusb, RG_PART_NUM);
591 version_num = atusb_read_reg(atusb, RG_VERSION_NUM);
596 if ((man_id_1 << 8 | man_id_0) != ATUSB_JEDEC_ATMEL) {
597 dev_err(&usb_dev->dev,
598 "non-Atmel transceiver xxxx%02x%02x\n",
611 dev_err(&usb_dev->dev,
612 "unexpected transceiver, part 0x%02x version 0x%02x\n",
613 part_num, version_num);
617 dev_info(&usb_dev->dev, "ATUSB: %s version %d\n", chip, version_num);
622 atusb->err = -ENODEV;
626 /* ----- Setup ------------------------------------------------------------- */
628 static int atusb_probe(struct usb_interface *interface,
629 const struct usb_device_id *id)
631 struct usb_device *usb_dev = interface_to_usbdev(interface);
632 struct ieee802154_hw *hw;
633 struct atusb *atusb = NULL;
636 hw = ieee802154_alloc_hw(sizeof(struct atusb), &atusb_ops);
642 atusb->usb_dev = usb_get_dev(usb_dev);
643 usb_set_intfdata(interface, atusb);
647 INIT_DELAYED_WORK(&atusb->work, atusb_work_urbs);
648 init_usb_anchor(&atusb->idle_urbs);
649 init_usb_anchor(&atusb->rx_urbs);
651 if (atusb_alloc_urbs(atusb, ATUSB_NUM_RX_URBS))
654 atusb->tx_dr.bRequestType = ATUSB_REQ_TO_DEV;
655 atusb->tx_dr.bRequest = ATUSB_TX;
656 atusb->tx_dr.wValue = cpu_to_le16(0);
658 atusb->tx_urb = usb_alloc_urb(0, GFP_ATOMIC);
662 hw->parent = &usb_dev->dev;
663 hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_AFILT |
664 IEEE802154_HW_PROMISCUOUS;
666 hw->phy->flags = WPAN_PHY_FLAG_TXPOWER;
668 hw->phy->current_page = 0;
669 hw->phy->current_channel = 11; /* reset default */
670 hw->phy->supported.channels[0] = 0x7FFF800;
671 hw->phy->supported.tx_powers = atusb_powers;
672 hw->phy->supported.tx_powers_size = ARRAY_SIZE(atusb_powers);
673 hw->phy->transmit_power = hw->phy->supported.tx_powers[0];
674 ieee802154_random_extended_addr(&hw->phy->perm_extended_addr);
676 atusb_command(atusb, ATUSB_RF_RESET, 0);
677 atusb_get_and_show_chip(atusb);
678 atusb_get_and_show_revision(atusb);
679 atusb_get_and_show_build(atusb);
680 ret = atusb_get_and_clear_error(atusb);
682 dev_err(&atusb->usb_dev->dev,
683 "%s: initialization failed, error = %d\n",
688 ret = ieee802154_register_hw(hw);
692 /* If we just powered on, we're now in P_ON and need to enter TRX_OFF
693 * explicitly. Any resets after that will send us straight to TRX_OFF,
694 * making the command below redundant.
696 atusb_write_reg(atusb, RG_TRX_STATE, STATE_FORCE_TRX_OFF);
697 msleep(1); /* reset => TRX_OFF, tTR13 = 37 us */
700 /* Calculating the maximum time available to empty the frame buffer
703 * According to [1], the inter-frame gap is
704 * R * 20 * 16 us + 128 us
705 * where R is a random number from 0 to 7. Furthermore, we have 20 bit
706 * times (80 us at 250 kbps) of SHR of the next frame before the
707 * transceiver begins storing data in the frame buffer.
709 * This yields a minimum time of 208 us between the last data of a
710 * frame and the first data of the next frame. This time is further
711 * reduced by interrupt latency in the atusb firmware.
713 * atusb currently needs about 500 us to retrieve a maximum-sized
714 * frame. We therefore have to allow reception of a new frame to begin
715 * while we retrieve the previous frame.
717 * [1] "JN-AN-1035 Calculating data rates in an IEEE 802.15.4-based
718 * network", Jennic 2006.
719 * http://www.jennic.com/download_file.php?supportFile=JN-AN-1035%20Calculating%20802-15-4%20Data%20Rates-1v0.pdf
722 atusb_write_subreg(atusb, SR_RX_SAFE_MODE, 1);
724 atusb_write_reg(atusb, RG_IRQ_MASK, 0xff);
726 ret = atusb_get_and_clear_error(atusb);
730 dev_err(&atusb->usb_dev->dev,
731 "%s: setup failed, error = %d\n",
734 ieee802154_unregister_hw(hw);
736 atusb_free_urbs(atusb);
737 usb_kill_urb(atusb->tx_urb);
738 usb_free_urb(atusb->tx_urb);
739 usb_put_dev(usb_dev);
740 ieee802154_free_hw(hw);
744 static void atusb_disconnect(struct usb_interface *interface)
746 struct atusb *atusb = usb_get_intfdata(interface);
748 dev_dbg(&atusb->usb_dev->dev, "atusb_disconnect\n");
751 cancel_delayed_work_sync(&atusb->work);
753 usb_kill_anchored_urbs(&atusb->rx_urbs);
754 atusb_free_urbs(atusb);
755 usb_kill_urb(atusb->tx_urb);
756 usb_free_urb(atusb->tx_urb);
758 ieee802154_unregister_hw(atusb->hw);
760 usb_put_dev(atusb->usb_dev);
762 ieee802154_free_hw(atusb->hw);
764 usb_set_intfdata(interface, NULL);
766 pr_debug("atusb_disconnect done\n");
769 /* The devices we work with */
770 static const struct usb_device_id atusb_device_table[] = {
772 .match_flags = USB_DEVICE_ID_MATCH_DEVICE |
773 USB_DEVICE_ID_MATCH_INT_INFO,
774 .idVendor = ATUSB_VENDOR_ID,
775 .idProduct = ATUSB_PRODUCT_ID,
776 .bInterfaceClass = USB_CLASS_VENDOR_SPEC
778 /* end with null element */
781 MODULE_DEVICE_TABLE(usb, atusb_device_table);
783 static struct usb_driver atusb_driver = {
785 .probe = atusb_probe,
786 .disconnect = atusb_disconnect,
787 .id_table = atusb_device_table,
789 module_usb_driver(atusb_driver);
791 MODULE_AUTHOR("Alexander Aring <alex.aring@gmail.com>");
792 MODULE_AUTHOR("Richard Sharpe <realrichardsharpe@gmail.com>");
793 MODULE_AUTHOR("Stefan Schmidt <stefan@datenfreihafen.org>");
794 MODULE_AUTHOR("Werner Almesberger <werner@almesberger.net>");
795 MODULE_DESCRIPTION("ATUSB IEEE 802.15.4 Driver");
796 MODULE_LICENSE("GPL");