1 // SPDX-License-Identifier: GPL-2.0
2 /* ELM327 based CAN interface driver (tty line discipline)
4 * This driver started as a derivative of linux/drivers/net/can/slcan.c
5 * and my thanks go to the original authors for their inspiration.
7 * can327.c Author : Max Staudt <max-linux@enpas.org>
8 * slcan.c Author : Oliver Hartkopp <socketcan@hartkopp.net>
9 * slip.c Authors : Laurence Culhane <loz@holmes.demon.co.uk>
10 * Fred N. van Kempen <waltje@uwalt.nl.mugnet.org>
13 #define pr_fmt(fmt) "can327: " fmt
15 #include <linux/init.h>
16 #include <linux/module.h>
18 #include <linux/bitops.h>
19 #include <linux/ctype.h>
20 #include <linux/errno.h>
21 #include <linux/kernel.h>
22 #include <linux/list.h>
23 #include <linux/lockdep.h>
24 #include <linux/netdevice.h>
25 #include <linux/skbuff.h>
26 #include <linux/spinlock.h>
27 #include <linux/string.h>
28 #include <linux/tty.h>
29 #include <linux/tty_ldisc.h>
30 #include <linux/version.h>
31 #include <linux/workqueue.h>
33 #include <uapi/linux/tty.h>
35 #include <linux/can.h>
36 #include <linux/can/dev.h>
37 #include <linux/can/error.h>
38 #include <linux/can/led.h>
39 #include <linux/can/rx-offload.h>
41 /* Line discipline ID number.
42 * Starting with Linux v5.18-rc1, N_DEVELOPMENT is defined as 29:
43 * https://github.com/torvalds/linux/commit/c2faf737abfb10f88f2d2612d573e9edc3c42c37
46 #define N_DEVELOPMENT 29
49 /* Compatibility for Linux < 5.11 */
50 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,11,0)
54 #define ELM327_NAPI_WEIGHT 4
56 #define ELM327_SIZE_RXBUF 992
57 #define ELM327_SIZE_TXBUF 32
59 #define ELM327_CAN_CONFIG_SEND_SFF 0x8000
60 #define ELM327_CAN_CONFIG_VARIABLE_DLC 0x4000
61 #define ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF 0x2000
62 #define ELM327_CAN_CONFIG_BAUDRATE_MULT_8_7 0x1000
64 #define ELM327_DUMMY_CHAR 'y'
65 #define ELM327_DUMMY_STRING "y"
66 #define ELM327_READY_CHAR '>'
68 /* Bits in elm->cmds_todo */
70 ELM327_TX_DO_CAN_DATA = 0,
71 ELM327_TX_DO_CANID_11BIT,
72 ELM327_TX_DO_CANID_29BIT_LOW,
73 ELM327_TX_DO_CANID_29BIT_HIGH,
74 ELM327_TX_DO_CAN_CONFIG_PART2,
75 ELM327_TX_DO_CAN_CONFIG,
76 ELM327_TX_DO_RESPONSES,
77 ELM327_TX_DO_SILENT_MONITOR,
82 /* This must be the first member when using alloc_candev() */
85 struct can_rx_offload offload;
88 u8 rxbuf[ELM327_SIZE_RXBUF];
89 u8 txbuf[ELM327_SIZE_TXBUF];
91 /* Per-channel lock */
94 /* TTY and netdev devices that we're bridging */
95 struct tty_struct *tty;
96 struct net_device *dev;
98 /* TTY buffer accounting */
99 struct work_struct tx_work; /* Flushes TTY TX buffer */
100 u8 *txhead; /* Next TX byte */
101 size_t txleft; /* Bytes left to TX */
102 int rxfill; /* Bytes already RX'd in buffer */
106 ELM327_STATE_NOTINIT = 0,
107 ELM327_STATE_GETDUMMYCHAR,
108 ELM327_STATE_GETPROMPT,
109 ELM327_STATE_RECEIVING,
112 /* Things we have yet to send */
113 char **next_init_cmd;
114 unsigned long cmds_todo;
116 /* The CAN frame and config the ELM327 is sending/using,
117 * or will send/use after finishing all cmds_todo
119 struct can_frame can_frame_to_send;
121 u8 can_bitrate_divisor;
126 /* Stop the channel on UART side hardware failure, e.g. stray
127 * characters or neverending lines. This may be caused by bad
128 * UART wiring, a bad ELM327, a bad UART bridge...
129 * Once this is true, nothing will be sent to the TTY.
131 bool uart_side_failure;
134 static inline void elm327_uart_side_failure(struct can327 *elm);
136 static void elm327_send(struct can327 *elm, const void *buf, size_t len)
140 lockdep_assert_held(&elm->lock);
142 if (elm->uart_side_failure)
145 memcpy(elm->txbuf, buf, len);
147 /* Order of next two lines is *very* important.
148 * When we are sending a little amount of data,
149 * the transfer may be completed inside the ops->write()
150 * routine, because it's running with interrupts enabled.
151 * In this case we *never* got WRITE_WAKEUP event,
152 * if we did not request it before write operation.
153 * 14 Oct 1994 Dmitry Gorodchanin.
155 set_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
156 written = elm->tty->ops->write(elm->tty, elm->txbuf, len);
159 "Failed to write to tty %s.\n",
161 elm327_uart_side_failure(elm);
165 elm->txleft = len - written;
166 elm->txhead = elm->txbuf + written;
169 /* Take the ELM327 out of almost any state and back into command mode.
170 * We send ELM327_DUMMY_CHAR which will either abort any running
171 * operation, or be echoed back to us in case we're already in command
174 static void elm327_kick_into_cmd_mode(struct can327 *elm)
176 lockdep_assert_held(&elm->lock);
178 if (elm->state != ELM327_STATE_GETDUMMYCHAR &&
179 elm->state != ELM327_STATE_GETPROMPT) {
180 elm327_send(elm, ELM327_DUMMY_STRING, 1);
182 elm->state = ELM327_STATE_GETDUMMYCHAR;
186 /* Schedule a CAN frame and necessary config changes to be sent to the TTY. */
187 static void elm327_send_frame(struct can327 *elm, struct can_frame *frame)
189 lockdep_assert_held(&elm->lock);
191 /* Schedule any necessary changes in ELM327's CAN configuration */
192 if (elm->can_frame_to_send.can_id != frame->can_id) {
193 /* Set the new CAN ID for transmission. */
194 if ((frame->can_id ^ elm->can_frame_to_send.can_id)
196 elm->can_config = (frame->can_id & CAN_EFF_FLAG
198 : ELM327_CAN_CONFIG_SEND_SFF)
199 | ELM327_CAN_CONFIG_VARIABLE_DLC
200 | ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF
201 | elm->can_bitrate_divisor;
203 set_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo);
206 if (frame->can_id & CAN_EFF_FLAG) {
207 clear_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo);
208 set_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo);
209 set_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo);
211 set_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo);
212 clear_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo);
213 clear_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo);
217 /* Schedule the CAN frame itself. */
218 elm->can_frame_to_send = *frame;
219 set_bit(ELM327_TX_DO_CAN_DATA, &elm->cmds_todo);
221 elm327_kick_into_cmd_mode(elm);
224 /* ELM327 initialisation sequence.
225 * The line length is limited by the buffer in elm327_handle_prompt().
227 static char *elm327_init_script[] = {
228 "AT WS\r", /* v1.0: Warm Start */
229 "AT PP FF OFF\r", /* v1.0: All Programmable Parameters Off */
230 "AT M0\r", /* v1.0: Memory Off */
231 "AT AL\r", /* v1.0: Allow Long messages */
232 "AT BI\r", /* v1.0: Bypass Initialisation */
233 "AT CAF0\r", /* v1.0: CAN Auto Formatting Off */
234 "AT CFC0\r", /* v1.0: CAN Flow Control Off */
235 "AT CF 000\r", /* v1.0: Reset CAN ID Filter */
236 "AT CM 000\r", /* v1.0: Reset CAN ID Mask */
237 "AT E1\r", /* v1.0: Echo On */
238 "AT H1\r", /* v1.0: Headers On */
239 "AT L0\r", /* v1.0: Linefeeds Off */
240 "AT SH 7DF\r", /* v1.0: Set CAN sending ID to 0x7df */
241 "AT ST FF\r", /* v1.0: Set maximum Timeout for response after TX */
242 "AT AT0\r", /* v1.2: Adaptive Timing Off */
243 "AT D1\r", /* v1.3: Print DLC On */
244 "AT S1\r", /* v1.3: Spaces On */
245 "AT TP B\r", /* v1.0: Try Protocol B */
249 static void elm327_init(struct can327 *elm)
251 lockdep_assert_held(&elm->lock);
253 elm->state = ELM327_STATE_NOTINIT;
254 elm->can_frame_to_send.can_id = 0x7df; /* ELM327 HW default */
256 elm->drop_next_line = 0;
258 /* We can only set the bitrate as a fraction of 500000.
259 * The bit timing constants in can327_bittiming_const will
260 * limit the user to the right values.
262 elm->can_bitrate_divisor = 500000 / elm->can.bittiming.bitrate;
263 elm->can_config = ELM327_CAN_CONFIG_SEND_SFF
264 | ELM327_CAN_CONFIG_VARIABLE_DLC
265 | ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF
266 | elm->can_bitrate_divisor;
268 /* Configure ELM327 and then start monitoring */
269 elm->next_init_cmd = &elm327_init_script[0];
270 set_bit(ELM327_TX_DO_INIT, &elm->cmds_todo);
271 set_bit(ELM327_TX_DO_SILENT_MONITOR, &elm->cmds_todo);
272 set_bit(ELM327_TX_DO_RESPONSES, &elm->cmds_todo);
273 set_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo);
275 elm327_kick_into_cmd_mode(elm);
278 static void elm327_feed_frame_to_netdev(struct can327 *elm,
281 lockdep_assert_held(&elm->lock);
283 if (!netif_running(elm->dev))
286 /* Queue for NAPI pickup.
287 * rx-offload will update stats and LEDs for us.
289 if (can_rx_offload_queue_tail(&elm->offload, skb))
290 elm->dev->stats.rx_fifo_errors++;
292 #if LINUX_VERSION_CODE >= KERNEL_VERSION(5,15,0)
294 can_rx_offload_irq_finish(&elm->offload);
298 /* Called when we're out of ideas and just want it all to end. */
299 static inline void elm327_uart_side_failure(struct can327 *elm)
301 struct can_frame *frame;
304 lockdep_assert_held(&elm->lock);
306 elm->uart_side_failure = true;
308 clear_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
310 elm->can.can_stats.bus_off++;
311 netif_stop_queue(elm->dev);
312 elm->can.state = CAN_STATE_BUS_OFF;
313 can_bus_off(elm->dev);
315 netdev_err(elm->dev, "ELM327 misbehaved. Blocking further communication.\n");
317 skb = alloc_can_err_skb(elm->dev, &frame);
321 frame->can_id |= CAN_ERR_BUSOFF;
322 elm327_feed_frame_to_netdev(elm, skb);
325 /* Compares a byte buffer (non-NUL terminated) to the payload part of a string,
326 * and returns true iff the buffer (content *and* length) is exactly that
327 * string, without the terminating NUL byte.
329 * Example: If reference is "BUS ERROR", then this returns true iff nbytes == 9
330 * and !memcmp(buf, "BUS ERROR", 9).
332 * The reason to use strings is so we can easily include them in the C code,
333 * and to avoid hardcoding lengths.
335 static inline bool elm327_rxbuf_cmp(const u8 *buf, size_t nbytes, const char *reference)
337 size_t ref_len = strlen(reference);
339 return (nbytes == ref_len) && !memcmp(buf, reference, ref_len);
342 static void elm327_parse_error(struct can327 *elm, size_t len)
344 struct can_frame *frame;
347 lockdep_assert_held(&elm->lock);
349 skb = alloc_can_err_skb(elm->dev, &frame);
351 /* It's okay to return here:
352 * The outer parsing loop will drop this UART buffer.
356 /* Filter possible error messages based on length of RX'd line */
357 if (elm327_rxbuf_cmp(elm->rxbuf, len, "UNABLE TO CONNECT")) {
359 "ELM327 reported UNABLE TO CONNECT. Please check your setup.\n");
360 } else if (elm327_rxbuf_cmp(elm->rxbuf, len, "BUFFER FULL")) {
361 /* This will only happen if the last data line was complete.
362 * Otherwise, elm327_parse_frame() will heuristically
363 * emit this kind of error frame instead.
365 frame->can_id |= CAN_ERR_CRTL;
366 frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
367 } else if (elm327_rxbuf_cmp(elm->rxbuf, len, "BUS ERROR")) {
368 frame->can_id |= CAN_ERR_BUSERROR;
369 } else if (elm327_rxbuf_cmp(elm->rxbuf, len, "CAN ERROR")) {
370 frame->can_id |= CAN_ERR_PROT;
371 } else if (elm327_rxbuf_cmp(elm->rxbuf, len, "<RX ERROR")) {
372 frame->can_id |= CAN_ERR_PROT;
373 } else if (elm327_rxbuf_cmp(elm->rxbuf, len, "BUS BUSY")) {
374 frame->can_id |= CAN_ERR_PROT;
375 frame->data[2] = CAN_ERR_PROT_OVERLOAD;
376 } else if (elm327_rxbuf_cmp(elm->rxbuf, len, "FB ERROR")) {
377 frame->can_id |= CAN_ERR_PROT;
378 frame->data[2] = CAN_ERR_PROT_TX;
379 } else if (len == 5 && !memcmp(elm->rxbuf, "ERR", 3)) {
380 /* ERR is followed by two digits, hence line length 5 */
381 netdev_err(elm->dev, "ELM327 reported an ERR%c%c. Please power it off and on again.\n",
382 elm->rxbuf[3], elm->rxbuf[4]);
383 frame->can_id |= CAN_ERR_CRTL;
385 /* Something else has happened.
386 * Maybe garbage on the UART line.
387 * Emit a generic error frame.
391 elm327_feed_frame_to_netdev(elm, skb);
394 /* Parse CAN frames coming as ASCII from ELM327.
395 * They can be of various formats:
397 * 29-bit ID (EFF): 12 34 56 78 D PL PL PL PL PL PL PL PL
398 * 11-bit ID (!EFF): 123 D PL PL PL PL PL PL PL PL
400 * where D = DLC, PL = payload byte
402 * Instead of a payload, RTR indicates a remote request.
404 * We will use the spaces and line length to guess the format.
406 static int elm327_parse_frame(struct can327 *elm, size_t len)
408 struct can_frame *frame;
414 lockdep_assert_held(&elm->lock);
416 skb = alloc_can_skb(elm->dev, &frame);
420 /* Find first non-hex and non-space character:
421 * - In the simplest case, there is none.
422 * - For RTR frames, 'R' is the first non-hex character.
423 * - An error message may replace the end of the data line.
425 for (hexlen = 0; hexlen <= len; hexlen++) {
426 if (hex_to_bin(elm->rxbuf[hexlen]) < 0 &&
427 elm->rxbuf[hexlen] != ' ') {
432 /* Sanity check whether the line is really a clean hexdump,
433 * or terminated by an error message, or contains garbage.
436 !isdigit(elm->rxbuf[hexlen]) &&
437 !isupper(elm->rxbuf[hexlen]) &&
438 '<' != elm->rxbuf[hexlen] &&
439 ' ' != elm->rxbuf[hexlen]) {
440 /* The line is likely garbled anyway, so bail.
441 * The main code will restart listening.
446 /* Use spaces in CAN ID to distinguish 29 or 11 bit address length.
447 * No out-of-bounds access:
448 * We use the fact that we can always read from elm->rxbuf.
450 if (elm->rxbuf[2] == ' ' && elm->rxbuf[5] == ' ' &&
451 elm->rxbuf[8] == ' ' && elm->rxbuf[11] == ' ' &&
452 elm->rxbuf[13] == ' ') {
453 frame->can_id = CAN_EFF_FLAG;
455 } else if (elm->rxbuf[3] == ' ' && elm->rxbuf[5] == ' ') {
458 /* This is not a well-formatted data line.
459 * Assume it's an error message.
464 if (hexlen < datastart) {
465 /* The line is too short to be a valid frame hex dump.
466 * Something interrupted the hex dump or it is invalid.
471 /* From here on all chars up to buf[hexlen] are hex or spaces,
472 * at well-defined offsets.
475 /* Read CAN data length */
476 frame->len = (hex_to_bin(elm->rxbuf[datastart - 2]) << 0);
479 if (frame->can_id & CAN_EFF_FLAG) {
480 frame->can_id |= (hex_to_bin(elm->rxbuf[0]) << 28)
481 | (hex_to_bin(elm->rxbuf[1]) << 24)
482 | (hex_to_bin(elm->rxbuf[3]) << 20)
483 | (hex_to_bin(elm->rxbuf[4]) << 16)
484 | (hex_to_bin(elm->rxbuf[6]) << 12)
485 | (hex_to_bin(elm->rxbuf[7]) << 8)
486 | (hex_to_bin(elm->rxbuf[9]) << 4)
487 | (hex_to_bin(elm->rxbuf[10]) << 0);
489 frame->can_id |= (hex_to_bin(elm->rxbuf[0]) << 8)
490 | (hex_to_bin(elm->rxbuf[1]) << 4)
491 | (hex_to_bin(elm->rxbuf[2]) << 0);
494 /* Check for RTR frame */
495 if (elm->rxfill >= hexlen + 3 &&
496 !memcmp(&elm->rxbuf[hexlen], "RTR", 3)) {
497 frame->can_id |= CAN_RTR_FLAG;
500 /* Is the line long enough to hold the advertised payload?
501 * Note: RTR frames have a DLC, but no actual payload.
503 if (!(frame->can_id & CAN_RTR_FLAG) &&
504 (hexlen < frame->len * 3 + datastart)) {
506 * Probably the ELM327's RS232 TX buffer was full.
507 * Emit an error frame and exit.
509 frame->can_id = CAN_ERR_FLAG | CAN_ERR_CRTL;
510 frame->len = CAN_ERR_DLC;
511 frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
512 elm327_feed_frame_to_netdev(elm, skb);
514 /* Signal failure to parse.
515 * The line will be re-parsed as an error line, which will fail.
516 * However, this will correctly drop the state machine back into
522 /* Parse the data nibbles. */
523 for (i = 0; i < frame->len; i++) {
524 frame->data[i] = (hex_to_bin(elm->rxbuf[datastart + 3*i]) << 4)
525 | (hex_to_bin(elm->rxbuf[datastart + 3*i + 1]));
528 /* Feed the frame to the network layer. */
529 elm327_feed_frame_to_netdev(elm, skb);
534 static void elm327_parse_line(struct can327 *elm, size_t len)
536 lockdep_assert_held(&elm->lock);
538 /* Skip empty lines */
542 /* Skip echo lines */
543 if (elm->drop_next_line) {
544 elm->drop_next_line = 0;
546 } else if (!memcmp(elm->rxbuf, "AT", 2)) {
550 /* Regular parsing */
551 if (elm->state == ELM327_STATE_RECEIVING &&
552 elm327_parse_frame(elm, len)) {
553 /* Parse an error line. */
554 elm327_parse_error(elm, len);
557 elm327_kick_into_cmd_mode(elm);
561 static void elm327_handle_prompt(struct can327 *elm)
563 struct can_frame *frame = &elm->can_frame_to_send;
564 /* Size this buffer for the largest ELM327 line we may generate,
565 * which is currently an 8 byte CAN frame's payload hexdump.
566 * Items in elm327_init_script must fit here, too!
568 char local_txbuf[sizeof("0102030405060708\r")];
570 lockdep_assert_held(&elm->lock);
572 if (!elm->cmds_todo) {
573 /* Enter CAN monitor mode */
574 elm327_send(elm, "ATMA\r", 5);
575 elm->state = ELM327_STATE_RECEIVING;
577 /* We will be in the default state once this command is
578 * sent, so enable the TX packet queue.
580 netif_wake_queue(elm->dev);
585 /* Reconfigure ELM327 step by step as indicated by elm->cmds_todo */
586 if (test_bit(ELM327_TX_DO_INIT, &elm->cmds_todo)) {
587 snprintf(local_txbuf, sizeof(local_txbuf),
589 *elm->next_init_cmd);
591 elm->next_init_cmd++;
592 if (!(*elm->next_init_cmd)) {
593 clear_bit(ELM327_TX_DO_INIT, &elm->cmds_todo);
597 } else if (test_and_clear_bit(ELM327_TX_DO_SILENT_MONITOR, &elm->cmds_todo)) {
598 snprintf(local_txbuf, sizeof(local_txbuf),
600 !!(elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY));
602 } else if (test_and_clear_bit(ELM327_TX_DO_RESPONSES, &elm->cmds_todo)) {
603 snprintf(local_txbuf, sizeof(local_txbuf),
605 !(elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY));
607 } else if (test_and_clear_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo)) {
608 snprintf(local_txbuf, sizeof(local_txbuf),
610 set_bit(ELM327_TX_DO_CAN_CONFIG_PART2, &elm->cmds_todo);
612 } else if (test_and_clear_bit(ELM327_TX_DO_CAN_CONFIG_PART2, &elm->cmds_todo)) {
613 snprintf(local_txbuf, sizeof(local_txbuf),
617 } else if (test_and_clear_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo)) {
618 snprintf(local_txbuf, sizeof(local_txbuf),
620 (frame->can_id & CAN_EFF_MASK) >> 24);
622 } else if (test_and_clear_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo)) {
623 snprintf(local_txbuf, sizeof(local_txbuf),
625 frame->can_id & CAN_EFF_MASK & ((1 << 24) - 1));
627 } else if (test_and_clear_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo)) {
628 snprintf(local_txbuf, sizeof(local_txbuf),
630 frame->can_id & CAN_SFF_MASK);
632 } else if (test_and_clear_bit(ELM327_TX_DO_CAN_DATA, &elm->cmds_todo)) {
633 if (frame->can_id & CAN_RTR_FLAG) {
634 /* Send an RTR frame. Their DLC is fixed.
635 * Some chips don't send them at all.
637 snprintf(local_txbuf, sizeof(local_txbuf),
640 /* Send a regular CAN data frame */
643 for (i = 0; i < frame->len; i++) {
644 snprintf(&local_txbuf[2 * i], sizeof(local_txbuf),
649 snprintf(&local_txbuf[2 * i], sizeof(local_txbuf),
653 elm->drop_next_line = 1;
654 elm->state = ELM327_STATE_RECEIVING;
656 /* We will be in the default state once this command is
657 * sent, so enable the TX packet queue.
659 netif_wake_queue(elm->dev);
662 elm327_send(elm, local_txbuf, strlen(local_txbuf));
665 static bool elm327_is_ready_char(char c)
667 /* Bits 0xc0 are sometimes set (randomly), hence the mask.
668 * Probably bad hardware.
670 return (c & 0x3f) == ELM327_READY_CHAR;
673 static void elm327_drop_bytes(struct can327 *elm, size_t i)
675 lockdep_assert_held(&elm->lock);
677 memmove(&elm->rxbuf[0], &elm->rxbuf[i], ELM327_SIZE_RXBUF - i);
681 static void elm327_parse_rxbuf(struct can327 *elm, size_t first_new_char_idx)
685 lockdep_assert_held(&elm->lock);
687 switch (elm->state) {
688 case ELM327_STATE_NOTINIT:
692 case ELM327_STATE_GETDUMMYCHAR:
693 /* Wait for 'y' or '>' */
694 for (pos = 0; pos < elm->rxfill; pos++) {
695 if (elm->rxbuf[pos] == ELM327_DUMMY_CHAR) {
696 elm327_send(elm, "\r", 1);
697 elm->state = ELM327_STATE_GETPROMPT;
700 } else if (elm327_is_ready_char(elm->rxbuf[pos])) {
701 elm327_send(elm, ELM327_DUMMY_STRING, 1);
707 elm327_drop_bytes(elm, pos);
710 case ELM327_STATE_GETPROMPT:
712 if (elm327_is_ready_char(elm->rxbuf[elm->rxfill - 1]))
713 elm327_handle_prompt(elm);
718 case ELM327_STATE_RECEIVING:
719 /* Find <CR> delimiting feedback lines. */
720 len = first_new_char_idx;
721 while (len < elm->rxfill && elm->rxbuf[len] != '\r')
724 if (len == ELM327_SIZE_RXBUF) {
725 /* Assume the buffer ran full with garbage.
726 * Did we even connect at the right baud rate?
729 "RX buffer overflow. Faulty ELM327 or UART?\n");
730 elm327_uart_side_failure(elm);
731 } else if (len == elm->rxfill) {
732 if (elm327_is_ready_char(elm->rxbuf[elm->rxfill - 1])) {
733 /* The ELM327's AT ST response timeout ran out,
734 * so we got a prompt.
735 * Clear RX buffer and restart listening.
739 elm327_handle_prompt(elm);
742 /* No <CR> found - we haven't received a full line yet.
743 * Wait for more data.
746 /* We have a full line to parse. */
747 elm327_parse_line(elm, len);
749 /* Remove parsed data from RX buffer. */
750 elm327_drop_bytes(elm, len + 1);
752 /* More data to parse? */
754 elm327_parse_rxbuf(elm, 0);
759 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,10,0)
760 /* Dummy needed to use can_rx_offload */
761 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,5,0)
762 static unsigned int *can327_mailbox_read(struct can_rx_offload *offload,
763 struct can_frame *cf,
764 u32 *timestamp, unsigned int n)
766 WARN_ON_ONCE(1); /* This function is a dummy, so don't call it! */
770 #else /* Since 4e9c9484b085 (included in v5.5) */
771 static struct sk_buff *can327_mailbox_read(struct can_rx_offload *offload,
772 unsigned int n, u32 *timestamp,
775 WARN_ON_ONCE(1); /* This function is a dummy, so don't call it! */
777 return ERR_PTR(-ENOBUFS);
782 static int can327_netdev_open(struct net_device *dev)
784 struct can327 *elm = netdev_priv(dev);
787 spin_lock_bh(&elm->lock);
790 spin_unlock_bh(&elm->lock);
794 if (elm->uart_side_failure)
795 netdev_warn(elm->dev, "Reopening netdev after a UART side fault has been detected.\n");
797 /* Clear TTY buffers */
801 /* open_candev() checks for elm->can.bittiming.bitrate != 0 */
802 err = open_candev(dev);
804 spin_unlock_bh(&elm->lock);
809 spin_unlock_bh(&elm->lock);
811 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,10,0)
812 elm->offload.mailbox_read = can327_mailbox_read;
813 err = can_rx_offload_add_fifo(dev, &elm->offload, ELM327_NAPI_WEIGHT);
815 err = can_rx_offload_add_manual(dev, &elm->offload, ELM327_NAPI_WEIGHT);
822 can_rx_offload_enable(&elm->offload);
824 can_led_event(dev, CAN_LED_EVENT_OPEN);
825 elm->can.state = CAN_STATE_ERROR_ACTIVE;
826 netif_start_queue(dev);
831 static int can327_netdev_close(struct net_device *dev)
833 struct can327 *elm = netdev_priv(dev);
835 /* Interrupt whatever the ELM327 is doing right now */
836 spin_lock_bh(&elm->lock);
837 elm327_send(elm, ELM327_DUMMY_STRING, 1);
838 spin_unlock_bh(&elm->lock);
840 netif_stop_queue(dev);
842 /* Give UART one final chance to flush. */
843 clear_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
844 flush_work(&elm->tx_work);
846 can_rx_offload_disable(&elm->offload);
847 elm->can.state = CAN_STATE_STOPPED;
848 can_rx_offload_del(&elm->offload);
850 can_led_event(dev, CAN_LED_EVENT_STOP);
855 /* Send a can_frame to a TTY. */
856 static netdev_tx_t can327_netdev_start_xmit(struct sk_buff *skb,
857 struct net_device *dev)
859 struct can327 *elm = netdev_priv(dev);
860 struct can_frame *frame = (struct can_frame *)skb->data;
862 if (can_dropped_invalid_skb(dev, skb))
865 /* This check will be part of can_dropped_invalid_skb()
868 if (elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
871 /* We shouldn't get here after a hardware fault:
872 * can_bus_off() calls netif_carrier_off()
874 if (elm->uart_side_failure) {
875 WARN_ON_ONCE(elm->uart_side_failure);
879 netif_stop_queue(dev);
881 /* BHs are already disabled, so no spin_lock_bh().
882 * See Documentation/networking/netdevices.txt
884 spin_lock(&elm->lock);
885 elm327_send_frame(elm, frame);
886 spin_unlock(&elm->lock);
888 dev->stats.tx_packets++;
889 dev->stats.tx_bytes += frame->len;
891 can_led_event(dev, CAN_LED_EVENT_TX);
898 static const struct net_device_ops can327_netdev_ops = {
899 .ndo_open = can327_netdev_open,
900 .ndo_stop = can327_netdev_close,
901 .ndo_start_xmit = can327_netdev_start_xmit,
902 .ndo_change_mtu = can_change_mtu,
905 static bool can327_is_valid_rx_char(u8 c)
907 static const bool lut_char_is_valid['z'] = {
911 ['0'] = true, true, true, true, true,
912 ['5'] = true, true, true, true, true,
914 [ELM327_READY_CHAR] = true,
916 ['A'] = true, true, true, true, true, true, true,
917 ['H'] = true, true, true, true, true, true, true,
918 ['O'] = true, true, true, true, true, true, true,
919 ['V'] = true, true, true, true, true,
923 [ELM327_DUMMY_CHAR] = true,
925 BUILD_BUG_ON(ELM327_DUMMY_CHAR >= 'z');
927 return (c < ARRAY_SIZE(lut_char_is_valid) &&
928 lut_char_is_valid[c]);
931 /* Handle incoming ELM327 ASCII data.
932 * This will not be re-entered while running, but other ldisc
933 * functions may be called in parallel.
935 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,14,0)
936 static void can327_ldisc_rx(struct tty_struct *tty,
937 const unsigned char *cp, char *fp, int count)
939 static void can327_ldisc_rx(struct tty_struct *tty,
940 const unsigned char *cp, const char *fp, int count)
943 struct can327 *elm = (struct can327 *)tty->disc_data;
944 size_t first_new_char_idx;
946 if (elm->uart_side_failure)
949 spin_lock_bh(&elm->lock);
951 /* Store old rxfill, so elm327_parse_rxbuf() will have
952 * the option of skipping already checked characters.
954 first_new_char_idx = elm->rxfill;
956 while (count-- && elm->rxfill < ELM327_SIZE_RXBUF) {
958 netdev_err(elm->dev, "Error in received character stream. Check your wiring.");
960 elm327_uart_side_failure(elm);
962 spin_unlock_bh(&elm->lock);
966 /* Ignore NUL characters, which the PIC microcontroller may
967 * inadvertently insert due to a known hardware bug.
968 * See ELM327 documentation, which refers to a Microchip PIC
972 /* Check for stray characters on the UART line.
973 * Likely caused by bad hardware.
975 if (!can327_is_valid_rx_char(*cp)) {
977 "Received illegal character %02x.\n",
979 elm327_uart_side_failure(elm);
981 spin_unlock_bh(&elm->lock);
985 elm->rxbuf[elm->rxfill++] = *cp;
992 netdev_err(elm->dev, "Receive buffer overflowed. Bad chip or wiring? count = %i", count);
994 elm327_uart_side_failure(elm);
996 spin_unlock_bh(&elm->lock);
1000 elm327_parse_rxbuf(elm, first_new_char_idx);
1001 spin_unlock_bh(&elm->lock);
1004 /* Write out remaining transmit buffer.
1005 * Scheduled when TTY is writable.
1007 static void can327_ldisc_tx_worker(struct work_struct *work)
1009 struct can327 *elm = container_of(work, struct can327, tx_work);
1012 if (elm->uart_side_failure)
1015 spin_lock_bh(&elm->lock);
1018 written = elm->tty->ops->write(elm->tty, elm->txhead, elm->txleft);
1020 netdev_err(elm->dev,
1021 "Failed to write to tty %s.\n",
1023 elm327_uart_side_failure(elm);
1025 spin_unlock_bh(&elm->lock);
1029 elm->txleft -= written;
1030 elm->txhead += written;
1034 clear_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
1036 spin_unlock_bh(&elm->lock);
1039 /* Called by the driver when there's room for more data. */
1040 static void can327_ldisc_tx_wakeup(struct tty_struct *tty)
1042 struct can327 *elm = (struct can327 *)tty->disc_data;
1044 schedule_work(&elm->tx_work);
1047 /* ELM327 can only handle bitrates that are integer divisors of 500 kHz,
1048 * or 7/8 of that. Divisors are 1 to 64.
1049 * Currently we don't implement support for 7/8 rates.
1051 static const u32 can327_bitrate_const[64] = {
1052 7812, 7936, 8064, 8196, 8333, 8474, 8620, 8771,
1053 8928, 9090, 9259, 9433, 9615, 9803, 10000, 10204,
1054 10416, 10638, 10869, 11111, 11363, 11627, 11904, 12195,
1055 12500, 12820, 13157, 13513, 13888, 14285, 14705, 15151,
1056 15625, 16129, 16666, 17241, 17857, 18518, 19230, 20000,
1057 20833, 21739, 22727, 23809, 25000, 26315, 27777, 29411,
1058 31250, 33333, 35714, 38461, 41666, 45454, 50000, 55555,
1059 62500, 71428, 83333, 100000, 125000, 166666, 250000, 500000
1062 /* Dummy needed to use bitrate_const */
1063 static int can327_do_set_bittiming(struct net_device *netdev)
1068 static int can327_ldisc_open(struct tty_struct *tty)
1070 struct net_device *dev;
1074 if (!capable(CAP_NET_ADMIN))
1077 if (!tty->ops->write)
1080 dev = alloc_candev(sizeof(struct can327), 0);
1083 elm = netdev_priv(dev);
1085 /* Configure TTY interface */
1086 tty->receive_room = 65536; /* We don't flow control */
1087 spin_lock_init(&elm->lock);
1088 INIT_WORK(&elm->tx_work, can327_ldisc_tx_worker);
1090 /* Configure CAN metadata */
1091 elm->can.bitrate_const = can327_bitrate_const;
1092 elm->can.bitrate_const_cnt = ARRAY_SIZE(can327_bitrate_const);
1093 elm->can.do_set_bittiming = can327_do_set_bittiming;
1094 elm->can.ctrlmode_supported = CAN_CTRLMODE_LISTENONLY;
1096 /* Configure netdev interface */
1098 dev->netdev_ops = &can327_netdev_ops;
1100 /* Mark ldisc channel as alive */
1102 tty->disc_data = elm;
1104 devm_can_led_init(elm->dev);
1107 err = register_candev(elm->dev);
1109 free_candev(elm->dev);
1113 netdev_info(elm->dev, "can327 on %s.\n", tty->name);
1118 /* Close down a can327 channel.
1119 * This means flushing out any pending queues, and then returning.
1120 * This call is serialized against other ldisc functions:
1121 * Once this is called, no other ldisc function of ours is entered.
1123 * We also use this function for a hangup event.
1125 static void can327_ldisc_close(struct tty_struct *tty)
1127 struct can327 *elm = (struct can327 *)tty->disc_data;
1129 /* unregister_netdev() calls .ndo_stop() so we don't have to.
1130 * Our .ndo_stop() also flushes the TTY write wakeup handler,
1131 * so we can safely set elm->tty = NULL after this.
1133 unregister_candev(elm->dev);
1135 /* Mark channel as dead */
1136 spin_lock_bh(&elm->lock);
1137 tty->disc_data = NULL;
1139 spin_unlock_bh(&elm->lock);
1141 netdev_info(elm->dev, "can327 off %s.\n", tty->name);
1143 free_candev(elm->dev);
1146 static int can327_ldisc_ioctl(struct tty_struct *tty,
1147 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,17,0)
1150 unsigned int cmd, unsigned long arg)
1152 struct can327 *elm = (struct can327 *)tty->disc_data;
1157 tmp = strnlen(elm->dev->name, IFNAMSIZ - 1) + 1;
1158 if (copy_to_user((void __user *)arg, elm->dev->name, tmp))
1166 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,16,0)
1167 return tty_mode_ioctl(tty, file, cmd, arg);
1169 return tty_mode_ioctl(tty, cmd, arg);
1174 static struct tty_ldisc_ops can327_ldisc = {
1175 .owner = THIS_MODULE,
1177 .num = N_DEVELOPMENT,
1178 .receive_buf = can327_ldisc_rx,
1179 .write_wakeup = can327_ldisc_tx_wakeup,
1180 .open = can327_ldisc_open,
1181 .close = can327_ldisc_close,
1182 .ioctl = can327_ldisc_ioctl,
1185 static int __init can327_init(void)
1189 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,14,0)
1190 status = tty_register_ldisc(N_DEVELOPMENT, &can327_ldisc);
1192 status = tty_register_ldisc(&can327_ldisc);
1195 pr_err("Can't register line discipline\n");
1200 static void __exit can327_exit(void)
1202 /* This will only be called when all channels have been closed by
1203 * userspace - tty_ldisc.c takes care of the module's refcount.
1205 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,14,0)
1208 status = tty_unregister_ldisc(N_DEVELOPMENT);
1210 pr_err("Can't unregister line discipline (error: %d)\n",
1213 tty_unregister_ldisc(&can327_ldisc);
1217 module_init(can327_init);
1218 module_exit(can327_exit);
1220 MODULE_ALIAS_LDISC(N_DEVELOPMENT);
1221 MODULE_DESCRIPTION("ELM327 based CAN interface");
1222 MODULE_LICENSE("GPL");
1223 MODULE_AUTHOR("Max Staudt <max-linux@enpas.org>");