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