usb_8dev.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035
  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/init.h>
  26. #include <linux/signal.h>
  27. #include <linux/slab.h>
  28. #include <linux/module.h>
  29. #include <linux/netdevice.h>
  30. #include <linux/usb.h>
  31. #include <linux/can.h>
  32. #include <linux/can/dev.h>
  33. #include <linux/can/error.h>
  34. #include <linux/can/led.h>
  35. /* driver constants */
  36. #define MAX_RX_URBS 20
  37. #define MAX_TX_URBS 20
  38. #define RX_BUFFER_SIZE 64
  39. /* vendor and product id */
  40. #define USB_8DEV_VENDOR_ID 0x0483
  41. #define USB_8DEV_PRODUCT_ID 0x1234
  42. /* endpoints */
  43. enum usb_8dev_endpoint {
  44. USB_8DEV_ENDP_DATA_RX = 1,
  45. USB_8DEV_ENDP_DATA_TX,
  46. USB_8DEV_ENDP_CMD_RX,
  47. USB_8DEV_ENDP_CMD_TX
  48. };
  49. /* device CAN clock */
  50. #define USB_8DEV_ABP_CLOCK 32000000
  51. /* setup flags */
  52. #define USB_8DEV_SILENT 0x01
  53. #define USB_8DEV_LOOPBACK 0x02
  54. #define USB_8DEV_DISABLE_AUTO_RESTRANS 0x04
  55. #define USB_8DEV_STATUS_FRAME 0x08
  56. /* commands */
  57. enum usb_8dev_cmd {
  58. USB_8DEV_RESET = 1,
  59. USB_8DEV_OPEN,
  60. USB_8DEV_CLOSE,
  61. USB_8DEV_SET_SPEED,
  62. USB_8DEV_SET_MASK_FILTER,
  63. USB_8DEV_GET_STATUS,
  64. USB_8DEV_GET_STATISTICS,
  65. USB_8DEV_GET_SERIAL,
  66. USB_8DEV_GET_SOFTW_VER,
  67. USB_8DEV_GET_HARDW_VER,
  68. USB_8DEV_RESET_TIMESTAMP,
  69. USB_8DEV_GET_SOFTW_HARDW_VER
  70. };
  71. /* command options */
  72. #define USB_8DEV_BAUD_MANUAL 0x09
  73. #define USB_8DEV_CMD_START 0x11
  74. #define USB_8DEV_CMD_END 0x22
  75. #define USB_8DEV_CMD_SUCCESS 0
  76. #define USB_8DEV_CMD_ERROR 255
  77. #define USB_8DEV_CMD_TIMEOUT 1000
  78. /* frames */
  79. #define USB_8DEV_DATA_START 0x55
  80. #define USB_8DEV_DATA_END 0xAA
  81. #define USB_8DEV_TYPE_CAN_FRAME 0
  82. #define USB_8DEV_TYPE_ERROR_FRAME 3
  83. #define USB_8DEV_EXTID 0x01
  84. #define USB_8DEV_RTR 0x02
  85. #define USB_8DEV_ERR_FLAG 0x04
  86. /* status */
  87. #define USB_8DEV_STATUSMSG_OK 0x00 /* Normal condition. */
  88. #define USB_8DEV_STATUSMSG_OVERRUN 0x01 /* Overrun occured when sending */
  89. #define USB_8DEV_STATUSMSG_BUSLIGHT 0x02 /* Error counter has reached 96 */
  90. #define USB_8DEV_STATUSMSG_BUSHEAVY 0x03 /* Error count. has reached 128 */
  91. #define USB_8DEV_STATUSMSG_BUSOFF 0x04 /* Device is in BUSOFF */
  92. #define USB_8DEV_STATUSMSG_STUFF 0x20 /* Stuff Error */
  93. #define USB_8DEV_STATUSMSG_FORM 0x21 /* Form Error */
  94. #define USB_8DEV_STATUSMSG_ACK 0x23 /* Ack Error */
  95. #define USB_8DEV_STATUSMSG_BIT0 0x24 /* Bit1 Error */
  96. #define USB_8DEV_STATUSMSG_BIT1 0x25 /* Bit0 Error */
  97. #define USB_8DEV_STATUSMSG_CRC 0x27 /* CRC Error */
  98. #define USB_8DEV_RP_MASK 0x7F /* Mask for Receive Error Bit */
  99. /* table of devices that work with this driver */
  100. static const struct usb_device_id usb_8dev_table[] = {
  101. { USB_DEVICE(USB_8DEV_VENDOR_ID, USB_8DEV_PRODUCT_ID) },
  102. { } /* Terminating entry */
  103. };
  104. MODULE_DEVICE_TABLE(usb, usb_8dev_table);
  105. struct usb_8dev_tx_urb_context {
  106. struct usb_8dev_priv *priv;
  107. u32 echo_index;
  108. u8 dlc;
  109. };
  110. /* Structure to hold all of our device specific stuff */
  111. struct usb_8dev_priv {
  112. struct can_priv can; /* must be the first member */
  113. struct sk_buff *echo_skb[MAX_TX_URBS];
  114. struct usb_device *udev;
  115. struct net_device *netdev;
  116. atomic_t active_tx_urbs;
  117. struct usb_anchor tx_submitted;
  118. struct usb_8dev_tx_urb_context tx_contexts[MAX_TX_URBS];
  119. struct usb_anchor rx_submitted;
  120. struct can_berr_counter bec;
  121. u8 *cmd_msg_buffer;
  122. struct mutex usb_8dev_cmd_lock;
  123. };
  124. /* tx frame */
  125. struct __packed usb_8dev_tx_msg {
  126. u8 begin;
  127. u8 flags; /* RTR and EXT_ID flag */
  128. __be32 id; /* upper 3 bits not used */
  129. u8 dlc; /* data length code 0-8 bytes */
  130. u8 data[8]; /* 64-bit data */
  131. u8 end;
  132. };
  133. /* rx frame */
  134. struct __packed usb_8dev_rx_msg {
  135. u8 begin;
  136. u8 type; /* frame type */
  137. u8 flags; /* RTR and EXT_ID flag */
  138. __be32 id; /* upper 3 bits not used */
  139. u8 dlc; /* data length code 0-8 bytes */
  140. u8 data[8]; /* 64-bit data */
  141. __be32 timestamp; /* 32-bit timestamp */
  142. u8 end;
  143. };
  144. /* command frame */
  145. struct __packed usb_8dev_cmd_msg {
  146. u8 begin;
  147. u8 channel; /* unkown - always 0 */
  148. u8 command; /* command to execute */
  149. u8 opt1; /* optional parameter / return value */
  150. u8 opt2; /* optional parameter 2 */
  151. u8 data[10]; /* optional parameter and data */
  152. u8 end;
  153. };
  154. static int usb_8dev_send_cmd_msg(struct usb_8dev_priv *priv, u8 *msg, int size)
  155. {
  156. int actual_length;
  157. return usb_bulk_msg(priv->udev,
  158. usb_sndbulkpipe(priv->udev, USB_8DEV_ENDP_CMD_TX),
  159. msg, size, &actual_length, USB_8DEV_CMD_TIMEOUT);
  160. }
  161. static int usb_8dev_wait_cmd_msg(struct usb_8dev_priv *priv, u8 *msg, int size,
  162. int *actual_length)
  163. {
  164. return usb_bulk_msg(priv->udev,
  165. usb_rcvbulkpipe(priv->udev, USB_8DEV_ENDP_CMD_RX),
  166. msg, size, actual_length, USB_8DEV_CMD_TIMEOUT);
  167. }
  168. /* Send command to device and receive result.
  169. * Command was successful when opt1 = 0.
  170. */
  171. static int usb_8dev_send_cmd(struct usb_8dev_priv *priv,
  172. struct usb_8dev_cmd_msg *out,
  173. struct usb_8dev_cmd_msg *in)
  174. {
  175. int err;
  176. int num_bytes_read;
  177. struct net_device *netdev;
  178. netdev = priv->netdev;
  179. out->begin = USB_8DEV_CMD_START;
  180. out->end = USB_8DEV_CMD_END;
  181. mutex_lock(&priv->usb_8dev_cmd_lock);
  182. memcpy(priv->cmd_msg_buffer, out,
  183. sizeof(struct usb_8dev_cmd_msg));
  184. err = usb_8dev_send_cmd_msg(priv, priv->cmd_msg_buffer,
  185. sizeof(struct usb_8dev_cmd_msg));
  186. if (err < 0) {
  187. netdev_err(netdev, "sending command message failed\n");
  188. goto failed;
  189. }
  190. err = usb_8dev_wait_cmd_msg(priv, priv->cmd_msg_buffer,
  191. sizeof(struct usb_8dev_cmd_msg),
  192. &num_bytes_read);
  193. if (err < 0) {
  194. netdev_err(netdev, "no command message answer\n");
  195. goto failed;
  196. }
  197. memcpy(in, priv->cmd_msg_buffer, sizeof(struct usb_8dev_cmd_msg));
  198. if (in->begin != USB_8DEV_CMD_START || in->end != USB_8DEV_CMD_END ||
  199. num_bytes_read != 16 || in->opt1 != 0)
  200. err = -EPROTO;
  201. failed:
  202. mutex_unlock(&priv->usb_8dev_cmd_lock);
  203. return err;
  204. }
  205. /* Send open command to device */
  206. static int usb_8dev_cmd_open(struct usb_8dev_priv *priv)
  207. {
  208. struct can_bittiming *bt = &priv->can.bittiming;
  209. struct usb_8dev_cmd_msg outmsg;
  210. struct usb_8dev_cmd_msg inmsg;
  211. u32 ctrlmode = priv->can.ctrlmode;
  212. u32 flags = USB_8DEV_STATUS_FRAME;
  213. __be32 beflags;
  214. __be16 bebrp;
  215. memset(&outmsg, 0, sizeof(outmsg));
  216. outmsg.command = USB_8DEV_OPEN;
  217. outmsg.opt1 = USB_8DEV_BAUD_MANUAL;
  218. outmsg.data[0] = bt->prop_seg + bt->phase_seg1;
  219. outmsg.data[1] = bt->phase_seg2;
  220. outmsg.data[2] = bt->sjw;
  221. /* BRP */
  222. bebrp = cpu_to_be16((u16)bt->brp);
  223. memcpy(&outmsg.data[3], &bebrp, sizeof(bebrp));
  224. /* flags */
  225. if (ctrlmode & CAN_CTRLMODE_LOOPBACK)
  226. flags |= USB_8DEV_LOOPBACK;
  227. if (ctrlmode & CAN_CTRLMODE_LISTENONLY)
  228. flags |= USB_8DEV_SILENT;
  229. if (ctrlmode & CAN_CTRLMODE_ONE_SHOT)
  230. flags |= USB_8DEV_DISABLE_AUTO_RESTRANS;
  231. beflags = cpu_to_be32(flags);
  232. memcpy(&outmsg.data[5], &beflags, sizeof(beflags));
  233. return usb_8dev_send_cmd(priv, &outmsg, &inmsg);
  234. }
  235. /* Send close command to device */
  236. static int usb_8dev_cmd_close(struct usb_8dev_priv *priv)
  237. {
  238. struct usb_8dev_cmd_msg inmsg;
  239. struct usb_8dev_cmd_msg outmsg = {
  240. .channel = 0,
  241. .command = USB_8DEV_CLOSE,
  242. .opt1 = 0,
  243. .opt2 = 0
  244. };
  245. return usb_8dev_send_cmd(priv, &outmsg, &inmsg);
  246. }
  247. /* Get firmware and hardware version */
  248. static int usb_8dev_cmd_version(struct usb_8dev_priv *priv, u32 *res)
  249. {
  250. struct usb_8dev_cmd_msg inmsg;
  251. struct usb_8dev_cmd_msg outmsg = {
  252. .channel = 0,
  253. .command = USB_8DEV_GET_SOFTW_HARDW_VER,
  254. .opt1 = 0,
  255. .opt2 = 0
  256. };
  257. int err = usb_8dev_send_cmd(priv, &outmsg, &inmsg);
  258. if (err)
  259. return err;
  260. *res = be32_to_cpup((__be32 *)inmsg.data);
  261. return err;
  262. }
  263. /* Set network device mode
  264. *
  265. * Maybe we should leave this function empty, because the device
  266. * set mode variable with open command.
  267. */
  268. static int usb_8dev_set_mode(struct net_device *netdev, enum can_mode mode)
  269. {
  270. struct usb_8dev_priv *priv = netdev_priv(netdev);
  271. int err = 0;
  272. switch (mode) {
  273. case CAN_MODE_START:
  274. err = usb_8dev_cmd_open(priv);
  275. if (err)
  276. netdev_warn(netdev, "couldn't start device");
  277. break;
  278. default:
  279. return -EOPNOTSUPP;
  280. }
  281. return err;
  282. }
  283. /* Read error/status frames */
  284. static void usb_8dev_rx_err_msg(struct usb_8dev_priv *priv,
  285. struct usb_8dev_rx_msg *msg)
  286. {
  287. struct can_frame *cf;
  288. struct sk_buff *skb;
  289. struct net_device_stats *stats = &priv->netdev->stats;
  290. /* Error message:
  291. * byte 0: Status
  292. * byte 1: bit 7: Receive Passive
  293. * byte 1: bit 0-6: Receive Error Counter
  294. * byte 2: Transmit Error Counter
  295. * byte 3: Always 0 (maybe reserved for future use)
  296. */
  297. u8 state = msg->data[0];
  298. u8 rxerr = msg->data[1] & USB_8DEV_RP_MASK;
  299. u8 txerr = msg->data[2];
  300. int rx_errors = 0;
  301. int tx_errors = 0;
  302. skb = alloc_can_err_skb(priv->netdev, &cf);
  303. if (!skb)
  304. return;
  305. switch (state) {
  306. case USB_8DEV_STATUSMSG_OK:
  307. priv->can.state = CAN_STATE_ERROR_ACTIVE;
  308. cf->can_id |= CAN_ERR_PROT;
  309. cf->data[2] = CAN_ERR_PROT_ACTIVE;
  310. break;
  311. case USB_8DEV_STATUSMSG_BUSOFF:
  312. priv->can.state = CAN_STATE_BUS_OFF;
  313. cf->can_id |= CAN_ERR_BUSOFF;
  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_unanchor_urb(urb);
  575. usb_free_coherent(priv->udev, size, buf, urb->transfer_dma);
  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. };
  716. static const struct can_bittiming_const usb_8dev_bittiming_const = {
  717. .name = "usb_8dev",
  718. .tseg1_min = 1,
  719. .tseg1_max = 16,
  720. .tseg2_min = 1,
  721. .tseg2_max = 8,
  722. .sjw_max = 4,
  723. .brp_min = 1,
  724. .brp_max = 1024,
  725. .brp_inc = 1,
  726. };
  727. /* Probe USB device
  728. *
  729. * Check device and firmware.
  730. * Set supported modes and bittiming constants.
  731. * Allocate some memory.
  732. */
  733. static int usb_8dev_probe(struct usb_interface *intf,
  734. const struct usb_device_id *id)
  735. {
  736. struct net_device *netdev;
  737. struct usb_8dev_priv *priv;
  738. int i, err = -ENOMEM;
  739. u32 version;
  740. char buf[18];
  741. struct usb_device *usbdev = interface_to_usbdev(intf);
  742. /* product id looks strange, better we also check iProduct string */
  743. if (usb_string(usbdev, usbdev->descriptor.iProduct, buf,
  744. sizeof(buf)) > 0 && strcmp(buf, "USB2CAN converter")) {
  745. dev_info(&usbdev->dev, "ignoring: not an USB2CAN converter\n");
  746. return -ENODEV;
  747. }
  748. netdev = alloc_candev(sizeof(struct usb_8dev_priv), MAX_TX_URBS);
  749. if (!netdev) {
  750. dev_err(&intf->dev, "Couldn't alloc candev\n");
  751. return -ENOMEM;
  752. }
  753. priv = netdev_priv(netdev);
  754. priv->udev = usbdev;
  755. priv->netdev = netdev;
  756. priv->can.state = CAN_STATE_STOPPED;
  757. priv->can.clock.freq = USB_8DEV_ABP_CLOCK;
  758. priv->can.bittiming_const = &usb_8dev_bittiming_const;
  759. priv->can.do_set_mode = usb_8dev_set_mode;
  760. priv->can.do_get_berr_counter = usb_8dev_get_berr_counter;
  761. priv->can.ctrlmode_supported = CAN_CTRLMODE_LOOPBACK |
  762. CAN_CTRLMODE_LISTENONLY |
  763. CAN_CTRLMODE_ONE_SHOT;
  764. netdev->netdev_ops = &usb_8dev_netdev_ops;
  765. netdev->flags |= IFF_ECHO; /* we support local echo */
  766. init_usb_anchor(&priv->rx_submitted);
  767. init_usb_anchor(&priv->tx_submitted);
  768. atomic_set(&priv->active_tx_urbs, 0);
  769. for (i = 0; i < MAX_TX_URBS; i++)
  770. priv->tx_contexts[i].echo_index = MAX_TX_URBS;
  771. priv->cmd_msg_buffer = kzalloc(sizeof(struct usb_8dev_cmd_msg),
  772. GFP_KERNEL);
  773. if (!priv->cmd_msg_buffer)
  774. goto cleanup_candev;
  775. usb_set_intfdata(intf, priv);
  776. SET_NETDEV_DEV(netdev, &intf->dev);
  777. mutex_init(&priv->usb_8dev_cmd_lock);
  778. err = register_candev(netdev);
  779. if (err) {
  780. netdev_err(netdev,
  781. "couldn't register CAN device: %d\n", err);
  782. goto cleanup_cmd_msg_buffer;
  783. }
  784. err = usb_8dev_cmd_version(priv, &version);
  785. if (err) {
  786. netdev_err(netdev, "can't get firmware version\n");
  787. goto cleanup_unregister_candev;
  788. } else {
  789. netdev_info(netdev,
  790. "firmware: %d.%d, hardware: %d.%d\n",
  791. (version>>24) & 0xff, (version>>16) & 0xff,
  792. (version>>8) & 0xff, version & 0xff);
  793. }
  794. devm_can_led_init(netdev);
  795. return 0;
  796. cleanup_unregister_candev:
  797. unregister_netdev(priv->netdev);
  798. cleanup_cmd_msg_buffer:
  799. kfree(priv->cmd_msg_buffer);
  800. cleanup_candev:
  801. free_candev(netdev);
  802. return err;
  803. }
  804. /* Called by the usb core when driver is unloaded or device is removed */
  805. static void usb_8dev_disconnect(struct usb_interface *intf)
  806. {
  807. struct usb_8dev_priv *priv = usb_get_intfdata(intf);
  808. usb_set_intfdata(intf, NULL);
  809. if (priv) {
  810. netdev_info(priv->netdev, "device disconnected\n");
  811. unregister_netdev(priv->netdev);
  812. free_candev(priv->netdev);
  813. unlink_all_urbs(priv);
  814. }
  815. }
  816. static struct usb_driver usb_8dev_driver = {
  817. .name = "usb_8dev",
  818. .probe = usb_8dev_probe,
  819. .disconnect = usb_8dev_disconnect,
  820. .id_table = usb_8dev_table,
  821. };
  822. module_usb_driver(usb_8dev_driver);
  823. MODULE_AUTHOR("Bernd Krumboeck <krumboeck@universalnet.at>");
  824. MODULE_DESCRIPTION("CAN driver for 8 devices USB2CAN interfaces");
  825. MODULE_LICENSE("GPL v2");