Add BSD-3-Clause licence

[elmcan.git] / module / elmcan.c

diff --git a/module/elmcan.c b/module/elmcan.c
index 7fc620777876baa3076ec9993f7b20101fa42e6a..6c99ca0a30da520ee11bd690d74a361a3698e4d0 100644 (file)
--- a/module/elmcan.c
+++ b/module/elmcan.c
@@ -2,13 +2,23 @@
 /* elmcan.c - ELM327 based CAN interface driver
  *            (tty line discipline)
  *
- * This file is derived from linux/drivers/net/can/slcan.c
+ * This driver started as a derivative of linux/drivers/net/can/slcan.c
+ * and my thanks go to the original authors for their inspiration.
  *
  * elmcan.c Author : Max Staudt <max-linux@enpas.org>
  * slcan.c Author  : Oliver Hartkopp <socketcan@hartkopp.net>
  * slip.c Authors  : Laurence Culhane <loz@holmes.demon.co.uk>
  *                   Fred N. van Kempen <waltje@uwalt.nl.mugnet.org>
  *
+ * This code barely bears any resemblance to slcan anymore, and whatever
+ * may be left is Linux specific boilerplate anyway, however I am leaving
+ * the GPL-2.0 identifier at the top just to be sure.
+ *
+ * Please feel free to use my own code, especially the ELM327 communication
+ * logic, in accordance with SPDX-License-Identifier BSD-3-Clause to port
+ * this driver to other systems.
+ *    - Max
+ *
  */
 
 #define pr_fmt(fmt) "[elmcan] " fmt
@@ -30,12 +40,14 @@
 #include <linux/spinlock.h>
 #include <linux/string.h>
 #include <linux/tty.h>
+#include <linux/version.h>
 #include <linux/workqueue.h>
 
 #include <linux/can.h>
 #include <linux/can/dev.h>
 #include <linux/can/error.h>
 #include <linux/can/led.h>
+#include <linux/can/rx-offload.h>
 
 MODULE_ALIAS_LDISC(N_ELMCAN);
 MODULE_DESCRIPTION("ELM327 based CAN interface");
@@ -56,6 +68,8 @@ MODULE_PARM_DESC(accept_flaky_uart, "Don't bail at the first invalid character.
 #define N_ELMCAN 29
 #endif
 
+#define ELM327_NAPI_WEIGHT 4
+
 #define ELM327_SIZE_RXBUF 256
 #define ELM327_SIZE_TXBUF 32
 
@@ -85,6 +99,8 @@ struct elmcan {
        /* This must be the first member when using alloc_candev() */
        struct can_priv can;
 
+       struct can_rx_offload offload;
+
        /* TTY and netdev devices that we're bridging */
        struct tty_struct       *tty;
        struct net_device       *dev;
@@ -313,11 +329,16 @@ static void elm327_feed_frame_to_netdev(struct elmcan *elm,
 
        memcpy(cf, frame, sizeof(struct can_frame));
 
-       elm->dev->stats.rx_packets++;
-       elm->dev->stats.rx_bytes += frame->can_dlc;
-       netif_rx_ni(skb);
+       /* Queue for NAPI pickup.
+        * rx-offload will update stats and LEDs for us.
+        */
+       if (can_rx_offload_queue_tail(&elm->offload, skb))
+               elm->dev->stats.rx_fifo_errors++;
 
-       can_led_event(elm->dev, CAN_LED_EVENT_RX);
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(5,15,0)
+       /* Wake NAPI */
+       can_rx_offload_irq_finish(&elm->offload);
+#endif
 }
 
  /***********************************************************************
@@ -363,7 +384,7 @@ static void elm327_parse_error(struct elmcan *elm, int len)
        case 17:
                if (!memcmp(elm->rxbuf, "UNABLE TO CONNECT", 17)) {
                        netdev_err(elm->dev,
-                                  "The ELM327 reported UNABLE TO CONNECT. Please check your setup.\n");
+                                  "ELM327 reported UNABLE TO CONNECT. Please check your setup.\n");
                }
                break;
        case 11:
@@ -397,7 +418,7 @@ static void elm327_parse_error(struct elmcan *elm, int len)
                break;
        case 5:
                if (!memcmp(elm->rxbuf, "ERR", 3)) {
-                       netdev_err(elm->dev, "The ELM327 reported an ERR%c%c. Please power it off and on again.\n",
+                       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;
                }
@@ -457,7 +478,7 @@ static int elm327_parse_frame(struct elmcan *elm, int len)
                 * The main code will restart listening.
                 */
                elm327_kick_into_cmd_mode(elm);
-               return 3;
+               return -ENODATA;
        }
 
        /* Use spaces in CAN ID to distinguish 29 or 11 bit address length.
@@ -476,14 +497,14 @@ static int elm327_parse_frame(struct elmcan *elm, int len)
                /* This is not a well-formatted data line.
                 * Assume it's an error message.
                 */
-               return 1;
+               return -ENODATA;
        }
 
        if (hexlen < datastart) {
                /* The line is too short to be a valid frame hex dump.
                 * Something interrupted the hex dump or it is invalid.
                 */
-               return 1;
+               return -ENODATA;
        }
 
        /* From here on all chars up to buf[hexlen] are hex or spaces,
@@ -535,7 +556,7 @@ static int elm327_parse_frame(struct elmcan *elm, int len)
                 * However, this will correctly drop the state machine back into
                 * command mode.
                 */
-               return 2;
+               return -ENODATA;
        }
 
        /* Parse the data nibbles. */
@@ -762,6 +783,16 @@ static void elm327_parse_rxbuf(struct elmcan *elm)
   * (takes elm->lock)                                                  *
   ***********************************************************************/
 
+/* Dummy needed to use can_rx_offload */
+static struct sk_buff *elmcan_mailbox_read(struct can_rx_offload *offload,
+                                          unsigned int n, u32 *timestamp,
+                                          bool drop)
+{
+       WARN_ON(1); /* This function is a dummy, so don't call it! */
+
+       return ERR_PTR(-ENOBUFS);
+}
+
 static int elmcan_netdev_open(struct net_device *dev)
 {
        struct elmcan *elm = netdev_priv(dev);
@@ -789,6 +820,15 @@ static int elmcan_netdev_open(struct net_device *dev)
        elm327_init(elm);
        spin_unlock_bh(&elm->lock);
 
+       elm->offload.mailbox_read = elmcan_mailbox_read;
+       err = can_rx_offload_add_fifo(dev, &elm->offload, ELM327_NAPI_WEIGHT);
+       if (err) {
+               close_candev(dev);
+               return err;
+       }
+
+       can_rx_offload_enable(&elm->offload);
+
        can_led_event(dev, CAN_LED_EVENT_OPEN);
        elm->can.state = CAN_STATE_ERROR_ACTIVE;
        netif_start_queue(dev);
@@ -800,6 +840,8 @@ static int elmcan_netdev_close(struct net_device *dev)
 {
        struct elmcan *elm = netdev_priv(dev);
 
+       netif_stop_queue(dev);
+
        spin_lock_bh(&elm->lock);
        if (elm->tty) {
                /* Interrupt whatever we're doing right now */
@@ -817,8 +859,9 @@ static int elmcan_netdev_close(struct net_device *dev)
                spin_unlock_bh(&elm->lock);
        }
 
+       can_rx_offload_disable(&elm->offload);
        elm->can.state = CAN_STATE_STOPPED;
-       netif_stop_queue(dev);
+       can_rx_offload_del(&elm->offload);
        close_candev(dev);
        can_led_event(dev, CAN_LED_EVENT_STOP);
 
@@ -1244,7 +1287,7 @@ static int __init elmcan_init(void)
 
        status = tty_register_ldisc(N_ELMCAN, &elmcan_ldisc);
        if (status)
-               pr_err("can't register line discipline\n");
+               pr_err("Can't register line discipline\n");
 
        return status;
 }