1 // SPDX-License-Identifier: GPL-2.0-only
3 * atusb.c - Driver for the ATUSB IEEE 802.15.4 dongle
5 * Written 2013 by Werner Almesberger <werner@almesberger.net>
7 * Copyright (c) 2015 - 2016 Stefan Schmidt <stefan@datenfreihafen.org>
9 * Based on at86rf230.c and spi_atusb.c.
11 * Copyright (C) 2009 Siemens AG
12 * Written by: Dmitry Eremin-Solenikov <dmitry.baryshkov@siemens.com>
15 * Copyright (c) 2011 Richard Sharpe <realrichardsharpe@gmail.com>
16 * Copyright (c) 2011 Stefan Schmidt <stefan@datenfreihafen.org>
17 * Copyright (c) 2011 Werner Almesberger <werner@almesberger.net>
19 * USB initialization is
20 * Copyright (c) 2013 Alexander Aring <alex.aring@gmail.com>
22 * Busware HUL support is
23 * Copyright (c) 2017 Josef Filzmaier <j.filzmaier@gmx.at>
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>
33 #include <net/cfg802154.h>
34 #include <net/mac802154.h>
36 #include "at86rf230.h"
39 #define ATUSB_JEDEC_ATMEL 0x1f /* JEDEC manufacturer ID */
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 */
46 struct ieee802154_hw *hw;
47 struct usb_device *usb_dev;
48 struct atusb_chip_data *data;
49 int shutdown; /* non-zero if shutting down */
50 int err; /* set by first error */
53 struct delayed_work work; /* memory allocations */
54 struct usb_anchor idle_urbs; /* URBs waiting to be submitted */
55 struct usb_anchor rx_urbs; /* URBs waiting for reception */
58 struct usb_ctrlrequest tx_dr;
60 struct sk_buff *tx_skb;
61 u8 tx_ack_seq; /* current TX ACK sequence number */
63 /* Firmware variable */
64 unsigned char fw_ver_maj; /* Firmware major version number */
65 unsigned char fw_ver_min; /* Firmware minor version number */
66 unsigned char fw_hw_type; /* Firmware hardware type */
69 struct atusb_chip_data {
73 int (*set_channel)(struct ieee802154_hw*, u8, u8);
74 int (*set_txpower)(struct ieee802154_hw*, s32);
77 /* ----- USB commands without data ----------------------------------------- */
79 /* To reduce the number of error checks in the code, we record the first error
80 * in atusb->err and reject all subsequent requests until the error is cleared.
83 static int atusb_control_msg(struct atusb *atusb, unsigned int pipe,
84 __u8 request, __u8 requesttype,
85 __u16 value, __u16 index,
86 void *data, __u16 size, int timeout)
88 struct usb_device *usb_dev = atusb->usb_dev;
94 ret = usb_control_msg(usb_dev, pipe, request, requesttype,
95 value, index, data, size, timeout);
98 dev_err(&usb_dev->dev,
99 "%s: req 0x%02x val 0x%x idx 0x%x, error %d\n",
100 __func__, request, value, index, ret);
105 static int atusb_command(struct atusb *atusb, u8 cmd, u8 arg)
107 struct usb_device *usb_dev = atusb->usb_dev;
109 dev_dbg(&usb_dev->dev, "%s: cmd = 0x%x\n", __func__, cmd);
110 return atusb_control_msg(atusb, usb_sndctrlpipe(usb_dev, 0),
111 cmd, ATUSB_REQ_TO_DEV, arg, 0, NULL, 0, 1000);
114 static int atusb_write_reg(struct atusb *atusb, u8 reg, u8 value)
116 struct usb_device *usb_dev = atusb->usb_dev;
118 dev_dbg(&usb_dev->dev, "%s: 0x%02x <- 0x%02x\n", __func__, reg, value);
119 return atusb_control_msg(atusb, usb_sndctrlpipe(usb_dev, 0),
120 ATUSB_REG_WRITE, ATUSB_REQ_TO_DEV,
121 value, reg, NULL, 0, 1000);
124 static int atusb_read_reg(struct atusb *atusb, u8 reg)
126 struct usb_device *usb_dev = atusb->usb_dev;
131 buffer = kmalloc(1, GFP_KERNEL);
135 dev_dbg(&usb_dev->dev, "%s: reg = 0x%x\n", __func__, reg);
136 ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
137 ATUSB_REG_READ, ATUSB_REQ_FROM_DEV,
138 0, reg, buffer, 1, 1000);
150 static int atusb_write_subreg(struct atusb *atusb, u8 reg, u8 mask,
153 struct usb_device *usb_dev = atusb->usb_dev;
157 dev_dbg(&usb_dev->dev, "%s: 0x%02x <- 0x%02x\n", __func__, reg, value);
159 orig = atusb_read_reg(atusb, reg);
161 /* Write the value only into that part of the register which is allowed
162 * by the mask. All other bits stay as before.
165 tmp |= (value << shift) & mask;
168 ret = atusb_write_reg(atusb, reg, tmp);
173 static int atusb_read_subreg(struct atusb *lp,
174 unsigned int addr, unsigned int mask,
179 rc = atusb_read_reg(lp, addr);
180 rc = (rc & mask) >> shift;
185 static int atusb_get_and_clear_error(struct atusb *atusb)
187 int err = atusb->err;
193 /* ----- skb allocation ---------------------------------------------------- */
196 #define MAX_RX_XFER (1 + MAX_PSDU + 2 + 1) /* PHR+PSDU+CRC+LQI */
198 #define SKB_ATUSB(skb) (*(struct atusb **)(skb)->cb)
200 static void atusb_in(struct urb *urb);
202 static int atusb_submit_rx_urb(struct atusb *atusb, struct urb *urb)
204 struct usb_device *usb_dev = atusb->usb_dev;
205 struct sk_buff *skb = urb->context;
209 skb = alloc_skb(MAX_RX_XFER, GFP_KERNEL);
211 dev_warn_ratelimited(&usb_dev->dev,
212 "atusb_in: can't allocate skb\n");
215 skb_put(skb, MAX_RX_XFER);
216 SKB_ATUSB(skb) = atusb;
219 usb_fill_bulk_urb(urb, usb_dev, usb_rcvbulkpipe(usb_dev, 1),
220 skb->data, MAX_RX_XFER, atusb_in, skb);
221 usb_anchor_urb(urb, &atusb->rx_urbs);
223 ret = usb_submit_urb(urb, GFP_KERNEL);
225 usb_unanchor_urb(urb);
232 static void atusb_work_urbs(struct work_struct *work)
234 struct atusb *atusb =
235 container_of(to_delayed_work(work), struct atusb, work);
236 struct usb_device *usb_dev = atusb->usb_dev;
244 urb = usb_get_from_anchor(&atusb->idle_urbs);
247 ret = atusb_submit_rx_urb(atusb, urb);
250 usb_anchor_urb(urb, &atusb->idle_urbs);
251 dev_warn_ratelimited(&usb_dev->dev,
252 "atusb_in: can't allocate/submit URB (%d)\n", ret);
253 schedule_delayed_work(&atusb->work,
254 msecs_to_jiffies(ATUSB_ALLOC_DELAY_MS) + 1);
257 /* ----- Asynchronous USB -------------------------------------------------- */
259 static void atusb_tx_done(struct atusb *atusb, u8 seq)
261 struct usb_device *usb_dev = atusb->usb_dev;
262 u8 expect = atusb->tx_ack_seq;
264 dev_dbg(&usb_dev->dev, "%s (0x%02x/0x%02x)\n", __func__, seq, expect);
266 /* TODO check for ifs handling in firmware */
267 ieee802154_xmit_complete(atusb->hw, atusb->tx_skb, false);
269 /* TODO I experience this case when atusb has a tx complete
270 * irq before probing, we should fix the firmware it's an
271 * unlikely case now that seq == expect is then true, but can
272 * happen and fail with a tx_skb = NULL;
274 ieee802154_wake_queue(atusb->hw);
276 dev_kfree_skb_irq(atusb->tx_skb);
280 static void atusb_in_good(struct urb *urb)
282 struct usb_device *usb_dev = urb->dev;
283 struct sk_buff *skb = urb->context;
284 struct atusb *atusb = SKB_ATUSB(skb);
287 if (!urb->actual_length) {
288 dev_dbg(&usb_dev->dev, "atusb_in: zero-sized URB ?\n");
294 if (urb->actual_length == 1) {
295 atusb_tx_done(atusb, len);
299 if (len + 1 > urb->actual_length - 1) {
300 dev_dbg(&usb_dev->dev, "atusb_in: frame len %d+1 > URB %u-1\n",
301 len, urb->actual_length);
305 if (!ieee802154_is_valid_psdu_len(len)) {
306 dev_dbg(&usb_dev->dev, "atusb_in: frame corrupted\n");
310 lqi = skb->data[len + 1];
311 dev_dbg(&usb_dev->dev, "atusb_in: rx len %d lqi 0x%02x\n", len, lqi);
312 skb_pull(skb, 1); /* remove PHR */
313 skb_trim(skb, len); /* get payload only */
314 ieee802154_rx_irqsafe(atusb->hw, skb, lqi);
315 urb->context = NULL; /* skb is gone */
318 static void atusb_in(struct urb *urb)
320 struct usb_device *usb_dev = urb->dev;
321 struct sk_buff *skb = urb->context;
322 struct atusb *atusb = SKB_ATUSB(skb);
324 dev_dbg(&usb_dev->dev, "%s: status %d len %d\n", __func__,
325 urb->status, urb->actual_length);
327 if (urb->status == -ENOENT) { /* being killed */
332 dev_dbg(&usb_dev->dev, "%s: URB error %d\n", __func__, urb->status);
337 usb_anchor_urb(urb, &atusb->idle_urbs);
338 if (!atusb->shutdown)
339 schedule_delayed_work(&atusb->work, 0);
342 /* ----- URB allocation/deallocation --------------------------------------- */
344 static void atusb_free_urbs(struct atusb *atusb)
349 urb = usb_get_from_anchor(&atusb->idle_urbs);
352 kfree_skb(urb->context);
357 static int atusb_alloc_urbs(struct atusb *atusb, int n)
362 urb = usb_alloc_urb(0, GFP_KERNEL);
364 atusb_free_urbs(atusb);
367 usb_anchor_urb(urb, &atusb->idle_urbs);
373 /* ----- IEEE 802.15.4 interface operations -------------------------------- */
375 static void atusb_xmit_complete(struct urb *urb)
377 dev_dbg(&urb->dev->dev, "atusb_xmit urb completed");
380 static int atusb_xmit(struct ieee802154_hw *hw, struct sk_buff *skb)
382 struct atusb *atusb = hw->priv;
383 struct usb_device *usb_dev = atusb->usb_dev;
386 dev_dbg(&usb_dev->dev, "%s (%d)\n", __func__, skb->len);
389 atusb->tx_dr.wIndex = cpu_to_le16(atusb->tx_ack_seq);
390 atusb->tx_dr.wLength = cpu_to_le16(skb->len);
392 usb_fill_control_urb(atusb->tx_urb, usb_dev,
393 usb_sndctrlpipe(usb_dev, 0),
394 (unsigned char *)&atusb->tx_dr, skb->data,
395 skb->len, atusb_xmit_complete, NULL);
396 ret = usb_submit_urb(atusb->tx_urb, GFP_ATOMIC);
397 dev_dbg(&usb_dev->dev, "%s done (%d)\n", __func__, ret);
401 static int atusb_ed(struct ieee802154_hw *hw, u8 *level)
408 static int atusb_set_hw_addr_filt(struct ieee802154_hw *hw,
409 struct ieee802154_hw_addr_filt *filt,
410 unsigned long changed)
412 struct atusb *atusb = hw->priv;
413 struct device *dev = &atusb->usb_dev->dev;
415 if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
416 u16 addr = le16_to_cpu(filt->short_addr);
418 dev_vdbg(dev, "%s called for saddr\n", __func__);
419 atusb_write_reg(atusb, RG_SHORT_ADDR_0, addr);
420 atusb_write_reg(atusb, RG_SHORT_ADDR_1, addr >> 8);
423 if (changed & IEEE802154_AFILT_PANID_CHANGED) {
424 u16 pan = le16_to_cpu(filt->pan_id);
426 dev_vdbg(dev, "%s called for pan id\n", __func__);
427 atusb_write_reg(atusb, RG_PAN_ID_0, pan);
428 atusb_write_reg(atusb, RG_PAN_ID_1, pan >> 8);
431 if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
432 u8 i, addr[IEEE802154_EXTENDED_ADDR_LEN];
434 memcpy(addr, &filt->ieee_addr, IEEE802154_EXTENDED_ADDR_LEN);
435 dev_vdbg(dev, "%s called for IEEE addr\n", __func__);
436 for (i = 0; i < 8; i++)
437 atusb_write_reg(atusb, RG_IEEE_ADDR_0 + i, addr[i]);
440 if (changed & IEEE802154_AFILT_PANC_CHANGED) {
441 dev_vdbg(dev, "%s called for panc change\n", __func__);
443 atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 1);
445 atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 0);
448 return atusb_get_and_clear_error(atusb);
451 static int atusb_start(struct ieee802154_hw *hw)
453 struct atusb *atusb = hw->priv;
454 struct usb_device *usb_dev = atusb->usb_dev;
457 dev_dbg(&usb_dev->dev, "%s\n", __func__);
458 schedule_delayed_work(&atusb->work, 0);
459 atusb_command(atusb, ATUSB_RX_MODE, 1);
460 ret = atusb_get_and_clear_error(atusb);
462 usb_kill_anchored_urbs(&atusb->idle_urbs);
466 static void atusb_stop(struct ieee802154_hw *hw)
468 struct atusb *atusb = hw->priv;
469 struct usb_device *usb_dev = atusb->usb_dev;
471 dev_dbg(&usb_dev->dev, "%s\n", __func__);
472 usb_kill_anchored_urbs(&atusb->idle_urbs);
473 atusb_command(atusb, ATUSB_RX_MODE, 0);
474 atusb_get_and_clear_error(atusb);
477 #define ATUSB_MAX_TX_POWERS 0xF
478 static const s32 atusb_powers[ATUSB_MAX_TX_POWERS + 1] = {
479 300, 280, 230, 180, 130, 70, 0, -100, -200, -300, -400, -500, -700,
484 atusb_txpower(struct ieee802154_hw *hw, s32 mbm)
486 struct atusb *atusb = hw->priv;
489 return atusb->data->set_txpower(hw, mbm);
495 atusb_set_txpower(struct ieee802154_hw *hw, s32 mbm)
497 struct atusb *atusb = hw->priv;
500 for (i = 0; i < hw->phy->supported.tx_powers_size; i++) {
501 if (hw->phy->supported.tx_powers[i] == mbm)
502 return atusb_write_subreg(atusb, SR_TX_PWR_23X, i);
509 hulusb_set_txpower(struct ieee802154_hw *hw, s32 mbm)
513 for (i = 0; i < hw->phy->supported.tx_powers_size; i++) {
514 if (hw->phy->supported.tx_powers[i] == mbm)
515 return atusb_write_subreg(hw->priv, SR_TX_PWR_212, i);
521 #define ATUSB_MAX_ED_LEVELS 0xF
522 static const s32 atusb_ed_levels[ATUSB_MAX_ED_LEVELS + 1] = {
523 -9100, -8900, -8700, -8500, -8300, -8100, -7900, -7700, -7500, -7300,
524 -7100, -6900, -6700, -6500, -6300, -6100,
527 #define AT86RF212_MAX_TX_POWERS 0x1F
528 static const s32 at86rf212_powers[AT86RF212_MAX_TX_POWERS + 1] = {
529 500, 400, 300, 200, 100, 0, -100, -200, -300, -400, -500, -600, -700,
530 -800, -900, -1000, -1100, -1200, -1300, -1400, -1500, -1600, -1700,
531 -1800, -1900, -2000, -2100, -2200, -2300, -2400, -2500, -2600,
534 #define AT86RF2XX_MAX_ED_LEVELS 0xF
535 static const s32 at86rf212_ed_levels_100[AT86RF2XX_MAX_ED_LEVELS + 1] = {
536 -10000, -9800, -9600, -9400, -9200, -9000, -8800, -8600, -8400, -8200,
537 -8000, -7800, -7600, -7400, -7200, -7000,
540 static const s32 at86rf212_ed_levels_98[AT86RF2XX_MAX_ED_LEVELS + 1] = {
541 -9800, -9600, -9400, -9200, -9000, -8800, -8600, -8400, -8200, -8000,
542 -7800, -7600, -7400, -7200, -7000, -6800,
546 atusb_set_cca_mode(struct ieee802154_hw *hw, const struct wpan_phy_cca *cca)
548 struct atusb *atusb = hw->priv;
551 /* mapping 802.15.4 to driver spec */
553 case NL802154_CCA_ENERGY:
556 case NL802154_CCA_CARRIER:
559 case NL802154_CCA_ENERGY_CARRIER:
561 case NL802154_CCA_OPT_ENERGY_CARRIER_AND:
564 case NL802154_CCA_OPT_ENERGY_CARRIER_OR:
575 return atusb_write_subreg(atusb, SR_CCA_MODE, val);
578 static int hulusb_set_cca_ed_level(struct atusb *lp, int rssi_base_val)
580 unsigned int cca_ed_thres;
582 cca_ed_thres = atusb_read_subreg(lp, SR_CCA_ED_THRES);
584 switch (rssi_base_val) {
586 lp->hw->phy->supported.cca_ed_levels = at86rf212_ed_levels_98;
587 lp->hw->phy->supported.cca_ed_levels_size = ARRAY_SIZE(at86rf212_ed_levels_98);
588 lp->hw->phy->cca_ed_level = at86rf212_ed_levels_98[cca_ed_thres];
591 lp->hw->phy->supported.cca_ed_levels = at86rf212_ed_levels_100;
592 lp->hw->phy->supported.cca_ed_levels_size = ARRAY_SIZE(at86rf212_ed_levels_100);
593 lp->hw->phy->cca_ed_level = at86rf212_ed_levels_100[cca_ed_thres];
603 atusb_set_cca_ed_level(struct ieee802154_hw *hw, s32 mbm)
605 struct atusb *atusb = hw->priv;
608 for (i = 0; i < hw->phy->supported.cca_ed_levels_size; i++) {
609 if (hw->phy->supported.cca_ed_levels[i] == mbm)
610 return atusb_write_subreg(atusb, SR_CCA_ED_THRES, i);
616 static int atusb_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
618 struct atusb *atusb = hw->priv;
622 ret = atusb->data->set_channel(hw, page, channel);
623 /* @@@ ugly synchronization */
624 msleep(atusb->data->t_channel_switch);
630 static int atusb_set_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
632 struct atusb *atusb = hw->priv;
635 ret = atusb_write_subreg(atusb, SR_CHANNEL, channel);
641 static int hulusb_set_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
646 struct atusb *lp = hw->priv;
649 rc = atusb_write_subreg(lp, SR_SUB_MODE, 0);
651 rc = atusb_write_subreg(lp, SR_SUB_MODE, 1);
656 rc = atusb_write_subreg(lp, SR_BPSK_QPSK, 0);
657 rssi_base_val = -100;
659 rc = atusb_write_subreg(lp, SR_BPSK_QPSK, 1);
665 rc = hulusb_set_cca_ed_level(lp, rssi_base_val);
669 /* This sets the symbol_duration according frequency on the 212.
670 * TODO move this handling while set channel and page in cfg802154.
671 * We can do that, this timings are according 802.15.4 standard.
672 * If we do that in cfg802154, this is a more generic calculation.
674 * This should also protected from ifs_timer. Means cancel timer and
675 * init with a new value. For now, this is okay.
679 /* SUB:0 and BPSK:0 -> BPSK-20 */
680 lp->hw->phy->symbol_duration = 50;
682 /* SUB:1 and BPSK:0 -> BPSK-40 */
683 lp->hw->phy->symbol_duration = 25;
687 /* SUB:0 and BPSK:1 -> OQPSK-100/200/400 */
688 lp->hw->phy->symbol_duration = 40;
690 /* SUB:1 and BPSK:1 -> OQPSK-250/500/1000 */
691 lp->hw->phy->symbol_duration = 16;
694 lp->hw->phy->lifs_period = IEEE802154_LIFS_PERIOD *
695 lp->hw->phy->symbol_duration;
696 lp->hw->phy->sifs_period = IEEE802154_SIFS_PERIOD *
697 lp->hw->phy->symbol_duration;
699 return atusb_write_subreg(lp, SR_CHANNEL, channel);
703 atusb_set_csma_params(struct ieee802154_hw *hw, u8 min_be, u8 max_be, u8 retries)
705 struct atusb *atusb = hw->priv;
708 ret = atusb_write_subreg(atusb, SR_MIN_BE, min_be);
712 ret = atusb_write_subreg(atusb, SR_MAX_BE, max_be);
716 return atusb_write_subreg(atusb, SR_MAX_CSMA_RETRIES, retries);
720 hulusb_set_lbt(struct ieee802154_hw *hw, bool on)
722 struct atusb *atusb = hw->priv;
724 return atusb_write_subreg(atusb, SR_CSMA_LBT_MODE, on);
728 atusb_set_frame_retries(struct ieee802154_hw *hw, s8 retries)
730 struct atusb *atusb = hw->priv;
732 return atusb_write_subreg(atusb, SR_MAX_FRAME_RETRIES, retries);
736 atusb_set_promiscuous_mode(struct ieee802154_hw *hw, const bool on)
738 struct atusb *atusb = hw->priv;
742 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 1);
746 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 1);
750 ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 0);
754 ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 0);
762 static struct atusb_chip_data atusb_chip_data = {
763 .t_channel_switch = 1,
764 .rssi_base_val = -91,
765 .set_txpower = atusb_set_txpower,
766 .set_channel = atusb_set_channel,
769 static struct atusb_chip_data hulusb_chip_data = {
770 .t_channel_switch = 11,
771 .rssi_base_val = -100,
772 .set_txpower = hulusb_set_txpower,
773 .set_channel = hulusb_set_channel,
776 static const struct ieee802154_ops atusb_ops = {
777 .owner = THIS_MODULE,
778 .xmit_async = atusb_xmit,
780 .set_channel = atusb_channel,
781 .start = atusb_start,
783 .set_hw_addr_filt = atusb_set_hw_addr_filt,
784 .set_txpower = atusb_txpower,
785 .set_lbt = hulusb_set_lbt,
786 .set_cca_mode = atusb_set_cca_mode,
787 .set_cca_ed_level = atusb_set_cca_ed_level,
788 .set_csma_params = atusb_set_csma_params,
789 .set_frame_retries = atusb_set_frame_retries,
790 .set_promiscuous_mode = atusb_set_promiscuous_mode,
793 /* ----- Firmware and chip version information ----------------------------- */
795 static int atusb_get_and_show_revision(struct atusb *atusb)
797 struct usb_device *usb_dev = atusb->usb_dev;
799 unsigned char *buffer;
802 buffer = kmalloc(3, GFP_KERNEL);
806 /* Get a couple of the ATMega Firmware values */
807 ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
808 ATUSB_ID, ATUSB_REQ_FROM_DEV, 0, 0,
811 atusb->fw_ver_maj = buffer[0];
812 atusb->fw_ver_min = buffer[1];
813 atusb->fw_hw_type = buffer[2];
815 switch (atusb->fw_hw_type) {
816 case ATUSB_HW_TYPE_100813:
817 case ATUSB_HW_TYPE_101216:
818 case ATUSB_HW_TYPE_110131:
820 atusb->data = &atusb_chip_data;
822 case ATUSB_HW_TYPE_RZUSB:
824 atusb->data = &atusb_chip_data;
826 case ATUSB_HW_TYPE_HULUSB:
828 atusb->data = &hulusb_chip_data;
832 atusb->err = -ENOTSUPP;
837 dev_info(&usb_dev->dev,
838 "Firmware: major: %u, minor: %u, hardware type: %s (%d)\n",
839 atusb->fw_ver_maj, atusb->fw_ver_min, hw_name,
842 if (atusb->fw_ver_maj == 0 && atusb->fw_ver_min < 2) {
843 dev_info(&usb_dev->dev,
844 "Firmware version (%u.%u) predates our first public release.",
845 atusb->fw_ver_maj, atusb->fw_ver_min);
846 dev_info(&usb_dev->dev, "Please update to version 0.2 or newer");
853 static int atusb_get_and_show_build(struct atusb *atusb)
855 struct usb_device *usb_dev = atusb->usb_dev;
859 build = kmalloc(ATUSB_BUILD_SIZE + 1, GFP_KERNEL);
863 ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
864 ATUSB_BUILD, ATUSB_REQ_FROM_DEV, 0, 0,
865 build, ATUSB_BUILD_SIZE, 1000);
868 dev_info(&usb_dev->dev, "Firmware: build %s\n", build);
875 static int atusb_get_and_conf_chip(struct atusb *atusb)
877 struct usb_device *usb_dev = atusb->usb_dev;
878 u8 man_id_0, man_id_1, part_num, version_num;
880 struct ieee802154_hw *hw = atusb->hw;
882 man_id_0 = atusb_read_reg(atusb, RG_MAN_ID_0);
883 man_id_1 = atusb_read_reg(atusb, RG_MAN_ID_1);
884 part_num = atusb_read_reg(atusb, RG_PART_NUM);
885 version_num = atusb_read_reg(atusb, RG_VERSION_NUM);
890 hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_AFILT |
891 IEEE802154_HW_PROMISCUOUS | IEEE802154_HW_CSMA_PARAMS;
893 hw->phy->flags = WPAN_PHY_FLAG_TXPOWER | WPAN_PHY_FLAG_CCA_ED_LEVEL |
894 WPAN_PHY_FLAG_CCA_MODE;
896 hw->phy->supported.cca_modes = BIT(NL802154_CCA_ENERGY) |
897 BIT(NL802154_CCA_CARRIER) |
898 BIT(NL802154_CCA_ENERGY_CARRIER);
899 hw->phy->supported.cca_opts = BIT(NL802154_CCA_OPT_ENERGY_CARRIER_AND) |
900 BIT(NL802154_CCA_OPT_ENERGY_CARRIER_OR);
902 hw->phy->cca.mode = NL802154_CCA_ENERGY;
904 hw->phy->current_page = 0;
906 if ((man_id_1 << 8 | man_id_0) != ATUSB_JEDEC_ATMEL) {
907 dev_err(&usb_dev->dev,
908 "non-Atmel transceiver xxxx%02x%02x\n",
916 atusb->hw->phy->supported.channels[0] = 0x7FFF800;
917 atusb->hw->phy->current_channel = 11; /* reset default */
918 atusb->hw->phy->symbol_duration = 16;
919 atusb->hw->phy->supported.tx_powers = atusb_powers;
920 atusb->hw->phy->supported.tx_powers_size = ARRAY_SIZE(atusb_powers);
921 hw->phy->supported.cca_ed_levels = atusb_ed_levels;
922 hw->phy->supported.cca_ed_levels_size = ARRAY_SIZE(atusb_ed_levels);
926 atusb->hw->phy->supported.channels[0] = 0x7FFF800;
927 atusb->hw->phy->current_channel = 11; /* reset default */
928 atusb->hw->phy->symbol_duration = 16;
929 atusb->hw->phy->supported.tx_powers = atusb_powers;
930 atusb->hw->phy->supported.tx_powers_size = ARRAY_SIZE(atusb_powers);
931 hw->phy->supported.cca_ed_levels = atusb_ed_levels;
932 hw->phy->supported.cca_ed_levels_size = ARRAY_SIZE(atusb_ed_levels);
936 atusb->hw->flags |= IEEE802154_HW_LBT;
937 atusb->hw->phy->supported.channels[0] = 0x00007FF;
938 atusb->hw->phy->supported.channels[2] = 0x00007FF;
939 atusb->hw->phy->current_channel = 5;
940 atusb->hw->phy->symbol_duration = 25;
941 atusb->hw->phy->supported.lbt = NL802154_SUPPORTED_BOOL_BOTH;
942 atusb->hw->phy->supported.tx_powers = at86rf212_powers;
943 atusb->hw->phy->supported.tx_powers_size = ARRAY_SIZE(at86rf212_powers);
944 atusb->hw->phy->supported.cca_ed_levels = at86rf212_ed_levels_100;
945 atusb->hw->phy->supported.cca_ed_levels_size = ARRAY_SIZE(at86rf212_ed_levels_100);
948 dev_err(&usb_dev->dev,
949 "unexpected transceiver, part 0x%02x version 0x%02x\n",
950 part_num, version_num);
954 hw->phy->transmit_power = hw->phy->supported.tx_powers[0];
955 hw->phy->cca_ed_level = hw->phy->supported.cca_ed_levels[7];
957 dev_info(&usb_dev->dev, "ATUSB: %s version %d\n", chip, version_num);
962 atusb->err = -ENODEV;
966 static int atusb_set_extended_addr(struct atusb *atusb)
968 struct usb_device *usb_dev = atusb->usb_dev;
969 unsigned char *buffer;
970 __le64 extended_addr;
974 /* Firmware versions before 0.3 do not support the EUI64_READ command.
975 * Just use a random address and be done.
977 if (atusb->fw_ver_maj == 0 && atusb->fw_ver_min < 3) {
978 ieee802154_random_extended_addr(&atusb->hw->phy->perm_extended_addr);
982 buffer = kmalloc(IEEE802154_EXTENDED_ADDR_LEN, GFP_KERNEL);
986 /* Firmware is new enough so we fetch the address from EEPROM */
987 ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
988 ATUSB_EUI64_READ, ATUSB_REQ_FROM_DEV, 0, 0,
989 buffer, IEEE802154_EXTENDED_ADDR_LEN, 1000);
991 dev_err(&usb_dev->dev, "failed to fetch extended address, random address set\n");
992 ieee802154_random_extended_addr(&atusb->hw->phy->perm_extended_addr);
997 memcpy(&extended_addr, buffer, IEEE802154_EXTENDED_ADDR_LEN);
998 /* Check if read address is not empty and the unicast bit is set correctly */
999 if (!ieee802154_is_valid_extended_unicast_addr(extended_addr)) {
1000 dev_info(&usb_dev->dev, "no permanent extended address found, random address set\n");
1001 ieee802154_random_extended_addr(&atusb->hw->phy->perm_extended_addr);
1003 atusb->hw->phy->perm_extended_addr = extended_addr;
1004 addr = swab64((__force u64)atusb->hw->phy->perm_extended_addr);
1005 dev_info(&usb_dev->dev, "Read permanent extended address %8phC from device\n",
1013 /* ----- Setup ------------------------------------------------------------- */
1015 static int atusb_probe(struct usb_interface *interface,
1016 const struct usb_device_id *id)
1018 struct usb_device *usb_dev = interface_to_usbdev(interface);
1019 struct ieee802154_hw *hw;
1020 struct atusb *atusb = NULL;
1023 hw = ieee802154_alloc_hw(sizeof(struct atusb), &atusb_ops);
1029 atusb->usb_dev = usb_get_dev(usb_dev);
1030 usb_set_intfdata(interface, atusb);
1032 atusb->shutdown = 0;
1034 INIT_DELAYED_WORK(&atusb->work, atusb_work_urbs);
1035 init_usb_anchor(&atusb->idle_urbs);
1036 init_usb_anchor(&atusb->rx_urbs);
1038 if (atusb_alloc_urbs(atusb, ATUSB_NUM_RX_URBS))
1041 atusb->tx_dr.bRequestType = ATUSB_REQ_TO_DEV;
1042 atusb->tx_dr.bRequest = ATUSB_TX;
1043 atusb->tx_dr.wValue = cpu_to_le16(0);
1045 atusb->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1049 hw->parent = &usb_dev->dev;
1051 atusb_command(atusb, ATUSB_RF_RESET, 0);
1052 atusb_get_and_conf_chip(atusb);
1053 atusb_get_and_show_revision(atusb);
1054 atusb_get_and_show_build(atusb);
1055 atusb_set_extended_addr(atusb);
1057 if ((atusb->fw_ver_maj == 0 && atusb->fw_ver_min >= 3) || atusb->fw_ver_maj > 0)
1058 hw->flags |= IEEE802154_HW_FRAME_RETRIES;
1060 ret = atusb_get_and_clear_error(atusb);
1062 dev_err(&atusb->usb_dev->dev,
1063 "%s: initialization failed, error = %d\n",
1068 ret = ieee802154_register_hw(hw);
1072 /* If we just powered on, we're now in P_ON and need to enter TRX_OFF
1073 * explicitly. Any resets after that will send us straight to TRX_OFF,
1074 * making the command below redundant.
1076 atusb_write_reg(atusb, RG_TRX_STATE, STATE_FORCE_TRX_OFF);
1077 msleep(1); /* reset => TRX_OFF, tTR13 = 37 us */
1080 /* Calculating the maximum time available to empty the frame buffer
1083 * According to [1], the inter-frame gap is
1084 * R * 20 * 16 us + 128 us
1085 * where R is a random number from 0 to 7. Furthermore, we have 20 bit
1086 * times (80 us at 250 kbps) of SHR of the next frame before the
1087 * transceiver begins storing data in the frame buffer.
1089 * This yields a minimum time of 208 us between the last data of a
1090 * frame and the first data of the next frame. This time is further
1091 * reduced by interrupt latency in the atusb firmware.
1093 * atusb currently needs about 500 us to retrieve a maximum-sized
1094 * frame. We therefore have to allow reception of a new frame to begin
1095 * while we retrieve the previous frame.
1097 * [1] "JN-AN-1035 Calculating data rates in an IEEE 802.15.4-based
1098 * network", Jennic 2006.
1099 * http://www.jennic.com/download_file.php?supportFile=JN-AN-1035%20Calculating%20802-15-4%20Data%20Rates-1v0.pdf
1102 atusb_write_subreg(atusb, SR_RX_SAFE_MODE, 1);
1104 atusb_write_reg(atusb, RG_IRQ_MASK, 0xff);
1106 ret = atusb_get_and_clear_error(atusb);
1110 dev_err(&atusb->usb_dev->dev,
1111 "%s: setup failed, error = %d\n",
1114 ieee802154_unregister_hw(hw);
1116 atusb_free_urbs(atusb);
1117 usb_kill_urb(atusb->tx_urb);
1118 usb_free_urb(atusb->tx_urb);
1119 usb_put_dev(usb_dev);
1120 ieee802154_free_hw(hw);
1124 static void atusb_disconnect(struct usb_interface *interface)
1126 struct atusb *atusb = usb_get_intfdata(interface);
1128 dev_dbg(&atusb->usb_dev->dev, "%s\n", __func__);
1130 atusb->shutdown = 1;
1131 cancel_delayed_work_sync(&atusb->work);
1133 usb_kill_anchored_urbs(&atusb->rx_urbs);
1134 atusb_free_urbs(atusb);
1135 usb_kill_urb(atusb->tx_urb);
1136 usb_free_urb(atusb->tx_urb);
1138 ieee802154_unregister_hw(atusb->hw);
1140 usb_put_dev(atusb->usb_dev);
1142 ieee802154_free_hw(atusb->hw);
1144 usb_set_intfdata(interface, NULL);
1146 pr_debug("%s done\n", __func__);
1149 /* The devices we work with */
1150 static const struct usb_device_id atusb_device_table[] = {
1152 .match_flags = USB_DEVICE_ID_MATCH_DEVICE |
1153 USB_DEVICE_ID_MATCH_INT_INFO,
1154 .idVendor = ATUSB_VENDOR_ID,
1155 .idProduct = ATUSB_PRODUCT_ID,
1156 .bInterfaceClass = USB_CLASS_VENDOR_SPEC
1158 /* end with null element */
1161 MODULE_DEVICE_TABLE(usb, atusb_device_table);
1163 static struct usb_driver atusb_driver = {
1165 .probe = atusb_probe,
1166 .disconnect = atusb_disconnect,
1167 .id_table = atusb_device_table,
1169 module_usb_driver(atusb_driver);
1171 MODULE_AUTHOR("Alexander Aring <alex.aring@gmail.com>");
1172 MODULE_AUTHOR("Richard Sharpe <realrichardsharpe@gmail.com>");
1173 MODULE_AUTHOR("Stefan Schmidt <stefan@datenfreihafen.org>");
1174 MODULE_AUTHOR("Werner Almesberger <werner@almesberger.net>");
1175 MODULE_AUTHOR("Josef Filzmaier <j.filzmaier@gmx.at>");
1176 MODULE_DESCRIPTION("ATUSB IEEE 802.15.4 Driver");
1177 MODULE_LICENSE("GPL");