module/elmcan.c

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