Merge branch 'master' into master

jeonghanlee · web-flow · commit 626dfc544e28 · 2018-07-30T22:26:32.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -3,7 +3,6 @@
 modules.order
 Module.symvers
 Mkfile.old
-dkms.conf
 core.*
 #*
 .#*
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ etherlabmaster
 Configuration Environment for EtherLab EtherCAT Master at https://sourceforge.net/projects/etherlabmaster/
 
 ## Role
-In order to download, install, setup all relevant components (system library, kernel module, ethercat configuration, and systemd service), one should do many steps manually. This repository was designed for the easy-to-reproducible enviornment for EtherLab EtherCAT Master. With the following steps, one can run the EtherCAT Master on one dedicated ethernet port within CentOS and Debian OSs.
+In order to download, install, setup all relevant components (system library, kernel module, ethercat configuration, and systemd service), one should do many steps manually. This repository was designed for the easy-to-reproducible environment for EtherLab EtherCAT Master. With the following steps, one can run the EtherCAT Master on one dedicated Ethernet port within CentOS and Debian OSs.
 
 
 
@@ -16,15 +16,21 @@ etherlabmaster (master)$ echo "ETHERCAT_MASTER0=eth0" > ethercatmaster.local
 ```
 The local file will be used to override the ETHERCAT_MASTER0 variable defined in scripts/ethercatmaster.conf.
 
-You are ready to do the following commands in the specific order:
+Be ready to do the following commands in the specific order:
 
 ```
 etherlabmaster (master)$ make init
 etherlabmaster (master)$ make patch
 etherlabmaster (master)$ make build
 etherlabmaster (master)$ make install
-etherlabmaster (master)$ make modules
-etherlabmaster (master)$ make modules_install
+```
+
+Kernel modules are built via dkms
+
+```
+etherlabmaster (master)$ make dkms_add
+etherlabmaster (master)$ make dkms_build
+etherlabmaster (master)$ make dkms_install
 etherlabmaster (master)$ make setup
 ```
 
@@ -50,23 +56,28 @@ Fixed scheduler settings in dc_user example; use CLOCK_MONOTONIC.
 ```
 ### make patch
 * We would like to keep ethercat.conf file within $PREFIX/etc path
-* [See the patch file](./patch/Site/use_prefix_for_ethercat_conf_path.p0.patch)
+* [See the patch file 1](./patch/Site/use_prefix_for_ethercat_conf_path.p0.patch)
+* [See the patch file 2](./patch/Site/after_dkms_service_patch.p0.patch)
 
 ### make build
 * Ethercat program compilation
 
 ### make install
 * Ethercat program (configuration, lib, and others) installation
 
-### make modules build
-* Kernel modules compiliation
+### make dkms_add
+* dkms add
+
+### make dkms_build
+* dkms build via dkms
 
-### make modules install
-* Kernel modules installation
+### make dkms_install
+* Kernel modules installation via dkms
 
 ### make setup
 
 * Activate the EtherCAT master Network Port
+* Setup the dkms systemd service
 * Setup the ethercat systemd service
 * Put the UDEV rule to allow an user to access the ethercat master port
 * Create the symbolic link for the ethercat executable command
diff --git a/configure/CONFIG b/configure/CONFIG
@@ -1,15 +1,11 @@
 VARS_EXCLUDES := $(.VARIABLES)
 
-#include $(TOP)/configure/RELEASE
-
 include $(TOP)/configure/CONFIG_MODULE
 
 
 ## It is not necessary to modify the following files in most case.
 ## Order is matter
 
-#include $(TOP)/configure/E3/CONFIG_REQUIRE
-#include $(TOP)/configure/E3/CONFIG_E3_PATH
 include $(TOP)/configure/E3/CONFIG_E3_MAKEFILE
 include $(TOP)/configure/E3/CONFIG_SUDO
 include $(TOP)/configure/E3/CONFIG_EXPORT
diff --git a/configure/E3/CONFIG_E3_MAKEFILE b/configure/E3/CONFIG_E3_MAKEFILE
@@ -3,8 +3,8 @@
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS := -C $(E3_MODULE_SRC_PATH)
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += -f $(E3_MODULE_MAKEFILE)
 E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += E3_ETHERLAB_INSTALL_LOCATION="$(E3_ETHERLAB_INSTALL_LOCATION)"
-# E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += LIBVERSION="$(E3_MODULE_VERSION)"
-# E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += PROJECT="$(E3_MODULE_NAME)"
+E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += E3_MODULE_VERSION="$(E3_MODULE_VERSION)"
+E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += E3_MODULE_NAME="$(E3_MODULE_NAME)"
 # E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += EPICS_MODULES="$(E3_MODULES_PATH)"
 # E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += EPICS_LOCATION="$(EPICS_BASE)"
 # E3_REQUIRE_MAKEFILE_INPUT_OPTIONS += BUILDCLASSES="Linux"
diff --git a/configure/E3/CONFIG_E3_PATH b/configure/E3/CONFIG_E3_PATH
diff --git a/configure/E3/CONFIG_REQUIRE b/configure/E3/CONFIG_REQUIRE
diff --git a/configure/E3/RULES_ETHERLAB b/configure/E3/RULES_ETHERLAB
@@ -51,22 +51,44 @@ distclean: clean
 	rm -rf $(E3_MODULE_SRC_PATH)	
 
 ## modules : EtherCAT Master Kernel Modules Compiliation
-modules:
+modules: conf
 	$(QUIET) $(E3_MODULE_MAKE_CMDS) modules
 
-
 # always sudo is needed
 ## modules_install : EtherCAT Master Kernel Modules Installation
 modules_install:
 	$(QUIET) sudo -E bash -c '$(E3_MODULE_MAKE_CMDS) modules_install'
 
+modules_uninstall:
+	$(QUIET) sudo -E bash -c '$(E3_MODULE_MAKE_CMDS) modules_uninstall'	
 
 autoconf: conf
 	$(QUIET) $(E3_MODULE_MAKE_CMDS) autoconf
 
 
 conf: 
 	$(QUIET) install -m 644 $(TOP)/$(E3_MODULE_MAKEFILE)  $(E3_MODULE_SRC_PATH)/
+	$(QUIET) install -m 644 $(TOP)/dkms/dkms.conf         $(E3_MODULE_SRC_PATH)/
+
+
+.PHONY: dkms_add dkms_remove dkms_build dkms_install dkms_uninstall
+
+dkms_add: conf
+	sudo -E bash -c 'ln -sf $(TOP)/$(E3_MODULE_SRC_PATH) /usr/src/$(E3_MODULE_NAME)-$(E3_MODULE_VERSION)'
+	$(QUIET) sudo -E bash -c '$(E3_MODULE_MAKE_CMDS) dkms_add'
+
+dkms_remove: conf
+	$(QUIET) sudo -E bash -c '$(E3_MODULE_MAKE_CMDS) dkms_remove'
+	     
+dkms_build:
+	$(QUIET) sudo -E bash -c '$(E3_MODULE_MAKE_CMDS) dkms_build'
+
+dkms_install:
+	$(QUIET) sudo -E bash -c '$(E3_MODULE_MAKE_CMDS) dkms_install'
+
+dkms_uninstall:
+	$(QUIET) sudo -E bash -c '$(E3_MODULE_MAKE_CMDS) dkms_uninstall'
+
 
 
 .PHONY: setup
diff --git a/configure/RELEASE b/configure/RELEASE
diff --git a/dkms/dkms.conf b/dkms/dkms.conf
@@ -0,0 +1,23 @@
+PACKAGE_NAME="etherlabmaster"
+PACKAGE_VERSION="1.5.2"
+
+
+BUILT_MODULE_NAME[0]="master/ec_master"
+DEST_MODULE_NAME[0]="ec_master"
+DEST_MODULE_LOCATION[0]="/updates/dkms"
+
+AUTOINSTALL=yes
+
+MAKE[0]="make -C ${kernel_source_dir} M=${dkms_tree}/${PACKAGE_NAME}/${PACKAGE_VERSION}/build modules"
+CLEAN="make -C ${kernel_source_dir} M=${dkms_tree}/${PACKAGE_NAME}/${PACKAGE_VERSION}/build clean"
+
+
+BUILT_MODULE_NAME[1]="devices/ec_generic"
+DEST_MODULE_NAME[1]="ec_generic"
+DEST_MODULE_LOCATION[1]="/updates/dkms"
+
+BUILT_MODULE_NAME[2]="examples/mini/ec_mini"
+DEST_MODULE_NAME[2]="ec_mini"
+DEST_MODULE_LOCATION[2]="/updates/dkms"
+
+REMAKE_INITRD=yes
diff --git a/etherlabmaster.Makefile b/etherlabmaster.Makefile
@@ -15,15 +15,13 @@
 #  this program. If not, see https://www.gnu.org/licenses/gpl-2.0.txt
 #
 # 
-# Author  : jhlee
-# email   : jhlee@esss.se
-# Date    : generated by 2018May22-1613-30CEST
-# version : 0.0.0 
+# Author  : Jeong Han Lee
+# email   : jeonghan.lee@gmail.com
+# Date    : Wednesday, July 25 23:31:31 CEST 2018
+# version : 0.0.1
 #
-# template file is generated by ./create_e3_modules.bash with 31f0fe0
-# Please look at many other _module_.Makefile in e3-* repository
-# 
 
+DKMS:=/usr/sbin/dkms
 
 
 autoconf:
@@ -45,6 +43,7 @@ uninstall:
 	make uninstall
 
 
+
 modules: 
 	make modules
 
@@ -53,10 +52,27 @@ modules_install:
 	make modules_install
 	depmod --quick
 
+dkms_build:
+	$(DKMS) build -m $(E3_MODULE_NAME) -v $(E3_MODULE_VERSION) 
+
+dkms_add:
+	$(DKMS) add -m $(E3_MODULE_NAME) -v $(E3_MODULE_VERSION)
+
+dkms_remove:
+	$(DKMS) remove -m $(E3_MODULE_NAME) -v $(E3_MODULE_VERSION) --all
+
+
+dkms_install:
+	$(DKMS) install -m $(E3_MODULE_NAME) -v $(E3_MODULE_VERSION)
+	depmod
+
+dkms_uninstall:
+	$(DKMS) uninstall -m $(E3_MODULE_NAME) -v $(E3_MODULE_VERSION)
+	depmod
 
 clean:
 	make clean
 
 
-.PHONY: autoconf build install uninstall modules modules_install clean
+.PHONY: autoconf build install uninstall modules modules_install modules_uninstall clean
 
diff --git a/patch/Site/HISTORY.md b/patch/Site/HISTORY.md
@@ -5,3 +5,12 @@ This patch allows us to use the installed etherlab master configuration in a loc
 
 * created by Jeong Han Lee, han.lee@esss.se
 * Thursday, May 24 11:51:52 CEST 2018
+
+
+# after_dkms_service_patch.p0.patch
+
+The dkms.service demon should be run before the ethercat.service will be started. 
+
+```
+etherlabmaster-code (master)$ hg diff script/ethercat.service.in > ../patch/Site/after_dkms_service_patch.p0.patch
+```
diff --git a/patch/Site/README.md b/patch/Site/README.md
@@ -22,3 +22,5 @@ $hg diff script/ethercatctl.in > ../use_prefix_for_ethercat_conf_path.p0.patch
 ```
 And remove a/b in user_prefix_for_ethercat_conf_path.p0.patch manually.
 
+
+
diff --git a/patch/Site/after_dkms_service_patch.p0.patch b/patch/Site/after_dkms_service_patch.p0.patch
@@ -0,0 +1,16 @@
+diff -r 9e65f782e8a1 script/ethercat.service.in
+--- script/ethercat.service.in	Tue Feb 13 17:16:01 2018 +0100
++++ script/ethercat.service.in	Fri Jul 27 00:04:00 2018 +0200
+@@ -9,8 +9,10 @@
+ # Uncomment this, if the generic Ethernet driver is used. It assures, that the
+ # network interfaces are configured, before the master starts.
+ #
+-#Requires=network.service # Stop master, if network is stopped
+-#After=network.service # Start master, after network is ready
++# Stop ethercat.service, if dkms.service is stopped
++Requires=dkms.service
++# Start ethercat.service, after dkms.service is ready
++After=dkms.service
+ 
+ #
+ # Uncomment this, if a native Ethernet driver is used. It assures, that the
diff --git a/scripts/dkms.service b/scripts/dkms.service
@@ -0,0 +1,11 @@
+[Unit]
+Description=Builds and install new kernel modules through DKMS
+Documentation=man:dkms(8)
+
+[Service]
+Type=oneshot
+RemainAfterExit=true
+ExecStart=/bin/sh -c 'dkms autoinstall --verbose --kernelver $(uname -r)'
+
+[Install]
+WantedBy=multi-user.target
diff --git a/scripts/etherlab_setup.bash b/scripts/etherlab_setup.bash

-Original file line number
+Diff line change
 ```
 And remove a/b in user_prefix_for_ethercat_conf_path.p0.patch manually.
++
++