usb_8dev.c 24 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036
  1. /*
  2. * CAN driver for "8 devices" USB2CAN converter
  3. *
  4. * Copyright (C) 2012 Bernd Krumboeck (krumboeck@universalnet.at)
  5. *
  6. * This program is free software; you can redistribute it and/or modify it
  7. * under the terms of the GNU General Public License as published
  8. * by the Free Software Foundation; version 2 of the License.
  9. *
  10. * This program is distributed in the hope that it will be useful, but
  11. * WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13. * General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License along
  16. * with this program.
  17. *
  18. * This driver is inspired by the 3.2.0 version of drivers/net/can/usb/ems_usb.c
  19. * and drivers/net/can/usb/esd_usb2.c
  20. *
  21. * Many thanks to Gerhard Bertelsmann (info@gerhard-bertelsmann.de)
  22. * for testing and fixing this driver. Also many thanks to "8 devices",
  23. * who were very cooperative and answered my questions.
  24. */
  25. #include <linux/signal.h>
  26. #include <linux/slab.h>
  27. #include <linux/module.h>
  28. #include <linux/netdevice.h>
  29. #include <linux/usb.h>
  30. #include <linux/can.h>
  31. #include <linux/can/dev.h>
  32. #include <linux/can/error.h>
  33. #include <linux/can/led.h>
  34. /* driver constants */
  35. #define MAX_RX_URBS 20
  36. #define MAX_TX_URBS 20
  37. #define RX_BUFFER_SIZE 64
  38. /* vendor and product id */
  39. #define USB_8DEV_VENDOR_ID 0x0483
  40. #define USB_8DEV_PRODUCT_ID 0x1234
  41. /* endpoints */
  42. enum usb_8dev_endpoint {
  43. USB_8DEV_ENDP_DATA_RX = 1,
  44. USB_8DEV_ENDP_DATA_TX,
  45. USB_8DEV_ENDP_CMD_RX,
  46. USB_8DEV_ENDP_CMD_TX
  47. };
  48. /* device CAN clock */
  49. #define USB_8DEV_ABP_CLOCK 32000000
  50. /* setup flags */
  51. #define USB_8DEV_SILENT 0x01
  52. #define USB_8DEV_LOOPBACK 0x02
  53. #define USB_8DEV_DISABLE_AUTO_RESTRANS 0x04
  54. #define USB_8DEV_STATUS_FRAME 0x08
  55. /* commands */
  56. enum usb_8dev_cmd {
  57. USB_8DEV_RESET = 1,
  58. USB_8DEV_OPEN,
  59. USB_8DEV_CLOSE,
  60. USB_8DEV_SET_SPEED,
  61. USB_8DEV_SET_MASK_FILTER,
  62. USB_8DEV_GET_STATUS,
  63. USB_8DEV_GET_STATISTICS,
  64. USB_8DEV_GET_SERIAL,
  65. USB_8DEV_GET_SOFTW_VER,
  66. USB_8DEV_GET_HARDW_VER,
  67. USB_8DEV_RESET_TIMESTAMP,
  68. USB_8DEV_GET_SOFTW_HARDW_VER
  69. };
  70. /* command options */
  71. #define USB_8DEV_BAUD_MANUAL 0x09
  72. #define USB_8DEV_CMD_START 0x11
  73. #define USB_8DEV_CMD_END 0x22
  74. #define USB_8DEV_CMD_SUCCESS 0
  75. #define USB_8DEV_CMD_ERROR 255
  76. #define USB_8DEV_CMD_TIMEOUT 1000
  77. /* frames */
  78. #define USB_8DEV_DATA_START 0x55
  79. #define USB_8DEV_DATA_END 0xAA
  80. #define USB_8DEV_TYPE_CAN_FRAME 0
  81. #define USB_8DEV_TYPE_ERROR_FRAME 3
  82. #define USB_8DEV_EXTID 0x01
  83. #define USB_8DEV_RTR 0x02
  84. #define USB_8DEV_ERR_FLAG 0x04
  85. /* status */
  86. #define USB_8DEV_STATUSMSG_OK 0x00 /* Normal condition. */
  87. #define USB_8DEV_STATUSMSG_OVERRUN 0x01 /* Overrun occured when sending */
  88. #define USB_8DEV_STATUSMSG_BUSLIGHT 0x02 /* Error counter has reached 96 */
  89. #define USB_8DEV_STATUSMSG_BUSHEAVY 0x03 /* Error count. has reached 128 */
  90. #define USB_8DEV_STATUSMSG_BUSOFF 0x04 /* Device is in BUSOFF */
  91. #define USB_8DEV_STATUSMSG_STUFF 0x20 /* Stuff Error */
  92. #define USB_8DEV_STATUSMSG_FORM 0x21 /* Form Error */
  93. #define USB_8DEV_STATUSMSG_ACK 0x23 /* Ack Error */
  94. #define USB_8DEV_STATUSMSG_BIT0 0x24 /* Bit1 Error */
  95. #define USB_8DEV_STATUSMSG_BIT1 0x25 /* Bit0 Error */
  96. #define USB_8DEV_STATUSMSG_CRC 0x27 /* CRC Error */
  97. #define USB_8DEV_RP_MASK 0x7F /* Mask for Receive Error Bit */
  98. /* table of devices that work with this driver */
  99. static const struct usb_device_id usb_8dev_table[] = {
  100. { USB_DEVICE(USB_8DEV_VENDOR_ID, USB_8DEV_PRODUCT_ID) },
  101. { } /* Terminating entry */
  102. };
  103. MODULE_DEVICE_TABLE(usb, usb_8dev_table);
  104. struct usb_8dev_tx_urb_context {
  105. struct usb_8dev_priv *priv;
  106. u32 echo_index;
  107. u8 dlc;
  108. };
  109. /* Structure to hold all of our device specific stuff */
  110. struct usb_8dev_priv {
  111. struct can_priv can; /* must be the first member */
  112. struct sk_buff *echo_skb[MAX_TX_URBS];
  113. struct usb_device *udev;
  114. struct net_device *netdev;
  115. atomic_t active_tx_urbs;
  116. struct usb_anchor tx_submitted;
  117. struct usb_8dev_tx_urb_context tx_contexts[MAX_TX_URBS];
  118. struct usb_anchor rx_submitted;
  119. struct can_berr_counter bec;
  120. u8 *cmd_msg_buffer;
  121. struct mutex usb_8dev_cmd_lock;
  122. };
  123. /* tx frame */
  124. struct __packed usb_8dev_tx_msg {
  125. u8 begin;
  126. u8 flags; /* RTR and EXT_ID flag */
  127. __be32 id; /* upper 3 bits not used */
  128. u8 dlc; /* data length code 0-8 bytes */
  129. u8 data[8]; /* 64-bit data */
  130. u8 end;
  131. };
  132. /* rx frame */
  133. struct __packed usb_8dev_rx_msg {
  134. u8 begin;
  135. u8 type; /* frame type */
  136. u8 flags; /* RTR and EXT_ID flag */
  137. __be32 id; /* upper 3 bits not used */
  138. u8 dlc; /* data length code 0-8 bytes */
  139. u8 data[8]; /* 64-bit data */
  140. __be32 timestamp; /* 32-bit timestamp */
  141. u8 end;
  142. };
  143. /* command frame */
  144. struct __packed usb_8dev_cmd_msg {
  145. u8 begin;
  146. u8 channel; /* unkown - always 0 */
  147. u8 command; /* command to execute */
  148. u8 opt1; /* optional parameter / return value */
  149. u8 opt2; /* optional parameter 2 */
  150. u8 data[10]; /* optional parameter and data */
  151. u8 end;
  152. };
  153. static int usb_8dev_send_cmd_msg(struct usb_8dev_priv *priv, u8 *msg, int size)
  154. {
  155. int actual_length;
  156. return usb_bulk_msg(priv->udev,
  157. usb_sndbulkpipe(priv->udev, USB_8DEV_ENDP_CMD_TX),
  158. msg, size, &actual_length, USB_8DEV_CMD_TIMEOUT);
  159. }
  160. static int usb_8dev_wait_cmd_msg(struct usb_8dev_priv *priv, u8 *msg, int size,
  161. int *actual_length)
  162. {
  163. return usb_bulk_msg(priv->udev,
  164. usb_rcvbulkpipe(priv->udev, USB_8DEV_ENDP_CMD_RX),
  165. msg, size, actual_length, USB_8DEV_CMD_TIMEOUT);
  166. }
  167. /* Send command to device and receive result.
  168. * Command was successful when opt1 = 0.
  169. */
  170. static int usb_8dev_send_cmd(struct usb_8dev_priv *priv,
  171. struct usb_8dev_cmd_msg *out,
  172. struct usb_8dev_cmd_msg *in)
  173. {
  174. int err;
  175. int num_bytes_read;
  176. struct net_device *netdev;
  177. netdev = priv->netdev;
  178. out->begin = USB_8DEV_CMD_START;
  179. out->end = USB_8DEV_CMD_END;
  180. mutex_lock(&priv->usb_8dev_cmd_lock);
  181. memcpy(priv->cmd_msg_buffer, out,
  182. sizeof(struct usb_8dev_cmd_msg));
  183. err = usb_8dev_send_cmd_msg(priv, priv->cmd_msg_buffer,
  184. sizeof(struct usb_8dev_cmd_msg));
  185. if (err < 0) {
  186. netdev_err(netdev, "sending command message failed\n");
  187. goto failed;
  188. }
  189. err = usb_8dev_wait_cmd_msg(priv, priv->cmd_msg_buffer,
  190. sizeof(struct usb_8dev_cmd_msg),
  191. &num_bytes_read);
  192. if (err < 0) {
  193. netdev_err(netdev, "no command message answer\n");
  194. goto failed;
  195. }
  196. memcpy(in, priv->cmd_msg_buffer, sizeof(struct usb_8dev_cmd_msg));
  197. if (in->begin != USB_8DEV_CMD_START || in->end != USB_8DEV_CMD_END ||
  198. num_bytes_read != 16 || in->opt1 != 0)
  199. err = -EPROTO;
  200. failed:
  201. mutex_unlock(&priv->usb_8dev_cmd_lock);
  202. return err;
  203. }
  204. /* Send open command to device */
  205. static int usb_8dev_cmd_open(struct usb_8dev_priv *priv)
  206. {
  207. struct can_bittiming *bt = &priv->can.bittiming;
  208. struct usb_8dev_cmd_msg outmsg;
  209. struct usb_8dev_cmd_msg inmsg;
  210. u32 ctrlmode = priv->can.ctrlmode;
  211. u32 flags = USB_8DEV_STATUS_FRAME;
  212. __be32 beflags;
  213. __be16 bebrp;
  214. memset(&outmsg, 0, sizeof(outmsg));
  215. outmsg.command = USB_8DEV_OPEN;
  216. outmsg.opt1 = USB_8DEV_BAUD_MANUAL;
  217. outmsg.data[0] = bt->prop_seg + bt->phase_seg1;
  218. outmsg.data[1] = bt->phase_seg2;
  219. outmsg.data[2] = bt->sjw;
  220. /* BRP */
  221. bebrp = cpu_to_be16((u16)bt->brp);
  222. memcpy(&outmsg.data[3], &bebrp, sizeof(bebrp));
  223. /* flags */
  224. if (ctrlmode & CAN_CTRLMODE_LOOPBACK)
  225. flags |= USB_8DEV_LOOPBACK;
  226. if (ctrlmode & CAN_CTRLMODE_LISTENONLY)
  227. flags |= USB_8DEV_SILENT;
  228. if (ctrlmode & CAN_CTRLMODE_ONE_SHOT)
  229. flags |= USB_8DEV_DISABLE_AUTO_RESTRANS;
  230. beflags = cpu_to_be32(flags);
  231. memcpy(&outmsg.data[5], &beflags, sizeof(beflags));
  232. return usb_8dev_send_cmd(priv, &outmsg, &inmsg);
  233. }
  234. /* Send close command to device */
  235. static int usb_8dev_cmd_close(struct usb_8dev_priv *priv)
  236. {
  237. struct usb_8dev_cmd_msg inmsg;
  238. struct usb_8dev_cmd_msg outmsg = {
  239. .channel = 0,
  240. .command = USB_8DEV_CLOSE,
  241. .opt1 = 0,
  242. .opt2 = 0
  243. };
  244. return usb_8dev_send_cmd(priv, &outmsg, &inmsg);
  245. }
  246. /* Get firmware and hardware version */
  247. static int usb_8dev_cmd_version(struct usb_8dev_priv *priv, u32 *res)
  248. {
  249. struct usb_8dev_cmd_msg inmsg;
  250. struct usb_8dev_cmd_msg outmsg = {
  251. .channel = 0,
  252. .command = USB_8DEV_GET_SOFTW_HARDW_VER,
  253. .opt1 = 0,
  254. .opt2 = 0
  255. };
  256. int err = usb_8dev_send_cmd(priv, &outmsg, &inmsg);
  257. if (err)
  258. return err;
  259. *res = be32_to_cpup((__be32 *)inmsg.data);
  260. return err;
  261. }
  262. /* Set network device mode
  263. *
  264. * Maybe we should leave this function empty, because the device
  265. * set mode variable with open command.
  266. */
  267. static int usb_8dev_set_mode(struct net_device *netdev, enum can_mode mode)
  268. {
  269. struct usb_8dev_priv *priv = netdev_priv(netdev);
  270. int err = 0;
  271. switch (mode) {
  272. case CAN_MODE_START:
  273. err = usb_8dev_cmd_open(priv);
  274. if (err)
  275. netdev_warn(netdev, "couldn't start device");
  276. break;
  277. default:
  278. return -EOPNOTSUPP;
  279. }
  280. return err;
  281. }
  282. /* Read error/status frames */
  283. static void usb_8dev_rx_err_msg(struct usb_8dev_priv *priv,
  284. struct usb_8dev_rx_msg *msg)
  285. {
  286. struct can_frame *cf;
  287. struct sk_buff *skb;
  288. struct net_device_stats *stats = &priv->netdev->stats;
  289. /* Error message:
  290. * byte 0: Status
  291. * byte 1: bit 7: Receive Passive
  292. * byte 1: bit 0-6: Receive Error Counter
  293. * byte 2: Transmit Error Counter
  294. * byte 3: Always 0 (maybe reserved for future use)
  295. */
  296. u8 state = msg->data[0];
  297. u8 rxerr = msg->data[1] & USB_8DEV_RP_MASK;
  298. u8 txerr = msg->data[2];
  299. int rx_errors = 0;
  300. int tx_errors = 0;
  301. skb = alloc_can_err_skb(priv->netdev, &cf);
  302. if (!skb)
  303. return;
  304. switch (state) {
  305. case USB_8DEV_STATUSMSG_OK:
  306. priv->can.state = CAN_STATE_ERROR_ACTIVE;
  307. cf->can_id |= CAN_ERR_PROT;
  308. cf->data[2] = CAN_ERR_PROT_ACTIVE;
  309. break;
  310. case USB_8DEV_STATUSMSG_BUSOFF:
  311. priv->can.state = CAN_STATE_BUS_OFF;
  312. cf->can_id |= CAN_ERR_BUSOFF;
  313. priv->can.can_stats.bus_off++;
  314. can_bus_off(priv->netdev);
  315. break;
  316. case USB_8DEV_STATUSMSG_OVERRUN:
  317. case USB_8DEV_STATUSMSG_BUSLIGHT:
  318. case USB_8DEV_STATUSMSG_BUSHEAVY:
  319. cf->can_id |= CAN_ERR_CRTL;
  320. break;
  321. default:
  322. priv->can.state = CAN_STATE_ERROR_WARNING;
  323. cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
  324. priv->can.can_stats.bus_error++;
  325. break;
  326. }
  327. switch (state) {
  328. case USB_8DEV_STATUSMSG_OK:
  329. case USB_8DEV_STATUSMSG_BUSOFF:
  330. break;
  331. case USB_8DEV_STATUSMSG_ACK:
  332. cf->can_id |= CAN_ERR_ACK;
  333. tx_errors = 1;
  334. break;
  335. case USB_8DEV_STATUSMSG_CRC:
  336. cf->data[2] |= CAN_ERR_PROT_UNSPEC;
  337. cf->data[3] |= CAN_ERR_PROT_LOC_CRC_SEQ |
  338. CAN_ERR_PROT_LOC_CRC_DEL;
  339. rx_errors = 1;
  340. break;
  341. case USB_8DEV_STATUSMSG_BIT0:
  342. cf->data[2] |= CAN_ERR_PROT_BIT0;
  343. tx_errors = 1;
  344. break;
  345. case USB_8DEV_STATUSMSG_BIT1:
  346. cf->data[2] |= CAN_ERR_PROT_BIT1;
  347. tx_errors = 1;
  348. break;
  349. case USB_8DEV_STATUSMSG_FORM:
  350. cf->data[2] |= CAN_ERR_PROT_FORM;
  351. rx_errors = 1;
  352. break;
  353. case USB_8DEV_STATUSMSG_STUFF:
  354. cf->data[2] |= CAN_ERR_PROT_STUFF;
  355. rx_errors = 1;
  356. break;
  357. case USB_8DEV_STATUSMSG_OVERRUN:
  358. cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
  359. stats->rx_over_errors++;
  360. rx_errors = 1;
  361. break;
  362. case USB_8DEV_STATUSMSG_BUSLIGHT:
  363. priv->can.state = CAN_STATE_ERROR_WARNING;
  364. cf->data[1] = (txerr > rxerr) ?
  365. CAN_ERR_CRTL_TX_WARNING :
  366. CAN_ERR_CRTL_RX_WARNING;
  367. priv->can.can_stats.error_warning++;
  368. break;
  369. case USB_8DEV_STATUSMSG_BUSHEAVY:
  370. priv->can.state = CAN_STATE_ERROR_PASSIVE;
  371. cf->data[1] = (txerr > rxerr) ?
  372. CAN_ERR_CRTL_TX_PASSIVE :
  373. CAN_ERR_CRTL_RX_PASSIVE;
  374. priv->can.can_stats.error_passive++;
  375. break;
  376. default:
  377. netdev_warn(priv->netdev,
  378. "Unknown status/error message (%d)\n", state);
  379. break;
  380. }
  381. if (tx_errors) {
  382. cf->data[2] |= CAN_ERR_PROT_TX;
  383. stats->tx_errors++;
  384. }
  385. if (rx_errors)
  386. stats->rx_errors++;
  387. cf->data[6] = txerr;
  388. cf->data[7] = rxerr;
  389. priv->bec.txerr = txerr;
  390. priv->bec.rxerr = rxerr;
  391. netif_rx(skb);
  392. stats->rx_packets++;
  393. stats->rx_bytes += cf->can_dlc;
  394. }
  395. /* Read data and status frames */
  396. static void usb_8dev_rx_can_msg(struct usb_8dev_priv *priv,
  397. struct usb_8dev_rx_msg *msg)
  398. {
  399. struct can_frame *cf;
  400. struct sk_buff *skb;
  401. struct net_device_stats *stats = &priv->netdev->stats;
  402. if (msg->type == USB_8DEV_TYPE_ERROR_FRAME &&
  403. msg->flags == USB_8DEV_ERR_FLAG) {
  404. usb_8dev_rx_err_msg(priv, msg);
  405. } else if (msg->type == USB_8DEV_TYPE_CAN_FRAME) {
  406. skb = alloc_can_skb(priv->netdev, &cf);
  407. if (!skb)
  408. return;
  409. cf->can_id = be32_to_cpu(msg->id);
  410. cf->can_dlc = get_can_dlc(msg->dlc & 0xF);
  411. if (msg->flags & USB_8DEV_EXTID)
  412. cf->can_id |= CAN_EFF_FLAG;
  413. if (msg->flags & USB_8DEV_RTR)
  414. cf->can_id |= CAN_RTR_FLAG;
  415. else
  416. memcpy(cf->data, msg->data, cf->can_dlc);
  417. netif_rx(skb);
  418. stats->rx_packets++;
  419. stats->rx_bytes += cf->can_dlc;
  420. can_led_event(priv->netdev, CAN_LED_EVENT_RX);
  421. } else {
  422. netdev_warn(priv->netdev, "frame type %d unknown",
  423. msg->type);
  424. }
  425. }
  426. /* Callback for reading data from device
  427. *
  428. * Check urb status, call read function and resubmit urb read operation.
  429. */
  430. static void usb_8dev_read_bulk_callback(struct urb *urb)
  431. {
  432. struct usb_8dev_priv *priv = urb->context;
  433. struct net_device *netdev;
  434. int retval;
  435. int pos = 0;
  436. netdev = priv->netdev;
  437. if (!netif_device_present(netdev))
  438. return;
  439. switch (urb->status) {
  440. case 0: /* success */
  441. break;
  442. case -ENOENT:
  443. case -ESHUTDOWN:
  444. return;
  445. default:
  446. netdev_info(netdev, "Rx URB aborted (%d)\n",
  447. urb->status);
  448. goto resubmit_urb;
  449. }
  450. while (pos < urb->actual_length) {
  451. struct usb_8dev_rx_msg *msg;
  452. if (pos + sizeof(struct usb_8dev_rx_msg) > urb->actual_length) {
  453. netdev_err(priv->netdev, "format error\n");
  454. break;
  455. }
  456. msg = (struct usb_8dev_rx_msg *)(urb->transfer_buffer + pos);
  457. usb_8dev_rx_can_msg(priv, msg);
  458. pos += sizeof(struct usb_8dev_rx_msg);
  459. }
  460. resubmit_urb:
  461. usb_fill_bulk_urb(urb, priv->udev,
  462. usb_rcvbulkpipe(priv->udev, USB_8DEV_ENDP_DATA_RX),
  463. urb->transfer_buffer, RX_BUFFER_SIZE,
  464. usb_8dev_read_bulk_callback, priv);
  465. retval = usb_submit_urb(urb, GFP_ATOMIC);
  466. if (retval == -ENODEV)
  467. netif_device_detach(netdev);
  468. else if (retval)
  469. netdev_err(netdev,
  470. "failed resubmitting read bulk urb: %d\n", retval);
  471. }
  472. /* Callback handler for write operations
  473. *
  474. * Free allocated buffers, check transmit status and
  475. * calculate statistic.
  476. */
  477. static void usb_8dev_write_bulk_callback(struct urb *urb)
  478. {
  479. struct usb_8dev_tx_urb_context *context = urb->context;
  480. struct usb_8dev_priv *priv;
  481. struct net_device *netdev;
  482. BUG_ON(!context);
  483. priv = context->priv;
  484. netdev = priv->netdev;
  485. /* free up our allocated buffer */
  486. usb_free_coherent(urb->dev, urb->transfer_buffer_length,
  487. urb->transfer_buffer, urb->transfer_dma);
  488. atomic_dec(&priv->active_tx_urbs);
  489. if (!netif_device_present(netdev))
  490. return;
  491. if (urb->status)
  492. netdev_info(netdev, "Tx URB aborted (%d)\n",
  493. urb->status);
  494. netdev->stats.tx_packets++;
  495. netdev->stats.tx_bytes += context->dlc;
  496. can_get_echo_skb(netdev, context->echo_index);
  497. can_led_event(netdev, CAN_LED_EVENT_TX);
  498. /* Release context */
  499. context->echo_index = MAX_TX_URBS;
  500. netif_wake_queue(netdev);
  501. }
  502. /* Send data to device */
  503. static netdev_tx_t usb_8dev_start_xmit(struct sk_buff *skb,
  504. struct net_device *netdev)
  505. {
  506. struct usb_8dev_priv *priv = netdev_priv(netdev);
  507. struct net_device_stats *stats = &netdev->stats;
  508. struct can_frame *cf = (struct can_frame *) skb->data;
  509. struct usb_8dev_tx_msg *msg;
  510. struct urb *urb;
  511. struct usb_8dev_tx_urb_context *context = NULL;
  512. u8 *buf;
  513. int i, err;
  514. size_t size = sizeof(struct usb_8dev_tx_msg);
  515. if (can_dropped_invalid_skb(netdev, skb))
  516. return NETDEV_TX_OK;
  517. /* create a URB, and a buffer for it, and copy the data to the URB */
  518. urb = usb_alloc_urb(0, GFP_ATOMIC);
  519. if (!urb) {
  520. netdev_err(netdev, "No memory left for URBs\n");
  521. goto nomem;
  522. }
  523. buf = usb_alloc_coherent(priv->udev, size, GFP_ATOMIC,
  524. &urb->transfer_dma);
  525. if (!buf) {
  526. netdev_err(netdev, "No memory left for USB buffer\n");
  527. goto nomembuf;
  528. }
  529. memset(buf, 0, size);
  530. msg = (struct usb_8dev_tx_msg *)buf;
  531. msg->begin = USB_8DEV_DATA_START;
  532. msg->flags = 0x00;
  533. if (cf->can_id & CAN_RTR_FLAG)
  534. msg->flags |= USB_8DEV_RTR;
  535. if (cf->can_id & CAN_EFF_FLAG)
  536. msg->flags |= USB_8DEV_EXTID;
  537. msg->id = cpu_to_be32(cf->can_id & CAN_ERR_MASK);
  538. msg->dlc = cf->can_dlc;
  539. memcpy(msg->data, cf->data, cf->can_dlc);
  540. msg->end = USB_8DEV_DATA_END;
  541. for (i = 0; i < MAX_TX_URBS; i++) {
  542. if (priv->tx_contexts[i].echo_index == MAX_TX_URBS) {
  543. context = &priv->tx_contexts[i];
  544. break;
  545. }
  546. }
  547. /* May never happen! When this happens we'd more URBs in flight as
  548. * allowed (MAX_TX_URBS).
  549. */
  550. if (!context)
  551. goto nofreecontext;
  552. context->priv = priv;
  553. context->echo_index = i;
  554. context->dlc = cf->can_dlc;
  555. usb_fill_bulk_urb(urb, priv->udev,
  556. usb_sndbulkpipe(priv->udev, USB_8DEV_ENDP_DATA_TX),
  557. buf, size, usb_8dev_write_bulk_callback, context);
  558. urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
  559. usb_anchor_urb(urb, &priv->tx_submitted);
  560. can_put_echo_skb(skb, netdev, context->echo_index);
  561. atomic_inc(&priv->active_tx_urbs);
  562. err = usb_submit_urb(urb, GFP_ATOMIC);
  563. if (unlikely(err))
  564. goto failed;
  565. else if (atomic_read(&priv->active_tx_urbs) >= MAX_TX_URBS)
  566. /* Slow down tx path */
  567. netif_stop_queue(netdev);
  568. /* Release our reference to this URB, the USB core will eventually free
  569. * it entirely.
  570. */
  571. usb_free_urb(urb);
  572. return NETDEV_TX_OK;
  573. nofreecontext:
  574. usb_free_coherent(priv->udev, size, buf, urb->transfer_dma);
  575. usb_free_urb(urb);
  576. netdev_warn(netdev, "couldn't find free context");
  577. return NETDEV_TX_BUSY;
  578. failed:
  579. can_free_echo_skb(netdev, context->echo_index);
  580. usb_unanchor_urb(urb);
  581. usb_free_coherent(priv->udev, size, buf, urb->transfer_dma);
  582. atomic_dec(&priv->active_tx_urbs);
  583. if (err == -ENODEV)
  584. netif_device_detach(netdev);
  585. else
  586. netdev_warn(netdev, "failed tx_urb %d\n", err);
  587. nomembuf:
  588. usb_free_urb(urb);
  589. nomem:
  590. dev_kfree_skb(skb);
  591. stats->tx_dropped++;
  592. return NETDEV_TX_OK;
  593. }
  594. static int usb_8dev_get_berr_counter(const struct net_device *netdev,
  595. struct can_berr_counter *bec)
  596. {
  597. struct usb_8dev_priv *priv = netdev_priv(netdev);
  598. bec->txerr = priv->bec.txerr;
  599. bec->rxerr = priv->bec.rxerr;
  600. return 0;
  601. }
  602. /* Start USB device */
  603. static int usb_8dev_start(struct usb_8dev_priv *priv)
  604. {
  605. struct net_device *netdev = priv->netdev;
  606. int err, i;
  607. for (i = 0; i < MAX_RX_URBS; i++) {
  608. struct urb *urb = NULL;
  609. u8 *buf;
  610. /* create a URB, and a buffer for it */
  611. urb = usb_alloc_urb(0, GFP_KERNEL);
  612. if (!urb) {
  613. netdev_err(netdev, "No memory left for URBs\n");
  614. err = -ENOMEM;
  615. break;
  616. }
  617. buf = usb_alloc_coherent(priv->udev, RX_BUFFER_SIZE, GFP_KERNEL,
  618. &urb->transfer_dma);
  619. if (!buf) {
  620. netdev_err(netdev, "No memory left for USB buffer\n");
  621. usb_free_urb(urb);
  622. err = -ENOMEM;
  623. break;
  624. }
  625. usb_fill_bulk_urb(urb, priv->udev,
  626. usb_rcvbulkpipe(priv->udev,
  627. USB_8DEV_ENDP_DATA_RX),
  628. buf, RX_BUFFER_SIZE,
  629. usb_8dev_read_bulk_callback, priv);
  630. urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
  631. usb_anchor_urb(urb, &priv->rx_submitted);
  632. err = usb_submit_urb(urb, GFP_KERNEL);
  633. if (err) {
  634. usb_unanchor_urb(urb);
  635. usb_free_coherent(priv->udev, RX_BUFFER_SIZE, buf,
  636. urb->transfer_dma);
  637. usb_free_urb(urb);
  638. break;
  639. }
  640. /* Drop reference, USB core will take care of freeing it */
  641. usb_free_urb(urb);
  642. }
  643. /* Did we submit any URBs */
  644. if (i == 0) {
  645. netdev_warn(netdev, "couldn't setup read URBs\n");
  646. return err;
  647. }
  648. /* Warn if we've couldn't transmit all the URBs */
  649. if (i < MAX_RX_URBS)
  650. netdev_warn(netdev, "rx performance may be slow\n");
  651. err = usb_8dev_cmd_open(priv);
  652. if (err)
  653. goto failed;
  654. priv->can.state = CAN_STATE_ERROR_ACTIVE;
  655. return 0;
  656. failed:
  657. if (err == -ENODEV)
  658. netif_device_detach(priv->netdev);
  659. netdev_warn(netdev, "couldn't submit control: %d\n", err);
  660. return err;
  661. }
  662. /* Open USB device */
  663. static int usb_8dev_open(struct net_device *netdev)
  664. {
  665. struct usb_8dev_priv *priv = netdev_priv(netdev);
  666. int err;
  667. /* common open */
  668. err = open_candev(netdev);
  669. if (err)
  670. return err;
  671. can_led_event(netdev, CAN_LED_EVENT_OPEN);
  672. /* finally start device */
  673. err = usb_8dev_start(priv);
  674. if (err) {
  675. if (err == -ENODEV)
  676. netif_device_detach(priv->netdev);
  677. netdev_warn(netdev, "couldn't start device: %d\n",
  678. err);
  679. close_candev(netdev);
  680. return err;
  681. }
  682. netif_start_queue(netdev);
  683. return 0;
  684. }
  685. static void unlink_all_urbs(struct usb_8dev_priv *priv)
  686. {
  687. int i;
  688. usb_kill_anchored_urbs(&priv->rx_submitted);
  689. usb_kill_anchored_urbs(&priv->tx_submitted);
  690. atomic_set(&priv->active_tx_urbs, 0);
  691. for (i = 0; i < MAX_TX_URBS; i++)
  692. priv->tx_contexts[i].echo_index = MAX_TX_URBS;
  693. }
  694. /* Close USB device */
  695. static int usb_8dev_close(struct net_device *netdev)
  696. {
  697. struct usb_8dev_priv *priv = netdev_priv(netdev);
  698. int err = 0;
  699. /* Send CLOSE command to CAN controller */
  700. err = usb_8dev_cmd_close(priv);
  701. if (err)
  702. netdev_warn(netdev, "couldn't stop device");
  703. priv->can.state = CAN_STATE_STOPPED;
  704. netif_stop_queue(netdev);
  705. /* Stop polling */
  706. unlink_all_urbs(priv);
  707. close_candev(netdev);
  708. can_led_event(netdev, CAN_LED_EVENT_STOP);
  709. return err;
  710. }
  711. static const struct net_device_ops usb_8dev_netdev_ops = {
  712. .ndo_open = usb_8dev_open,
  713. .ndo_stop = usb_8dev_close,
  714. .ndo_start_xmit = usb_8dev_start_xmit,
  715. .ndo_change_mtu = can_change_mtu,
  716. };
  717. static const struct can_bittiming_const usb_8dev_bittiming_const = {
  718. .name = "usb_8dev",
  719. .tseg1_min = 1,
  720. .tseg1_max = 16,
  721. .tseg2_min = 1,
  722. .tseg2_max = 8,
  723. .sjw_max = 4,
  724. .brp_min = 1,
  725. .brp_max = 1024,
  726. .brp_inc = 1,
  727. };
  728. /* Probe USB device
  729. *
  730. * Check device and firmware.
  731. * Set supported modes and bittiming constants.
  732. * Allocate some memory.
  733. */
  734. static int usb_8dev_probe(struct usb_interface *intf,
  735. const struct usb_device_id *id)
  736. {
  737. struct net_device *netdev;
  738. struct usb_8dev_priv *priv;
  739. int i, err = -ENOMEM;
  740. u32 version;
  741. char buf[18];
  742. struct usb_device *usbdev = interface_to_usbdev(intf);
  743. /* product id looks strange, better we also check iProduct string */
  744. if (usb_string(usbdev, usbdev->descriptor.iProduct, buf,
  745. sizeof(buf)) > 0 && strcmp(buf, "USB2CAN converter")) {
  746. dev_info(&usbdev->dev, "ignoring: not an USB2CAN converter\n");
  747. return -ENODEV;
  748. }
  749. netdev = alloc_candev(sizeof(struct usb_8dev_priv), MAX_TX_URBS);
  750. if (!netdev) {
  751. dev_err(&intf->dev, "Couldn't alloc candev\n");
  752. return -ENOMEM;
  753. }
  754. priv = netdev_priv(netdev);
  755. priv->udev = usbdev;
  756. priv->netdev = netdev;
  757. priv->can.state = CAN_STATE_STOPPED;
  758. priv->can.clock.freq = USB_8DEV_ABP_CLOCK;
  759. priv->can.bittiming_const = &usb_8dev_bittiming_const;
  760. priv->can.do_set_mode = usb_8dev_set_mode;
  761. priv->can.do_get_berr_counter = usb_8dev_get_berr_counter;
  762. priv->can.ctrlmode_supported = CAN_CTRLMODE_LOOPBACK |
  763. CAN_CTRLMODE_LISTENONLY |
  764. CAN_CTRLMODE_ONE_SHOT;
  765. netdev->netdev_ops = &usb_8dev_netdev_ops;
  766. netdev->flags |= IFF_ECHO; /* we support local echo */
  767. init_usb_anchor(&priv->rx_submitted);
  768. init_usb_anchor(&priv->tx_submitted);
  769. atomic_set(&priv->active_tx_urbs, 0);
  770. for (i = 0; i < MAX_TX_URBS; i++)
  771. priv->tx_contexts[i].echo_index = MAX_TX_URBS;
  772. priv->cmd_msg_buffer = kzalloc(sizeof(struct usb_8dev_cmd_msg),
  773. GFP_KERNEL);
  774. if (!priv->cmd_msg_buffer)
  775. goto cleanup_candev;
  776. usb_set_intfdata(intf, priv);
  777. SET_NETDEV_DEV(netdev, &intf->dev);
  778. mutex_init(&priv->usb_8dev_cmd_lock);
  779. err = register_candev(netdev);
  780. if (err) {
  781. netdev_err(netdev,
  782. "couldn't register CAN device: %d\n", err);
  783. goto cleanup_cmd_msg_buffer;
  784. }
  785. err = usb_8dev_cmd_version(priv, &version);
  786. if (err) {
  787. netdev_err(netdev, "can't get firmware version\n");
  788. goto cleanup_unregister_candev;
  789. } else {
  790. netdev_info(netdev,
  791. "firmware: %d.%d, hardware: %d.%d\n",
  792. (version>>24) & 0xff, (version>>16) & 0xff,
  793. (version>>8) & 0xff, version & 0xff);
  794. }
  795. devm_can_led_init(netdev);
  796. return 0;
  797. cleanup_unregister_candev:
  798. unregister_netdev(priv->netdev);
  799. cleanup_cmd_msg_buffer:
  800. kfree(priv->cmd_msg_buffer);
  801. cleanup_candev:
  802. free_candev(netdev);
  803. return err;
  804. }
  805. /* Called by the usb core when driver is unloaded or device is removed */
  806. static void usb_8dev_disconnect(struct usb_interface *intf)
  807. {
  808. struct usb_8dev_priv *priv = usb_get_intfdata(intf);
  809. usb_set_intfdata(intf, NULL);
  810. if (priv) {
  811. netdev_info(priv->netdev, "device disconnected\n");
  812. unregister_netdev(priv->netdev);
  813. free_candev(priv->netdev);
  814. unlink_all_urbs(priv);
  815. }
  816. }
  817. static struct usb_driver usb_8dev_driver = {
  818. .name = "usb_8dev",
  819. .probe = usb_8dev_probe,
  820. .disconnect = usb_8dev_disconnect,
  821. .id_table = usb_8dev_table,
  822. };
  823. module_usb_driver(usb_8dev_driver);
  824. MODULE_AUTHOR("Bernd Krumboeck <krumboeck@universalnet.at>");
  825. MODULE_DESCRIPTION("CAN driver for 8 devices USB2CAN interfaces");
  826. MODULE_LICENSE("GPL v2");