module/elmcan.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /* ELM327 based CAN interface driver (tty line discipline)
   3  *
   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, even
   6  * after almost none of their code is left.
   7  *
   8  * elmcan.c Author : Max Staudt <max-linux@enpas.org>
   9  * slcan.c Author  : Oliver Hartkopp <socketcan@hartkopp.net>
  10  * slip.c Authors  : Laurence Culhane <loz@holmes.demon.co.uk>
  11  *                   Fred N. van Kempen <waltje@uwalt.nl.mugnet.org>
  12  */
  13
  14 #define pr_fmt(fmt) "elmcan: " fmt
  15
  16 #include <linux/init.h>
  17 #include <linux/module.h>
  18 #include <linux/moduleparam.h>
  19
  20 #include <linux/atomic.h>
  21 #include <linux/bitops.h>
  22 #include <linux/ctype.h>
  23 #include <linux/delay.h>
  24 #include <linux/errno.h>
  25 #include <linux/if_ether.h>
  26 #include <linux/kernel.h>
  27 #include <linux/list.h>
  28 #include <linux/lockdep.h>
  29 #include <linux/netdevice.h>
  30 #include <linux/skbuff.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/string.h>
  33 #include <linux/tty.h>
  34 #include <linux/tty_ldisc.h>
  35 #include <linux/version.h>
  36 #include <linux/workqueue.h>
  37
  38 #include <uapi/linux/tty.h>
  39
  40 #include <linux/can.h>
  41 #include <linux/can/dev.h>
  42 #include <linux/can/error.h>
  43 #include <linux/can/led.h>
  44 #include <linux/can/rx-offload.h>
  45
  46 /* Line discipline ID number.
  47  * N_DEVELOPMENT will likely be defined from Linux 5.18 onwards:
  48  * https://git.kernel.org/pub/scm/linux/kernel/git/gregkh/tty.git/commit/?h=tty-next&id=c2faf737abfb10f88f2d2612d573e9edc3c42c37
  49  */
  50 #ifndef N_DEVELOPMENT
  51 #define N_DEVELOPMENT 29
  52 #endif
  53
  54 /* Compatibility for Linux < 5.11 */
  55 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,11,0)
  56 #define len can_dlc
  57 #endif
  58
  59 #define ELM327_NAPI_WEIGHT 4
  60
  61 #define ELM327_SIZE_RXBUF 256
  62 #define ELM327_SIZE_TXBUF 32
  63
  64 #define ELM327_CAN_CONFIG_SEND_SFF           0x8000
  65 #define ELM327_CAN_CONFIG_VARIABLE_DLC       0x4000
  66 #define ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF  0x2000
  67 #define ELM327_CAN_CONFIG_BAUDRATE_MULT_8_7  0x1000
  68
  69 #define ELM327_DUMMY_CHAR 'y'
  70 #define ELM327_DUMMY_STRING "y"
  71 #define ELM327_READY_CHAR '>'
  72
  73 /* Bits in elm->cmds_todo */
  74 enum ELM327_TX_DO_BITS {
  75         ELM327_TX_DO_CAN_DATA = 0,
  76         ELM327_TX_DO_CANID_11BIT,
  77         ELM327_TX_DO_CANID_29BIT_LOW,
  78         ELM327_TX_DO_CANID_29BIT_HIGH,
  79         ELM327_TX_DO_CAN_CONFIG_PART2,
  80         ELM327_TX_DO_CAN_CONFIG,
  81         ELM327_TX_DO_RESPONSES,
  82         ELM327_TX_DO_SILENT_MONITOR,
  83         ELM327_TX_DO_INIT
  84 };
  85
  86 struct elmcan {
  87         /* This must be the first member when using alloc_candev() */
  88         struct can_priv can;
  89
  90         struct can_rx_offload offload;
  91
  92         /* TTY and netdev devices that we're bridging */
  93         struct tty_struct *tty;
  94         struct net_device *dev;
  95
  96         /* Per-channel lock */
  97         spinlock_t lock;
  98
  99         /* Keep track of how many things are using this struct.
 100          * Once it reaches 0, we are in the process of cleaning up,
 101          * and new operations will be cancelled immediately.
 102          * Use atomic_t rather than refcount_t because we deliberately
 103          * decrement to 0, and refcount_dec() spills a WARN_ONCE in
 104          * that case.
 105          */
 106         atomic_t refcount;
 107
 108         /* Stop the channel on hardware failure.
 109          * Once this is true, nothing will be sent to the TTY.
 110          */
 111         bool hw_failure;
 112
 113         /* TTY TX helpers */
 114         struct work_struct tx_work;     /* Flushes TTY TX buffer   */
 115         unsigned char *txbuf;
 116         unsigned char *txhead;          /* Pointer to next TX byte */
 117         int txleft;                     /* Bytes left to TX */
 118
 119         /* TTY RX helpers */
 120         unsigned char rxbuf[ELM327_SIZE_RXBUF];
 121         int rxfill;
 122
 123         /* State machine */
 124         enum {
 125                 ELM327_STATE_NOTINIT = 0,
 126                 ELM327_STATE_GETDUMMYCHAR,
 127                 ELM327_STATE_GETPROMPT,
 128                 ELM327_STATE_RECEIVING,
 129         } state;
 130
 131         bool drop_next_line;
 132
 133         /* The CAN frame and config the ELM327 is sending/using,
 134          * or will send/use after finishing all cmds_todo
 135          */
 136         struct can_frame can_frame_to_send;
 137         u16 can_config;
 138         u8 can_bitrate_divisor;
 139
 140         /* Things we have yet to send */
 141         char **next_init_cmd;
 142         unsigned long cmds_todo;
 143 };
 144
 145 /* A lock for all tty->disc_data handled by this ldisc.
 146  * This is to prevent a case where tty->disc_data is set to NULL,
 147  * yet someone is still trying to dereference it.
 148  * Without this, we cannot do a clean shutdown.
 149  */
 150 static DEFINE_SPINLOCK(elmcan_discdata_lock);
 151
 152 static inline void elm327_hw_failure(struct elmcan *elm);
 153
 154 static void elm327_send(struct elmcan *elm, const void *buf, size_t len)
 155 {
 156         int actual;
 157
 158         lockdep_assert_held(elm->lock);
 159
 160         if (elm->hw_failure)
 161                 return;
 162
 163         memcpy(elm->txbuf, buf, len);
 164
 165         /* Order of next two lines is *very* important.
 166          * When we are sending a little amount of data,
 167          * the transfer may be completed inside the ops->write()
 168          * routine, because it's running with interrupts enabled.
 169          * In this case we *never* got WRITE_WAKEUP event,
 170          * if we did not request it before write operation.
 171          *       14 Oct 1994  Dmitry Gorodchanin.
 172          */
 173         set_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
 174         actual = elm->tty->ops->write(elm->tty, elm->txbuf, len);
 175         if (actual < 0) {
 176                 netdev_err(elm->dev,
 177                            "Failed to write to tty %s.\n",
 178                            elm->tty->name);
 179                 elm327_hw_failure(elm);
 180                 return;
 181         }
 182
 183         elm->txleft = len - actual;
 184         elm->txhead = elm->txbuf + actual;
 185 }
 186
 187 /* Take the ELM327 out of almost any state and back into command mode.
 188  * We send ELM327_DUMMY_CHAR which will either abort any running
 189  * operation, or be echoed back to us in case we're already in command
 190  * mode.
 191  */
 192 static void elm327_kick_into_cmd_mode(struct elmcan *elm)
 193 {
 194         lockdep_assert_held(elm->lock);
 195
 196         if (elm->state != ELM327_STATE_GETDUMMYCHAR &&
 197             elm->state != ELM327_STATE_GETPROMPT) {
 198                 elm327_send(elm, ELM327_DUMMY_STRING, 1);
 199
 200                 elm->state = ELM327_STATE_GETDUMMYCHAR;
 201         }
 202 }
 203
 204 /* Schedule a CAN frame and necessary config changes to be sent to the TTY. */
 205 static void elm327_send_frame(struct elmcan *elm, struct can_frame *frame)
 206 {
 207         lockdep_assert_held(elm->lock);
 208
 209         /* Schedule any necessary changes in ELM327's CAN configuration */
 210         if (elm->can_frame_to_send.can_id != frame->can_id) {
 211                 /* Set the new CAN ID for transmission. */
 212                 if ((frame->can_id & CAN_EFF_FLAG) ^
 213                     (elm->can_frame_to_send.can_id & CAN_EFF_FLAG)) {
 214                         elm->can_config = (frame->can_id & CAN_EFF_FLAG
 215                                                 ? 0
 216                                                 : ELM327_CAN_CONFIG_SEND_SFF)
 217                                         | ELM327_CAN_CONFIG_VARIABLE_DLC
 218                                         | ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF
 219                                         | elm->can_bitrate_divisor;
 220
 221                         set_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo);
 222                 }
 223
 224                 if (frame->can_id & CAN_EFF_FLAG) {
 225                         clear_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo);
 226                         set_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo);
 227                         set_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo);
 228                 } else {
 229                         set_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo);
 230                         clear_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo);
 231                         clear_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo);
 232                 }
 233         }
 234
 235         /* Schedule the CAN frame itself. */
 236         elm->can_frame_to_send = *frame;
 237         set_bit(ELM327_TX_DO_CAN_DATA, &elm->cmds_todo);
 238
 239         elm327_kick_into_cmd_mode(elm);
 240 }
 241
 242 /* ELM327 initialisation sequence. */
 243 static char *elm327_init_script[] = {
 244         "AT WS\r",        /* v1.0: Warm Start */
 245         "AT PP FF OFF\r", /* v1.0: All Programmable Parameters Off */
 246         "AT M0\r",        /* v1.0: Memory Off */
 247         "AT AL\r",        /* v1.0: Allow Long messages */
 248         "AT BI\r",        /* v1.0: Bypass Initialisation */
 249         "AT CAF0\r",      /* v1.0: CAN Auto Formatting Off */
 250         "AT CFC0\r",      /* v1.0: CAN Flow Control Off */
 251         "AT CF 000\r",    /* v1.0: Reset CAN ID Filter */
 252         "AT CM 000\r",    /* v1.0: Reset CAN ID Mask */
 253         "AT E1\r",        /* v1.0: Echo On */
 254         "AT H1\r",        /* v1.0: Headers On */
 255         "AT L0\r",        /* v1.0: Linefeeds Off */
 256         "AT SH 7DF\r",    /* v1.0: Set CAN sending ID to 0x7df */
 257         "AT ST FF\r",     /* v1.0: Set maximum Timeout for response after TX */
 258         "AT AT0\r",       /* v1.2: Adaptive Timing Off */
 259         "AT D1\r",        /* v1.3: Print DLC On */
 260         "AT S1\r",        /* v1.3: Spaces On */
 261         "AT TP B\r",      /* v1.0: Try Protocol B */
 262         NULL
 263 };
 264
 265 static void elm327_init(struct elmcan *elm)
 266 {
 267         lockdep_assert_held(elm->lock);
 268
 269         elm->state = ELM327_STATE_NOTINIT;
 270         elm->can_frame_to_send.can_id = 0x7df; /* ELM327 HW default */
 271         elm->rxfill = 0;
 272         elm->drop_next_line = 0;
 273
 274         /* We can only set the bitrate as a fraction of 500000.
 275          * The bit timing constants in elmcan_bittiming_const will
 276          * limit the user to the right values.
 277          */
 278         elm->can_bitrate_divisor = 500000 / elm->can.bittiming.bitrate;
 279         elm->can_config = ELM327_CAN_CONFIG_SEND_SFF
 280                         | ELM327_CAN_CONFIG_VARIABLE_DLC
 281                         | ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF
 282                         | elm->can_bitrate_divisor;
 283
 284         /* Configure ELM327 and then start monitoring */
 285         elm->next_init_cmd = &elm327_init_script[0];
 286         set_bit(ELM327_TX_DO_INIT, &elm->cmds_todo);
 287         set_bit(ELM327_TX_DO_SILENT_MONITOR, &elm->cmds_todo);
 288         set_bit(ELM327_TX_DO_RESPONSES, &elm->cmds_todo);
 289         set_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo);
 290
 291         elm327_kick_into_cmd_mode(elm);
 292 }
 293
 294 static void elm327_feed_frame_to_netdev(struct elmcan *elm,
 295                                         struct sk_buff *skb)
 296 {
 297         lockdep_assert_held(elm->lock);
 298
 299         if (!netif_running(elm->dev))
 300                 return;
 301
 302         /* Queue for NAPI pickup.
 303          * rx-offload will update stats and LEDs for us.
 304          */
 305         if (can_rx_offload_queue_tail(&elm->offload, skb))
 306                 elm->dev->stats.rx_fifo_errors++;
 307
 308 #if LINUX_VERSION_CODE >= KERNEL_VERSION(5,15,0)
 309         /* Wake NAPI */
 310         can_rx_offload_irq_finish(&elm->offload);
 311 #endif
 312 }
 313
 314 /* Called when we're out of ideas and just want it all to end. */
 315 static inline void elm327_hw_failure(struct elmcan *elm)
 316 {
 317         struct can_frame *frame;
 318         struct sk_buff *skb;
 319
 320         lockdep_assert_held(elm->lock);
 321
 322         elm->hw_failure = true;
 323
 324         elm->can.can_stats.bus_off++;
 325         netif_stop_queue(elm->dev);
 326         elm->can.state = CAN_STATE_BUS_OFF;
 327         can_bus_off(elm->dev);
 328
 329         netdev_err(elm->dev, "ELM327 misbehaved. Blocking further communication.\n");
 330
 331         skb = alloc_can_err_skb(elm->dev, &frame);
 332         if (!skb)
 333                 return;
 334
 335         frame->can_id |= CAN_ERR_BUSOFF;
 336         elm327_feed_frame_to_netdev(elm, skb);
 337 }
 338
 339 /* Compare a buffer to a fixed string */
 340 static inline int _memstrcmp(const u8 *mem, const char *str)
 341 {
 342         return memcmp(mem, str, strlen(str));
 343 }
 344
 345 /* Compare buffer to string length, then compare buffer to fixed string.
 346  * This ensures two things:
 347  *  - It flags cases where the fixed string is only the start of the
 348  *    buffer, rather than exactly all of it.
 349  *  - It avoids byte comparisons in case the length doesn't match.
 350  */
 351 static inline int _len_memstrcmp(const u8 *mem, size_t mem_len, const char *str)
 352 {
 353         size_t str_len = strlen(str);
 354
 355         return (mem_len != str_len) || memcmp(mem, str, str_len);
 356 }
 357
 358 static void elm327_parse_error(struct elmcan *elm, size_t len)
 359 {
 360         struct can_frame *frame;
 361         struct sk_buff *skb;
 362
 363         lockdep_assert_held(elm->lock);
 364
 365         skb = alloc_can_err_skb(elm->dev, &frame);
 366         if (!skb)
 367                 /* It's okay to return here:
 368                  * The outer parsing loop will drop this UART buffer.
 369                  */
 370                 return;
 371
 372         /* Filter possible error messages based on length of RX'd line */
 373         if (!_len_memstrcmp(elm->rxbuf, len, "UNABLE TO CONNECT")) {
 374                 netdev_err(elm->dev,
 375                            "ELM327 reported UNABLE TO CONNECT. Please check your setup.\n");
 376         } else if (!_len_memstrcmp(elm->rxbuf, len, "BUFFER FULL")) {
 377                 /* This will only happen if the last data line was complete.
 378                  * Otherwise, elm327_parse_frame() will heuristically
 379                  * emit this kind of error frame instead.
 380                  */
 381                 frame->can_id |= CAN_ERR_CRTL;
 382                 frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
 383         } else if (!_len_memstrcmp(elm->rxbuf, len, "BUS ERROR")) {
 384                 frame->can_id |= CAN_ERR_BUSERROR;
 385         } else if (!_len_memstrcmp(elm->rxbuf, len, "CAN ERROR")) {
 386                 frame->can_id |= CAN_ERR_PROT;
 387         } else if (!_len_memstrcmp(elm->rxbuf, len, "<RX ERROR")) {
 388                 frame->can_id |= CAN_ERR_PROT;
 389         } else if (!_len_memstrcmp(elm->rxbuf, len, "BUS BUSY")) {
 390                 frame->can_id |= CAN_ERR_PROT;
 391                 frame->data[2] = CAN_ERR_PROT_OVERLOAD;
 392         } else if (!_len_memstrcmp(elm->rxbuf, len, "FB ERROR")) {
 393                 frame->can_id |= CAN_ERR_PROT;
 394                 frame->data[2] = CAN_ERR_PROT_TX;
 395         } else if (len == 5 && !_memstrcmp(elm->rxbuf, "ERR")) {
 396                 /* ERR is followed by two digits, hence line length 5 */
 397                 netdev_err(elm->dev, "ELM327 reported an ERR%c%c. Please power it off and on again.\n",
 398                            elm->rxbuf[3], elm->rxbuf[4]);
 399                 frame->can_id |= CAN_ERR_CRTL;
 400         } else {
 401                 /* Something else has happened.
 402                  * Maybe garbage on the UART line.
 403                  * Emit a generic error frame.
 404                  */
 405         }
 406
 407         elm327_feed_frame_to_netdev(elm, skb);
 408 }
 409
 410 /* Parse CAN frames coming as ASCII from ELM327.
 411  * They can be of various formats:
 412  *
 413  * 29-bit ID (EFF):  12 34 56 78 D PL PL PL PL PL PL PL PL
 414  * 11-bit ID (!EFF): 123 D PL PL PL PL PL PL PL PL
 415  *
 416  * where D = DLC, PL = payload byte
 417  *
 418  * Instead of a payload, RTR indicates a remote request.
 419  *
 420  * We will use the spaces and line length to guess the format.
 421  */
 422 static int elm327_parse_frame(struct elmcan *elm, size_t len)
 423 {
 424         struct can_frame *frame;
 425         struct sk_buff *skb;
 426         int hexlen;
 427         int datastart;
 428         int i;
 429
 430         lockdep_assert_held(elm->lock);
 431
 432         skb = alloc_can_skb(elm->dev, &frame);
 433         if (!skb)
 434                 return -ENOMEM;
 435
 436         /* Find first non-hex and non-space character:
 437          *  - In the simplest case, there is none.
 438          *  - For RTR frames, 'R' is the first non-hex character.
 439          *  - An error message may replace the end of the data line.
 440          */
 441         for (hexlen = 0; hexlen <= len; hexlen++) {
 442                 if (hex_to_bin(elm->rxbuf[hexlen]) < 0 &&
 443                     elm->rxbuf[hexlen] != ' ') {
 444                         break;
 445                 }
 446         }
 447
 448         /* Sanity check whether the line is really a clean hexdump,
 449          * or terminated by an error message, or contains garbage.
 450          */
 451         if (hexlen < len &&
 452             !isdigit(elm->rxbuf[hexlen]) &&
 453             !isupper(elm->rxbuf[hexlen]) &&
 454             '<' != elm->rxbuf[hexlen] &&
 455             ' ' != elm->rxbuf[hexlen]) {
 456                 /* The line is likely garbled anyway, so bail.
 457                  * The main code will restart listening.
 458                  */
 459                 return -ENODATA;
 460         }
 461
 462         /* Use spaces in CAN ID to distinguish 29 or 11 bit address length.
 463          * No out-of-bounds access:
 464          * We use the fact that we can always read from elm->rxbuf.
 465          */
 466         if (elm->rxbuf[2] == ' ' && elm->rxbuf[5] == ' ' &&
 467             elm->rxbuf[8] == ' ' && elm->rxbuf[11] == ' ' &&
 468             elm->rxbuf[13] == ' ') {
 469                 frame->can_id = CAN_EFF_FLAG;
 470                 datastart = 14;
 471         } else if (elm->rxbuf[3] == ' ' && elm->rxbuf[5] == ' ') {
 472                 datastart = 6;
 473         } else {
 474                 /* This is not a well-formatted data line.
 475                  * Assume it's an error message.
 476                  */
 477                 return -ENODATA;
 478         }
 479
 480         if (hexlen < datastart) {
 481                 /* The line is too short to be a valid frame hex dump.
 482                  * Something interrupted the hex dump or it is invalid.
 483                  */
 484                 return -ENODATA;
 485         }
 486
 487         /* From here on all chars up to buf[hexlen] are hex or spaces,
 488          * at well-defined offsets.
 489          */
 490
 491         /* Read CAN data length */
 492         frame->len = (hex_to_bin(elm->rxbuf[datastart - 2]) << 0);
 493
 494         /* Read CAN ID */
 495         if (frame->can_id & CAN_EFF_FLAG) {
 496                 frame->can_id |= (hex_to_bin(elm->rxbuf[0]) << 28)
 497                                | (hex_to_bin(elm->rxbuf[1]) << 24)
 498                                | (hex_to_bin(elm->rxbuf[3]) << 20)
 499                                | (hex_to_bin(elm->rxbuf[4]) << 16)
 500                                | (hex_to_bin(elm->rxbuf[6]) << 12)
 501                                | (hex_to_bin(elm->rxbuf[7]) << 8)
 502                                | (hex_to_bin(elm->rxbuf[9]) << 4)
 503                                | (hex_to_bin(elm->rxbuf[10]) << 0);
 504         } else {
 505                 frame->can_id |= (hex_to_bin(elm->rxbuf[0]) << 8)
 506                                | (hex_to_bin(elm->rxbuf[1]) << 4)
 507                                | (hex_to_bin(elm->rxbuf[2]) << 0);
 508         }
 509
 510         /* Check for RTR frame */
 511         if (elm->rxfill >= hexlen + 3 &&
 512             !_memstrcmp(&elm->rxbuf[hexlen], "RTR")) {
 513                 frame->can_id |= CAN_RTR_FLAG;
 514         }
 515
 516         /* Is the line long enough to hold the advertised payload?
 517          * Note: RTR frames have a DLC, but no actual payload.
 518          */
 519         if (!(frame->can_id & CAN_RTR_FLAG) &&
 520             (hexlen < frame->len * 3 + datastart)) {
 521                 /* Incomplete frame.
 522                  * Probably the ELM327's RS232 TX buffer was full.
 523                  * Emit an error frame and exit.
 524                  */
 525                 frame->can_id = CAN_ERR_FLAG | CAN_ERR_CRTL;
 526                 frame->len = CAN_ERR_DLC;
 527                 frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
 528                 elm327_feed_frame_to_netdev(elm, skb);
 529
 530                 /* Signal failure to parse.
 531                  * The line will be re-parsed as an error line, which will fail.
 532                  * However, this will correctly drop the state machine back into
 533                  * command mode.
 534                  */
 535                 return -ENODATA;
 536         }
 537
 538         /* Parse the data nibbles. */
 539         for (i = 0; i < frame->len; i++) {
 540                 frame->data[i] = (hex_to_bin(elm->rxbuf[datastart + 3*i]) << 4)
 541                                | (hex_to_bin(elm->rxbuf[datastart + 3*i + 1]));
 542         }
 543
 544         /* Feed the frame to the network layer. */
 545         elm327_feed_frame_to_netdev(elm, skb);
 546
 547         return 0;
 548 }
 549
 550 static void elm327_parse_line(struct elmcan *elm, size_t len)
 551 {
 552         lockdep_assert_held(elm->lock);
 553
 554         /* Skip empty lines */
 555         if (!len)
 556                 return;
 557
 558         /* Skip echo lines */
 559         if (elm->drop_next_line) {
 560                 elm->drop_next_line = 0;
 561                 return;
 562         } else if (!_memstrcmp(elm->rxbuf, "AT")) {
 563                 return;
 564         }
 565
 566         /* Regular parsing */
 567         if (elm->state == ELM327_STATE_RECEIVING
 568             && elm327_parse_frame(elm, len)) {
 569                 /* Parse an error line. */
 570                 elm327_parse_error(elm, len);
 571
 572                 /* Start afresh. */
 573                 elm327_kick_into_cmd_mode(elm);
 574         }
 575 }
 576
 577 static void elm327_handle_prompt(struct elmcan *elm)
 578 {
 579         struct can_frame *frame = &elm->can_frame_to_send;
 580         char local_txbuf[20];
 581
 582         lockdep_assert_held(elm->lock);
 583
 584         if (!elm->cmds_todo) {
 585                 /* Enter CAN monitor mode */
 586                 elm327_send(elm, "ATMA\r", 5);
 587                 elm->state = ELM327_STATE_RECEIVING;
 588
 589                 return;
 590         }
 591
 592         /* Reconfigure ELM327 step by step as indicated by elm->cmds_todo */
 593         if (test_bit(ELM327_TX_DO_INIT, &elm->cmds_todo)) {
 594                 strcpy(local_txbuf, *elm->next_init_cmd);
 595
 596                 elm->next_init_cmd++;
 597                 if (!(*elm->next_init_cmd)) {
 598                         clear_bit(ELM327_TX_DO_INIT, &elm->cmds_todo);
 599                         /* Init finished. */
 600                 }
 601
 602         } else if (test_and_clear_bit(ELM327_TX_DO_SILENT_MONITOR, &elm->cmds_todo)) {
 603                 sprintf(local_txbuf, "ATCSM%i\r",
 604                         !(!(elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)));
 605
 606         } else if (test_and_clear_bit(ELM327_TX_DO_RESPONSES, &elm->cmds_todo)) {
 607                 sprintf(local_txbuf, "ATR%i\r",
 608                         !(elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY));
 609
 610         } else if (test_and_clear_bit(ELM327_TX_DO_CAN_CONFIG, &elm->cmds_todo)) {
 611                 sprintf(local_txbuf, "ATPC\r");
 612                 set_bit(ELM327_TX_DO_CAN_CONFIG_PART2, &elm->cmds_todo);
 613
 614         } else if (test_and_clear_bit(ELM327_TX_DO_CAN_CONFIG_PART2, &elm->cmds_todo)) {
 615                 sprintf(local_txbuf, "ATPB%04X\r",
 616                         elm->can_config);
 617
 618         } else if (test_and_clear_bit(ELM327_TX_DO_CANID_29BIT_HIGH, &elm->cmds_todo)) {
 619                 sprintf(local_txbuf, "ATCP%02X\r",
 620                         (frame->can_id & CAN_EFF_MASK) >> 24);
 621
 622         } else if (test_and_clear_bit(ELM327_TX_DO_CANID_29BIT_LOW, &elm->cmds_todo)) {
 623                 sprintf(local_txbuf, "ATSH%06X\r",
 624                         frame->can_id & CAN_EFF_MASK & ((1 << 24) - 1));
 625
 626         } else if (test_and_clear_bit(ELM327_TX_DO_CANID_11BIT, &elm->cmds_todo)) {
 627                 sprintf(local_txbuf, "ATSH%03X\r",
 628                         frame->can_id & CAN_SFF_MASK);
 629
 630         } else if (test_and_clear_bit(ELM327_TX_DO_CAN_DATA, &elm->cmds_todo)) {
 631                 if (frame->can_id & CAN_RTR_FLAG) {
 632                         /* Send an RTR frame. Their DLC is fixed.
 633                          * Some chips don't send them at all.
 634                          */
 635                         sprintf(local_txbuf, "ATRTR\r");
 636                 } else {
 637                         /* Send a regular CAN data frame */
 638                         int i;
 639
 640                         for (i = 0; i < frame->len; i++) {
 641                                 sprintf(&local_txbuf[2 * i], "%02X",
 642                                         frame->data[i]);
 643                         }
 644
 645                         sprintf(&local_txbuf[2 * i], "\r");
 646                 }
 647
 648                 elm->drop_next_line = 1;
 649                 elm->state = ELM327_STATE_RECEIVING;
 650         }
 651
 652         elm327_send(elm, local_txbuf, strlen(local_txbuf));
 653 }
 654
 655 static bool elm327_is_ready_char(char c)
 656 {
 657         /* Bits 0xc0 are sometimes set (randomly), hence the mask.
 658          * Probably bad hardware.
 659          */
 660         return (c & 0x3f) == ELM327_READY_CHAR;
 661 }
 662
 663 static void elm327_drop_bytes(struct elmcan *elm, size_t i)
 664 {
 665         lockdep_assert_held(elm->lock);
 666
 667         memmove(&elm->rxbuf[0], &elm->rxbuf[i], ELM327_SIZE_RXBUF - i);
 668         elm->rxfill -= i;
 669 }
 670
 671 static void elm327_parse_rxbuf(struct elmcan *elm)
 672 {
 673         size_t len;
 674         int i;
 675
 676         lockdep_assert_held(elm->lock);
 677
 678         switch (elm->state) {
 679         case ELM327_STATE_NOTINIT:
 680                 elm->rxfill = 0;
 681                 break;
 682
 683         case ELM327_STATE_GETDUMMYCHAR:
 684         {
 685                 /* Wait for 'y' or '>' */
 686                 for (i = 0; i < elm->rxfill; i++) {
 687                         if (elm->rxbuf[i] == ELM327_DUMMY_CHAR) {
 688                                 elm327_send(elm, "\r", 1);
 689                                 elm->state = ELM327_STATE_GETPROMPT;
 690                                 i++;
 691                                 break;
 692                         } else if (elm327_is_ready_char(elm->rxbuf[i])) {
 693                                 elm327_send(elm, ELM327_DUMMY_STRING, 1);
 694                                 i++;
 695                                 break;
 696                         }
 697                 }
 698
 699                 elm327_drop_bytes(elm, i);
 700
 701                 break;
 702         }
 703
 704         case ELM327_STATE_GETPROMPT:
 705                 /* Wait for '>' */
 706                 if (elm327_is_ready_char(elm->rxbuf[elm->rxfill - 1]))
 707                         elm327_handle_prompt(elm);
 708
 709                 elm->rxfill = 0;
 710                 break;
 711
 712         case ELM327_STATE_RECEIVING:
 713                 /* Find <CR> delimiting feedback lines. */
 714                 for (len = 0;
 715                      (len < elm->rxfill) && (elm->rxbuf[len] != '\r');
 716                      len++) {
 717                         /* empty loop */
 718                 }
 719
 720                 if (len == ELM327_SIZE_RXBUF) {
 721                         /* Line exceeds buffer. It's probably all garbage.
 722                          * Did we even connect at the right baud rate?
 723                          */
 724                         netdev_err(elm->dev,
 725                                    "RX buffer overflow. Faulty ELM327 or UART?\n");
 726                         elm327_hw_failure(elm);
 727                         break;
 728                 } else if (len == elm->rxfill) {
 729                         if (elm327_is_ready_char(elm->rxbuf[elm->rxfill - 1])) {
 730                                 /* The ELM327's AT ST response timeout ran out,
 731                                  * so we got a prompt.
 732                                  * Clear RX buffer and restart listening.
 733                                  */
 734                                 elm->rxfill = 0;
 735
 736                                 elm327_handle_prompt(elm);
 737                                 break;
 738                         }
 739
 740                         /* No <CR> found - we haven't received a full line yet.
 741                          * Wait for more data.
 742                          */
 743                         break;
 744                 }
 745
 746                 /* We have a full line to parse. */
 747                 elm327_parse_line(elm, len);
 748
 749                 /* Remove parsed data from RX buffer. */
 750                 elm327_drop_bytes(elm, len + 1);
 751
 752                 /* More data to parse? */
 753                 if (elm->rxfill)
 754                         elm327_parse_rxbuf(elm);
 755         }
 756 }
 757
 758 /* Dummy needed to use can_rx_offload */
 759 static struct sk_buff *elmcan_mailbox_read(struct can_rx_offload *offload,
 760                                            unsigned int n, u32 *timestamp,
 761                                            bool drop)
 762 {
 763         WARN_ON_ONCE(1); /* This function is a dummy, so don't call it! */
 764
 765         return ERR_PTR(-ENOBUFS);
 766 }
 767
 768 static int elmcan_netdev_open(struct net_device *dev)
 769 {
 770         struct elmcan *elm = netdev_priv(dev);
 771         int err;
 772
 773         spin_lock_bh(&elm->lock);
 774         if (elm->hw_failure) {
 775                 netdev_err(elm->dev, "Refusing to open interface after a hardware fault has been detected.\n");
 776                 spin_unlock_bh(&elm->lock);
 777                 return -EIO;
 778         }
 779
 780         if (!elm->tty) {
 781                 spin_unlock_bh(&elm->lock);
 782                 return -ENODEV;
 783         }
 784
 785         /* open_candev() checks for elm->can.bittiming.bitrate != 0 */
 786         err = open_candev(dev);
 787         if (err) {
 788                 spin_unlock_bh(&elm->lock);
 789                 return err;
 790         }
 791
 792         elm327_init(elm);
 793         spin_unlock_bh(&elm->lock);
 794
 795         elm->offload.mailbox_read = elmcan_mailbox_read;
 796         err = can_rx_offload_add_fifo(dev, &elm->offload, ELM327_NAPI_WEIGHT);
 797         if (err) {
 798                 close_candev(dev);
 799                 return err;
 800         }
 801
 802         can_rx_offload_enable(&elm->offload);
 803
 804         can_led_event(dev, CAN_LED_EVENT_OPEN);
 805         elm->can.state = CAN_STATE_ERROR_ACTIVE;
 806         netif_start_queue(dev);
 807
 808         return 0;
 809 }
 810
 811 static int elmcan_netdev_close(struct net_device *dev)
 812 {
 813         struct elmcan *elm = netdev_priv(dev);
 814
 815         netif_stop_queue(dev);
 816
 817         spin_lock_bh(&elm->lock);
 818         if (elm->tty) {
 819                 /* Interrupt whatever we're doing right now */
 820                 elm327_send(elm, ELM327_DUMMY_STRING, 1);
 821
 822                 /* Clear the wakeup bit, as the netdev will be down and thus
 823                  * the wakeup handler won't clear it
 824                  */
 825                 clear_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
 826
 827                 spin_unlock_bh(&elm->lock);
 828
 829                 flush_work(&elm->tx_work);
 830         } else {
 831                 spin_unlock_bh(&elm->lock);
 832         }
 833
 834         can_rx_offload_disable(&elm->offload);
 835         elm->can.state = CAN_STATE_STOPPED;
 836         can_rx_offload_del(&elm->offload);
 837         close_candev(dev);
 838         can_led_event(dev, CAN_LED_EVENT_STOP);
 839
 840         return 0;
 841 }
 842
 843 /* Send a can_frame to a TTY. */
 844 static netdev_tx_t elmcan_netdev_start_xmit(struct sk_buff *skb,
 845                                             struct net_device *dev)
 846 {
 847         struct elmcan *elm = netdev_priv(dev);
 848         struct can_frame *frame = (struct can_frame *)skb->data;
 849
 850         /* BHs are already disabled, so no spin_lock_bh().
 851          * See Documentation/networking/netdevices.txt
 852          */
 853         spin_lock(&elm->lock);
 854
 855         /* We shouldn't get here after a hardware fault:
 856          * can_bus_off() calls netif_carrier_off()
 857          */
 858         WARN_ON_ONCE(elm->hw_failure);
 859
 860         if (!elm->tty ||
 861             elm->hw_failure ||
 862             elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY) {
 863                 spin_unlock(&elm->lock);
 864                 goto out;
 865         }
 866
 867         netif_stop_queue(dev);
 868
 869         elm327_send_frame(elm, frame);
 870         spin_unlock(&elm->lock);
 871
 872         dev->stats.tx_packets++;
 873         dev->stats.tx_bytes += frame->len;
 874
 875         can_led_event(dev, CAN_LED_EVENT_TX);
 876
 877 out:
 878         kfree_skb(skb);
 879         return NETDEV_TX_OK;
 880 }
 881
 882 static const struct net_device_ops elmcan_netdev_ops = {
 883         .ndo_open       = elmcan_netdev_open,
 884         .ndo_stop       = elmcan_netdev_close,
 885         .ndo_start_xmit = elmcan_netdev_start_xmit,
 886         .ndo_change_mtu = can_change_mtu,
 887 };
 888
 889 /* Get a reference to our struct, taking into account locks/refcounts.
 890  * This is to ensure ordering in case we are shutting down, and to ensure
 891  * there is a refcount at all (otherwise tty->disc_data may be freed and
 892  * before we increment the refcount).
 893  * Use this for anything that can race against elmcan_ldisc_close().
 894  */
 895 static struct elmcan *get_elm(struct tty_struct *tty)
 896 {
 897         struct elmcan *elm;
 898         bool got_ref;
 899
 900         spin_lock_bh(&elmcan_discdata_lock);
 901         elm = (struct elmcan *)tty->disc_data;
 902
 903         if (!elm) {
 904                 spin_unlock_bh(&elmcan_discdata_lock);
 905                 return NULL;
 906         }
 907
 908         got_ref = atomic_inc_not_zero(&elm->refcount);
 909         spin_unlock_bh(&elmcan_discdata_lock);
 910
 911         if (!got_ref)
 912                 return NULL;
 913
 914         return elm;
 915 }
 916
 917 static void put_elm(struct elmcan *elm)
 918 {
 919         atomic_dec(&elm->refcount);
 920 }
 921
 922 static bool elmcan_is_valid_rx_char(char c)
 923 {
 924         return (isdigit(c) ||
 925                 isupper(c) ||
 926                 c == ELM327_DUMMY_CHAR ||
 927                 c == ELM327_READY_CHAR ||
 928                 c == '<' ||
 929                 c == 'a' ||
 930                 c == 'b' ||
 931                 c == 'v' ||
 932                 c == '.' ||
 933                 c == '?' ||
 934                 c == '\r' ||
 935                 c == ' ');
 936 }
 937
 938 /* Handle incoming ELM327 ASCII data.
 939  * This will not be re-entered while running, but other ldisc
 940  * functions may be called in parallel.
 941  */
 942 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,14,0)
 943 static void elmcan_ldisc_rx(struct tty_struct *tty,
 944                             const unsigned char *cp, char *fp, int count)
 945 #else
 946 static void elmcan_ldisc_rx(struct tty_struct *tty,
 947                             const unsigned char *cp, const char *fp, int count)
 948 #endif
 949 {
 950         struct elmcan *elm = get_elm(tty);
 951
 952         if (!elm)
 953                 return;
 954
 955         spin_lock_bh(&elm->lock);
 956
 957         if (elm->hw_failure)
 958                 goto out;
 959
 960         while (count-- && elm->rxfill < ELM327_SIZE_RXBUF) {
 961                 if (fp && *fp++) {
 962                         netdev_err(elm->dev, "Error in received character stream. Check your wiring.");
 963
 964                         elm327_hw_failure(elm);
 965
 966                         goto out;
 967                 }
 968
 969                 /* Ignore NUL characters, which the PIC microcontroller may
 970                  * inadvertently insert due to a known hardware bug.
 971                  * See ELM327 documentation, which refers to a Microchip PIC
 972                  * bug description.
 973                  */
 974                 if (*cp != 0) {
 975                         /* Check for stray characters on the UART line.
 976                          * Likely caused by bad hardware.
 977                          */
 978                         if (!elmcan_is_valid_rx_char(*cp)) {
 979                                 netdev_err(elm->dev,
 980                                            "Received illegal character %02x.\n",
 981                                            *cp);
 982                                 elm327_hw_failure(elm);
 983
 984                                 goto out;
 985                         }
 986
 987                         elm->rxbuf[elm->rxfill++] = *cp;
 988                 }
 989
 990                 cp++;
 991         }
 992
 993         if (count >= 0) {
 994                 netdev_err(elm->dev, "Receive buffer overflowed. Bad chip or wiring?");
 995
 996                 elm327_hw_failure(elm);
 997
 998                 goto out;
 999         }
1000
1001         elm327_parse_rxbuf(elm);
1002
1003 out:
1004         spin_unlock_bh(&elm->lock);
1005         put_elm(elm);
1006 }
1007
1008 /* Write out remaining transmit buffer.
1009  * Scheduled when TTY is writable.
1010  */
1011 static void elmcan_ldisc_tx_worker(struct work_struct *work)
1012 {
1013         /* No need to use get_elm() here, as we'll always flush workers
1014          * before destroying the elmcan object.
1015          */
1016         struct elmcan *elm = container_of(work, struct elmcan, tx_work);
1017         ssize_t actual;
1018
1019         spin_lock_bh(&elm->lock);
1020         if (elm->hw_failure) {
1021                 spin_unlock_bh(&elm->lock);
1022                 return;
1023         }
1024
1025         if (!elm->tty || !netif_running(elm->dev)) {
1026                 spin_unlock_bh(&elm->lock);
1027                 return;
1028         }
1029
1030         if (elm->txleft <= 0)  {
1031                 /* Our TTY write buffer is empty:
1032                  * Allow netdev to hand us another packet
1033                  */
1034                 clear_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
1035                 spin_unlock_bh(&elm->lock);
1036                 netif_wake_queue(elm->dev);
1037                 return;
1038         }
1039
1040         actual = elm->tty->ops->write(elm->tty, elm->txhead, elm->txleft);
1041         if (actual < 0) {
1042                 netdev_err(elm->dev,
1043                            "Failed to write to tty %s.\n",
1044                            elm->tty->name);
1045                 elm327_hw_failure(elm);
1046                 spin_unlock_bh(&elm->lock);
1047                 return;
1048         }
1049
1050         elm->txleft -= actual;
1051         elm->txhead += actual;
1052         spin_unlock_bh(&elm->lock);
1053 }
1054
1055 /* Called by the driver when there's room for more data. */
1056 static void elmcan_ldisc_tx_wakeup(struct tty_struct *tty)
1057 {
1058         struct elmcan *elm = get_elm(tty);
1059
1060         if (!elm)
1061                 return;
1062
1063         schedule_work(&elm->tx_work);
1064
1065         put_elm(elm);
1066 }
1067
1068 /* ELM327 can only handle bitrates that are integer divisors of 500 kHz,
1069  * or 7/8 of that. Divisors are 1 to 64.
1070  * Currently we don't implement support for 7/8 rates.
1071  */
1072 static const u32 elmcan_bitrate_const[64] = {
1073          7812,  7936,  8064,  8196,  8333,  8474,  8620,  8771,
1074          8928,  9090,  9259,  9433,  9615,  9803, 10000, 10204,
1075         10416, 10638, 10869, 11111, 11363, 11627, 11904, 12195,
1076         12500, 12820, 13157, 13513, 13888, 14285, 14705, 15151,
1077         15625, 16129, 16666, 17241, 17857, 18518, 19230, 20000,
1078         20833, 21739, 22727, 23809, 25000, 26315, 27777, 29411,
1079         31250, 33333, 35714, 38461, 41666, 45454, 50000, 55555,
1080         62500, 71428, 83333, 100000, 125000, 166666, 250000, 500000
1081 };
1082
1083 /* Dummy needed to use bitrate_const */
1084 static int elmcan_do_set_bittiming(struct net_device *netdev)
1085 {
1086         return 0;
1087 }
1088
1089 static int elmcan_ldisc_open(struct tty_struct *tty)
1090 {
1091         struct net_device *dev;
1092         struct elmcan *elm;
1093         int err;
1094
1095         if (!capable(CAP_NET_ADMIN))
1096                 return -EPERM;
1097
1098         if (!tty->ops->write)
1099                 return -EOPNOTSUPP;
1100
1101         dev = alloc_candev(sizeof(struct elmcan), 0);
1102         if (!dev)
1103                 return -ENFILE;
1104         elm = netdev_priv(dev);
1105
1106         elm->txbuf = kmalloc(ELM327_SIZE_TXBUF, GFP_KERNEL);
1107         if (!elm->txbuf) {
1108                 err = -ENOMEM;
1109                 goto out_err;
1110         }
1111
1112         /* Configure TTY interface */
1113         tty->receive_room = 65536; /* We don't flow control */
1114         elm->txleft = 0; /* Clear TTY TX buffer */
1115         spin_lock_init(&elm->lock);
1116         atomic_set(&elm->refcount, 1);
1117         INIT_WORK(&elm->tx_work, elmcan_ldisc_tx_worker);
1118
1119         /* Configure CAN metadata */
1120         elm->can.state = CAN_STATE_STOPPED;
1121         elm->can.bitrate_const = elmcan_bitrate_const;
1122         elm->can.bitrate_const_cnt = ARRAY_SIZE(elmcan_bitrate_const);
1123         elm->can.do_set_bittiming = elmcan_do_set_bittiming;
1124         elm->can.ctrlmode_supported = CAN_CTRLMODE_LISTENONLY;
1125
1126         /* Configure netdev interface */
1127         elm->dev = dev;
1128         dev->netdev_ops = &elmcan_netdev_ops;
1129
1130         /* Mark ldisc channel as alive */
1131         elm->tty = tty;
1132         tty->disc_data = elm;
1133
1134         devm_can_led_init(elm->dev);
1135
1136         /* Let 'er rip */
1137         err = register_candev(elm->dev);
1138         if (err)
1139                 goto out_err;
1140
1141         netdev_info(elm->dev, "elmcan on %s.\n", tty->name);
1142
1143         return 0;
1144
1145 out_err:
1146         kfree(elm->txbuf);
1147         free_candev(elm->dev);
1148         return err;
1149 }
1150
1151 /* Close down an elmcan channel.
1152  * This means flushing out any pending queues, and then returning.
1153  * This call is serialized against other ldisc functions:
1154  * Once this is called, no other ldisc function of ours is entered.
1155  *
1156  * We also use this function for a hangup event.
1157  */
1158 static void elmcan_ldisc_close(struct tty_struct *tty)
1159 {
1160         struct elmcan *elm = get_elm(tty);
1161
1162         if (!elm)
1163                 return;
1164
1165         /* unregister_netdev() calls .ndo_stop() so we don't have to. */
1166         unregister_candev(elm->dev);
1167
1168         /* Decrease the refcount twice, once for our own get_elm(),
1169          * and once to remove the count of 1 that we set in _open().
1170          * Once it reaches 0, we can safely destroy it.
1171          */
1172         put_elm(elm);
1173         put_elm(elm);
1174
1175         while (atomic_read(&elm->refcount) > 0)
1176                 msleep_interruptible(10);
1177
1178         /* At this point, all ldisc calls to us have become no-ops. */
1179
1180         flush_work(&elm->tx_work);
1181
1182         /* Mark channel as dead */
1183         spin_lock_bh(&elm->lock);
1184         tty->disc_data = NULL;
1185         elm->tty = NULL;
1186         spin_unlock_bh(&elm->lock);
1187
1188         netdev_info(elm->dev, "elmcan off %s.\n", tty->name);
1189
1190         kfree(elm->txbuf);
1191         free_candev(elm->dev);
1192 }
1193
1194 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,16,0)
1195 static int elmcan_ldisc_hangup(struct tty_struct *tty)
1196 #else
1197 static void elmcan_ldisc_hangup(struct tty_struct *tty)
1198 #endif
1199 {
1200         elmcan_ldisc_close(tty);
1201 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,16,0)
1202         return 0;
1203 #endif
1204 }
1205
1206 static int elmcan_ldisc_ioctl(struct tty_struct *tty,
1207 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,17,0)
1208                               struct file *file,
1209 #endif
1210                               unsigned int cmd, unsigned long arg)
1211 {
1212         struct elmcan *elm = get_elm(tty);
1213         unsigned int tmp;
1214
1215         if (!elm)
1216                 return -EINVAL;
1217
1218         switch (cmd) {
1219         case SIOCGIFNAME:
1220                 tmp = strnlen(elm->dev->name, IFNAMSIZ - 1) + 1;
1221                 if (copy_to_user((void __user *)arg, elm->dev->name, tmp)) {
1222                         put_elm(elm);
1223                         return -EFAULT;
1224                 }
1225
1226                 put_elm(elm);
1227                 return 0;
1228
1229         case SIOCSIFHWADDR:
1230                 put_elm(elm);
1231                 return -EINVAL;
1232
1233         default:
1234                 put_elm(elm);
1235 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,16,0)
1236                 return tty_mode_ioctl(tty, file, cmd, arg);
1237 #else
1238                 return tty_mode_ioctl(tty, cmd, arg);
1239 #endif
1240         }
1241 }
1242
1243 static struct tty_ldisc_ops elmcan_ldisc = {
1244         .owner          = THIS_MODULE,
1245         .name           = "elmcan",
1246         .num            = N_DEVELOPMENT,
1247         .receive_buf    = elmcan_ldisc_rx,
1248         .write_wakeup   = elmcan_ldisc_tx_wakeup,
1249         .open           = elmcan_ldisc_open,
1250         .close          = elmcan_ldisc_close,
1251         .hangup         = elmcan_ldisc_hangup,
1252         .ioctl          = elmcan_ldisc_ioctl,
1253 };
1254
1255 static int __init elmcan_init(void)
1256 {
1257         int status;
1258
1259 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,14,0)
1260         status = tty_register_ldisc(N_DEVELOPMENT, &elmcan_ldisc);
1261 #else
1262         status = tty_register_ldisc(&elmcan_ldisc);
1263 #endif
1264         if (status)
1265                 pr_err("Can't register line discipline\n");
1266
1267         return status;
1268 }
1269
1270 static void __exit elmcan_exit(void)
1271 {
1272         /* This will only be called when all channels have been closed by
1273          * userspace - tty_ldisc.c takes care of the module's refcount.
1274          */
1275 #if LINUX_VERSION_CODE < KERNEL_VERSION(5,14,0)
1276         int status;
1277
1278         status = tty_unregister_ldisc(N_DEVELOPMENT);
1279         if (status)
1280                 pr_err("Can't unregister line discipline (error: %d)\n",
1281                        status);
1282 #else
1283         tty_unregister_ldisc(&elmcan_ldisc);
1284 #endif
1285 }
1286
1287 module_init(elmcan_init);
1288 module_exit(elmcan_exit);
1289
1290 MODULE_ALIAS_LDISC(N_DEVELOPMENT);
1291 MODULE_DESCRIPTION("ELM327 based CAN interface");
1292 MODULE_LICENSE("GPL");
1293 MODULE_AUTHOR("Max Staudt <max-linux@enpas.org>");