atusb.c 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762
  1. /*
  2. * atusb.c - Driver for the ATUSB IEEE 802.15.4 dongle
  3. *
  4. * Written 2013 by Werner Almesberger <werner@almesberger.net>
  5. *
  6. * This program is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU General Public License as
  8. * published by the Free Software Foundation, version 2
  9. *
  10. * Based on at86rf230.c and spi_atusb.c.
  11. * at86rf230.c is
  12. * Copyright (C) 2009 Siemens AG
  13. * Written by: Dmitry Eremin-Solenikov <dmitry.baryshkov@siemens.com>
  14. *
  15. * spi_atusb.c is
  16. * Copyright (c) 2011 Richard Sharpe <realrichardsharpe@gmail.com>
  17. * Copyright (c) 2011 Stefan Schmidt <stefan@datenfreihafen.org>
  18. * Copyright (c) 2011 Werner Almesberger <werner@almesberger.net>
  19. *
  20. * USB initialization is
  21. * Copyright (c) 2013 Alexander Aring <alex.aring@gmail.com>
  22. */
  23. #include <linux/kernel.h>
  24. #include <linux/slab.h>
  25. #include <linux/module.h>
  26. #include <linux/jiffies.h>
  27. #include <linux/usb.h>
  28. #include <linux/skbuff.h>
  29. #include <net/cfg802154.h>
  30. #include <net/mac802154.h>
  31. #include "at86rf230.h"
  32. #include "atusb.h"
  33. #define ATUSB_JEDEC_ATMEL 0x1f /* JEDEC manufacturer ID */
  34. #define ATUSB_NUM_RX_URBS 4 /* allow for a bit of local latency */
  35. #define ATUSB_ALLOC_DELAY_MS 100 /* delay after failed allocation */
  36. #define ATUSB_TX_TIMEOUT_MS 200 /* on the air timeout */
  37. struct atusb {
  38. struct ieee802154_hw *hw;
  39. struct usb_device *usb_dev;
  40. int shutdown; /* non-zero if shutting down */
  41. int err; /* set by first error */
  42. /* RX variables */
  43. struct delayed_work work; /* memory allocations */
  44. struct usb_anchor idle_urbs; /* URBs waiting to be submitted */
  45. struct usb_anchor rx_urbs; /* URBs waiting for reception */
  46. /* TX variables */
  47. struct usb_ctrlrequest tx_dr;
  48. struct urb *tx_urb;
  49. struct sk_buff *tx_skb;
  50. uint8_t tx_ack_seq; /* current TX ACK sequence number */
  51. };
  52. /* ----- USB commands without data ----------------------------------------- */
  53. /* To reduce the number of error checks in the code, we record the first error
  54. * in atusb->err and reject all subsequent requests until the error is cleared.
  55. */
  56. static int atusb_control_msg(struct atusb *atusb, unsigned int pipe,
  57. __u8 request, __u8 requesttype,
  58. __u16 value, __u16 index,
  59. void *data, __u16 size, int timeout)
  60. {
  61. struct usb_device *usb_dev = atusb->usb_dev;
  62. int ret;
  63. if (atusb->err)
  64. return atusb->err;
  65. ret = usb_control_msg(usb_dev, pipe, request, requesttype,
  66. value, index, data, size, timeout);
  67. if (ret < 0) {
  68. atusb->err = ret;
  69. dev_err(&usb_dev->dev,
  70. "atusb_control_msg: req 0x%02x val 0x%x idx 0x%x, error %d\n",
  71. request, value, index, ret);
  72. }
  73. return ret;
  74. }
  75. static int atusb_command(struct atusb *atusb, uint8_t cmd, uint8_t arg)
  76. {
  77. struct usb_device *usb_dev = atusb->usb_dev;
  78. dev_dbg(&usb_dev->dev, "atusb_command: cmd = 0x%x\n", cmd);
  79. return atusb_control_msg(atusb, usb_sndctrlpipe(usb_dev, 0),
  80. cmd, ATUSB_REQ_TO_DEV, arg, 0, NULL, 0, 1000);
  81. }
  82. static int atusb_write_reg(struct atusb *atusb, uint8_t reg, uint8_t value)
  83. {
  84. struct usb_device *usb_dev = atusb->usb_dev;
  85. dev_dbg(&usb_dev->dev, "atusb_write_reg: 0x%02x <- 0x%02x\n",
  86. reg, value);
  87. return atusb_control_msg(atusb, usb_sndctrlpipe(usb_dev, 0),
  88. ATUSB_REG_WRITE, ATUSB_REQ_TO_DEV,
  89. value, reg, NULL, 0, 1000);
  90. }
  91. static int atusb_read_reg(struct atusb *atusb, uint8_t reg)
  92. {
  93. struct usb_device *usb_dev = atusb->usb_dev;
  94. int ret;
  95. uint8_t value;
  96. dev_dbg(&usb_dev->dev, "atusb: reg = 0x%x\n", reg);
  97. ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
  98. ATUSB_REG_READ, ATUSB_REQ_FROM_DEV,
  99. 0, reg, &value, 1, 1000);
  100. return ret >= 0 ? value : ret;
  101. }
  102. static int atusb_write_subreg(struct atusb *atusb, uint8_t reg, uint8_t mask,
  103. uint8_t shift, uint8_t value)
  104. {
  105. struct usb_device *usb_dev = atusb->usb_dev;
  106. uint8_t orig, tmp;
  107. int ret = 0;
  108. dev_dbg(&usb_dev->dev, "atusb_write_subreg: 0x%02x <- 0x%02x\n",
  109. reg, value);
  110. orig = atusb_read_reg(atusb, reg);
  111. /* Write the value only into that part of the register which is allowed
  112. * by the mask. All other bits stay as before.
  113. */
  114. tmp = orig & ~mask;
  115. tmp |= (value << shift) & mask;
  116. if (tmp != orig)
  117. ret = atusb_write_reg(atusb, reg, tmp);
  118. return ret;
  119. }
  120. static int atusb_get_and_clear_error(struct atusb *atusb)
  121. {
  122. int err = atusb->err;
  123. atusb->err = 0;
  124. return err;
  125. }
  126. /* ----- skb allocation ---------------------------------------------------- */
  127. #define MAX_PSDU 127
  128. #define MAX_RX_XFER (1 + MAX_PSDU + 2 + 1) /* PHR+PSDU+CRC+LQI */
  129. #define SKB_ATUSB(skb) (*(struct atusb **)(skb)->cb)
  130. static void atusb_in(struct urb *urb);
  131. static int atusb_submit_rx_urb(struct atusb *atusb, struct urb *urb)
  132. {
  133. struct usb_device *usb_dev = atusb->usb_dev;
  134. struct sk_buff *skb = urb->context;
  135. int ret;
  136. if (!skb) {
  137. skb = alloc_skb(MAX_RX_XFER, GFP_KERNEL);
  138. if (!skb) {
  139. dev_warn_ratelimited(&usb_dev->dev,
  140. "atusb_in: can't allocate skb\n");
  141. return -ENOMEM;
  142. }
  143. skb_put(skb, MAX_RX_XFER);
  144. SKB_ATUSB(skb) = atusb;
  145. }
  146. usb_fill_bulk_urb(urb, usb_dev, usb_rcvbulkpipe(usb_dev, 1),
  147. skb->data, MAX_RX_XFER, atusb_in, skb);
  148. usb_anchor_urb(urb, &atusb->rx_urbs);
  149. ret = usb_submit_urb(urb, GFP_KERNEL);
  150. if (ret) {
  151. usb_unanchor_urb(urb);
  152. kfree_skb(skb);
  153. urb->context = NULL;
  154. }
  155. return ret;
  156. }
  157. static void atusb_work_urbs(struct work_struct *work)
  158. {
  159. struct atusb *atusb =
  160. container_of(to_delayed_work(work), struct atusb, work);
  161. struct usb_device *usb_dev = atusb->usb_dev;
  162. struct urb *urb;
  163. int ret;
  164. if (atusb->shutdown)
  165. return;
  166. do {
  167. urb = usb_get_from_anchor(&atusb->idle_urbs);
  168. if (!urb)
  169. return;
  170. ret = atusb_submit_rx_urb(atusb, urb);
  171. } while (!ret);
  172. usb_anchor_urb(urb, &atusb->idle_urbs);
  173. dev_warn_ratelimited(&usb_dev->dev,
  174. "atusb_in: can't allocate/submit URB (%d)\n", ret);
  175. schedule_delayed_work(&atusb->work,
  176. msecs_to_jiffies(ATUSB_ALLOC_DELAY_MS) + 1);
  177. }
  178. /* ----- Asynchronous USB -------------------------------------------------- */
  179. static void atusb_tx_done(struct atusb *atusb, uint8_t seq)
  180. {
  181. struct usb_device *usb_dev = atusb->usb_dev;
  182. uint8_t expect = atusb->tx_ack_seq;
  183. dev_dbg(&usb_dev->dev, "atusb_tx_done (0x%02x/0x%02x)\n", seq, expect);
  184. if (seq == expect) {
  185. /* TODO check for ifs handling in firmware */
  186. ieee802154_xmit_complete(atusb->hw, atusb->tx_skb, false);
  187. } else {
  188. /* TODO I experience this case when atusb has a tx complete
  189. * irq before probing, we should fix the firmware it's an
  190. * unlikely case now that seq == expect is then true, but can
  191. * happen and fail with a tx_skb = NULL;
  192. */
  193. ieee802154_wake_queue(atusb->hw);
  194. if (atusb->tx_skb)
  195. dev_kfree_skb_irq(atusb->tx_skb);
  196. }
  197. }
  198. static void atusb_in_good(struct urb *urb)
  199. {
  200. struct usb_device *usb_dev = urb->dev;
  201. struct sk_buff *skb = urb->context;
  202. struct atusb *atusb = SKB_ATUSB(skb);
  203. uint8_t len, lqi;
  204. if (!urb->actual_length) {
  205. dev_dbg(&usb_dev->dev, "atusb_in: zero-sized URB ?\n");
  206. return;
  207. }
  208. len = *skb->data;
  209. if (urb->actual_length == 1) {
  210. atusb_tx_done(atusb, len);
  211. return;
  212. }
  213. if (len + 1 > urb->actual_length - 1) {
  214. dev_dbg(&usb_dev->dev, "atusb_in: frame len %d+1 > URB %u-1\n",
  215. len, urb->actual_length);
  216. return;
  217. }
  218. if (!ieee802154_is_valid_psdu_len(len)) {
  219. dev_dbg(&usb_dev->dev, "atusb_in: frame corrupted\n");
  220. return;
  221. }
  222. lqi = skb->data[len + 1];
  223. dev_dbg(&usb_dev->dev, "atusb_in: rx len %d lqi 0x%02x\n", len, lqi);
  224. skb_pull(skb, 1); /* remove PHR */
  225. skb_trim(skb, len); /* get payload only */
  226. ieee802154_rx_irqsafe(atusb->hw, skb, lqi);
  227. urb->context = NULL; /* skb is gone */
  228. }
  229. static void atusb_in(struct urb *urb)
  230. {
  231. struct usb_device *usb_dev = urb->dev;
  232. struct sk_buff *skb = urb->context;
  233. struct atusb *atusb = SKB_ATUSB(skb);
  234. dev_dbg(&usb_dev->dev, "atusb_in: status %d len %d\n",
  235. urb->status, urb->actual_length);
  236. if (urb->status) {
  237. if (urb->status == -ENOENT) { /* being killed */
  238. kfree_skb(skb);
  239. urb->context = NULL;
  240. return;
  241. }
  242. dev_dbg(&usb_dev->dev, "atusb_in: URB error %d\n", urb->status);
  243. } else {
  244. atusb_in_good(urb);
  245. }
  246. usb_anchor_urb(urb, &atusb->idle_urbs);
  247. if (!atusb->shutdown)
  248. schedule_delayed_work(&atusb->work, 0);
  249. }
  250. /* ----- URB allocation/deallocation --------------------------------------- */
  251. static void atusb_free_urbs(struct atusb *atusb)
  252. {
  253. struct urb *urb;
  254. while (1) {
  255. urb = usb_get_from_anchor(&atusb->idle_urbs);
  256. if (!urb)
  257. break;
  258. if (urb->context)
  259. kfree_skb(urb->context);
  260. usb_free_urb(urb);
  261. }
  262. }
  263. static int atusb_alloc_urbs(struct atusb *atusb, int n)
  264. {
  265. struct urb *urb;
  266. while (n) {
  267. urb = usb_alloc_urb(0, GFP_KERNEL);
  268. if (!urb) {
  269. atusb_free_urbs(atusb);
  270. return -ENOMEM;
  271. }
  272. usb_anchor_urb(urb, &atusb->idle_urbs);
  273. n--;
  274. }
  275. return 0;
  276. }
  277. /* ----- IEEE 802.15.4 interface operations -------------------------------- */
  278. static void atusb_xmit_complete(struct urb *urb)
  279. {
  280. dev_dbg(&urb->dev->dev, "atusb_xmit urb completed");
  281. }
  282. static int atusb_xmit(struct ieee802154_hw *hw, struct sk_buff *skb)
  283. {
  284. struct atusb *atusb = hw->priv;
  285. struct usb_device *usb_dev = atusb->usb_dev;
  286. int ret;
  287. dev_dbg(&usb_dev->dev, "atusb_xmit (%d)\n", skb->len);
  288. atusb->tx_skb = skb;
  289. atusb->tx_ack_seq++;
  290. atusb->tx_dr.wIndex = cpu_to_le16(atusb->tx_ack_seq);
  291. atusb->tx_dr.wLength = cpu_to_le16(skb->len);
  292. usb_fill_control_urb(atusb->tx_urb, usb_dev,
  293. usb_sndctrlpipe(usb_dev, 0),
  294. (unsigned char *)&atusb->tx_dr, skb->data,
  295. skb->len, atusb_xmit_complete, NULL);
  296. ret = usb_submit_urb(atusb->tx_urb, GFP_ATOMIC);
  297. dev_dbg(&usb_dev->dev, "atusb_xmit done (%d)\n", ret);
  298. return ret;
  299. }
  300. static int atusb_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
  301. {
  302. struct atusb *atusb = hw->priv;
  303. int ret;
  304. /* This implicitly sets the CCA (Clear Channel Assessment) mode to 0,
  305. * "Mode 3a, Carrier sense OR energy above threshold".
  306. * We should probably make this configurable. @@@
  307. */
  308. ret = atusb_write_reg(atusb, RG_PHY_CC_CCA, channel);
  309. if (ret < 0)
  310. return ret;
  311. msleep(1); /* @@@ ugly synchronization */
  312. return 0;
  313. }
  314. static int atusb_ed(struct ieee802154_hw *hw, u8 *level)
  315. {
  316. BUG_ON(!level);
  317. *level = 0xbe;
  318. return 0;
  319. }
  320. static int atusb_set_hw_addr_filt(struct ieee802154_hw *hw,
  321. struct ieee802154_hw_addr_filt *filt,
  322. unsigned long changed)
  323. {
  324. struct atusb *atusb = hw->priv;
  325. struct device *dev = &atusb->usb_dev->dev;
  326. if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
  327. u16 addr = le16_to_cpu(filt->short_addr);
  328. dev_vdbg(dev, "atusb_set_hw_addr_filt called for saddr\n");
  329. atusb_write_reg(atusb, RG_SHORT_ADDR_0, addr);
  330. atusb_write_reg(atusb, RG_SHORT_ADDR_1, addr >> 8);
  331. }
  332. if (changed & IEEE802154_AFILT_PANID_CHANGED) {
  333. u16 pan = le16_to_cpu(filt->pan_id);
  334. dev_vdbg(dev, "atusb_set_hw_addr_filt called for pan id\n");
  335. atusb_write_reg(atusb, RG_PAN_ID_0, pan);
  336. atusb_write_reg(atusb, RG_PAN_ID_1, pan >> 8);
  337. }
  338. if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
  339. u8 i, addr[IEEE802154_EXTENDED_ADDR_LEN];
  340. memcpy(addr, &filt->ieee_addr, IEEE802154_EXTENDED_ADDR_LEN);
  341. dev_vdbg(dev, "atusb_set_hw_addr_filt called for IEEE addr\n");
  342. for (i = 0; i < 8; i++)
  343. atusb_write_reg(atusb, RG_IEEE_ADDR_0 + i, addr[i]);
  344. }
  345. if (changed & IEEE802154_AFILT_PANC_CHANGED) {
  346. dev_vdbg(dev,
  347. "atusb_set_hw_addr_filt called for panc change\n");
  348. if (filt->pan_coord)
  349. atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 1);
  350. else
  351. atusb_write_subreg(atusb, SR_AACK_I_AM_COORD, 0);
  352. }
  353. return atusb_get_and_clear_error(atusb);
  354. }
  355. static int atusb_start(struct ieee802154_hw *hw)
  356. {
  357. struct atusb *atusb = hw->priv;
  358. struct usb_device *usb_dev = atusb->usb_dev;
  359. int ret;
  360. dev_dbg(&usb_dev->dev, "atusb_start\n");
  361. schedule_delayed_work(&atusb->work, 0);
  362. atusb_command(atusb, ATUSB_RX_MODE, 1);
  363. ret = atusb_get_and_clear_error(atusb);
  364. if (ret < 0)
  365. usb_kill_anchored_urbs(&atusb->idle_urbs);
  366. return ret;
  367. }
  368. static void atusb_stop(struct ieee802154_hw *hw)
  369. {
  370. struct atusb *atusb = hw->priv;
  371. struct usb_device *usb_dev = atusb->usb_dev;
  372. dev_dbg(&usb_dev->dev, "atusb_stop\n");
  373. usb_kill_anchored_urbs(&atusb->idle_urbs);
  374. atusb_command(atusb, ATUSB_RX_MODE, 0);
  375. atusb_get_and_clear_error(atusb);
  376. }
  377. #define ATUSB_MAX_TX_POWERS 0xF
  378. static const s32 atusb_powers[ATUSB_MAX_TX_POWERS + 1] = {
  379. 300, 280, 230, 180, 130, 70, 0, -100, -200, -300, -400, -500, -700,
  380. -900, -1200, -1700,
  381. };
  382. static int
  383. atusb_set_txpower(struct ieee802154_hw *hw, s32 mbm)
  384. {
  385. struct atusb *atusb = hw->priv;
  386. u32 i;
  387. for (i = 0; i < hw->phy->supported.tx_powers_size; i++) {
  388. if (hw->phy->supported.tx_powers[i] == mbm)
  389. return atusb_write_subreg(atusb, SR_TX_PWR_23X, i);
  390. }
  391. return -EINVAL;
  392. }
  393. static int
  394. atusb_set_promiscuous_mode(struct ieee802154_hw *hw, const bool on)
  395. {
  396. struct atusb *atusb = hw->priv;
  397. int ret;
  398. if (on) {
  399. ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 1);
  400. if (ret < 0)
  401. return ret;
  402. ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 1);
  403. if (ret < 0)
  404. return ret;
  405. } else {
  406. ret = atusb_write_subreg(atusb, SR_AACK_PROM_MODE, 0);
  407. if (ret < 0)
  408. return ret;
  409. ret = atusb_write_subreg(atusb, SR_AACK_DIS_ACK, 0);
  410. if (ret < 0)
  411. return ret;
  412. }
  413. return 0;
  414. }
  415. static struct ieee802154_ops atusb_ops = {
  416. .owner = THIS_MODULE,
  417. .xmit_async = atusb_xmit,
  418. .ed = atusb_ed,
  419. .set_channel = atusb_channel,
  420. .start = atusb_start,
  421. .stop = atusb_stop,
  422. .set_hw_addr_filt = atusb_set_hw_addr_filt,
  423. .set_txpower = atusb_set_txpower,
  424. .set_promiscuous_mode = atusb_set_promiscuous_mode,
  425. };
  426. /* ----- Firmware and chip version information ----------------------------- */
  427. static int atusb_get_and_show_revision(struct atusb *atusb)
  428. {
  429. struct usb_device *usb_dev = atusb->usb_dev;
  430. unsigned char buffer[3];
  431. int ret;
  432. /* Get a couple of the ATMega Firmware values */
  433. ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
  434. ATUSB_ID, ATUSB_REQ_FROM_DEV, 0, 0,
  435. buffer, 3, 1000);
  436. if (ret >= 0)
  437. dev_info(&usb_dev->dev,
  438. "Firmware: major: %u, minor: %u, hardware type: %u\n",
  439. buffer[0], buffer[1], buffer[2]);
  440. if (buffer[0] == 0 && buffer[1] < 2) {
  441. dev_info(&usb_dev->dev,
  442. "Firmware version (%u.%u) is predates our first public release.",
  443. buffer[0], buffer[1]);
  444. dev_info(&usb_dev->dev, "Please update to version 0.2 or newer");
  445. }
  446. return ret;
  447. }
  448. static int atusb_get_and_show_build(struct atusb *atusb)
  449. {
  450. struct usb_device *usb_dev = atusb->usb_dev;
  451. char build[ATUSB_BUILD_SIZE + 1];
  452. int ret;
  453. ret = atusb_control_msg(atusb, usb_rcvctrlpipe(usb_dev, 0),
  454. ATUSB_BUILD, ATUSB_REQ_FROM_DEV, 0, 0,
  455. build, ATUSB_BUILD_SIZE, 1000);
  456. if (ret >= 0) {
  457. build[ret] = 0;
  458. dev_info(&usb_dev->dev, "Firmware: build %s\n", build);
  459. }
  460. return ret;
  461. }
  462. static int atusb_get_and_show_chip(struct atusb *atusb)
  463. {
  464. struct usb_device *usb_dev = atusb->usb_dev;
  465. uint8_t man_id_0, man_id_1, part_num, version_num;
  466. man_id_0 = atusb_read_reg(atusb, RG_MAN_ID_0);
  467. man_id_1 = atusb_read_reg(atusb, RG_MAN_ID_1);
  468. part_num = atusb_read_reg(atusb, RG_PART_NUM);
  469. version_num = atusb_read_reg(atusb, RG_VERSION_NUM);
  470. if (atusb->err)
  471. return atusb->err;
  472. if ((man_id_1 << 8 | man_id_0) != ATUSB_JEDEC_ATMEL) {
  473. dev_err(&usb_dev->dev,
  474. "non-Atmel transceiver xxxx%02x%02x\n",
  475. man_id_1, man_id_0);
  476. goto fail;
  477. }
  478. if (part_num != 3 && part_num != 2) {
  479. dev_err(&usb_dev->dev,
  480. "unexpected transceiver, part 0x%02x version 0x%02x\n",
  481. part_num, version_num);
  482. goto fail;
  483. }
  484. dev_info(&usb_dev->dev, "ATUSB: AT86RF231 version %d\n", version_num);
  485. return 0;
  486. fail:
  487. atusb->err = -ENODEV;
  488. return -ENODEV;
  489. }
  490. /* ----- Setup ------------------------------------------------------------- */
  491. static int atusb_probe(struct usb_interface *interface,
  492. const struct usb_device_id *id)
  493. {
  494. struct usb_device *usb_dev = interface_to_usbdev(interface);
  495. struct ieee802154_hw *hw;
  496. struct atusb *atusb = NULL;
  497. int ret = -ENOMEM;
  498. hw = ieee802154_alloc_hw(sizeof(struct atusb), &atusb_ops);
  499. if (!hw)
  500. return -ENOMEM;
  501. atusb = hw->priv;
  502. atusb->hw = hw;
  503. atusb->usb_dev = usb_get_dev(usb_dev);
  504. usb_set_intfdata(interface, atusb);
  505. atusb->shutdown = 0;
  506. atusb->err = 0;
  507. INIT_DELAYED_WORK(&atusb->work, atusb_work_urbs);
  508. init_usb_anchor(&atusb->idle_urbs);
  509. init_usb_anchor(&atusb->rx_urbs);
  510. if (atusb_alloc_urbs(atusb, ATUSB_NUM_RX_URBS))
  511. goto fail;
  512. atusb->tx_dr.bRequestType = ATUSB_REQ_TO_DEV;
  513. atusb->tx_dr.bRequest = ATUSB_TX;
  514. atusb->tx_dr.wValue = cpu_to_le16(0);
  515. atusb->tx_urb = usb_alloc_urb(0, GFP_ATOMIC);
  516. if (!atusb->tx_urb)
  517. goto fail;
  518. hw->parent = &usb_dev->dev;
  519. hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_AFILT |
  520. IEEE802154_HW_PROMISCUOUS;
  521. hw->phy->flags = WPAN_PHY_FLAG_TXPOWER;
  522. hw->phy->current_page = 0;
  523. hw->phy->current_channel = 11; /* reset default */
  524. hw->phy->supported.channels[0] = 0x7FFF800;
  525. hw->phy->supported.tx_powers = atusb_powers;
  526. hw->phy->supported.tx_powers_size = ARRAY_SIZE(atusb_powers);
  527. hw->phy->transmit_power = hw->phy->supported.tx_powers[0];
  528. ieee802154_random_extended_addr(&hw->phy->perm_extended_addr);
  529. atusb_command(atusb, ATUSB_RF_RESET, 0);
  530. atusb_get_and_show_chip(atusb);
  531. atusb_get_and_show_revision(atusb);
  532. atusb_get_and_show_build(atusb);
  533. ret = atusb_get_and_clear_error(atusb);
  534. if (ret) {
  535. dev_err(&atusb->usb_dev->dev,
  536. "%s: initialization failed, error = %d\n",
  537. __func__, ret);
  538. goto fail;
  539. }
  540. ret = ieee802154_register_hw(hw);
  541. if (ret)
  542. goto fail;
  543. /* If we just powered on, we're now in P_ON and need to enter TRX_OFF
  544. * explicitly. Any resets after that will send us straight to TRX_OFF,
  545. * making the command below redundant.
  546. */
  547. atusb_write_reg(atusb, RG_TRX_STATE, STATE_FORCE_TRX_OFF);
  548. msleep(1); /* reset => TRX_OFF, tTR13 = 37 us */
  549. #if 0
  550. /* Calculating the maximum time available to empty the frame buffer
  551. * on reception:
  552. *
  553. * According to [1], the inter-frame gap is
  554. * R * 20 * 16 us + 128 us
  555. * where R is a random number from 0 to 7. Furthermore, we have 20 bit
  556. * times (80 us at 250 kbps) of SHR of the next frame before the
  557. * transceiver begins storing data in the frame buffer.
  558. *
  559. * This yields a minimum time of 208 us between the last data of a
  560. * frame and the first data of the next frame. This time is further
  561. * reduced by interrupt latency in the atusb firmware.
  562. *
  563. * atusb currently needs about 500 us to retrieve a maximum-sized
  564. * frame. We therefore have to allow reception of a new frame to begin
  565. * while we retrieve the previous frame.
  566. *
  567. * [1] "JN-AN-1035 Calculating data rates in an IEEE 802.15.4-based
  568. * network", Jennic 2006.
  569. * http://www.jennic.com/download_file.php?supportFile=JN-AN-1035%20Calculating%20802-15-4%20Data%20Rates-1v0.pdf
  570. */
  571. atusb_write_subreg(atusb, SR_RX_SAFE_MODE, 1);
  572. #endif
  573. atusb_write_reg(atusb, RG_IRQ_MASK, 0xff);
  574. ret = atusb_get_and_clear_error(atusb);
  575. if (!ret)
  576. return 0;
  577. dev_err(&atusb->usb_dev->dev,
  578. "%s: setup failed, error = %d\n",
  579. __func__, ret);
  580. ieee802154_unregister_hw(hw);
  581. fail:
  582. atusb_free_urbs(atusb);
  583. usb_kill_urb(atusb->tx_urb);
  584. usb_free_urb(atusb->tx_urb);
  585. usb_put_dev(usb_dev);
  586. ieee802154_free_hw(hw);
  587. return ret;
  588. }
  589. static void atusb_disconnect(struct usb_interface *interface)
  590. {
  591. struct atusb *atusb = usb_get_intfdata(interface);
  592. dev_dbg(&atusb->usb_dev->dev, "atusb_disconnect\n");
  593. atusb->shutdown = 1;
  594. cancel_delayed_work_sync(&atusb->work);
  595. usb_kill_anchored_urbs(&atusb->rx_urbs);
  596. atusb_free_urbs(atusb);
  597. usb_kill_urb(atusb->tx_urb);
  598. usb_free_urb(atusb->tx_urb);
  599. ieee802154_unregister_hw(atusb->hw);
  600. ieee802154_free_hw(atusb->hw);
  601. usb_set_intfdata(interface, NULL);
  602. usb_put_dev(atusb->usb_dev);
  603. pr_debug("atusb_disconnect done\n");
  604. }
  605. /* The devices we work with */
  606. static const struct usb_device_id atusb_device_table[] = {
  607. {
  608. .match_flags = USB_DEVICE_ID_MATCH_DEVICE |
  609. USB_DEVICE_ID_MATCH_INT_INFO,
  610. .idVendor = ATUSB_VENDOR_ID,
  611. .idProduct = ATUSB_PRODUCT_ID,
  612. .bInterfaceClass = USB_CLASS_VENDOR_SPEC
  613. },
  614. /* end with null element */
  615. {}
  616. };
  617. MODULE_DEVICE_TABLE(usb, atusb_device_table);
  618. static struct usb_driver atusb_driver = {
  619. .name = "atusb",
  620. .probe = atusb_probe,
  621. .disconnect = atusb_disconnect,
  622. .id_table = atusb_device_table,
  623. };
  624. module_usb_driver(atusb_driver);
  625. MODULE_AUTHOR("Alexander Aring <alex.aring@gmail.com>");
  626. MODULE_AUTHOR("Richard Sharpe <realrichardsharpe@gmail.com>");
  627. MODULE_AUTHOR("Stefan Schmidt <stefan@datenfreihafen.org>");
  628. MODULE_AUTHOR("Werner Almesberger <werner@almesberger.net>");
  629. MODULE_DESCRIPTION("ATUSB IEEE 802.15.4 Driver");
  630. MODULE_LICENSE("GPL");