Change MAGIC to DUMMY, and silence init
[elmcan.git] / module / elmcan.c
index 76ec682e9450b6d93d16d199ba426b604a2ce944..663c19ef142c7157742a99650f0eda7c5a7227db 100644 (file)
@@ -60,8 +60,8 @@ MODULE_AUTHOR("Max Staudt <max-linux@enpas.org>");
 #define ELM327_CAN_CONFIG_RECV_BOTH_SFF_EFF  0x2000
 #define ELM327_CAN_CONFIG_BAUDRATE_MULT_8_7  0x1000
 
-#define ELM327_MAGIC_CHAR 'y'
-#define ELM327_MAGIC_STRING "y"
+#define ELM327_DUMMY_CHAR 'y'
+#define ELM327_DUMMY_STRING "y"
 #define ELM327_READY_CHAR '>'
 
 /* Bits in elm->cmds_todo */
@@ -117,7 +117,7 @@ struct elmcan {
        /* State machine */
        enum {
                ELM_NOTINIT = 0,
-               ELM_GETMAGICCHAR,
+               ELM_GETDUMMYCHAR,
                ELM_GETPROMPT,
                ELM_RECEIVING,
        } state;
@@ -180,7 +180,7 @@ static void elm327_send(struct elmcan *elm, const void *buf, size_t len)
 }
 
 /* Take the ELM327 out of almost any state and back into command mode.
- * We send ELM327_MAGIC_CHAR which will either abort any running
+ * We send ELM327_DUMMY_CHAR which will either abort any running
  * operation, or be echoed back to us in case we're already in command
  * mode.
  *
@@ -188,10 +188,10 @@ static void elm327_send(struct elmcan *elm, const void *buf, size_t len)
  */
 static void elm327_kick_into_cmd_mode(struct elmcan *elm)
 {
-       if (elm->state != ELM_GETMAGICCHAR && elm->state != ELM_GETPROMPT) {
-               elm327_send(elm, ELM327_MAGIC_STRING, 1);
+       if (elm->state != ELM_GETDUMMYCHAR && elm->state != ELM_GETPROMPT) {
+               elm327_send(elm, ELM327_DUMMY_STRING, 1);
 
-               elm->state = ELM_GETMAGICCHAR;
+               elm->state = ELM_GETDUMMYCHAR;
        }
 }
 
@@ -343,8 +343,21 @@ static int _memstrcmp(const u8 *mem, const char *str)
        return memcmp(mem, str, strlen(str));
 }
 
+/* Compare buffer to string length, then compare buffer to fixed string.
+ * This ensures two things:
+ *  - It flags cases where the fixed string is only the start of the
+ *    buffer, rather than exactly all of it.
+ *  - It avoids byte comparisons in case the length doesn't match.
+ */
+static int _len_memstrcmp(const u8 *mem, size_t mem_len, const char *str)
+{
+       size_t str_len = strlen(str);
+
+       return (mem_len != str_len) || memcmp(mem, str, str_len);
+}
+
 /* Assumes elm->lock taken. */
-static void elm327_parse_error(struct elmcan *elm, int len)
+static void elm327_parse_error(struct elmcan *elm, size_t len)
 {
        struct can_frame frame;
 
@@ -353,55 +366,38 @@ static void elm327_parse_error(struct elmcan *elm, int len)
        frame.can_dlc = CAN_ERR_DLC;
 
        /* Filter possible error messages based on length of RX'd line */
-       switch (len) {
-       case 17:
-               if (!_memstrcmp(elm->rxbuf, "UNABLE TO CONNECT")) {
-                       netdev_err(elm->dev,
-                                  "ELM327 reported UNABLE TO CONNECT. Please check your setup.\n");
-               }
-               break;
-       case 11:
-               if (!_memstrcmp(elm->rxbuf, "BUFFER FULL")) {
-                       /* This case will only happen if the last data
-                        * line was complete.
-                        * Otherwise, elm327_parse_frame() will heuristically
-                        * emit this error frame instead.
-                        */
-                       frame.can_id |= CAN_ERR_CRTL;
-                       frame.data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
-               }
-               break;
-       case 9:
-               if (!_memstrcmp(elm->rxbuf, "BUS ERROR"))
-                       frame.can_id |= CAN_ERR_BUSERROR;
-               if (!_memstrcmp(elm->rxbuf, "CAN ERROR"))
-                       frame.can_id |= CAN_ERR_PROT;
-               if (!_memstrcmp(elm->rxbuf, "<RX ERROR"))
-                       frame.can_id |= CAN_ERR_PROT;
-               break;
-       case 8:
-               if (!_memstrcmp(elm->rxbuf, "BUS BUSY")) {
-                       frame.can_id |= CAN_ERR_PROT;
-                       frame.data[2] = CAN_ERR_PROT_OVERLOAD;
-               }
-               if (!_memstrcmp(elm->rxbuf, "FB ERROR")) {
-                       frame.can_id |= CAN_ERR_PROT;
-                       frame.data[2] = CAN_ERR_PROT_TX;
-               }
-               break;
-       case 5: /* ERR is followed by two digits, hence line length 5 */
-               if (!_memstrcmp(elm->rxbuf, "ERR")) {
-                       netdev_err(elm->dev, "ELM327 reported an ERR%c%c. Please power it off and on again.\n",
-                                  elm->rxbuf[3], elm->rxbuf[4]);
-                       frame.can_id |= CAN_ERR_CRTL;
-               }
-               break;
-       default:
+       if (!_len_memstrcmp(elm->rxbuf, len, "UNABLE TO CONNECT")) {
+               netdev_err(elm->dev,
+                          "ELM327 reported UNABLE TO CONNECT. Please check your setup.\n");
+       } else if (!_len_memstrcmp(elm->rxbuf, len, "BUFFER FULL")) {
+               /* This will only happen if the last data line was complete.
+                * Otherwise, elm327_parse_frame() will heuristically
+                * emit this kind of error frame instead.
+                */
+               frame.can_id |= CAN_ERR_CRTL;
+               frame.data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
+       } else if (!_len_memstrcmp(elm->rxbuf, len, "BUS ERROR")) {
+               frame.can_id |= CAN_ERR_BUSERROR;
+       } else if (!_len_memstrcmp(elm->rxbuf, len, "CAN ERROR")) {
+               frame.can_id |= CAN_ERR_PROT;
+       } else if (!_len_memstrcmp(elm->rxbuf, len, "<RX ERROR")) {
+               frame.can_id |= CAN_ERR_PROT;
+       } else if (!_len_memstrcmp(elm->rxbuf, len, "BUS BUSY")) {
+               frame.can_id |= CAN_ERR_PROT;
+               frame.data[2] = CAN_ERR_PROT_OVERLOAD;
+       } else if (!_len_memstrcmp(elm->rxbuf, len, "FB ERROR")) {
+               frame.can_id |= CAN_ERR_PROT;
+               frame.data[2] = CAN_ERR_PROT_TX;
+       } else if (len == 5 && !_memstrcmp(elm->rxbuf, "ERR")) {
+               /* ERR is followed by two digits, hence line length 5 */
+               netdev_err(elm->dev, "ELM327 reported an ERR%c%c. Please power it off and on again.\n",
+                          elm->rxbuf[3], elm->rxbuf[4]);
+               frame.can_id |= CAN_ERR_CRTL;
+       } else {
                /* Something else has happened.
                 * Maybe garbage on the UART line.
                 * Emit a generic error frame.
                 */
-               break;
        }
 
        elm327_feed_frame_to_netdev(elm, &frame);
@@ -421,7 +417,7 @@ static void elm327_parse_error(struct elmcan *elm, int len)
  *
  * Assumes elm->lock taken.
  */
-static int elm327_parse_frame(struct elmcan *elm, int len)
+static int elm327_parse_frame(struct elmcan *elm, size_t len)
 {
        struct can_frame frame;
        int hexlen;
@@ -547,7 +543,7 @@ static int elm327_parse_frame(struct elmcan *elm, int len)
 }
 
 /* Assumes elm->lock taken. */
-static void elm327_parse_line(struct elmcan *elm, int len)
+static void elm327_parse_line(struct elmcan *elm, size_t len)
 {
        /* Skip empty lines */
        if (!len)
@@ -598,7 +594,7 @@ static void elm327_handle_prompt(struct elmcan *elm)
                elm->next_init_cmd++;
                if (!(*elm->next_init_cmd)) {
                        clear_bit(TODO_INIT, &elm->cmds_todo);
-                       netdev_info(elm->dev, "Initialization finished.\n");
+                       /* Init finished. */
                }
 
        } else if (test_and_clear_bit(TODO_SILENT_MONITOR, &elm->cmds_todo)) {
@@ -663,7 +659,7 @@ static bool elm327_is_ready_char(char c)
 }
 
 /* Assumes elm->lock taken. */
-static void elm327_drop_bytes(struct elmcan *elm, int i)
+static void elm327_drop_bytes(struct elmcan *elm, size_t i)
 {
        memmove(&elm->rxbuf[0], &elm->rxbuf[i], ELM327_SIZE_RXBUF - i);
        elm->rxfill -= i;
@@ -672,26 +668,26 @@ static void elm327_drop_bytes(struct elmcan *elm, int i)
 /* Assumes elm->lock taken. */
 static void elm327_parse_rxbuf(struct elmcan *elm)
 {
-       int len;
+       size_t len;
 
        switch (elm->state) {
        case ELM_NOTINIT:
                elm->rxfill = 0;
                break;
 
-       case ELM_GETMAGICCHAR:
+       case ELM_GETDUMMYCHAR:
        {
                /* Wait for 'y' or '>' */
                int i;
 
                for (i = 0; i < elm->rxfill; i++) {
-                       if (elm->rxbuf[i] == ELM327_MAGIC_CHAR) {
+                       if (elm->rxbuf[i] == ELM327_DUMMY_CHAR) {
                                elm327_send(elm, "\r", 1);
                                elm->state = ELM_GETPROMPT;
                                i++;
                                break;
                        } else if (elm327_is_ready_char(elm->rxbuf[i])) {
-                               elm327_send(elm, ELM327_MAGIC_STRING, 1);
+                               elm327_send(elm, ELM327_DUMMY_STRING, 1);
                                i++;
                                break;
                        }
@@ -818,7 +814,7 @@ static int elmcan_netdev_close(struct net_device *dev)
        spin_lock_bh(&elm->lock);
        if (elm->tty) {
                /* Interrupt whatever we're doing right now */
-               elm327_send(elm, ELM327_MAGIC_STRING, 1);
+               elm327_send(elm, ELM327_DUMMY_STRING, 1);
 
                /* Clear the wakeup bit, as the netdev will be down and thus
                 * the wakeup handler won't clear it
@@ -932,7 +928,7 @@ static bool elmcan_is_valid_rx_char(char c)
 {
        return (isdigit(c) ||
                isupper(c) ||
-               c == ELM327_MAGIC_CHAR ||
+               c == ELM327_DUMMY_CHAR ||
                c == ELM327_READY_CHAR ||
                c == '<' ||
                c == 'a' ||