]> rtime.felk.cvut.cz Git - linux-lin.git/blobdiff - sllin/sllin.c
sllin: General purpose LIN-related flags and masks moved into separate header file.
[linux-lin.git] / sllin / sllin.c
index 03d6137fc35b4e3e7c26eb436903e96102e7ad9e..d1821e801ab4969f697feb750aa68541f5bdcf75 100644 (file)
@@ -36,6 +36,8 @@
  *
  */
 
+#define DEBUG          1 /* Enables pr_debug() printouts */
+
 #include <linux/module.h>
 #include <linux/moduleparam.h>
 
 #include <linux/can.h>
 #include <linux/kthread.h>
 #include <linux/hrtimer.h>
+#include "linux/lin_bus.h"
 
 /* Should be in include/linux/tty.h */
-#define N_SLLIN         25
+#define N_SLLIN                25
+/* -------------------------------- */
 
 static __initdata const char banner[] =
        KERN_INFO "sllin: serial line LIN interface driver\n";
@@ -68,8 +72,8 @@ MODULE_DESCRIPTION("serial line LIN interface");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("");
 
-#define SLLIN_MAGIC 0x53CA
-// #define BREAK_BY_BAUD
+#define SLLIN_MAGIC            0x53CA
+/* #define BREAK_BY_BAUD */
 
 static int maxdev = 10;                /* MAX number of SLLIN channels;
                                   This can be overridden with
@@ -78,17 +82,13 @@ module_param(maxdev, int, 0);
 MODULE_PARM_DESC(maxdev, "Maximum number of sllin interfaces");
 
 /* maximum buffer len to store whole LIN message*/
-#define SLLIN_DATA_MAX  8
-#define SLLIN_BUFF_LEN (1 /*break*/ + 1 /*sync*/ + 1 /*ID*/ + \
-                         SLLIN_DATA_MAX + 1 /*checksum*/)
-#define SLLIN_BUFF_BREAK 0
-#define SLLIN_BUFF_SYNC         1
-#define SLLIN_BUFF_ID   2
-#define SLLIN_BUFF_DATA         3
-
-#define SLLIN_ID_MASK          0x3f
-#define SLLIN_ID_MAX           SLLIN_ID_MASK
-#define SLLIN_CTRL_FRAME       CAN_EFF_FLAG
+#define SLLIN_DATA_MAX         8
+#define SLLIN_BUFF_LEN         (1 /*break*/ + 1 /*sync*/ + 1 /*ID*/ + \
+                               SLLIN_DATA_MAX + 1 /*checksum*/)
+#define SLLIN_BUFF_BREAK       0
+#define SLLIN_BUFF_SYNC                1
+#define SLLIN_BUFF_ID          2
+#define SLLIN_BUFF_DATA                3
 
 #define SLLIN_SAMPLES_PER_CHAR 10
 #define SLLIN_CHARS_TO_TIMEOUT 12
@@ -106,21 +106,6 @@ enum slstate {
 
 struct sllin_conf_entry {
        int dlc;                /* Length of data in LIN frame */
-#define SLLIN_CANFR_FLAGS_OFFS 6 /* Lower 6 bits in can_id correspond to LIN ID */
-/* Save configuration for particular LIN ID */
-#define SLLIN_LIN_ID_CONF      (1 <<  SLLIN_CANFR_FLAGS_OFFS)
-/* Publisher of particular LIN response is SLLIN Master */
-#define SLLIN_SRC_MASTER       (1 << (SLLIN_CANFR_FLAGS_OFFS + 1))
-#define SLLIN_SRC_SLAVE                (1 << (SLLIN_CANFR_FLAGS_OFFS + 2))
-#define SLLIN_SLAVE_LOCAL      (1 << (SLLIN_CANFR_FLAGS_OFFS + 3))
-#define SLLIN_SLAVE_REMOTE     (1 << (SLLIN_CANFR_FLAGS_OFFS + 4))
-#define SLLIN_LOC_SLAVE_CACHE  (1 << (SLLIN_CANFR_FLAGS_OFFS + 5))
-#define SLLIN_CHECKSUM_EXTENDED        (1 << (SLLIN_CANFR_FLAGS_OFFS + 6))
-
-#define SLLIN_ERR_RX_TIMEOUT    (1 << (SLLIN_CANFR_FLAGS_OFFS + 7))
-#define SLLIN_ERR_CHECKSUM      (1 << (SLLIN_CANFR_FLAGS_OFFS + 8))
-//#define SLLIN_ERR_FRAMING     (1 << (SLLIN_CANFR_FLAGS_OFFS + 9))
-
        canid_t frame_fl;       /* LIN frame flags. Passed from userspace as canid_t data type */
        u8 data[8];             /* LIN frame data payload */
 };
@@ -158,7 +143,7 @@ struct sllin {
 
        dev_t                   line;
        struct task_struct      *kwthread;
-       wait_queue_head_t       kwt_wq;
+       wait_queue_head_t       kwt_wq;         /* Wait queue used by kwthread */
        struct hrtimer          rx_timer;       /* RX timeout timer */
        ktime_t                 rx_timer_timeout; /* RX timeout timer value */
        struct sk_buff          *tx_req_skb;    /* Socket buffer with CAN frame received
@@ -172,17 +157,27 @@ static struct net_device **sllin_devs;
 static int sllin_configure_frame_cache(struct sllin *sl, struct can_frame *cf);
 
 
+/* Values of two parity bits in LIN Protected
+   Identifier for each particular LIN ID */
 const unsigned char sllin_id_parity_table[] = {
-        0x80,0xc0,0x40,0x00,0xc0,0x80,0x00,0x40,
-        0x00,0x40,0xc0,0x80,0x40,0x00,0x80,0xc0,
-        0x40,0x00,0x80,0xc0,0x00,0x40,0xc0,0x80,
-        0xc0,0x80,0x00,0x40,0x80,0xc0,0x40,0x00,
-        0x00,0x40,0xc0,0x80,0x40,0x00,0x80,0xc0,
-        0x80,0xc0,0x40,0x00,0xc0,0x80,0x00,0x40,
-        0xc0,0x80,0x00,0x40,0x80,0xc0,0x40,0x00,
-        0x40,0x00,0x80,0xc0,0x00,0x40,0xc0,0x80
+        0x80, 0xc0, 0x40, 0x00, 0xc0, 0x80, 0x00, 0x40,
+        0x00, 0x40, 0xc0, 0x80, 0x40, 0x00, 0x80, 0xc0,
+        0x40, 0x00, 0x80, 0xc0, 0x00, 0x40, 0xc0, 0x80,
+        0xc0, 0x80, 0x00, 0x40, 0x80, 0xc0, 0x40, 0x00,
+        0x00, 0x40, 0xc0, 0x80, 0x40, 0x00, 0x80, 0xc0,
+        0x80, 0xc0, 0x40, 0x00, 0xc0, 0x80, 0x00, 0x40,
+        0xc0, 0x80, 0x00, 0x40, 0x80, 0xc0, 0x40, 0x00,
+        0x40, 0x00, 0x80, 0xc0, 0x00, 0x40, 0xc0, 0x80
 };
 
+/**
+ * sltty_change_speed() -- Change baudrate of Serial device belonging to particular @tty
+ *
+ * @tty:       Pointer to TTY to change speed for.
+ * @speed:     Integer value of new speed. It is possible to 
+ *             assign non-standard values, i.e. those which
+ *             are not defined in termbits.h.
+ */
 static int sltty_change_speed(struct tty_struct *tty, unsigned speed)
 {
        struct ktermios old_termios;
@@ -237,6 +232,11 @@ static void sllin_send_canfr(struct sllin *sl, canid_t id, char *data, int len)
 
 }
 
+/**
+ * sll_bump() -- Send data of received LIN frame (existing in sl->rx_buff) as CAN frame
+ *
+ * @sl:
+ */
 static void sll_bump(struct sllin *sl)
 {
        sllin_send_canfr(sl, sl->rx_buff[SLLIN_BUFF_ID] & SLLIN_ID_MASK,
@@ -268,7 +268,7 @@ static void sllin_write_wakeup(struct tty_struct *tty)
                sl->tx_cnt += actual;
 
                if (sl->tx_cnt < sl->tx_lim) {
-                       printk(KERN_INFO "sllin_write_wakeup sent %d, remains %d, waiting\n",
+                       pr_debug("sllin: sllin_write_wakeup sent %d, remains %d, waiting\n",
                                sl->tx_cnt, sl->tx_lim - sl->tx_cnt);
                        return;
                }
@@ -278,10 +278,15 @@ static void sllin_write_wakeup(struct tty_struct *tty)
        set_bit(SLF_TXEVENT, &sl->flags);
        wake_up(&sl->kwt_wq);
 
-       printk(KERN_INFO "sllin_write_wakeup sent %d, wakeup\n", sl->tx_cnt);
+       pr_debug("sllin: sllin_write_wakeup sent %d, wakeup\n", sl->tx_cnt);
 }
 
-/* Send a can_frame to a TTY queue. */
+/**
+ * sll_xmit() -- Send a can_frame to a TTY queue.
+ *
+ * @skb: Pointer to Socket buffer to be sent.
+ * @dev: Network device where @skb will be sent.
+ */
 static netdev_tx_t sll_xmit(struct sk_buff *skb, struct net_device *dev)
 {
        struct sllin *sl = netdev_priv(dev);
@@ -394,21 +399,12 @@ static void sll_setup(struct net_device *dev)
   Routines looking at TTY side.
  ******************************************/
 
-/*
- * Handle the 'receiver data ready' interrupt.
- * This function is called by the 'tty_io' module in the kernel when
- * a block of SLLIN data has been received, which can now be decapsulated
- * and sent on to some IP layer for further processing. This will not
- * be re-entered while running but other ldisc functions may be called
- * in parallel
- */
-
 static void sllin_receive_buf(struct tty_struct *tty,
                              const unsigned char *cp, char *fp, int count)
 {
        struct sllin *sl = (struct sllin *) tty->disc_data;
 
-       printk(KERN_INFO "sllin_receive_buf invoked\n");
+       pr_debug("sllin: sllin_receive_buf invoked\n");
 
        if (!sl || sl->magic != SLLIN_MAGIC || !netif_running(sl->dev))
                return;
@@ -418,7 +414,7 @@ static void sllin_receive_buf(struct tty_struct *tty,
                if (fp && *fp++) {
                        if (!test_and_set_bit(SLF_ERROR, &sl->flags))
                                sl->dev->stats.rx_errors++;
-                       printk(KERN_INFO "sllin_receive_buf char 0x%02x ignored "
+                       pr_debug("sllin: sllin_receive_buf char 0x%02x ignored "
                                "due marker 0x%02x, flags 0x%lx\n",
                                *cp, *(fp-1), sl->flags);
                        cp++;
@@ -432,7 +428,7 @@ static void sllin_receive_buf(struct tty_struct *tty,
                                sl->rx_buff[sl->rx_cnt++] = 0x00;
                        }
 #endif
-                       printk(KERN_INFO "LIN_RX[%d]: 0x%02x\n", sl->rx_cnt, *cp);
+                       pr_debug("sllin: LIN_RX[%d]: 0x%02x\n", sl->rx_cnt, *cp);
                        sl->rx_buff[sl->rx_cnt++] = *cp++;
                }
        }
@@ -440,21 +436,35 @@ static void sllin_receive_buf(struct tty_struct *tty,
        if (sl->rx_cnt >= sl->rx_expect) {
                set_bit(SLF_RXEVENT, &sl->flags);
                wake_up(&sl->kwt_wq);
-               printk(KERN_INFO "sllin_receive_buf count %d, wakeup\n", sl->rx_cnt);
+               pr_debug("sllin: sllin_receive_buf count %d, wakeup\n", sl->rx_cnt);
        } else {
-               printk(KERN_INFO "sllin_receive_buf count %d, waiting\n", sl->rx_cnt);
+               pr_debug("sllin: sllin_receive_buf count %d, waiting\n", sl->rx_cnt);
        }
 }
 
 /*****************************************
  *  sllin message helper routines
  *****************************************/
+/**
+ * sllin_report_error() -- Report an error by sending CAN frame \
+ *     with particular error flag set in can_id
+ *
+ * @sl:
+ * @err: Error flag to be sent.
+ */
 void sllin_report_error(struct sllin *sl, int err)
 {
        sllin_send_canfr(sl, 0 | CAN_EFF_FLAG | 
                (err & ~SLLIN_ID_MASK), NULL, 0);
 }
 
+/**
+ * sllin_configure_frame_cache() -- Configure particular entry in linfr_cache
+ *
+ * @sl:
+ * @cf: Pointer to CAN frame sent to this driver
+ *     holding configuration information
+ */
 static int sllin_configure_frame_cache(struct sllin *sl, struct can_frame *cf)
 {
        struct sllin_conf_entry *sce;
@@ -462,7 +472,7 @@ static int sllin_configure_frame_cache(struct sllin *sl, struct can_frame *cf)
                return -1;
 
        sce = &sl->linfr_cache[cf->can_id & SLLIN_ID_MASK];
-       printk(KERN_INFO "Setting frame cache with EFF CAN frame. "
+       pr_debug("sllin: Setting frame cache with EFF CAN frame. "
                "LIN ID = %d\n", cf->can_id & SLLIN_ID_MASK);
 
        sce->dlc = cf->can_dlc;
@@ -475,6 +485,15 @@ static int sllin_configure_frame_cache(struct sllin *sl, struct can_frame *cf)
        return 0;
 }
 
+/**
+ * sllin_checksum() -- Count checksum for particular data
+ * 
+ * @data:       Pointer to the buffer containing whole LIN
+ *              frame (i.e. including break and sync bytes).
+ * @length:     Length of the buffer.
+ * @enhanced_fl: Flag determining whether Enhanced or Classic
+ *              checksum should be counted.
+ */
 static inline unsigned sllin_checksum(unsigned char *data, int length, int enhanced_fl)
 {
        unsigned csum = 0;
@@ -564,7 +583,7 @@ int sllin_send_tx_buff(struct sllin *sl)
                sl->tx_cnt += res;
        }
 
-       printk(KERN_INFO "sllin_send_tx_buff sent %d, remains %d\n",
+       pr_debug("sllin: sllin_send_tx_buff sent %d, remains %d\n",
                        sl->tx_cnt, remains);
 
        return 0;
@@ -629,7 +648,7 @@ int sllin_send_break(struct sllin *sl)
 
        sl->tx_cnt = SLLIN_BUFF_SYNC;
 
-       printk(KERN_INFO "sllin: Break sent.\n");
+       pr_debug("sllin: Break sent.\n");
        set_bit(SLF_RXEVENT, &sl->flags);
        wake_up(&sl->kwt_wq);
 
@@ -649,6 +668,11 @@ static enum hrtimer_restart sllin_rx_timeout_handler(struct hrtimer *hrtimer)
        return HRTIMER_NORESTART;
 }
 
+/**
+ * sllin_rx_validate() -- Validate received frame, i,e. check checksum
+ *
+ * @sl:
+ */
 static int sllin_rx_validate(struct sllin *sl)
 {
        int actual_id;
@@ -691,7 +715,7 @@ int sllin_kwthread(void *ptr)
        int tx_bytes = 0; /* Used for Network statistics */
 
 
-       printk(KERN_INFO "sllin: sllin_kwthread started.\n");
+       pr_debug("sllin: sllin_kwthread started.\n");
        sched_setscheduler(current, SCHED_FIFO, &schparam);
 
        clear_bit(SLF_ERROR, &sl->flags);
@@ -720,15 +744,15 @@ int sllin_kwthread(void *ptr)
                                && test_bit(SLF_MSGEVENT, &sl->flags)));
 
                if (test_and_clear_bit(SLF_RXEVENT, &sl->flags)) {
-                       printk(KERN_INFO "sllin_kthread RXEVENT \n");
+                       pr_debug("sllin: sllin_kthread RXEVENT \n");
                }
 
                if (test_and_clear_bit(SLF_TXEVENT, &sl->flags)) {
-                       printk(KERN_INFO "sllin_kthread TXEVENT \n");
+                       pr_debug("sllin: sllin_kthread TXEVENT \n");
                }
 
                if (test_and_clear_bit(SLF_TMOUTEVENT, &sl->flags)) {
-                       printk(KERN_INFO "sllin_kthread TMOUTEVENT \n");
+                       pr_debug("sllin: sllin_kthread TMOUTEVENT \n");
                        sl->rx_cnt = 0;
                        sl->rx_expect = 0;
                        sl->rx_lim = sl->lin_master ? 0 : SLLIN_BUFF_LEN;
@@ -750,7 +774,7 @@ int sllin_kwthread(void *ptr)
                                /* SFF RTR CAN frame -> LIN header */ 
                                if (cf->can_id & CAN_RTR_FLAG) {
                                        spin_lock(&sl->lock);
-                                       printk(KERN_INFO "%s: RTR SFF CAN frame, ID = %x\n",
+                                       pr_debug("sllin: %s: RTR SFF CAN frame, ID = %x\n",
                                                __FUNCTION__, cf->can_id & SLLIN_ID_MASK);
 
                                        /* Is there Slave response in linfr_cache to be sent? */
@@ -758,7 +782,7 @@ int sllin_kwthread(void *ptr)
                                                SLLIN_LOC_SLAVE_CACHE) 
                                                && (sl->linfr_cache[cf->can_id & SLLIN_ID_MASK].dlc > 0)) {
                                                
-                                               printk(KERN_INFO "Sending LIN response from linfr_cache\n");
+                                               pr_debug("sllin: Sending LIN response from linfr_cache\n");
                                                lin_data = sl->linfr_cache[cf->can_id & SLLIN_ID_MASK].data;
                                                lin_dlc = sl->linfr_cache[cf->can_id & SLLIN_ID_MASK].dlc;
                                                if (lin_dlc > SLLIN_DATA_MAX)
@@ -771,7 +795,7 @@ int sllin_kwthread(void *ptr)
                                        }
                                        spin_unlock(&sl->lock);
                                } else { /* SFF NON-RTR CAN frame -> LIN header + LIN response */
-                                       printk(KERN_INFO "%s: NON-RTR SFF CAN frame, ID = %x\n",
+                                       pr_debug("sllin: %s: NON-RTR SFF CAN frame, ID = %x\n",
                                                __FUNCTION__, (int)cf->can_id & SLLIN_ID_MASK);
 
                                        lin_data = cf->data;
@@ -869,16 +893,16 @@ int sllin_kwthread(void *ptr)
                                        continue;
                        
                                hrtimer_cancel(&sl->rx_timer);
-                               printk(KERN_INFO "sllin: response received ID %d len %d\n",
+                               pr_debug("sllin: response received ID %d len %d\n",
                                        sl->rx_buff[SLLIN_BUFF_ID], sl->rx_cnt - SLLIN_BUFF_DATA - 1);
 
                                if (sllin_rx_validate(sl) == -1) {
-                                       printk("sllin: RX validation failed.\n");
+                                       pr_debug("sllin: RX validation failed.\n");
                                        sllin_report_error(sl, SLLIN_ERR_CHECKSUM);
                                        //FIXME tx_stat.err++
                                } else {
                                        // send CAN non-RTR frame with data
-                                       printk(KERN_INFO "sllin: sending NON-RTR CAN"
+                                       pr_debug("sllin: sending NON-RTR CAN"
                                                "frame with LIN payload.");
                                        sll_bump(sl); //send packet to the network layer
                                }
@@ -893,7 +917,7 @@ int sllin_kwthread(void *ptr)
                                        continue;
                                
                                sll_bump(sl); //send packet to the network layer
-                               printk(KERN_INFO "sllin: response sent ID %d len %d\n",
+                               pr_debug("sllin: response sent ID %d len %d\n",
                                        sl->rx_buff[SLLIN_BUFF_ID], sl->rx_cnt - SLLIN_BUFF_DATA - 1);
 
                                sl->id_to_send = false;
@@ -909,7 +933,7 @@ int sllin_kwthread(void *ptr)
        }
 
        hrtimer_cancel(&sl->rx_timer);
-       printk(KERN_INFO "sllin: sllin_kwthread stopped.\n");
+       pr_debug("sllin: sllin_kwthread stopped.\n");
 
        return 0;
 }
@@ -1174,7 +1198,7 @@ static int __init sllin_init(void)
                maxdev = 4; /* Sanity */
 
        printk(banner);
-       printk(KERN_INFO "sllin: %d dynamic interface channels.\n", maxdev);
+       pr_debug("sllin: %d dynamic interface channels.\n", maxdev);
 
        sllin_devs = kzalloc(sizeof(struct net_device *)*maxdev, GFP_KERNEL);
        if (!sllin_devs) {
@@ -1190,9 +1214,9 @@ static int __init sllin_init(void)
        }
 
 #ifdef BREAK_BY_BAUD
-       printk(KERN_INFO "sllin: Break is generated by baud-rate change.");
+       pr_debug("sllin: Break is generated by baud-rate change.");
 #else
-       printk(KERN_INFO "sllin: Break is generated manually with tiny sleep.");
+       pr_debug("sllin: Break is generated manually with tiny sleep.");
 #endif
 
        return status;