Established 'xcan' naming throughout project

Author: FARLY7

.gitignore

@@ -1,5 +1 @@
-cmake_install.cmake
-CMakeCache.txt
-Makefile
-CMakeFiles/
-XCAN_EXE
+build/

CMakeLists.txt

@@ -5,11 +5,11 @@ project(XCAN    VERSION 1.0
                 LANGUAGES C)
 
 add_executable(XCAN_EXE
-                modules/can_dev_softdevice.c
-                modules/can_dev_socketcan.c
-                stack/can_device.c
-                stack/can_frame.c
-                stack/can_stack.c
+                modules/xcan_dev_softdevice.c
+                modules/xcan_dev_socketcan.c
+                stack/xcan_device.c
+                stack/xcan_frame.c
+                stack/xcan_stack.c
                 examples/linux/main.c)
 
 target_include_directories(XCAN_EXE PUBLIC

README.md

@@ -1,13 +1,13 @@
-# CAN Routing Stack
+# XCAN Routing Stack
 
 ## Background
 
-CAN is a robust message-based multi-master bus protocol which is particularly dominant in the automotive industry. In large control systems with different domains, there are often several independent CAN buses with each bus connecting together the nodes of a particular domain in the system.
+XCAN is a robust message-based multi-master bus protocol which is particularly dominant in the automotive industry. In large control systems with different domains, there are often several independent CAN buses with each bus connecting together the nodes of a particular domain in the system.
 It is the role of a central **gateway/router** device to pass certain messages between each these buses to enable the sharing of information across domains.
 
-This is where the CAN Routing Stack fits in.
+This is where the XCAN Routing Stack fits in.
 
-The intention of this project is to provide an open-source CAN routing stack.
+The intention of this project is to provide an open-source XCAN routing stack.
 
 ## Features
 
@@ -36,7 +36,7 @@ $ sudo ip link add dev vcan0 type vcan
 $ sudo ip link add dev vcan1 type vcan
 ```
 
-Bring up the two vCAN interfaces:
+Bring up the two virtual CAN interfaces:
 ``` shell
 $ sudo ip link set up vcan0
 $ sudo ip link set up vcan1

examples/linux/main.c

@@ -1,34 +1,34 @@
 #include <stdio.h>
 #include <time.h>
 
-#include "can_stack.h"
-#include "can_dev_socketcan.h"
+#include "xcan_stack.h"
+#include "xcan_dev_socketcan.h"
 
 
 int main(int argc, char *argv[])
 {
-    struct can_device *dev0, *dev1;
+    struct xcan_device *dev0, *dev1;
 
-    printf("***** XCAN Linux Example *****\n");
+    printf("***** XXCAN Linux Example *****\n");
     printf("Debug: Enabled\n\n");
 
     /* Initialise the XCAN stack */
-    can_stack_init();
+    xcan_stack_init();
 
     /* Create the SocketCAN interface 0 */
-    dev0 = can_socketcan_create(0, "SocketCAN-0");
+    dev0 = xcan_socketcan_create(0, "SocketCAN-0");
     if(!dev0)
         return -1;
 
     /* Create the SocketCAN interface 1 */
-    dev1 = can_socketcan_create(1, "SocketCAN-1");
+    dev1 = xcan_socketcan_create(1, "SocketCAN-1");
     if(!dev1)
         return -1;
 
-    /* Enter a forever loop, processing CAN frames */
+    /* Enter a forever loop, processing XCAN frames */
     while(1)
     {
-        can_stack_tick();
+        xcan_stack_tick();
         usleep(1000 * 500);
     }
 

modules/can_dev_socketcan.h

@@ -1,12 +1,12 @@
-#include "can_dev_socketcan.h"
+#include "xcan_dev_socketcan.h"
 
 #include "sys/socket.h"
 #include <linux/can.h>
 #include <linux/can/raw.h>
 
-struct can_device_socketcan {	
-    struct can_device dev;
-    // Anything else specific to socketcan
+struct xcan_device_socketxcan {	
+    struct xcan_device dev;
+    // Anything else specific to socketxcan
     int fd;
 };
 
@@ -15,18 +15,18 @@ struct can_device_socketcan {
 /* =======================      PRIVATE      ======================= */
 /* ================================================================= */
 
-int prv_link_state(struct can_device *dev)
+int prv_link_state(struct xcan_device *dev)
 {
     return 1;
 }
 
-int prv_send(struct can_device *self, void *buf, int len)
+int prv_send(struct xcan_device *self, void *buf, int len)
 {
-    dbg("CAN sc: Sending %d bytes\n", len);
+    dbg("XCAN sc: Sending %d bytes\n", len);
     return 0;
 }
 
-int prv_poll(struct can_device *self, int loop_score)
+int prv_poll(struct xcan_device *self, int loop_score)
 {
 
 }
@@ -36,25 +36,25 @@ int prv_poll(struct can_device *self, int loop_score)
 /* ================================================================= */
 
 
-void can_socketcan_destroy(struct can_device *dev)
+void xcan_socketxcan_destroy(struct xcan_device *dev)
 {
-    struct can_device_socketcan *sc = (struct can_device_socketcan *) dev;
+    struct xcan_device_socketxcan *sc = (struct xcan_device_socketxcan *) dev;
 
     free(sc);
     dbg("Device %s destroyed.\n", sc->dev.name);
 }
 
 
-struct can_device* can_socketcan_create(uint8_t id, char *name)
+struct xcan_device* xcan_socketxcan_create(uint8_t id, char *name)
 {
-    struct can_device_socketcan *sc = malloc(sizeof(struct can_device_socketcan));
+    struct xcan_device_socketxcan *sc = malloc(sizeof(struct xcan_device_socketxcan));
 
     if(!sc)
         return NULL;
 
-    /* Initialise SocketCAN interface */
+    /* Initialise SocketXCAN interface */
     if((sc->fd = socket(PF_CAN, SOCK_RAW, CAN_RAW)) < 0) {
-        dbg("Failed to open socketCAN interface");
+        dbg("Failed to open socketXCAN interface");
         return NULL;
     }
 
@@ -63,19 +63,19 @@ struct can_device* can_socketcan_create(uint8_t id, char *name)
     strcpy(ifr.ifr_name, "vcan0");
 
 
-    /* Register SocketCAN interface as XCAN device */
-    if( 0 != can_device_init((struct can_device *) sc, id, name)) {
+    /* Register SocketXCAN interface as XXCAN device */
+    if( 0 != xcan_device_init((struct xcan_device *) sc, id, name)) {
 
-        dbg("CAN socketcan init failed.\n");
-        can_socketcan_destroy((struct can_device*) sc);
+        dbg("XCAN socketxcan init failed.\n");
+        xcan_socketxcan_destroy((struct xcan_device*) sc);
         return NULL;
     }
 
     /* Fill in vtable */
     sc->dev.link_state  = prv_link_state;
     sc->dev.send        = prv_send;
     sc->dev.poll        = prv_poll;
-    sc->dev.destroy     = can_socketcan_destroy;
+    sc->dev.destroy     = xcan_socketxcan_destroy;
     dbg("Device %s created\n", name);
-    return (struct can_device *) sc;
+    return (struct xcan_device *) sc;
 }

modules/can_dev_softdevice.c

@@ -0,0 +1,10 @@
+#ifndef XCAN_DEV_SOCKETXCAN_H
+#define XCAN_DEV_SOCKETXCAN_H
+
+#include "xcan_device.h"
+
+void xcan_socketxcan_destroy(struct xcan_device *socketxcan);
+
+struct xcan_device* xcan_socketxcan_create(uint8_t id, char *name);
+
+#endif /* XCAN_DEV_SOCKETXCAN_H */

modules/can_dev_softdevice.h

@@ -0,0 +1,65 @@
+#include "xcan_dev_softdevice.h"
+
+#include <stdio.h>
+
+struct xcan_device_softdevice {	
+    struct xcan_device dev;
+    // Anything else specific to softdevice
+};
+
+
+/* ================================================================= */
+/* =======================      PRIVATE      ======================= */
+/* ================================================================= */
+
+int prv_link_state(struct xcan_device *dev)
+{
+    return 1;
+}
+
+int prv_send(struct xcan_device *self, void *buf, int len)
+{
+    dbg("XCAN SD: Sending %d bytes\n", len);
+    return 0;
+}
+
+int prv_poll(struct xcan_device *self, int loop_score)
+{
+
+}
+
+/* ================================================================= */
+/* =======================      PUBLIC      ======================== */
+/* ================================================================= */
+
+
+void xcan_softdevice_destroy(struct xcan_device *dev)
+{
+    struct xcan_device_softdevice *sd = (struct xcan_device_softdevice *) dev;
+
+    free(sd);
+    dbg("Device %s destroyed.\n", sd->dev.name);
+}
+
+
+struct xcan_device* xcan_softdevice_create(uint8_t id, char *name)
+{
+    struct xcan_device_softdevice *sd = malloc(sizeof(struct xcan_device_softdevice));
+
+    if(!sd)
+        return NULL;
+
+    if( 0 != xcan_device_init((struct xcan_device *) sd, id, name)) {
+    
+        dbg("XCAN SoftDevice init failed.\n");
+        xcan_softdevice_destroy((struct xcan_device*) sd);
+        return NULL;
+    }
+
+    sd->dev.link_state = prv_link_state;
+    sd->dev.send       = prv_send;
+    sd->dev.poll       = prv_poll;
+    sd->dev.destroy    = xcan_softdevice_destroy;
+    dbg("Device %s created\n", name);
+    return (struct xcan_device *) sd;
+}

modules/can_dev_socketcan.c renamed to modules/xcan_dev_socketcan.c

@@ -0,0 +1,10 @@
+#ifndef XCAN_DEV_SOFTDEVICE_H
+#define XCAN_DEV_SOFTDEVICE_H
+
+#include "xcan_device.h"
+
+void xcan_softdevice_destroy(struct xcan_device *softdevice);
+
+struct xcan_device* xcan_softdevice_create(uint8_t id, char *name);
+
+#endif /* XCAN_DEV_SOFTDEVICE_H */