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 = {0};
 339
 340         frame.can_id = CAN_ERR_FLAG;
 341         frame.can_dlc = CAN_ERR_DLC;
 342         frame.data[5] = 'R';
 343         frame.data[6] = 'I';
 344         frame.data[7] = 'P';
 345         elm327_feed_frame_to_netdev(elm, &frame);
 346
 347         netdev_err(elm->dev, "ELM327 misbehaved. "
 348                         "Blocking further communication.\n");
 349
 350         elm->hw_failure = true;
 351         can_bus_off(elm->dev);
 352 }
 353
 354
 355
 356  /************************************************************************
 357   *             ELM327: Reception parser                        *
 358   *                                                             *
 359   * (assumes elm->lock taken)                                   *
 360   ************************************************************************/
 361
 362 static void elm327_parse_error(struct elmcan *elm, int len)
 363 {
 364         struct can_frame frame = {0};
 365
 366         frame.can_id = CAN_ERR_FLAG;
 367         frame.can_dlc = CAN_ERR_DLC;
 368
 369         switch(len) {
 370                 case 17:
 371                         if (!memcmp(elm->rxbuf, "UNABLE TO CONNECT", 17)) {
 372                                 netdev_err(elm->dev, "The ELM327 reported UNABLE TO CONNECT. Please check your setup.\n");
 373                         }
 374                         break;
 375                 case 11:
 376                         if (!memcmp(elm->rxbuf, "BUFFER FULL", 11)) {
 377                                 /* This case will only happen if the last data
 378                                  * line was complete.
 379                                  * Otherwise, elm327_parse_frame() will emit the
 380                                  * error frame instead.
 381                                  */
 382                                 frame.can_id |= CAN_ERR_CRTL;
 383                                 frame.data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
 384                         }
 385                         break;
 386                 case 9:
 387                         if (!memcmp(elm->rxbuf, "BUS ERROR", 9)) {
 388                                 frame.can_id |= CAN_ERR_BUSERROR;
 389                         }
 390                         if (!memcmp(elm->rxbuf, "CAN ERROR", 9)
 391                                 || !memcmp(elm->rxbuf, "<RX ERROR", 9)) {
 392                                 frame.can_id |= CAN_ERR_PROT;
 393                         }
 394                         break;
 395                 case 8:
 396                         if (!memcmp(elm->rxbuf, "BUS BUSY", 8)) {
 397                                 frame.can_id |= CAN_ERR_PROT;
 398                                 frame.data[2] = CAN_ERR_PROT_OVERLOAD;
 399                         }
 400                         if (!memcmp(elm->rxbuf, "FB ERROR", 8)) {
 401                                 frame.can_id |= CAN_ERR_PROT;
 402                                 frame.data[2] = CAN_ERR_PROT_TX;
 403                         }
 404                         break;
 405                 case 5:
 406                         if (!memcmp(elm->rxbuf, "ERR", 3)) {
 407                                 netdev_err(elm->dev, "The ELM327 reported an ERR%c%c. Please power it off and on again.\n",
 408                                         elm->rxbuf[3], elm->rxbuf[4]);
 409                                 frame.can_id |= CAN_ERR_CRTL;
 410                         }
 411                         break;
 412                 default:
 413                         /* Don't emit an error frame if we're unsure */
 414                         return;
 415         }
 416
 417         elm327_feed_frame_to_netdev(elm, &frame);
 418 }
 419
 420
 421 static int elm327_parse_frame(struct elmcan *elm, int len)
 422 {
 423         struct can_frame frame = {0};
 424         int hexlen;
 425         int datastart;
 426         int i;
 427
 428         /* Find first non-hex and non-space character:
 429          *  - In the simplest case, there is none.
 430          *  - For RTR frames, 'R' is the first non-hex character.
 431          *  - An error message may replace the end of the data line.
 432          */
 433         for (hexlen = 0; hexlen <= len; hexlen++) {
 434                 if (hex_to_bin(elm->rxbuf[hexlen]) < 0
 435                     && elm->rxbuf[hexlen] != ' ') {
 436                         break;
 437                 }
 438         }
 439
 440         /* Use spaces in CAN ID to distinguish 29 or 11 bit address length.
 441          * No out-of-bounds access:
 442          * We use the fact that we can always read from elm->rxbuf.
 443          */
 444         if (elm->rxbuf[2] == ' ' && elm->rxbuf[5] == ' '
 445                 && elm->rxbuf[8] == ' ' && elm->rxbuf[11] == ' '
 446                 && elm->rxbuf[13] == ' ') {
 447                 frame.can_id = CAN_EFF_FLAG;
 448                 datastart = 14;
 449         } else if (elm->rxbuf[3] == ' ' && elm->rxbuf[5] == ' ') {
 450                 frame.can_id = 0;
 451                 datastart = 6;
 452         } else {
 453                 /* This is not a well-formatted data line.
 454                  * Assume it's an error message.
 455                  */
 456                 return 1;
 457         }
 458
 459         if (hexlen < datastart) {
 460                 /* The line is too short to be a valid frame hex dump.
 461                  * Something interrupted the hex dump or it is invalid.
 462                  */
 463                 return 1;
 464         }
 465
 466         /* From here on all chars up to buf[hexlen] are hex or spaces,
 467          * at well-defined offsets.
 468          */
 469
 470         /* Read CAN data length */
 471         frame.can_dlc = (hex_to_bin(elm->rxbuf[datastart - 2]) << 0);
 472
 473         /* Read CAN ID */
 474         if (frame.can_id & CAN_EFF_FLAG) {
 475                 frame.can_id |= (hex_to_bin(elm->rxbuf[0]) << 28)
 476                               | (hex_to_bin(elm->rxbuf[1]) << 24)
 477                               | (hex_to_bin(elm->rxbuf[3]) << 20)
 478                               | (hex_to_bin(elm->rxbuf[4]) << 16)
 479                               | (hex_to_bin(elm->rxbuf[6]) << 12)
 480                               | (hex_to_bin(elm->rxbuf[7]) << 8)
 481                               | (hex_to_bin(elm->rxbuf[9]) << 4)
 482                               | (hex_to_bin(elm->rxbuf[10]) << 0);
 483         } else {
 484                 frame.can_id |= (hex_to_bin(elm->rxbuf[0]) << 8)
 485                               | (hex_to_bin(elm->rxbuf[1]) << 4)
 486                               | (hex_to_bin(elm->rxbuf[2]) << 0);
 487         }
 488
 489         /* Check for RTR frame */
 490         if (elm->rxfill >= hexlen + 3
 491             && elm->rxbuf[hexlen + 0] == 'R'
 492             && elm->rxbuf[hexlen + 1] == 'T'
 493             && elm->rxbuf[hexlen + 2] == 'R') {
 494                 frame.can_id |= CAN_RTR_FLAG;
 495         }
 496
 497         /* Is the line long enough to hold the advertised payload? */
 498         if (!(frame.can_id & CAN_RTR_FLAG) && (hexlen < frame.can_dlc * 3 + datastart)) {
 499                 /* Incomplete frame. */
 500
 501                 /* Probably the ELM327's RS232 TX buffer was full.
 502                  * Emit an error frame and exit.
 503                  */
 504                 frame.can_id = CAN_ERR_FLAG | CAN_ERR_CRTL;
 505                 frame.can_dlc = CAN_ERR_DLC;
 506                 frame.data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
 507                 elm327_feed_frame_to_netdev(elm, &frame);
 508
 509                 /* Signal failure to parse.
 510                  * The line will be re-parsed as an error line, which will fail.
 511                  * However, this will correctly drop the state machine back into
 512                  * command mode.
 513                  */
 514                 return 2;
 515         }
 516
 517         /* Parse the data nibbles. */
 518         for (i = 0; i < frame.can_dlc; i++) {
 519                 frame.data[i] = (hex_to_bin(elm->rxbuf[datastart+3*i]) << 4)
 520                                 | (hex_to_bin(elm->rxbuf[datastart+3*i+1]) << 0);
 521         }
 522
 523         /* Feed the frame to the network layer. */
 524         elm327_feed_frame_to_netdev(elm, &frame);
 525
 526         return 0;
 527 }
 528
 529
 530 static void elm327_parse_line(struct elmcan *elm, int len)
 531 {
 532         /* Skip empty lines */
 533         if (!len) {
 534                 return;
 535         }
 536
 537         /* Skip echo lines */
 538         if (elm->drop_next_line) {
 539                 elm->drop_next_line = 0;
 540                 return;
 541         } else if (elm->rxbuf[0] == 'A' && elm->rxbuf[1] == 'T') {
 542                 return;
 543         }
 544
 545         /* Regular parsing */
 546         switch(elm->state) {
 547                 case ELM_RECEIVING:
 548                         if (elm327_parse_frame(elm, len)) {
 549                                 /* Parse an error line. */
 550                                 elm327_parse_error(elm, len);
 551
 552                                 /* After the error line, we expect a prompt. */
 553                                 elm->state = ELM_GETPROMPT;
 554                         }
 555                         break;
 556                 default:
 557                         break;
 558         }
 559 }
 560
 561
 562 static void elm327_handle_prompt(struct elmcan *elm)
 563 {
 564         if (elm->cmds_todo) {
 565                 struct can_frame *frame = &elm->can_frame;
 566                 char txbuf[20];
 567
 568                 if (test_bit(ELM_TODO_INIT, &elm->cmds_todo)) {
 569                         elm327_send(elm, *elm->next_init_cmd, strlen(*elm->next_init_cmd));
 570                         elm->next_init_cmd++;
 571                         if (!(*elm->next_init_cmd)) {
 572                                 clear_bit(ELM_TODO_INIT, &elm->cmds_todo);
 573                                 netdev_info(elm->dev, "Initialization finished.\n");
 574                         }
 575
 576                         /* Some chips are unreliable and need extra time after
 577                          * init commands, as seen with a clone.
 578                          * So let's do a dummy get-cmd-prompt dance.
 579                          */
 580                         elm->state = ELM_NOTINIT;
 581                         elm327_kick_into_cmd_mode(elm);
 582                 } else if (test_and_clear_bit(ELM_TODO_SILENT_MONITOR, &elm->cmds_todo)) {
 583                         snprintf(txbuf, sizeof(txbuf), "ATCSM%i\r", !(!(elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)));
 584                 } else if (test_and_clear_bit(ELM_TODO_RESPONSES, &elm->cmds_todo)) {
 585                         snprintf(txbuf, sizeof(txbuf), "ATR%i\r", !(elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY));
 586                 } else if (test_and_clear_bit(ELM_TODO_CAN_CONFIG, &elm->cmds_todo)) {
 587                         snprintf(txbuf, sizeof(txbuf), "ATPB%04X\r", elm->can_config);
 588                 } else if (test_and_clear_bit(ELM_TODO_CANID_29BIT_HIGH, &elm->cmds_todo)) {
 589                         snprintf(txbuf, sizeof(txbuf), "ATCP%02X\r", (frame->can_id & CAN_EFF_MASK) >> 24);
 590                 } else if (test_and_clear_bit(ELM_TODO_CANID_29BIT_LOW, &elm->cmds_todo)) {
 591                         snprintf(txbuf, sizeof(txbuf), "ATSH%06X\r", frame->can_id & CAN_EFF_MASK & ((1 << 24) - 1));
 592                 } else if (test_and_clear_bit(ELM_TODO_CANID_11BIT, &elm->cmds_todo)) {
 593                         snprintf(txbuf, sizeof(txbuf), "ATSH%03X\r", frame->can_id & CAN_SFF_MASK);
 594                 } else if (test_and_clear_bit(ELM_TODO_CAN_DATA, &elm->cmds_todo)) {
 595                         if (frame->can_id & CAN_RTR_FLAG) {
 596                                 snprintf(txbuf, sizeof(txbuf), "ATRTR\r");
 597                         } else {
 598                                 int i;
 599
 600                                 for (i = 0; i < frame->can_dlc; i++) {
 601                                         sprintf(&txbuf[2*i], "%02X", frame->data[i]);
 602                                 }
 603
 604                                 sprintf(&txbuf[2*i], "\r");
 605                         }
 606
 607                         elm->drop_next_line = 1;
 608                         elm->state = ELM_RECEIVING;
 609                 }
 610
 611                 elm327_send(elm, txbuf, strlen(txbuf));
 612         } else {
 613                 /* Enter CAN monitor mode */
 614                 elm327_send(elm, "ATMA\r", 5);
 615                 elm->state = ELM_RECEIVING;
 616         }
 617 }
 618
 619
 620 static void elm327_drop_bytes(struct elmcan *elm, int i)
 621 {
 622         memmove(&elm->rxbuf[0], &elm->rxbuf[i], sizeof(elm->rxbuf) - i);
 623         elm->rxfill -= i;
 624 }
 625
 626
 627 static void elm327_parse_rxbuf(struct elmcan *elm)
 628 {
 629         int len;
 630
 631         switch (elm->state) {
 632         case ELM_NOTINIT:
 633                 elm->rxfill = 0;
 634                 return;
 635
 636         case ELM_GETMAGICCHAR:
 637         {
 638                 /* Wait for 'y' or '>' */
 639                 int i;
 640
 641                 for (i = 0; i < elm->rxfill; i++) {
 642                         if (elm->rxbuf[i] == ELM327_MAGIC_CHAR) {
 643                                 elm327_send(elm, "\r", 1);
 644                                 elm->state = ELM_GETPROMPT;
 645                                 i++;
 646                                 break;
 647                         } else if (elm->rxbuf[i] == ELM327_READY_CHAR) {
 648                                 elm327_send(elm, ELM327_MAGIC_STRING, 1);
 649                                 i++;
 650                                 break;
 651                         }
 652                 }
 653
 654                 elm327_drop_bytes(elm, i);
 655
 656                 return;
 657         }
 658
 659         case ELM_GETPROMPT:
 660                 /* Wait for '>' */
 661                 if (elm->rxbuf[elm->rxfill - 1] == ELM327_READY_CHAR) {
 662                         elm327_handle_prompt(elm);
 663                 }
 664
 665                 elm->rxfill = 0;
 666                 return;
 667
 668         case ELM_RECEIVING:
 669                 /* Find <CR> delimiting feedback lines. */
 670                 for (len = 0;
 671                      (len < elm->rxfill) && (elm->rxbuf[len] != '\r');
 672                      len++) {
 673                         /* empty loop */
 674                 }
 675
 676                 if (len == sizeof(elm->rxbuf)) {
 677                         /* Line exceeds buffer. It's probably all garbage.
 678                          * Did we even connect at the right baud rate?
 679                          */
 680                         netdev_err(elm->dev, "RX buffer overflow. Faulty ELM327 connected?\n");
 681                         elm327_hw_failure(elm);
 682                         return;
 683                 } else if (len == elm->rxfill) {
 684                         if (elm->state == ELM_RECEIVING
 685                                 && elm->rxbuf[elm->rxfill - 1] == ELM327_READY_CHAR) {
 686                                 /* The ELM327's AT ST response timeout ran out,
 687                                  * so we got a prompt.
 688                                  * Clear RX buffer and restart listening.
 689                                  */
 690                                 elm->rxfill = 0;
 691
 692                                 elm327_handle_prompt(elm);
 693                                 return;
 694                         } else {
 695                                 /* We haven't received a full line yet.
 696                                  * Wait for more data.
 697                                  */
 698                                 return;
 699                         }
 700                 }
 701
 702                 /* We have a full line to parse. */
 703                 elm327_parse_line(elm, len);
 704
 705                 /* Remove parsed data from RX buffer. */
 706                 elm327_drop_bytes(elm, len+1);
 707
 708                 /* More data to parse? */
 709                 if (elm->rxfill) {
 710                         elm327_parse_rxbuf(elm);
 711                 }
 712         }
 713 }
 714
 715
 716
 717
 718
 719  /************************************************************************
 720   *             netdev                                          *
 721   *                                                             *
 722   * (takes elm->lock)                                           *
 723   ************************************************************************/
 724
 725 /* Netdevice DOWN -> UP routine */
 726 static int elmcan_netdev_open(struct net_device *dev)
 727 {
 728         struct elmcan *elm = netdev_priv(dev);
 729         int err;
 730
 731         spin_lock_bh(&elm->lock);
 732         if (elm->hw_failure) {
 733                 netdev_err(elm->dev, "Refusing to open interface after "
 734                                 "a hardware fault has been detected.\n");
 735                 spin_unlock_bh(&elm->lock);
 736                 return -EIO;
 737         }
 738
 739         if (elm->tty == NULL) {
 740                 spin_unlock_bh(&elm->lock);
 741                 return -ENODEV;
 742         }
 743
 744         /* open_candev() checks for elm->can.bittiming.bitrate != 0 */
 745         err = open_candev(dev);
 746         if (err) {
 747                 spin_unlock_bh(&elm->lock);
 748                 return err;
 749         }
 750
 751         /* Initialize the ELM327 */
 752         elm327_init(elm);
 753         spin_unlock_bh(&elm->lock);
 754
 755         can_led_event(dev, CAN_LED_EVENT_OPEN);
 756         elm->can.state = CAN_STATE_ERROR_ACTIVE;
 757         netif_start_queue(dev);
 758
 759         return 0;
 760 }
 761
 762 /* Netdevice UP -> DOWN routine */
 763 static int elmcan_netdev_close(struct net_device *dev)
 764 {
 765         struct elmcan *elm = netdev_priv(dev);
 766
 767         spin_lock_bh(&elm->lock);
 768         if (elm->tty) {
 769                 /* TTY discipline is running. */
 770
 771                 /* Interrupt whatever we're doing right now */
 772                 elm327_send(elm, ELM327_MAGIC_STRING, 1);
 773
 774                 /* Clear the wakeup bit, as the netdev will be down and thus
 775                  * the wakeup handler won't clear it
 776                  */
 777                 clear_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
 778
 779                 spin_unlock_bh(&elm->lock);
 780
 781                 flush_work(&elm->tx_work);
 782         } else {
 783                 spin_unlock_bh(&elm->lock);
 784         }
 785
 786         elm->can.state = CAN_STATE_STOPPED;
 787         netif_stop_queue(dev);
 788         close_candev(dev);
 789         can_led_event(dev, CAN_LED_EVENT_STOP);
 790
 791         return 0;
 792 }
 793
 794 /* Send a can_frame to a TTY queue. */
 795 static netdev_tx_t elmcan_netdev_start_xmit(struct sk_buff *skb, struct net_device *dev)
 796 {
 797         struct elmcan *elm = netdev_priv(dev);
 798         struct can_frame *frame = (struct can_frame *) skb->data;
 799
 800         if (skb->len != sizeof(struct can_frame))
 801                 goto out;
 802
 803         if (!netif_running(dev))  {
 804                 netdev_warn(elm->dev, "xmit: iface is down.\n");
 805                 goto out;
 806         }
 807
 808         /* BHs are already disabled, so no spin_lock_bh().
 809          * See Documentation/networking/netdevices.txt
 810          */
 811         spin_lock(&elm->lock);
 812
 813         /* We shouldn't get here after a hardware fault:
 814          * can_bus_off() calls netif_carrier_off()
 815          */
 816         BUG_ON(elm->hw_failure);
 817
 818         if (elm->tty == NULL
 819                 || elm->can.ctrlmode & CAN_CTRLMODE_LISTENONLY) {
 820                 spin_unlock(&elm->lock);
 821                 goto out;
 822         }
 823
 824         netif_stop_queue(dev);
 825
 826         elm327_send_frame(elm, frame);
 827         spin_unlock(&elm->lock);
 828
 829         dev->stats.tx_packets++;
 830         dev->stats.tx_bytes += frame->can_dlc;
 831
 832         can_led_event(dev, CAN_LED_EVENT_TX);
 833
 834 out:
 835         kfree_skb(skb);
 836         return NETDEV_TX_OK;
 837 }
 838
 839 static int elmcan_netdev_change_mtu(struct net_device *dev, int new_mtu)
 840 {
 841         return -EINVAL;
 842 }
 843
 844 static const struct net_device_ops elmcan_netdev_ops = {
 845         .ndo_open       = elmcan_netdev_open,
 846         .ndo_stop       = elmcan_netdev_close,
 847         .ndo_start_xmit = elmcan_netdev_start_xmit,
 848         .ndo_change_mtu = elmcan_netdev_change_mtu,
 849 };
 850
 851
 852
 853
 854
 855  /************************************************************************
 856   *             Line discipline                                 *
 857   *                                                             *
 858   * (takes elm->lock)                                           *
 859   ************************************************************************/
 860
 861 /*
 862  * Get a reference to our struct, taking into account locks/refcounts.
 863  * This is to ensure ordering in case we are shutting down, and to ensure
 864  * there is a refcount at all (because tty->disc_data may be NULL).
 865  */
 866 static struct elmcan* get_elm(struct tty_struct *tty)
 867 {
 868         struct elmcan *elm;
 869         bool got_ref;
 870
 871         /* Lock all elmcan TTYs, so tty->disc_data can't become NULL
 872          * the moment before we increase the reference counter.
 873          */
 874         spin_lock_bh(&elmcan_discdata_lock);
 875         elm = (struct elmcan *) tty->disc_data;
 876
 877         if (!elm) {
 878                 spin_unlock_bh(&elmcan_discdata_lock);
 879                 return NULL;
 880         }
 881
 882         got_ref = atomic_inc_not_zero(&elm->refcount);
 883         spin_unlock_bh(&elmcan_discdata_lock);
 884
 885         if (!got_ref) {
 886                 return NULL;
 887         }
 888
 889         return elm;
 890 }
 891
 892 static void put_elm(struct elmcan *elm)
 893 {
 894         atomic_dec(&elm->refcount);
 895 }
 896
 897
 898
 899 /*
 900  * Handle the 'receiver data ready' interrupt.
 901  * This function is called by the 'tty_io' module in the kernel when
 902  * a block of ELM327 CAN data has been received, which can now be parsed
 903  * and sent on to some IP layer for further processing. This will not
 904  * be re-entered while running but other ldisc functions may be called
 905  * in parallel
 906  */
 907 static void elmcan_ldisc_rx(struct tty_struct *tty,
 908                         const unsigned char *cp, char *fp, int count)
 909 {
 910         struct elmcan *elm = get_elm(tty);
 911
 912         if (!elm)
 913                 return;
 914
 915         /* Read the characters out of the buffer */
 916         while (count-- && elm->rxfill < sizeof(elm->rxbuf)) {
 917                 if (fp && *fp++) {
 918                         netdev_err(elm->dev, "Error in received character stream. Check your wiring.");
 919
 920                         spin_lock_bh(&elm->lock);
 921                         elm327_hw_failure(elm);
 922                         spin_unlock_bh(&elm->lock);
 923
 924                         put_elm(elm);
 925                         return;
 926                 }
 927                 if (*cp != 0) {
 928                         elm->rxbuf[elm->rxfill++] = *cp;
 929                 }
 930                 cp++;
 931         }
 932
 933         if (count >= 0) {
 934                 netdev_err(elm->dev, "Receive buffer overflowed. Bad chip or wiring?");
 935
 936                 spin_lock_bh(&elm->lock);
 937                 elm327_hw_failure(elm);
 938                 spin_unlock_bh(&elm->lock);
 939
 940                 put_elm(elm);
 941                 return;
 942         }
 943
 944         spin_lock_bh(&elm->lock);
 945         elm327_parse_rxbuf(elm);
 946         spin_unlock_bh(&elm->lock);
 947
 948         put_elm(elm);
 949 }
 950
 951 /*
 952  * Write out remaining transmit buffer.
 953  * Scheduled when TTY is writable.
 954  */
 955 static void elmcan_ldisc_tx_worker(struct work_struct *work)
 956 {
 957         /* No need to use get_elm() here, as we'll always flush workers
 958          * befory destroying the elmcan object.
 959          */
 960         struct elmcan *elm = container_of(work, struct elmcan, tx_work);
 961         ssize_t actual;
 962
 963         spin_lock_bh(&elm->lock);
 964         if (elm->hw_failure) {
 965                 spin_unlock_bh(&elm->lock);
 966                 return;
 967         }
 968
 969         if (!elm->tty || !netif_running(elm->dev)) {
 970                 spin_unlock_bh(&elm->lock);
 971                 return;
 972         }
 973
 974         if (elm->txleft <= 0)  {
 975                 /* Our TTY write buffer is empty:
 976                  * We can start transmission of another packet
 977                  */
 978                 clear_bit(TTY_DO_WRITE_WAKEUP, &elm->tty->flags);
 979                 spin_unlock_bh(&elm->lock);
 980                 netif_wake_queue(elm->dev);
 981                 return;
 982         }
 983
 984         actual = elm->tty->ops->write(elm->tty, elm->txhead, elm->txleft);
 985         if (actual < 0) {
 986                 netdev_err(elm->dev, "Failed to write to tty %s.\n", elm->tty->name);
 987                 elm327_hw_failure(elm);
 988                 spin_unlock_bh(&elm->lock);
 989                 return;
 990         }
 991
 992         elm->txleft -= actual;
 993         elm->txhead += actual;
 994         spin_unlock_bh(&elm->lock);
 995 }
 996
 997
 998 /*
 999  * Called by the driver when there's room for more data.
1000  * Schedule the transmit.
1001  */
1002 static void elmcan_ldisc_tx_wakeup(struct tty_struct *tty)
1003 {
1004         struct elmcan *elm = get_elm(tty);
1005
1006         if (!elm)
1007                 return;
1008
1009         schedule_work(&elm->tx_work);
1010
1011         put_elm(elm);
1012 }
1013
1014
1015
1016 /* Some fake bit timings to allow bitrate setting */
1017 static const struct can_bittiming_const elmcan_bittiming_const = {
1018         .name = "elmcan",
1019         .tseg1_min = 1,
1020         .tseg1_max = 1,
1021         .tseg2_min = 0,
1022         .tseg2_max = 0,
1023         .sjw_max = 1,
1024         .brp_min = 1,
1025         .brp_max = 500,
1026         .brp_inc = 1,
1027 };
1028
1029 /*
1030  * Open the high-level part of the elmcan channel.
1031  * This function is called by the TTY module when the
1032  * elmcan line discipline is called for.
1033  *
1034  * Called in process context serialized from other ldisc calls.
1035  */
1036 static int elmcan_ldisc_open(struct tty_struct *tty)
1037 {
1038         struct net_device *dev;
1039         struct elmcan *elm;
1040         int err;
1041
1042         if (!capable(CAP_NET_ADMIN))
1043                 return -EPERM;
1044
1045         if (!tty->ops->write)
1046                 return -EOPNOTSUPP;
1047
1048
1049         /* OK.  Find a free elmcan channel to use. */
1050         dev = alloc_candev(sizeof(struct elmcan), 0);
1051         if (!dev)
1052                 return -ENFILE;
1053         elm = netdev_priv(dev);
1054
1055         /* Configure TTY interface */
1056         tty->receive_room = 65536; /* We don't flow control */
1057         elm->txleft = 0; /* Clear TTY TX buffer */
1058         spin_lock_init(&elm->lock);
1059         atomic_set(&elm->refcount, 1);
1060         INIT_WORK(&elm->tx_work, elmcan_ldisc_tx_worker);
1061
1062         /* Configure CAN metadata */
1063         elm->can.state = CAN_STATE_STOPPED;
1064         elm->can.clock.freq = 1000000;
1065         elm->can.bittiming_const = &elmcan_bittiming_const;
1066         elm->can.ctrlmode_supported = CAN_CTRLMODE_LISTENONLY;
1067
1068         /* Configure netlink interface */
1069         elm->dev = dev;
1070         dev->netdev_ops = &elmcan_netdev_ops;
1071
1072         /* Mark ldisc channel as alive */
1073         elm->tty = tty;
1074         tty->disc_data = elm;
1075
1076         devm_can_led_init(elm->dev);
1077
1078         /* Let 'er rip */
1079         err = register_candev(elm->dev);
1080         if (err) {
1081                 free_candev(elm->dev);
1082                 return err;
1083         }
1084
1085         netdev_info(elm->dev, "elmcan on %s.\n", tty->name);
1086
1087         return 0;
1088 }
1089
1090 /*
1091  * Close down an elmcan channel.
1092  * This means flushing out any pending queues, and then returning.
1093  * This call is serialized against other ldisc functions:
1094  * Once this is called, no other ldisc function of ours is entered.
1095  *
1096  * We also use this function for a hangup event.
1097  */
1098 static void elmcan_ldisc_close(struct tty_struct *tty)
1099 {
1100         /* Use get_elm() to synchronize against other users */
1101         struct elmcan *elm = get_elm(tty);
1102
1103         if (!elm)
1104                 return;
1105
1106         /* Tear down network side.
1107          * unregister_netdev() calls .ndo_stop() so we don't have to.
1108          */
1109         unregister_candev(elm->dev);
1110
1111         /* Decrease the refcount twice, once for our own get_elm(),
1112          * and once to remove the count of 1 that we set in _open().
1113          * Once it reaches 0, we can safely destroy it.
1114          */
1115         put_elm(elm);
1116         put_elm(elm);
1117
1118         /* Spin until refcount reaches 0 */
1119         while(atomic_read(&elm->refcount) > 0)
1120                 msleep(1);
1121
1122         /* At this point, all ldisc calls to us will be no-ops.
1123          * Since the refcount is 0, they are bailing immediately.
1124          */
1125
1126         /* Mark channel as dead */
1127         spin_lock_bh(&elm->lock);
1128         tty->disc_data = NULL;
1129         elm->tty = NULL;
1130         spin_unlock_bh(&elm->lock);
1131
1132         /* Flush TTY side */
1133         flush_work(&elm->tx_work);
1134
1135         netdev_info(elm->dev, "elmcan off %s.\n", tty->name);
1136
1137         /* Free our memory */
1138         free_candev(elm->dev);
1139 }
1140
1141 static int elmcan_ldisc_hangup(struct tty_struct *tty)
1142 {
1143         elmcan_ldisc_close(tty);
1144         return 0;
1145 }
1146
1147 /* Perform I/O control on an active elmcan channel. */
1148 static int elmcan_ldisc_ioctl(struct tty_struct *tty, struct file *file,
1149                         unsigned int cmd, unsigned long arg)
1150 {
1151         struct elmcan *elm = get_elm(tty);
1152         unsigned int tmp;
1153
1154         if (!elm)
1155                 return -EINVAL;
1156
1157         switch (cmd) {
1158         case SIOCGIFNAME:
1159                 tmp = strlen(elm->dev->name) + 1;
1160                 if (copy_to_user((void __user *)arg, elm->dev->name, tmp)) {
1161                         put_elm(elm);
1162                         return -EFAULT;
1163                 }
1164
1165                 put_elm(elm);
1166                 return 0;
1167
1168         case SIOCSIFHWADDR:
1169                 put_elm(elm);
1170                 return -EINVAL;
1171
1172         default:
1173                 put_elm(elm);
1174                 return tty_mode_ioctl(tty, file, cmd, arg);
1175         }
1176 }
1177
1178 static struct tty_ldisc_ops elmcan_ldisc = {
1179         .owner          = THIS_MODULE,
1180         .magic          = TTY_LDISC_MAGIC,
1181         .name           = "elmcan",
1182         .receive_buf    = elmcan_ldisc_rx,
1183         .write_wakeup   = elmcan_ldisc_tx_wakeup,
1184         .open           = elmcan_ldisc_open,
1185         .close          = elmcan_ldisc_close,
1186         .hangup         = elmcan_ldisc_hangup,
1187         .ioctl          = elmcan_ldisc_ioctl,
1188 };
1189
1190
1191
1192
1193
1194  /************************************************************************
1195   *             Module init/exit                                *
1196   ************************************************************************/
1197
1198 static int __init elmcan_init(void)
1199 {
1200         int status;
1201
1202         pr_info("ELM327 based best-effort CAN interface driver\n");
1203         pr_info("This device is severely limited as a CAN interface, see documentation.\n");
1204
1205         /* Fill in our line protocol discipline, and register it */
1206         status = tty_register_ldisc(N_ELMCAN, &elmcan_ldisc);
1207         if (status) {
1208                 pr_err("can't register line discipline\n");
1209         }
1210         return status;
1211 }
1212
1213 static void __exit elmcan_exit(void)
1214 {
1215         /* This will only be called when all channels have been closed by
1216          * userspace - tty_ldisc.c takes care of the module's refcount.
1217          */
1218         int status;
1219
1220         status = tty_unregister_ldisc(N_ELMCAN);
1221         if (status) {
1222                 pr_err("Can't unregister line discipline (error: %d)\n", status);
1223         }
1224 }
1225
1226 module_init(elmcan_init);
1227 module_exit(elmcan_exit);