stir4200.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158
  1. /*****************************************************************************
  2. *
  3. * Filename: stir4200.c
  4. * Version: 0.4
  5. * Description: Irda SigmaTel USB Dongle
  6. * Status: Experimental
  7. * Author: Stephen Hemminger <shemminger@osdl.org>
  8. *
  9. * Based on earlier driver by Paul Stewart <stewart@parc.com>
  10. *
  11. * Copyright (C) 2000, Roman Weissgaerber <weissg@vienna.at>
  12. * Copyright (C) 2001, Dag Brattli <dag@brattli.net>
  13. * Copyright (C) 2001, Jean Tourrilhes <jt@hpl.hp.com>
  14. * Copyright (C) 2004, Stephen Hemminger <shemminger@osdl.org>
  15. *
  16. * This program is free software; you can redistribute it and/or modify
  17. * it under the terms of the GNU General Public License as published by
  18. * the Free Software Foundation; either version 2 of the License.
  19. *
  20. * This program is distributed in the hope that it will be useful,
  21. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  23. * GNU General Public License for more details.
  24. *
  25. * You should have received a copy of the GNU General Public License
  26. * along with this program; if not, write to the Free Software
  27. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  28. *
  29. *****************************************************************************/
  30. /*
  31. * This dongle does no framing, and requires polling to receive the
  32. * data. The STIr4200 has bulk in and out endpoints just like
  33. * usr-irda devices, but the data it sends and receives is raw; like
  34. * irtty, it needs to call the wrap and unwrap functions to add and
  35. * remove SOF/BOF and escape characters to/from the frame.
  36. */
  37. #include <linux/module.h>
  38. #include <linux/moduleparam.h>
  39. #include <linux/kernel.h>
  40. #include <linux/types.h>
  41. #include <linux/init.h>
  42. #include <linux/time.h>
  43. #include <linux/skbuff.h>
  44. #include <linux/netdevice.h>
  45. #include <linux/slab.h>
  46. #include <linux/delay.h>
  47. #include <linux/usb.h>
  48. #include <linux/crc32.h>
  49. #include <linux/kthread.h>
  50. #include <linux/freezer.h>
  51. #include <net/irda/irda.h>
  52. #include <net/irda/irda_device.h>
  53. #include <net/irda/wrapper.h>
  54. #include <net/irda/crc.h>
  55. #include <asm/byteorder.h>
  56. #include <asm/unaligned.h>
  57. MODULE_AUTHOR("Stephen Hemminger <shemminger@linux-foundation.org>");
  58. MODULE_DESCRIPTION("IrDA-USB Dongle Driver for SigmaTel STIr4200");
  59. MODULE_LICENSE("GPL");
  60. static int qos_mtt_bits = 0x07; /* 1 ms or more */
  61. module_param(qos_mtt_bits, int, 0);
  62. MODULE_PARM_DESC(qos_mtt_bits, "Minimum Turn Time");
  63. static int rx_sensitivity = 1; /* FIR 0..4, SIR 0..6 */
  64. module_param(rx_sensitivity, int, 0);
  65. MODULE_PARM_DESC(rx_sensitivity, "Set Receiver sensitivity (0-6, 0 is most sensitive)");
  66. static int tx_power = 0; /* 0 = highest ... 3 = lowest */
  67. module_param(tx_power, int, 0);
  68. MODULE_PARM_DESC(tx_power, "Set Transmitter power (0-3, 0 is highest power)");
  69. #define STIR_IRDA_HEADER 4
  70. #define CTRL_TIMEOUT 100 /* milliseconds */
  71. #define TRANSMIT_TIMEOUT 200 /* milliseconds */
  72. #define STIR_FIFO_SIZE 4096
  73. #define FIFO_REGS_SIZE 3
  74. enum FirChars {
  75. FIR_CE = 0x7d,
  76. FIR_XBOF = 0x7f,
  77. FIR_EOF = 0x7e,
  78. };
  79. enum StirRequests {
  80. REQ_WRITE_REG = 0x00,
  81. REQ_READ_REG = 0x01,
  82. REQ_READ_ROM = 0x02,
  83. REQ_WRITE_SINGLE = 0x03,
  84. };
  85. /* Register offsets */
  86. enum StirRegs {
  87. REG_RSVD=0,
  88. REG_MODE,
  89. REG_PDCLK,
  90. REG_CTRL1,
  91. REG_CTRL2,
  92. REG_FIFOCTL,
  93. REG_FIFOLSB,
  94. REG_FIFOMSB,
  95. REG_DPLL,
  96. REG_IRDIG,
  97. REG_TEST=15,
  98. };
  99. enum StirModeMask {
  100. MODE_FIR = 0x80,
  101. MODE_SIR = 0x20,
  102. MODE_ASK = 0x10,
  103. MODE_FASTRX = 0x08,
  104. MODE_FFRSTEN = 0x04,
  105. MODE_NRESET = 0x02,
  106. MODE_2400 = 0x01,
  107. };
  108. enum StirPdclkMask {
  109. PDCLK_4000000 = 0x02,
  110. PDCLK_115200 = 0x09,
  111. PDCLK_57600 = 0x13,
  112. PDCLK_38400 = 0x1D,
  113. PDCLK_19200 = 0x3B,
  114. PDCLK_9600 = 0x77,
  115. PDCLK_2400 = 0xDF,
  116. };
  117. enum StirCtrl1Mask {
  118. CTRL1_SDMODE = 0x80,
  119. CTRL1_RXSLOW = 0x40,
  120. CTRL1_TXPWD = 0x10,
  121. CTRL1_RXPWD = 0x08,
  122. CTRL1_SRESET = 0x01,
  123. };
  124. enum StirCtrl2Mask {
  125. CTRL2_SPWIDTH = 0x08,
  126. CTRL2_REVID = 0x03,
  127. };
  128. enum StirFifoCtlMask {
  129. FIFOCTL_DIR = 0x10,
  130. FIFOCTL_CLR = 0x08,
  131. FIFOCTL_EMPTY = 0x04,
  132. };
  133. enum StirDiagMask {
  134. IRDIG_RXHIGH = 0x80,
  135. IRDIG_RXLOW = 0x40,
  136. };
  137. enum StirTestMask {
  138. TEST_PLLDOWN = 0x80,
  139. TEST_LOOPIR = 0x40,
  140. TEST_LOOPUSB = 0x20,
  141. TEST_TSTENA = 0x10,
  142. TEST_TSTOSC = 0x0F,
  143. };
  144. struct stir_cb {
  145. struct usb_device *usbdev; /* init: probe_irda */
  146. struct net_device *netdev; /* network layer */
  147. struct irlap_cb *irlap; /* The link layer we are binded to */
  148. struct net_device_stats stats; /* network statistics */
  149. struct qos_info qos;
  150. unsigned speed; /* Current speed */
  151. struct task_struct *thread; /* transmit thread */
  152. struct sk_buff *tx_pending;
  153. void *io_buf; /* transmit/receive buffer */
  154. __u8 *fifo_status;
  155. iobuff_t rx_buff; /* receive unwrap state machine */
  156. struct timeval rx_time;
  157. int receiving;
  158. struct urb *rx_urb;
  159. };
  160. /* These are the currently known USB ids */
  161. static struct usb_device_id dongles[] = {
  162. /* SigmaTel, Inc, STIr4200 IrDA/USB Bridge */
  163. { USB_DEVICE(0x066f, 0x4200) },
  164. { }
  165. };
  166. MODULE_DEVICE_TABLE(usb, dongles);
  167. /* Send control message to set dongle register */
  168. static int write_reg(struct stir_cb *stir, __u16 reg, __u8 value)
  169. {
  170. struct usb_device *dev = stir->usbdev;
  171. pr_debug("%s: write reg %d = 0x%x\n",
  172. stir->netdev->name, reg, value);
  173. return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  174. REQ_WRITE_SINGLE,
  175. USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE,
  176. value, reg, NULL, 0,
  177. CTRL_TIMEOUT);
  178. }
  179. /* Send control message to read multiple registers */
  180. static inline int read_reg(struct stir_cb *stir, __u16 reg,
  181. __u8 *data, __u16 count)
  182. {
  183. struct usb_device *dev = stir->usbdev;
  184. return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  185. REQ_READ_REG,
  186. USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  187. 0, reg, data, count,
  188. CTRL_TIMEOUT);
  189. }
  190. static inline int isfir(u32 speed)
  191. {
  192. return (speed == 4000000);
  193. }
  194. /*
  195. * Prepare a FIR IrDA frame for transmission to the USB dongle. The
  196. * FIR transmit frame is documented in the datasheet. It consists of
  197. * a two byte 0x55 0xAA sequence, two little-endian length bytes, a
  198. * sequence of exactly 16 XBOF bytes of 0x7E, two BOF bytes of 0x7E,
  199. * then the data escaped as follows:
  200. *
  201. * 0x7D -> 0x7D 0x5D
  202. * 0x7E -> 0x7D 0x5E
  203. * 0x7F -> 0x7D 0x5F
  204. *
  205. * Then, 4 bytes of little endian (stuffed) FCS follow, then two
  206. * trailing EOF bytes of 0x7E.
  207. */
  208. static inline __u8 *stuff_fir(__u8 *p, __u8 c)
  209. {
  210. switch(c) {
  211. case 0x7d:
  212. case 0x7e:
  213. case 0x7f:
  214. *p++ = 0x7d;
  215. c ^= IRDA_TRANS;
  216. /* fall through */
  217. default:
  218. *p++ = c;
  219. }
  220. return p;
  221. }
  222. /* Take raw data in skb and put it wrapped into buf */
  223. static unsigned wrap_fir_skb(const struct sk_buff *skb, __u8 *buf)
  224. {
  225. __u8 *ptr = buf;
  226. __u32 fcs = ~(crc32_le(~0, skb->data, skb->len));
  227. __u16 wraplen;
  228. int i;
  229. /* Header */
  230. buf[0] = 0x55;
  231. buf[1] = 0xAA;
  232. ptr = buf + STIR_IRDA_HEADER;
  233. memset(ptr, 0x7f, 16);
  234. ptr += 16;
  235. /* BOF */
  236. *ptr++ = 0x7e;
  237. *ptr++ = 0x7e;
  238. /* Address / Control / Information */
  239. for (i = 0; i < skb->len; i++)
  240. ptr = stuff_fir(ptr, skb->data[i]);
  241. /* FCS */
  242. ptr = stuff_fir(ptr, fcs & 0xff);
  243. ptr = stuff_fir(ptr, (fcs >> 8) & 0xff);
  244. ptr = stuff_fir(ptr, (fcs >> 16) & 0xff);
  245. ptr = stuff_fir(ptr, (fcs >> 24) & 0xff);
  246. /* EOFs */
  247. *ptr++ = 0x7e;
  248. *ptr++ = 0x7e;
  249. /* Total length, minus the header */
  250. wraplen = (ptr - buf) - STIR_IRDA_HEADER;
  251. buf[2] = wraplen & 0xff;
  252. buf[3] = (wraplen >> 8) & 0xff;
  253. return wraplen + STIR_IRDA_HEADER;
  254. }
  255. static unsigned wrap_sir_skb(struct sk_buff *skb, __u8 *buf)
  256. {
  257. __u16 wraplen;
  258. wraplen = async_wrap_skb(skb, buf + STIR_IRDA_HEADER,
  259. STIR_FIFO_SIZE - STIR_IRDA_HEADER);
  260. buf[0] = 0x55;
  261. buf[1] = 0xAA;
  262. buf[2] = wraplen & 0xff;
  263. buf[3] = (wraplen >> 8) & 0xff;
  264. return wraplen + STIR_IRDA_HEADER;
  265. }
  266. /*
  267. * Frame is fully formed in the rx_buff so check crc
  268. * and pass up to irlap
  269. * setup for next receive
  270. */
  271. static void fir_eof(struct stir_cb *stir)
  272. {
  273. iobuff_t *rx_buff = &stir->rx_buff;
  274. int len = rx_buff->len - 4;
  275. struct sk_buff *skb, *nskb;
  276. __u32 fcs;
  277. if (unlikely(len <= 0)) {
  278. pr_debug("%s: short frame len %d\n",
  279. stir->netdev->name, len);
  280. ++stir->stats.rx_errors;
  281. ++stir->stats.rx_length_errors;
  282. return;
  283. }
  284. fcs = ~(crc32_le(~0, rx_buff->data, len));
  285. if (fcs != get_unaligned_le32(rx_buff->data + len)) {
  286. pr_debug("crc error calc 0x%x len %d\n", fcs, len);
  287. stir->stats.rx_errors++;
  288. stir->stats.rx_crc_errors++;
  289. return;
  290. }
  291. /* if frame is short then just copy it */
  292. if (len < IRDA_RX_COPY_THRESHOLD) {
  293. nskb = dev_alloc_skb(len + 1);
  294. if (unlikely(!nskb)) {
  295. ++stir->stats.rx_dropped;
  296. return;
  297. }
  298. skb_reserve(nskb, 1);
  299. skb = nskb;
  300. skb_copy_to_linear_data(nskb, rx_buff->data, len);
  301. } else {
  302. nskb = dev_alloc_skb(rx_buff->truesize);
  303. if (unlikely(!nskb)) {
  304. ++stir->stats.rx_dropped;
  305. return;
  306. }
  307. skb_reserve(nskb, 1);
  308. skb = rx_buff->skb;
  309. rx_buff->skb = nskb;
  310. rx_buff->head = nskb->data;
  311. }
  312. skb_put(skb, len);
  313. skb_reset_mac_header(skb);
  314. skb->protocol = htons(ETH_P_IRDA);
  315. skb->dev = stir->netdev;
  316. netif_rx(skb);
  317. stir->stats.rx_packets++;
  318. stir->stats.rx_bytes += len;
  319. rx_buff->data = rx_buff->head;
  320. rx_buff->len = 0;
  321. }
  322. /* Unwrap FIR stuffed data and bump it to IrLAP */
  323. static void stir_fir_chars(struct stir_cb *stir,
  324. const __u8 *bytes, int len)
  325. {
  326. iobuff_t *rx_buff = &stir->rx_buff;
  327. int i;
  328. for (i = 0; i < len; i++) {
  329. __u8 byte = bytes[i];
  330. switch(rx_buff->state) {
  331. case OUTSIDE_FRAME:
  332. /* ignore garbage till start of frame */
  333. if (unlikely(byte != FIR_EOF))
  334. continue;
  335. /* Now receiving frame */
  336. rx_buff->state = BEGIN_FRAME;
  337. /* Time to initialize receive buffer */
  338. rx_buff->data = rx_buff->head;
  339. rx_buff->len = 0;
  340. continue;
  341. case LINK_ESCAPE:
  342. if (byte == FIR_EOF) {
  343. pr_debug("%s: got EOF after escape\n",
  344. stir->netdev->name);
  345. goto frame_error;
  346. }
  347. rx_buff->state = INSIDE_FRAME;
  348. byte ^= IRDA_TRANS;
  349. break;
  350. case BEGIN_FRAME:
  351. /* ignore multiple BOF/EOF */
  352. if (byte == FIR_EOF)
  353. continue;
  354. rx_buff->state = INSIDE_FRAME;
  355. rx_buff->in_frame = TRUE;
  356. /* fall through */
  357. case INSIDE_FRAME:
  358. switch(byte) {
  359. case FIR_CE:
  360. rx_buff->state = LINK_ESCAPE;
  361. continue;
  362. case FIR_XBOF:
  363. /* 0x7f is not used in this framing */
  364. pr_debug("%s: got XBOF without escape\n",
  365. stir->netdev->name);
  366. goto frame_error;
  367. case FIR_EOF:
  368. rx_buff->state = OUTSIDE_FRAME;
  369. rx_buff->in_frame = FALSE;
  370. fir_eof(stir);
  371. continue;
  372. }
  373. break;
  374. }
  375. /* add byte to rx buffer */
  376. if (unlikely(rx_buff->len >= rx_buff->truesize)) {
  377. pr_debug("%s: fir frame exceeds %d\n",
  378. stir->netdev->name, rx_buff->truesize);
  379. ++stir->stats.rx_over_errors;
  380. goto error_recovery;
  381. }
  382. rx_buff->data[rx_buff->len++] = byte;
  383. continue;
  384. frame_error:
  385. ++stir->stats.rx_frame_errors;
  386. error_recovery:
  387. ++stir->stats.rx_errors;
  388. rx_buff->state = OUTSIDE_FRAME;
  389. rx_buff->in_frame = FALSE;
  390. }
  391. }
  392. /* Unwrap SIR stuffed data and bump it up to IrLAP */
  393. static void stir_sir_chars(struct stir_cb *stir,
  394. const __u8 *bytes, int len)
  395. {
  396. int i;
  397. for (i = 0; i < len; i++)
  398. async_unwrap_char(stir->netdev, &stir->stats,
  399. &stir->rx_buff, bytes[i]);
  400. }
  401. static inline void unwrap_chars(struct stir_cb *stir,
  402. const __u8 *bytes, int length)
  403. {
  404. if (isfir(stir->speed))
  405. stir_fir_chars(stir, bytes, length);
  406. else
  407. stir_sir_chars(stir, bytes, length);
  408. }
  409. /* Mode parameters for each speed */
  410. static const struct {
  411. unsigned speed;
  412. __u8 pdclk;
  413. } stir_modes[] = {
  414. { 2400, PDCLK_2400 },
  415. { 9600, PDCLK_9600 },
  416. { 19200, PDCLK_19200 },
  417. { 38400, PDCLK_38400 },
  418. { 57600, PDCLK_57600 },
  419. { 115200, PDCLK_115200 },
  420. { 4000000, PDCLK_4000000 },
  421. };
  422. /*
  423. * Setup chip for speed.
  424. * Called at startup to initialize the chip
  425. * and on speed changes.
  426. *
  427. * Note: Write multiple registers doesn't appear to work
  428. */
  429. static int change_speed(struct stir_cb *stir, unsigned speed)
  430. {
  431. int i, err;
  432. __u8 mode;
  433. for (i = 0; i < ARRAY_SIZE(stir_modes); ++i) {
  434. if (speed == stir_modes[i].speed)
  435. goto found;
  436. }
  437. dev_warn(&stir->netdev->dev, "invalid speed %d\n", speed);
  438. return -EINVAL;
  439. found:
  440. pr_debug("speed change from %d to %d\n", stir->speed, speed);
  441. /* Reset modulator */
  442. err = write_reg(stir, REG_CTRL1, CTRL1_SRESET);
  443. if (err)
  444. goto out;
  445. /* Undocumented magic to tweak the DPLL */
  446. err = write_reg(stir, REG_DPLL, 0x15);
  447. if (err)
  448. goto out;
  449. /* Set clock */
  450. err = write_reg(stir, REG_PDCLK, stir_modes[i].pdclk);
  451. if (err)
  452. goto out;
  453. mode = MODE_NRESET | MODE_FASTRX;
  454. if (isfir(speed))
  455. mode |= MODE_FIR | MODE_FFRSTEN;
  456. else
  457. mode |= MODE_SIR;
  458. if (speed == 2400)
  459. mode |= MODE_2400;
  460. err = write_reg(stir, REG_MODE, mode);
  461. if (err)
  462. goto out;
  463. /* This resets TEMIC style transceiver if any. */
  464. err = write_reg(stir, REG_CTRL1,
  465. CTRL1_SDMODE | (tx_power & 3) << 1);
  466. if (err)
  467. goto out;
  468. err = write_reg(stir, REG_CTRL1, (tx_power & 3) << 1);
  469. if (err)
  470. goto out;
  471. /* Reset sensitivity */
  472. err = write_reg(stir, REG_CTRL2, (rx_sensitivity & 7) << 5);
  473. out:
  474. stir->speed = speed;
  475. return err;
  476. }
  477. /*
  478. * Called from net/core when new frame is available.
  479. */
  480. static int stir_hard_xmit(struct sk_buff *skb, struct net_device *netdev)
  481. {
  482. struct stir_cb *stir = netdev_priv(netdev);
  483. netif_stop_queue(netdev);
  484. /* the IRDA wrapping routines don't deal with non linear skb */
  485. SKB_LINEAR_ASSERT(skb);
  486. skb = xchg(&stir->tx_pending, skb);
  487. wake_up_process(stir->thread);
  488. /* this should never happen unless stop/wakeup problem */
  489. if (unlikely(skb)) {
  490. WARN_ON(1);
  491. dev_kfree_skb(skb);
  492. }
  493. return 0;
  494. }
  495. /*
  496. * Wait for the transmit FIFO to have space for next data
  497. *
  498. * If space < 0 then wait till FIFO completely drains.
  499. * FYI: can take up to 13 seconds at 2400baud.
  500. */
  501. static int fifo_txwait(struct stir_cb *stir, int space)
  502. {
  503. int err;
  504. unsigned long count, status;
  505. unsigned long prev_count = 0x1fff;
  506. /* Read FIFO status and count */
  507. for (;; prev_count = count) {
  508. err = read_reg(stir, REG_FIFOCTL, stir->fifo_status,
  509. FIFO_REGS_SIZE);
  510. if (unlikely(err != FIFO_REGS_SIZE)) {
  511. dev_warn(&stir->netdev->dev,
  512. "FIFO register read error: %d\n", err);
  513. return err;
  514. }
  515. status = stir->fifo_status[0];
  516. count = (unsigned)(stir->fifo_status[2] & 0x1f) << 8
  517. | stir->fifo_status[1];
  518. pr_debug("fifo status 0x%lx count %lu\n", status, count);
  519. /* is fifo receiving already, or empty */
  520. if (!(status & FIFOCTL_DIR)
  521. || (status & FIFOCTL_EMPTY))
  522. return 0;
  523. if (signal_pending(current))
  524. return -EINTR;
  525. /* shutting down? */
  526. if (!netif_running(stir->netdev)
  527. || !netif_device_present(stir->netdev))
  528. return -ESHUTDOWN;
  529. /* only waiting for some space */
  530. if (space >= 0 && STIR_FIFO_SIZE - 4 > space + count)
  531. return 0;
  532. /* queue confused */
  533. if (prev_count < count)
  534. break;
  535. /* estimate transfer time for remaining chars */
  536. msleep((count * 8000) / stir->speed);
  537. }
  538. err = write_reg(stir, REG_FIFOCTL, FIFOCTL_CLR);
  539. if (err)
  540. return err;
  541. err = write_reg(stir, REG_FIFOCTL, 0);
  542. if (err)
  543. return err;
  544. return 0;
  545. }
  546. /* Wait for turnaround delay before starting transmit. */
  547. static void turnaround_delay(const struct stir_cb *stir, long us)
  548. {
  549. long ticks;
  550. struct timeval now;
  551. if (us <= 0)
  552. return;
  553. do_gettimeofday(&now);
  554. if (now.tv_sec - stir->rx_time.tv_sec > 0)
  555. us -= USEC_PER_SEC;
  556. us -= now.tv_usec - stir->rx_time.tv_usec;
  557. if (us < 10)
  558. return;
  559. ticks = us / (1000000 / HZ);
  560. if (ticks > 0)
  561. schedule_timeout_interruptible(1 + ticks);
  562. else
  563. udelay(us);
  564. }
  565. /*
  566. * Start receiver by submitting a request to the receive pipe.
  567. * If nothing is available it will return after rx_interval.
  568. */
  569. static int receive_start(struct stir_cb *stir)
  570. {
  571. /* reset state */
  572. stir->receiving = 1;
  573. stir->rx_buff.in_frame = FALSE;
  574. stir->rx_buff.state = OUTSIDE_FRAME;
  575. stir->rx_urb->status = 0;
  576. return usb_submit_urb(stir->rx_urb, GFP_KERNEL);
  577. }
  578. /* Stop all pending receive Urb's */
  579. static void receive_stop(struct stir_cb *stir)
  580. {
  581. stir->receiving = 0;
  582. usb_kill_urb(stir->rx_urb);
  583. if (stir->rx_buff.in_frame)
  584. stir->stats.collisions++;
  585. }
  586. /*
  587. * Wrap data in socket buffer and send it.
  588. */
  589. static void stir_send(struct stir_cb *stir, struct sk_buff *skb)
  590. {
  591. unsigned wraplen;
  592. int first_frame = 0;
  593. /* if receiving, need to turnaround */
  594. if (stir->receiving) {
  595. receive_stop(stir);
  596. turnaround_delay(stir, irda_get_mtt(skb));
  597. first_frame = 1;
  598. }
  599. if (isfir(stir->speed))
  600. wraplen = wrap_fir_skb(skb, stir->io_buf);
  601. else
  602. wraplen = wrap_sir_skb(skb, stir->io_buf);
  603. /* check for space available in fifo */
  604. if (!first_frame)
  605. fifo_txwait(stir, wraplen);
  606. stir->stats.tx_packets++;
  607. stir->stats.tx_bytes += skb->len;
  608. stir->netdev->trans_start = jiffies;
  609. pr_debug("send %d (%d)\n", skb->len, wraplen);
  610. if (usb_bulk_msg(stir->usbdev, usb_sndbulkpipe(stir->usbdev, 1),
  611. stir->io_buf, wraplen,
  612. NULL, TRANSMIT_TIMEOUT))
  613. stir->stats.tx_errors++;
  614. }
  615. /*
  616. * Transmit state machine thread
  617. */
  618. static int stir_transmit_thread(void *arg)
  619. {
  620. struct stir_cb *stir = arg;
  621. struct net_device *dev = stir->netdev;
  622. struct sk_buff *skb;
  623. while (!kthread_should_stop()) {
  624. #ifdef CONFIG_PM
  625. /* if suspending, then power off and wait */
  626. if (unlikely(freezing(current))) {
  627. if (stir->receiving)
  628. receive_stop(stir);
  629. else
  630. fifo_txwait(stir, -1);
  631. write_reg(stir, REG_CTRL1, CTRL1_TXPWD|CTRL1_RXPWD);
  632. refrigerator();
  633. if (change_speed(stir, stir->speed))
  634. break;
  635. }
  636. #endif
  637. /* if something to send? */
  638. skb = xchg(&stir->tx_pending, NULL);
  639. if (skb) {
  640. unsigned new_speed = irda_get_next_speed(skb);
  641. netif_wake_queue(dev);
  642. if (skb->len > 0)
  643. stir_send(stir, skb);
  644. dev_kfree_skb(skb);
  645. if ((new_speed != -1) && (stir->speed != new_speed)) {
  646. if (fifo_txwait(stir, -1) ||
  647. change_speed(stir, new_speed))
  648. break;
  649. }
  650. continue;
  651. }
  652. /* nothing to send? start receiving */
  653. if (!stir->receiving
  654. && irda_device_txqueue_empty(dev)) {
  655. /* Wait otherwise chip gets confused. */
  656. if (fifo_txwait(stir, -1))
  657. break;
  658. if (unlikely(receive_start(stir))) {
  659. if (net_ratelimit())
  660. dev_info(&dev->dev,
  661. "%s: receive usb submit failed\n",
  662. stir->netdev->name);
  663. stir->receiving = 0;
  664. msleep(10);
  665. continue;
  666. }
  667. }
  668. /* sleep if nothing to send */
  669. set_current_state(TASK_INTERRUPTIBLE);
  670. schedule();
  671. }
  672. return 0;
  673. }
  674. /*
  675. * USB bulk receive completion callback.
  676. * Wakes up every ms (usb round trip) with wrapped
  677. * data.
  678. */
  679. static void stir_rcv_irq(struct urb *urb)
  680. {
  681. struct stir_cb *stir = urb->context;
  682. int err;
  683. /* in process of stopping, just drop data */
  684. if (!netif_running(stir->netdev))
  685. return;
  686. /* unlink, shutdown, unplug, other nasties */
  687. if (urb->status != 0)
  688. return;
  689. if (urb->actual_length > 0) {
  690. pr_debug("receive %d\n", urb->actual_length);
  691. unwrap_chars(stir, urb->transfer_buffer,
  692. urb->actual_length);
  693. do_gettimeofday(&stir->rx_time);
  694. }
  695. /* kernel thread is stopping receiver don't resubmit */
  696. if (!stir->receiving)
  697. return;
  698. /* resubmit existing urb */
  699. err = usb_submit_urb(urb, GFP_ATOMIC);
  700. /* in case of error, the kernel thread will restart us */
  701. if (err) {
  702. dev_warn(&stir->netdev->dev, "usb receive submit error: %d\n",
  703. err);
  704. stir->receiving = 0;
  705. wake_up_process(stir->thread);
  706. }
  707. }
  708. /*
  709. * Function stir_net_open (dev)
  710. *
  711. * Network device is taken up. Usually this is done by "ifconfig irda0 up"
  712. */
  713. static int stir_net_open(struct net_device *netdev)
  714. {
  715. struct stir_cb *stir = netdev_priv(netdev);
  716. int err;
  717. char hwname[16];
  718. err = usb_clear_halt(stir->usbdev, usb_sndbulkpipe(stir->usbdev, 1));
  719. if (err)
  720. goto err_out1;
  721. err = usb_clear_halt(stir->usbdev, usb_rcvbulkpipe(stir->usbdev, 2));
  722. if (err)
  723. goto err_out1;
  724. err = change_speed(stir, 9600);
  725. if (err)
  726. goto err_out1;
  727. err = -ENOMEM;
  728. /* Initialize for SIR/FIR to copy data directly into skb. */
  729. stir->receiving = 0;
  730. stir->rx_buff.truesize = IRDA_SKB_MAX_MTU;
  731. stir->rx_buff.skb = dev_alloc_skb(IRDA_SKB_MAX_MTU);
  732. if (!stir->rx_buff.skb)
  733. goto err_out1;
  734. skb_reserve(stir->rx_buff.skb, 1);
  735. stir->rx_buff.head = stir->rx_buff.skb->data;
  736. do_gettimeofday(&stir->rx_time);
  737. stir->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
  738. if (!stir->rx_urb)
  739. goto err_out2;
  740. stir->io_buf = kmalloc(STIR_FIFO_SIZE, GFP_KERNEL);
  741. if (!stir->io_buf)
  742. goto err_out3;
  743. usb_fill_bulk_urb(stir->rx_urb, stir->usbdev,
  744. usb_rcvbulkpipe(stir->usbdev, 2),
  745. stir->io_buf, STIR_FIFO_SIZE,
  746. stir_rcv_irq, stir);
  747. stir->fifo_status = kmalloc(FIFO_REGS_SIZE, GFP_KERNEL);
  748. if (!stir->fifo_status)
  749. goto err_out4;
  750. /*
  751. * Now that everything should be initialized properly,
  752. * Open new IrLAP layer instance to take care of us...
  753. * Note : will send immediately a speed change...
  754. */
  755. sprintf(hwname, "usb#%d", stir->usbdev->devnum);
  756. stir->irlap = irlap_open(netdev, &stir->qos, hwname);
  757. if (!stir->irlap) {
  758. err("stir4200: irlap_open failed");
  759. goto err_out5;
  760. }
  761. /** Start kernel thread for transmit. */
  762. stir->thread = kthread_run(stir_transmit_thread, stir,
  763. "%s", stir->netdev->name);
  764. if (IS_ERR(stir->thread)) {
  765. err = PTR_ERR(stir->thread);
  766. err("stir4200: unable to start kernel thread");
  767. goto err_out6;
  768. }
  769. netif_start_queue(netdev);
  770. return 0;
  771. err_out6:
  772. irlap_close(stir->irlap);
  773. err_out5:
  774. kfree(stir->fifo_status);
  775. err_out4:
  776. kfree(stir->io_buf);
  777. err_out3:
  778. usb_free_urb(stir->rx_urb);
  779. err_out2:
  780. kfree_skb(stir->rx_buff.skb);
  781. err_out1:
  782. return err;
  783. }
  784. /*
  785. * Function stir_net_close (stir)
  786. *
  787. * Network device is taken down. Usually this is done by
  788. * "ifconfig irda0 down"
  789. */
  790. static int stir_net_close(struct net_device *netdev)
  791. {
  792. struct stir_cb *stir = netdev_priv(netdev);
  793. /* Stop transmit processing */
  794. netif_stop_queue(netdev);
  795. /* Kill transmit thread */
  796. kthread_stop(stir->thread);
  797. kfree(stir->fifo_status);
  798. /* Mop up receive urb's */
  799. usb_kill_urb(stir->rx_urb);
  800. kfree(stir->io_buf);
  801. usb_free_urb(stir->rx_urb);
  802. kfree_skb(stir->rx_buff.skb);
  803. /* Stop and remove instance of IrLAP */
  804. if (stir->irlap)
  805. irlap_close(stir->irlap);
  806. stir->irlap = NULL;
  807. return 0;
  808. }
  809. /*
  810. * IOCTLs : Extra out-of-band network commands...
  811. */
  812. static int stir_net_ioctl(struct net_device *netdev, struct ifreq *rq, int cmd)
  813. {
  814. struct if_irda_req *irq = (struct if_irda_req *) rq;
  815. struct stir_cb *stir = netdev_priv(netdev);
  816. int ret = 0;
  817. switch (cmd) {
  818. case SIOCSBANDWIDTH: /* Set bandwidth */
  819. if (!capable(CAP_NET_ADMIN))
  820. return -EPERM;
  821. /* Check if the device is still there */
  822. if (netif_device_present(stir->netdev))
  823. ret = change_speed(stir, irq->ifr_baudrate);
  824. break;
  825. case SIOCSMEDIABUSY: /* Set media busy */
  826. if (!capable(CAP_NET_ADMIN))
  827. return -EPERM;
  828. /* Check if the IrDA stack is still there */
  829. if (netif_running(stir->netdev))
  830. irda_device_set_media_busy(stir->netdev, TRUE);
  831. break;
  832. case SIOCGRECEIVING:
  833. /* Only approximately true */
  834. irq->ifr_receiving = stir->receiving;
  835. break;
  836. default:
  837. ret = -EOPNOTSUPP;
  838. }
  839. return ret;
  840. }
  841. /*
  842. * Get device stats (for /proc/net/dev and ifconfig)
  843. */
  844. static struct net_device_stats *stir_net_get_stats(struct net_device *netdev)
  845. {
  846. struct stir_cb *stir = netdev_priv(netdev);
  847. return &stir->stats;
  848. }
  849. /*
  850. * This routine is called by the USB subsystem for each new device
  851. * in the system. We need to check if the device is ours, and in
  852. * this case start handling it.
  853. * Note : it might be worth protecting this function by a global
  854. * spinlock... Or not, because maybe USB already deal with that...
  855. */
  856. static int stir_probe(struct usb_interface *intf,
  857. const struct usb_device_id *id)
  858. {
  859. struct usb_device *dev = interface_to_usbdev(intf);
  860. struct stir_cb *stir = NULL;
  861. struct net_device *net;
  862. int ret = -ENOMEM;
  863. /* Allocate network device container. */
  864. net = alloc_irdadev(sizeof(*stir));
  865. if(!net)
  866. goto err_out1;
  867. SET_NETDEV_DEV(net, &intf->dev);
  868. stir = netdev_priv(net);
  869. stir->netdev = net;
  870. stir->usbdev = dev;
  871. ret = usb_reset_configuration(dev);
  872. if (ret != 0) {
  873. err("stir4200: usb reset configuration failed");
  874. goto err_out2;
  875. }
  876. printk(KERN_INFO "SigmaTel STIr4200 IRDA/USB found at address %d, "
  877. "Vendor: %x, Product: %x\n",
  878. dev->devnum, le16_to_cpu(dev->descriptor.idVendor),
  879. le16_to_cpu(dev->descriptor.idProduct));
  880. /* Initialize QoS for this device */
  881. irda_init_max_qos_capabilies(&stir->qos);
  882. /* That's the Rx capability. */
  883. stir->qos.baud_rate.bits &= IR_2400 | IR_9600 | IR_19200 |
  884. IR_38400 | IR_57600 | IR_115200 |
  885. (IR_4000000 << 8);
  886. stir->qos.min_turn_time.bits &= qos_mtt_bits;
  887. irda_qos_bits_to_value(&stir->qos);
  888. /* Override the network functions we need to use */
  889. net->hard_start_xmit = stir_hard_xmit;
  890. net->open = stir_net_open;
  891. net->stop = stir_net_close;
  892. net->get_stats = stir_net_get_stats;
  893. net->do_ioctl = stir_net_ioctl;
  894. ret = register_netdev(net);
  895. if (ret != 0)
  896. goto err_out2;
  897. dev_info(&intf->dev, "IrDA: Registered SigmaTel device %s\n",
  898. net->name);
  899. usb_set_intfdata(intf, stir);
  900. return 0;
  901. err_out2:
  902. free_netdev(net);
  903. err_out1:
  904. return ret;
  905. }
  906. /*
  907. * The current device is removed, the USB layer tell us to shut it down...
  908. */
  909. static void stir_disconnect(struct usb_interface *intf)
  910. {
  911. struct stir_cb *stir = usb_get_intfdata(intf);
  912. if (!stir)
  913. return;
  914. unregister_netdev(stir->netdev);
  915. free_netdev(stir->netdev);
  916. usb_set_intfdata(intf, NULL);
  917. }
  918. #ifdef CONFIG_PM
  919. /* USB suspend, so power off the transmitter/receiver */
  920. static int stir_suspend(struct usb_interface *intf, pm_message_t message)
  921. {
  922. struct stir_cb *stir = usb_get_intfdata(intf);
  923. netif_device_detach(stir->netdev);
  924. return 0;
  925. }
  926. /* Coming out of suspend, so reset hardware */
  927. static int stir_resume(struct usb_interface *intf)
  928. {
  929. struct stir_cb *stir = usb_get_intfdata(intf);
  930. netif_device_attach(stir->netdev);
  931. /* receiver restarted when send thread wakes up */
  932. return 0;
  933. }
  934. #endif
  935. /*
  936. * USB device callbacks
  937. */
  938. static struct usb_driver irda_driver = {
  939. .name = "stir4200",
  940. .probe = stir_probe,
  941. .disconnect = stir_disconnect,
  942. .id_table = dongles,
  943. #ifdef CONFIG_PM
  944. .suspend = stir_suspend,
  945. .resume = stir_resume,
  946. #endif
  947. };
  948. /*
  949. * Module insertion
  950. */
  951. static int __init stir_init(void)
  952. {
  953. return usb_register(&irda_driver);
  954. }
  955. module_init(stir_init);
  956. /*
  957. * Module removal
  958. */
  959. static void __exit stir_cleanup(void)
  960. {
  961. /* Deregister the driver and remove all pending instances */
  962. usb_deregister(&irda_driver);
  963. }
  964. module_exit(stir_cleanup);